MixedRealityBoundarySystem Class

Definition

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

public ref class MixedRealityBoundarySystem : Microsoft::MixedReality::Toolkit::Boundary::BaseBoundarySystem
[UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/boundary/boundary-system-getting-started")]
public class MixedRealityBoundarySystem : Microsoft.MixedReality.Toolkit.Boundary.BaseBoundarySystem
[<UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/boundary/boundary-system-getting-started")>]
type MixedRealityBoundarySystem = class
    inherit BaseBoundarySystem
Public Class MixedRealityBoundarySystem
Inherits BaseBoundarySystem
Inheritance
Attributes
UnityEngine.HelpURLAttribute

Constructors

MixedRealityBoundarySystem(IMixedRealityServiceRegistrar, MixedRealityBoundaryVisualizationProfile, ExperienceScale)
Obsolete.

Constructor.

MixedRealityBoundarySystem(MixedRealityBoundaryVisualizationProfile, ExperienceScale)

Constructor.

Fields

DefaultPriority (Inherited from BaseService)
disposed

Value indicating if the object has completed disposal.

(Inherited from BaseService)
RectangularBounds

The largest rectangle that is contained withing the play space geometry.

(Inherited from BaseBoundarySystem)

Properties

BoundaryHeight

The height of the play space, in meters.

(Inherited from BaseBoundarySystem)
BoundaryVisualizationProfile

Typed representation of the ConfigurationProfile property.

(Inherited from BaseBoundarySystem)
BoundaryWallsPhysicsLayer

The physics layer that the generated boundary walls are assigned to.

(Inherited from BaseBoundarySystem)
Bounds

Two dimensional representation of the geometry of the boundary, as provided by the platform.

(Inherited from BaseBoundarySystem)
CeilingPhysicsLayer

The physics layer that the generated boundary ceiling is assigned to.

(Inherited from BaseBoundarySystem)
ConfigurationProfile

The configuration profile for the service.

(Inherited from BaseService)
EventHandlersByType

List of all event handlers grouped by type that are registered to this Event System.

(Inherited from BaseEventSystem)
EventListeners

List of event listeners that are registered to this Event System.

(Inherited from BaseEventSystem)
FloorHeight

Indicates the height of the floor, in relation to the coordinate system origin.

(Inherited from BaseBoundarySystem)
FloorPhysicsLayer

The physics layer that the generated floor is assigned to.

(Inherited from BaseBoundarySystem)
IsEnabled

Indicates whether or not the service is currently enabled.

(Inherited from BaseService)
IsInitialized

Indicates whether or not the service has been initialized.

(Inherited from BaseService)
IsMarkedDestroyed

Indicates whether or not the Destroy method been called on this service.

(Inherited from BaseService)
IsXRDevicePresent

Whether any XR device is present.

IsXRDevicePresent
Obsolete.

Whether any XR device is present.

(Inherited from BaseBoundarySystem)
Name

Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action.

PlayAreaPhysicsLayer

The physics layer that the generated play area is assigned to.

(Inherited from BaseBoundarySystem)
Priority

Optional Priority to reorder registered managers based on their respective priority, reduces the risk of race conditions by prioritizing the order in which managers are evaluated.

(Inherited from BaseService)
Registrar
Obsolete.

The service registrar instance that registered this service.

(Inherited from BaseCoreSystem)
Scale

The scale (ex: World Scale) of the experience.

(Inherited from BaseBoundarySystem)
ShowBoundaryCeiling

Enable / disable ceiling rendering.

(Inherited from BaseBoundarySystem)
ShowBoundaryWalls

Enable / disable boundary wall rendering.

(Inherited from BaseBoundarySystem)
ShowFloor

Enable / disable floor rendering.

(Inherited from BaseBoundarySystem)
ShowPlayArea

Enable / disable play area rendering.

(Inherited from BaseBoundarySystem)
ShowTrackedArea

Enable / disable tracked area rendering.

(Inherited from BaseBoundarySystem)
SourceId

The unique source id of this event source.

(Inherited from BaseBoundarySystem)
SourceName

The name of this event source.

(Inherited from BaseBoundarySystem)
TrackedAreaPhysicsLayer

The physics layer that the generated tracked area is assigned to.

(Inherited from BaseBoundarySystem)

Methods

Contains(Vector3, BoundaryType)

Determines if a location is within the specified area of the boundary space.

(Inherited from BaseBoundarySystem)
Destroy()

Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed.

(Inherited from BaseBoundarySystem)
Disable()

Optional Disable function to pause the service.

(Inherited from BaseService)
Dispose()

Cleanup resources used by this object.

(Inherited from BaseService)
Dispose(Boolean)

Cleanup resources used by the object

(Inherited from BaseService)
Enable()

Optional Enable function to enable / re-enable the service.

(Inherited from BaseService)
GetBoundaryCeilingVisualization()

Gets the GameObject that represents the upper surface of the user's boundary.

(Inherited from BaseBoundarySystem)
GetBoundaryGeometry()

Retrieves the boundary geometry.

GetBoundaryWallVisualization()

Gets the GameObject that represents the user's boundary walls.

(Inherited from BaseBoundarySystem)
GetFloorVisualization()

Gets the GameObject that represents the user's floor.

(Inherited from BaseBoundarySystem)
GetHashCode(Object) (Inherited from BaseBoundarySystem)
GetPlayAreaVisualization()

Gets the GameObject that represents the user's play area.

(Inherited from BaseBoundarySystem)
GetTrackedAreaVisualization()

Gets the GameObject that represents the user's tracked area.

(Inherited from BaseBoundarySystem)
HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction)

The main function for handling and forwarding all events to their intended recipients.

(Inherited from BaseBoundarySystem)
Initialize()

The initialize function is used to setup the service once created. This method is called once all services have been registered in the Mixed Reality Toolkit.

(Inherited from BaseBoundarySystem)
LateUpdate()

Optional LateUpdate function to that is called after Update has been called on all services.

(Inherited from BaseService)
Register(GameObject)

Registers the GameObject to listen for boundary events.

(Inherited from BaseBoundarySystem)
RegisterHandler<T>(IEventSystemHandler)

Registers the given handler as a global listener for all events handled via the T interface. T must be an interface type, not a class type, derived from IEventSystemHandler.

(Inherited from BaseEventSystem)
Reset()

Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change.

(Inherited from BaseService)
SetTrackingSpace()

Updates the TrackingSpaceType on the XR device.

TryGetRectangularBoundsParams(Vector2, Single, Single, Single)

Returns the description of the inscribed rectangular bounds.

(Inherited from BaseBoundarySystem)
Unregister(GameObject)

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

(Inherited from BaseBoundarySystem)
UnregisterHandler<T>(IEventSystemHandler)

Unregisters the given handler as a global listener for all events handled via the T interface. T must be an interface type, not a class type, derived from IEventSystemHandler.

(Inherited from BaseEventSystem)
Update() (Inherited from BaseBoundarySystem)

Explicit Interface Implementations

IEqualityComparer.Equals(Object, Object) (Inherited from BaseBoundarySystem)

Applies to