Skip to main content
Version: 3.3

interface IARScanQualityClassifier

(Niantic.Lightship.AR.Scanning.IARScanQualityClassifier)

Overview​

    interface IARScanQualityClassifier: IDisposable {
        // properties
    
        bool Running;
        float Progress;

        // methods
    
        bool Run(float framerate, string scanPath);
        void CancelCurrentRun();
        ScanQualityResult GetResult(string scanPath);
    };

    // direct descendants

    class ARScanQualityClassifier;

Detailed Documentation​

Properties​

Running​

bool Running

Flag tells if a scan quality compute is running or not.

    Returns:

    Whether or not a run of quality computer is ongoing.

Progress​

float Progress

Progress of current quality compute, range is in percent between [0, 100.0].

    Returns:

    Percentage of existing run. 0 will be returned if not running a quality compute.

Methods​

Run​

bool Run(float framerate, string scanPath)

Start a run to compute the scan quality asynchoursly.

    Parameters:

    scanPath - Identifier of a scan.

    Returns:

    Whether or not the run will start, if ARScanQualityClassifier has already running, it will return false.

CancelCurrentRun​

void CancelCurrentRun()

Cancel current run. When the function returns, it is guaranteed the ARScanQualityClassifier is not running a scan. Do nothing if it is not running.

GetResult​

ScanQualityResult GetResult(string scanPath)

Returns a ScanQualityResult of current quality compute, Scores are in range of [0, 1.0]. Higher values means high scan quality. Categories are within ScanQualityCategory.

    Returns:

    A ScanQualityResult with overall score and RejectionReasons. RejectionReasons will be empty if all scores pass the quality bar.