Skip to main content

ARDK for Android/com.nianticlabs.ardk/ScannerConfig

ScannerConfig

class ScannerConfig(var framerate: Int = 0, var enableRaycastVisualization: Boolean = false, var enableVoxelVisualization: Boolean = false, var raycastWidth: Int = 0, var raycastHeight: Int = 0, var nearDepth: Float = 0.02f, var farDepth: Float = 0.0f, var voxelSize: Float = 0.0f, var basePath: String? = null, var scanTargetId: String? = null, var useArdkDepthsIfPlatformUnavailable: Boolean = false, var enableFullResolution: Boolean = false, var fullResolutionFramerate: Int = 0)

Configuration parameters for scanning functionality.

ScannerConfig allows you to customize scan recording behavior including recording framerate, visualization settings, depth range, and output resolution. Use this class to optimize scanning performance for your specific use case.

Basic Usage​

val config = ScannerConfig(
    framerate = 30,
    enableRaycastVisualization = true,
    enableVoxelVisualization = true
)
scanningSession.configure(config)

See also​

ScanningSession.configure

Constructors​

ScannerConfig[androidJvm]
constructor(framerate: Int = 0, enableRaycastVisualization: Boolean = false, enableVoxelVisualization: Boolean = false, raycastWidth: Int = 0, raycastHeight: Int = 0, nearDepth: Float = 0.02f, farDepth: Float = 0.0f, voxelSize: Float = 0.0f, basePath: String? = null, scanTargetId: String? = null, useArdkDepthsIfPlatformUnavailable: Boolean = false, enableFullResolution: Boolean = false, fullResolutionFramerate: Int = 0)

Properties​

NameSummary
basePath[androidJvm]
var basePath: String?
Optional field to set a base path for writing scan data.
enableFullResolution[androidJvm]
var enableFullResolution: Boolean
Controls whether full-resolution camera images are recorded.
enableRaycastVisualization[androidJvm]
var enableRaycastVisualization: Boolean
Controls whether raycast visualization images are generated.
enableVoxelVisualization[androidJvm]
var enableVoxelVisualization: Boolean
Controls whether voxel visualization is enabled.
farDepth[androidJvm]
var farDepth: Float
Far depth plane for scan depth range, in meters.
framerate[androidJvm]
var framerate: Int
Target FPS for recording and visualization processes.
fullResolutionFramerate[androidJvm]
var fullResolutionFramerate: Int
Target FPS for full resolution frame recording.
nearDepth[androidJvm]
var nearDepth: Float
Near depth plane for scan depth range, in meters.
raycastHeight[androidJvm]
var raycastHeight: Int
Height of the raycast visualization's output image in pixel units.
raycastWidth[androidJvm]
var raycastWidth: Int
Width of the raycast visualization's output image in pixel units.
scanTargetId[androidJvm]
var scanTargetId: String?
Optional field to set a scan target identifier for use with Niantic Spatial's mapping services.
useArdkDepthsIfPlatformUnavailable[androidJvm]
var useArdkDepthsIfPlatformUnavailable: Boolean
Whether to use and record NSDK's estimated depths, if platform depths are unavailable.
voxelSize[androidJvm]
var voxelSize: Float
Minimum size of voxels for the voxel visualization, in meters.