SpatialEntityWatcher
SpatialEntityWatcher
SpatialEntityWatcher
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 : sealed class SpatialEntityWatcher : ISpatialEntityWatcherpublic sealed class SpatialEntityWatcher : ISpatialEntityWatcherPublic NotInheritable Class SpatialEntityWatcher Implements ISpatialEntityWatcher// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
Properties
Methods
Start() Start() Start() Start()
Starts watching for changes to the set of spatial entities in the store.
public : void Start()public void Start()Public Function Start() As void// You can use this method in JavaScript.
Remarks
This will replay any changes to the spatial entity store that occurred before the app called Start.
Events
Added Added Added Added
The event that is raised when a new spatial entity is added to the store by a participant.
public : event TypedEventHandler Added<SpatialEntityWatcher, SpatialEntityAddedEventArgs>public event TypedEventHandler Added<SpatialEntityWatcher, SpatialEntityAddedEventArgs>Public Event Added<SpatialEntityWatcher, SpatialEntityAddedEventArgs>// You can use this event in JavaScript.
EnumerationCompleted EnumerationCompleted EnumerationCompleted EnumerationCompleted
The event that is raised when the initial replay of prior changes to the spatial entity store has completed.
public : event TypedEventHandler EnumerationCompleted<SpatialEntityWatcher, object>public event TypedEventHandler EnumerationCompleted<SpatialEntityWatcher, object>Public Event EnumerationCompleted<SpatialEntityWatcher, object>// You can use this event in JavaScript.
Removed Removed Removed Removed
The event that is raised when a spatial entity is removed from the store by a participant.
public : event TypedEventHandler Removed<SpatialEntityWatcher, SpatialEntityRemovedEventArgs>public event TypedEventHandler Removed<SpatialEntityWatcher, SpatialEntityRemovedEventArgs>Public Event Removed<SpatialEntityWatcher, SpatialEntityRemovedEventArgs>// You can use this event in JavaScript.
Updated Updated Updated Updated
The event that is raised when an existing spatial entity has its metadata updated by a participant.
public : event TypedEventHandler Updated<SpatialEntityWatcher, SpatialEntityUpdatedEventArgs>public event TypedEventHandler Updated<SpatialEntityWatcher, SpatialEntityUpdatedEventArgs>Public Event Updated<SpatialEntityWatcher, SpatialEntityUpdatedEventArgs>// You can use this event in JavaScript.
Remarks
Note that adjustments to the position of a spatial anchor that occur as the device learns more about its environment are not represented by this Updated event. Apps should react to changes to the anchor's coordinate system each frame, just as is necessary for local anchors.