public final 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.
public 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.
public final class Config.DeviceTrackingMode extends Config.ConfigMode

This class is deprecated. Use androidx.xr.runtime.DeviceTrackingMode instead.
public final class Config.FaceTrackingMode extends Config.ConfigMode

This class is deprecated. Use androidx.xr.runtime.FaceTrackingMode instead.
public final class Config.GeospatialMode extends Config.ConfigMode

This class is deprecated. Use androidx.xr.runtime.GeospatialMode instead.
public final class Config.HandTrackingMode extends Config.ConfigMode

This class is deprecated. Use androidx.xr.runtime.HandTrackingMode instead.
public final class Config.PlaneTrackingMode extends Config.ConfigMode

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

Public constructors

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

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

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

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

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

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

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

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

Public methods
final @NonNull Config
copy(
    @NonNull PlaneTrackingMode planeTracking,
    @NonNull HandTrackingMode handTracking,
    @NonNull DeviceTrackingMode deviceTracking,
    @NonNull DepthEstimationMode depthEstimation,
    @NonNull AnchorPersistenceMode anchorPersistence
)
boolean
equals(Object other)
final @NonNull AnchorPersistenceMode

Feature that allows anchors to be persisted through sessions.
final @NonNull DepthEstimationMode

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

Feature that allows tracking of the AR device.
final @NonNull FaceTrackingMode
final @NonNull GeospatialMode

Feature that allows geospatial localization and tracking.
final @NonNull HandTrackingMode

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

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

Public constructors

Config

Added in 1.0.0-alpha11
Deprecated in 1.0.0-alpha11
public Config(@NonNull Config.PlaneTrackingMode planeTracking)

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
@NonNull Config.PlaneTrackingMode planeTracking

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
public Config(
    @NonNull Config.PlaneTrackingMode planeTracking,
    @NonNull Config.HandTrackingMode handTracking
)

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
@NonNull Config.PlaneTrackingMode planeTracking

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

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
public Config(
    @NonNull Config.PlaneTrackingMode planeTracking,
    @NonNull Config.HandTrackingMode handTracking,
    @NonNull Config.DeviceTrackingMode deviceTracking
)

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
@NonNull Config.PlaneTrackingMode planeTracking

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

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

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

Config

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

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
@NonNull Config.PlaneTrackingMode planeTracking

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

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

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

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
public Config(
    @NonNull Config.PlaneTrackingMode planeTracking,
    @NonNull Config.HandTrackingMode handTracking,
    @NonNull Config.DeviceTrackingMode deviceTracking,
    @NonNull Config.DepthEstimationMode depthEstimation,
    @NonNull Config.AnchorPersistenceMode anchorPersistence
)

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
@NonNull Config.PlaneTrackingMode planeTracking

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

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

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

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

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
public Config(
    @NonNull Config.PlaneTrackingMode planeTracking,
    @NonNull Config.HandTrackingMode handTracking,
    @NonNull Config.DeviceTrackingMode deviceTracking,
    @NonNull Config.DepthEstimationMode depthEstimation,
    @NonNull Config.AnchorPersistenceMode anchorPersistence,
    @NonNull Config.FaceTrackingMode faceTracking
)

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
@NonNull Config.PlaneTrackingMode planeTracking

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

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

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

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

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

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

Config

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

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
@NonNull Config.PlaneTrackingMode planeTracking

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

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

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

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

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

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

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

Config

Added in 1.0.0-alpha11
public Config(
    @NonNull PlaneTrackingMode planeTracking,
    @NonNull HandTrackingMode handTracking,
    @NonNull DeviceTrackingMode deviceTracking,
    @NonNull DepthEstimationMode depthEstimation,
    @NonNull AnchorPersistenceMode anchorPersistence,
    @NonNull FaceTrackingMode faceTracking,
    @NonNull GeospatialMode geospatial
)

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
@NonNull PlaneTrackingMode planeTracking

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

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

Feature that allows tracking of the AR device. See androidx.xr.runtime.DeviceTrackingMode.
@NonNull DepthEstimationMode depthEstimation

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

Feature that allows anchors to be persisted through sessions. See androidx.xr.runtime.AnchorPersistenceMode.
@NonNull FaceTrackingMode faceTracking

Feature that allows tracking of human faces. See androidx.xr.runtime.FaceTrackingMode.
@NonNull GeospatialMode geospatial

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

Public methods

copy

Added in 1.0.0-alpha11
public final @NonNull Config copy(
    @NonNull PlaneTrackingMode planeTracking,
    @NonNull HandTrackingMode handTracking,
    @NonNull DeviceTrackingMode deviceTracking,
    @NonNull DepthEstimationMode depthEstimation,
    @NonNull AnchorPersistenceMode anchorPersistence
)

equals

public boolean equals(Object other)

getAnchorPersistence

Added in 1.0.0-alpha11
public final @NonNull AnchorPersistenceMode getAnchorPersistence()

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

getDepthEstimation

Added in 1.0.0-alpha11
public final @NonNull DepthEstimationMode getDepthEstimation()

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

getDeviceTracking

Added in 1.0.0-alpha11
public final @NonNull DeviceTrackingMode getDeviceTracking()

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

getFaceTracking

Added in 1.0.0-alpha11
public final @NonNull FaceTrackingMode getFaceTracking()

getGeospatial

Added in 1.0.0-alpha11
public final @NonNull GeospatialMode getGeospatial()

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

getHandTracking

Added in 1.0.0-alpha11
public final @NonNull HandTrackingMode getHandTracking()

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

getPlaneTracking

Added in 1.0.0-alpha11
public final @NonNull PlaneTrackingMode getPlaneTracking()

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

hashCode

public int hashCode()