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`.

Extension functions
`final @NonNull Flowable<@NonNull Plane.State>`	`RxJava3PlaneKt.getStateAsFlowable(@NonNull Plane receiver)` The current state of the `Plane`.

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 `Session.config` is set to `Config.PlaneTrackingMode.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.

Only Planes that are TrackingState.TRACKING will be emitted in the Collection. Instances of the same Plane will remain between subsequent emits to the StateFlow as long as they remain tracking.

Throws
`kotlin.IllegalStateException`	if `Session.config` is set to `Config.PlaneTrackingMode.DISABLED`

public final @NonNull Flowable<@NonNull Plane.State> RxJava3PlaneKt.getStateAsFlowable(@NonNull Plane receiver)

The current state of the Plane.