Interface IMixedRealitySceneUnderstandingObserver
The interface for defining a spatial awareness observer which provides scene data.
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Experimental.SpatialAwareness
Assembly: cs.temp.dll.dll
Syntax
public interface IMixedRealitySceneUnderstandingObserver : IMixedRealityOnDemandObserver, IMixedRealitySpatialAwarenessObserverProperties
InferRegions
When enabled, generates data for observed and inferred regions in the scene. When disabled, generates data only for observed regions in the scene.
Declaration
bool InferRegions { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
InstantiationBatchRate
Number of meshes to generate per frame. Throttled to keep framerate under control.
Declaration
int InstantiationBatchRate { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
QueryRadius
The distance infer surface understanding
Declaration
float QueryRadius { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
RequestMeshData
When enabled, the service will provide surface meshes.
Declaration
bool RequestMeshData { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
RequestOcclusionMask
When enabled, the service will generate texture data for suitable for spatial queries
Declaration
bool RequestOcclusionMask { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
RequestPlaneData
When enabled, the service will provide surface planes, represented as a quad.
Declaration
bool RequestPlaneData { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
Remarks
Use PlaneValidationMask for the validation mask on the quad.
SceneObjects
The set of SpatialAwarenessSceneObjects being managed by the observer, keyed by a unique id.
Declaration
IReadOnlyDictionary<int, SpatialAwarenessSceneObject> SceneObjects { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyDictionary<Int32, SpatialAwarenessSceneObject> |
SurfaceTypes
Surface types to be observed by the observer.
Declaration
SpatialAwarenessSurfaceTypes SurfaceTypes { get; set; }Property Value
| Type | Description |
|---|---|
| SpatialAwarenessSurfaceTypes |
UsePersistentObjects
When enabled, the service will preserve previously observed surfaces when updating.
Declaration
bool UsePersistentObjects { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
WorldMeshLevelOfDetail
Configures the density of the mesh retrieved from the service
Declaration
SpatialAwarenessMeshLevelOfDetail WorldMeshLevelOfDetail { get; set; }Property Value
| Type | Description |
|---|---|
| SpatialAwarenessMeshLevelOfDetail |
Methods
SaveScene(String)
Save a scene file to the device
Declaration
void SaveScene(string filenamePrefix)Parameters
| Type | Name | Description |
|---|---|---|
| String | filenamePrefix | Prefix of the name of the saved file |
TryFindCentermostPlacement(Int32, Vector2, out Vector3)
Finds best placement position in local space to the quad
Declaration
bool TryFindCentermostPlacement(int quadId, Vector2 objExtents, out Vector3 placementPosOnQuad)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | quadId | The id of quad that will be used for placement |
| Vector2 | objExtents | Total width and height of object to be placed in meters. |
| Vector3 | placementPosOnQuad | Base position on plane in local space. |
Returns
| Type | Description |
|---|---|
| Boolean | Returns false if a centermost placement location cannot be found. |