←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

Name	Type	Summary
readonly IsMappingInProgress	bool	A state if mapping is in progress or not. True is mapping is ongoing. Becomes false after calling StopMapping()
MappingSplitterMaxDistanceMeters	float	Property access for map splitting criteria by distance
MappingSplitterMaxDurationSeconds	float	Property access for map splitting criteria by time
MappingTargetFrameRate	uint	Property access for mapping speed
readonly RootAnchorPayload	string	Get the root anchor payload if one has been created (as base64-encoded string).

---

Methods

Name	Type	Summary
ClearMap	void	-
ExtractMapMetadataFromRootAnchor	bool	Extract the metadata from a map relative to the stored root anchor.
StartMapping	void	Start map generation
StopMapping	void	Stop map generation
TryGetMapData	bool	-

---

Events

Name	Type	Summary
MapFinalized	Action<byte[]>	An event when device map is finalized and ready to save
MapUpdated	Action<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.

---