interface IARWorldTrackingConfiguration (Niantic.ARDK.AR.Configuration.IARWorldTrackingConfiguration)

Overview

interface IARWorldTrackingConfiguration: Niantic.ARDK.AR.Configuration.IARConfiguration {
    // properties

    DepthPointCloudGenerator.Settings DepthPointCloudSettings;
    UInt32 DepthTargetFrameRate;
    IReadOnlyCollection<IARReferenceImage> DetectionImages;
    bool IsAutoFocusEnabled;
    bool IsDepthEnabled;
    bool IsMeshingEnabled;
    bool IsSemanticSegmentationEnabled;
    bool IsSharedExperienceEnabled;
    MapLayerIdentifier MapLayerIdentifier;
    MappingRole MappingRole;
    float MeshingRadius;
    float MeshingTargetBlockSize;
    UInt32 MeshingTargetFrameRate;
    PlaneDetection PlaneDetection;
    UInt32 SemanticTargetFrameRate;

    // methods

    void SetDetectionImagesAsync(
        IReadOnlyCollection<IARReferenceImage> detectionImages,
        Action completionHandler
    );
};

Inherited Members

public:
    // properties

    bool IsLightEstimationEnabled;
    ReadOnlyCollection<IARVideoFormat> SupportedVideoFormats;
    IARVideoFormat VideoFormat;
    WorldAlignment WorldAlignment;

    // methods

    void CopyTo(IARConfiguration target);

Detailed Documentation

Properties

DepthPointCloudGenerator.Settings DepthPointCloudSettings

Configuration settings for the estimated depths point cloud generator.

UInt32 DepthTargetFrameRate

A value specifying the target framerate of how many times the depth estimation routine should be run per second.

IReadOnlyCollection<IARReferenceImage> DetectionImages

Used to get or set the reference images to detect when running this configuration.

Note

Not supported in Editor.

bool IsAutoFocusEnabled

A value specifying whether the camera should use autofocus or not when running.

bool IsDepthEnabled

A boolean specifying whether or not depths are enabled.

bool IsMeshingEnabled

A boolean specifying whether or not meshing is enabled.

bool IsSemanticSegmentationEnabled

A boolean specifying whether or not semantic segmentation is enabled.

bool IsSharedExperienceEnabled

A boolean specifying whether the session will generate the necessary data to enable peer-to-peer AR experiences. Defaults to false.

MapLayerIdentifier MapLayerIdentifier

A value specifying which map layer to use.

Note

This is part of an experimental feature that is currently disabled in release builds.

MappingRole MappingRole

A value specifying whether this session should build maps or only localize against maps.

Note

This is part of an experimental feature that is currently disabled in release builds.

float MeshingRadius

A value specifying the radius in meters of the meshed area around the player. The minimum value is 5 meters. The default value is 0, meaning that there is no limitations while the mesh grows forever.

float MeshingTargetBlockSize

A value specifying the target size of a mesh block in meters.

UInt32 MeshingTargetFrameRate

A value specifying the target number of times per second to run the mesh update routine.

PlaneDetection PlaneDetection

A value specifying how and whether the session will detect real-world surfaces.

Note

Defaults to PlaneDetection.None.

UInt32 SemanticTargetFrameRate

A value specifying the target framerate of how many times the semantic segmentation routine should be run per second.

Methods

void SetDetectionImagesAsync(
    IReadOnlyCollection<IARReferenceImage> detectionImages,
    Action completionHandler
)

Set the detection images for this configuration asynchronously. The provided callback will be called upon completion.