Class TapGesture
Gesture for when the user performs a tap on the touch screen.
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit.AR
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
public class TapGesture : Gesture<TapGesture>Constructors
TapGesture(TapGestureRecognizer, Touch)
Initializes and returns an instance of TapGesture.
Declaration
public TapGesture(TapGestureRecognizer recognizer, Touch touch)Parameters
| Type | Name | Description |
|---|---|---|
| TapGestureRecognizer | recognizer | The gesture recognizer. |
| Touch | touch | The touch that started this gesture. |
TapGesture(TapGestureRecognizer, Touch)
Initializes and returns an instance of TapGesture.
Declaration
public TapGesture(TapGestureRecognizer recognizer, Touch touch)Parameters
| Type | Name | Description |
|---|---|---|
| TapGestureRecognizer | recognizer | The gesture recognizer. |
| Touch | touch | The touch that started this gesture. |
Properties
fingerId
(Read Only) The id of the finger used in this gesture.
Declaration
public int fingerId { get; }Property Value
| Type | Description |
|---|---|
| int |
startPosition
(Read Only) The screen position where the gesture started.
Declaration
public Vector2 startPosition { get; }Property Value
| Type | Description |
|---|---|
| Vector2 |
tapRecognizer
(Read Only) The gesture recognizer.
Declaration
protected TapGestureRecognizer tapRecognizer { get; }Property Value
| Type | Description |
|---|---|
| TapGestureRecognizer |
Methods
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. |