We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

    Show / Hide Table of Contents

    Class SpatialObjectMeshObserver

    Spatial awareness mesh observer that provides mesh data from a 3D model imported as a Unity asset.

    Inheritance
    Object
    SpatialObjectMeshObserver
    Implements
    IMixedRealitySpatialAwarenessMeshObserver
    IMixedRealityCapabilityCheck
    Namespace: Microsoft.MixedReality.Toolkit.SpatialObjectMeshObserver
    Assembly: cs.temp.dll.dll
    Syntax
    public class SpatialObjectMeshObserver : BaseSpatialObserver, IMixedRealitySpatialAwarenessMeshObserver, IMixedRealityCapabilityCheck

    Constructors

    SpatialObjectMeshObserver(IMixedRealitySpatialAwarenessSystem, String, UInt32, BaseMixedRealityProfile)

    Constructor.

    Declaration
    public SpatialObjectMeshObserver(IMixedRealitySpatialAwarenessSystem spatialAwarenessSystem, string name = null, uint priority = default(uint), BaseMixedRealityProfile profile = null)
    Parameters
    Type Name Description
    IMixedRealitySpatialAwarenessSystem spatialAwarenessSystem
    String name

    Friendly name of the service.

    UInt32 priority

    Service priority. Used to determine order of instantiation.

    BaseMixedRealityProfile profile

    The service's configuration profile.

    SpatialObjectMeshObserver(IMixedRealityServiceRegistrar, IMixedRealitySpatialAwarenessSystem, String, UInt32, BaseMixedRealityProfile)

    Constructor.

    Declaration
    [Obsolete("This constructor is obsolete (registrar parameter is no longer required) and will be removed in a future version of the Microsoft Mixed Reality Toolkit.")]
    public SpatialObjectMeshObserver(IMixedRealityServiceRegistrar registrar, IMixedRealitySpatialAwarenessSystem spatialAwarenessSystem, string name = null, uint priority = default(uint), BaseMixedRealityProfile profile = null)
    Parameters
    Type Name Description
    IMixedRealityServiceRegistrar registrar

    The IMixedRealityServiceRegistrar instance that loaded the service.

    IMixedRealitySpatialAwarenessSystem spatialAwarenessSystem
    String name

    Friendly name of the service.

    UInt32 priority

    Service priority. Used to determine order of instantiation.

    BaseMixedRealityProfile profile

    The service's configuration profile.

    Properties

    DisplayOption

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

    LevelOfDetail

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

    Meshes

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

    MeshPhysicsLayer

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

    MeshPhysicsLayerMask

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

    ObservedObjectParent

    Declaration
    protected virtual GameObject ObservedObjectParent { get; }
    Property Value
    Type Description
    GameObject

    OcclusionMaterial

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

    RecalculateNormals

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

    TrianglesPerCubicMeter

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

    VisibleMaterial

    Declaration
    public Material VisibleMaterial { get; set; }
    Property Value
    Type Description
    Material

    Methods

    ClearObservations()

    Declaration
    public override void ClearObservations()

    Destroy()

    Declaration
    public override void Destroy()

    Disable()

    Declaration
    public override void Disable()

    Enable()

    Declaration
    public override void Enable()

    Initialize()

    Declaration
    public override void Initialize()

    Reset()

    Declaration
    public override void Reset()

    Resume()

    Declaration
    public override void Resume()

    Suspend()

    Declaration
    public override void Suspend()

    Update()

    Declaration
    public override void Update()

    Explicit Interface Implementations

    IMixedRealityCapabilityCheck.CheckCapability(MixedRealityCapability)

    Checks to see if one or more registered data providers supports the requested capability on the current platform.

    Declaration
    bool IMixedRealityCapabilityCheck.CheckCapability(MixedRealityCapability capability)
    Parameters
    Type Name Description
    MixedRealityCapability capability

    The capability to check.

    Returns
    Type Description
    Boolean

    True if the capability is supported, false otherwise.

    Implements

    IMixedRealitySpatialAwarenessMeshObserver
    IMixedRealityCapabilityCheck
    Back to top Generated by DocFX