SpatialEntity SpatialEntity SpatialEntity SpatialEntity Class

Definition

Represents a physical location in the user's surroundings and its metadata, which an app intends to share with other devices.

public : sealed class SpatialEntity : ISpatialEntitypublic sealed class SpatialEntity : ISpatialEntityPublic NotInheritable Class SpatialEntity Implements ISpatialEntity// 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)

Constructors

SpatialEntity(SpatialAnchor) SpatialEntity(SpatialAnchor) SpatialEntity(SpatialAnchor) SpatialEntity(SpatialAnchor)

Creates a new spatial entity to share the provided spatial anchor.

public : SpatialEntity(SpatialAnchor spatialAnchor)public SpatialEntity(SpatialAnchor spatialAnchor)Public Sub New(spatialAnchor As SpatialAnchor)// You can use this method in JavaScript.
Parameters
spatialAnchor
SpatialAnchor SpatialAnchor SpatialAnchor SpatialAnchor

The spatial anchor to share.

SpatialEntity(SpatialAnchor, ValueSet) SpatialEntity(SpatialAnchor, ValueSet) SpatialEntity(SpatialAnchor, ValueSet) SpatialEntity(SpatialAnchor, ValueSet)

Creates a new spatial entity to share the provided spatial anchor and metadata.

public : SpatialEntity(SpatialAnchor spatialAnchor, ValueSet propertySet)public SpatialEntity(SpatialAnchor spatialAnchor, ValueSet propertySet)Public Sub New(spatialAnchor As SpatialAnchor, propertySet As ValueSet)// You can use this method in JavaScript.
Parameters
spatialAnchor
SpatialAnchor SpatialAnchor SpatialAnchor SpatialAnchor

The spatial anchor to share.

propertySet
ValueSet ValueSet ValueSet ValueSet

The metadata to share for this anchor.

Properties

Anchor Anchor Anchor Anchor

Gets the spatial anchor representing the shared location in the user's surroundings.

public : SpatialAnchor Anchor { get; }public SpatialAnchor Anchor { get; }Public ReadOnly Property Anchor As SpatialAnchor// You can use this property in JavaScript.

Id Id Id Id

Gets the globally-unique ID for this spatial entity.

public : PlatForm::String Id { get; }public string Id { get; }Public ReadOnly Property Id As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The ID.

Properties Properties Properties Properties

Gets the key/value store of metadata for this spatial entity.

public : ValueSet Properties { get; }public ValueSet Properties { get; }Public ReadOnly Property Properties As ValueSet// You can use this property in JavaScript.
Value
ValueSet ValueSet ValueSet ValueSet

The metadata.