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

Overview

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

    UInt32 DepthTargetFrameRate;
    IReadOnlyCollection<IARReferenceImage> DetectionImages;
    bool IsAutoFocusEnabled;
    bool IsDepthEnabled;
    bool IsDepthPointCloudEnabled;
    bool IsMeshingEnabled;
    bool IsPalmDetectionEnabled;
    bool IsSemanticSegmentationEnabled;
    bool IsSharedExperienceEnabled;
    float MeshDecimationThreshold;
    float MeshingRadius;
    float MeshingRangeMax;
    float MeshingTargetBlockSize;
    UInt32 MeshingTargetFrameRate;
    PlaneDetection PlaneDetection;
    UInt32 SemanticTargetFrameRate;
    float VoxelSize;

    // methods

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

Inherited Members

public:
    // properties

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

    // methods

    void CopyTo(IARConfiguration target);

Detailed Documentation

Properties

UInt32 DepthTargetFrameRate

A value specifying how many times the depth generation routine should target running 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 IsDepthPointCloudEnabled

A boolean specifying whether or not depth point cloud generation are enabled.

bool IsMeshingEnabled

A boolean specifying whether or not meshing is enabled.

bool IsPalmDetectionEnabled

A boolean specifying whether or not palms are detected.

Note

This is an experimental feature. Experimental features should not be used in production products as they are subject to breaking changes, not officially supported, and may be deprecated without notice

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.

float MeshDecimationThreshold

The value specifying the distance, in meters, of the meshed surface around the player. Existing mesh blocks are decimated when distance to device is bigger than this threshold. Minimum distance is maximum meshing range.

Note

A value of 0 represents ‘Infinity’

float MeshingRadius

The value specifying the distance, in meters, of the meshed surface around the player. Existing mesh blocks are decimated when distance to device is bigger than this threshold. Minimum distance is maximum meshing range.

Note

A value of 0 represents ‘Infinity’

float MeshingRangeMax

The value specifying the maximum range in meters of a depth measurement / estimation used for meshing.

float MeshingTargetBlockSize

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

UInt32 MeshingTargetFrameRate

A value specifying how many times the meshing routine should target running per second.

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 how many times the semantic segmentation routine should target running per second.

float VoxelSize

The value specifying the edge length of the meshing voxels in meters.

Methods

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

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