platform_view.dart 26.8 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6 7
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:ui';

import 'package:flutter/foundation.dart';
8
import 'package:flutter/gestures.dart';
9
import 'package:flutter/semantics.dart';
10 11 12 13 14 15 16
import 'package:flutter/services.dart';

import 'box.dart';
import 'layer.dart';
import 'object.dart';


17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
/// How an embedded platform view behave during hit tests.
enum PlatformViewHitTestBehavior {
  /// Opaque targets can be hit by hit tests, causing them to both receive
  /// events within their bounds and prevent targets visually behind them from
  /// also receiving events.
  opaque,

  /// Translucent targets both receive events within their bounds and permit
  /// targets visually behind them to also receive events.
  translucent,

  /// Transparent targets don't receive events within their bounds and permit
  /// targets visually behind them to receive events.
  transparent,
}

33 34 35 36 37 38
enum _PlatformViewState {
  uninitialized,
  resizing,
  ready,
}

39
bool _factoryTypesSetEquals<T>(Set<Factory<T>>? a, Set<Factory<T>>? b) {
40 41 42 43 44 45 46 47 48 49 50 51 52
  if (a == b) {
    return true;
  }
  if (a == null ||  b == null) {
    return false;
  }
  return setEquals(_factoriesTypeSet(a), _factoriesTypeSet(b));
}

Set<Type> _factoriesTypeSet<T>(Set<Factory<T>> factories) {
  return factories.map<Type>((Factory<T> factory) => factory.type).toSet();
}

53 54
/// A render object for an Android view.
///
55 56
/// Requires Android API level 20 or greater.
///
57 58
/// [RenderAndroidView] is responsible for sizing, displaying and passing touch events to an
/// Android [View](https://developer.android.com/reference/android/view/View).
59
///
60
/// {@template flutter.rendering.RenderAndroidView.layout}
61
/// The render object's layout behavior is to fill all available space, the parent of this object must
62
/// provide bounded layout constraints.
63
/// {@endtemplate}
64
///
65
/// {@template flutter.rendering.RenderAndroidView.gestures}
66
/// The render object participates in Flutter's gesture arenas, and dispatches touch events to the
67 68 69 70 71
/// platform view iff it won the arena. Specific gestures that should be dispatched to the platform
/// view can be specified with factories in the `gestureRecognizers` constructor parameter or
/// by calling `updateGestureRecognizers`. If the set of gesture recognizers is empty, the gesture
/// will be dispatched to the platform view iff it was not claimed by any other gesture recognizer.
/// {@endtemplate}
72 73
///
/// See also:
74
///
75 76
///  * [AndroidView] which is a widget that is used to show an Android view.
///  * [PlatformViewsService] which is a service for controlling platform views.
77
class RenderAndroidView extends RenderBox with _PlatformViewGestureMixin {
78 79 80

  /// Creates a render object for an Android view.
  RenderAndroidView({
81 82 83
    required AndroidViewController viewController,
    required PlatformViewHitTestBehavior hitTestBehavior,
    required Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers,
84
    Clip clipBehavior = Clip.hardEdge,
85
  }) : assert(viewController != null),
86
       assert(hitTestBehavior != null),
87
       assert(gestureRecognizers != null),
88 89 90
       assert(clipBehavior != null),
       _viewController = viewController,
       _clipBehavior = clipBehavior {
91
    _viewController.pointTransformer = (Offset offset) => globalToLocal(offset);
92
    updateGestureRecognizers(gestureRecognizers);
93
    _viewController.addOnPlatformViewCreatedListener(_onPlatformViewCreated);
94
    this.hitTestBehavior = hitTestBehavior;
95
  }
96 97 98 99 100 101 102 103 104 105 106

  _PlatformViewState _state = _PlatformViewState.uninitialized;

