platform_view.dart 26.7 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
import 'package:flutter/services.dart';

import 'box.dart';
import 'layer.dart';
14
import 'mouse_tracker.dart';
15 16 17
import 'object.dart';


18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
/// 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,
}

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

40
bool _factoryTypesSetEquals<T>(Set<Factory<T>>? a, Set<Factory<T>>? b) {
41 42 43 44 45 46 47 48 49 50 51 52 53
  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();
}

54 55
/// A render object for an Android view.
///
56 57
/// Requires Android API level 20 or greater.
///
58 59
/// [RenderAndroidView] is responsible for sizing, displaying and passing touch events to an
/// Android [View](https://developer.android.com/reference/android/view/View).
60
///
61
/// {@template flutter.rendering.RenderAndroidView.layout}
62
/// The render object's layout behavior is to fill all available space, the parent of this object must
63
/// provide bounded layout constraints.
64
/// {@endtemplate}
65
///
66
/// {@template flutter.rendering.RenderAndroidView.gestures}
67
/// The render object participates in Flutter's gesture arenas, and dispatches touch events to the
68 69 70 71 72
/// 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}
73 74
///
/// See also:
75
///
76 77
///  * [AndroidView] which is a widget that is used to show an Android view.
///  * [PlatformViewsService] which is a service for controlling platform views.
78
class RenderAndroidView extends RenderBox with _PlatformViewGestureMixin {
79 80 81

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

  _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);
108
    assert(viewController != null);
109 110
    if (_viewController == viewController)
      return;
111
    _viewController.removeOnPlatformViewCreatedListener(_onPlatformViewCreated);
112 113
    _viewController = viewController;
    _sizePlatformView();
114 115 116 117 118 119
    if (_viewController.isCreated) {
      markNeedsSemanticsUpdate();
    }
    _viewController.addOnPlatformViewCreatedListener(_onPlatformViewCreated);
  }

120
  /// {@macro flutter.material.Material.clipBehavior}
121 122 123 124 125 126 127 128 129 130 131 132 133
  ///
  /// 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();
    }
  }

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

138
  /// {@template flutter.rendering.RenderAndroidView.updateGestureRecognizers}
139
  /// Updates which gestures should be forwarded to the platform view.
140
  ///
141 142
  /// 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
143 144
  /// gesture arena, the entire pointer event sequence starting from the pointer down event
  /// will be dispatched to the Android view.
145 146 147 148 149
  ///
  /// 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.
150
  /// {@endtemplate}
151 152 153 154
  ///
  /// 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) {
155
    _updateGestureRecognizersWithCallBack(gestureRecognizers, _viewController.dispatchPointerEvent);
156 157
  }

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

  @override
  bool get alwaysNeedsCompositing => true;

  @override
  bool get isRepaintBoundary => true;

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

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

178
  late Size _currentAndroidViewSize;
179

180
  Future<void> _sizePlatformView() async {
181 182 183 184
    // 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) {
185 186 187 188
      return;
    }

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

    Size targetSize;
    do {
      targetSize = size;
194 195
      await _viewController.setSize(targetSize);
      _currentAndroidViewSize = targetSize;
196 197 198 199 200 201 202 203 204 205 206 207 208 209
      // 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;

210 211
    // 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).
212
    if ((size.width < _currentAndroidViewSize.width || size.height < _currentAndroidViewSize.height) && clipBehavior != Clip.none) {
213 214
      _clipRectLayer = context.pushClipRect(true, offset, offset & size, _paintTexture, clipBehavior: clipBehavior,
          oldLayer: _clipRectLayer);
215 216
      return;
    }
217
    _clipRectLayer = null;
218 219 220
    _paintTexture(context, offset);
  }

221 222
  ClipRectLayer? _clipRectLayer;

223 224 225 226 227 228 229 230 231 232
  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.
233
    context.addLayer(TextureLayer(
234
      rect: offset & _currentAndroidViewSize,
235
      textureId: _viewController.textureId!,
236
      freeze: _state == _PlatformViewState.resizing,
237 238
    ));
  }
239

240 241 242 243 244 245 246
  @override
  void describeSemanticsConfiguration (SemanticsConfiguration config) {
    super.describeSemanticsConfiguration(config);

    config.isSemanticBoundary = true;

    if (_viewController.isCreated) {
247
      config.platformViewId = _viewController.viewId;
248 249
    }
  }
250 251
}

