Plane.State

Kotlin |Java

public final class Plane.State implements 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 methods
`boolean`	`equals(Object other)`
`final @NonNull Pose`	`getCenterPose()` The `Pose` of the center of the detected plane's bounding box in the world coordinate space.
`final @NonNull FloatSize2d`	`getExtents()` The dimensions of the bounding box of the detected plane.
`final @NonNull Plane.Label`	`getLabel()` The `Label` associated with the plane.
`final Plane`	`getSubsumedBy()` If this plane has been subsumed, returns the plane this plane was merged into.
`@NonNull TrackingState`	`getTrackingState()` whether this plane is being tracked or not.
`final @NonNull List<@NonNull Vector2>`	`getVertices()` The 2D vertices of a convex polygon approximating the detected plane, relative to its `centerPose` in the X and Z axes.
`int`	`hashCode()`

Public methods

equals

public boolean equals(Object other)

getCenterPose

Added in 1.0.0-alpha09

public final @NonNull Pose getCenterPose()

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.

getExtents

Added in 1.0.0-alpha09

public final @NonNull FloatSize2d getExtents()

The dimensions of the bounding box of the detected plane.

getLabel

Added in 1.0.0-alpha09

public final @NonNull Plane.Label getLabel()

The Label associated with the plane.

getSubsumedBy

Added in 1.0.0-alpha09

public final Plane getSubsumedBy()

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.

getTrackingState

public @NonNull TrackingState getTrackingState()

whether this plane is being tracked or not.

getVertices

Added in 1.0.0-alpha09

public final @NonNull List<@NonNull Vector2> getVertices()

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

hashCode

public int hashCode()