Skip to content

Commit 795b615

Browse files
author
David Kline (ANALOG)
committed
updates and fixes
1 parent f14c86b commit 795b615

6 files changed

+18
-50
lines changed
10.5 KB
Loading
9.84 KB
Loading
-989 Bytes
Loading
20.9 KB
Loading
21.6 KB
Loading

Documentation/Architecture/SpatialAwarenessSystemArchitecture.md

Lines changed: 18 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,11 @@ The spatial awareness system will call the IMixedRealitySpatialAwarenessMeshHand
106106

107107
#### void RaiseMeshUpdated(uint meshId, Vector3 position, Mesh meshData, GameObject meshObject)
108108

109-
The spatial awareness system will call the IMixedRealitySpatialAwarenessMeshHandler.OnMeshAdded method to indicate an existing mesh has changed.
109+
The spatial awareness system will call the IMixedRealitySpatialAwarenessMeshHandler.OnMeshUpdated method to indicate an existing mesh has changed.
110110

111-
#### void RaiseMeshDeleted(uint meshId)
111+
#### void RaiseMeshRemoved(uint meshId)
112112

113-
The spatial awareness system will call the IMixedRealitySpatialAwarenessMeshHandler.OnMeshAdded method to indicate an existing mesh has been removed.
113+
The spatial awareness system will call the IMixedRealitySpatialAwarenessMeshHandler.OnMeshRemoved method to indicate an existing mesh has been removed.
114114

115115
#### [MixedRealitySpatialAwarenessMeshDescription](#mixedrealityspatialawarenessmeshdescription)[] GetMeshes()
116116

@@ -180,11 +180,11 @@ The spatial awareness system will call the IMixedRealitySpatialAwarenessSurfaceF
180180

181181
#### void RaiseSurfaceUpdated(uint surfaceId, Vector3 position, Bounds surfaceData, Vector3 normal, GameObject surfaceObject)
182182

183-
The spatial awareness system will call the IMixedRealitySpatialAwarenessSurfaceFindingHandler.OnSurfacefsUpdated method to indicate an existing planar surface has changed.
183+
The spatial awareness system will call the IMixedRealitySpatialAwarenessSurfaceFindingHandler.OnSurfaceUpdated method to indicate an existing planar surface has changed.
184184

185-
#### void RaiseSurfaceDeleted(uint surfaceId)
185+
#### void RaiseSurfaceRemoved(uint surfaceId)
186186

187-
The spatial awareness system will call the IMixedRealitySpatialAwarenessSurfaceFindingHandler.OnSurfaceDeleted method to indicate an existing planar surface has been removed.
187+
The spatial awareness system will call the IMixedRealitySpatialAwarenessSurfaceFindingHandler.OnSurfaceRemoved method to indicate an existing planar surface has been removed.
188188

189189
#### [MixedRealitySpatialAwarenessPlanarSurfaceDescription](#mixedrealityspatialawarenessplanarsurfacedescription)[] GetSurfaces()
190190

@@ -202,15 +202,15 @@ Returns the collection of GameObjects managed by the surface finding subsystem.
202202

203203
<img src="Images/IMixedRealitySpatialAwarenessMeshHandler.png">
204204

205-
### void OnMeshAdded([MixedRealitySpatialMeshEventData](#mixedrealityspatialmesheventdata) eventData)
205+
### void OnMeshAdded([MixedRealitySpatialMeshEventData](#mixedrealityspatialawarenessmesheventdata) eventData)
206206

207207
Called when a new surface mesh has been identified by the spatial awareness system.
208208

209-
### void OnMeshUpdated([MixedRealitySpatialMeshEventData](#mixedrealityspatialmesheventdata) eventData)
209+
### void OnMeshUpdated([MixedRealitySpatialMeshEventData](#mixedrealityspatialawarenessmesheventdata) eventData)
210210

211211
Called when an existing surface mesh has been modified by the spatial awareness system.
212212

213-
### OnMeshDeleted([MixedRealitySpatialMeshEventData](#mixedrealityspatialmesheventdata) eventData)
213+
### OnMeshDeleted([MixedRealitySpatialMeshEventData](#mixedrealityspatialawarenessmesheventdata) eventData)
214214

215215
Called when an existing surface mesh has been discarded by the spatial awareness system.
216216

@@ -222,15 +222,15 @@ Called when an existing surface mesh has been discarded by the spatial awareness
222222

223223
<img src="Images/IMixedRealitySpatialAwarenessSurfaceFindingHandler.png">
224224

