PlayAreaManager Class Members

The following tables list the members exposed by PlayAreaManager.

Public Constructors

	Name	Description
	PlayAreaManager Constructor

Top

Public Properties

	Name	Description
	customPlayAreaDimensions	Indicates the custom dimensions (width / depth) of the Play Area.
	getHMDPlayAreaSize	Returns the PlayAreaSize that is applied to the HMD Play Area.
	getHMDPlayAreaVerticesList	Returns a list of the vertices exposed by the HMD Play Area.
	getSteamPlayArea	Returns the SteamVR_PlayArea component of the HMD Play Area.
	getSteamPlayAreaTransform	The Transform to which the SteamVR_PlayArea component is attached.
	hasHMDPlayArea	Indicates whether an HMD Play Area is included in the scene or calculated by an attached HMD.
	hasImmerseumPlayArea	Indicates whether the Immerseum SDK has generated a play area for display in the scene.
	hasOculusPlayArea	Indicates whether there is an Oculus-generated HMD Play Area in the scene.
	hasSteamPlayArea	Indicates whether there is a Steam-generated HMD Play Area (or its data) present in the scene.
	Instance	The singleton Instance of this class.
	isHMDPlayAreaSizeCalibrated	Indicates whether the HMD Play Area's size has been calibrated to an attached HMD.
	isMovementBoundToPlayArea	Indicates whether the user's movement is currently constrained to the play area, i.e. movement input will not take the user's camera outside of the play area as determined by their HMD configuration (for room-scale configurations) or by the scene designer (for seated/standing configurations).
	isPlayAreaDisplayedAlways	Indicates whether the Play Area should always be displayed in the scene.
	isPlayAreaDisplayedOnApproach	Indicates whether the Immerseum Play Area should be displayed when the user approaches its bounds.
	playArea	The instance of the Play Area component applied to the Immerseum Play Area object.
	playAreaBorderThickness	Indicates the thickness of the Play Area's border when rendering without a Material.
	playAreaColor	Indicates the color to apply to the Play Area.
	playAreaDisplayOnApproachDistance	Indicates the distance at which the Immerseum Play Area should be displayed. When the distance between the Play Area's bounds and the camera/controllers is less than this value, the Immerseum Play Area is displayed.
	playAreaDisplayOnInputAction	Indicates the name of the InputAction that toggles the Immerseum Play Area.
	playAreaDisplayTrigger	Indicates when the Immerseum Play Area should be rendered/displayed within the scene.
	playAreaMaterial	Indicates the Material to apply to the Immerseum Play Area.
	playAreaSize	Indicates the size of the Play Area, in terms of width (x-axis) and depth (z-axis).
	shouldPlayAreaBeApplied	Indicates whether the Immerseum Play Area should be calculated and built in the scene.

Top

Public Methods

	Name	Description
	doesPlayAreaDisplayAtDistance	Indicates whether the Play Area should be displayed given the distance supplied.
	doesPlayAreaDisplayOnInputAction	Overloaded. Indicates whether the Play Area should be toggled (displayed or hidden) on an .
	getPlayAreaDimensions	Returns the width (X) and depth (Z) of the Play Area as a Vector2 value.
	setInputMoveTarget	Sets whether the user's movement is bound to the size of their play area, either determined by their HMD configuration or by the scene designer.
	setIsMovementBoundToPlayArea	Sets whether the user's movement is bound to the size of their play area, either determined by their HMD configuration or by the scene designer.
	setPlayArea	Sets the instance of the Play Area object that is assigned to the Immerseum Play Area.
	setPlayAreaBorderThickness	Sets the value of the playAreaBorderThickness.
	setPlayAreaColor	Sets the Color to apply to the Play Area.
	setPlayAreaDisplayOnApproachDistance	Sets the value of playAreaDisplayOnApproachDistance.
	setPlayAreaDisplayOnInputAction	Sets the value of playAreaDisplayOnInputAction which determines which toggles the display of the Play Area.
	setPlayAreaDisplayTrigger	Sets the value of playAreaDisplayTrigger.
	setPlayAreaMaterial	Sets the Material to apply to the Play Area.
	setPlayAreaSize	Sets the value of playAreaSize and propagates that information to the scene.

Top

Reference

PlayAreaManager Class
Immerseum.VRSimulator Namespace