SpatialEntityWatcher Class

Definition

Monitors changes to the set of entities that participants add, update, or remove within a spatial entity store, and provides notifications when that set changes.

public ref class SpatialEntityWatcher sealed
class SpatialEntityWatcher sealed
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class SpatialEntityWatcher
Public NotInheritable Class SpatialEntityWatcher
Inheritance
SpatialEntityWatcher
Attributes

Windows 10 requirements

Device family
Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v4.0)

Remarks

Important

The SpatialEntityStore approach of synchronizing spatial anchors between devices is not currently supported. Consider using Azure Spatial Anchors instead.

Properties

Status

Gets the operational status of the spatial entity watcher.

Methods

Start()

Starts watching for changes to the set of spatial entities in the store.

Stop()

Stops watching for changes to the set of spatial entities in the store.

Events

Added

The event that is raised when a new spatial entity is added to the store by a participant.

EnumerationCompleted

The event that is raised when the initial replay of prior changes to the spatial entity store has completed.

Removed

The event that is raised when a spatial entity is removed from the store by a participant.

Updated

The event that is raised when an existing spatial entity has its metadata updated by a participant.

Applies to