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


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

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

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

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

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

52 53
/// A render object for an Android view.
///
54
/// Requires Android API level 23 or greater.
55
///
56 57
/// [RenderAndroidView] is responsible for sizing, displaying and passing touch events to an
/// Android [View](https://developer.android.com/reference/android/view/View).
58
///
59
/// {@template flutter.rendering.RenderAndroidView.layout}
60
/// The render object's layout behavior is to fill all available space, the parent of this object must
61
/// provide bounded layout constraints.
62
/// {@endtemplate}
63
///
64
/// {@template flutter.rendering.RenderAndroidView.gestures}
65
/// The render object participates in Flutter's gesture arenas, and dispatches touch events to the
66 67 68 69 70
/// 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}
71 72
///
/// See also:
73
///
74 75
///  * [AndroidView] which is a widget that is used to show an Android view.
///  * [PlatformViewsService] which is a service for controlling platform views.
76
class RenderAndroidView extends PlatformViewRenderBox {
77 78
  /// Creates a render object for an Android view.
  RenderAndroidView({
79 80 81
    required AndroidViewController viewController,
    required PlatformViewHitTestBehavior hitTestBehavior,
    required Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers,
82
    Clip clipBehavior = Clip.hardEdge,
83
  }) : _viewController = viewController,
84 85
       _clipBehavior = clipBehavior,
       super(controller: viewController, hitTestBehavior: hitTestBehavior, gestureRecognizers: gestureRecognizers) {
86
    _viewController.pointTransformer = (Offset offset) => globalToLocal(offset);
87
    updateGestureRecognizers(gestureRecognizers);
88
    _viewController.addOnPlatformViewCreatedListener(_onPlatformViewCreated);
89
    this.hitTestBehavior = hitTestBehavior;
90
    _setOffset();
91
  }
92 93 94

  _PlatformViewState _state = _PlatformViewState.uninitialized;

95 96 97 98
  Size? _currentTextureSize;

  bool _isDisposed = false;

99
  /// The Android view controller for the Android view associated with this render object.
100 101 102
  @override
  AndroidViewController get controller => _viewController;

103
  AndroidViewController _viewController;
104

105
  /// Sets a new Android view controller.
106 107
  @override
  set controller(AndroidViewController controller) {
108
    assert(!_isDisposed);
109
    if (_viewController == controller) {
110
      return;
111
    }
112
    _viewController.removeOnPlatformViewCreatedListener(_onPlatformViewCreated);
113 114 115
    super.controller = controller;
    _viewController = controller;
    _viewController.pointTransformer = (Offset offset) => globalToLocal(offset);
116
    _sizePlatformView();
117 118 119 120 121 122
    if (_viewController.isCreated) {
      markNeedsSemanticsUpdate();
    }
    _viewController.addOnPlatformViewCreatedListener(_onPlatformViewCreated);
  }

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

136
  void _onPlatformViewCreated(int id) {
137
    assert(!_isDisposed);
138
    markNeedsSemanticsUpdate();
139 140 141 142 143 144 145 146 147 148 149
  }

  @override
  bool get sizedByParent => true;

  @override
  bool get alwaysNeedsCompositing => true;

  @override
  bool get isRepaintBoundary => true;

150 151 152 153 154
  @override
  Size computeDryLayout(BoxConstraints constraints) {
    return constraints.biggest;
  }

155 156
  @override
  void performResize() {
157
    super.performResize();
158 159 160
    _sizePlatformView();
  }

161
  Future<void> _sizePlatformView() async {
162 163 164
    // 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).
165
    if (_state == _PlatformViewState.resizing || size.isEmpty) {
166
      return;
167
    }
168 169

    _state = _PlatformViewState.resizing;
170
    markNeedsPaint();
171 172 173 174

    Size targetSize;
    do {
      targetSize = size;
175 176 177
      _currentTextureSize = await _viewController.setSize(targetSize);
      if (_isDisposed) {
        return;
178
      }
179 180 181 182 183 184 185 186 187
      // 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();
  }

188
  // Sets the offset of the underlying platform view on the platform side.
189 190 191 192 193 194 195 196 197
  //
  // This allows the Android native view to draw the a11y highlights in the same
  // location on the screen as the platform view widget in the Flutter framework.
  //
  // It also allows platform code to obtain the correct position of the Android
  // native view on the screen.
  void _setOffset() {
    SchedulerBinding.instance.addPostFrameCallback((_) async {
      if (!_isDisposed) {
198
        if (attached) {
199
          await _viewController.setOffset(localToGlobal(Offset.zero));
200
        }
201 202 203 204 205 206
        // Schedule a new post frame callback.
        _setOffset();
      }
    });
  }

207 208
  @override
  void paint(PaintingContext context, Offset offset) {
209
    if (_viewController.textureId == null || _currentTextureSize == null) {
210
      return;
211
    }
212

213 214 215 216 217 218 219 220 221 222 223
    // 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, clip the texture.
    // This guarantees that the size of the texture frame we're painting is always
    // _currentAndroidTextureSize.
    final bool isTextureLargerThanWidget = _currentTextureSize!.width > size.width ||
                                           _currentTextureSize!.height > size.height;
    if (isTextureLargerThanWidget && clipBehavior != Clip.none) {
224
      _clipRectLayer.layer = context.pushClipRect(
225 226 227 228 229
        true,
        offset,
        offset & size,
        _paintTexture,
        clipBehavior: clipBehavior,
230
        oldLayer: _clipRectLayer.layer,
231
      );
232 233
      return;
    }
234
    _clipRectLayer.layer = null;
235 236 237
    _paintTexture(context, offset);
  }

238 239 240 241
  final LayerHandle<ClipRectLayer> _clipRectLayer = LayerHandle<ClipRectLayer>();

  @override
  void dispose() {
242
    _isDisposed = true;
243
    _clipRectLayer.layer = null;
244
    _viewController.removeOnPlatformViewCreatedListener(_onPlatformViewCreated);
245 246
    super.dispose();
  }
247

248
  void _paintTexture(PaintingContext context, Offset offset) {
249
    if (_currentTextureSize == null) {
250
      return;
251
    }
252

253
    context.addLayer(TextureLayer(
254
      rect: offset & _currentTextureSize!,
255
      textureId: _viewController.textureId!,
256 257
    ));
  }
258

259
  @override
260 261 262 263
  void describeSemanticsConfiguration(SemanticsConfiguration config) {
    // Don't call the super implementation since `platformViewId` should
    // be set only when the platform view is created, but the concept of
    // a "created" platform view belongs to this subclass.
264 265 266
    config.isSemanticBoundary = true;

    if (_viewController.isCreated) {
267
      config.platformViewId = _viewController.viewId;
268 269
    }
  }
270 271
}

272 273
/// A render object for an iOS UIKit UIView.
///
274 275 276 277 278
/// [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.
///
279
/// {@macro flutter.rendering.RenderAndroidView.layout}
280
///
281
/// {@macro flutter.rendering.RenderAndroidView.gestures}
282
///
283
/// See also:
284
///
285 286 287 288 289
///  * [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.
  ///
290
  /// The `viewId`, `hitTestBehavior`, and `gestureRecognizers` parameters must not be null.
291
  RenderUiKitView({
292 293 294
    required UiKitViewController viewController,
    required this.hitTestBehavior,
    required Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers,
295
  }) : _viewController = viewController {
296 297
    updateGestureRecognizers(gestureRecognizers);
  }
298 299 300 301 302 303


