Skip to content

Commit bd6dea8

Browse files
author
David Kline (ANALOG)
committed
pr feedback: split file by type
1 parent 5f8ae09 commit bd6dea8

21 files changed

+1037
-692
lines changed

‎Documentation/Architecture/IMixedRealitySpatialAwarenessBaseDescription.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# IMixedRealitySpatialAwarenessBaseDescription Interface
2+
3+
| Toolkit Layer | Namespace |
4+
| --- | --- |
5+
| Core | Microsoft.MixedReality.Toolkit.Core.Definitions.SpatialAwarenessSystem |
6+
7+
The IMixedRealitySpatialAwarenessBaseDescription interface describes the core data required for an application to understand a object in the environment.
8+
9+
<img src="Images/IMixedRealitySpatialAwarenessBaseDescription.png">
10+
11+
## Position
12+
13+
| Type |
14+
| --- |
15+
| Vector3 |
16+
17+
The position, in the environment, at which the object should be placed.
18+
19+
## See Also
20+
21+
- [Mixed Reality Spatial Awareness System Architecture](./SpatialAwarenessSystemArchitecture.md)
22+
- [MixedRealitySpatialAwarenessBaseDescription Class](./MixedRealitySpatialAwarenessBaseDescription.md)

‎Documentation/Architecture/IMixedRealitySpatialAwarenessMeshDescription.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# IMixedRealitySpatialAwarenessMeshDescription Interface
2+
3+
| Toolkit Layer | Namespace |
4+
| --- | --- |
5+
| Core | Microsoft.MixedReality.Toolkit.Core.Definitions.SpatialAwarenessSystem |
6+
7+
The IMixedRealitySpatialAwarenessMeshDescription interface describes the data required for an application to understand how to construct and place a mesh in the environment.
8+
9+
<img src="Images/IMixedRealitySpatialAwarenessMeshDescription.png">
10+
11+
## Position
12+
13+
*Inherited from [IMixedRealitySpatialAwarenessBaseDescription](./IMixedRealitySpatialAwarenessBaseDescription.md).*
14+
15+
## Mesh
16+
17+
| Type |
18+
| --- |
19+
| Mesh |
20+
21+
The mesh data.
22+
23+
## See Also
24+
25+
- [Mixed Reality Spatial Awareness System Architecture](./SpatialAwarenessSystemArchitecture.md)
26+
- [MixedRealitySpatialAwarenessMeshDescription Class](./MixedRealitySpatialAwarenessMeshDescription.md)

‎Documentation/Architecture/IMixedRealitySpatialAwarenessMeshHandler.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# IMixedRealitySpatialAwarenessMeshHandler Interface
2+
3+
| Toolkit Layer | Namespace |
4+
| --- | --- |
5+
| Core | Microsoft.MixedReality.Toolkit.Core.Interfaces.SpatialAwarenessSystem.Handlers |
6+
7+
<img src="Images/IMixedRealitySpatialAwarenessMeshHandler.png">
8+
9+
## void OnMeshAdded([MixedRealitySpatialMeshEventData](./MixedRealitySpatialMeshEventData.md) eventData)
10+
11+
Called when a new surface mesh has been identified by the spatial awareness system.
12+
13+
## void OnMeshUpdated([MixedRealitySpatialMeshEventData](./MixedRealitySpatialMeshEventData.md) eventData)
14+
15+
Called when an existing surface mesh has been modified by the spatial awareness system.
16+
17+
## OnMeshDeleted([MixedRealitySpatialMeshEventData](./MixedRealitySpatialMeshEventData.md) eventData)
18+
19+
Called when an existing surface mesh has been discarded by the spatial awareness system.
20+
21+
## See Also
22+
23+
- [Mixed Reality Spatial Awareness System Architecture](./SpatialAwarenessSystemArchitecture.md)
24+
- [MixedRealitySpatialAwarenessMeshHandler Class](./MixedRealitySpatialAwarenessMeshHandler.md)
25+
- [IMixedRealitySpatialAwarenessBaseDescription](./IMixedRealitySpatialAwarenessBaseDescription.md)

‎Documentation/Architecture/IMixedRealitySpatialAwarenessPlanarSurfaceDescription.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# IMixedRealitySpatialAwarenessPlanarSurfaceDescription Interface
2+
3+
| Toolkit Layer | Namespace |
4+
| --- | --- |
5+
| SDK - Surface Awareness Package | Microsoft.MixedReality.Toolkit.SDK.SpatialAwarenessSystem |
6+
7+
The IMixedRealitySpatialAwarenessPlanarSurfaceDescription interface describe the data required for an application to understand how to construct and place a planar surface.
8+
9+
## Position
10+
11+
*Inherited from [IMixedRealitySpatialAwarenessBaseDescription](./IMixedRealitySpatialAwarenessBaseDescription.md).*
12+
13+
## BoundingBox
14+
15+
| Type |
16+
| --- |
17+
| Bounds |
18+
19+
The axis aligned bounding box that contains the surface being described.
20+
21+
## Normal
22+
23+
| Type |
24+
| --- |
25+
| Vector3 |
26+
27+
The normal of the described surface.
28+
29+
## SurfaceType
30+
31+
| Type |
32+
| --- |
33+
| [MixedRealitySpatialAwarenessSurfaceTypes](./MixedRealitySpatialAwarenessSurfaceTypes.md)
34+
35+
The semantic (ex: Floor) associated with the surface.
36+
37+
## See Also
38+
39+
- [Mixed Reality Spatial Awareness System Architecture](./SpatialAwarenessSystemArchitecture.md)
40+
- [MixedRealitySpatialAwarenessPlanarSurfaceDescription Class](./MixedRealitySpatialAwarenessPlanarSurfaceDescription.md)

‎Documentation/Architecture/IMixedRealitySpatialAwarenessSurfaceFindingHandler.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# IMixedRealitySpatialAwarenessSurfaceFindingHandler Interface
2+
3+
| Toolkit Layer | Namespace |
4+
| --- | --- |
5+
| Core | Microsoft.MixedReality.Toolkit.Core.Interfaces.SpatialAwarenessSystem.Handlers |
6+
7+
<img src="Images/IMixedRealitySpatialAwarenessSurfaceFindingHandler.png">
8+
9+
## OnSurfaceAdded([MixedRealitySpatialSurfaceEventData](./MixedRealitySpatialSurfaceEventData.md) eventData)
10+
11+
Called when a new planar surface has been identified by the spatial awareness system.
12+
13+
## OnSurfaceUpdated([MixedRealitySpatialSurfaceEventData](./MixedRealitySpatialSurfaceEventData.md) eventData)
14+
15+
Called when an existing planar surface has been modified by the spatial awareness system.
16+
17+
## OnSurfaceDeleted([MixedRealitySpatialSurfaceEventData](./MixedRealitySpatialSurfaceEventData.md) eventDatawhat do )
18+
19+
Called when an existing planar surface has been discarded by the spatial awareness system.
20+
21+
## See Also
22+
23+
- [Mixed Reality Spatial Awareness System Architecture](./SpatialAwarenessSystemArchitecture.md)
24+
- [MixedRealitySpatialAwarenessSurfaceFindingHandler Class](./MixedRealitySpatialAwarenessSurfaceFindingHandler.md)

‎Documentation/Architecture/IMixedRealitySpatialAwarenessSystem.md‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
# IMixedRealitySpatialAwarenessSystem Interface
2+
3+
| Toolkit Layer | Namespace |
4+
| --- | --- |
5+
| Core | Microsoft.MixedReality.Toolkit.Core.Interfaces.SpatialAwarenessSystem |
6+
7+
The IMixedRealitySpatialAwarenessSystem is the interface that defines the requirements of the spatial awareness system. The interface is divided, logically into multiple sections. As new functionality is added, the appropriate settings section is to be defined.
8+
9+
<img src="Images/IMixedRealitySpatialAwarenessSystem.png">
10+
11+
## General System Controls
12+
13+
The spatial awareness system contains data and methods that configure and control the overall spatial awareness system.
14+
15+
### StartObserverSuspended
16+
17+
Gets or sets a value that indicates that the developer intends for the spatial observer to not return data until explicitly resumed. This allows the application to decide precisely when it wishes to begin receiving spatial data notifications.
18+
19+
### ObservationExtents
20+
21+
Gets or sets the size of the volume from which individual observations will be made. This is not the total size of the observable space.
22+
23+
### UpdateInterval
24+
25+
Gets or sets the frequency, in seconds, at which the spatial observer updates.
26+
27+
### IsObserverRunning
28+
29+
Indicates the current running state of the spatial observer.
30+
31+
*This is a read-only property, set by the spatial awareness system.*
32+
33+
### void ResumeObserver()
34+
35+
Starts / restarts the spatial observer. This will cause spatial observation events (ex: MeshAddedEvent) to resume being sent.
36+
37+
### void SuspendObserver()
38+
39+
Stops / pauses the spatial observer. This will cause spatial observation events to be suspended until ResumeObserver is called.
40+
41+
## Mesh Handling Controls
42+
43+
The mesh handling section contains the data and methods that configure and control the representation of data as a collection of meshes.
44+
45+
For platforms that do not natively support returning observation data as a mesh, implementations can optionally process the native data before providing it to the caller.
46+
47+
### Use Mesh System
48+
49+
Gets or sets a value that indicates if the spatial mesh subsystem is in use by the application. Turning this off will suspend all mesh events and cause the subsystem to return an empty collection when the GetMeshes method is called.
50+
51+
### MeshPhysicsLayer
52+
53+
Get or sets the desired Unity Physics Layer on which to set the spatial mesh.
54+
55+
### MeshPhysicsLayerMask
56+
57+
Gets the bit mask that corresponds to the value specified in MeshPhysicsLayer.
58+
59+
*This is a read-only property set by the spatial awareness system.*
60+
61+
### MeshLevelOfDetail
62+
63+
Gets or sets the level of detail, as a [MixedRealitySpatialAwarenessMeshLevelOfDetail](./MixedRealitySpatialAwarenessMeshLevelOfDetail.md) value, for the returned spatial mesh. Setting this value to Custom, implies that the developer is specifying a custom value for TrianglesPerCubicMeter.
64+
65+
Specifying any other value will cause TrianglesPerCubicMeter to be overwritten.
66+
67+
### TrianglesPerCubicMeter
68+
69+
Gets or sets the level of detail, in triangles per cubic meter, for the returned spatial mesh.
70+
71+
When specifying Coarse or Fine for the MeshLevelOfDetail, this value will be automatically overwritten.
72+
73+
### RecalculateNormals
74+
75+
Gets or sets the value indicating if the spatial awareness system to generate normal for the returned meshes as some platforms may not support returning normal along with the spatial mesh.
76+
77+
### RenderMeshes
78+
79+
Gets or sets a value indicating if the mesh subsystem is to automatically display surface meshes within the application. When enabled, the meshes will be added to the scene and rendered using the configured MeshMaterial.
80+
81+
Applications that wish to process the Meshes should set this value to false.
82+
83+
### MeshMaterial
84+
85+
Gets or sets the material to be used when rendering spatial meshes.
86+
87+
### [IMixedRealitySpatialAwarenessMeshDescription](./IMixedRealitySpatialAwarenessMeshDescription.md)[] GetMeshes()
88+
89+
Returns the collection of Meshes being managed by the spatial awareness mesh subsystem.
90+
91+
### GameObject[] GetMeshes()
92+
93+
Returns the collection of GameObjects being managed by the spatial awareness mesh subsystem.
94+
95+
## Surface Finding Controls
96+
97+
The surface finding section contains the data and methods that configure and control the representation of data as a collection of planar surfaces.
98+
99+
### UseSurfaceFindingSystem
100+
101+
Indicates if the surface finding subsystem is in use by the application. Turning this off will suspend all surface events.
102+
103+
### SurfacePhysicsLayer
104+
105+
Get or sets the desired Unity Physics Layer on which to set spatial surfaces.
106+
107+
### SurfacePhysicsLayerMask
108+
109+
Gets the bit mask that corresponds to the value specified in SurfacePhysicsLayer.
110+
111+
*This is a read-only property set by the spatial awareness system.*
112+
113+
### SurfaceFindingMinimumArea
114+
115+
Gets or sets the minimum surface area, in square meters, that must be satisfied before a surface is identified.
116+
117+
### RenderFloorSurfaces
118+
119+
Gets or sets a value indicating if the surface subsystem is to automatically display floor surfaces within the application. When enabled, the surfaces will be added to the scene and rendered using the configured FloorSurfaceMaterial.
120+
121+
### FloorSurfaceMaterial
122+
123+
Gets or sets the material to be used when rendering planar surface(s) identified as a floor.
124+
125+
### RenderCeilingSurfaces
126+
127+
Gets or sets a value indicating if the surface subsystem is to automatically display ceiling surfaces within the application. When enabled, the surfaces will be added to the scene and rendered using the configured CeilingSurfaceMaterial.
128+
129+
### CeilingSurfaceMaterial
130+
131+
Gets or sets the material to be used when rendering planar surface(s) identified as a ceiling.
132+
133+
### RenderWallSurfaces
134+
135+
Gets or sets a value indicating if the surface subsystem is to automatically display wall surfaces within the application. When enabled, the surfaces will be added to the scene and rendered using the configured WallSurfaceMaterial.
136+
137+
### WallSurfaceMaterial
138+
139+
Gets or sets the material to be used when rendering planar surface(s) identified as a wall.
140+
141+
### RenderPlatformSurfaces
142+
143+
Gets or sets a value indicating if the surface subsystem is to automatically display raised horizontal platform surfaces within the application. When enabled, the surfaces will be added to the scene and rendered using the configured PlatformSurfaceMaterial.
144+
145+
### PlatformSurfaceMaterial
146+
147+
Gets or sets the material to be used when rendering planar surface(s) identified as a raised horizontal platform.
148+
149+
### [IMixedRealitySpatialAwarenessPlanarSurfaceDescription](./IMixedRealitySpatialAwarenessPlanarSurfaceDescription.md)[] GetSurfaces()
150+
151+
Returns the collection of surface descriptions being tracked by the surface finding subsystem.
152+
153+
### GameObject[] GetSurfaceObjects()
154+
155+
Returns the collection of GameObjects managed by the surface finding subsystem.
156+
157+
## See Also
158+
159+
- [Mixed Reality Spatial Awareness System Architecture](./SpatialAwarenessSystemArchitecture.md)
160+
- [MixedRealitySpatialAwarenessSystem Class](./MixedRealitySpatialAwarenessSystem.md)
161+
- [IMixedRealitySpatialAwarenessMeshDescription Interface](./IMixedRealitySpatialAwarenessMeshDescription.md)
162+
- [IMixedRealitySpatialAwarenessPlanarSurfaceDescription Interface](./IMixedRealitySpatialAwarenessPlanarSurfaceDescription.md)
163+
- [MixedRealitySpatialAwarenessMeshLevelOfDetail Enumeration](./MixedRealitySpatialAwarenessMeshLevelOfDetail.md)

