BaseBoundarySystem Class

Definition

public ref class BaseBoundarySystem abstract : Microsoft::MixedReality::Toolkit::BaseCoreSystem, IDisposable, Microsoft::MixedReality::Toolkit::Boundary::IMixedRealityBoundarySystem, System::Collections::IEqualityComparer
public abstract class BaseBoundarySystem : Microsoft.MixedReality.Toolkit.BaseCoreSystem, IDisposable, Microsoft.MixedReality.Toolkit.Boundary.IMixedRealityBoundarySystem, System.Collections.IEqualityComparer
type BaseBoundarySystem = class
    inherit BaseCoreSystem
    interface IMixedRealityBoundarySystem
    interface IMixedRealityEventSystem
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityEventSource
    interface IEqualityComparer
Public MustInherit Class BaseBoundarySystem
Inherits BaseCoreSystem
Implements IDisposable, IEqualityComparer, IMixedRealityBoundarySystem
Inheritance
Derived
Implements

Constructors

BaseBoundarySystem(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.

Properties

BoundaryHeight

The height of the play space, in meters.

BoundaryVisualizationProfile

Typed representation of the ConfigurationProfile property.

BoundaryWallsPhysicsLayer

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

Bounds

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

CeilingPhysicsLayer

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

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.

FloorPhysicsLayer

The physics layer that the generated floor is assigned to.

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
Obsolete.

Whether any XR device is present.

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.

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.

ShowBoundaryCeiling

Enable / disable ceiling rendering.

ShowBoundaryWalls

Enable / disable boundary wall rendering.

ShowFloor

Enable / disable floor rendering.

ShowPlayArea

Enable / disable play area rendering.

ShowTrackedArea

Enable / disable tracked area rendering.

SourceId

The unique source id of this event source.

SourceName

The name of this event source.

TrackedAreaPhysicsLayer

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

Methods

Contains(Vector3, BoundaryType)

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

Destroy()

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

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.

GetBoundaryGeometry()

Retrieves the boundary geometry.

GetBoundaryWallVisualization()

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

GetFloorVisualization()

Gets the GameObject that represents the user's floor.

GetHashCode(Object)

Returns a hash code for the specified object.

GetPlayAreaVisualization()

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

GetTrackedAreaVisualization()

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

HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction)

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

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.

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.

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 tracking space on the XR device.

TryGetRectangularBoundsParams(Vector2, Single, Single, Single)

Returns the description of the inscribed rectangular bounds.

Unregister(GameObject)

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

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()
Update()

Optional Update function to perform per-frame updates of the service.

(Inherited from BaseService)

Explicit Interface Implementations

IEqualityComparer.Equals(Object, Object)

Determines whether the specified objects are equal.

Applies to