#import <FlutterPlatformViewsController.h>

Inheritance diagram for FlutterPlatformViewsController:

Instance Methods
(instancetype)	- NS_DESIGNATED_INITIALIZER

(void)	- registerViewFactory:withId:gestureRecognizersBlockingPolicy:
	set the factory used to construct embedded UI Views. More...

(void)	- beginFrameWithSize:
	Mark the beginning of a frame and record the size of the onscreen. More...

(void)	- cancelFrame
	Cancel the current frame, indicating that no platform views are composited. More...

(void)	- prerollCompositeEmbeddedView:withParams:
	Record a platform view in the layer tree to be rendered, along with the positioning and mutator parameters. More...

(FlutterTouchInterceptingView *)	- flutterTouchInterceptingViewForId:
	Returns the`FlutterTouchInterceptingView` with the provided view_id. More...

(flutter::PostPrerollResult)	- postPrerollActionWithThreadMerger:impellerEnabled:
	Determine if thread merging is required after prerolling platform views. More...

(void)	- endFrameWithResubmit:threadMerger:impellerEnabled:
	Mark the end of a compositor frame. More...

(flutter::DlCanvas *)	- compositeEmbeddedViewWithId:
	Returns the Canvas for the overlay slice for the given platform view. More...

(void)	- reset
	Discards all platform views instances and auxiliary resources. More...

(BOOL)	- submitFrame:withIosContext:grContext:
	Encode rendering for the Flutter overlay views and queue up perform platform view mutations. More...

(void)	- onMethodCall:result:
	Handler for platform view message channels. More...

(long)	- firstResponderPlatformViewId
	Returns the platform view id if the platform view (or any of its descendant view) is the first responder. More...

(void)	- pushFilterToVisitedPlatformViews:withRect:
	Pushes backdrop filter mutation to the mutator stack of each visited platform view. More...

(void)	- pushVisitedPlatformViewId:
	Pushes the view id of a visted platform view to the list of visied platform views. More...

(size_t)	- embeddedViewCount

(UIView *_Nullable)	- platformViewForId:

(void)	- compositeView:withParams:

(const flutter::EmbeddedViewParams &)	- compositionParamsForView:

Properties
const fml::RefPtr< fml::TaskRunner > &	taskRunner
	The task runner used to post rendering tasks to the platform thread. More...

UIView *_Nullable	flutterView
	The flutter view. More...

UIViewController< FlutterViewResponder > *_Nullable	flutterViewController
	The flutter view controller. More...

Detailed Description

Definition at line 31 of file FlutterPlatformViewsController.h.

Method Documentation

◆ beginFrameWithSize:

- (void) beginFrameWithSize: (SkISize) frameSize

Mark the beginning of a frame and record the size of the onscreen.

Definition at line 447 of file FlutterPlatformViewsController.mm.

                           :(SkISize)frameSize {
   [self resetFrameState];
   self.frameSize = frameSize;
 }

◆ cancelFrame

- (void) cancelFrame

Cancel the current frame, indicating that no platform views are composited.

Additionally, reverts the composition order to its original state at the beginning of the frame.

Definition at line 452 of file FlutterPlatformViewsController.mm.

                     {
   [self resetFrameState];
 }

Referenced by postPrerollActionWithThreadMerger:impellerEnabled:.

◆ compositeEmbeddedViewWithId:

- (DlCanvas *) FlutterPlatformViewsController: (int64_t) viewId

Returns the Canvas for the overlay slice for the given platform view.

Called from the raster thread.

Definition at line 707 of file FlutterPlatformViewsController.mm.

                                                :(int64_t)viewId {
   FML_DCHECK(self.slices.find(viewId) != self.slices.end());
   return self.slices[viewId]->canvas();
 }

◆ compositeView:withParams:

- (void) compositeView:	(int64_t)	viewId
withParams:	(const flutter::EmbeddedViewParams &)	params

Provided by category FlutterPlatformViewsController(Testing).

◆ compositionParamsForView:

