class OpenXrPlane


Wraps the native XrTrackableANDROID with the Plane interface.

Summary

Public functions

open Anchor

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

open Unit
update(xrTime: Long)

Updates the entity retrieving its state at xrTime.

Public properties

open Pose

The center of the detected plane.

open Vector2

The dimensions of the detected plane.

open Plane.Label
open Plane?

If this plane has been subsumed, returns the plane this plane was merged into.

open TrackingState

The TrackingState of this trackable.

open Plane.Type

The Type of the plane

open List<Vector2>

Returns the 2D vertices (three or more) of a convex polygon approximating the detected plane.

Public functions

createAnchor

Added in 1.0.0-alpha01
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.

update

Added in 1.0.0-alpha01
open fun update(xrTime: Long): Unit

Updates the entity retrieving its state at xrTime.

Parameters
xrTime: Long

the number of nanoseconds since the start of the OpenXR epoch.

Public properties

centerPose

Added in 1.0.0-alpha01
open val centerPosePose

The center of the detected plane.

extents

Added in 1.0.0-alpha01
open val extentsVector2

The dimensions of the detected plane.

label

Added in 1.0.0-alpha01
open val labelPlane.Label

subsumedBy

Added in 1.0.0-alpha01
open val subsumedByPlane?

If this plane has been subsumed, returns the plane this plane was merged into.

trackingState

Added in 1.0.0-alpha01
open val trackingStateTrackingState

The TrackingState of this trackable.

type

Added in 1.0.0-alpha01
open val typePlane.Type

The Type of the plane

vertices

Added in 1.0.0-alpha01
open val verticesList<Vector2>

Returns the 2D vertices (three or more) of a convex polygon approximating the detected plane.