  /// The Android view controller for the Android view associated with this render object.
  AndroidViewController get viewcontroller => _viewController;
  AndroidViewController _viewController;
  /// Sets a new Android view controller.
  ///
  /// `viewController` must not be null.
  set viewController(AndroidViewController viewController) {
    assert(_viewController != null);
107
    assert(viewController != null);
108 109
    if (_viewController == viewController)
      return;
110
    _viewController.removeOnPlatformViewCreatedListener(_onPlatformViewCreated);
111 112
    _viewController = viewController;
    _sizePlatformView();
113 114 115 116 117 118
    if (_viewController.isCreated) {
      markNeedsSemanticsUpdate();
    }
    _viewController.addOnPlatformViewCreatedListener(_onPlatformViewCreated);
  }

119
  /// {@macro flutter.material.Material.clipBehavior}
120 121 122 123 124 125 126 127 128 129 130 131 132
  ///
  /// Defaults to [Clip.hardEdge], and must not be null.
  Clip get clipBehavior => _clipBehavior;
  Clip _clipBehavior = Clip.hardEdge;
  set clipBehavior(Clip value) {
    assert(value != null);
    if (value != _clipBehavior) {
      _clipBehavior = value;
      markNeedsPaint();
      markNeedsSemanticsUpdate();
    }
  }

133 134
  void _onPlatformViewCreated(int id) {
    markNeedsSemanticsUpdate();
135 136
  }

137
  /// {@template flutter.rendering.RenderAndroidView.updateGestureRecognizers}
138
  /// Updates which gestures should be forwarded to the platform view.
139
  ///
140 141
  /// Gesture recognizers created by factories in this set participate in the gesture arena for each
  /// pointer that was put down on the render box. If any of the recognizers on this list wins the
142 143
  /// gesture arena, the entire pointer event sequence starting from the pointer down event
  /// will be dispatched to the Android view.
144 145 146 147 148
  ///
  /// The `gestureRecognizers` property must not contain more than one factory with the same [Factory.type].
  ///
  /// Setting a new set of gesture recognizer factories with the same [Factory.type]s as the current
  /// set has no effect, because the factories' constructors would have already been called with the previous set.
149
  /// {@endtemplate}
150 151 152 153
  ///
  /// Any active gesture arena the Android view participates in is rejected when the
  /// set of gesture recognizers is changed.
  void updateGestureRecognizers(Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers) {
154
    _updateGestureRecognizersWithCallBack(gestureRecognizers, _viewController.dispatchPointerEvent);
155 156
  }

157 158 159 160 161 162 163 164 165
  @override
  bool get sizedByParent => true;

  @override
  bool get alwaysNeedsCompositing => true;

  @override
  bool get isRepaintBoundary => true;

166 167 168 169 170
  @override
  Size computeDryLayout(BoxConstraints constraints) {
    return constraints.biggest;
  }

171 172
  @override
  void performResize() {
173
    super.performResize();
174 175 176
    _sizePlatformView();
  }

177
  late Size _currentAndroidViewSize;
178

179
  Future<void> _sizePlatformView() async {
180 181 182 183
    // Android virtual displays cannot have a zero size.
    // Trying to size it to 0 crashes the app, which was happening when starting the app
    // with a locked screen (see: https://github.com/flutter/flutter/issues/20456).
    if (_state == _PlatformViewState.resizing || size.isEmpty) {
184 185 186 187
      return;
    }

    _state = _PlatformViewState.resizing;
188
    markNeedsPaint();
189 190 191 192

    Size targetSize;
    do {
      targetSize = size;
193 194
      await _viewController.setSize(targetSize);
      _currentAndroidViewSize = targetSize;
195 196 197 198 199 200 201 202 203 204 205 206 207 208
      // We've resized the platform view to targetSize, but it is possible that
      // while we were resizing the render object's size was changed again.
      // In that case we will resize the platform view again.
    } while (size != targetSize);

    _state = _PlatformViewState.ready;
    markNeedsPaint();
  }

  @override
  void paint(PaintingContext context, Offset offset) {
    if (_viewController.textureId == null)
      return;

209 210
    // Clip the texture if it's going to paint out of the bounds of the renter box
    // (see comment in _paintTexture for an explanation of when this happens).
211
    if ((size.width < _currentAndroidViewSize.width || size.height < _currentAndroidViewSize.height) && clipBehavior != Clip.none) {
212 213 214 215 216 217 218 219
      _clipRectLayer = context.pushClipRect(
        true,
        offset,
        offset & size,
        _paintTexture,
        clipBehavior: clipBehavior,
        oldLayer: _clipRectLayer,
      );
220 221
      return;
    }
222
    _clipRectLayer = null;
223 224 225
    _paintTexture(context, offset);
  }

226 227
  ClipRectLayer? _clipRectLayer;

228 229 230 231 232 233 234 235 236 237
  void _paintTexture(PaintingContext context, Offset offset) {
    // As resizing the Android view happens asynchronously we don't know exactly when is a
    // texture frame with the new size is ready for consumption.
    // TextureLayer is unaware of the texture frame's size and always maps it to the
    // specified rect. If the rect we provide has a different size from the current texture frame's
    // size the texture frame will be scaled.
    // To prevent unwanted scaling artifacts while resizing we freeze the texture frame, until
    // we know that a frame with the new size is in the buffer.
    // This guarantees that the size of the texture frame we're painting is always
    // _currentAndroidViewSize.
238
    context.addLayer(TextureLayer(
239
      rect: offset & _currentAndroidViewSize,
240
      textureId: _viewController.textureId!,
241
      freeze: _state == _PlatformViewState.resizing,
242 243
    ));
  }
244

245 246 247 248 249 250 251
  @override
  void describeSemanticsConfiguration (SemanticsConfiguration config) {
    super.describeSemanticsConfiguration(config);

    config.isSemanticBoundary = true;

    if (_viewController.isCreated) {
252
      config.platformViewId = _viewController.viewId;
253 254
    }
  }
255 256
}

257 258
/// A render object for an iOS UIKit UIView.
///
259
/// {@template flutter.rendering.RenderUiKitView}
260
/// Embedding UIViews is still preview-quality. To enable the preview for an iOS app add a boolean
261 262
/// field with the key 'io.flutter.embedded_views_preview' and the value set to 'YES' to the
/// application's Info.plist file. A list of open issued with embedding UIViews is available on
263
/// [Github](https://github.com/flutter/flutter/issues?q=is%3Aopen+is%3Aissue+label%3A%22a%3A+platform-views%22+label%3Aplatform-ios+sort%3Acreated-asc)
264
/// {@endtemplate}
265 266 267 268 269 270
///
/// [RenderUiKitView] is responsible for sizing and displaying an iOS
/// [UIView](https://developer.apple.com/documentation/uikit/uiview).
///
/// UIViews are added as sub views of the FlutterView and are composited by Quartz.
///
271
/// {@macro flutter.rendering.RenderAndroidView.layout}
272
///
273
/// {@macro flutter.rendering.RenderAndroidView.gestures}
274
///
275
/// See also:
276
///
277 278 279 280 281
///  * [UiKitView] which is a widget that is used to show a UIView.
///  * [PlatformViewsService] which is a service for controlling platform views.
class RenderUiKitView extends RenderBox {
  /// Creates a render object for an iOS UIView.
  ///
282
  /// The `viewId`, `hitTestBehavior`, and `gestureRecognizers` parameters must not be null.
283
  RenderUiKitView({
284 285 286
    required UiKitViewController viewController,
    required this.hitTestBehavior,
    required Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers,
287
  }) : assert(viewController != null),
288
       assert(hitTestBehavior != null),
289 290 291 292
       assert(gestureRecognizers != null),
       _viewController = viewController {
    updateGestureRecognizers(gestureRecognizers);
  }
293 294 295 296 297 298


  /// The unique identifier of the UIView controlled by this controller.
  ///
  /// Typically generated by [PlatformViewsRegistry.getNextPlatformViewId], the UIView
  /// must have been created by calling [PlatformViewsService.initUiKitView].
299 300
  UiKitViewController get viewController => _viewController;
  UiKitViewController _viewController;
301 302
  set viewController(UiKitViewController viewController) {
    assert(viewController != null);
303
    final bool needsSemanticsUpdate = _viewController.id != viewController.id;
304
    _viewController = viewController;
305
    markNeedsPaint();
306 307 308
    if (needsSemanticsUpdate) {
      markNeedsSemanticsUpdate();
    }
309 310 311 312 313 314 315
  }

  /// How to behave during hit testing.
  // The implicit setter is enough here as changing this value will just affect
  // any newly arriving events there's nothing we need to invalidate.
  PlatformViewHitTestBehavior hitTestBehavior;

316
  /// {@macro flutter.rendering.RenderAndroidView.updateGestureRecognizers}
317 318 319
  void updateGestureRecognizers(Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers) {
    assert(gestureRecognizers != null);
    assert(
320 321 322 323
      _factoriesTypeSet(gestureRecognizers).length == gestureRecognizers.length,
      'There were multiple gesture recognizer factories for the same type, there must only be a single '
      'gesture recognizer factory for each gesture recognizer type.',
    );
324 325 326 327 328 329 330
    if (_factoryTypesSetEquals(gestureRecognizers, _gestureRecognizer?.gestureRecognizerFactories)) {
      return;
    }
    _gestureRecognizer?.dispose();
    _gestureRecognizer = _UiKitViewGestureRecognizer(viewController, gestureRecognizers);
  }

331 332 333 334 335 336 337 338 339
  @override
  bool get sizedByParent => true;

  @override
  bool get alwaysNeedsCompositing => true;

  @override
  bool get isRepaintBoundary => true;

340
  _UiKitViewGestureRecognizer? _gestureRecognizer;
341

342
  PointerEvent? _lastPointerDownEvent;
343

344
  @override
345 346
  Size computeDryLayout(BoxConstraints constraints) {
    return constraints.biggest;
347 348 349 350 351 352
  }

  @override
  void paint(PaintingContext context, Offset offset) {
    context.addLayer(PlatformViewLayer(
      rect: offset & size,
353
      viewId: _viewController.id,
354 355 356 357
    ));
  }

  @override
358 359
  bool hitTest(BoxHitTestResult result, { Offset? position }) {
    if (hitTestBehavior == PlatformViewHitTestBehavior.transparent || !size.contains(position!))
360 361 362 363 364 365 366
      return false;
    result.add(BoxHitTestEntry(this, position));
    return hitTestBehavior == PlatformViewHitTestBehavior.opaque;
  }

  @override
  bool hitTestSelf(Offset position) => hitTestBehavior != PlatformViewHitTestBehavior.transparent;
367 368 369

  @override
  void handleEvent(PointerEvent event, HitTestEntry entry) {
370 371 372
    if (event is! PointerDownEvent) {
      return;
    }
373
    _gestureRecognizer!.addPointer(event);
374
    _lastPointerDownEvent = event.original ?? event;
375 376 377 378 379 380 381
  }

  // This is registered as a global PointerRoute while the render object is attached.
  void _handleGlobalPointerEvent(PointerEvent event) {
    if (event is! PointerDownEvent) {
      return;
    }
382
    if (!(Offset.zero & size).contains(globalToLocal(event.position))) {
383 384
      return;
    }
385
    if ((event.original ?? event) != _lastPointerDownEvent) {
386 387 388 389 390
      // The pointer event is in the bounds of this render box, but we didn't get it in handleEvent.
      // This means that the pointer event was absorbed by a different render object.
      // Since on the platform side the FlutterTouchIntercepting view is seeing all events that are
      // within its bounds we need to tell it to reject the current touch sequence.
      _viewController.rejectGesture();
391
    }
392 393 394
    _lastPointerDownEvent = null;
  }

395 396 397 398 399 400 401
  @override
  void describeSemanticsConfiguration (SemanticsConfiguration config) {
    super.describeSemanticsConfiguration(config);
    config.isSemanticBoundary = true;
    config.platformViewId = _viewController.id;
  }

402 403 404
  @override
  void attach(PipelineOwner owner) {
    super.attach(owner);
405
    GestureBinding.instance!.pointerRouter.addGlobalRoute(_handleGlobalPointerEvent);
406 407 408 409
  }

  @override
  void detach() {
410 411
    GestureBinding.instance!.pointerRouter.removeGlobalRoute(_handleGlobalPointerEvent);
    _gestureRecognizer!.reset();
412 413 414 415 416
    super.detach();
  }
}

// This recognizer constructs gesture recognizers from a set of gesture recognizer factories
417
// it was give, adds all of them to a gesture arena team with the _UiKitViewGestureRecognizer
418 419 420 421
// as the team captain.
// When the team wins a gesture the recognizer notifies the engine that it should release
// the touch sequence to the embedded UIView.
class _UiKitViewGestureRecognizer extends OneSequenceGestureRecognizer {
422 423 424
  _UiKitViewGestureRecognizer(
    this.controller,
    this.gestureRecognizerFactories, {
425 426
    Set<PointerDeviceKind>? supportedDevices,
  }) : super(supportedDevices: supportedDevices) {
427 428
    team = GestureArenaTeam()
      ..captain = this;
429 430
    _gestureRecognizers = gestureRecognizerFactories.map(
      (Factory<OneSequenceGestureRecognizer> recognizerFactory) {
431 432 433 434 435 436 437 438 439 440 441 442 443
        final OneSequenceGestureRecognizer gestureRecognizer = recognizerFactory.constructor();
        gestureRecognizer.team = team;
        // The below gesture recognizers requires at least one non-empty callback to
        // compete in the gesture arena.
        // https://github.com/flutter/flutter/issues/35394#issuecomment-562285087
        if (gestureRecognizer is LongPressGestureRecognizer) {
          gestureRecognizer.onLongPress ??= (){};
        } else if (gestureRecognizer is DragGestureRecognizer) {
          gestureRecognizer.onDown ??= (_){};
        } else if (gestureRecognizer is TapGestureRecognizer) {
          gestureRecognizer.onTapDown ??= (_){};
        }
        return gestureRecognizer;
444 445 446 447 448 449 450 451 452
      },
    ).toSet();
  }


  // We use OneSequenceGestureRecognizers as they support gesture arena teams.
  // TODO(amirh): get a list of GestureRecognizers here.
  // https://github.com/flutter/flutter/issues/20953
  final Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizerFactories;
453
  late Set<OneSequenceGestureRecognizer> _gestureRecognizers;
454 455 456 457

  final UiKitViewController controller;

  @override
458
  void addAllowedPointer(PointerDownEvent event) {
459
    super.addAllowedPointer(event);
460
    for (final OneSequenceGestureRecognizer recognizer in _gestureRecognizers) {
461 462 463 464 465 466 467 468
      recognizer.addPointer(event);
    }
  }

  @override
  String get debugDescription => 'UIKit view';

  @override
469
  void didStopTrackingLastPointer(int pointer) { }
470 471 472 473 474 475 476 477 478 479 480 481 482

  @override
  void handleEvent(PointerEvent event) {
    stopTrackingIfPointerNoLongerDown(event);
  }

  @override
  void acceptGesture(int pointer) {
    controller.acceptGesture();
  }

  @override
  void rejectGesture(int pointer) {
483
    controller.rejectGesture();
484 485 486 487 488
  }

  void reset() {
    resolve(GestureDisposition.rejected);
  }
489 490
}

491
typedef _HandlePointerEvent = Future<void> Function(PointerEvent event);
492

493
// This recognizer constructs gesture recognizers from a set of gesture recognizer factories
494
// it was give, adds all of them to a gesture arena team with the _PlatformViewGestureRecognizer
495
// as the team captain.
496 497 498 499 500 501
// As long as the gesture arena is unresolved, the recognizer caches all pointer events.
// When the team wins, the recognizer sends all the cached pointer events to `_handlePointerEvent`, and
// sets itself to a "forwarding mode" where it will forward any new pointer event to `_handlePointerEvent`.
class _PlatformViewGestureRecognizer extends OneSequenceGestureRecognizer {
  _PlatformViewGestureRecognizer(
    _HandlePointerEvent handlePointerEvent,
502
    this.gestureRecognizerFactories, {
503 504
    Set<PointerDeviceKind>? supportedDevices,
  }) : super(supportedDevices: supportedDevices) {
505 506
    team = GestureArenaTeam()
      ..captain = this;
507
    _gestureRecognizers = gestureRecognizerFactories.map(
508
      (Factory<OneSequenceGestureRecognizer> recognizerFactory) {
509 510 511 512 513 514 515 516 517 518 519 520 521
        final OneSequenceGestureRecognizer gestureRecognizer = recognizerFactory.constructor();
        gestureRecognizer.team = team;
        // The below gesture recognizers requires at least one non-empty callback to
        // compete in the gesture arena.
        // https://github.com/flutter/flutter/issues/35394#issuecomment-562285087
        if (gestureRecognizer is LongPressGestureRecognizer) {
          gestureRecognizer.onLongPress ??= (){};
        } else if (gestureRecognizer is DragGestureRecognizer) {
          gestureRecognizer.onDown ??= (_){};
        } else if (gestureRecognizer is TapGestureRecognizer) {
          gestureRecognizer.onTapDown ??= (_){};
        }
        return gestureRecognizer;
522
      },
523
    ).toSet();
524
    _handlePointerEvent = handlePointerEvent;
525 526
  }

527
  late _HandlePointerEvent _handlePointerEvent;
528 529 530

  // Maps a pointer to a list of its cached pointer events.
  // Before the arena for a pointer is resolved all events are cached here, if we win the arena
531
  // the cached events are dispatched to `_handlePointerEvent`, if we lose the arena we clear the cache for
532
  // the pointer.
533
  final Map<int, List<PointerEvent>> cachedEvents = <int, List<PointerEvent>>{};
534 535

