Plane.State


class Plane.State : Trackable.State


The representation of the current state of a Plane. A Plane is represented as a finite polygon with an arbitrary amount of vertices around a centerPose.

Summary

Public functions

open operator Boolean
equals(other: Any?)
open Int

Public properties

Pose

The Pose of the center of the detected plane's bounding box in the world coordinate space.

Vector2

The dimensions of the bounding box of the detected plane.

Plane.Label

The Label associated with the plane.

Plane?

If this plane has been subsumed, returns the plane this plane was merged into.

open TrackingState

whether this plane is being tracked or not.

List<Vector2>

The 2D vertices of a convex polygon approximating the detected plane, relative to its centerPose in the X and Z axes.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

centerPose

Added in 1.0.0-alpha05
val centerPosePose

The Pose of the center of the detected plane's bounding box in the world coordinate space. The +Y axis relative to the centerPose is equivalent to the normal of the Plane.

extents

Added in 1.0.0-alpha05
val extentsVector2

The dimensions of the bounding box of the detected plane.

label

Added in 1.0.0-alpha05
val labelPlane.Label

The Label associated with the plane.

subsumedBy

Added in 1.0.0-alpha05
val subsumedByPlane?

If this plane has been subsumed, returns the plane this plane was merged into. If the subsuming plane is also subsumed by another plane, this plane will continue to be subsumed by the former.

trackingState

open val trackingStateTrackingState

whether this plane is being tracked or not.

vertices

Added in 1.0.0-alpha05
val verticesList<Vector2>

The 2D vertices of a convex polygon approximating the detected plane, relative to its centerPose in the X and Z axes.