SpatialEntityStore SpatialEntityStore SpatialEntityStore SpatialEntityStore Class

Definition

Represents a shared pool of spatial entities, synchronized automatically among the participants in a remote session.

public : sealed class SpatialEntityStore : ISpatialEntityStorepublic sealed class SpatialEntityStore : ISpatialEntityStorePublic NotInheritable Class SpatialEntityStore Implements ISpatialEntityStore// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Properties

IsSupported IsSupported IsSupported IsSupported

Gets whether spatial entity sharing is supported on this system.

public : static PlatForm::Boolean IsSupported { get; }public static bool IsSupported { get; }Public Static ReadOnly Property IsSupported As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Whether spatial entity sharing is supported on this system.

Methods

CreateEntityWatcher() CreateEntityWatcher() CreateEntityWatcher() CreateEntityWatcher()

Gets a watcher that lets an app observe when participants add, update or remove entities in the store.

public : SpatialEntityWatcher CreateEntityWatcher()public SpatialEntityWatcher CreateEntityWatcher()Public Function CreateEntityWatcher() As SpatialEntityWatcher// You can use this method in JavaScript.
Returns

RemoveAsync(SpatialEntity) RemoveAsync(SpatialEntity) RemoveAsync(SpatialEntity) RemoveAsync(SpatialEntity)

Removes a spatial entity from the store for all participants.

public : IAsyncAction RemoveAsync(SpatialEntity entity)public IAsyncAction RemoveAsync(SpatialEntity entity)Public Function RemoveAsync(entity As SpatialEntity) As IAsyncAction// You can use this method in JavaScript.
Parameters
entity
SpatialEntity SpatialEntity SpatialEntity SpatialEntity

The spatial entity to remove.

Returns

Action that triggers once once the entity removal has been communicated to the host.

SaveAsync(SpatialEntity) SaveAsync(SpatialEntity) SaveAsync(SpatialEntity) SaveAsync(SpatialEntity)

Saves a new or updated spatial entity into the store, to be synchronized with all participants.

public : IAsyncAction SaveAsync(SpatialEntity entity)public IAsyncAction SaveAsync(SpatialEntity entity)Public Function SaveAsync(entity As SpatialEntity) As IAsyncAction// You can use this method in JavaScript.
Parameters
entity
SpatialEntity SpatialEntity SpatialEntity SpatialEntity

The new or updated spatial entity.

Returns

Action that triggers once once the entity data has been communicated to the host.

TryGet(RemoteSystemSession) TryGet(RemoteSystemSession) TryGet(RemoteSystemSession) TryGet(RemoteSystemSession)

Establishes or retrieves an automatically-synchronized pool of spatial entities for a remote session.

public : static SpatialEntityStore TryGet(RemoteSystemSession session)public static SpatialEntityStore TryGet(RemoteSystemSession session)Public Static Function TryGet(session As RemoteSystemSession) As SpatialEntityStore// You can use this method in JavaScript.
Parameters
session
RemoteSystemSession RemoteSystemSession RemoteSystemSession RemoteSystemSession

The remote session with the participants that will share spatial entities.

Returns