  // Pointer for which we have already won the arena, events for pointers in this set are
536
  // immediately dispatched to `_handlePointerEvent`.
537
  final Set<int> forwardedPointers = <int>{};
538 539 540 541

  // We use OneSequenceGestureRecognizers as they support gesture arena teams.
  // TODO(amirh): get a list of GestureRecognizers here.
  // https://github.com/flutter/flutter/issues/20953
542
  final Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizerFactories;
543
  late Set<OneSequenceGestureRecognizer> _gestureRecognizers;
544 545

  @override
546
  void addAllowedPointer(PointerDownEvent event) {
547
    super.addAllowedPointer(event);
548
    for (final OneSequenceGestureRecognizer recognizer in _gestureRecognizers) {
549 550 551 552 553
      recognizer.addPointer(event);
    }
  }

  @override
554
  String get debugDescription => 'Platform view';
555 556

  @override
557
  void didStopTrackingLastPointer(int pointer) { }
558 559 560 561

  @override
  void handleEvent(PointerEvent event) {
    if (!forwardedPointers.contains(event.pointer)) {
562
      _cacheEvent(event);
563
    } else {
564
      _handlePointerEvent(event);
565 566 567 568 569 570
    }
    stopTrackingIfPointerNoLongerDown(event);
  }

  @override
  void acceptGesture(int pointer) {
571
    _flushPointerCache(pointer);
572 573 574 575 576 577 578 579 580
    forwardedPointers.add(pointer);
  }

  @override
  void rejectGesture(int pointer) {
    stopTrackingPointer(pointer);
    cachedEvents.remove(pointer);
  }

581
  void _cacheEvent(PointerEvent event) {
582 583 584
    if (!cachedEvents.containsKey(event.pointer)) {
      cachedEvents[event.pointer] = <PointerEvent> [];
    }
585
    cachedEvents[event.pointer]!.add(event);
586 587
  }

588 589
  void _flushPointerCache(int pointer) {
    cachedEvents.remove(pointer)?.forEach(_handlePointerEvent);
590 591 592 593 594 595 596 597 598 599 600 601 602 603
  }

  @override
  void stopTrackingPointer(int pointer) {
    super.stopTrackingPointer(pointer);
    forwardedPointers.remove(pointer);
  }

  void reset() {
    forwardedPointers.forEach(super.stopTrackingPointer);
    forwardedPointers.clear();
    cachedEvents.keys.forEach(super.stopTrackingPointer);
    cachedEvents.clear();
    resolve(GestureDisposition.rejected);
604 605 606
  }
}

607 608
/// A render object for embedding a platform view.
///
609 610 611
/// [PlatformViewRenderBox] presents a platform view by adding a [PlatformViewLayer] layer,
/// integrates it with the gesture arenas system and adds relevant semantic nodes to the semantics tree.
class PlatformViewRenderBox extends RenderBox with _PlatformViewGestureMixin {
612 613 614 615 616

  /// Creating a render object for a [PlatformViewSurface].
  ///
  /// The `controller` parameter must not be null.
  PlatformViewRenderBox({
617 618 619
    required PlatformViewController controller,
    required PlatformViewHitTestBehavior hitTestBehavior,
    required Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers,
620 621 622 623
  }) :  assert(controller != null && controller.viewId != null && controller.viewId > -1),
        assert(hitTestBehavior != null),
        assert(gestureRecognizers != null),
        _controller = controller {
624 625 626
    this.hitTestBehavior = hitTestBehavior;
    updateGestureRecognizers(gestureRecognizers);
  }
627 628 629 630 631 632 633 634 635 636 637 638

  /// Sets the [controller] for this render object.
  ///
  /// This value must not be null, and setting it to a new value will result in a repaint.
  set controller(PlatformViewController controller) {
    assert(controller != null);
    assert(controller.viewId != null && controller.viewId > -1);

    if ( _controller == controller) {
      return;
    }
    final bool needsSemanticsUpdate = _controller.viewId != controller.viewId;
639 640
    _controller = controller;
    markNeedsPaint();
641 642 643 644 645
    if (needsSemanticsUpdate) {
      markNeedsSemanticsUpdate();
    }
  }

646
  /// {@macro  flutter.rendering.RenderAndroidView.updateGestureRecognizers}
647 648 649
  ///
  /// Any active gesture arena the `PlatformView` participates in is rejected when the
  /// set of gesture recognizers is changed.
650 651
  void updateGestureRecognizers(Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers) {
    _updateGestureRecognizersWithCallBack(gestureRecognizers, _controller.dispatchPointerEvent);
652 653
  }

654 655 656 657 658 659 660 661 662 663 664 665
  PlatformViewController _controller;

