XrPlane class final

A flat surface the runtime found: a rectangle of width by depth meters centered at pose, lying in the pose's x-z plane with its normal along the pose's +y.

Constructors

XrPlane({required String id, required RigidPose pose, required double width, required double depth, XrPlaneOrientation orientation = XrPlaneOrientation.arbitrary})
The plane id, as the runtime keeps it from frame to frame.
XrPlane.fromInput(ExternalStateInput input)
The plane toInput wrote. Throws a PluginFormatException for input that is not one.
factory

Properties

depth → double
Its extent along the pose's z, in meters.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
The runtime's id, stable for as long as the plane is tracked.
final
orientation → XrPlaneOrientation
Which way it faces.
final
pose → RigidPose
Its center and turn, in the session's space.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
width → double
Its extent along the pose's x, in meters.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toCollider({double thickness = 0.02}) → Collider
A static collider over the plane: the axis-aligned box around it, thickness meters deep below its surface.
toInput({double? displaySeconds}) → ExternalStateInput
The plane as input for the step: the pose's seven numbers and the two extents, with the orientation as the reading's tag.
toString() → String
A string representation of this object.
inherited

Operators

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

Static Methods

isPlane(String source) → bool
Whether source names a plane.
lost(String id, {double? displaySeconds}) → ExternalStateInput
Input saying the plane id is no longer tracked: no numbers at all.
sourceOf(String id) → String
Where a plane goes on the tape: xr.plane.<id>.