Interface IMixedRealityBoundarySystem
Manager interface for a Boundary system in the Mixed Reality Toolkit All replacement systems for providing Boundary functionality should derive from this interface
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Boundary
Assembly: cs.temp.dll.dll
Syntax
public interface IMixedRealityBoundarySystem : IMixedRealityEventSystem, IMixedRealityService, IDisposable, IMixedRealityEventSource, IEqualityComparer
Properties
BoundaryHeight
The height of the play space, in meters.
Declaration
float BoundaryHeight { get; set; }
Property Value
Type | Description |
---|---|
Single |
Remarks
This is used to create a three dimensional boundary volume.
BoundaryVisualizationProfile
Typed representation of the ConfigurationProfile property.
Declaration
MixedRealityBoundaryVisualizationProfile BoundaryVisualizationProfile { get; }
Property Value
Type | Description |
---|---|
MixedRealityBoundaryVisualizationProfile |
BoundaryWallsPhysicsLayer
The physics layer that the generated boundary walls are assigned to.
Declaration
int BoundaryWallsPhysicsLayer { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Bounds
Two dimensional representation of the geometry of the boundary, as provided by the platform.
Declaration
Edge[] Bounds { get; }
Property Value
Type | Description |
---|---|
Edge[] |
Remarks
BoundaryGeometry should be treated as the outline of the player's space, placed on the floor.
CeilingPhysicsLayer
The physics layer that the generated boundary ceiling is assigned to.
Declaration
int CeilingPhysicsLayer { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
FloorHeight
Indicates the height of the floor, in relation to the coordinate system origin.
Declaration
float? FloorHeight { get; }
Property Value
Type | Description |
---|---|
Nullable<Single> |
Remarks
If a floor has been located, FloorHeight.HasValue will be true, otherwise it will be false.
FloorPhysicsLayer
The physics layer that the generated floor is assigned to.
Declaration
int FloorPhysicsLayer { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
PlayAreaPhysicsLayer
The physics layer that the generated play area is assigned to.
Declaration
int PlayAreaPhysicsLayer { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Scale
The scale (ex: World Scale) of the experience.
Declaration
ExperienceScale Scale { get; set; }
Property Value
Type | Description |
---|---|
ExperienceScale |
ShowBoundaryCeiling
Enable / disable ceiling rendering.
Declaration
bool ShowBoundaryCeiling { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Remarks
The ceiling is defined as a GameObject positioned BoundaryHeight above the floor.
ShowBoundaryWalls
Enable / disable boundary wall rendering.
Declaration
bool ShowBoundaryWalls { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
ShowFloor
Enable / disable floor rendering.
Declaration
bool ShowFloor { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
ShowPlayArea
Enable / disable play area rendering.
Declaration
bool ShowPlayArea { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
ShowTrackedArea
Enable / disable tracked area rendering.
Declaration
bool ShowTrackedArea { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
TrackedAreaPhysicsLayer
The physics layer that the generated tracked area is assigned to.
Declaration
int TrackedAreaPhysicsLayer { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Methods
Contains(Vector3, BoundaryType)
Determines if a location is within the specified area of the boundary space.
Declaration
bool Contains(Vector3 location, BoundaryType boundaryType = BoundaryType.TrackedArea)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | location | The location to be checked. |
BoundaryType | boundaryType | The type of boundary space being checked. |
Returns
Type | Description |
---|---|
Boolean | True if the location is within the specified area of the boundary space. |
Remarks
Use BoundaryType.PlayArea for the inscribed volume and BoundaryType.TrackedArea for the area defined by the boundary edges.
GetBoundaryCeilingVisualization()
Gets the GameObject that represents the upper surface of the user's boundary.
Declaration
GameObject GetBoundaryCeilingVisualization()
Returns
Type | Description |
---|---|
GameObject | The boundary ceiling visualization object or null if one does not exist. |
GetBoundaryWallVisualization()
Gets the GameObject that represents the user's boundary walls.
Declaration
GameObject GetBoundaryWallVisualization()
Returns
Type | Description |
---|---|
GameObject | The boundary wall visualization object or null if one does not exist. |
GetFloorVisualization()
Gets the GameObject that represents the user's floor.
Declaration
GameObject GetFloorVisualization()
Returns
Type | Description |
---|---|
GameObject | The floor visualization object or null if one does not exist. |
GetPlayAreaVisualization()
Gets the GameObject that represents the user's play area.
Declaration
GameObject GetPlayAreaVisualization()
Returns
Type | Description |
---|---|
GameObject | The play area visualization object or null if one does not exist. |
GetTrackedAreaVisualization()
Gets the GameObject that represents the user's tracked area.
Declaration
GameObject GetTrackedAreaVisualization()
Returns
Type | Description |
---|---|
GameObject | The tracked area visualization object or null if one does not exist. |
TryGetRectangularBoundsParams(out Vector2, out Single, out Single, out Single)
Returns the description of the inscribed rectangular bounds.
Declaration
bool TryGetRectangularBoundsParams(out Vector2 center, out float angle, out float width, out float height)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | center | The center of the rectangle. |
Single | angle | The orientation of the rectangle. |
Single | width | The width of the rectangle. |
Single | height | The height of the rectangle. |
Returns
Type | Description |
---|---|
Boolean | True if an inscribed rectangle was found in the boundary geometry, false otherwise. |