Immerseum SDK: VR Simulator (version: RC-1.0.0)
       [view as Desktop | Tablet | Mobile]
PlayArea Class Members
Fields  Properties  Methods 

The following tables list the members exposed by PlayArea.

Public Constructors
 NameDescription
Public ConstructorPlayArea Constructor  
Top
Public Fields
 NameDescription
Public FieldborderThickness  
Public Fieldcolor  
Public FieldcornerVertices  
Public FieldheightOffset  
Public Fieldmaterial  
Public FieldverticesList  
Top
Public Properties
 NameDescription
Public PropertydepthIndicates the depth (along the z-axis) of the Play Area.  
Public PropertydimensionsIndicates the dimensions (width / depth) of the Play Area as a Vector2.  
Public Propertyheight

The height (along the y-axis) of the Play Area.

You Should Know... You Should Know...
The Immerseum Play Area always has a fixed height of 0.01.
 
Public PropertyisAvatarOutsideBoundaryIndicates whether the user's avatar is currently outside of the Play Area's bounds.  
Public PropertyisAvatarWithinBoundaryIndicates whether the user's avatar is currently inside of the Play Area's bounds.  
Public PropertyisVisibleIndicates whether the Play Area is currently visible within the scene.  
Public PropertysizeThe PlayAreaSize that determines the width/depth of this Play Area.  
Public PropertywidthIndicates the width (along the x-axis) of the Play Area.  
Top
Public Methods
 NameDescription
Public MethodapplyCollidersGenerates and applies one Colliders to the Play Area as applicable.  
Public MethodapplyColorToOculusPlayAreaApplies the Play Area's color to the Oculus Boundary system.  
Public MethodapplySettingsToSteamPlayArea

Applies the Play Area's size and appearance settings to the SteamVR_PlayArea component attached to the camera rig.

Be Aware Be Aware
If your Play Area's size does not match one of the SteamVR_PlayArea's allowed sizes, will default to 3m x 2.25m.
 
Public MethodapplySteamPlayAreaSettingsApplies the camera rig's SteamVR_PlayArea component size and appearance settings to the simulated Play Area.  
Public MethodcalibratePlayAreaAdjusts the sizing / dimensions of the Play Area to correspond to the HMD Play Area and its calibrated settings (if available).  
Public MethodgetDistanceOverloaded. Returns the shortest distance from the point to the Play Area's bounds.  
Public MethodisWithinBoundaryOverloaded. Determines whether the point is within the Play Area's bounds.  
Public MethodmoveRepositions the Play Area at the provided coordinates.  
Public MethodrecenterOnAvatarPositions the Play Area to be centered on the user's avatar.  
Public MethodsetDimensionsOverloaded. Adjusts the dimensions of the Play Area to the width/depth provided.  
Public MethodsetMaterialSets the Material and Color that are applied to the Play Area.  
Public MethodsetParentChanges the parent of the Play Area gameobject in the scene hierarchy.  
Public MethodsetPlayAreaSizeOverloaded. Sets the size of the Play Area to one of the preconfigured PlayAreaSize values.  
Public MethodsetVerticesSets the size of the Play Area based on a collection of vertex points that define the boundary.  
Top
See Also

Reference

PlayArea Class
Immerseum.VRSimulator Namespace

 

 


Copyright (c) 2016-2017 Immerseum Inc. All rights reserved.

Send Feedback