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 MixedRealityBoundaryVisualizationProfile

    Configuration profile settings for setting up boundary visualizations.

    Inheritance
    Object
    BaseMixedRealityProfile
    MixedRealityBoundaryVisualizationProfile
    Namespace: Microsoft.MixedReality.Toolkit.Boundary
    Assembly: cs.temp.dll.dll
    Syntax
    [MixedRealityServiceProfile(typeof(IMixedRealityBoundarySystem))]
    public class MixedRealityBoundaryVisualizationProfile : BaseMixedRealityProfile

    Properties

    BoundaryCeilingMaterial

    The material to use for displaying the boundary ceiling.

    Declaration
    public Material BoundaryCeilingMaterial { get; }
    Property Value
    Type Description
    Material

    BoundaryHeight

    The developer defined height of the boundary, in meters.

    Declaration
    public float BoundaryHeight { get; }
    Property Value
    Type Description
    Single
    Remarks

    The BoundaryHeight property is used to create a three dimensional volume for the play space.

    BoundaryWallMaterial

    The material to use for displaying the boundary geometry walls.

    Declaration
    public Material BoundaryWallMaterial { get; }
    Property Value
    Type Description
    Material

    BoundaryWallsPhysicsLayer

    The physics layer to assign to the generated boundary walls.

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

    CeilingPhysicsLayer

    The physics layer to assign to the generated boundary ceiling.

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

    FloorMaterial

    The material to use for the floor GameObject when created by the boundary system.

    Declaration
    public Material FloorMaterial { get; }
    Property Value
    Type Description
    Material

    FloorPhysicsLayer

    The physics layer to assign to the generated floor.

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

    FloorScale

    The size at which to display the rectangular floor plane GameObject.

    Declaration
    public Vector2 FloorScale { get; }
    Property Value
    Type Description
    Vector2

    PlayAreaMaterial

    The material to use for the rectangular play area GameObject.

    Declaration
    public Material PlayAreaMaterial { get; }
    Property Value
    Type Description
    Material

    PlayAreaPhysicsLayer

    The physics layer to assign to the generated play area.

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

    ShowBoundaryCeiling

    Should the boundary system display the boundary ceiling?

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

    ShowBoundaryWalls

    Should the boundary system display the boundary geometry walls?

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

    ShowFloor

    Should the boundary system display the floor?

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

    ShowPlayArea

    Should the boundary system display the play area?

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

    ShowTrackedArea

    Should the boundary system display the tracked area?

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

    TrackedAreaMaterial

    The material to use for the boundary geometry GameObject.

    Declaration
    public Material TrackedAreaMaterial { get; }
    Property Value
    Type Description
    Material

    TrackedAreaPhysicsLayer

    The physics layer to assign to the generated tracked area.

    Declaration
    public int TrackedAreaPhysicsLayer { get; }
    Property Value
    Type Description
    Int32
    Back to top Generated by DocFX