FlutterMutatorView Class Reference

#import <FlutterMutatorView.h>

Inheritance diagram for FlutterMutatorView:

Instance Methods
(nonnull instancetype)	- initWithPlatformView:cursorCoordiator:
	Designated initializer. More...
(nonnull instancetype)	- initWithPlatformView:
(void)	- applyFlutterLayer:
(void)	- resetHitTestRegion
	Resets hit hit testing region for this mutator view. More...
(void)	- addHitTestIgnoreRegion:
(NSMutableArray *)	- pathClipViews [implementation]
(NSView *)	- platformViewContainer [implementation]
(instancetype)	- initWithPlatformView: [implementation]
(instancetype)	- initWithPlatformView:cursorCoordiator: [implementation]
(void)	- mouseMoved: [implementation]
(NSView *)	- hitTest: [implementation]
(BOOL)	- isFlipped [implementation]
(CGFloat)	- contentsScale [implementation]
	Returns the scale factor to translate logical pixels to physical pixels for this view. More...
(void)	- updatePathClipViewsWithPaths: [implementation]
	Updates the nested stack of clip views that host the platform view. More...
(void)	- updatePlatformViewWithBounds:transformedBounds:transform:clipRect: [implementation]
(void)	- applyFlutterLayer: [implementation]

Protected Attributes
NSMutableArray *	_pathClipViews
NSView *	_platformViewContainer
NSView *	_platformView
FlutterCursorCoordinator *	_cursorCoordinator
NSView *	_trackingAreaContainer
NSTrackingArea *	_trackingArea
std::vector< CGRect >	_hitTestIgnoreRegion

Properties
NSView *	platformView
	Returns wrapped platform view. More...

Detailed Description

FlutterMutatorView contains platform view and is responsible for applying FlutterLayer mutations to it.

Definition at line 63 of file FlutterMutatorView.h.

Method Documentation

addHitTestIgnoreRegion:

- (void) addHitTestIgnoreRegion:

(CGRect)

region

Adds rectangle (in local vie coordinates) to hit test ignore region (part of view obscured by Flutter contents).

Definition at line 417 of file FlutterMutatorView.mm.

                              :(CGRect)region {
  self->_hitTestIgnoreRegion.push_back(region);
}

applyFlutterLayer: [1/2]

- (void) applyFlutterLayer: (const flutter::PlatformViewLayer*)  layer

implementation

Whenever possible view will be clipped using layer bounds. If clipping to path is needed, CAShapeLayer(s) will be used as mask. Clipping to round rect only clips to path if round corners are intersected.

Paths in global logical coordinates that need to be clipped to.

Update PlatformViewContainer, PlatformView, and apply transforms and axis-aligned clip rect.

Definition at line 417 of file FlutterMutatorView.mm.

                         :(const flutter::PlatformViewLayer*)layer {
  // Compute the untransformed bounding rect for the platform view in logical pixels.
  // FlutterLayer.size is in physical pixels but Cocoa uses logical points.
  CGFloat scale = [self contentsScale];
  MutationVector mutations = MutationsForPlatformView(layer->mutations(), scale);
 
  CATransform3D finalTransform = CATransformFromMutations(mutations);
 
  // Compute the untransformed bounding rect for the platform view in logical pixels.
  // FlutterLayer.size is in physical pixels but Cocoa uses logical points.
  CGRect untransformedBoundingRect =
      CGRectMake(0, 0, layer->size().width / scale, layer->size().height / scale);
  CGRect finalBoundingRect = CGRectApplyAffineTransform(
      untransformedBoundingRect, CATransform3DGetAffineTransform(finalTransform));
  self.frame = finalBoundingRect;
 
  // Compute the layer opacity.
  self.layer.opacity = OpacityFromMutations(mutations);
 
  // Compute the master clip in global logical coordinates.
  CGRect masterClip = MasterClipFromMutations(finalBoundingRect, mutations);
  if (CGRectIsNull(masterClip)) {
    self.hidden = YES;
    return;
  }
  self.hidden = NO;
 
  /// Paths in global logical coordinates that need to be clipped to.
  NSMutableArray* paths = ClipPathFromMutations(masterClip, mutations);
  [self updatePathClipViewsWithPaths:paths];
 
  /// Update PlatformViewContainer, PlatformView, and apply transforms and axis-aligned clip rect.
  [self updatePlatformViewWithBounds:untransformedBoundingRect
                   transformedBounds:finalBoundingRect
                           transform:finalTransform
                            clipRect:masterClip];
 
  [self addSubview:_trackingAreaContainer positioned:(NSWindowAbove)relativeTo:nil];
  _trackingAreaContainer.frame = self.bounds;
}

applyFlutterLayer: [2/2]

- (void) applyFlutterLayer:

(nonnull const flutter::PlatformViewLayer *)

layer

Applies mutations from FlutterLayer to the platform view. This may involve creating or removing intermediate subviews depending on current state and requested mutations.

