-
-
Notifications
You must be signed in to change notification settings - Fork 992
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(Locomotion): add snap rotation touchpad control action
A new touchpad control action has been added that causes the controlled object to snap rotate around it's `up` vector based on the position of the touchpad axis. This provides a sudden change in rotation angle as opposed to the smooth angle change of the Rotate touchpad control action. It's also possible to provide a delay between each rotation and an optional fade/blink between each rotation to reduce nausia. This can be useful for rotating the play area for seated games.
- Loading branch information
1 parent
8b0a80b
commit c2669b0
Showing
4 changed files
with
172 additions
and
2 deletions.
There are no files selected for viewing
115 changes: 115 additions & 0 deletions
115
...ts/VRTK/Scripts/Locomotion/TouchpadControlActions/VRTK_SnapRotateTouchpadControlAction.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| // Snap Rotate Touchpad Control Action|TouchpadControlActions|25030 | ||
| namespace VRTK | ||
| { | ||
| using UnityEngine; | ||
|
|
||
| /// <summary> | ||
| /// The Snap Rotate Touchpad Control Action script is used to snap rotate the controlled GameObject around the up vector when changing the touchpad axis. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// The effect is a immediate snap rotation to quickly face in a new direction. | ||
| /// </remarks> | ||
| public class VRTK_SnapRotateTouchpadControlAction : VRTK_BaseTouchpadControlAction | ||
| { | ||
| [Tooltip("The angle to rotate for each snap.")] | ||
| public float anglePerSnap = 30f; | ||
| [Tooltip("The snap angle multiplier to be applied when the modifier button is pressed.")] | ||
| public float angleMultiplier = 1.5f; | ||
| [Tooltip("The amount of time required to pass before another snap rotation can be carried out.")] | ||
| public float snapDelay = 0.5f; | ||
| [Tooltip("The speed for the headset to fade out and back in. Having a blink between rotations can reduce nausia.")] | ||
| public float blinkTransitionSpeed = 0.6f; | ||
|
|
||
| private Collider centerCollider; | ||
| private Transform controlledTransform; | ||
| private Transform playArea; | ||
| private float snapDelayTimer = 0f; | ||
|
|
||
| /// <summary> | ||
| /// The ProcessFixedUpdate method is run for every FixedUpdate on the Touchpad Control script. | ||
| /// </summary> | ||
| /// <param name="controlledGameObject">The GameObject that is going to be affected.</param> | ||
| /// <param name="directionDevice">The device that is used for the direction.</param> | ||
| /// <param name="axisDirection">The axis that is being affected from the touchpad.</param> | ||
| /// <param name="axis">The value of the current touchpad touch point based across the axis direction.</param> | ||
| /// <param name="deadzone">The value of the deadzone based across the axis direction.</param> | ||
| /// <param name="currentlyFalling">Whether the controlled GameObject is currently falling.</param> | ||
| /// <param name="modifierActive">Whether the modifier button is pressed.</param> | ||
| public override void ProcessFixedUpdate(GameObject controlledGameObject, Transform directionDevice, Vector3 axisDirection, float axis, float deadzone, bool currentlyFalling, bool modifierActive) | ||
| { | ||
| if (snapDelayTimer < Time.timeSinceLevelLoad) | ||
| { | ||
| float angle = Rotate(axis, modifierActive); | ||
| if (angle != 0f) | ||
| { | ||
| Blink(); | ||
| RotateAroundPlayer(controlledGameObject, angle); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| protected virtual void OnEnable() | ||
| { | ||
| playArea = VRTK_DeviceFinder.PlayAreaTransform(); | ||
| } | ||
|
|
||
| protected virtual void RotateAroundPlayer(GameObject controlledGameObject, float angle) | ||
| { | ||
| Vector3 objectCenter = GetObjectCenter(controlledGameObject.transform); | ||
| Vector3 objectPosition = controlledGameObject.transform.TransformPoint(objectCenter); | ||
| controlledGameObject.transform.Rotate(Vector3.up, angle); | ||
| objectPosition -= controlledGameObject.transform.TransformPoint(objectCenter); | ||
| controlledGameObject.transform.position += objectPosition; | ||
| } | ||
|
|
||
| protected virtual float Rotate(float axis, bool modifierActive) | ||
| { | ||
| snapDelayTimer = Time.timeSinceLevelLoad + snapDelay; | ||
| int axisDirection = 0; | ||
| if (axis < 0) | ||
| { | ||
| axisDirection = -1; | ||
| } | ||
| else if (axis > 0) | ||
| { | ||
| axisDirection = 1; | ||
| } | ||
| return (anglePerSnap * (modifierActive ? angleMultiplier : 1)) * axisDirection; | ||
| } | ||
|
|
||
| protected virtual void Blink() | ||
| { | ||
| if (blinkTransitionSpeed > 0f) | ||
| { | ||
| VRTK_SDK_Bridge.HeadsetFade(Color.black, 0); | ||
| Invoke("ReleaseBlink", 0.01f); | ||
| } | ||
| } | ||
|
|
||
| protected virtual void ReleaseBlink() | ||
| { | ||
| VRTK_SDK_Bridge.HeadsetFade(Color.clear, blinkTransitionSpeed); | ||
| } | ||
|
|
||
| protected virtual Vector3 GetObjectCenter(Transform checkObject) | ||
| { | ||
| if (centerCollider == null || checkObject != controlledTransform) | ||
| { | ||
| controlledTransform = checkObject; | ||
|
|
||
| if (checkObject == playArea) | ||
| { | ||
| CapsuleCollider playAreaCollider = playArea.GetComponent<CapsuleCollider>(); | ||
| centerCollider = playAreaCollider; | ||
| return playAreaCollider.center; | ||
| } | ||
| else | ||
| { | ||
| centerCollider = checkObject.GetComponent<Collider>(); | ||
| } | ||
| } | ||
|
|
||
| return Vector3.zero; | ||
| } | ||
| } | ||
| } |
12 changes: 12 additions & 0 deletions
12
...TK/Scripts/Locomotion/TouchpadControlActions/VRTK_SnapRotateTouchpadControlAction.cs.meta
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters