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

public final class Config.AnchorPersistenceMode implements Config.ConfigMode

Feature that allows anchors to be persisted through sessions.

public interface Config.ConfigMode

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

public final class Config.DepthEstimationMode implements Config.ConfigMode

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

public final class Config.DeviceTrackingMode implements Config.ConfigMode

Feature that allows tracking of the AR device.

public final class Config.FaceTrackingMode implements Config.ConfigMode

Feature that allows tracking of human faces.

public final class Config.GeospatialMode implements Config.ConfigMode

Feature that allows Geospatial localization and tracking.

public final class Config.HandTrackingMode implements Config.ConfigMode

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

public final class Config.HeadTrackingMode implements Config.ConfigMode

Feature that allows tracking of the user's head pose.

public final class Config.PlaneTrackingMode implements Config.ConfigMode

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

Public constructors

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

Public methods

final @NonNull Config
copy(
    @NonNull Config.PlaneTrackingMode planeTracking,
    @NonNull Config.HandTrackingMode handTracking,
    @NonNull Config.HeadTrackingMode headTracking,
    @NonNull Config.DepthEstimationMode depthEstimation,
    @NonNull Config.AnchorPersistenceMode anchorPersistence
)
boolean
equals(Object other)
final @NonNull Config.AnchorPersistenceMode

Feature that allows anchors to be persisted through sessions.

final @NonNull Config.DepthEstimationMode

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

final @NonNull Config.FaceTrackingMode
final @NonNull Config.GeospatialMode

Feature that allows geospatial localization and tracking.

final @NonNull Config.HandTrackingMode

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

final @NonNull Config.HeadTrackingMode

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

final @NonNull Config.PlaneTrackingMode

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

int

Public constructors

Config

Added in 1.0.0-alpha08
public Config(
    @NonNull Config.PlaneTrackingMode planeTracking,
    @NonNull Config.HandTrackingMode handTracking,
    @NonNull Config.HeadTrackingMode headTracking,
    @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.HeadTrackingMode headTracking

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

@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.

Public methods

copy

Added in 1.0.0-alpha08
public final @NonNull Config copy(
    @NonNull Config.PlaneTrackingMode planeTracking,
    @NonNull Config.HandTrackingMode handTracking,
    @NonNull Config.HeadTrackingMode headTracking,
    @NonNull Config.DepthEstimationMode depthEstimation,
    @NonNull Config.AnchorPersistenceMode anchorPersistence
)

equals

public boolean equals(Object other)

getAnchorPersistence

Added in 1.0.0-alpha08
public final @NonNull Config.AnchorPersistenceMode getAnchorPersistence()

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

getDepthEstimation

Added in 1.0.0-alpha08
public final @NonNull Config.DepthEstimationMode getDepthEstimation()

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

getFaceTracking

Added in 1.0.0-alpha08
public final @NonNull Config.FaceTrackingMode getFaceTracking()

getGeospatial

Added in 1.0.0-alpha08
public final @NonNull Config.GeospatialMode getGeospatial()

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

getHandTracking

Added in 1.0.0-alpha08
public final @NonNull Config.HandTrackingMode getHandTracking()

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

getHeadTracking

Added in 1.0.0-alpha08
public final @NonNull Config.HeadTrackingMode getHeadTracking()

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

getPlaneTracking

Added in 1.0.0-alpha08
public final @NonNull Config.PlaneTrackingMode getPlaneTracking()

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

hashCode

public int hashCode()