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

This class is deprecated. Use androidx.xr.runtime.AnchorPersistenceMode instead.
abstract class Config.ConfigMode

Describes a specific value used to set the configuration via Session.configure.

This class is deprecated. Use androidx.xr.runtime.DepthEstimationMode instead.

This class is deprecated. Use androidx.xr.runtime.DeviceTrackingMode instead.

This class is deprecated. Use androidx.xr.runtime.FaceTrackingMode instead.

This class is deprecated. Use androidx.xr.runtime.GeospatialMode instead.

This class is deprecated. Use androidx.xr.runtime.HandTrackingMode instead.

This class is deprecated. Use androidx.xr.runtime.PlaneTrackingMode instead.

Public constructors

This function is deprecated. Use the constructor with androidx.xr.runtime.* ConfigMode classes instead.
Config(
    planeTracking: Config.PlaneTrackingMode,
    handTracking: Config.HandTrackingMode
)

This function is deprecated. Use the constructor with androidx.xr.runtime.* ConfigMode classes instead.
Config(
    planeTracking: Config.PlaneTrackingMode,
    handTracking: Config.HandTrackingMode,
    deviceTracking: Config.DeviceTrackingMode
)

This function is deprecated. Use the constructor with androidx.xr.runtime.* ConfigMode classes instead.
Config(
    planeTracking: Config.PlaneTrackingMode,
    handTracking: Config.HandTrackingMode,
    deviceTracking: Config.DeviceTrackingMode,
    depthEstimation: Config.DepthEstimationMode
)

This function is deprecated. Use the constructor with androidx.xr.runtime.* ConfigMode classes instead.
Config(
    planeTracking: Config.PlaneTrackingMode,
    handTracking: Config.HandTrackingMode,
    deviceTracking: Config.DeviceTrackingMode,
    depthEstimation: Config.DepthEstimationMode,
    anchorPersistence: Config.AnchorPersistenceMode
)

This function is deprecated. Use the constructor with androidx.xr.runtime.* ConfigMode classes instead.
Config(
    planeTracking: Config.PlaneTrackingMode,
    handTracking: Config.HandTrackingMode,
    deviceTracking: Config.DeviceTrackingMode,
    depthEstimation: Config.DepthEstimationMode,
    anchorPersistence: Config.AnchorPersistenceMode,
    faceTracking: Config.FaceTrackingMode
)

This function is deprecated. Use the constructor with androidx.xr.runtime.* ConfigMode classes instead.
Config(
    planeTracking: Config.PlaneTrackingMode,
    handTracking: Config.HandTrackingMode,
    deviceTracking: Config.DeviceTrackingMode,
    depthEstimation: Config.DepthEstimationMode,
    anchorPersistence: Config.AnchorPersistenceMode,
    faceTracking: Config.FaceTrackingMode,
    geospatial: Config.GeospatialMode
)

This function is deprecated. Use the constructor with androidx.xr.runtime.* ConfigMode classes instead.
Config(
    planeTracking: PlaneTrackingMode,
    handTracking: HandTrackingMode,
    deviceTracking: DeviceTrackingMode,
    depthEstimation: DepthEstimationMode,
    anchorPersistence: AnchorPersistenceMode,
    faceTracking: FaceTrackingMode,
    geospatial: GeospatialMode
)

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

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

Public properties
AnchorPersistenceMode

Feature that allows anchors to be persisted through sessions.
DepthEstimationMode

Feature that allows more accurate information about scene depth and meshes.
DeviceTrackingMode

Feature that allows tracking of the AR device.
FaceTrackingMode
GeospatialMode

Feature that allows geospatial localization and tracking.
HandTrackingMode

Feature that allows tracking of the user's hands and hand joints.
PlaneTrackingMode

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

Public constructors

Config

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
Config(planeTracking: Config.PlaneTrackingMode)

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

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

Config

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
Config(
    planeTracking: Config.PlaneTrackingMode,
    handTracking: Config.HandTrackingMode
)

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

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

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

Config

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
Config(
    planeTracking: Config.PlaneTrackingMode,
    handTracking: Config.HandTrackingMode,
    deviceTracking: Config.DeviceTrackingMode
)

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

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

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

Feature that allows tracking of the AR device. See Config.DeviceTrackingMode.

Config

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
Config(
    planeTracking: Config.PlaneTrackingMode,
    handTracking: Config.HandTrackingMode,
    deviceTracking: Config.DeviceTrackingMode,
    depthEstimation: Config.DepthEstimationMode
)

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

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

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

Feature that allows tracking of the AR device. See Config.DeviceTrackingMode.
depthEstimation: Config.DepthEstimationMode

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

Config

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
Config(
    planeTracking: Config.PlaneTrackingMode,
    handTracking: Config.HandTrackingMode,
    deviceTracking: Config.DeviceTrackingMode,
    depthEstimation: Config.DepthEstimationMode,
    anchorPersistence: Config.AnchorPersistenceMode
)

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

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

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

Feature that allows tracking of the AR device. See Config.DeviceTrackingMode.
depthEstimation: Config.DepthEstimationMode

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

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

Config

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
Config(
    planeTracking: Config.PlaneTrackingMode,
    handTracking: Config.HandTrackingMode,
    deviceTracking: Config.DeviceTrackingMode,
    depthEstimation: Config.DepthEstimationMode,
    anchorPersistence: Config.AnchorPersistenceMode,
    faceTracking: Config.FaceTrackingMode
)

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

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

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

Feature that allows tracking of the AR device. See Config.DeviceTrackingMode.
depthEstimation: Config.DepthEstimationMode

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

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

Feature that allows tracking of human faces. See Config.FaceTrackingMode.

Config

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
Config(
    planeTracking: Config.PlaneTrackingMode,
    handTracking: Config.HandTrackingMode,
    deviceTracking: Config.DeviceTrackingMode,
    depthEstimation: Config.DepthEstimationMode,
    anchorPersistence: Config.AnchorPersistenceMode,
    faceTracking: Config.FaceTrackingMode,
    geospatial: Config.GeospatialMode
)

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

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

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

Feature that allows tracking of the AR device. See Config.DeviceTrackingMode.
depthEstimation: Config.DepthEstimationMode

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

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

Feature that allows tracking of human faces. See Config.FaceTrackingMode.
geospatial: Config.GeospatialMode

Feature that allows geospatial localization and tracking. See Config.GeospatialMode.

Config

Added in 1.0.0-alpha11
Config(
    planeTracking: PlaneTrackingMode = androidx.xr.runtime.PlaneTrackingMode.DISABLED,
    handTracking: HandTrackingMode = androidx.xr.runtime.HandTrackingMode.DISABLED,
    deviceTracking: DeviceTrackingMode = androidx.xr.runtime.DeviceTrackingMode.DISABLED,
    depthEstimation: DepthEstimationMode = androidx.xr.runtime.DepthEstimationMode.DISABLED,
    anchorPersistence: AnchorPersistenceMode = androidx.xr.runtime.AnchorPersistenceMode.DISABLED,
    faceTracking: FaceTrackingMode = androidx.xr.runtime.FaceTrackingMode.DISABLED,
    geospatial: GeospatialMode = androidx.xr.runtime.GeospatialMode.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: PlaneTrackingMode = androidx.xr.runtime.PlaneTrackingMode.DISABLED

Feature that allows tracking of and provides information about scene planes. See androidx.xr.runtime.PlaneTrackingMode.
handTracking: HandTrackingMode = androidx.xr.runtime.HandTrackingMode.DISABLED

Feature that allows tracking of the user's hands and hand joints. See androidx.xr.runtime.HandTrackingMode.
deviceTracking: DeviceTrackingMode = androidx.xr.runtime.DeviceTrackingMode.DISABLED

Feature that allows tracking of the AR device. See androidx.xr.runtime.DeviceTrackingMode.
depthEstimation: DepthEstimationMode = androidx.xr.runtime.DepthEstimationMode.DISABLED

Feature that allows more accurate information about scene depth and meshes. See androidx.xr.runtime.DepthEstimationMode.
anchorPersistence: AnchorPersistenceMode = androidx.xr.runtime.AnchorPersistenceMode.DISABLED

Feature that allows anchors to be persisted through sessions. See androidx.xr.runtime.AnchorPersistenceMode.
faceTracking: FaceTrackingMode = androidx.xr.runtime.FaceTrackingMode.DISABLED

Feature that allows tracking of human faces. See androidx.xr.runtime.FaceTrackingMode.
geospatial: GeospatialMode = androidx.xr.runtime.GeospatialMode.DISABLED

Feature that allows geospatial localization and tracking. See androidx.xr.runtime.GeospatialMode.

Public functions

copy

Added in 1.0.0-alpha11
fun copy(
    planeTracking: PlaneTrackingMode = this.planeTracking,
    handTracking: HandTrackingMode = this.handTracking,
    deviceTracking: DeviceTrackingMode = this.deviceTracking,
    depthEstimation: DepthEstimationMode = this.depthEstimation,
    anchorPersistence: 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-alpha11
val anchorPersistence: AnchorPersistenceMode

Feature that allows anchors to be persisted through sessions. See androidx.xr.runtime.AnchorPersistenceMode.

depthEstimation

Added in 1.0.0-alpha11
val depthEstimation: DepthEstimationMode

Feature that allows more accurate information about scene depth and meshes. See androidx.xr.runtime.DepthEstimationMode.

deviceTracking

Added in 1.0.0-alpha11
val deviceTracking: DeviceTrackingMode

Feature that allows tracking of the AR device. See androidx.xr.runtime.DeviceTrackingMode.

faceTracking

Added in 1.0.0-alpha11
val faceTracking: FaceTrackingMode

geospatial

Added in 1.0.0-alpha11
val geospatial: GeospatialMode

Feature that allows geospatial localization and tracking. See androidx.xr.runtime.GeospatialMode.

handTracking

Added in 1.0.0-alpha11
val handTracking: HandTrackingMode

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

planeTracking

Added in 1.0.0-alpha11
val planeTracking: PlaneTrackingMode

Feature that allows tracking of and provides information about scene planes. See androidx.xr.runtime.PlaneTrackingMode.