platform_view.dart 26 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 8
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:async';
import 'dart:ui';

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

import 'box.dart';
import 'layer.dart';
15
import 'mouse_cursor.dart';
16
import 'mouse_tracking.dart';
17 18 19
import 'object.dart';


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

36 37 38 39 40 41
enum _PlatformViewState {
  uninitialized,
  resizing,
  ready,
}

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

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

  /// Creates a render object for an Android view.
  RenderAndroidView({
84 85 86
    required AndroidViewController viewController,
    required PlatformViewHitTestBehavior hitTestBehavior,
    required Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers,
87
  }) : assert(viewController != null),
88
       assert(hitTestBehavior != null),
89
       assert(gestureRecognizers != null),
90
       _viewController = viewController {
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 119 120
    if (_viewController.isCreated) {
      markNeedsSemanticsUpdate();
    }
    _viewController.addOnPlatformViewCreatedListener(_onPlatformViewCreated);
  }

  void _onPlatformViewCreated(int id) {
    markNeedsSemanticsUpdate();
121 122
  }

123 124
  /// {@template flutter.rendering.platformView.updateGestureRecognizers}
  /// Updates which gestures should be forwarded to the platform view.
125
  ///
126 127
  /// 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
128 129
  /// gesture arena, the entire pointer event sequence starting from the pointer down event
  /// will be dispatched to the Android view.
130 131 132 133 134
  ///
  /// 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.
135
  /// {@endtemplate}
136 137 138 139
  ///
  /// 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) {
140
    _updateGestureRecognizersWithCallBack(gestureRecognizers, _viewController.dispatchPointerEvent);
141 142
  }

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
  @override
  bool get sizedByParent => true;

  @override
  bool get alwaysNeedsCompositing => true;

  @override
  bool get isRepaintBoundary => true;

  @override
  void performResize() {
    size = constraints.biggest;
    _sizePlatformView();
  }

158
  late Size _currentAndroidViewSize;
159

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

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

    Size targetSize;
    do {
      targetSize = size;
174 175
      await _viewController.setSize(targetSize);
      _currentAndroidViewSize = targetSize;
176 177 178 179 180 181 182 183 184 185 186 187 188 189
      // 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;

190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
    // 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).
    if (size.width < _currentAndroidViewSize.width || size.height < _currentAndroidViewSize.height) {
      context.pushClipRect(true, offset, offset & size, _paintTexture);
      return;
    }

    _paintTexture(context, offset);
  }

  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.
210
    context.addLayer(TextureLayer(
211
      rect: offset & _currentAndroidViewSize,
212
      textureId: _viewController.textureId!,
213
      freeze: _state == _PlatformViewState.resizing,
214 215
    ));
  }
216

217 218 219 220 221 222 223
  @override
  void describeSemanticsConfiguration (SemanticsConfiguration config) {
    super.describeSemanticsConfiguration(config);

    config.isSemanticBoundary = true;

    if (_viewController.isCreated) {
224
      config.platformViewId = _viewController.viewId;
225 226
    }
  }
227 228
}

229 230 231
/// A render object for an iOS UIKit UIView.
///
/// {@template flutter.rendering.platformView.preview}
232
/// Embedding UIViews is still preview-quality. To enable the preview for an iOS app add a boolean
233 234
/// 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
235
/// [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)
236
/// {@endtemplate}
237 238 239 240 241 242 243 244
///
/// [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.
///
/// {@macro flutter.rendering.platformView.layout}
///
245 246
/// {@macro flutter.rendering.platformView.gestures}
///
247
/// See also:
248
///
249 250 251 252 253
///  * [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.
  ///
254
  /// The `viewId`, `hitTestBehavior`, and `gestureRecognizers` parameters must not be null.
255
  RenderUiKitView({
256 257 258
    required UiKitViewController viewController,
    required this.hitTestBehavior,
    required Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers,
259
  }) : assert(viewController != null),
260
       assert(hitTestBehavior != null),
261 262 263 264
       assert(gestureRecognizers != null),
       _viewController = viewController {
    updateGestureRecognizers(gestureRecognizers);
  }
