UArConfig class

Constructors

UArConfig({UArMode mode = UArMode.world, UArCameraFacing camera = UArCameraFacing.back, UArPlaneDetection planeDetection = UArPlaneDetection.both, UArPlaneStyle planeStyle = UArPlaneStyle.grid, Color planeColor = const Color(0x80FFFFFF), bool showFeaturePoints = false, bool showWorldOrigin = false, bool showAnchors = false, bool showSceneMesh = false, bool occlusion = true, bool peopleOcclusion = true, UArSceneReconstruction sceneReconstruction = UArSceneReconstruction.none, UArLightEstimation lightEstimation = UArLightEstimation.environmentalHdr, UArFocusMode focusMode = UArFocusMode.auto, bool instantPlacement = true, bool reticle = false, Color reticleColor = const Color(0xFFFFFFFF), bool coaching = true, UArCoachingGoal coachingGoal = UArCoachingGoal.anyPlane, List<UArReferenceImage> images = const <UArReferenceImage>[], int maxTrackedImages = 4, List<UArReferenceObject> objects = const <UArReferenceObject>[], UArGeoMode geoMode = UArGeoMode.auto, bool cloudAnchors = false, bool semantics = false, bool showFaceMesh = false, Color faceMeshColor = const Color(0x55FFFFFF), bool collaboration = false, Uint8List? worldMap, UArWorldAlignment worldAlignment = UArWorldAlignment.gravity, bool shadows = true, double shadowOpacity = 0.45, double exposure = 1, double environmentIntensity = 1, Color background = const Color(0xFFF2F2F2), bool transparentBackground = false, UArOrbit orbit = const UArOrbit(), int eventRate = 30, bool highFps = false})
const
UArConfig.viewer({Color background = const Color(0xFFF2F2F2), bool transparentBackground = false, bool shadows = true, double shadowOpacity = 0.35, double exposure = 1, double environmentIntensity = 1, UArOrbit orbit = const UArOrbit(), int eventRate = 30})
A plain 3D model viewer: no camera, no permission, works everywhere.
const

Properties

background → Color
final
camera → UArCameraFacing
final
cloudAnchors → bool
Google Cloud Anchors (Android). Needs an ARCore API key in the host app.
final
coaching → bool
Shows the platform's own "move your phone" guidance where one exists (iOS).
final
coachingGoal → UArCoachingGoal
final
collaboration → bool
Multi-user ARKit sessions; exchange UArController.collaborationData yourself.
final
environmentIntensity → double
final
eventRate → int
Maximum frame events per second sent to Dart.
final
exposure → double
final
faceMeshColor → Color
final
focusMode → UArFocusMode
final
geoMode → UArGeoMode
final
hashCode → int
The hash code for this object.
no setterinherited
highFps → bool
Prefers a 60 fps camera where the device offers one.
final
images → List<UArReferenceImage>
final
instantPlacement → bool
Place content before a surface is found (Android), refined as it is.
final
isViewer → bool
no setter
lightEstimation → UArLightEstimation
final
maxTrackedImages → int
final
mode → UArMode
final
objects → List<UArReferenceObject>
final
occlusion → bool
Real surfaces hide virtual content behind them (Depth API / LiDAR).
final
orbit → UArOrbit
final
peopleOcclusion → bool
People walking in front of content hide it (iOS A12+).
final
planeColor → Color
final
planeDetection → UArPlaneDetection
final
planeStyle → UArPlaneStyle
final
reticle → bool
Draws a placement ring where the screen centre meets a surface and reports it in UArFrame.centerHit.
final
reticleColor → Color
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sceneReconstruction → UArSceneReconstruction
final
semantics → bool
Outdoor scene labels — sky, building, road… (Android).
final
shadowOpacity → double
final
shadows → bool
final
showAnchors → bool
final
showFaceMesh → bool
final
showFeaturePoints → bool
final
showSceneMesh → bool
Draws the LiDAR scene mesh (iOS Pro devices).
final
showWorldOrigin → bool
final
transparentBackground → bool
final
worldAlignment → UArWorldAlignment
final
worldMap → Uint8List?
A map saved with UArController.getWorldMap to restore content (iOS).
final

Methods

copyWith({UArMode? mode, UArCameraFacing? camera, UArPlaneDetection? planeDetection, UArPlaneStyle? planeStyle, Color? planeColor, bool? showFeaturePoints, bool? showWorldOrigin, bool? showAnchors, bool? showSceneMesh, bool? occlusion, bool? peopleOcclusion, UArSceneReconstruction? sceneReconstruction, UArLightEstimation? lightEstimation, UArFocusMode? focusMode, bool? instantPlacement, bool? reticle, Color? reticleColor, bool? coaching, UArCoachingGoal? coachingGoal, List<UArReferenceImage>? images, int? maxTrackedImages, List<UArReferenceObject>? objects, UArGeoMode? geoMode, bool? cloudAnchors, bool? semantics, bool? showFaceMesh, Color? faceMeshColor, bool? collaboration, Uint8List? worldMap, UArWorldAlignment? worldAlignment, bool? shadows, double? shadowOpacity, double? exposure, double? environmentIntensity, Color? background, bool? transparentBackground, UArOrbit? orbit, int? eventRate, bool? highFps}) → UArConfig
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, Object?>
toString() → String
A string representation of this object.
inherited

Operators

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