Class TwoFingerDragGesture

Gesture for when the user performs a two finger vertical swipe motion on the touch screen.

Inheritance

Object

Gesture<TwoFingerDragGesture>

TwoFingerDragGesture

Inherited Members

Gesture<TwoFingerDragGesture>.onStart

Gesture<TwoFingerDragGesture>.onUpdated

Gesture<TwoFingerDragGesture>.onFinished

Gesture<TwoFingerDragGesture>.isCanceled

Gesture<TwoFingerDragGesture>.targetObject

Gesture<TwoFingerDragGesture>.recognizer

Gesture<TwoFingerDragGesture>.WasCancelled

Gesture<TwoFingerDragGesture>.TargetObject

Gesture<TwoFingerDragGesture>.m_Recognizer

Gesture<TwoFingerDragGesture>.Complete()

Namespace: UnityEngine.XR.Interaction.Toolkit.AR

Syntax

public class TwoFingerDragGesture : Gesture<TwoFingerDragGesture>

Constructors

TwoFingerDragGesture(TwoFingerDragGestureRecognizer, InputSystem.EnhancedTouch.Touch, InputSystem.EnhancedTouch.Touch)

Constructs a two finger drag gesture.

Declaration

public TwoFingerDragGesture(TwoFingerDragGestureRecognizer recognizer, InputSystem.EnhancedTouch.Touch touch1, InputSystem.EnhancedTouch.Touch touch2)

Parameters

Type	Name	Description
TwoFingerDragGestureRecognizer	recognizer	The gesture recognizer.
InputSystem.EnhancedTouch.Touch	touch1	The first touch that started this gesture.
InputSystem.EnhancedTouch.Touch	touch2	The second touch that started this gesture.

TwoFingerDragGesture(TwoFingerDragGestureRecognizer, Touch, Touch)

Constructs a two finger drag gesture.

Declaration

public TwoFingerDragGesture(TwoFingerDragGestureRecognizer recognizer, Touch touch1, Touch touch2)

Parameters

Type	Name	Description
TwoFingerDragGestureRecognizer	recognizer	The gesture recognizer.
Touch	touch1	The first touch that started this gesture.
Touch	touch2	The second touch that started this gesture.

Properties

delta

(Read Only) The delta screen position of the gesture.

Declaration

public Vector2 delta { get; }

Property Value

Type	Description
Vector2

Delta

(Read Only) The delta screen position of the gesture.

Declaration

public Vector2 Delta { get; }

Property Value

Type	Description
Vector2

dragRecognizer

(Read Only) The gesture recognizer.

Declaration

protected TwoFingerDragGestureRecognizer dragRecognizer { get; }

Property Value

Type	Description
TwoFingerDragGestureRecognizer

fingerId1

(Read Only) The id of the first finger used in this gesture.

Declaration

public int fingerId1 { get; }

Property Value

Type	Description
Int32

FingerId1

(Read Only) The id of the first finger used in this gesture.

Declaration

public int FingerId1 { get; }

Property Value

Type	Description
Int32

fingerId2

(Read Only) The id of the second finger used in this gesture.

Declaration

public int fingerId2 { get; }

Property Value

Type	Description
Int32

FingerId2

(Read Only) The id of the second finger used in this gesture.

Declaration

public int FingerId2 { get; }

Property Value

Type	Description
Int32

position

(Read Only) The current screen position of the gesture.

Declaration

public Vector2 position { get; }

Property Value

Type	Description
Vector2

Position

(Read Only) The current screen position of the gesture.

Declaration

public Vector2 Position { get; }

Property Value

Type	Description
Vector2

startPosition1

(Read Only) The screen position of the first finger where the gesture started.

Declaration

public Vector2 startPosition1 { get; }

Property Value

Type	Description
Vector2

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

StartPosition2

(Read Only) The screen position of the second finger where the gesture started.

Declaration

public Vector2 StartPosition2 { get; }

Property Value

Type	Description
Vector2

Methods

CanStart()

Returns true if this gesture can start.

Declaration

protected override bool CanStart()

Returns

Type	Description
Boolean	Returns true if the gesture can start. Otherwise, returns false.

Overrides

UnityEngine.XR.Interaction.Toolkit.AR.Gesture<UnityEngine.XR.Interaction.Toolkit.AR.TwoFingerDragGesture>.CanStart()

OnCancel()

This method is called automatically when this gesture is canceled.

Declaration

protected override void OnCancel()

Overrides

UnityEngine.XR.Interaction.Toolkit.AR.Gesture<UnityEngine.XR.Interaction.Toolkit.AR.TwoFingerDragGesture>.OnCancel()

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

UnityEngine.XR.Interaction.Toolkit.AR.Gesture<UnityEngine.XR.Interaction.Toolkit.AR.TwoFingerDragGesture>.OnFinish()

OnStart()

This method is called automatically when this gesture is started.

Declaration

protected override void OnStart()

Overrides

UnityEngine.XR.Interaction.Toolkit.AR.Gesture<UnityEngine.XR.Interaction.Toolkit.AR.TwoFingerDragGesture>.OnStart()

UpdateGesture()

Updates this gesture.

Declaration

protected override bool UpdateGesture()

Returns

Type	Description
Boolean	Returns true if the update was successful. Otherwise, returns false.

Overrides

UnityEngine.XR.Interaction.Toolkit.AR.Gesture<UnityEngine.XR.Interaction.Toolkit.AR.TwoFingerDragGesture>.UpdateGesture()