252 253
/// A render object for an iOS UIKit UIView.
///
254
/// {@template flutter.rendering.RenderUiKitView}
255
/// Embedding UIViews is still preview-quality. To enable the preview for an iOS app add a boolean
256 257
/// 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
258
/// [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)
259
/// {@endtemplate}
260 261 262 263 264 265
///
/// [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.
///
266
/// {@macro flutter.rendering.RenderAndroidView.layout}
267
///
268
/// {@macro flutter.rendering.RenderAndroidView.gestures}
269
///
270
/// See also:
271
///
272 273 274 275 276
///  * [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.
  ///
277
  /// The `viewId`, `hitTestBehavior`, and `gestureRecognizers` parameters must not be null.
278
  RenderUiKitView({
279 280 281
    required UiKitViewController viewController,
    required this.hitTestBehavior,
    required Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers,
282
  }) : assert(viewController != null),
283
       assert(hitTestBehavior != null),
284 285 286 287
       assert(gestureRecognizers != null),
       _viewController = viewController {
    updateGestureRecognizers(gestureRecognizers);
  }
288 289 290 291 292 293


  /// 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].
294 295
  UiKitViewController get viewController => _viewController;
  UiKitViewController _viewController;
296 297
  set viewController(UiKitViewController viewController) {
    assert(viewController != null);
298
    final bool needsSemanticsUpdate = _viewController.id != viewController.id;
299
    _viewController = viewController;
300
    markNeedsPaint();
301 302 303
    if (needsSemanticsUpdate) {
      markNeedsSemanticsUpdate();
    }
304 305 306 307 308 309 310
  }

  /// 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;

311
  /// {@macro flutter.rendering.RenderAndroidView.updateGestureRecognizers}
312 313 314 315 316 317 318 319 320 321 322 323 324
  void updateGestureRecognizers(Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers) {
    assert(gestureRecognizers != null);
    assert(
    _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.',);
    if (_factoryTypesSetEquals(gestureRecognizers, _gestureRecognizer?.gestureRecognizerFactories)) {
      return;
    }
    _gestureRecognizer?.dispose();
    _gestureRecognizer = _UiKitViewGestureRecognizer(viewController, gestureRecognizers);
  }

325 326 327 328 329 330 331 332 333
  @override
  bool get sizedByParent => true;

  @override
  bool get alwaysNeedsCompositing => true;

  @override
  bool get isRepaintBoundary => true;

334
  _UiKitViewGestureRecognizer? _gestureRecognizer;
335

336
  PointerEvent? _lastPointerDownEvent;
337

338
  @override
339 340
  Size computeDryLayout(BoxConstraints constraints) {
    return constraints.biggest;
341 342 343 344 345 346
  }

  @override
  void paint(PaintingContext context, Offset offset) {
    context.addLayer(PlatformViewLayer(
      rect: offset & size,
347
      viewId: _viewController.id,
348 349 350 351
    ));
  }

  @override
352 353
  bool hitTest(BoxHitTestResult result, { Offset? position }) {
    if (hitTestBehavior == PlatformViewHitTestBehavior.transparent || !size.contains(position!))
354 355 356 357 358 359 360
      return false;
    result.add(BoxHitTestEntry(this, position));
    return hitTestBehavior == PlatformViewHitTestBehavior.opaque;
  }

  @override
  bool hitTestSelf(Offset position) => hitTestBehavior != PlatformViewHitTestBehavior.transparent;
361 362 363

  @override
  void handleEvent(PointerEvent event, HitTestEntry entry) {
364 365 366
    if (event is! PointerDownEvent) {
      return;
    }
367
    _gestureRecognizer!.addPointer(event);
368
    _lastPointerDownEvent = event.original ?? event;
369 370 371 372 373 374 375
  }

  // This is registered as a global PointerRoute while the render object is attached.
  void _handleGlobalPointerEvent(PointerEvent event) {
    if (event is! PointerDownEvent) {
      return;
    }
376
    if (!(Offset.zero & size).contains(globalToLocal(event.position))) {
377 378
      return;
    }
379
    if ((event.original ?? event) != _lastPointerDownEvent) {
380 381 382 383 384
      // 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();
385
    }
386 387 388
    _lastPointerDownEvent = null;
  }

389 390 391 392 393 394 395
  @override
  void describeSemanticsConfiguration (SemanticsConfiguration config) {
    super.describeSemanticsConfiguration(config);
    config.isSemanticBoundary = true;
    config.platformViewId = _viewController.id;
  }

396 397 398
  @override
  void attach(PipelineOwner owner) {
    super.attach(owner);
399
    GestureBinding.instance!.pointerRouter.addGlobalRoute(_handleGlobalPointerEvent);
400 401 402 403
  }

  @override
  void detach() {
404 405
    GestureBinding.instance!.pointerRouter.removeGlobalRoute(_handleGlobalPointerEvent);
    _gestureRecognizer!.reset();
406 407 408 409 410 411 412 413 414 415
    super.detach();
  }
}