225-
### OnSurfaceAdded([MixedRealitySpatialSurfaceEventData](#mixedrealityspatialsurfaceeventdata))
225+
### OnSurfaceAdded([MixedRealitySpatialSurfaceEventData](#mixedrealityspatialawarenesssurfaceeventdata))
226226

227227
Called when a new planar surface has been identified by the spatial awareness system.
228228

229-
### OnSurfaceUpdated([MixedRealitySpatialSurfaceEventData](#mixedrealityspatialsurfaceeventdata))
229+
### OnSurfaceUpdated([MixedRealitySpatialSurfaceEventData](#mixedrealityspatialawarenesssurfaceeventdata))
230230

231231
Called when an existing planar surface has been modified by the spatial awareness system.
232232

233-
### OnSurfaceDeleted([MixedRealitySpatialSurfaceEventData](#mixedrealityspatialsurfaceeventdata))
233+
### OnSurfaceDeleted([MixedRealitySpatialSurfaceEventData](#mixedrealityspatialawarenesssurfaceeventdata))
234234

235235
Called when an existing planar surface has been discarded by the spatial awareness system.
236236

@@ -631,14 +631,6 @@ The type of event that has occurred.
631631

632632
An identifier assigned to a specific object in the spatial awareness system.
633633

634-
### Position
635-
636-
| Type |
637-
| --- |
638-
| Vector3 |
639-
640-
The position, in the environment, at which the data should be placed.
641-
642634
### GameObject
643635

644636
| Type |
@@ -671,21 +663,17 @@ The MixedRealitySpatialAwarenessMeshEventData derives from [MixedRealitySpatialA
671663

672664
*Inherited from [MixedRealitySpatialAwarenessBaseEventData](#mixedrealityspatialawarenessbaseeventdata).*
673665

674-
### Position
675-
676-
*Inherited from [MixedRealitySpatialAwarenessBaseEventData](#mixedrealityspatialawarenessbaseeventdata).*
677-
678666
### GameObject
679667

680668
*Inherited from [MixedRealitySpatialAwarenessBaseEventData](#mixedrealityspatialawarenessbaseeventdata).*
681669

682-
### MeshData
670+
### Description
683671

684672
| Type |
685673
| --- |
686-
| Mesh |
674+
| [MixedRealitySpatialAwarenessMeshDescription](#mixedrealityspatialawarenessmeshdescription) |
687675

688-
For MeshAdded and MeshUpdated events, this will contain the mesh data. For MeshDeleted, the value will be null.
676+
For MeshAdded and MeshUpdated events, this will contain the mesh description. For MeshRemoved, the value will be null.
689677

690678
## MixedRealitySpatialSurfaceEventData
691679

@@ -709,37 +697,17 @@ The MixedRealitySpatialSurfaceEventData derives from [MixedRealitySpatialAwarene
709697

710698
*Inherited from [MixedRealitySpatialAwarenessBaseEventData](#mixedrealityspatialawarenessbaseeventdata).*
711699

712-
### Position
713-
714-
*Inherited from [MixedRealitySpatialAwarenessBaseEventData](#mixedrealityspatialawarenessbaseeventdata).*
715-
716700
### GameObject
717701

718702
*Inherited from [MixedRealitySpatialAwarenessBaseEventData](#mixedrealityspatialawarenessbaseeventdata).*
719703

720-
### BoundingBox
704+
### Description
721705

722706
| Type |
723707
| --- |
724-
| Bounds |
725-
726-
For SurfaceAdded and SurfaceUpdated events, this will contain the axis aligned bounding box for the surface. For SurfaceDeleted, the value will be null.
727-
728-
### Normal
729-
730-
| Type |
731-
| --- |
732-
| Vector3 |
708+
| [MixedRealitySpatialAwarenessPlanarSurfaceDescription](#mixedrealityspatialawarenessplanarsurfacedescription) |
733709

734-
The surface normal.
735-
736-
### SurfaceType
737-
738-
| Type |
739-
| --- |
740-
| [MixedRealitySpatialAwarenessSurfaceTypes](#mixedrealityspatialawarenesssurfacetypes) |
741-
742-
The semantic (ex: Floor) associated with the surface.
710+
For SurfaceAdded and SurfaceUpdated events, this will contain the description of the planar surface. For SurfaceRemoved, the value will be null.
743711

744712
## MixedRealitySpatialAwarenessEventType
745713

0 commit comments

Comments
 (0)