- (const EmbeddedViewParams& FlutterPlatformViewsController(Testing)): (int64_t) viewId

Provided by category FlutterPlatformViewsController(Testing).

◆ embeddedViewCount

- (size_t) embeddedViewCount

Provided by category FlutterPlatformViewsController(Testing).

◆ endFrameWithResubmit:threadMerger:impellerEnabled:

- (void) endFrameWithResubmit:	(BOOL)	shouldResubmitFrame
threadMerger:	(const fml::RefPtr<fml::RasterThreadMerger>&)	rasterThreadMerger
impellerEnabled:	(BOOL)	impellerEnabled

Mark the end of a compositor frame.

May determine changes are required to the thread merging state. Called from the raster thread.

Definition at line 491 of file FlutterPlatformViewsController.mm.

                             :(BOOL)shouldResubmitFrame
                 threadMerger:(const fml::RefPtr<fml::RasterThreadMerger>&)rasterThreadMerger
              impellerEnabled:(BOOL)impellerEnabled {
 #if FML_OS_IOS_SIMULATOR
   BOOL runCheck = YES;
 #else
   BOOL runCheck = !impellerEnabled;
 #endif  // FML_OS_IOS_SIMULATOR
   if (runCheck && shouldResubmitFrame) {
     rasterThreadMerger->MergeWithLease(kDefaultMergedLeaseDuration);
   }
 }

References kDefaultMergedLeaseDuration.

◆ firstResponderPlatformViewId

- (long) firstResponderPlatformViewId

Returns the platform view id if the platform view (or any of its descendant view) is the first responder.

Returns -1 if no such platform view is found.

Definition at line 546 of file FlutterPlatformViewsController.mm.

                                      {
   for (auto const& [id, platformViewData] : self.platformViews) {
     UIView* rootView = platformViewData.root_view;
     if (rootView.flt_hasFirstResponderInViewHierarchySubtree) {
       return id;
     }
   }
   return -1;
 }

◆ flutterTouchInterceptingViewForId:

- (FlutterTouchInterceptingView *) flutterTouchInterceptingViewForId: (int64_t) viewId

Returns theFlutterTouchInterceptingView with the provided view_id.

Returns nil if there is no platform view with the provided id. Called from the platform thread.

Definition at line 539 of file FlutterPlatformViewsController.mm.

                                                                   :(int64_t)viewId {
   if (self.platformViews.empty()) {
     return nil;
   }
   return self.platformViews[viewId].touch_interceptor;
 }

◆ NS_DESIGNATED_INITIALIZER

- (instancetype) NS_DESIGNATED_INITIALIZER

◆ onMethodCall:result:

- (void) onMethodCall:	(FlutterMethodCall*)	call
result:	(FlutterResult)	result

Handler for platform view message channels.

Definition at line 310 of file FlutterPlatformViewsController.mm.

                     :(FlutterMethodCall*)call result:(FlutterResult)result {
   if ([[call method] isEqualToString:@"create"]) {
     [self onCreate:call result:result];
   } else if ([[call method] isEqualToString:@"dispose"]) {
     [self onDispose:call result:result];
   } else if ([[call method] isEqualToString:@"acceptGesture"]) {
     [self onAcceptGesture:call result:result];
   } else if ([[call method] isEqualToString:@"rejectGesture"]) {
     [self onRejectGesture:call result:result];
   } else {
     result(FlutterMethodNotImplemented);
   }
 }

References FlutterMethodNotImplemented.

◆ platformViewForId:

- (UIView* _Nullable) platformViewForId: (int64_t) viewId

Provided by category FlutterPlatformViewsController(Testing).

◆ postPrerollActionWithThreadMerger:impellerEnabled:

- (PostPrerollResult) FlutterPlatformViewsController:	(const fml::RefPtr<fml::RasterThreadMerger>&)	rasterThreadMerger
impellerEnabled:	(BOOL)	impellerEnabled

Determine if thread merging is required after prerolling platform views.

Called from the raster thread.

