Skip to content

Commit f14c86b

Browse files
author
David Kline (ANALOG)
committed
updates to use interfaces for descriptions
1 parent c325f9f commit f14c86b

7 files changed

+62
-38
lines changed

‎Documentation/Architecture/Images/IMixedRealitySpatialAwarenessBaseDescription.png‎

13.5 KB
Loading

‎Documentation/Architecture/Images/IMixedRealitySpatialAwarenessMeshDescription.png‎

25.3 KB
Loading

‎Documentation/Architecture/Images/IMixedRealitySpatialAwarenessPlanarSurfaceDescription.png‎

29.3 KB
Loading

‎Documentation/Architecture/Images/MixedRealitySpatialAwarenessBaseDescription.png‎

-7.92 KB
Binary file not shown.

‎Documentation/Architecture/Images/MixedRealitySpatialAwarenessMeshDescription.png‎

-10.1 KB
Binary file not shown.

‎Documentation/Architecture/Images/MixedRealitySpatialAwarenessPlanarSurfaceDescription.png‎

-11.8 KB
Binary file not shown.

‎Documentation/Architecture/SpatialAwarenessSystemArchitecture.md‎

Lines changed: 62 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -234,41 +234,15 @@ Called when an existing planar surface has been modified by the spatial awarenes
234234

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

237-
# Classes
238-
239-
## MixedRealitySpatialAwarenessSystem
240-
241-
| Toolkit Layer | Namespace |
242-
| --- | --- |
243-
| SDK - Surface Awareness Package | Microsoft.MixedReality.Toolkit.SDK.SpatialAwarenessSystem |
244-
245-
The MixedRealitySpatialAwarenessSystem class provides the default implementation of the spatial awareness system. Implements the [IMixedRealitySpatialAwarenessSystem](#imixedrealityspatialawarenesssystem) interface.
246-
247-
## MixedRealitySpatialAwarenessMeshHandler
248-
249-
| Toolkit Layer | Namespace |
250-
| --- | --- |
251-
| SDK - Surface Awareness Package | Microsoft.MixedReality.Toolkit.SDK.SpatialAwarenessSystem |
252-
253-
The MixedRealitySpatialAwarenessMeshHandler provides the default implementation of the spatial awareness system. Implements the default implementation of the [IMixedRealitySpatialAwarenessMeshHandler](#imixedrealityspatialawarenessmeshhandler) interface.
254-
255-
## MixedRealitySpatialAwarenessSurfaceFindingHandler
256-
257-
| Toolkit Layer | Namespace |
258-
| --- | --- |
259-
| SDK - Surface Awareness Package | Microsoft.MixedReality.Toolkit.SDK.SpatialAwarenessSystem |
260-
261-
The MixedRealitySpatialAwarenessSurfaceFindingHandler class provides the default implementation of the [IMixedRealitySpatialAwarenessSurfaceFindingHandler](#imixedrealityspatialawarenesssurfacefindinghandler) interface.
262-
263-
## MixedRealitySpatialAwarenessBaseDescription
237+
## IMixedRealitySpatialAwarenessBaseDescription
264238

265239
| Toolkit Layer | Namespace |
266240
| --- | --- |
267241
| Core | Microsoft.MixedReality.Toolkit.Core.Definitions.SpatialAwarenessSystem |
268242

269-
The MixedRealitySpatialAwarenessBaseDescription class describes the core data required for an application to understand a object in the environment.
243+
The IMixedRealitySpatialAwarenessBaseDescription interface describes the core data required for an application to understand a object in the environment.
270244

271-
<img src="Images/MixedRealitySpatialAwarenessBaseDescription.png">
245+
<img src="Images/IMixedRealitySpatialAwarenessBaseDescription.png">
272246

273247
### Position
274248

@@ -278,19 +252,19 @@ The MixedRealitySpatialAwarenessBaseDescription class describes the core data re
278252

279253
The position, in the environment, at which the object should be placed.
280254

281-
## MixedRealitySpatialAwarenessMeshDescription
255+
## IMixedRealitySpatialAwarenessMeshDescription
282256

283257
| Toolkit Layer | Namespace |
284258
| --- | --- |
285259
| Core | Microsoft.MixedReality.Toolkit.Core.Definitions.SpatialAwarenessSystem |
286260

287-
The MixedRealitySpatialAwarenessMeshDescription class describes the data required for an application to understand how to construct and place a mesh in the environment.
261+
The IMixedRealitySpatialAwarenessMeshDescription interface describes the data required for an application to understand how to construct and place a mesh in the environment.
288262

289-
<img src="Images/MixedRealitySpatialAwarenessMeshDescription.png">]
263+
<img src="Images/IMixedRealitySpatialAwarenessMeshDescription.png">
290264

291265
### Position
292266

293-
*Inherited from [MixedRealitySpatialAwarenessBaseDescription](#mixedrealityspatialawarenessbasedescription).*
267+
*Inherited from [IMixedRealitySpatialAwarenessBaseDescription](#imixedrealityspatialawarenessbasedescription).*
294268

295269
### Mesh
296270

@@ -300,19 +274,19 @@ The MixedRealitySpatialAwarenessMeshDescription class describes the data require
300274

301275
The mesh data.
302276

303-
## MixedRealitySpatialAwarenessPlanarSurfaceDescription
277+
## IMixedRealitySpatialAwarenessPlanarSurfaceDescription
304278

305279
| Toolkit Layer | Namespace |
306280
| --- | --- |
307281
| Core | Microsoft.MixedReality.Toolkit.Core.Definitions.SpatialAwarenessSystem |
308282

309-
The MixedRealitySpatialAwarenessPlanarSurfaceDescription describes the data required for an application to understand how to construct and place a planar surface.
283+
The IMixedRealitySpatialAwarenessPlanarSurfaceDescription interface describes the data required for an application to understand how to construct and place a planar surface.
310284

311-
<img src="Images/MixedRealitySpatialAwarenessPlanarSurfaceDescription.png">
285+
<img src="Images/IMixedRealitySpatialAwarenessPlanarSurfaceDescription.png">
312286

313287
### Position
314288

315-
*Inherited from [MixedRealitySpatialAwarenessBaseDescription](#mixedrealityspatialawarenessbasedescription).*
289+
*Inherited from [IMixedRealitySpatialAwarenessBaseDescription](#imixedrealityspatialawarenessbasedescription).*
316290

317291
### BoundingBox
318292

@@ -334,10 +308,60 @@ The normal of the described surface.
334308

335309
| Type |
336310
| --- |
337-
| [MixedRealitySpatialAwarenessSurfaceTypes]{#mixedrealityspatialawarenesssurfacetypes} |
311+
| [MixedRealitySpatialAwarenessSurfaceTypes](#mixedrealityspatialawarenesssurfacetypes) |
338312

339313
The semantic (ex: Floor) associated with the surface.
340314

315+
# Classes
316+
317+
## MixedRealitySpatialAwarenessSystem
318+
319+
| Toolkit Layer | Namespace |
320+
| --- | --- |
321+
| SDK - Surface Awareness Package | Microsoft.MixedReality.Toolkit.SDK.SpatialAwarenessSystem |
322+
323+
The MixedRealitySpatialAwarenessSystem class provides the default implementation of the spatial awareness system. Implements the [IMixedRealitySpatialAwarenessSystem](#imixedrealityspatialawarenesssystem) interface.
324+
325+
## MixedRealitySpatialAwarenessMeshHandler
326+
327+
| Toolkit Layer | Namespace |
328+
| --- | --- |
329+
| SDK - Surface Awareness Package | Microsoft.MixedReality.Toolkit.SDK.SpatialAwarenessSystem |
330+
331+
The MixedRealitySpatialAwarenessMeshHandler class provides the default implementation of the [IMixedRealitySpatialAwarenessMeshHandler](#imixedrealityspatialawarenessmeshhandler) interface.
332+
333+
## MixedRealitySpatialAwarenessSurfaceFindingHandler
334+
335+
| Toolkit Layer | Namespace |
336+
| --- | --- |
337+
| SDK - Surface Awareness Package | Microsoft.MixedReality.Toolkit.SDK.SpatialAwarenessSystem |
338+
339+
The MixedRealitySpatialAwarenessSurfaceFindingHandler class provides the default implementation of the [IMixedRealitySpatialAwarenessSurfaceFindingHandler](#imixedrealityspatialawarenesssurfacefindinghandler) interface.
340+
341+
## MixedRealitySpatialAwarenessBaseDescription
342+
343+
| Toolkit Layer | Namespace |
344+
| --- | --- |
345+
| SDK - Surface Awareness Package | Microsoft.MixedReality.Toolkit.SDK.SpatialAwarenessSystem |
346+
347+
The MixedRealitySpatialAwarenessBaseDescription class provides the default implementation of the [IMixedRealitySpatialAwarenessBaseDescription](#imixedrealityspatialawarenessbasedescription) interface.
348+
349+
## MixedRealitySpatialAwarenessMeshDescription
350+
351+
| Toolkit Layer | Namespace |
352+
| --- | --- |
353+
| SDK - Surface Awareness Package | Microsoft.MixedReality.Toolkit.SDK.SpatialAwarenessSystem |
354+
355+
The MixedRealitySpatialAwarenessMeshDescription class provides the default implementation of the [MixedRealitySpatialAwarenessMeshDescription](#imixedrealityspatialawarenessmeshdescription) interface.
356+
357+
## MixedRealitySpatialAwarenessPlanarSurfaceDescription
358+
359+
| Toolkit Layer | Namespace |
360+
| --- | --- |
361+
| SDK - Surface Awareness Package | Microsoft.MixedReality.Toolkit.SDK.SpatialAwarenessSystem |
362+
363+
The MixedRealitySpatialAwarenessPlanarSurfaceDescription class provides the default implementation of the [MixedRealitySpatialAwarenessPlanarSurfaceDescription](#imixedrealityspatialawarenessplanarsurfacedescription) interface.
364+
341365
# System Profile Management Classes and Types
342366

343367
## MixedRealitySpatialAwarenessProfile

0 commit comments

Comments
 (0)