  /// 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].
304 305
  UiKitViewController get viewController => _viewController;
  UiKitViewController _viewController;
306 307 308 309 310 311
  set viewController(UiKitViewController value) {
    if (_viewController == value) {
      return;
    }
    final bool needsSemanticsUpdate = _viewController.id != value.id;
    _viewController = value;
312
    markNeedsPaint();
313 314 315
    if (needsSemanticsUpdate) {
      markNeedsSemanticsUpdate();
    }
316 317 318 319 320 321 322
  }

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

323
  /// {@macro flutter.rendering.PlatformViewRenderBox.updateGestureRecognizers}
324 325
  void updateGestureRecognizers(Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers) {
    assert(
326 327 328 329
      _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.',
    );
330 331 332 333 334 335 336
    if (_factoryTypesSetEquals(gestureRecognizers, _gestureRecognizer?.gestureRecognizerFactories)) {
      return;
    }
    _gestureRecognizer?.dispose();
    _gestureRecognizer = _UiKitViewGestureRecognizer(viewController, gestureRecognizers);
  }

337 338 339 340 341 342 343 344 345
  @override
  bool get sizedByParent => true;

  @override
  bool get alwaysNeedsCompositing => true;

  @override
  bool get isRepaintBoundary => true;

346
  _UiKitViewGestureRecognizer? _gestureRecognizer;
347

348
  PointerEvent? _lastPointerDownEvent;
349

350
  @override
351 352
  Size computeDryLayout(BoxConstraints constraints) {
    return constraints.biggest;
353 354 355 356 357 358
  }

  @override
  void paint(PaintingContext context, Offset offset) {
    context.addLayer(PlatformViewLayer(
      rect: offset & size,
359
      viewId: _viewController.id,
360 361 362 363
    ));
  }

  @override
364
  bool hitTest(BoxHitTestResult result, { Offset? position }) {
365
    if (hitTestBehavior == PlatformViewHitTestBehavior.transparent || !size.contains(position!)) {
366
      return false;
367
    }
368 369 370 371 372 373
    result.add(BoxHitTestEntry(this, position));
    return hitTestBehavior == PlatformViewHitTestBehavior.opaque;
  }

  @override
  bool hitTestSelf(Offset position) => hitTestBehavior != PlatformViewHitTestBehavior.transparent;
374 375 376

  @override
  void handleEvent(PointerEvent event, HitTestEntry entry) {
377 378 379
    if (event is! PointerDownEvent) {
      return;
    }
380
    _gestureRecognizer!.addPointer(event);
381
    _lastPointerDownEvent = event.original ?? event;
382 383 384 385 386 387 388
  }

  // This is registered as a global PointerRoute while the render object is attached.
  void _handleGlobalPointerEvent(PointerEvent event) {
    if (event is! PointerDownEvent) {
      return;
    }
389
    if (!(Offset.zero & size).contains(globalToLocal(event.position))) {
390 391
      return;
    }
392
    if ((event.original ?? event) != _lastPointerDownEvent) {
393 394 395 396 397
      // 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();
398
    }
399 400 401
    _lastPointerDownEvent = null;
  }

402 403 404 405 406 407 408
  @override
  void describeSemanticsConfiguration (SemanticsConfiguration config) {
    super.describeSemanticsConfiguration(config);
    config.isSemanticBoundary = true;
    config.platformViewId = _viewController.id;
  }

409 410 411
  @override
  void attach(PipelineOwner owner) {
    super.attach(owner);
412
    GestureBinding.instance.pointerRouter.addGlobalRoute(_handleGlobalPointerEvent);
413 414 415 416
  }

  @override
  void detach() {
417
    GestureBinding.instance.pointerRouter.removeGlobalRoute(_handleGlobalPointerEvent);
418
    _gestureRecognizer!.reset();
419 420 421 422 423
    super.detach();
  }
}

// This recognizer constructs gesture recognizers from a set of gesture recognizer factories
424
// it was give, adds all of them to a gesture arena team with the _UiKitViewGestureRecognizer
425 426 427 428
// 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 {
429 430
  _UiKitViewGestureRecognizer(
    this.controller,
431 432
    this.gestureRecognizerFactories
  ) {
433 434
    team = GestureArenaTeam()
      ..captain = this;
435 436
    _gestureRecognizers = gestureRecognizerFactories.map(
      (Factory<OneSequenceGestureRecognizer> recognizerFactory) {
437 438 439 440 441 442 443 444 445 446 447 448 449
        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;
450 451 452 453 454 455 456 457
      },
    ).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;
458
  late Set<OneSequenceGestureRecognizer> _gestureRecognizers;
459 460 461 462

  final UiKitViewController controller;

  @override
463
  void addAllowedPointer(PointerDownEvent event) {
464
    super.addAllowedPointer(event);
465
    for (final OneSequenceGestureRecognizer recognizer in _gestureRecognizers) {
466 467 468 469 470 471 472 473
      recognizer.addPointer(event);
    }
  }

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

  @override
474
  void didStopTrackingLastPointer(int pointer) { }
475 476 477 478 479 480 481 482 483 484 485 486 487

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

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

  @override
  void rejectGesture(int pointer) {
488
    controller.rejectGesture();
489 490 491 492 493
  }

  void reset() {
    resolve(GestureDisposition.rejected);
  }
494 495
}

496
typedef _HandlePointerEvent = Future<void> Function(PointerEvent event);
497

498
// This recognizer constructs gesture recognizers from a set of gesture recognizer factories
499
// it was give, adds all of them to a gesture arena team with the _PlatformViewGestureRecognizer
500
// as the team captain.
501 502 503 504 505 506
// 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,
507 508
    this.gestureRecognizerFactories
  ) {
509 510
    team = GestureArenaTeam()
      ..captain = this;
511
    _gestureRecognizers = gestureRecognizerFactories.map(
512
      (Factory<OneSequenceGestureRecognizer> recognizerFactory) {
513 514 515 516 517 518 519 520 521 522 523 524 525
        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;
526
      },
527
    ).toSet();
528
    _handlePointerEvent = handlePointerEvent;
529 530
  }

531
  late _HandlePointerEvent _handlePointerEvent;
532 533 534

  // 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
535
  // the cached events are dispatched to `_handlePointerEvent`, if we lose the arena we clear the cache for
536
  // the pointer.
537
  final Map<int, List<PointerEvent>> cachedEvents = <int, List<PointerEvent>>{};
538 539

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

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

  @override
550
  void addAllowedPointer(PointerDownEvent event) {
551
    super.addAllowedPointer(event);
552
    for (final OneSequenceGestureRecognizer recognizer in _gestureRecognizers) {
553 554 555 556 557
      recognizer.addPointer(event);
    }
  }

  @override
558
  String get debugDescription => 'Platform view';
559 560

  @override
561
  void didStopTrackingLastPointer(int pointer) { }
562 563 564 565

  @override
  void handleEvent(PointerEvent event) {
    if (!forwardedPointers.contains(event.pointer)) {
566
      _cacheEvent(event);
567
    } else {
568
      _handlePointerEvent(event);
569 570 571 572 573 574
    }
    stopTrackingIfPointerNoLongerDown(event);
  }

  @override
  void acceptGesture(int pointer) {
575
    _flushPointerCache(pointer);
576 577 578 579 580 581 582 583 584
    forwardedPointers.add(pointer);
  }

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

585
  void _cacheEvent(PointerEvent event) {
586 587 588
    if (!cachedEvents.containsKey(event.pointer)) {
      cachedEvents[event.pointer] = <PointerEvent> [];
    }
589
    cachedEvents[event.pointer]!.add(event);
590 591
  }

592 593
  void _flushPointerCache(int pointer) {
    cachedEvents.remove(pointer)?.forEach(_handlePointerEvent);
594 595 596 597 598 599 600 601 602 603 604 605 606 607
  }

  @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);
608 609 610
  }
}

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

629 630 631
  /// The controller for this render object.
  PlatformViewController get controller => _controller;
  PlatformViewController _controller;
632
  /// This value must not be null, and setting it to a new value will result in a repaint.