  @override
  bool get sizedByParent => true;

  @override
  bool get alwaysNeedsCompositing => true;

  @override
  bool get isRepaintBoundary => true;

  @override
666 667
  Size computeDryLayout(BoxConstraints constraints) {
    return constraints.biggest;
668 669 670 671 672 673
  }

  @override
  void paint(PaintingContext context, Offset offset) {
    assert(_controller.viewId != null);
    context.addLayer(PlatformViewLayer(
674 675 676
      rect: offset & size,
      viewId: _controller.viewId,
    ));
677 678 679 680 681 682 683 684 685 686
  }

  @override
  void describeSemanticsConfiguration (SemanticsConfiguration config) {
    super.describeSemanticsConfiguration(config);
    assert(_controller.viewId != null);
    config.isSemanticBoundary = true;
    config.platformViewId = _controller.viewId;
  }
}
687 688

/// The Mixin handling the pointer events and gestures of a platform view render box.
689
mixin _PlatformViewGestureMixin on RenderBox implements MouseTrackerAnnotation {
690 691

  /// How to behave during hit testing.
692 693 694 695 696
  // Changing _hitTestBehavior might affect which objects are considered hovered over.
  set hitTestBehavior(PlatformViewHitTestBehavior value) {
    if (value != _hitTestBehavior) {
      _hitTestBehavior = value;
      if (owner != null)
697
        markNeedsPaint();
698 699
    }
  }
700
  PlatformViewHitTestBehavior? _hitTestBehavior;
701

702
  _HandlePointerEvent? _handlePointerEvent;
703

704
  /// {@macro  flutter.rendering.RenderAndroidView.updateGestureRecognizers}
705 706 707
  ///
  /// Any active gesture arena the `PlatformView` participates in is rejected when the
  /// set of gesture recognizers is changed.
708
  void _updateGestureRecognizersWithCallBack(Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers, _HandlePointerEvent handlePointerEvent) {
709 710
    assert(gestureRecognizers != null);
    assert(
711 712 713 714
      _factoriesTypeSet(gestureRecognizers).length == gestureRecognizers.length,
      'There were multiple gesture recognizer factories for the same type, there must only be a single '
      'gesture recognizer factory for each gesture recognizer type.',
    );
715 716 717 718
    if (_factoryTypesSetEquals(gestureRecognizers, _gestureRecognizer?.gestureRecognizerFactories)) {
      return;
    }
    _gestureRecognizer?.dispose();
719
    _gestureRecognizer = _PlatformViewGestureRecognizer(handlePointerEvent, gestureRecognizers);
720
    _handlePointerEvent = handlePointerEvent;
721 722
  }

723
  _PlatformViewGestureRecognizer? _gestureRecognizer;
724 725

  @override
726
  bool hitTest(BoxHitTestResult result, { required Offset position }) {
727
    if (_hitTestBehavior == PlatformViewHitTestBehavior.transparent || !size.contains(position)) {
728 729 730
      return false;
    }
    result.add(BoxHitTestEntry(this, position));
731
    return _hitTestBehavior == PlatformViewHitTestBehavior.opaque;
732 733 734
  }

  @override
735
  bool hitTestSelf(Offset position) => _hitTestBehavior != PlatformViewHitTestBehavior.transparent;
736

737
  @override
738
  PointerEnterEventListener? get onEnter => null;
739 740

  @override
741
  PointerExitEventListener? get onExit => null;
742 743 744 745

  @override
  MouseCursor get cursor => MouseCursor.uncontrolled;

746 747 748
  @override
  bool get validForMouseTracker => true;

749 750 751
  @override
  void handleEvent(PointerEvent event, HitTestEntry entry) {
    if (event is PointerDownEvent) {
752
      _gestureRecognizer!.addPointer(event);
753
    }
754 755 756
    if (event is PointerHoverEvent) {
      _handlePointerEvent?.call(event);
    }
757 758 759 760
  }

  @override
  void detach() {
761
    _gestureRecognizer!.reset();
762 763 764
    super.detach();
  }
}