AR Design
UBC EML collab with UBC SALA - visualizing IoT data in AR
HoloToolkit.Unity.SpatialUnderstandingCustomMesh Class Reference

Handles the custom meshes generated by the understanding DLL. The meshes are generated during the scanning phase and once more on scan finalization. The meshes can be used to visualize the scanning progress. More...

Inheritance diagram for HoloToolkit.Unity.SpatialUnderstandingCustomMesh:
HoloToolkit.Unity.SpatialMapping.SpatialMappingSource

Public Member Functions

IEnumerator Import_UnderstandingMesh ()
 Imports the custom mesh from the DLL. This a a coroutine which will take multiple frames to complete. More...
 
- Public Member Functions inherited from HoloToolkit.Unity.SpatialMapping.SpatialMappingSource
 SpatialMappingSource ()
 
virtual List< MeshFilter > GetMeshFilters ()
 Gets all mesh filters that have a valid mesh. More...
 
virtual List< MeshRenderer > GetMeshRenderers ()
 Gets all mesh renderers that have been created. More...
 
void SaveSpatialMeshes (string fileName)
 Saves all the currently created spatial source meshes in world space. More...
 

Public Attributes

float ImportMeshPeriod = 1.0f
 
float MaxFrameTime = 5.0f
 Used to keep our processing from exceeding our frame budget. More...
 
bool CreateMeshColliders = true
 Whether to create mesh colliders. If unchecked, mesh colliders will be empty and disabled. More...
 

Properties

Material MeshMaterial [get, set]
 
bool DrawProcessedMesh [get, set]
 Controls rendering of the mesh. This can be set by the user to hide or show the mesh. More...
 
bool HasMeshSectors [get]
 Have any mesh sectors been scanned More...
 
bool IsImportActive [get]
 Indicates if the previous import is still being processed. More...
 
override Material RenderMaterial [get]
 The material to use if rendering. More...
 
- Properties inherited from HoloToolkit.Unity.SpatialMapping.SpatialMappingSource
ReadOnlyCollection< SurfaceObjectSurfaceObjects [get]
 Collection of surface objects that have been created for this spatial mapping source. More...
 
virtual Material RenderMaterial [get]
 Material to use for rendering the mesh More...
 

Additional Inherited Members

- Protected Member Functions inherited from HoloToolkit.Unity.SpatialMapping.SpatialMappingSource
virtual void Awake ()
 
SurfaceObject CreateSurfaceObject (Mesh mesh, string objectName, Transform parentObject, int meshID=0, bool? drawVisualMeshesOverride=null, bool? castShadowsOverride=null)
 Create a new surface object. More...
 
void AddSurfaceObject (SurfaceObject toAdd)
 Add the surface to SurfaceObjects. More...
 
SurfaceObject UpdateOrAddSurfaceObject (SurfaceObject toUpdateOrAdd, bool destroyGameObjectIfReplaced=true, bool destroyMeshesIfReplaced=true)
 Update the first surface with a matching ID if one exists in SurfaceObjects, otherwise add the surface as new. More...
 
SurfaceObject RemoveSurfaceIfFound (int surfaceID, bool destroyGameObject=true, bool destroyMeshes=true)
 Remove the first surface with the specified ID if one exists in SurfaceObjects. More...
 
void CleanUpSurface (SurfaceObject surface, bool destroyGameObject=true, bool destroyMeshes=true, GameObject objectToPreserve=null, Mesh meshToPreserveA=null, Mesh meshToPreserveB=null)
 Clean up the resources associated with the surface. More...
 
void Cleanup (bool destroyGameObjects=true, bool destroyMeshes=true)
 Cleans up references to objects that we have created. More...
 
- Protected Attributes inherited from HoloToolkit.Unity.SpatialMapping.SpatialMappingSource
readonly Type [] componentsRequiredForSurfaceMesh
 When a mesh is created we will need to create a game object with a minimum set of components to contain the mesh. These are the required component types. More...
 
- Events inherited from HoloToolkit.Unity.SpatialMapping.SpatialMappingSource
EventHandler< DataEventArgs< SurfaceObject > > SurfaceAdded
 
EventHandler< DataEventArgs< SurfaceUpdate > > SurfaceUpdated
 
EventHandler< DataEventArgs< SurfaceObject > > SurfaceRemoved
 
EventHandler< EventArgs > RemovingAllSurfaces
 

Detailed Description

Handles the custom meshes generated by the understanding DLL. The meshes are generated during the scanning phase and once more on scan finalization. The meshes can be used to visualize the scanning progress.

Definition at line 25 of file SpatialUnderstandingCustomMesh.cs.

Member Function Documentation

§ Import_UnderstandingMesh()

IEnumerator HoloToolkit.Unity.SpatialUnderstandingCustomMesh.Import_UnderstandingMesh ( )

Imports the custom mesh from the DLL. This a a coroutine which will take multiple frames to complete.

Returns

Definition at line 275 of file SpatialUnderstandingCustomMesh.cs.

Member Data Documentation

§ CreateMeshColliders

bool HoloToolkit.Unity.SpatialUnderstandingCustomMesh.CreateMeshColliders = true

Whether to create mesh colliders. If unchecked, mesh colliders will be empty and disabled.

Definition at line 68 of file SpatialUnderstandingCustomMesh.cs.

§ ImportMeshPeriod

float HoloToolkit.Unity.SpatialUnderstandingCustomMesh.ImportMeshPeriod = 1.0f

Definition at line 29 of file SpatialUnderstandingCustomMesh.cs.

§ MaxFrameTime

float HoloToolkit.Unity.SpatialUnderstandingCustomMesh.MaxFrameTime = 5.0f

Used to keep our processing from exceeding our frame budget.

Definition at line 59 of file SpatialUnderstandingCustomMesh.cs.

Property Documentation

§ DrawProcessedMesh

bool HoloToolkit.Unity.SpatialUnderstandingCustomMesh.DrawProcessedMesh
getset

Controls rendering of the mesh. This can be set by the user to hide or show the mesh.

Definition at line 77 of file SpatialUnderstandingCustomMesh.cs.

§ HasMeshSectors

bool HoloToolkit.Unity.SpatialUnderstandingCustomMesh.HasMeshSectors
get

Have any mesh sectors been scanned

Definition at line 95 of file SpatialUnderstandingCustomMesh.cs.

§ IsImportActive

bool HoloToolkit.Unity.SpatialUnderstandingCustomMesh.IsImportActive
get

Indicates if the previous import is still being processed.

Definition at line 100 of file SpatialUnderstandingCustomMesh.cs.

§ MeshMaterial

Material HoloToolkit.Unity.SpatialUnderstandingCustomMesh.MeshMaterial
getset

Definition at line 36 of file SpatialUnderstandingCustomMesh.cs.

§ RenderMaterial

override Material HoloToolkit.Unity.SpatialUnderstandingCustomMesh.RenderMaterial
getprotected

The material to use if rendering.

Definition at line 105 of file SpatialUnderstandingCustomMesh.cs.


The documentation for this class was generated from the following file: