Skip to main content
API Reference NianticSpatial.NSDK.AR.XRSubsystems

XRScanningSubsystem

↳ extends UnityEngine.SubsystemsImplementation.SubsystemWithProvider
Defines an interface for interacting with scanning functionality.

Declaration

public class XRScanningSubsystem : SubsystemWithProvider<XRScanningSubsystem, XRScanningSubsystemDescriptor, Provider>

Remarks

This abstract class should be implemented by an XR provider and instantiated using the SubsystemManager to enumerate the available XRScanningSubsystemDescriptors.


Constructors

public XRScanningSubsystem()

Summary

Constructor. Do not invoke directly; use the SubsystemManager
to enumerate the available XRScanningSubsystemDescriptors
and call Create on the desired descriptor.


Properties

NameTypeSummary
CurrentConfigurationXRScanningConfiguration
Get or set configuration with

Methods

NameTypeSummary
ComputeVoxelsvoid
Request a voxel buffer to be computed. This is an async operation that takes some time. Obtain the result with
TryGetVoxels. "enableVoxels" must be set to true on the XRScanningConfiguration
DisposeVoxelBuffervoid
Dispose a voxel buffer previously obtained from TryGetVoxelBuffer
GetFrameCountint
-
GetScanIdstring
Get the current scan's ID.
GetStateScanningState
Get the current state of the scanning subsystem.
GetVoxelSizefloat
Get the current voxel size in meters.
SaveCurrentScanvoid
Save the current scan. Recording will stop after save. ScanID will be reset.
TryGetRaycastBufferbool
Get the latest raycast textures.
TryGetVoxelBufferbool
Get latest computed voxel buffer. This then must be later disposed with DisposeVoxelBuffer

Relationships

derived: NsdkScanningSubsystem