265 266 267 268 269 270


  /// 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].
271 272
  UiKitViewController get viewController => _viewController;
  UiKitViewController _viewController;
273 274
  set viewController(UiKitViewController viewController) {
    assert(viewController != null);
275
    final bool needsSemanticsUpdate = _viewController.id != viewController.id;
276
    _viewController = viewController;
277
    markNeedsPaint();
278 279 280
    if (needsSemanticsUpdate) {
      markNeedsSemanticsUpdate();
    }
281 282 283 284 285 286 287
  }

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

288 289 290 291 292 293 294 295 296 297 298 299 300 301
  /// {@macro flutter.rendering.platformView.updateGestureRecognizers}
  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);
  }

302 303 304 305 306 307 308 309 310
  @override
  bool get sizedByParent => true;

  @override
  bool get alwaysNeedsCompositing => true;

  @override
  bool get isRepaintBoundary => true;

311
  _UiKitViewGestureRecognizer? _gestureRecognizer;
312

313
  PointerEvent? _lastPointerDownEvent;
314

315 316 317 318 319 320 321 322 323
  @override
  void performResize() {
    size = constraints.biggest;
  }

  @override
  void paint(PaintingContext context, Offset offset) {
    context.addLayer(PlatformViewLayer(
      rect: offset & size,
324
      viewId: _viewController.id,
325 326 327 328
    ));
  }

  @override
329 330
  bool hitTest(BoxHitTestResult result, { Offset? position }) {
    if (hitTestBehavior == PlatformViewHitTestBehavior.transparent || !size.contains(position!))
331 332 333 334 335 336 337
      return false;
    result.add(BoxHitTestEntry(this, position));
    return hitTestBehavior == PlatformViewHitTestBehavior.opaque;
  }

  @override
  bool hitTestSelf(Offset position) => hitTestBehavior != PlatformViewHitTestBehavior.transparent;
338 339 340

  @override
  void handleEvent(PointerEvent event, HitTestEntry entry) {
341 342 343
    if (event is! PointerDownEvent) {
      return;
    }
344
    _gestureRecognizer!.addPointer(event);
345
    _lastPointerDownEvent = event.original ?? event;
346 347 348 349 350 351 352
  }

  // This is registered as a global PointerRoute while the render object is attached.
  void _handleGlobalPointerEvent(PointerEvent event) {
    if (event is! PointerDownEvent) {
      return;
    }
353
    if (!(Offset.zero & size).contains(globalToLocal(event.position))) {
354 355
      return;
    }
356
    if ((event.original ?? event) != _lastPointerDownEvent) {
357 358 359 360 361
      // 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();
362
    }
363 364 365
    _lastPointerDownEvent = null;
  }

366 367 368 369 370 371 372
  @override
  void describeSemanticsConfiguration (SemanticsConfiguration config) {
    super.describeSemanticsConfiguration(config);
    config.isSemanticBoundary = true;
    config.platformViewId = _viewController.id;
  }