contentsScale

- (CGFloat) contentsScale

implementation

Returns the scale factor to translate logical pixels to physical pixels for this view.

Definition at line 417 of file FlutterMutatorView.mm.

                         {
  return self.superview != nil ? self.superview.layer.contentsScale : 1.0;
}

hitTest:

- (NSView *) hitTest: (NSPoint)  point

implementation

Definition at line 417 of file FlutterMutatorView.mm.

                  :(NSPoint)point {
  CGPoint localPoint = point;
  localPoint.x -= self.frame.origin.x;
  localPoint.y -= self.frame.origin.y;
  for (const auto& region : _hitTestIgnoreRegion) {
    if (CGRectContainsPoint(region, localPoint)) {
      return nil;
    }
  }
  return [super hitTest:point];
}

initWithPlatformView: [1/2]

- (nonnull instancetype) initWithPlatformView:

(nonnull NSView *)

platformView

initWithPlatformView: [2/2]

- (instancetype) initWithPlatformView: (NSView*)  platformView

implementation

Definition at line 417 of file FlutterMutatorView.mm.

                                    :(NSView*)platformView {
  return [self initWithPlatformView:platformView cursorCoordiator:nil];
}

initWithPlatformView:cursorCoordiator: [1/2]

- (nonnull instancetype) initWithPlatformView:		(nonnull NSView *)	platformView
cursorCoordiator:		(nullable FlutterCursorCoordinator *)	coordinator

Designated initializer.

initWithPlatformView:cursorCoordiator: [2/2]

- (instancetype) initWithPlatformView: (NSView*)  platformView cursorCoordiator: (FlutterCursorCoordinator*)  coordinator

implementation

Definition at line 417 of file FlutterMutatorView.mm.

                                    :(NSView*)platformView
                    cursorCoordiator:(FlutterCursorCoordinator*)coordinator {
  if (self = [super initWithFrame:NSZeroRect]) {
    _platformView = platformView;
    _pathClipViews = [NSMutableArray array];
    _cursorCoordinator = coordinator;
    self.wantsLayer = YES;
    self.clipsToBounds = YES;
 
    _trackingAreaContainer = [[FlutterTrackingAreaContainer alloc] initWithFrame:NSZeroRect];
    [self addSubview:_trackingAreaContainer];
 
    NSTrackingAreaOptions options = NSTrackingMouseMoved | NSTrackingInVisibleRect |
                                    NSTrackingEnabledDuringMouseDrag | NSTrackingActiveAlways;
    _trackingArea = [[NSTrackingArea alloc] initWithRect:NSZeroRect
                                                 options:options
                                                   owner:self
                                                userInfo:nil];
    [_trackingAreaContainer addTrackingArea:_trackingArea];
  }
  return self;
}

isFlipped

- (BOOL) isFlipped

implementation

Definition at line 417 of file FlutterMutatorView.mm.

                  {
  return YES;
}

mouseMoved:

- (void) mouseMoved: (NSEvent*)  event

implementation

Definition at line 417 of file FlutterMutatorView.mm.

                  :(NSEvent*)event {
  [_cursorCoordinator processMouseMoveEvent:event
                             forMutatorView:self
                              overlayRegion:_hitTestIgnoreRegion];
}

pathClipViews

- (NSMutableArray *) pathClipViews

implementation

Provided by category FlutterMutatorView(Private).

Definition at line 417 of file FlutterMutatorView.mm.

                                 {
  return _pathClipViews;
}

platformViewContainer

- (NSView *) platformViewContainer

implementation

Provided by category FlutterMutatorView(Private).

Definition at line 417 of file FlutterMutatorView.mm.

                                 {
  return _platformViewContainer;
}

resetHitTestRegion

- (void) resetHitTestRegion

Resets hit hit testing region for this mutator view.

Definition at line 417 of file FlutterMutatorView.mm.

                           {
  self->_hitTestIgnoreRegion.clear();
}

updatePathClipViewsWithPaths:

- (void) updatePathClipViewsWithPaths: (NSArray*)  paths

implementation

Updates the nested stack of clip views that host the platform view.

Definition at line 417 of file FlutterMutatorView.mm.

                                    :(NSArray*)paths {
  // Remove path clip views depending on the number of paths.
  while (_pathClipViews.count > paths.count) {
    NSView* view = _pathClipViews.lastObject;
    [view removeFromSuperview];
    [_pathClipViews removeLastObject];
  }
  // Otherwise, add path clip views to the end.
  for (size_t i = _pathClipViews.count; i < paths.count; ++i) {
    NSView* superView = _pathClipViews.count == 0 ? self : _pathClipViews.lastObject;
    FlutterPathClipView* pathClipView = [[FlutterPathClipView alloc] initWithFrame:self.bounds];
    [_pathClipViews addObject:pathClipView];
    [superView addSubview:pathClipView];
  }
  // Update bounds and apply clip paths.
  for (size_t i = 0; i < _pathClipViews.count; ++i) {
    FlutterPathClipView* pathClipView = _pathClipViews[i];
    pathClipView.frame = self.bounds;
    [pathClipView maskToPath:(__bridge CGPathRef)[paths objectAtIndex:i]
                  withOrigin:self.frame.origin];
  }
}

updatePlatformViewWithBounds:transformedBounds:transform:clipRect:

- (void) updatePlatformViewWithBounds: (CGRect)  untransformedBounds transformedBounds: (CGRect)  transformedBounds transform: (CATransform3D)  transform clipRect: (CGRect)  clipRect

implementation

Updates the PlatformView and PlatformView container views.

Re-nests _platformViewContainer in the innermost clip view, applies transforms to the underlying CALayer, adds the platform view as a subview of the container, and sets the axis-aligned clip rect around the tranformed view.

Definition at line 417 of file FlutterMutatorView.mm.

                                    :(CGRect)untransformedBounds
                   transformedBounds:(CGRect)transformedBounds
                           transform:(CATransform3D)transform
                            clipRect:(CGRect)clipRect {
  // Create the PlatformViewContainer view if necessary.
  if (_platformViewContainer == nil) {
    _platformViewContainer = [[FlutterPlatformViewContainer alloc] initWithFrame:self.bounds];
    _platformViewContainer.wantsLayer = YES;
  }
 
  // Nest the PlatformViewContainer view in the innermost path clip view.
  NSView* containerSuperview = _pathClipViews.count == 0 ? self : _pathClipViews.lastObject;
  [containerSuperview addSubview:_platformViewContainer];
  _platformViewContainer.frame = self.bounds;
 
  // Nest the platform view in the PlatformViewContainer, but only if the view doesn't have a
  // superview yet. Sometimes the platform view reparents itself (WKWebView entering FullScreen)
  // in which case do not forcefully move it back.
  if (_platformView.superview == nil) {
    [_platformViewContainer addSubview:_platformView];
  }
 
  // Originally first subview would be the _platformView. However during WKWebView full screen
  // the platform view gets replaced with a placeholder. Given that _platformViewContainer does
  // not contain any other views it is safe to assume that any subview found can be treated
  // as the platform view.
  _platformViewContainer.subviews.firstObject.frame = untransformedBounds;
 
  // Transform for the platform view is finalTransform adjusted for bounding rect origin.
  CATransform3D translation =
      CATransform3DMakeTranslation(-transformedBounds.origin.x, -transformedBounds.origin.y, 0);
  transform = CATransform3DConcat(transform, translation);
  _platformViewContainer.layer.sublayerTransform = transform;
 
  // By default NSView clips children to frame. If masterClip is tighter than mutator view frame,
  // the frame is set to masterClip and child offset adjusted to compensate for the difference.
  if (!CGRectEqualToRect(clipRect, transformedBounds)) {
    NSMutableArray<NSView*>* subviews = [NSMutableArray arrayWithArray:self.subviews];
    [subviews removeObject:_trackingAreaContainer];
    FML_DCHECK(subviews.count == 1);
    auto subview = subviews.firstObject;
    FML_DCHECK(subview.frame.origin.x == 0 && subview.frame.origin.y == 0);
    subview.frame = CGRectMake(transformedBounds.origin.x - clipRect.origin.x,
                               transformedBounds.origin.y - clipRect.origin.y,
                               subview.frame.size.width, subview.frame.size.height);
    self.frame = clipRect;
  }
}

Member Data Documentation

_cursorCoordinator

- (FlutterCursorCoordinator*) _cursorCoordinator

protected

Definition at line 104 of file FlutterMutatorView.mm.

_hitTestIgnoreRegion

- (vector<CGRect> FlutterMutatorView()):

protected

Definition at line 114 of file FlutterMutatorView.mm.

_pathClipViews

- (NSMutableArray*) _pathClipViews

protected

Definition at line 96 of file FlutterMutatorView.mm.

_platformView

- (NSView*) _platformView

protected

Definition at line 102 of file FlutterMutatorView.mm.

_platformViewContainer

- (NSView*) _platformViewContainer

protected

Definition at line 100 of file FlutterMutatorView.mm.

_trackingArea

- (NSTrackingArea*) _trackingArea

protected

Definition at line 111 of file FlutterMutatorView.mm.

_trackingAreaContainer

- (NSView*) _trackingAreaContainer

protected

Definition at line 108 of file FlutterMutatorView.mm.

Property Documentation

platformView

- (NSView *) platformView

readatomicassign

Returns wrapped platform view.

Definition at line 72 of file FlutterMutatorView.h.

---

The documentation for this class was generated from the following files:

• shell/platform/darwin/macos/framework/Source/FlutterMutatorView.h
• shell/platform/darwin/macos/framework/Source/FlutterMutatorView.mm