Skip to main content
API Reference NSDK NSDKMeshingSession

Configuration

The type of configuration used by this session

Declaration

struct Configuration

Constructors

init(frameRate: UInt32 = 0, fuseKeyframesOnly: Bool = false, maximumIntegrationDistance: Float = 0, voxelSize: Float = 0, enableDistanceBasedVolumetricCleanup: Bool = false, numVoxelLevels: Int32 = 0, meshBlockSize: Float = 0, meshCullingDistance: Float = 0, enableMeshDecimation: Bool = true, filterMeshWithSceneSegmentation: Bool = false, enableAllowlist: Bool = false, packedAllowlist: SceneSegmentationChannels = SceneSegmentationChannels(), enableBlocklist: Bool = false, packedBlocklist: SceneSegmentationChannels = SceneSegmentationChannels())

Properties

NameTypeSummary
var enableAllowlistBool
If true, packedAllowlist will be used to filter the mesh.
Requires filterMeshWithSceneSegmentation to be true.
var enableBlocklistBool
If true, packedBlocklist will be used to filter the mesh.
Requires filterMeshWithSceneSegmentation to be true.
var enableDistanceBasedVolumetricCleanupBool
If true, the feature will clean up internal data that is far away from the user
to improve performance. This will not remove previously-generated mesh.
var enableMeshDecimationBool
If true, mesh surfaces will be simplified to save compute and memory
var filterMeshWithSceneSegmentationBool
If true, the mesh will be filtered according to the packedAllowlist and/or packedBlocklist.
var frameRateUInt32
Target frame rate for the meshing feature
var fuseKeyframesOnlyBool
If true, only high-quality frames will be integrated into the mesh,
but updates will be less frequent
var maximumIntegrationDistanceFloat
The maximum distance from the device sensor to incorporate depth data, in meters
var meshBlockSizeFloat
The size of the mesh blocks, in meters
var meshCullingDistanceFloat
Mesh culling distance, in meters
Setting meshCullingDistance less than maximumIntegrationDistance may lead
to unexpected behaviour.
var numVoxelLevelsInt32
The levels of detail in the voxel grid
By default, this is 0.
Setting this to a value greater than 1 will allow lower detail levels to be used
in areas with less thorough coverage.
var packedAllowlistSceneSegmentationChannels
Semantic channels to include in the mesh (e.g. [.ground, .grass]).
var packedBlocklistSceneSegmentationChannels
Semantic channels to exclude from the mesh (e.g. [.sky]).
var voxelSizeFloat
Voxel size for the meshing engine, in meters