Definition at line 456 of file FlutterPlatformViewsController.mm.

                                                              :
                                   (const fml::RefPtr<fml::RasterThreadMerger>&)rasterThreadMerger
                                                 impellerEnabled:(BOOL)impellerEnabled {
   // TODO(jonahwilliams): remove this once Software backend is removed for iOS Sim.
 #ifdef FML_OS_IOS_SIMULATOR
   const bool mergeThreads = true;
 #else
   const bool mergeThreads = !impellerEnabled;
 #endif  // FML_OS_IOS_SIMULATOR
  
   if (mergeThreads) {
     if (self.compositionOrder.empty()) {
       return flutter::PostPrerollResult::kSuccess;
     }
     if (!rasterThreadMerger->IsMerged()) {
       // The raster thread merger may be disabled if the rasterizer is being
       // created or teared down.
       //
       // In such cases, the current frame is dropped, and a new frame is attempted
       // with the same layer tree.
       //
       // Eventually, the frame is submitted once this method returns `kSuccess`.
       // At that point, the raster tasks are handled on the platform thread.
       [self cancelFrame];
       return flutter::PostPrerollResult::kSkipAndRetryFrame;
     }
     // If the post preroll action is successful, we will display platform views in the current
     // frame. In order to sync the rendering of the platform views (quartz) with skia's rendering,
     // We need to begin an explicit CATransaction. This transaction needs to be submitted
     // after the current frame is submitted.
     rasterThreadMerger->ExtendLeaseTo(kDefaultMergedLeaseDuration);
   }
   return flutter::PostPrerollResult::kSuccess;
 }

References cancelFrame, and kDefaultMergedLeaseDuration.

◆ prerollCompositeEmbeddedView:withParams:

- (void) prerollCompositeEmbeddedView:	(int64_t)	viewId
withParams:	(std::unique_ptr<flutter::EmbeddedViewParams>)	params

Record a platform view in the layer tree to be rendered, along with the positioning and mutator parameters.

Called from the raster thread.

Definition at line 513 of file FlutterPlatformViewsController.mm.

                                     :(int64_t)viewId
                           withParams:(std::unique_ptr<flutter::EmbeddedViewParams>)params {
   SkRect viewBounds = SkRect::Make(self.frameSize);
   std::unique_ptr<flutter::EmbedderViewSlice> view;
   view = std::make_unique<flutter::DisplayListEmbedderViewSlice>(viewBounds);
   self.slices.insert_or_assign(viewId, std::move(view));
  
   self.compositionOrder.push_back(viewId);
  
   if (self.currentCompositionParams.count(viewId) == 1 &&
       self.currentCompositionParams[viewId] == *params.get()) {
     // Do nothing if the params didn't change.
     return;
   }
   self.currentCompositionParams[viewId] = flutter::EmbeddedViewParams(*params.get());
   self.viewsToRecomposite.insert(viewId);
 }

◆ pushFilterToVisitedPlatformViews:withRect:

- (void) pushFilterToVisitedPlatformViews:	(const std::shared_ptr<flutter::DlImageFilter>&)	filter
withRect:	(const SkRect&)	filterRect

Pushes backdrop filter mutation to the mutator stack of each visited platform view.

Definition at line 504 of file FlutterPlatformViewsController.mm.

                                         :(const std::shared_ptr<flutter::DlImageFilter>&)filter
                                 withRect:(const SkRect&)filterRect {
   for (int64_t id : self.visitedPlatformViews) {
     flutter::EmbeddedViewParams params = self.currentCompositionParams[id];
     params.PushImageFilter(filter, filterRect);
     self.currentCompositionParams[id] = params;
   }
 }

◆ pushVisitedPlatformViewId:

- (void) pushVisitedPlatformViewId: (int64_t) viewId

Pushes the view id of a visted platform view to the list of visied platform views.

Definition at line 1021 of file FlutterPlatformViewsController.mm.

                                  :(int64_t)viewId {
   self.visitedPlatformViews.push_back(viewId);
 }

◆ registerViewFactory:withId:gestureRecognizersBlockingPolicy:

