HMDSimulator Class Members

The following tables list the members exposed by HMDSimulator.

Public Constructors

	Name	Description
	HMDSimulator Constructor

Top

Public Properties

	Name	Description
	cameraInitializationTimeout	Gets the number of seconds that the system should attempt to establish a connection with an HMD.
	CameraRig	The Transform of the GameObject you are using as your VR CameraRig.
	controllerPrimitive	If simulateControllers is set to true, will return the Unity primitive that will be used to simulate position-tracked controllers.
	disableInStandaloneBuild	Indicates whether the VR Simulator should be disabled when running in a standalone build.
	getCamera	Returns the UnityEngine.Transform of the camera UnityEngine.GameObject.
	getCameraContainer	Gets the UnityEngine.Transform of the Camera Container.
	hasCollider	Indicates whether the Camera Rig or its relatives in the hierarchy have a Collider attached.
	headHeight	Returns the height (in meters / unity units) of the camera's position.
	heightTarget	Indicates the camera height that you wish to simulate.
	hmdFamily	The family of HMD which is currently connected.
	Instance	The singleton Instance of the HMDSimulator class.
	isCameraInitializationComplete	Gets a value indicating whether the Camera Initialization process has been completed.
	isCameraRigPresent	Indicates whether a supported Camera Rig GameObject is present within the scene or not.
	isGamepadConnected	Indicates whether the user has a gamepad connected to the platform.
	isHMDConnected	Indicates whether there is a VR Head-Mounted Display (HMD) connected to the user's system.
	isOculusHMDConnected	Indicates whether there is an Oculus Rift HMD connected to the user's system.
	isPlaystationVRHMDConnected	Indicates whether a PlayStation VR is connected to the user's system.
	isRemoteConnected	Indicates whether the user has an Oculus Remote connected to their computer.
	isSteamVRHMDConnected	Indicates whether a SteamVR HMD (e.g. an HTC Vive) is connected to the user's system.
	isTrackingHands	Indicates whether the user's VR system is positionally tracking their hands (i.e. by way of a positionally-tracked handheld controller, such as the HTC Wands or the Oculus Touch).
	isUsingOVRPlayerController	Indicates whether the scene is actively making use of the OVRPlayerController prefab from the Oculus Utilities for Unity.
	isUsingProfileData	Indicates whether the scene or character controller is using the HMD's stored profile data.
	isUsingSteamRig	Indicates whether the scene (and HMD Simulator) is using a SteamVR CameraRig.
	leftController	The instance of the simulated left-hand controller in your scene.
	leftControllerPrefab	Returns the prefab GameObject that will be used to simulate the left-hand controller. Can be any prefab you wish.
	logDiagnostics	Gets a value indicating whether Diagnostic Information should be logged to the console.
	logInputActions	Gets a value indicating whether InputAction events should be logged to the console.
	primitiveScaling	If simulateControllers is set to true and controllerPrimitive is not Custom, returns the scaling factor to apply to the controller primitive.
	rightController	The instance of the simulated right-hand controller in your scene.
	rightControllerPrefab	Returns the prefab GameObject that will be used to simulate the right-hand controller. Can be any prefab you wish.
	simulateControllers	Indicates whether to simulate position-tracked controllers or not.

Top

Public Methods

	Name	Description
	getDefaultHeadHeight	Returns the default Head Height for given HeightTargets value.
	isCameraRigInTransform	Indicates whether the Camera Rig is related to the Transform passed to this method.
	setCameraRig	Sets the value of CameraRig.
	setControllerPrefab	Overloaded. Assigns a supplied prefab as the prefab to use when simulating an indicated position-tracked controller.
	setControllers	Sets controllerObject as the object for the simulated controller indicated by the value of controller.

Top

Reference

HMDSimulator Class
Immerseum.VRSimulator Namespace