ArLocationWidget class

Inheritance

Constructors

ArLocationWidget({Key? key, required List<ArAnnotation> annotations, required AnnotationViewBuilder annotationViewBuilder, required ChangeLocationCallback onLocationChange, double annotationWidth = 200, double annotationHeight = 75, double maxVisibleDistance = 1500, Size? frame, bool showDebugInfoSensor = true, double paddingOverlap = 5, double? yOffsetOverlap, Widget? accessory, double minDistanceReload = 50, bool scaleWithDistance = true, double minScale = AnnotationLayoutConfig.defaultMinScale, Color? markerColor, Color? backgroundRadar, RadarPosition? radarPosition, bool showRadar = true, double? radarWidth, bool isLoading = false, Widget? loadingWidget, ArSensorSource? sensorSource, ArSensorErrorBuilder? sensorErrorBuilder, double? cameraFieldOfView, bool useAltitude = false, bool hideWithinLocationAccuracy = false, int? maxRows, AnnotationGroupBadgeBuilder? groupBadgeBuilder, ArCameraErrorBuilder? cameraErrorBuilder})
const

Properties

accessory → Widget?
Widget drawn above the AR overlay once the camera is ready, e.g. buttons or a legend. Position it yourself (it is a child of a Stack).
final
annotationHeight → double
Annotation view height
final
annotations → List<ArAnnotation>
List of POIs
final
annotationViewBuilder → AnnotationViewBuilder
Function given context and annotation return widget for annotation view
final
annotationWidth → double
Annotation view width
final
backgroundRadar → Color?
background radar color
final
cameraErrorBuilder → ArCameraErrorBuilder?
Widget shown instead of the camera preview when the camera permission is denied or the camera is unavailable, see ArCamera.errorBuilder.
final
cameraFieldOfView → double?
Field of view of the back camera along its long side, in degrees. Read from the device when null.
final
frame → Size?
Unused.
final
groupBadgeBuilder → AnnotationGroupBadgeBuilder?
Badge shown on a label that has annotations grouped into it, see ArView.groupBadgeBuilder.
final
hashCode → int
The hash code for this object.
no setterinherited
hideWithinLocationAccuracy → bool
Hide POIs closer than the location accuracy, see AnnotationLayoutConfig.hideWithinLocationAccuracy.
final
isLoading → bool
Shows loadingWidget above everything, e.g. while annotations are being fetched.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loadingWidget → Widget?
Widget shown while isLoading. Defaults to a centered CircularProgressIndicator.
final
markerColor → Color?
marker color in radar
final
maxRows → int?
Maximum number of stacked rows of labels, see AnnotationLayoutConfig.maxRows.
final
maxVisibleDistance → double
Max distance, in meters, at which a POI is shown (and the range of the radar).
final
minDistanceReload → double
Distance, in meters, the user must move before onLocationChange is called again.
final
minScale → double
Scale of a label at maxVisibleDistance when scaleWithDistance: labels shrink linearly from 1 next to the user down to this value.
final
onLocationChange → ChangeLocationCallback
Called with the first location, then whenever the user moved by more than minDistanceReload meters. Typically used to reload the annotations around the user.
final
paddingOverlap → double
Vertical gap, in pixels, between two stacked overlapping labels.
final
radarPosition → RadarPosition?
radar position in view
final
radarWidth → double?
Radar width
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaleWithDistance → bool
Scale annotation view with distance from user
final
sensorErrorBuilder → ArSensorErrorBuilder?
Widget shown when location/sensors are unavailable, forwarded to ArView.
final
sensorSource → ArSensorSource?
Source of fused sensor/location samples, forwarded to ArView. Defaults to a device-backed ArSensorManager instantiated per view.
final
showDebugInfoSensor → bool
Show debug info sensor in debug mode
final
showRadar → bool
Show radar in view
final
useAltitude → bool
Place POIs above/below the horizon from their altitude, see AnnotationLayoutConfig.useAltitude.
final
yOffsetOverlap → double?
Vertical distance, in pixels, between two stacked overlapping labels, before paddingOverlap. Defaults to annotationHeight.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ArLocationWidget>
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, int wrapWidth = 65}) → 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