{"__v":0,"_id":"58b15f33cd7f282500fb0c4b","category":{"version":"58796781cd4a9c37007c96ef","project":"571fa55ca0acd42000af9545","_id":"58796781cd4a9c37007c96fa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-01-01T17:04:07.774Z","from_sync":false,"order":12,"slug":"3d-controls","title":"3D Controls"},"parentDoc":null,"project":"571fa55ca0acd42000af9545","user":"571fa519db52d01700f5cf3d","version":{"__v":4,"_id":"58796781cd4a9c37007c96ef","project":"571fa55ca0acd42000af9545","createdAt":"2017-01-13T23:49:21.393Z","releaseDate":"2017-01-13T23:49:21.393Z","categories":["58796781cd4a9c37007c96f0","58796781cd4a9c37007c96f1","58796781cd4a9c37007c96f2","58796781cd4a9c37007c96f3","58796781cd4a9c37007c96f4","58796781cd4a9c37007c96f5","58796781cd4a9c37007c96f6","58796781cd4a9c37007c96f7","58796781cd4a9c37007c96f8","58796781cd4a9c37007c96f9","58796781cd4a9c37007c96fa","58796781cd4a9c37007c96fb","58796781cd4a9c37007c96fc","58796781cd4a9c37007c96fd","58796781cd4a9c37007c96fe","58796781cd4a9c37007c96ff","58796781cd4a9c37007c9700","58b157ca1756cf370022f90d","58b1596f5dae732f00adeca2","58b1605a5dae732f00adecb1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Mukota","version_clean":"3.1.0","version":"3.1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-25T10:40:51.843Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"> extends [VRTK_Control](doc:vrtk_control)\n\n## Overview\n\nAttaching the script to a game object will allow the user to interact with it as if it were a spinnable wheel.\n\nThe script will instantiate the required Rigidbody and Interactable components automatically in case they do not exist yet.\n\n## Inspector Parameters\n\n * **Connected To:** An optional game object to which the wheel will be connected. If the game object moves the wheel will follow along.\n * **Grab Type:** The grab attach mechanic to use. Track Object allows for rotations of the controller, Rotator Track allows for grabbing the wheel and spinning it.\n * **Detatch Distance:** The maximum distance the grabbing controller is away from the wheel before it is automatically released.\n * **Minimum Value:** The minimum value the wheel can be set to.\n * **Maximum Value:** The maximum value the wheel can be set to.\n * **Step Size:** The increments in which values can change.\n * **Snap To Step:** If this is checked then when the wheel is released, it will snap to the step rotation.\n * **Grabbed Friction:** The amount of friction the wheel will have when it is grabbed.\n * **Released Friction:** The amount of friction the wheel will have when it is released.\n * **Max Angle:** The maximum angle the wheel has to be turned to reach it's maximum value.\n * **Lock At Limits:** If this is checked then the wheel cannot be turned beyond the minimum and maximum value.\n\n## Example\n\n`VRTK/Examples/025_Controls_Overview` has a collection of wheels that can be rotated by grabbing with the controller and then rotating the controller in the desired direction.","excerpt":"","slug":"vrtk_wheel","type":"basic","title":"VRTK_Wheel"}
> extends [VRTK_Control](doc:vrtk_control) ## Overview Attaching the script to a game object will allow the user to interact with it as if it were a spinnable wheel. The script will instantiate the required Rigidbody and Interactable components automatically in case they do not exist yet. ## Inspector Parameters * **Connected To:** An optional game object to which the wheel will be connected. If the game object moves the wheel will follow along. * **Grab Type:** The grab attach mechanic to use. Track Object allows for rotations of the controller, Rotator Track allows for grabbing the wheel and spinning it. * **Detatch Distance:** The maximum distance the grabbing controller is away from the wheel before it is automatically released. * **Minimum Value:** The minimum value the wheel can be set to. * **Maximum Value:** The maximum value the wheel can be set to. * **Step Size:** The increments in which values can change. * **Snap To Step:** If this is checked then when the wheel is released, it will snap to the step rotation. * **Grabbed Friction:** The amount of friction the wheel will have when it is grabbed. * **Released Friction:** The amount of friction the wheel will have when it is released. * **Max Angle:** The maximum angle the wheel has to be turned to reach it's maximum value. * **Lock At Limits:** If this is checked then the wheel cannot be turned beyond the minimum and maximum value. ## Example `VRTK/Examples/025_Controls_Overview` has a collection of wheels that can be rotated by grabbing with the controller and then rotating the controller in the desired direction.