Plane

Kotlin |Java

class Plane : Trackable

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

Summary

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

Public companion functions
`StateFlow<Collection<Plane>>`	`subscribe(session: Session)` Emits the planes that are currently being tracked in the `session`.

Public functions
`open AnchorCreateResult`	`createAnchor(pose: Pose)` Creates an `Anchor` that is attached to this trackable, using the given initial `pose` in the world coordinate space.

Public properties
`open StateFlow<Plane.State>`	`state` The current state of the `Plane`.
`Plane.Type`	`type` The `Type` of the `Plane`.

Extension properties
`Flowable<Plane.State>`	`Plane.stateAsFlowable` The current state of the `Plane`.

fun subscribe(session: Session): StateFlow<Collection<Plane>>

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`

open fun createAnchor(pose: Pose): AnchorCreateResult

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

open val state: StateFlow<Plane.State>

The current state of the Plane.

val type: Plane.Type

The Type of the Plane.

val Plane.stateAsFlowable: Flowable<Plane.State>

The current state of the Plane.