Class TwistGesture
Gesture for when the user performs a two-finger twist motion on the touch screen.
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit.AR
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
public class TwistGesture : Gesture<TwistGesture>Constructors
TwistGesture(TwistGestureRecognizer, Touch, Touch)
Initializes and returns an instance of TwistGesture.
Declaration
public TwistGesture(TwistGestureRecognizer recognizer, Touch touch1, Touch touch2)Parameters
| Type | Name | Description |
|---|---|---|
| TwistGestureRecognizer | recognizer | The gesture recognizer. |
| Touch | touch1 | The first touch that started this gesture. |
| Touch | touch2 | The second touch that started this gesture. |
TwistGesture(TwistGestureRecognizer, Touch, Touch)
Initializes and returns an instance of TwistGesture.
Declaration
public TwistGesture(TwistGestureRecognizer recognizer, Touch touch1, Touch touch2)Parameters
| Type | Name | Description |
|---|---|---|
| TwistGestureRecognizer | recognizer | The gesture recognizer. |
| Touch | touch1 | The first touch that started this gesture. |
| Touch | touch2 | The second touch that started this gesture. |
Properties
deltaRotation
(Read Only) The delta rotation of the gesture.
Declaration
public float deltaRotation { get; }Property Value
| Type | Description |
|---|---|
| float |
fingerId1
(Read Only) The id of the first finger used in this gesture.
Declaration
public int fingerId1 { get; }Property Value
| Type | Description |
|---|---|
| int |
fingerId2
(Read Only) The id of the second finger used in this gesture.
Declaration
public int fingerId2 { get; }Property Value
| Type | Description |
|---|---|
| int |
startPosition1
(Read Only) The screen position of the first finger where the gesture started.
Declaration
public Vector2 startPosition1 { get; }Property Value
| Type | Description |
|---|---|
| Vector2 |
startPosition2
(Read Only) The screen position of the second finger where the gesture started.
Declaration
public Vector2 startPosition2 { get; }Property Value
| Type | Description |
|---|---|
| Vector2 |
twistRecognizer
(Read Only) The gesture recognizer.
Declaration
protected TwistGestureRecognizer twistRecognizer { get; }Property Value
| Type | Description |
|---|---|
| TwistGestureRecognizer |
Methods
CalculateDeltaRotation(Vector2, Vector2, Vector2, Vector2)
Calculates a signed angle for how much to twist according to the movement of two touch positions.
Declaration
protected static float CalculateDeltaRotation(Vector2 currentPosition1, Vector2 currentPosition2, Vector2 previousPosition1, Vector2 previousPosition2)Parameters
| Type | Name | Description |
|---|---|---|
| Vector2 | currentPosition1 | Current position of the first touch. |
| Vector2 | currentPosition2 | Current position of the second touch. |
| Vector2 | previousPosition1 | Previous position of the first touch. |
| Vector2 | previousPosition2 | Previous position of the second touch. |
Returns
| Type | Description |
|---|---|
| float | A signed angle, in degrees, representing how much to rotate an interactable by according to the changes in the two positions passed in. |
CanStart()
Returns true if this gesture can start.
Declaration
protected override bool CanStart()Returns
| Type | Description |
|---|---|
| bool | Returns true if the gesture can start. Otherwise, returns false. |
Overrides
OnCancel()
This method is called automatically when this gesture is canceled.
Declaration
protected override void OnCancel()Overrides
Remarks
When canceled, this method is called right before OnFinish(), which is still invoked.
OnFinish()
This method is called automatically when this gesture is finished.
Declaration
protected override void OnFinish()Overrides
OnStart()
This method is called automatically when this gesture is started.
Declaration
protected override void OnStart()Overrides
UpdateGesture()
Updates this gesture.
Declaration
protected override bool UpdateGesture()Returns
| Type | Description |
|---|---|
| bool | Returns true if the update was successful. Otherwise, returns false. |