373 374 375
  @override
  void attach(PipelineOwner owner) {
    super.attach(owner);
376
    GestureBinding.instance!.pointerRouter.addGlobalRoute(_handleGlobalPointerEvent);
377 378 379 380
  }

  @override
  void detach() {
381 382
    GestureBinding.instance!.pointerRouter.removeGlobalRoute(_handleGlobalPointerEvent);
    _gestureRecognizer!.reset();
383 384 385 386 387 388 389 390 391 392
    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 {
393 394 395
  _UiKitViewGestureRecognizer(
    this.controller,
    this.gestureRecognizerFactories, {
396
    PointerDeviceKind? kind,
397
  }) : super(kind: kind) {
398 399
    team = GestureArenaTeam()
      ..captain = this;
400 401
    _gestureRecognizers = gestureRecognizerFactories.map(
      (Factory<OneSequenceGestureRecognizer> recognizerFactory) {
402 403 404 405 406 407 408 409 410 411 412 413 414
        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;
415 416 417 418 419 420 421 422 423
      },
    ).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;
424
  late Set<OneSequenceGestureRecognizer> _gestureRecognizers;
425 426 427 428

  final UiKitViewController controller;

  @override
429
  void addAllowedPointer(PointerDownEvent event) {
430
    startTrackingPointer(event.pointer, event.transform);
431
    for (final OneSequenceGestureRecognizer recognizer in _gestureRecognizers) {
432 433 434 435 436 437 438 439
      recognizer.addPointer(event);
    }
  }

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

  @override
440
  void didStopTrackingLastPointer(int pointer) { }
441 442 443 444 445 446 447 448 449 450 451 452 453

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

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

  @override
  void rejectGesture(int pointer) {
454
    controller.rejectGesture();
455 456 457 458 459
  }

  void reset() {
    resolve(GestureDisposition.rejected);
  }
460 461
}

462
typedef _HandlePointerEvent = Future<void> Function(PointerEvent event);
463

464
// This recognizer constructs gesture recognizers from a set of gesture recognizer factories
465
// it was give, adds all of them to a gesture arena team with the _PlatformViewGestureRecognizer
466
// as the team captain.
467 468 469 470 471 472
// 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,
473
    this.gestureRecognizerFactories, {
474
    PointerDeviceKind? kind,
475
  }) : super(kind: kind) {
476 477
    team = GestureArenaTeam()
      ..captain = this;
478
    _gestureRecognizers = gestureRecognizerFactories.map(
479
      (Factory<OneSequenceGestureRecognizer> recognizerFactory) {
480 481 482 483 484 485 486 487 488 489 490 491 492
        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;
493
      },
494
    ).toSet();
495
    _handlePointerEvent = handlePointerEvent;
496 497
  }

498
  late _HandlePointerEvent _handlePointerEvent;
499 500 501

  // 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
502
  // the cached events are dispatched to `_handlePointerEvent`, if we lose the arena we clear the cache for
503
  // the pointer.
504
  final Map<int, List<PointerEvent>> cachedEvents = <int, List<PointerEvent>>{};
505 506

  // Pointer for which we have already won the arena, events for pointers in this set are
507
  // immediately dispatched to `_handlePointerEvent`.
508
  final Set<int> forwardedPointers = <int>{};
509 510 511 512

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

  @override
517
  void addAllowedPointer(PointerDownEvent event) {
518
    startTrackingPointer(event.pointer, event.transform);
519
    for (final OneSequenceGestureRecognizer recognizer in _gestureRecognizers) {
520 521 522 523 524
      recognizer.addPointer(event);
    }
  }

  @override
525
  String get debugDescription => 'Platform view';
526 527

  @override
528
  void didStopTrackingLastPointer(int pointer) { }
529 530 531 532

  @override
  void handleEvent(PointerEvent event) {
    if (!forwardedPointers.contains(event.pointer)) {
533
      _cacheEvent(event);
534
    } else {
535
      _handlePointerEvent(event);
536 537 538 539 540 541
    }
    stopTrackingIfPointerNoLongerDown(event);
  }

  @override
  void acceptGesture(int pointer) {
542
    _flushPointerCache(pointer);
543 544 545 546 547 548 549 550 551
    forwardedPointers.add(pointer);
  }

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

552
  void _cacheEvent(PointerEvent event) {
553 554 555
    if (!cachedEvents.containsKey(event.pointer)) {
      cachedEvents[event.pointer] = <PointerEvent> [];
    }
556
    cachedEvents[event.pointer]!.add(event);
557 558
  }

559 560
  void _flushPointerCache(int pointer) {
    cachedEvents.remove(pointer)?.forEach(_handlePointerEvent);
561 562 563 564 565 566 567 568 569 570 571 572 573 574
  }

  @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);
575 576 577
  }
}

578 579
/// A render object for embedding a platform view.
///
580 581 582
/// [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 {
583 584 585 586 587

  /// Creating a render object for a [PlatformViewSurface].
  ///
  /// The `controller` parameter must not be null.
  PlatformViewRenderBox({
588 589 590
    required PlatformViewController controller,
    required PlatformViewHitTestBehavior hitTestBehavior,
    required Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers,
591 592 593 594
  }) :  assert(controller != null && controller.viewId != null && controller.viewId > -1),
        assert(hitTestBehavior != null),
        assert(gestureRecognizers != null),
        _controller = controller {
595 596 597
    this.hitTestBehavior = hitTestBehavior;
    updateGestureRecognizers(gestureRecognizers);
  }
