{"_id":"5b1f8576c2505d0003125442","category":{"_id":"5b1f8576c2505d0003125429","version":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-02-25T10:16:15.006Z","from_sync":false,"order":5,"slug":"object-control-actions","title":"Object Control Actions"},"project":"571fa55ca0acd42000af9545","parentDoc":null,"user":"571fa519db52d01700f5cf3d","version":{"_id":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":4,"forked_from":"594949e52be16d0026ec04cd","createdAt":"2017-06-20T16:14:29.816Z","releaseDate":"2017-06-20T16:14:29.816Z","categories":["5b1f8576c2505d0003125424","5b1f8576c2505d0003125425","5b1f8576c2505d0003125426","5b1f8576c2505d0003125427","5b1f8576c2505d0003125428","5b1f8576c2505d0003125429","5b1f8576c2505d000312542a","5b1f8576c2505d000312542b","5b1f8576c2505d000312542c","5b1f8576c2505d000312542d","5b1f8576c2505d000312542e","5b1f8576c2505d000312542f","5b1f8576c2505d0003125430","5b1f8576c2505d0003125431","5b1f8576c2505d0003125432","5b1f8576c2505d0003125433","5b1f8576c2505d0003125434","5b1f8576c2505d0003125435","5b1f8576c2505d0003125436","5b1f8576c2505d0003125437","5b1f8576c2505d0003125438","5b1f8aab9c683000032979e7","5b1f8b2f3073470003ffa5da","5b1f8bd9fd653400031d94f4","5b1f900bd4c5f000036b57bd"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Mangalica","version_clean":"3.3.0","version":"3.3.0"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-25T10:17:53.324Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"> extends [VRTK_BaseObjectControlAction](doc:vrtk_baseobjectcontrolaction)\n\n## Overview\n\nProvides the ability to snap rotate a GameObject through the world `y` axis in the scene by updating the Transform rotation in defined steps when the corresponding Object Control axis changes.\n\n  > The effect is a immediate snap rotation to quickly face in a new direction.\n\n**Required Components:**\n * `VRTK_ObjectControl` - The Object Control script to listen for the axis changes on.\n\n**Script Usage:**\n * Place the `VRTK_SnapRotateObjectControlAction` script on any active scene GameObject.\n * Link the required Object Control script to the `Object Control Script` parameter of this script.\n * Set the `Listen On Axis Change` parameter on this script to the axis change to affect with this movement type.\n\n## Inspector Parameters\n\n * **Angle Per Snap:** The angle to rotate for each snap.\n * **Angle Multiplier:** The snap angle multiplier to be applied when the modifier button is pressed.\n * **Snap Delay:** The amount of time required to pass before another snap rotation can be carried out.\n * **Blink Transition Speed:** The speed for the headset to fade out and back in. Having a blink between rotations can reduce nausia.\n * **Axis Threshold:** The threshold the listened axis needs to exceed before the action occurs. This can be used to limit the snap rotate to a single axis direction (e.g. pull down to flip rotate). The threshold is ignored if it is 0.\n\n## Example\n\n`VRTK/Examples/017_CameraRig_TouchpadWalking` has a collection of walls and slopes that can be traversed by the user with the touchpad. There is also an area that can only be traversed if the user is crouching.\n\nTo enable the Snap Rotate Object Control Action, ensure one of the `TouchpadControlOptions` children (located under the Controller script alias) has the `Snap Rotate` control script active.","excerpt":"","slug":"vrtk_snaprotateobjectcontrolaction","type":"basic","title":"VRTK_SnapRotateObjectControlAction"}

VRTK_SnapRotateObjectControlAction


> extends [VRTK_BaseObjectControlAction](doc:vrtk_baseobjectcontrolaction) ## Overview Provides the ability to snap rotate a GameObject through the world `y` axis in the scene by updating the Transform rotation in defined steps when the corresponding Object Control axis changes. > The effect is a immediate snap rotation to quickly face in a new direction. **Required Components:** * `VRTK_ObjectControl` - The Object Control script to listen for the axis changes on. **Script Usage:** * Place the `VRTK_SnapRotateObjectControlAction` script on any active scene GameObject. * Link the required Object Control script to the `Object Control Script` parameter of this script. * Set the `Listen On Axis Change` parameter on this script to the axis change to affect with this movement type. ## Inspector Parameters * **Angle Per Snap:** The angle to rotate for each snap. * **Angle Multiplier:** The snap angle multiplier to be applied when the modifier button is pressed. * **Snap Delay:** The amount of time required to pass before another snap rotation can be carried out. * **Blink Transition Speed:** The speed for the headset to fade out and back in. Having a blink between rotations can reduce nausia. * **Axis Threshold:** The threshold the listened axis needs to exceed before the action occurs. This can be used to limit the snap rotate to a single axis direction (e.g. pull down to flip rotate). The threshold is ignored if it is 0. ## Example `VRTK/Examples/017_CameraRig_TouchpadWalking` has a collection of walls and slopes that can be traversed by the user with the touchpad. There is also an area that can only be traversed if the user is crouching. To enable the Snap Rotate Object Control Action, ensure one of the `TouchpadControlOptions` children (located under the Controller script alias) has the `Snap Rotate` control script active.