Skip to content

Commit 5f8ae09

Browse files
author
David Kline (ANALOG)
committed
in person feedback, update images
1 parent 795b615 commit 5f8ae09

File tree

4 files changed

+5
-29
lines changed

4 files changed

+5
-29
lines changed
20.4 KB
Loading
-4.18 KB
Loading
-6.32 KB
Loading

Documentation/Architecture/SpatialAwarenessSystemArchitecture.md

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -100,18 +100,6 @@ Applications that wish to process the Meshes should set this value to false.
100100

101101
Gets or sets the material to be used when rendering spatial meshes.
102102

103-
#### void RaiseMeshAdded(uint meshId, Vector3 position, Mesh meshData, GameObject meshObject)
104-
105-
The spatial awareness system will call the IMixedRealitySpatialAwarenessMeshHandler.OnMeshAdded method to indicate a new mesh has been added.
106-
107-
#### void RaiseMeshUpdated(uint meshId, Vector3 position, Mesh meshData, GameObject meshObject)
108-
109-
The spatial awareness system will call the IMixedRealitySpatialAwarenessMeshHandler.OnMeshUpdated method to indicate an existing mesh has changed.
110-
111-
#### void RaiseMeshRemoved(uint meshId)
112-
113-
The spatial awareness system will call the IMixedRealitySpatialAwarenessMeshHandler.OnMeshRemoved method to indicate an existing mesh has been removed.
114-
115103
#### [MixedRealitySpatialAwarenessMeshDescription](#mixedrealityspatialawarenessmeshdescription)[] GetMeshes()
116104

117105
Returns the collection of Meshes being managed by the spatial awareness mesh subsystem.
@@ -174,18 +162,6 @@ Gets or sets a value indicating if the surface subsystem is to automatically dis
174162

175163
Gets or sets the material to be used when rendering planar surface(s) identified as a raised horizontal platform.
176164

177-
#### void RaiseSurfaceAdded(uint surfaceId, Vector3 position, Bounds surfaceData, Vector3 normal, GameObject surfaceObject)
178-
179-
The spatial awareness system will call the IMixedRealitySpatialAwarenessSurfaceFindingHandler.OnSurfaceAdded method to indicate a new planar surface has been added.
180-
181-
#### void RaiseSurfaceUpdated(uint surfaceId, Vector3 position, Bounds surfaceData, Vector3 normal, GameObject surfaceObject)
182-
183-
The spatial awareness system will call the IMixedRealitySpatialAwarenessSurfaceFindingHandler.OnSurfaceUpdated method to indicate an existing planar surface has changed.
184-
185-
#### void RaiseSurfaceRemoved(uint surfaceId)
186-
187-
The spatial awareness system will call the IMixedRealitySpatialAwarenessSurfaceFindingHandler.OnSurfaceRemoved method to indicate an existing planar surface has been removed.
188-
189165
#### [MixedRealitySpatialAwarenessPlanarSurfaceDescription](#mixedrealityspatialawarenessplanarsurfacedescription)[] GetSurfaces()
190166

191167
Returns the collection of surface descriptions being tracked by the surface finding subsystem.
@@ -559,7 +535,7 @@ public enum MixedRealitySpatialAwarenessSurfaceTypes
559535
/// A raised, horizontal surface such as a shelf.
560536
/// </summary>
561537
/// <remarks>
562-
Platforms, like floors, that can be used for placing objects
538+
/// Platforms, like floors, can be used for placing objects
563539
/// requiring a horizontal surface.
564540
/// </remarks>
565541
Platform
@@ -581,7 +557,7 @@ public enum MixedRealitySpatialAwarenessMeshLevelOfDetail
581557
/// </summary>
582558
Custom = -1,
583559

584-
/// <summary>
560+
/// <summary>
585561
/// The coarse level of detail is well suited for identifying large
586562
/// environmental features, such as floors and walls.
587563
/// </summary>
@@ -667,15 +643,15 @@ The MixedRealitySpatialAwarenessMeshEventData derives from [MixedRealitySpatialA
667643

668644
*Inherited from [MixedRealitySpatialAwarenessBaseEventData](#mixedrealityspatialawarenessbaseeventdata).*
669645

670-
### Description
646+
### MeshDescription
671647

672648
| Type |
673649
| --- |
674650
| [MixedRealitySpatialAwarenessMeshDescription](#mixedrealityspatialawarenessmeshdescription) |
675651

676652
For MeshAdded and MeshUpdated events, this will contain the mesh description. For MeshRemoved, the value will be null.
677653

678-
## MixedRealitySpatialSurfaceEventData
654+
## MixedRealitySpatialAwarenessSurfaceEventData
679655

680656
| Toolkit Layer | Namespace |
681657
| --- | --- |
@@ -701,7 +677,7 @@ The MixedRealitySpatialSurfaceEventData derives from [MixedRealitySpatialAwarene
701677

702678
*Inherited from [MixedRealitySpatialAwarenessBaseEventData](#mixedrealityspatialawarenessbaseeventdata).*
703679

704-
### Description
680+
### SurfaceDescription
705681

706682
| Type |
707683
| --- |

0 commit comments

Comments
 (0)