// This recognizer constructs gesture recognizers from a set of gesture recognizer factories
// it was give, adds all of them to a gesture arena team with the _UiKitViewGesturrRecognizer
// 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 {
416 417 418
  _UiKitViewGestureRecognizer(
    this.controller,
    this.gestureRecognizerFactories, {
419
    PointerDeviceKind? kind,
420
  }) : super(kind: kind) {
421 422
    team = GestureArenaTeam()
      ..captain = this;
423 424
    _gestureRecognizers = gestureRecognizerFactories.map(
      (Factory<OneSequenceGestureRecognizer> recognizerFactory) {
425 426 427 428 429 430 431 432 433 434 435 436 437
        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;
438 439 440 441 442 443 444 445 446
      },
    ).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;
447
  late Set<OneSequenceGestureRecognizer> _gestureRecognizers;
448 449 450 451

  final UiKitViewController controller;

  @override
452
  void addAllowedPointer(PointerDownEvent event) {
453
    startTrackingPointer(event.pointer, event.transform);
454
    for (final OneSequenceGestureRecognizer recognizer in _gestureRecognizers) {
455 456 457 458 459 460 461 462
      recognizer.addPointer(event);
    }
  }

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

  @override
463
  void didStopTrackingLastPointer(int pointer) { }
464 465 466 467 468 469 470 471 472 473 474 475 476

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

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

  @override
  void rejectGesture(int pointer) {
477
    controller.rejectGesture();
478 479 480 481 482
  }

  void reset() {
    resolve(GestureDisposition.rejected);
  }
483 484
}

485
typedef _HandlePointerEvent = Future<void> Function(PointerEvent event);
486

487
// This recognizer constructs gesture recognizers from a set of gesture recognizer factories
488
// it was give, adds all of them to a gesture arena team with the _PlatformViewGestureRecognizer
489
// as the team captain.
490 491 492 493 494 495
// 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,
496
    this.gestureRecognizerFactories, {
497
    PointerDeviceKind? kind,
498
  }) : super(kind: kind) {
499 500
    team = GestureArenaTeam()
      ..captain = this;
501
    _gestureRecognizers = gestureRecognizerFactories.map(
502
      (Factory<OneSequenceGestureRecognizer> recognizerFactory) {
503 504 505 506 507 508 509 510 511 512 513 514 515
        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;
516
      },
517
    ).toSet();
518
    _handlePointerEvent = handlePointerEvent;
519 520
  }

521
  late _HandlePointerEvent _handlePointerEvent;
522 523 524

  // 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
525
  // the cached events are dispatched to `_handlePointerEvent`, if we lose the arena we clear the cache for
526
  // the pointer.
527
  final Map<int, List<PointerEvent>> cachedEvents = <int, List<PointerEvent>>{};
528 529

  // Pointer for which we have already won the arena, events for pointers in this set are
530
  // immediately dispatched to `_handlePointerEvent`.
531
  final Set<int> forwardedPointers = <int>{};
532 533 534 535

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

  @override
540
  void addAllowedPointer(PointerDownEvent event) {
541
    startTrackingPointer(event.pointer, event.transform);
542
    for (final OneSequenceGestureRecognizer recognizer in _gestureRecognizers) {
543 544 545 546 547
      recognizer.addPointer(event);
    }
  }

  @override
548
  String get debugDescription => 'Platform view';
549 550

  @override
551
  void didStopTrackingLastPointer(int pointer) { }
552 553 554 555

  @override
  void handleEvent(PointerEvent event) {
    if (!forwardedPointers.contains(event.pointer)) {
556
      _cacheEvent(event);
557
    } else {
558
      _handlePointerEvent(event);
559 560 561 562 563 564
    }
    stopTrackingIfPointerNoLongerDown(event);
  }

  @override
  void acceptGesture(int pointer) {
565
    _flushPointerCache(pointer);
566 567 568 569 570 571 572 573 574
    forwardedPointers.add(pointer);
  }

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

575
  void _cacheEvent(PointerEvent event) {
576 577 578
    if (!cachedEvents.containsKey(event.pointer)) {
      cachedEvents[event.pointer] = <PointerEvent> [];
    }
579
    cachedEvents[event.pointer]!.add(event);
580 581
  }

