Class MixedRealityBoundarySystem

The Boundary system controls the presentation and display of the users boundary in a scene.

Inheritance
Object
MixedRealityBoundarySystem
Namespace: Microsoft.MixedReality.Toolkit.Boundary
Assembly: cs.temp.dll.dll
Syntax
public class MixedRealityBoundarySystem : BaseCoreSystem, IMixedRealityBoundarySystem, IMixedRealityEventSystem, IMixedRealityService, IDisposable, IMixedRealityEventSource, IEqualityComparer

Constructors

MixedRealityBoundarySystem(MixedRealityBoundaryVisualizationProfile, ExperienceScale)

Constructor.

Declaration
public MixedRealityBoundarySystem(MixedRealityBoundaryVisualizationProfile profile, ExperienceScale scale)
Parameters
Type Name Description
MixedRealityBoundaryVisualizationProfile profile

The configuration profile for the service.
ExperienceScale scale

The application's configured ExperienceScale.

MixedRealityBoundarySystem(MixedRealityBoundaryVisualizationProfile, ExperienceScale)

Constructor.

Declaration
public MixedRealityBoundarySystem(MixedRealityBoundaryVisualizationProfile profile, ExperienceScale scale)
Parameters
Type Name Description
MixedRealityBoundaryVisualizationProfile profile

The configuration profile for the service.
ExperienceScale scale

The application's configured ExperienceScale.

MixedRealityBoundarySystem(IMixedRealityServiceRegistrar, MixedRealityBoundaryVisualizationProfile, ExperienceScale)

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 MixedRealityBoundarySystem(IMixedRealityServiceRegistrar registrar, MixedRealityBoundaryVisualizationProfile profile, ExperienceScale scale)
Parameters
Type Name Description
IMixedRealityServiceRegistrar registrar

The IMixedRealityServiceRegistrar instance that loaded the service.
MixedRealityBoundaryVisualizationProfile profile

The configuration profile for the service.
ExperienceScale scale

The application's configured ExperienceScale.

MixedRealityBoundarySystem(IMixedRealityServiceRegistrar, MixedRealityBoundaryVisualizationProfile, ExperienceScale)

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 MixedRealityBoundarySystem(IMixedRealityServiceRegistrar registrar, MixedRealityBoundaryVisualizationProfile profile, ExperienceScale scale)
Parameters
Type Name Description
IMixedRealityServiceRegistrar registrar

The IMixedRealityServiceRegistrar instance that loaded the service.
MixedRealityBoundaryVisualizationProfile profile

The configuration profile for the service.
ExperienceScale scale

The application's configured ExperienceScale.

Properties

BoundaryHeight

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

BoundaryVisualizationProfile

Declaration
public MixedRealityBoundaryVisualizationProfile BoundaryVisualizationProfile { get; }
Property Value
Type Description
MixedRealityBoundaryVisualizationProfile

BoundaryWallsPhysicsLayer

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

Bounds

Declaration
public Edge[] Bounds { get; }
Property Value
Type Description
Edge[]

CeilingPhysicsLayer

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

FloorHeight

Declaration
public float? FloorHeight { get; }
Property Value
Type Description
Nullable<Single>

FloorPhysicsLayer

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

Name

Declaration
public override string Name { get; protected set; }
Property Value
Type Description
String

Name

Declaration
public override string Name { get; protected set; }
Property Value
Type Description
String

PlayAreaPhysicsLayer

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

Scale

Declaration
public ExperienceScale Scale { get; set; }
Property Value
Type Description
ExperienceScale

ShowBoundaryCeiling

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

ShowBoundaryWalls

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

ShowFloor

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

ShowPlayArea

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

ShowTrackedArea

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

SourceId

Declaration
public uint SourceId { get; }
Property Value
Type Description
UInt32

SourceName

Declaration
public string SourceName { get; }
Property Value
Type Description
String

TrackedAreaPhysicsLayer

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

Methods

Contains(Vector3, BoundaryType)

Declaration
public bool Contains(Vector3 location, BoundaryType boundaryType = null)
Parameters
Type Name Description
Vector3 location
BoundaryType boundaryType
Returns
Type Description
Boolean

Destroy()

Declaration
public override void Destroy()

GetBoundaryCeilingVisualization()

Declaration
public GameObject GetBoundaryCeilingVisualization()
Returns
Type Description
GameObject

GetBoundaryGeometry()

Declaration
protected override List<Vector3> GetBoundaryGeometry()
Returns
Type Description
List<Vector3>

GetBoundaryWallVisualization()

Declaration
public GameObject GetBoundaryWallVisualization()
Returns
Type Description
GameObject

GetFloorVisualization()

Declaration
public GameObject GetFloorVisualization()
Returns
Type Description
GameObject

GetHashCode(Object)

Declaration
public int GetHashCode(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Int32

GetPlayAreaVisualization()

Declaration
public GameObject GetPlayAreaVisualization()
Returns
Type Description
GameObject

GetTrackedAreaVisualization()

Declaration
public GameObject GetTrackedAreaVisualization()
Returns
Type Description
GameObject

HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)

Declaration
public override void HandleEvent<T>(BaseEventData eventData, ExecuteEvents.EventFunction<T> eventHandler)
Parameters
Type Name Description
BaseEventData eventData
ExecuteEvents.EventFunction<T> eventHandler
Type Parameters
Name Description
T

Initialize()

Declaration
public override void Initialize()

Initialize()

Declaration
public override void Initialize()

Register(GameObject)

Registers the GameObject to listen for boundary events.

Declaration
public override void Register(GameObject listener)
Parameters
Type Name Description
GameObject listener

SetTrackingSpace()

Updates the TrackingSpaceType on the XR device.

Declaration
protected override void SetTrackingSpace()

TryGetRectangularBoundsParams(out Vector2, out Single, out Single, out Single)

Declaration
public bool TryGetRectangularBoundsParams(out Vector2 center, out float angle, out float width, out float height)
Parameters
Type Name Description
Vector2 center
Single angle
Single width
Single height
Returns
Type Description
Boolean

Unregister(GameObject)

UnRegisters the GameObject to listen for boundary events. ///

Declaration
public override void Unregister(GameObject listener)
Parameters
Type Name Description
GameObject listener

Implements

IDisposable
IEqualityComparer