{"_id":"594949e92be16d0026ec0547","category":{"_id":"594949e62be16d0026ec04cf","version":"594949e52be16d0026ec04cd","project":"571fa55ca0acd42000af9545","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-07-31T16:56:01.612Z","from_sync":false,"order":1,"slug":"prefabs","title":"Prefabs"},"parentDoc":null,"user":"571fa519db52d01700f5cf3d","project":"571fa55ca0acd42000af9545","version":{"_id":"594949e52be16d0026ec04cd","project":"571fa55ca0acd42000af9545","__v":2,"createdAt":"2017-06-20T16:14:29.816Z","releaseDate":"2017-06-20T16:14:29.816Z","categories":["594949e62be16d0026ec04ce","594949e62be16d0026ec04cf","594949e62be16d0026ec04d0","594949e62be16d0026ec04d1","594949e62be16d0026ec04d2","594949e62be16d0026ec04d3","594949e62be16d0026ec04d4","594949e62be16d0026ec04d5","594949e62be16d0026ec04d6","594949e62be16d0026ec04d7","594949e62be16d0026ec04d8","594949e62be16d0026ec04d9","594949e62be16d0026ec04da","594949e62be16d0026ec04db","594949e62be16d0026ec04dc","594949e62be16d0026ec04dd","594949e62be16d0026ec04de","594949e62be16d0026ec04df","594949e62be16d0026ec04e0","594949e62be16d0026ec04e1","59497219f4a8980024dd0631"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Kunekune","version_clean":"3.2.0","version":"3.2.0"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-01T16:34:15.636Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"## Overview\n\nThe `VRSimulatorCameraRig` prefab is a mock Camera Rig set up that can be used to develop with VRTK without the need for VR Hardware.\n\nUse the mouse and keyboard to move around both play area and hands and interacting with objects without the need of a hmd or VR controls.\n\n## Inspector Parameters\n\n * **Show Control Hints:** Show control information in the upper left corner of the screen.\n * **Hide Hands At Switch:** Hide hands when disabling them.\n * **Reset Hands At Switch:** Reset hand position and rotation when enabling them.\n * **Mouse Movement Input:** Whether mouse movement always acts as input or requires a button press.\n * **Lock Mouse To View:** Lock the mouse cursor to the game window when the mouse movement key is pressed.\n * **Hand Move Multiplier:** Adjust hand movement speed.\n * **Hand Rotation Multiplier:** Adjust hand rotation speed.\n * **Player Move Multiplier:** Adjust player movement speed.\n * **Player Rotation Multiplier:** Adjust player rotation speed.\n * **Player Sprint Multiplier:** Adjust player sprint speed.\n * **Mouse Movement Key:** Key used to enable mouse input if a button press is required.\n * **Toggle Control Hints:** Key used to toggle control hints on/off.\n * **Change Hands:** Key used to switch between left and righ hand.\n * **Hands On Off:** Key used to switch hands On/Off.\n * **Rotation Position:** Key used to switch between positional and rotational movement.\n * **Change Axis:** Key used to switch between X/Y and X/Z axis.\n * **Distance Pickup Left:** Key used to distance pickup with left hand.\n * **Distance Pickup Right:** Key used to distance pickup with right hand.\n * **Distance Pickup Modifier:** Key used to enable distance pickup.\n * **Move Forward:** Key used to move forward.\n * **Move Left:** Key used to move to the left.\n * **Move Backward:** Key used to move backwards.\n * **Move Right:** Key used to move to the right.\n * **Sprint:** Key used to sprint.\n * **Trigger Alias:** Key used to simulate trigger button.\n * **Grip Alias:** Key used to simulate grip button.\n * **Touchpad Alias:** Key used to simulate touchpad button.\n * **Button One Alias:** Key used to simulate button one.\n * **Button Two Alias:** Key used to simulate button two.\n * **Start Menu Alias:** Key used to simulate start menu button.\n * **Touch Modifier:** Key used to switch between button touch and button press mode.\n * **Hair Touch Modifier:** Key used to switch between hair touch mode.\n\n## Class Variables\n\n * `public enum MouseInputMode` - Mouse input mode types\n  * `Always` - Mouse movement is always treated as mouse input.\n  * `RequiresButtonPress` - Mouse movement is only treated as movement when a button is pressed.\n\n## Class Methods\n\n### FindInScene/0\n\n  > `public static GameObject FindInScene()`\n\n  * Parameters\n   * _none_\n  * Returns\n   * `GameObject` - Returns the found `VRSimulatorCameraRig` GameObject if it is found. If it is not found then it prints a debug log error.\n\nThe FindInScene method is used to find the `VRSimulatorCameraRig` GameObject within the current scene.","excerpt":"","slug":"vr-simulator","type":"basic","title":"VR Simulator"}
## Overview The `VRSimulatorCameraRig` prefab is a mock Camera Rig set up that can be used to develop with VRTK without the need for VR Hardware. Use the mouse and keyboard to move around both play area and hands and interacting with objects without the need of a hmd or VR controls. ## Inspector Parameters * **Show Control Hints:** Show control information in the upper left corner of the screen. * **Hide Hands At Switch:** Hide hands when disabling them. * **Reset Hands At Switch:** Reset hand position and rotation when enabling them. * **Mouse Movement Input:** Whether mouse movement always acts as input or requires a button press. * **Lock Mouse To View:** Lock the mouse cursor to the game window when the mouse movement key is pressed. * **Hand Move Multiplier:** Adjust hand movement speed. * **Hand Rotation Multiplier:** Adjust hand rotation speed. * **Player Move Multiplier:** Adjust player movement speed. * **Player Rotation Multiplier:** Adjust player rotation speed. * **Player Sprint Multiplier:** Adjust player sprint speed. * **Mouse Movement Key:** Key used to enable mouse input if a button press is required. * **Toggle Control Hints:** Key used to toggle control hints on/off. * **Change Hands:** Key used to switch between left and righ hand. * **Hands On Off:** Key used to switch hands On/Off. * **Rotation Position:** Key used to switch between positional and rotational movement. * **Change Axis:** Key used to switch between X/Y and X/Z axis. * **Distance Pickup Left:** Key used to distance pickup with left hand. * **Distance Pickup Right:** Key used to distance pickup with right hand. * **Distance Pickup Modifier:** Key used to enable distance pickup. * **Move Forward:** Key used to move forward. * **Move Left:** Key used to move to the left. * **Move Backward:** Key used to move backwards. * **Move Right:** Key used to move to the right. * **Sprint:** Key used to sprint. * **Trigger Alias:** Key used to simulate trigger button. * **Grip Alias:** Key used to simulate grip button. * **Touchpad Alias:** Key used to simulate touchpad button. * **Button One Alias:** Key used to simulate button one. * **Button Two Alias:** Key used to simulate button two. * **Start Menu Alias:** Key used to simulate start menu button. * **Touch Modifier:** Key used to switch between button touch and button press mode. * **Hair Touch Modifier:** Key used to switch between hair touch mode. ## Class Variables * `public enum MouseInputMode` - Mouse input mode types * `Always` - Mouse movement is always treated as mouse input. * `RequiresButtonPress` - Mouse movement is only treated as movement when a button is pressed. ## Class Methods ### FindInScene/0 > `public static GameObject FindInScene()` * Parameters * _none_ * Returns * `GameObject` - Returns the found `VRSimulatorCameraRig` GameObject if it is found. If it is not found then it prints a debug log error. The FindInScene method is used to find the `VRSimulatorCameraRig` GameObject within the current scene.