582 583
  void _flushPointerCache(int pointer) {
    cachedEvents.remove(pointer)?.forEach(_handlePointerEvent);
584 585 586 587 588 589 590 591 592 593 594 595 596 597
  }

  @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);
598 599 600
  }
}

601 602
/// A render object for embedding a platform view.
///
603 604 605
/// [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 {
606 607 608 609 610

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

  /// 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;
633 634
    _controller = controller;
    markNeedsPaint();
635 636 637 638 639
    if (needsSemanticsUpdate) {
      markNeedsSemanticsUpdate();
    }
  }

640
  /// {@macro  flutter.rendering.RenderAndroidView.updateGestureRecognizers}
641 642 643
  ///
  /// Any active gesture arena the `PlatformView` participates in is rejected when the
  /// set of gesture recognizers is changed.
644 645
  void updateGestureRecognizers(Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers) {
    _updateGestureRecognizersWithCallBack(gestureRecognizers, _controller.dispatchPointerEvent);
646 647
  }

648 649 650 651 652 653 654 655 656 657 658 659
  PlatformViewController _controller;

  @override
  bool get sizedByParent => true;

  @override
  bool get alwaysNeedsCompositing => true;

  @override
  bool get isRepaintBoundary => true;

  @override
660 661
  Size computeDryLayout(BoxConstraints constraints) {
    return constraints.biggest;
662 663 664 665 666 667
  }

  @override
  void paint(PaintingContext context, Offset offset) {
    assert(_controller.viewId != null);
    context.addLayer(PlatformViewLayer(
668 669 670
      rect: offset & size,
      viewId: _controller.viewId,
    ));
671 672 673 674 675 676 677 678 679 680
  }

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

/// The Mixin handling the pointer events and gestures of a platform view render box.
683
mixin _PlatformViewGestureMixin on RenderBox implements MouseTrackerAnnotation {
684 685

  /// How to behave during hit testing.
686 687 688 689 690
  // Changing _hitTestBehavior might affect which objects are considered hovered over.
  set hitTestBehavior(PlatformViewHitTestBehavior value) {
    if (value != _hitTestBehavior) {
      _hitTestBehavior = value;
      if (owner != null)
691
        markNeedsPaint();
692 693
    }
  }
694
  PlatformViewHitTestBehavior? _hitTestBehavior;
695

696
  _HandlePointerEvent? _handlePointerEvent;
697

698
  /// {@macro  flutter.rendering.RenderAndroidView.updateGestureRecognizers}
699 700 701
  ///
  /// Any active gesture arena the `PlatformView` participates in is rejected when the
  /// set of gesture recognizers is changed.
702
  void _updateGestureRecognizersWithCallBack(Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers, _HandlePointerEvent handlePointerEvent) {
703 704 705 706 707 708 709 710 711
    assert(gestureRecognizers != null);
    assert(
    _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.',);
    if (_factoryTypesSetEquals(gestureRecognizers, _gestureRecognizer?.gestureRecognizerFactories)) {
      return;
    }
    _gestureRecognizer?.dispose();
712
    _gestureRecognizer = _PlatformViewGestureRecognizer(handlePointerEvent, gestureRecognizers);
713
    _handlePointerEvent = handlePointerEvent;
714 715
  }

716
  _PlatformViewGestureRecognizer? _gestureRecognizer;
717 718

  @override
719
  bool hitTest(BoxHitTestResult result, { required Offset position }) {
720
    if (_hitTestBehavior == PlatformViewHitTestBehavior.transparent || !size.contains(position)) {
721 722 723
      return false;
    }
    result.add(BoxHitTestEntry(this, position));
724
    return _hitTestBehavior == PlatformViewHitTestBehavior.opaque;
725 726 727
  }

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

730
  @override
731
  PointerEnterEventListener? get onEnter => null;
732 733

  @override
734
  PointerExitEventListener? get onExit => null;
735 736 737 738

  @override
  MouseCursor get cursor => MouseCursor.uncontrolled;

739 740 741
  @override
  bool get validForMouseTracker => true;

742 743 744
  @override
  void handleEvent(PointerEvent event, HitTestEntry entry) {
    if (event is PointerDownEvent) {
745
      _gestureRecognizer!.addPointer(event);
746
    }
747 748 749
    if (event is PointerHoverEvent) {
      _handlePointerEvent?.call(event);
    }
750 751 752 753
  }

  @override
  void detach() {
754
    _gestureRecognizer!.reset();
755 756 757
    super.detach();
  }
}