SpatialAnchorStore Class

Reference

Definition

Namespace:: Windows.Perception.Spatial

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents a collection of SpatialAnchor objects stored by Windows on behalf of an app.

public ref class SpatialAnchorStore sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class SpatialAnchorStore final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class SpatialAnchorStore

Public NotInheritable Class SpatialAnchorStore

Inheritance: Object Platform::Object IInspectable SpatialAnchorStore

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduced in v2.0)

Remarks

This lets an app persist SpatialAnchors and then load them back again during a future app session. The app is responsible for keeping track of which identifiers represent which logical locations within the app, for example associating an anchor with a hologram that should be displayed there.

To request the app's SpatialAnchorStore, use the SpatialAnchorManager class.

Methods

Clear()	Clears all anchors in the app's anchor store.
GetAllSavedAnchors()	Gets a map of all anchors saved in the store, with their identifiers as the keys.
Remove(String)	Removes a specific anchor from the store. The anchor is specified by its identifier.
TrySave(String, SpatialAnchor)	Persists an anchor to the store.

Applies to

Share via