Config

Artifact: androidx.xr.runtime:runtime

View Source

Added in 1.0.0-alpha05

---

Kotlin |Java

class Config

---

Defines a configuration state of all available features to be set at runtime.

An instance of this class should be passed to Session.configure to set the current configuration. Use Config.copy on Session.config to modify a copy of the existing configuration to pass to Session.configure.

Summary

Nested types
class Config.AnchorPersistenceMode Feature that allows anchors to be persisted through sessions.
class Config.DepthEstimationMode Feature that allows more accurate information about scene depth and meshes.
class Config.HandTrackingMode Feature that allows tracking of the user's hands and hand joints.
class Config.HeadTrackingMode Feature that allows tracking of the user's head pose.
class Config.PlaneTrackingMode Feature that allows tracking of and provides information about scene planes.

Public constructors
Config(     planeTracking: Config.PlaneTrackingMode,     handTracking: Config.HandTrackingMode,     headTracking: Config.HeadTrackingMode,     depthEstimation: Config.DepthEstimationMode,     anchorPersistence: Config.AnchorPersistenceMode ) Defines a configuration state of all available features to be set at runtime.

Public functions
Config	copy(     planeTracking: Config.PlaneTrackingMode,     handTracking: Config.HandTrackingMode,     headTracking: Config.HeadTrackingMode,     depthEstimation: Config.DepthEstimationMode,     anchorPersistence: Config.AnchorPersistenceMode )
open operator Boolean	equals(other: Any?)
open Int	hashCode()

Public properties
Config.AnchorPersistenceMode	anchorPersistence Feature that allows anchors to be persisted through sessions.
Config.DepthEstimationMode	depthEstimation Feature that allows more accurate information about scene depth and meshes.
Config.HandTrackingMode	handTracking Feature that allows tracking of the user's hands and hand joints.
Config.HeadTrackingMode	headTracking Feature that allows tracking of the user's head position.
Config.PlaneTrackingMode	planeTracking Feature that allows tracking of and provides information about scene planes.

Public constructors

Config

Added in 1.0.0-alpha05

Config(
    planeTracking: Config.PlaneTrackingMode = PlaneTrackingMode.DISABLED,
    handTracking: Config.HandTrackingMode = HandTrackingMode.DISABLED,
    headTracking: Config.HeadTrackingMode = HeadTrackingMode.DISABLED,
    depthEstimation: Config.DepthEstimationMode = DepthEstimationMode.DISABLED,
    anchorPersistence: Config.AnchorPersistenceMode = AnchorPersistenceMode.DISABLED
)

Defines a configuration state of all available features to be set at runtime.

An instance of this class should be passed to Session.configure to set the current configuration. Use Config.copy on Session.config to modify a copy of the existing configuration to pass to Session.configure.

Parameters
planeTracking: Config.PlaneTrackingMode = PlaneTrackingMode.DISABLED	Feature that allows tracking of and provides information about scene planes. See Config.PlaneTrackingMode.
handTracking: Config.HandTrackingMode = HandTrackingMode.DISABLED	Feature that allows tracking of the user's hands and hand joints. See Config.HandTrackingMode.
headTracking: Config.HeadTrackingMode = HeadTrackingMode.DISABLED	Feature that allows tracking of the user's head position. See Config.HeadTrackingMode.
depthEstimation: Config.DepthEstimationMode = DepthEstimationMode.DISABLED	Feature that allows more accurate information about scene depth and meshes. See Config.DepthEstimationMode.
anchorPersistence: Config.AnchorPersistenceMode = AnchorPersistenceMode.DISABLED	Feature that allows anchors to be persisted through sessions. See Config.AnchorPersistenceMode.

Public functions

copy

Added in 1.0.0-alpha05

fun copy(
    planeTracking: Config.PlaneTrackingMode = this.planeTracking,
    handTracking: Config.HandTrackingMode = this.handTracking,
    headTracking: Config.HeadTrackingMode = this.headTracking,
    depthEstimation: Config.DepthEstimationMode = this.depthEstimation,
    anchorPersistence: Config.AnchorPersistenceMode = this.anchorPersistence
): Config

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

anchorPersistence

Added in 1.0.0-alpha05

val anchorPersistence: Config.AnchorPersistenceMode

Feature that allows anchors to be persisted through sessions. See Config.AnchorPersistenceMode.

depthEstimation

Added in 1.0.0-alpha05

val depthEstimation: Config.DepthEstimationMode

Feature that allows more accurate information about scene depth and meshes. See Config.DepthEstimationMode.

handTracking

Added in 1.0.0-alpha05

val handTracking: Config.HandTrackingMode

Feature that allows tracking of the user's hands and hand joints. See Config.HandTrackingMode.

headTracking

Added in 1.0.0-alpha05

val headTracking: Config.HeadTrackingMode

Feature that allows tracking of the user's head position. See Config.HeadTrackingMode.

planeTracking

Added in 1.0.0-alpha05

val planeTracking: Config.PlaneTrackingMode

Feature that allows tracking of and provides information about scene planes. See Config.PlaneTrackingMode.