Release Notes
Getting Started
Getting Started with the VRSimulator
Quick Start
Requirements and Supported Devices
FAQ
Configuring the VRSimulator
Managing Your Camera
Managing Your Controllers
Managing Your Play Area
Configuration Settings
HMDSimulator Settings
ControllerManager Settings
MovementManager Settings
InputActionManager Settings
PlayAreaManager Settings
Input & Movement
Custom Input Handling
Custom InputAction Mapping
Default Movement Mapping
Default Input Actions
Scripting Reference
Event Reference
Order of Events
Immerseum.VRSimulator Namespace
Overview
Classes
ControllerManager
Overview
Members
ControllerManager Constructor
Methods
moveController Method
moveController(Int32,Vector3,Quaternion) Method
moveController(Int32,ControllerPositions) Method
Properties
applyCollider Property
applyColliderHand Property
applyRigidbody Property
applyRigidbodyHand Property
areControllersSimulated Property
colliderCenter Property
colliderDirection Property
colliderHeight Property
colliderPhysicMaterial Property
colliderRadius Property
colliderSize Property
Instance Property
isKinematic Property
isTrigger Property
movementSpeed Property
primaryHand Property
rbAngularDrag Property
rbDrag Property
rbMass Property
rbUseGravity Property
seatedAdjustment Property
startingPosition Property
EventManager
Overview
Members
EventManager Constructor
Methods
activateCancelButton Method
activateLeftBumper Method
activateLeftThumbstickClick Method
activatePauseButton Method
activatePrimaryTrigger Method
activateRightBumper Method
activateRightThumbstickClick Method
activateSecondaryButton Method
activateSecondaryTrigger Method
activateSelectionButton Method
activateTertiaryButton Method
activateViewButton Method
applyCollider Method
applyRigidbody Method
deactivateCancelButton Method
deactivateLeftBumper Method
deactivateLeftThumbstickClick Method
deactivatePauseButton Method
deactivatePrimaryTrigger Method
deactivateRightBumper Method
deactivateRightThumbstickClick Method
deactivateSecondaryButton Method
deactivateSecondaryTrigger Method
deactivateSelectionButton Method
deactivateTertiaryButton Method
deactivateViewButton Method
disableVRSimulator Method
endApplyCollider Method
endApplyRigidbody Method
endInitializeCameraRig Method
endInitializeControllers Method
endInitializeInputActions Method
endInitializePlayArea Method
endInputAction Method
endInstantiateController Method
endMoveAvatar Method
endMoveController Method
endPitchRotation Method
endPositionController Method
endXAxisMovement Method
endYawRotation Method
endZAxisMovement Method
initializeCameraRig Method
initializeControllers Method
initializeHMDSimulator Method
initializeInputActions Method
initializePlayArea Method
instantiateController Method
moveController Method
moveController(Int32,ControllerPositions) Method
moveController(Int32,Vector3,Quaternion,Boolean) Method
positionController Method
startInputAction Method
startMoveAvatar Method
startPitchRotation Method
startXAxisMovement Method
startYawRotation Method
startZAxisMovement Method
Events
OnApplyCollider Event
OnApplyColliderEnd Event
OnApplyRigidbody Event
OnApplyRigidbodyEnd Event
OnCancelButtonActivation Event
OnCancelButtonDeactivation Event
OnDisableVRSimulator Event
OnInitializeCameraRig Event
OnInitializeCameraRigEnd Event
OnInitializeControllers Event
OnInitializeControllersEnd Event
OnInitializeHMDSimulator Event
OnInitializeInputActions Event
OnInitializeInputActionsEnd Event
OnInitializePlayArea Event
OnInitializePlayAreaEnd Event
OnInputActionEnd Event
OnInputActionStart Event
OnInstantiateController Event
OnInstantiateControllerEnd Event
OnLeftBumperActivation Event
OnLeftBumperDeactivation Event
OnLeftThumbstickClickActivation Event
OnLeftThumbstickClickDeactivation Event
OnMoveAvatarEnd Event
OnMoveAvatarStart Event
OnMoveControllerEnd Event
OnMoveControllerStart Event
OnMoveControllerStart_Vector Event
OnPauseButtonActivation Event
OnPauseButtonDeactivation Event
OnPitchRotationEnd Event
OnPitchRotationStart Event
OnPositionController Event
OnPositionControllerEnd Event
OnPrimaryTriggerActivation Event
OnPrimaryTriggerDeactivation Event
OnRightBumperActivation Event
OnRightBumperDeactivation Event
OnRightThumbstickClickActivation Event
OnRightThumbstickClickDeactivation Event
OnSecondaryButtonActivation Event
OnSecondaryButtonDeactivation Event
OnSecondaryTriggerActivation Event
OnSecondaryTriggerDeactivation Event
OnSelectionButtonActivation Event
OnSelectionButtonDeactivation Event
OnTertiaryButtonActivation Event
OnTertiaryButtonDeactivation Event
OnViewButtonActivation Event
OnViewButtonDeactivation Event
OnXAxisMovementEnd Event
OnXAxisMovementStart Event
OnYawRotationEnd Event
OnYawRotationStart Event
OnZAxisMovementEnd Event
OnZAxisMovementStart Event
HMDSimulator
Overview
Members
HMDSimulator Constructor
Methods
getDefaultHeadHeight Method
isCameraRigInTransform Method
setCameraRig Method
setControllerPrefab Method
setControllerPrefab(Int32,GameObject) Method
setControllerPrefab() Method
setControllerPrefab(GameObject) Method
setControllers Method
Properties
cameraInitializationTimeout Property
CameraRig Property
controllerPrimitive Property
disableInStandaloneBuild Property
getCamera Property
getCameraContainer Property
hasCollider Property
headHeight Property
heightTarget Property
hmdFamily Property
Instance Property
isCameraInitializationComplete Property
isCameraRigPresent Property
isGamepadConnected Property
isHMDConnected Property
isOculusHMDConnected Property
isPlaystationVRHMDConnected Property
isRemoteConnected Property
isSteamVRHMDConnected Property
isTrackingHands Property
isUsingOVRPlayerController Property
isUsingProfileData Property
isUsingSteamRig Property
leftController Property
leftControllerPrefab Property
logDiagnostics Property
logInputActions Property
primitiveScaling Property
rightController Property
rightControllerPrefab Property
simulateControllers Property
InputAction
Overview
Members
InputAction Constructor
Methods
deregisterAction Method
Equals Method
Equals(Object) Method
Equals(InputAction) Method
getAxisValueSource Method
GetHashCode Method
registerAction Method
ToString Method
Properties
buttonValue Property
hasAxis Property
hasAxisFired Property
hasButton Property
hasButtonFired Property
hasFired Property
hasKey Property
hasKeyFired Property
isButtonHeld Property
isButtonPressed Property
isButtonPressedAndHeld Property
isButtonReleased Property
isKeyHeld Property
isKeyPressed Property
isKeyPressedAndHeld Property
isKeyReleased Property
isLeftTriggerAxisAtMax Property
isLeftTriggerAxisAtMin Property
isLeftTriggerAxisAtRest Property
isPitchAxisAtMax Property
isPitchAxisAtMin Property
isPitchAxisAtRest Property
isRightTriggerAxisAtMax Property
isRightTriggerAxisAtMin Property
isRightTriggerAxisAtRest Property
isXAxisAtMax Property
isXAxisAtMin Property
isXAxisAtRest Property
isYawAxisAtMax Property
isYawAxisAtMin Property
isYawAxisAtRest Property
isYAxisAtMax Property
isYAxisAtMin Property
isYAxisAtRest Property
isZAxisAtMax Property
isZAxisAtMin Property
isZAxisAtRest Property
leftTriggerAxisRawValue Property
leftTriggerAxisRawValue2D Property
leftTriggerAxisValue Property
leftTriggerAxisValue2D Property
name Property
pitchAxisRawValue Property
pitchAxisRawValue2D Property
pitchAxisValue Property
pitchAxisValue2D Property
rightTriggerAxisRawValue Property
rightTriggerAxisRawValue2D Property
rightTriggerAxisValue Property
rightTriggerAxisValue2D Property
xAxisRawValue Property
xAxisRawValue2D Property
xAxisValue Property
xAxisValue2D Property
yawAxisRawValue Property
yawAxisRawValue2D Property
yawAxisValue Property
yawAxisValue2D Property
yAxisRawValue Property
yAxisRawValue2D Property
yAxisValue Property
yAxisValue2D Property
zAxisRawValue Property
zAxisRawValue2D Property
zAxisValue Property
zAxisValue2D Property
Fields
heldButtonList Field
heldKeyList Field
internalDescription Field
leftTriggerAxisList Field
pitchAxisList Field
pressedAndHeldButtonList Field
pressedAndHeldKeyList Field
pressedButtonList Field
pressedKeyList Field
releasedButtonList Field
releasedKeyList Field
rightTriggerAxisList Field
xAxisList Field
yawAxisList Field
yAxisList Field
zAxisList Field
Operators
Equality Operator
Inequality Operator
InputActionManager
Overview
Members
InputActionManager Constructor
Methods
addInputAction Method
getInputAction Method
isActionRegistered Method
isKeyClicked Method
isKeyClicked(KeyCode) Method
isKeyClicked(KeyCode[]) Method
isKeyHeld Method
isKeyHeld(KeyCode) Method
isKeyHeld(KeyCode[]) Method
isKeyPressed Method
isKeyPressed(KeyCode) Method
isKeyPressed(KeyCode[]) Method
isKeyPressedAndHeld Method
isKeyPressedAndHeld(KeyCode) Method
isKeyPressedAndHeld(KeyCode[]) Method
isKeyReleased Method
isKeyReleased(KeyCode) Method
isKeyReleased(KeyCode[]) Method
isMouseClicked Method
isMouseClicked(Int32) Method
isMouseClicked(Int32[]) Method
isMouseHeld Method
isMouseHeld(Int32) Method
isMouseHeld(Int32[]) Method
isMousePressed Method
isMousePressed(Int32) Method
isMousePressed(Int32[]) Method
isMousePressedAndHeld Method
isMousePressedAndHeld(Int32) Method
isMousePressedAndHeld(Int32[]) Method
isMouseReleased Method
isMouseReleased(Int32) Method
isMouseReleased(Int32[]) Method
removeInputAction Method
removeInputAction(InputAction) Method
removeInputAction(Int32) Method
removeInputAction(String) Method
setCancelButtonActivated Method
setLeftBumperActivated Method
setLeftThumbstickClickActivated Method
setPauseButtonActivated Method
setRightBumperActivated Method
setRightThumbstickClickActivated Method
setSecondaryButtonActivated Method
setSelectionButtonActivated Method
setTertiaryButtonActivated Method
setViewButtonActivated Method
Properties
areImmerseumAxesDefined Property
areInputActionsInitialized Property
createImmerseumDefaults Property
inputActionList Property
inputActions Property
Instance Property
isCancelButtonActivated Property
isLeftBumperActivated Property
isLeftThumbstickClickActivated Property
isPauseButtonActivated Property
isRightBumperActivated Property
isRightThumbstickClickActivated Property
isSecondaryButtonActivated Property
isSelectionButtonActivated Property
isTertiaryButtonActivated Property
isViewButtonActivated Property
useImmerseumDefaults Property
InputAxis
Overview
Members
InputAxis Constructor
Properties
dimensions Property
isAtMax Property
isAtMin Property
isAtRest Property
rawValue Property
rawValue2D Property
value Property
value2D Property
Fields
hasMaximumValue Field
hasMinimumValue Field
inputType Field
maximumValue Field
minimumValue Field
name Field
returnX Field
valueAtRestList Field
InputButton
Overview
Members
InputButton Constructor
Properties
buttonType Property
isClicked Property
isGamepadButton Property
isHeld Property
isKeyboardButton Property
isMouseButton Property
isOculusButton Property
isPressed Property
isPressedAndHeld Property
isReleased Property
isSteamVRButton Property
value Property
Fields
internalDescription Field
isNegativeValue Field
name Field
KeyboardButton
Overview
Members
KeyboardButton Constructor
Properties
buttonType Property
isHeld Property
isPressed Property
isReleased Property
Fields
keyList Field
MouseButton
Overview
Members
MouseButton Constructor
Properties
buttonType Property
isClicked Property
isHeld Property
isPressed Property
isPressedAndHeld Property
isReleased Property
Fields
buttonIndex Field
MovementManager
Overview
Members
MovementManager Constructor
Methods
setHasMoved Method
setRunActive Method
Properties
accelerationRate Property
backAndSideDampingRate Property
forwardDampingRate Property
gravityAdjustment Property
hasMoved Property
Instance Property
isPrimaryTriggerInUse Property
isRunActive Property
isRunEnabled Property
isSecondaryTriggerInUse Property
isStrafeEnabled Property
keyboardRotationRatchet Property
primaryGamepadTrigger Property
useDefaultInputActions Property
OculusButton
Overview
Members
OculusButton Constructor
Properties
buttonType Property
isClicked Property
isHeld Property
isPressed Property
isPressedAndHeld Property
isRawClicked Property
isRawHeld Property
isRawPressed Property
isRawPressedAndHeld Property
isRawReleased Property
isReleased Property
Fields
buttonMask Field
controllerMask Field
rawButtonMask Field
OculusInputAxis
Overview
Members
OculusInputAxis Constructor
Methods
toggleAxis1D Method
toggleAxis2D Method
toggleRawAxis1D Method
toggleRawAxis2D Method
Properties
axis1D Property
axis2D Property
inputType Property
rawAxis1D Property
rawAxis2D Property
rawValue Property
rawValue2D Property
value Property
value2D Property
Fields
controllerMask Field
dimensions Field
OculusNearTouchButton
Overview
Members
OculusNearTouchButton Constructor
Fields
buttonMask Field
rawButtonMask Field
OculusTouchButton
Overview
Members
OculusTouchButton Constructor
Fields
buttonMask Field
rawButtonMask Field
PlayArea
Overview
Members
PlayArea Constructor
Methods
applyColliders Method
applyColorToOculusPlayArea Method
applySettingsToSteamPlayArea Method
applySteamPlayAreaSettings Method
calibratePlayArea Method
getDistance Method
getDistance(Vector3,Boolean,Boolean) Method
getDistance(Vector3,Vector3,Vector3,Boolean,Boolean) Method
getDistance(Boolean,Boolean) Method
isWithinBoundary Method
isWithinBoundary(Vector3) Method
isWithinBoundary(Vector3,Vector3,Vector3) Method
isWithinBoundary() Method
move Method
recenterOnAvatar Method
setDimensions Method
setDimensions(Vector2) Method
setDimensions(Single,Single) Method
setDimensions() Method
setMaterial Method
setParent Method
setPlayAreaSize Method
setPlayAreaSize(PlayAreaSize) Method
setPlayAreaSize(PlayAreaSize,Vector2) Method
setPlayAreaSize(Vector2) Method
setPlayAreaSize(List<Vector3>) Method
setVertices Method
Properties
depth Property
dimensions Property
height Property
isAvatarOutsideBoundary Property
isAvatarWithinBoundary Property
isVisible Property
size Property
width Property
Fields
borderThickness Field
color Field
cornerVertices Field
heightOffset Field
material Field
verticesList Field
PlayAreaManager
Overview
Members
PlayAreaManager Constructor
Methods
doesPlayAreaDisplayAtDistance Method
doesPlayAreaDisplayOnInputAction Method
doesPlayAreaDisplayOnInputAction() Method
doesPlayAreaDisplayOnInputAction(String) Method
getPlayAreaDimensions Method
setInputMoveTarget Method
setIsMovementBoundToPlayArea Method
setPlayArea Method
setPlayAreaBorderThickness Method
setPlayAreaColor Method
setPlayAreaDisplayOnApproachDistance Method
setPlayAreaDisplayOnInputAction Method
setPlayAreaDisplayTrigger Method
setPlayAreaMaterial Method
setPlayAreaSize Method
Properties
customPlayAreaDimensions Property
getHMDPlayAreaSize Property
getHMDPlayAreaVerticesList Property
getSteamPlayArea Property
getSteamPlayAreaTransform Property
hasHMDPlayArea Property
hasImmerseumPlayArea Property
hasOculusPlayArea Property
hasSteamPlayArea Property
Instance Property
isHMDPlayAreaSizeCalibrated Property
isMovementBoundToPlayArea Property
isPlayAreaDisplayedAlways Property
isPlayAreaDisplayedOnApproach Property
playArea Property
playAreaBorderThickness Property
playAreaColor Property
playAreaDisplayOnApproachDistance Property
playAreaDisplayOnInputAction Property
playAreaDisplayTrigger Property
playAreaMaterial Property
playAreaSize Property
shouldPlayAreaBeApplied Property
SplineTester
Overview
Members
SplineTester Constructor
SteamVRAxis
Overview
Members
SteamVRAxis Constructor
Properties
deviceIndex Property
dimensions Property
hasTracking Property
inputType Property
isCalibrating Property
isConnected Property
isOutOfRange Property
value2D Property
Fields
buttonMask Field
deviceRelation Field
SteamVRButton
Overview
Members
SteamVRButton Constructor
Properties
buttonType Property
deviceIndex Property
hasTracking Property
isCalibrating Property
isConnected Property
isHeld Property
isOutOfRange Property
isPressed Property
isReleased Property
Fields
buttonMask Field
deviceRelation Field
SteamVRHairTrigger
Overview
Members
SteamVRHairTrigger Constructor
Properties
isHeld Property
isPressed Property
isReleased Property
SteamVRTouch
Overview
Members
SteamVRTouch Constructor
Properties
isHeld Property
isPressed Property
isReleased Property
Enumerations
CameraRigPackages
ControllerPositions
Direction
Handedness
Hands
HeightTargets
hmdFamilies
InputMoveTarget
InputSources
InputType
PlayAreaDisplayTrigger
PlayAreaSize
PrimitiveType
Delegates
EventManager.disableVRSimulatorAction
EventManager.InitializeCameraRigEndAction
EventManager.InitializeControllersEndAction
EventManager.InitializePlayAreaAction
EventManager.InitializePlayAreaEndAction
EventManager.MoveAvatarEndAction
EventManager.MoveAvatarStartAction