Skip to main content
←API Reference ←NianticSpatial.NSDK.AR.Mapping

ARDeviceMappingManager

↳ extends UnityEngine.XR.ARFoundation.SubsystemLifecycleManager
ARDeviceMappingManager can be used to create and manage maps on the local device.

Declaration​

public class ARDeviceMappingManager : SubsystemLifecycleManager<XRDeviceMappingSubsystem, XRDeviceMappingSubsystemDescriptor, Provider>

Properties​

NameTypeSummary
readonly IsMappingInProgressbool
A state if mapping is in progress or not. True is mapping is ongoing. Becomes false after calling StopMapping()
This is an experimental feature, and is subject to breaking changes or deprecation without notice
MappingSplitterMaxDistanceMetersfloat
Property access for map splitting criteria by distance
This is an experimental feature, and is subject to breaking changes or deprecation without notice
MappingSplitterMaxDurationSecondsfloat
Property access for map splitting criteria by time
This is an experimental feature, and is subject to breaking changes or deprecation without notice
MappingTargetFrameRateuint
Property access for mapping speed
This is an experimental feature, and is subject to breaking changes or deprecation without notice
readonly RootAnchorPayloadstring
Get the root anchor payload if one has been created (as base64-encoded string).
This is an experimental feature, and is subject to breaking changes or deprecation without notice

Methods​

NameTypeSummary
ClearMapvoid
-
ExtractMapMetadataFromRootAnchorbool
Extract the metadata from a map relative to the stored root anchor.
OnBeforeStartvoid
-
OnDestroyvoid
-
OnDisablevoid
-
StartMappingvoid
Start map generation
StopMappingvoid
Stop map generation
TryGetMapDatabool
-

Events​

NameTypeSummary
MapFinalizedAction<byte[]>
An event when device map is finalized and ready to save
This is an experimental feature, and is subject to breaking changes or deprecation without notice
MapUpdatedAction<byte[]>
An event when device map data has been updated. The surfaced map contains only the parts of the map that
were updated since the last time this event was invoked. Use TryGetMapData to get the entire map.
This is an experimental feature, and is subject to breaking changes or deprecation without notice