ARKitSceneView class

A widget that wraps ARSCNView from ARKit.

Inheritance

Constructors

ARKitSceneView({Key? key, required ARKitPluginCreatedCallback onARKitViewCreated, ARKitConfiguration configuration = ARKitConfiguration.worldTracking, ARWorldTrackingConfigurationEnvironmentTexturing environmentTexturing = ARWorldTrackingConfigurationEnvironmentTexturing.none, bool showStatistics = false, bool autoenablesDefaultLighting = true, bool enableTapRecognizer = false, bool enablePinchRecognizer = false, bool enablePanRecognizer = false, bool enableRotationRecognizer = false, bool showFeaturePoints = false, bool showWorldOrigin = false, ARPlaneDetection planeDetection = ARPlaneDetection.none, String? detectionImagesGroupName, List<ARKitReferenceImage>? detectionImages, String? trackingImagesGroupName, List<ARKitReferenceImage>? trackingImages, bool forceUserTapOnCenter = false, ARWorldAlignment worldAlignment = ARWorldAlignment.gravity, int maximumNumberOfTrackedImages = 0, bool debug = false})
const

Properties

autoenablesDefaultLighting → bool
Specifies whether the receiver should automatically light up scenes that have no light source. When enabled, a diffuse light is automatically added and placed while rendering scenes that have no light or only ambient lights. The default is true.
final
configuration → ARKitConfiguration
The configuration to use. Defaults to World Tracking.
final
debug → bool
When true prints all communication between the plugin and the framework. The default is false;
final
detectionImages → List<ARKitReferenceImage>?
Images to detect in the scene. If set the session will attempt to detect the specified images (bundle name or url) When an image is detected an ARImageAnchor will be added to the session.
final
detectionImagesGroupName → String?
Images to detect in the scene. If set the session will attempt to detect the specified images. When an image is detected an ARImageAnchor will be added to the session.
final
enablePanRecognizer → bool
Determines whether the receiver should recognize pan events. The default is false.
final
enablePinchRecognizer → bool
Determines whether the receiver should recognize pinch events. The default is false.
final
enableRotationRecognizer → bool
Determines whether the receiver should recognize rotation events. The default is false.
final
enableTapRecognizer → bool
Determines whether the receiver should recognize taps. The default is false.
final
environmentTexturing → ARWorldTrackingConfigurationEnvironmentTexturing
The mode of environment texturing to run. If set, texture information will be accumulated and updated. Adding an AREnvironmentProbeAnchor to the session will get the current environment texture available from that probe's perspective which can be used for lighting virtual objects in the scene. Defaults to ARWorldTrackingConfigurationEnvironmentTexturing.none. Requires iOS 12 or newer
final
forceUserTapOnCenter → bool
When set every user tap will be processed like user tapped on the center of the screen. The default is false.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
maximumNumberOfTrackedImages → int
Maximum number of images to track simultaneously. Setting the maximum number of tracked images will limit the number of images that can be tracked in a given frame. If more than the maximum is visible, only the images already being tracked will continue to track until tracking is lost or another image is removed. The default is 0
final
onARKitViewCreated → ARKitPluginCreatedCallback
This function will be fired when ARKit view is created.
final
planeDetection → ARPlaneDetection
Type of planes to detect in the scene. If set, new planes will continue to be detected and updated over time. Detected planes will be added to the session as ARPlaneAnchor objects. In the event that two planes are merged, the newer plane will be removed. Defaults to ARPlaneDetection.none.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showFeaturePoints → bool
Show detected 3D feature points in the world. The default is false.
final
showStatistics → bool
Determines whether the receiver should display statistics info like FPS. When set to true, statistics are displayed in a overlay on top of the rendered scene. Defaults to false.
final
showWorldOrigin → bool
Show the world origin in the scene. The default is false.
final
trackingImages → List<ARKitReferenceImage>?
Images to detect in the scene. If set the session will attempt to detect the specified images. When an image is detected an ARImageAnchor will be added to the session.
final
trackingImagesGroupName → String?
Images to detect in the scene. If set the session will attempt to detect the specified images. When an image is detected an ARImageAnchor will be added to the session.
final
worldAlignment → ARWorldAlignment
Determines how the coordinate system should be aligned with the world. The default is ARWorldAlignment.gravity.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ARKitSceneView>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited