Show / Hide Table of Contents

    Interface IMixedRealitySpatialAwarenessMeshObserver

    The interface for defining an IMixedRealitySpatialAwarenessObserver which provides mesh data.

    Inherited Members
    IMixedRealitySpatialAwarenessObserver.StartupBehavior
    IMixedRealitySpatialAwarenessObserver.DefaultPhysicsLayer
    IMixedRealitySpatialAwarenessObserver.IsRunning
    IMixedRealitySpatialAwarenessObserver.IsStationaryObserver
    IMixedRealitySpatialAwarenessObserver.ObserverVolumeType
    IMixedRealitySpatialAwarenessObserver.ObservationExtents
    IMixedRealitySpatialAwarenessObserver.ObserverRotation
    IMixedRealitySpatialAwarenessObserver.ObserverOrigin
    IMixedRealitySpatialAwarenessObserver.UpdateInterval
    IMixedRealitySpatialAwarenessObserver.Resume()
    IMixedRealitySpatialAwarenessObserver.Suspend()
    IMixedRealitySpatialAwarenessObserver.ClearObservations()
    IMixedRealityService.Name
    IMixedRealityService.Priority
    IMixedRealityService.ConfigurationProfile
    IMixedRealityService.Initialize()
    IMixedRealityService.Reset()
    IMixedRealityService.Enable()
    IMixedRealityService.Update()
    IMixedRealityService.LateUpdate()
    IMixedRealityService.Disable()
    IMixedRealityService.Destroy()
    IDisposable.Dispose()
    IMixedRealityEventSource.SourceId
    IMixedRealityEventSource.SourceName
    Namespace: Microsoft.MixedReality.Toolkit.SpatialAwareness
    Assembly: cs.temp.dll.dll
    Syntax
    public interface IMixedRealitySpatialAwarenessMeshObserver : IMixedRealitySpatialAwarenessObserver, IMixedRealityDataProvider, IMixedRealityService, IDisposable, IMixedRealityEventSource, IEqualityComparer

    Properties

    DisplayOption

    Gets or sets a value indicating how the mesh subsystem is to display surface meshes within the application.

    Declaration
    SpatialAwarenessMeshDisplayOptions DisplayOption { get; set; }
    Property Value
    Type Description
    SpatialAwarenessMeshDisplayOptions
    Remarks

    Applications that wish to process the Meshes should set this value to None.

    LevelOfDetail

    Gets or sets the level of detail, as a MixedRealitySpatialAwarenessMeshLevelOfDetail value, for the returned spatial mesh. Setting this value to Custom, implies that the developer is specifying a custom value for MeshTrianglesPerCubicMeter.

    Declaration
    SpatialAwarenessMeshLevelOfDetail LevelOfDetail { get; set; }
    Property Value
    Type Description
    SpatialAwarenessMeshLevelOfDetail
    Remarks

    Specifying any other value will cause TrianglesPerCubicMeter to be overwritten.

    Meshes

    Gets the collection of SpatialAwarenessMeshObjects being managed by the observer.

    Declaration
    IReadOnlyDictionary<int, SpatialAwarenessMeshObject> Meshes { get; }
    Property Value
    Type Description
    IReadOnlyDictionary<Int32, SpatialAwarenessMeshObject>

    MeshPhysicsLayer

    Get or sets the desired Unity Physics Layer on which to set the spatial mesh.

    Declaration
    int MeshPhysicsLayer { get; set; }
    Property Value
    Type Description
    Int32
    Remarks

    If not explicitly set, it is recommended that implementations return DefaultPhysicsLayer.

    MeshPhysicsLayerMask

    Gets the bit mask that corresponds to the value specified in MeshPhysicsLayer.

    Declaration
    int MeshPhysicsLayerMask { get; }
    Property Value
    Type Description
    Int32

    OcclusionMaterial

    Gets or sets the Material to be used when spatial Meshes should occlude other objects.

    Declaration
    Material OcclusionMaterial { get; set; }
    Property Value
    Type Description
    Material

    RecalculateNormals

    Indicates whether or not mesh normals should be recalculated by the observer.

    Declaration
    bool RecalculateNormals { get; set; }
    Property Value
    Type Description
    Boolean

    TrianglesPerCubicMeter

    Gets or sets the level of detail, in triangles per cubic meter, for the returned spatial mesh.

    Declaration
    int TrianglesPerCubicMeter { get; set; }
    Property Value
    Type Description
    Int32
    Remarks

    When specifying a LevelOfDetail other than Custom, this value will be automatically overwritten with system default values.

    VisibleMaterial

    Gets or sets the Material to be used when displaying Meshes.

    Declaration
    Material VisibleMaterial { get; set; }
    Property Value
    Type Description
    Material
    Back to top Generated by DocFX