IMixedRealityBoundarySystem Interface

Definition

Manager interface for a Boundary system in the Mixed Reality Toolkit All replacement systems for providing Boundary functionality should derive from this interface

public interface class IMixedRealityBoundarySystem : IDisposable, Microsoft::MixedReality::Toolkit::IMixedRealityEventSource, Microsoft::MixedReality::Toolkit::IMixedRealityEventSystem, System::Collections::IEqualityComparer
public interface IMixedRealityBoundarySystem : IDisposable, Microsoft.MixedReality.Toolkit.IMixedRealityEventSource, Microsoft.MixedReality.Toolkit.IMixedRealityEventSystem, System.Collections.IEqualityComparer
type IMixedRealityBoundarySystem = interface
    interface IMixedRealityEventSystem
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityEventSource
    interface IEqualityComparer
Public Interface IMixedRealityBoundarySystem
Implements IDisposable, IEqualityComparer, IMixedRealityEventSource, IMixedRealityEventSystem
Derived
Implements

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 IMixedRealityService)
EventListeners

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

(Inherited from IMixedRealityEventSystem)
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.

Name

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

(Inherited from IMixedRealityService)
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 IMixedRealityService)
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.

(Inherited from IMixedRealityEventSource)
SourceName

The name of this event source.

(Inherited from IMixedRealityEventSource)
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.

(Inherited from IMixedRealityService)
Disable()

Optional Disable function to pause the service.

(Inherited from IMixedRealityService)
Enable()

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

(Inherited from IMixedRealityService)
GetBoundaryCeilingVisualization()

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

GetBoundaryWallVisualization()

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

GetFloorVisualization()

Gets the GameObject that represents the user's floor.

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.

(Inherited from IMixedRealityEventSystem)
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 IMixedRealityService)
LateUpdate()

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

(Inherited from IMixedRealityService)
Register(GameObject)
Obsolete.

Registers a GameObject to listen for events from this Event System.

(Inherited from IMixedRealityEventSystem)
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 IMixedRealityEventSystem)
Reset()

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

(Inherited from IMixedRealityService)
TryGetRectangularBoundsParams(Vector2, Single, Single, Single)

Returns the description of the inscribed rectangular bounds.

Unregister(GameObject)
Obsolete.

Unregisters a GameObject from listening for events from this Event System.

(Inherited from IMixedRealityEventSystem)
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 IMixedRealityEventSystem)
Update()

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

(Inherited from IMixedRealityService)

Applies to