‎Documentation/Architecture/MixedRealitySpatialAwarenessBaseDescription.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# MixedRealitySpatialAwarenessBaseDescription Class
2+
3+
| Toolkit Layer | Namespace |
4+
| --- | --- |
5+
| SDK - Surface Awareness Package | Microsoft.MixedReality.Toolkit.SDK.SpatialAwarenessSystem |
6+
7+
The MixedRealitySpatialAwarenessBaseDescription class provides the default implementation of the [IMixedRealitySpatialAwarenessBaseDescription](./IMixedRealitySpatialAwarenessBaseDescription.md) interface.
8+
9+
## Position
10+
11+
| Type |
12+
| --- |
13+
| Vector3 |
14+
15+
The position, in the environment, at which the object should be placed.
16+
17+
## See Also
18+
19+
- [Mixed Reality Spatial Awareness System Architecture](./SpatialAwarenessSystemArchitecture.md)
20+
- [IMixedRealitySpatialAwarenessBaseDescription Class](./IMixedRealitySpatialAwarenessBaseDescription.md)

‎Documentation/Architecture/MixedRealitySpatialAwarenessBaseEventData.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# MixedRealitySpatialAwarenessBaseEventData Class
2+
3+
| Toolkit Layer | Namespace |
4+
| --- | --- |
5+
| Core | Microsoft.MixedReality.Toolkit.Core.EventDatum.SpatialAwareness |
6+
7+
The MixedRealitySpatialAwarenessBaseEventData provides the data shared by all of the spatial awareness event types.
8+
9+
<img src="Images/MixedRealitySpatialAwarenessBaseEventData.png">
10+
11+
## EventTime
12+
13+
| Type |
14+
| --- |
15+
| DateTime |
16+
17+
The time at which the event occurred.
18+
19+
## EventType
20+
21+
| Type |
22+
| --- |
23+
| [MixedRealitySpatialAwarenessEventType](./MixedRealitySpatialAwarenessEventType.md) |
24+
25+
The type of event that has occurred.
26+
27+
## Id
28+
29+
| Type |
30+
| --- |
31+
| UInt32 |
32+
33+
An identifier assigned to a specific object in the spatial awareness system.
34+
35+
## GameObject
36+
37+
| Type |
38+
| --- |
39+
| GameObject |
40+
41+
Unity GameObject, managed by the spatial awareness system, representing the data in this event.
42+
43+
## See Also
44+
45+
- [Mixed Reality Spatial Awareness System Architecture](./SpatialAwarenessSystemArchitecture.md)
46+
- [MixedRealitySpatialAwarenessEventType Enumeration](./MixedRealitySpatialAwarenessEventType.md)

0 commit comments

Comments
 (0)