TapGesture Class |
Recognizes a tap.
Inheritance HierarchySystemObject
Object
Component
Behaviour
MonoBehaviour
TouchScript.CoreDebuggableMonoBehaviour
TouchScript.GesturesGesture
TouchScript.GesturesTapGesture
Object
Component
Behaviour
MonoBehaviour
TouchScript.CoreDebuggableMonoBehaviour
TouchScript.GesturesGesture
TouchScript.GesturesTapGesture
Namespace: TouchScript.Gestures
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxC#
public class TapGesture : Gesture
The TapGesture type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TapGesture | Initializes a new instance of the TapGesture class |
Properties| Name | Description | |
|---|---|---|
 | ActivePointers |
Gets list of gesture's active pointers.
(Inherited from Gesture.) |
| CombinePointers |
Gets or sets the flag if pointers should be treated as a cluster.
|
| CombinePointersInterval |
Gets or sets time interval before gesture is recognized to combine all lifted pointers into a cluster to use its center as [!:ScreenPosition].
|
| DebugMode |
Gets or sets if this object should show its debug information.
(Inherited from DebuggableMonoBehaviour.) |
| Delegate |
Gets or sets an object implementing IGestureDelegate to be asked for gesture specific actions.
(Inherited from Gesture.) |
| DistanceLimit |
Gets or sets maximum distance for point cluster must move for the gesture to fail.
|
 | gestureManager |
Reference to global GestureManager.
(Inherited from Gesture.) |
| MaxPointers |
Gets or sets maximum number of pointers this gesture reacts to.
The gesture will not be recognized if it has more than MaxPointers pointers.
(Inherited from Gesture.) |
| MinPointers |
Gets or sets minimum number of pointers this gesture reacts to.
The gesture will not be recognized if it has less than MinPointers pointers.
(Inherited from Gesture.) |
| NormalizedScreenPosition |
Gets normalized screen position.
(Inherited from Gesture.) |
| NumberOfTapsRequired |
Gets or sets the number of taps required for the gesture to recognize.
|
| NumPointers |
Gets the number of active pointerss.
(Inherited from Gesture.) |
| pointersNumState |
The state of min/max number of pointers.
(Inherited from Gesture.) |
| PreviousNormalizedScreenPosition |
Gets previous screen position.
(Inherited from Gesture.) |
| PreviousScreenPosition |
Gets previous screen position.
(Inherited from Gesture.) |
| PreviousState |
Gets previous gesture state.
(Inherited from Gesture.) |
| RequireGestureToFail |
Gets or sets another gesture which must fail before this gesture can be recognized.
(Inherited from Gesture.) |
| ScreenPosition |
Gets current screen position.
(Inherited from Gesture.) |
| SendMessageTarget |
Gets or sets the target of Unity messages sent from this gesture.
(Inherited from Gesture.) |
| SendStateChangeEvents |
Gets or sets a value indicating whether state change events are broadcasted if UseUnityEvents is true.
(Inherited from Gesture.) |
| SendStateChangeMessages |
Gets or sets a value indicating whether state change events are broadcasted if UseSendMessage is true.
(Inherited from Gesture.) |
| State |
Gets current gesture state.
(Inherited from Gesture.) |
| TimeLimit |
Gets or sets maximum hold time before gesture fails.
|
| touchManager |
Reference to global TouchManager.
(Inherited from Gesture.) |
| UseSendMessage |
Gets or sets whether gesture should use Unity's SendMessage in addition to C# events.
(Inherited from Gesture.) |
| UseUnityEvents |
Gets or sets whether gesture should use Unity Events in addition to C# events.
(Inherited from Gesture.) |
Methods| Name | Description | |
|---|---|---|
| AddFriendlyGesture |
Adds a friendly gesture.
(Inherited from Gesture.) |
 | Awake | (Inherited from Gesture.) |
| CanBePreventedByGesture |
Determines whether this instance can be prevented by specified gesture.
(Inherited from Gesture.) |
| Cancel |
Cancels this gesture.
(Inherited from Gesture.) |
| Cancel(Boolean, Boolean) |
Cancels this gesture.
(Inherited from Gesture.) |
| CanPreventGesture |
Determines whether this instance can prevent the specified gesture.
(Inherited from Gesture.) |
| GetScreenPositionHitData |
Returns HitData for gesture's ScreenPosition, i.e. what is right beneath it.
(Inherited from Gesture.) |
| HasPointer |
Determines whether gesture controls a pointer.
(Inherited from Gesture.) |
| IsFriendly |
Checks if a gesture is friendly with this gesture.
(Inherited from Gesture.) |
| onBegan |
Called when state is changed to Began.
(Inherited from Gesture.) |
| onCancelled |
Called when state is changed to Cancelled.
(Inherited from Gesture.) |
| onChanged |
Called when state is changed to Changed.
(Inherited from Gesture.) |
| OnDestroy |
Unity OnDestroy handler.
(Inherited from Gesture.) |
| OnDisable |
Unity OnDisable handler.
(Inherited from Gesture.) |
| OnEnable |
Unity Start handler.
(Overrides GestureOnEnable.) |
| onFailed |
Called when state is changed to Failed.
(Inherited from Gesture.) |
| onIdle |
Called when state is changed to Idle.
(Inherited from Gesture.) |
| onPossible |
Called when state is changed to Possible.
(Inherited from Gesture.) |
| onRecognized |
Called when state is changed to Recognized.
(Overrides GestureonRecognized.) |
| pointersCancelled |
Called when pointers are cancelled.
(Inherited from Gesture.) |
| pointersPressed |
Called when new pointers appear.
(Overrides GesturepointersPressed(IListPointer).) |
| pointersReleased |
Called if pointers are removed.
(Overrides GesturepointersReleased(IListPointer).) |
| pointersUpdated |
Called for moved pointers.
(Overrides GesturepointersUpdated(IListPointer).) |
| reset |
Called to reset gesture state after it fails or recognizes.
(Overrides Gesturereset.) |
| setState |
Tries to change gesture state.
(Inherited from Gesture.) |
| ShouldBegin |
Specifies if gesture can begin or recognize.
(Inherited from Gesture.) |
| shouldCachePointerPosition |
Should the gesture cache this pointers to use it later in calculation of ScreenPosition.
(Overrides GestureshouldCachePointerPosition(Pointer).) |
| ShouldReceivePointer |
Specifies if gesture can receive this specific pointer point.
(Overrides GestureShouldReceivePointer(Pointer).) |
Events| Name | Description | |
|---|---|---|
 | Cancelled |
Occurs when gesture is cancelled.
(Inherited from Gesture.) |
| StateChanged |
Occurs when gesture changes state.
(Inherited from Gesture.) |
| Tapped |
Occurs when gesture is recognized.
|
Fields| Name | Description | |
|---|---|---|
 | activePointers |
Pointers the gesture currently owns and works with.
(Inherited from Gesture.) |
| basicEditor | (Inherited from Gesture.) |
| cachedPreviousScreenPosition |
Cached previous screen position.
Used to keep tap's position which can't be calculated from pointers when the gesture is recognized since all pointers are gone.
(Inherited from Gesture.) |
| cachedScreenPosition |
Cached screen position.
Used to keep tap's position which can't be calculated from pointers when the gesture is recognized since all pointers are gone.
(Inherited from Gesture.) |
| cachedTransform |
Cached transform of the parent object.
(Inherited from Gesture.) |
 | OnStateChange |
Occurs when gesture changes state.
(Inherited from Gesture.) |
| OnTap |
Unity event, occurs when gesture is recognized.
|
 | TAP_MESSAGE |
Message name when gesture is recognized
|
See Also