SpatialEntity 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 physical location in the user's surroundings and its metadata, which an app intends to share with other devices.

public ref class SpatialEntity sealed

/// [Windows.Foundation.Metadata.Activatable(Windows.Perception.Spatial.ISpatialEntityFactory, 262144, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class SpatialEntity final

[Windows.Foundation.Metadata.Activatable(typeof(Windows.Perception.Spatial.ISpatialEntityFactory), 262144, "Windows.Foundation.UniversalApiContract")]
[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 SpatialEntity

function SpatialEntity(spatialAnchor, propertySet)

Public NotInheritable Class SpatialEntity

Inheritance: Object SpatialEntity

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows 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.

Constructors

SpatialEntity(SpatialAnchor, ValueSet)	Creates a new spatial entity to share the provided spatial anchor and metadata.
SpatialEntity(SpatialAnchor)	Creates a new spatial entity to share the provided spatial anchor.

Properties

Anchor	Gets the spatial anchor representing the shared location in the user's surroundings.
Id	Gets the globally-unique ID for this spatial entity.
Properties	Gets the key/value store of metadata for this spatial entity.

Applies to

Product	Versions
WinRT	Build 15063, Build 16299, Build 17134, Build 17763, Build 18362, Build 19041, Build 20348, Build 22000, Build 22621, Build 26100

Share via