Plane

Kotlin |Java

public final class Plane implements Trackable

Describes the system's current best knowledge of a real-world planar surface.

Summary

Nested types
`public final class Plane.Label` A semantic description of a `Plane`.
`public final class Plane.State implements Trackable.State` The representation of the current state of a `Plane`.
`public final class Plane.Type` A simple summary of the normal vector of a `Plane`.

Public methods
`@NonNull AnchorCreateResult`	`createAnchor(@NonNull Pose pose)` Creates an `Anchor` that is attached to this trackable, using the given initial `pose` in the world coordinate space.
`@NonNull StateFlow<@NonNull Plane.State>`	`getState()` The current state of the `Plane`.
`final @NonNull Plane.Type`	`getType()` The `Type` of the `Plane`.
`static final @NonNull StateFlow<@NonNull Collection<@NonNull Plane>>`	`subscribe(@NonNull Session session)` Emits the planes that are currently being tracked in the `session`.
`void`	`update()` Updates the state of the `Updatable`.

public @NonNull AnchorCreateResult createAnchor(@NonNull Pose pose)

Creates an Anchor that is attached to this trackable, using the given initial pose in the world coordinate space.

Throws
`kotlin.IllegalStateException`	if `PlaneTrackingMode` is set to Disabled.

public @NonNull StateFlow<@NonNull Plane.State> getState()

The current state of the Plane.

public final @NonNull Plane.Type getType()

The Type of the Plane.

public static final @NonNull StateFlow<@NonNull Collection<@NonNull Plane>> subscribe(@NonNull Session session)

Emits the planes that are currently being tracked in the session.

Throws
`kotlin.IllegalStateException`	if `PlaneTrackingMode` is set to Disabled.

public void update()

Updates the state of the Updatable.