633
  set controller(covariant PlatformViewController controller) {
634
    assert(controller.viewId > -1);
635

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

647 648 649 650 651 652 653 654 655 656 657 658 659
  /// {@template flutter.rendering.PlatformViewRenderBox.updateGestureRecognizers}
  /// Updates which gestures should be forwarded to the platform view.
  ///
  /// 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
  /// gesture arena, the entire pointer event sequence starting from the pointer down event
  /// will be dispatched to the Android view.
  ///
  /// 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.
  /// {@endtemplate}
660 661 662
  ///
  /// Any active gesture arena the `PlatformView` participates in is rejected when the
  /// set of gesture recognizers is changed.
663 664
  void updateGestureRecognizers(Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers) {
    _updateGestureRecognizersWithCallBack(gestureRecognizers, _controller.dispatchPointerEvent);
665 666
  }

667 668 669 670 671 672 673 674 675 676
  @override
  bool get sizedByParent => true;

  @override
  bool get alwaysNeedsCompositing => true;

  @override
  bool get isRepaintBoundary => true;

  @override
677 678
  Size computeDryLayout(BoxConstraints constraints) {
    return constraints.biggest;
679 680 681 682 683
  }

  @override
  void paint(PaintingContext context, Offset offset) {
    context.addLayer(PlatformViewLayer(
684 685 686
      rect: offset & size,
      viewId: _controller.viewId,
    ));
687 688 689
  }

  @override
690
  void describeSemanticsConfiguration(SemanticsConfiguration config) {
691 692 693 694 695
    super.describeSemanticsConfiguration(config);
    config.isSemanticBoundary = true;
    config.platformViewId = _controller.viewId;
  }
}
696 697

/// The Mixin handling the pointer events and gestures of a platform view render box.
698
mixin _PlatformViewGestureMixin on RenderBox implements MouseTrackerAnnotation {
699 700

  /// How to behave during hit testing.
701 702 703 704
  // Changing _hitTestBehavior might affect which objects are considered hovered over.
  set hitTestBehavior(PlatformViewHitTestBehavior value) {
    if (value != _hitTestBehavior) {
      _hitTestBehavior = value;
705
      if (owner != null) {
706
        markNeedsPaint();
707
      }
708 709
    }
  }
710
  PlatformViewHitTestBehavior? _hitTestBehavior;
711

712
  _HandlePointerEvent? _handlePointerEvent;
713

714
  /// {@macro flutter.rendering.RenderAndroidView.updateGestureRecognizers}
715 716 717
  ///
  /// Any active gesture arena the `PlatformView` participates in is rejected when the
  /// set of gesture recognizers is changed.
718
  void _updateGestureRecognizersWithCallBack(Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers, _HandlePointerEvent handlePointerEvent) {
719
    assert(
720 721 722 723
      _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.',
    );
724 725 726 727
    if (_factoryTypesSetEquals(gestureRecognizers, _gestureRecognizer?.gestureRecognizerFactories)) {
      return;
    }
    _gestureRecognizer?.dispose();
728
    _gestureRecognizer = _PlatformViewGestureRecognizer(handlePointerEvent, gestureRecognizers);
729
    _handlePointerEvent = handlePointerEvent;
730 731
  }

732
  _PlatformViewGestureRecognizer? _gestureRecognizer;
733 734

  @override
735
  bool hitTest(BoxHitTestResult result, { required Offset position }) {
736
    if (_hitTestBehavior == PlatformViewHitTestBehavior.transparent || !size.contains(position)) {
737 738 739
      return false;
    }
    result.add(BoxHitTestEntry(this, position));
740
    return _hitTestBehavior == PlatformViewHitTestBehavior.opaque;
741 742 743
  }

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

746
  @override
747
  PointerEnterEventListener? get onEnter => null;
748 749

  @override
750
  PointerExitEventListener? get onExit => null;
751 752 753 754

  @override
  MouseCursor get cursor => MouseCursor.uncontrolled;

755 756 757
  @override
  bool get validForMouseTracker => true;

758 759 760
  @override
  void handleEvent(PointerEvent event, HitTestEntry entry) {
    if (event is PointerDownEvent) {
761
      _gestureRecognizer!.addPointer(event);
762
    }
763 764 765
    if (event is PointerHoverEvent) {
      _handlePointerEvent?.call(event);
    }
766 767 768 769
  }

  @override
  void detach() {
770
    _gestureRecognizer!.reset();
771 772 773
    super.detach();
  }
}