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 Anchor`	`createAnchor(pose: Pose)` Creates an `Anchor` that is attached to this trackable, using the given initial `pose` in the world coordinate space.
`open suspend Unit`	`update()` Updates the state of the `Updatable`.

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

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

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

open fun createAnchor(pose: Pose): Anchor

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

open suspend fun update(): Unit

Updates the state of the Updatable.

open val state: StateFlow<Plane.State>

The current state of the Plane.

val type: Plane.Type

The Type of the Plane.