Skip to main content
Version: 3.3

class ScanStore

(Niantic.ARDK.AR.Scanning.ScanStore)

Overview​

class ScanStore {
    public:
    
        class SavedScan;

        // properties
    
        string ScanBasePath;

        // methods
    
        ScanStore(string basePath);
        void DeleteScan(SavedScan scan);
        Task DeleteScanAsync(SavedScan scan);
        List<SavedScan> GetSavedScans();
    };

Detailed Documentation​

Methods​

ScanStore​

ScanStore(string basePath)

Create a ScanStore given the base path for all your scans. The path should match the ScanBasePath of XRScanningConfiguration.

    Parameters:

    basePath -

DeleteScan​

void DeleteScan(SavedScan scan)

Delete the given saved scan from disk. This must not be a scan that is currently in progress. Deleting a scan in progress is undefined behavior. The scan is invalid after deletion.

    Parameters:

    scan - The scan to delete.

DeleteScanAsync​

Task DeleteScanAsync(SavedScan scan)

Delete the scan in an async way..     See also:     DeleteScan

    Parameters:

    scan -

    Returns:

GetSavedScans​

List<SavedScan> GetSavedScans()

Return the list of scans currently saved. This will include the current active scan if called with a scan in-progress.

    Returns:

    A List of scans that are currently on-disk