Skip to main content
←API Reference ←NianticSpatial.NSDK.AR.Utilities.Preloading ←IModelPreloader

CurrentProgress


Declaration​

public abstract PreloaderStatusCode CurrentProgress(DepthMode depthMode, out float progress)

Summary​

Read the current status of a mode file request, if a request was previously made. The result of
DownloadModel is asynchronous, so the caller must poll CurrentProgress
for the status of the request to ensure that the HTTP request completed successfully.

Returns​

Returns a PreloaderStatusCode indicating the status of the request.

Parameters​

NameTypeSummary
depthModeDepthMode
-
progressfloat
A value in the range of [0.0, 1.0] representing how much progress has been made downloading the model
file of the specified feature mode. A progress of 1.0 means the file is present in the cache. The download
progress value is server dependent and may not always support incremental progress updates.

Overload 1​

public abstract PreloaderStatusCode CurrentProgress(SceneSegmentationMode sceneSegmentationMode, out float progress)

Summary​

Read the current status of a mode file request, if a request was previously made. The result of
DownloadModel is asynchronous, so the caller must poll CurrentProgress
for the status of the request to ensure that the HTTP request completed successfully.

Returns​

Returns a PreloaderStatusCode indicating the status of the request.

Parameters​

NameTypeSummary
depthModeDepthMode
-
progressfloat
A value in the range of [0.0, 1.0] representing how much progress has been made downloading the model
file of the specified feature mode. A progress of 1.0 means the file is present in the cache. The download
progress value is server dependent and may not always support incremental progress updates.

Overload 2​

public abstract PreloaderStatusCode CurrentProgress(ScanningSQCMode scanningSQCMode, out float progress)

Summary​

Read the current status of a mode file request, if a request was previously made. The result of
DownloadModel is asynchronous, so the caller must poll CurrentProgress
for the status of the request to ensure that the HTTP request completed successfully.

Returns​

Returns a PreloaderStatusCode indicating the status of the request.

Parameters​

NameTypeSummary
depthModeDepthMode
-
progressfloat
A value in the range of [0.0, 1.0] representing how much progress has been made downloading the model
file of the specified feature mode. A progress of 1.0 means the file is present in the cache. The download
progress value is server dependent and may not always support incremental progress updates.