UArScene class

Full interactive AR: find surfaces, place items, move / rotate / scale them, take photos and videos. Everything is configurable and every piece of chrome can be replaced through the builders.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• UArScene

Available extensions

• WidgetsExtension

Constructors

UArScene({List<UArPlaceable> items = const <UArPlaceable>[], int initialItem = 0, UArController? controller, UArConfig config = const UArConfig(reticle: true), UArSceneOptions options = const UArSceneOptions(), List<UArOverlay> overlays = const <UArOverlay>[], UArLabels labels = const UArLabels(), UArStyle style = const UArStyle(), void onCreated(UArController controller)?, void onPlaced(UArPlacedItem placed)?, void onNodeTap(UArNodeHit hit, UArNode? node)?, void onSurfaceTap(UArHitResult hit)?, void onSnapshot(Uint8List image)?, void onRecorded(UArRecording recording)?, void onError(UArException error)?, VoidCallback? onClose, Widget hintBuilder(BuildContext context, String hint)?, Widget toolbarBuilder(BuildContext context, UArSceneState state)?, Widget pickerBuilder(BuildContext context, UArSceneState state)?, Widget overlayBuilder(BuildContext context, UArController controller)?, Widget? placeholder, bool gate = true, Key? key})

const

Properties

config → UArConfig

final

controller → UArController?

Supply one to drive the session yourself; otherwise one is created.

final

gate → bool

Checks availability and asks for the camera before starting.

final

hashCode → int

The hash code for this object.

no setter, inherited

hintBuilder → Widget Function(BuildContext context, String hint)?

final

initialItem → int

final

items → List<UArPlaceable>

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

labels → UArLabels

final

onClose → VoidCallback?

final

onCreated → void Function(UArController controller)?

final

onError → void Function(UArException error)?

final

onNodeTap → void Function(UArNodeHit hit, UArNode? node)?

final

onPlaced → void Function(UArPlacedItem placed)?

final

onRecorded → void Function(UArRecording recording)?

final

onSnapshot → void Function(Uint8List image)?

final

onSurfaceTap → void Function(UArHitResult hit)?

Called for taps on surfaces when nothing is being placed.

final

options → UArSceneOptions

final

overlayBuilder → Widget Function(BuildContext context, UArController controller)?

Anything else drawn over the view, below the built-in chrome.

final

overlays → List<UArOverlay>

final

pickerBuilder → Widget Function(BuildContext context, UArSceneState state)?

final

placeholder → Widget?

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

style → UArStyle

final

toolbarBuilder → Widget Function(BuildContext context, UArSceneState state)?

final

Methods

alignAtBottomCenter({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

alignAtBottomLeft({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

alignAtBottomRight({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

alignAtCenter({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

alignAtCenterLeft({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

alignAtCenterRight({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

alignAtLERP(Alignment a, Alignment b, double t, {Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

alignAtTopCenter({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

alignAtTopLeft({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

alignAtTopRight({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

alignXY(double x, double y, {Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the WidgetsExtension extension

card({Color? backgroundColor, double? elevation, EdgeInsetsGeometry? margin}) → Widget

Available on Widget, provided by the WidgetsExtension extension

chip({required Color backgroundColor, double? width, double? height, Alignment? alignment, double borderWidth = 1, double radius = 12, Color borderColor = Colors.transparent, EdgeInsets padding = const EdgeInsets.symmetric(horizontal: 8, vertical: 6), EdgeInsetsGeometry? margin, BoxConstraints? constraints}) → Widget

Available on Widget, provided by the WidgetsExtension extension

container({double? width, double? height, Alignment? alignment, Color? backgroundColor, double borderWidth = 1, double radius = 1, Color borderColor = Colors.transparent, EdgeInsetsGeometry? padding, EdgeInsetsGeometry? margin, BoxConstraints? constraints}) → Widget

Available on Widget, provided by the WidgetsExtension extension

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<UArScene>

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

expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetsExtension extension

fadeSlideIn({int milliseconds = 1000, double offset = 24}) → Widget

Available on Widget, provided by the WidgetsExtension extension

fit({Alignment alignment = Alignment.center}) → Widget

Available on Widget, provided by the WidgetsExtension extension

form(GlobalKey<FormState> key) → Widget

Available on Widget, provided by the WidgetsExtension extension

ltr() → Widget

Available on Widget, provided by the WidgetsExtension extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onDoubleTap(GestureTapCallback? onPressed) → Widget

Available on Widget, provided by the WidgetsExtension extension

onLongPress(GestureTapCallback? onPressed) → Widget

Available on Widget, provided by the WidgetsExtension extension

onPress(VoidCallback onTap, {double pressedScale = 0.9, Duration duration = const Duration(milliseconds: 120)}) → Widget

Available on Widget, provided by the WidgetsExtension extension

onTap(GestureTapCallback? onPressed) → Widget

Available on Widget, provided by the WidgetsExtension extension

onTapInk(GestureTapCallback? onPressed) → Widget

Available on Widget, provided by the WidgetsExtension extension

pAll(double padding) → Widget

Available on Widget, provided by the WidgetsExtension extension

pLTRB(double left, double top, double right, double bottom) → Widget

Available on Widget, provided by the WidgetsExtension extension

pOnly({double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) → Widget

Available on Widget, provided by the WidgetsExtension extension

position({double? left, double? top, double? right, double? bottom, double? width, double? height}) → Widget

Available on Widget, provided by the WidgetsExtension extension

pSymmetric({double horizontal = 0.0, double vertical = 0.0}) → Widget

Available on Widget, provided by the WidgetsExtension extension

rotate(double scale) → Widget

Available on Widget, provided by the WidgetsExtension extension

rtl() → Widget

Available on Widget, provided by the WidgetsExtension extension

safeArea() → Widget

Available on Widget, provided by the WidgetsExtension extension

scale(double scale) → Widget

Available on Widget, provided by the WidgetsExtension extension

scrollable({Axis scrollDirection = Axis.vertical}) → Widget

Available on Widget, provided by the WidgetsExtension extension

showMenus(List<PopupMenuEntry<int>> items) → Widget

Available on Widget, provided by the WidgetsExtension extension

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

translate(Offset offset) → Widget

Available on Widget, provided by the WidgetsExtension extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited