PlayArea Class Members
| Immerseum.VRSimulator Namespace : PlayArea Class |
The following tables list the members exposed by PlayArea.
| Name | Description | |
|---|---|---|
 | PlayArea Constructor |
| Name | Description | |
|---|---|---|
 | borderThickness | |
| color | |
| cornerVertices | |
| heightOffset | |
| material | |
| verticesList |
| Name | Description | |||||
|---|---|---|---|---|---|---|
 | depth | Indicates the depth (along the z-axis) of the Play Area. | ||||
| dimensions | Indicates the dimensions (width / depth) of the Play Area as a Vector2. | ||||
| height | The height (along the y-axis) of the Play Area.
| ||||
| isAvatarOutsideBoundary | Indicates whether the user's avatar is currently outside of the Play Area's bounds. | ||||
| isAvatarWithinBoundary | Indicates whether the user's avatar is currently inside of the Play Area's bounds. | ||||
| isVisible | Indicates whether the Play Area is currently visible within the scene. | ||||
| size | The PlayAreaSize that determines the width/depth of this Play Area. | ||||
| width | Indicates the width (along the x-axis) of the Play Area. |
| Name | Description | |||||
|---|---|---|---|---|---|---|
 | applyColliders | Generates and applies one Colliders to the Play Area as applicable. | ||||
| applyColorToOculusPlayArea | Applies the Play Area's color to the Oculus Boundary system. | ||||
| applySettingsToSteamPlayArea | Applies the Play Area's size and appearance settings to the SteamVR_PlayArea component attached to the camera rig.
| ||||
| applySteamPlayAreaSettings | Applies the camera rig's SteamVR_PlayArea component size and appearance settings to the simulated Play Area. | ||||
| calibratePlayArea | Adjusts the sizing / dimensions of the Play Area to correspond to the HMD Play Area and its calibrated settings (if available). | ||||
| getDistance | Overloaded. Returns the shortest distance from the point to the Play Area's bounds. | ||||
| isWithinBoundary | Overloaded. Determines whether the point is within the Play Area's bounds. | ||||
| move | Repositions the Play Area at the provided coordinates. | ||||
| recenterOnAvatar | Positions the Play Area to be centered on the user's avatar. | ||||
| setDimensions | Overloaded. Adjusts the dimensions of the Play Area to the width/depth provided. | ||||
| setMaterial | Sets the Material and Color that are applied to the Play Area. | ||||
| setParent | Changes the parent of the Play Area gameobject in the scene hierarchy. | ||||
| setPlayAreaSize | Overloaded. Sets the size of the Play Area to one of the preconfigured PlayAreaSize values. | ||||
| setVertices | Sets the size of the Play Area based on a collection of vertex points that define the boundary. |
