Class DragGesture
Gesture for when the user performs a drag motion on the touch screen.
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit.AR
Syntax
public class DragGesture : Gesture<DragGesture>Constructors
DragGesture(DragGestureRecognizer, Touch)
Initializes and returns an instance of DragGesture.
Declaration
public DragGesture(DragGestureRecognizer recognizer, Touch touch)Parameters
| Type | Name | Description |
|---|---|---|
| DragGestureRecognizer | recognizer | The gesture recognizer. |
| Touch | touch | The touch that started this gesture. |
DragGesture(DragGestureRecognizer, Touch)
Initializes and returns an instance of DragGesture.
Declaration
public DragGesture(DragGestureRecognizer recognizer, Touch touch)Parameters
| Type | Name | Description |
|---|---|---|
| DragGestureRecognizer | recognizer | The gesture recognizer. |
| Touch | touch | The 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
[Obsolete("Delta has been deprecated. Use delta instead. (UnityUpgradable) -> delta")]
public Vector2 Delta { get; }Property Value
| Type | Description |
|---|---|
| Vector2 |
Remarks
Delta has been deprecated. Use delta instead.
dragRecognizer
(Read Only) The gesture recognizer.
Declaration
protected DragGestureRecognizer dragRecognizer { get; }Property Value
| Type | Description |
|---|---|
| DragGestureRecognizer |
fingerId
(Read Only) The id of the finger used in this gesture.
Declaration
public int fingerId { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
FingerId
(Read Only) The id of the finger used in this gesture.
Declaration
[Obsolete("FingerId has been deprecated. Use fingerId instead. (UnityUpgradable) -> fingerId")]
public int FingerId { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Remarks
FingerId has been deprecated. Use fingerId instead.
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
[Obsolete("Position has been deprecated. Use position instead. (UnityUpgradable) -> position")]
public Vector2 Position { get; }Property Value
| Type | Description |
|---|---|
| Vector2 |
Remarks
Position has been deprecated. Use position instead.
startPosition
(Read Only) The screen position where the gesture started.
Declaration
public Vector2 startPosition { get; }Property Value
| Type | Description |
|---|---|
| Vector2 |
StartPosition
(Read Only) The screen position where the gesture started.
Declaration
[Obsolete("StartPosition has been deprecated. Use startPosition instead. (UnityUpgradable) -> startPosition")]
public Vector2 StartPosition { get; }Property Value
| Type | Description |
|---|---|
| Vector2 |
Remarks
StartPosition has been deprecated. Use startPosition instead.
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
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 |
|---|---|
| Boolean | Returns true if the update was successful. Otherwise, returns false. |