- (void) registerViewFactory:	(NSObject<FlutterPlatformViewFactory>*)	factory
withId:	(NSString*)	factoryId
gestureRecognizersBlockingPolicy:	(FlutterPlatformViewGestureRecognizersBlockingPolicy)	gestureRecognizerBlockingPolicy

set the factory used to construct embedded UI Views.

Definition at line 437 of file FlutterPlatformViewsController.mm.

                            :(NSObject<FlutterPlatformViewFactory>*)factory
                               withId:(NSString*)factoryId
     gestureRecognizersBlockingPolicy:
         (FlutterPlatformViewGestureRecognizersBlockingPolicy)gestureRecognizerBlockingPolicy {
   std::string idString([factoryId UTF8String]);
   FML_CHECK(self.factories.count(idString) == 0);
   self.factories[idString] = factory;
   self.gestureRecognizersBlockingPolicies[idString] = gestureRecognizerBlockingPolicy;
 }

◆ reset

- (void) reset

Discards all platform views instances and auxiliary resources.

Called from the raster thread.

Definition at line 712 of file FlutterPlatformViewsController.mm.

               {
   // Reset will only be called from the raster thread or a merged raster/platform thread.
   // _platformViews must only be modified on the platform thread, and any operations that
   // read or modify platform views should occur there.
   fml::TaskRunner::RunNowOrPostTask(self.platformTaskRunner, [self]() {
     for (int64_t viewId : self.compositionOrder) {
       [self.platformViews[viewId].root_view removeFromSuperview];
     }
     self.platformViews.clear();
   });
  
   self.compositionOrder.clear();
   self.slices.clear();
   self.currentCompositionParams.clear();
   self.viewsToRecomposite.clear();
   self.layerPool->RecycleLayers();
   self.visitedPlatformViews.clear();
 }

◆ submitFrame:withIosContext:grContext:

- (BOOL) submitFrame:	(std::unique_ptr< flutter::SurfaceFrame >)	frame
withIosContext:	(const std::shared_ptr< flutter::IOSContext > &)	iosContext
grContext:	(GrDirectContext *_Nullable)	grContext

Encode rendering for the Flutter overlay views and queue up perform platform view mutations.

Called from the raster thread.

Property Documentation

◆ flutterView

- (UIView* _Nullable) flutterView

readwritenonatomicweak

The flutter view.

Definition at line 39 of file FlutterPlatformViewsController.h.

◆ flutterViewController

- (UIViewController<FlutterViewResponder>* _Nullable) flutterViewController

readwritenonatomicweak

The flutter view controller.

Definition at line 42 of file FlutterPlatformViewsController.h.

◆ taskRunner

- (const RefPtr<) fml:

readwritenonatomicassign

The task runner used to post rendering tasks to the platform thread.

Definition at line 36 of file FlutterPlatformViewsController.h.

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

shell/platform/darwin/ios/framework/Source/FlutterPlatformViewsController.h
shell/platform/darwin/ios/framework/Source/FlutterPlatformViewsController.mm

Instance Methods

Properties

Detailed Description

Method Documentation

◆ beginFrameWithSize:

◆ cancelFrame

◆ compositeEmbeddedViewWithId:

◆ compositeView:withParams:

◆ compositionParamsForView:

◆ embeddedViewCount

◆ endFrameWithResubmit:threadMerger:impellerEnabled:

◆ firstResponderPlatformViewId

◆ flutterTouchInterceptingViewForId:

◆ NS_DESIGNATED_INITIALIZER

◆ onMethodCall:result:

◆ platformViewForId:

◆ postPrerollActionWithThreadMerger:impellerEnabled:

◆ prerollCompositeEmbeddedView:withParams:

◆ pushFilterToVisitedPlatformViews:withRect:

◆ pushVisitedPlatformViewId:

◆ registerViewFactory:withId:gestureRecognizersBlockingPolicy:

◆ reset

◆ submitFrame:withIosContext:grContext:

Property Documentation

◆ flutterView

◆ flutterViewController

◆ taskRunner