598 599 600 601 602 603 604 605 606 607 608 609

  /// 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;
610 611
    _controller = controller;
    markNeedsPaint();
612 613 614 615 616
    if (needsSemanticsUpdate) {
      markNeedsSemanticsUpdate();
    }
  }

617 618 619 620
  /// {@macro  flutter.rendering.platformView.updateGestureRecognizers}
  ///
  /// Any active gesture arena the `PlatformView` participates in is rejected when the
  /// set of gesture recognizers is changed.
621 622
  void updateGestureRecognizers(Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers) {
    _updateGestureRecognizersWithCallBack(gestureRecognizers, _controller.dispatchPointerEvent);
623 624
  }

625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
  PlatformViewController _controller;

  @override
  bool get sizedByParent => true;

  @override
  bool get alwaysNeedsCompositing => true;

  @override
  bool get isRepaintBoundary => true;

  @override
  void performResize() {
    size = constraints.biggest;
  }

  @override
  void paint(PaintingContext context, Offset offset) {
    assert(_controller.viewId != null);
    context.addLayer(PlatformViewLayer(
645 646 647
      rect: offset & size,
      viewId: _controller.viewId,
    ));
648 649 650 651 652 653 654 655 656 657
  }

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

/// The Mixin handling the pointer events and gestures of a platform view render box.
660
mixin _PlatformViewGestureMixin on RenderBox implements MouseTrackerAnnotation {
661 662

  /// How to behave during hit testing.
663 664 665 666 667
  // Changing _hitTestBehavior might affect which objects are considered hovered over.
  set hitTestBehavior(PlatformViewHitTestBehavior value) {
    if (value != _hitTestBehavior) {
      _hitTestBehavior = value;
      if (owner != null)
668
        markNeedsPaint();
669 670
    }
  }
671
  PlatformViewHitTestBehavior? _hitTestBehavior;
672

673
  _HandlePointerEvent? _handlePointerEvent;
674

675 676 677 678
  /// {@macro  flutter.rendering.platformView.updateGestureRecognizers}
  ///
  /// Any active gesture arena the `PlatformView` participates in is rejected when the
  /// set of gesture recognizers is changed.
679
  void _updateGestureRecognizersWithCallBack(Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers, _HandlePointerEvent handlePointerEvent) {
680 681 682 683 684 685 686 687 688
    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();
689
    _gestureRecognizer = _PlatformViewGestureRecognizer(handlePointerEvent, gestureRecognizers);
690
    _handlePointerEvent = handlePointerEvent;
691 692
  }

693
  _PlatformViewGestureRecognizer? _gestureRecognizer;
694 695

  @override
696
  bool hitTest(BoxHitTestResult result, { required Offset position }) {
697
    if (_hitTestBehavior == PlatformViewHitTestBehavior.transparent || !size.contains(position)) {
698 699 700
      return false;
    }
    result.add(BoxHitTestEntry(this, position));
701
    return _hitTestBehavior == PlatformViewHitTestBehavior.opaque;
702 703 704
  }

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

707
  @override
708
  PointerEnterEventListener? get onEnter => null;
709 710 711 712 713

  @override
  PointerHoverEventListener get onHover => _handleHover;
  void _handleHover(PointerHoverEvent event) {
    if (_handlePointerEvent != null)
714
      _handlePointerEvent!(event);
715 716 717
  }

  @override
718
  PointerExitEventListener? get onExit => null;
719 720 721 722

  @override
  MouseCursor get cursor => MouseCursor.uncontrolled;

723 724 725
  @override
  void handleEvent(PointerEvent event, HitTestEntry entry) {
    if (event is PointerDownEvent) {
726
      _gestureRecognizer!.addPointer(event);
727 728 729 730 731
    }
  }

  @override
  void detach() {
732
    _gestureRecognizer!.reset();
733 734 735
    super.detach();
  }
}