Long-Press gesture: detects when the finger is held down without moving, for a specific duration More...
Inherits AveragedGestureRecognizer.
Public Attributes | |
| float | Duration = 1.0f |
| How long the finger must stay down without moving in order to validate the gesture More... | |
| float | MoveTolerance = 5.0f |
| How far the finger is allowed to move around its starting position without breaking the gesture More... | |
 Public Attributes inherited from AveragedGestureRecognizer | |
| int | RequiredFingerCount = 1 |
| Exact number of touches required for the gesture to be recognized More... | |
| Public Attributes inherited from GestureRecognizer | |
| GestureResetMode | ResetMode = GestureResetMode.StartOfTouchSequence |
| Get or set the reset mode for this gesture recognizer More... | |
Protected Member Functions | |
| override void | OnBegin (FingerGestures.IFingerList touches) |
| Method called when the gesture recognizer has just started recognizing a valid gesture More... | |
| override GestureState | OnActive (FingerGestures.IFingerList touches) |
| Method called on each frame that the gesture recognizer is in an active state More... | |
| void | RaiseOnLongPress () |
| Protected Member Functions inherited from AveragedGestureRecognizer | |
| override int | GetRequiredFingerCount () |
| Return the exact number of active touches required for the gesture to be valid More... | |
| Protected Member Functions inherited from GestureRecognizer | |
| virtual void | Reset () |
| Put back the gesture recognizer in Ready state and reset any relevant data ResetMode More... | |
| override void | Start () |
| virtual void | OnTouchSequenceStarted () |
| Called when the first finger of a new multi-touch sequence has touched the screen More... | |
| virtual void | OnTouchSequenceEnded () |
| Called when all the fingers that participated in the current multi-touch sequence are no longer touching the screen More... | |
| override void | OnUpdate (FingerGestures.IFingerList touches) |
| This is called after FingerGestures has updated the state of each finger More... | |
| virtual GestureState | OnReady (FingerGestures.IFingerList touches) |
| virtual bool | ShouldFailFromReady (FingerGestures.IFingerList touches) |
| virtual bool | CanBegin (FingerGestures.IFingerList touches) |
| This controls whether or not the gesture recognition should begin More... | |
| bool | Young (FingerGestures.IFingerList touches) |
| Check if all the touches in the list started recently More... | |
| Protected Member Functions inherited from FGComponent | |
| virtual void | Awake () |
| virtual void | OnEnable () |
| virtual void | OnDisable () |
Properties | |
| float | StartTime [get] |
| Time when the gesture last started More... | |
| Properties inherited from AveragedGestureRecognizer | |
| Vector2 | StartPosition [get, protected set] |
| Initial finger(s) position More... | |
| Vector2 | Position [get, protected set] |
| Current finger(s) position More... | |
| Properties inherited from GestureRecognizer | |
| GestureState | PreviousState [get] |
| Get the previous gesture state More... | |
| GestureState | State [get, protected set] |
| Get or set the current gesture state More... | |
| bool | IsActive [get] |
| Return true if the gesture recognition has started and is on-going State More... | |
| FingerGestures.ITouchFilter | TouchFilter [get, set] |
| Get or set the touch filter used to modify the list of active touches about to be processed by the gesture recognizer More... | |
Events | |
| EventDelegate< LongPressGestureRecognizer > | OnLongPress |
| Event fired when the the gesture is recognized More... | |
| Events inherited from GestureRecognizer | |
| EventDelegate< GestureRecognizer > | OnStateChanged |
| Event fired whenever the gesture recognizer state changes State PreviousState More... | |
Additional Inherited Members | |
| Public Types inherited from GestureRecognizer | |
| enum | GestureState { GestureState.Ready, GestureState.InProgress, GestureState.Failed, GestureState.Recognized } |
| Possible gesture states More... | |
| enum | GestureResetMode { GestureResetMode.NextFrame, GestureResetMode.EndOfTouchSequence, GestureResetMode.StartOfTouchSequence } |
| The reset mode determines when to reset a GestureRecognizer after it fails or succeed (GestureState.Failed or GestureState.Recognized) More... | |
| Public Member Functions inherited from GestureRecognizer | |
| virtual bool | CheckCanBeginDelegate (FingerGestures.IFingerList touches) |
| delegate bool | CanBeginDelegate (GestureRecognizer gr, FingerGestures.IFingerList touches) |
| void | SetCanBeginDelegate (CanBeginDelegate f) |
| CanBeginDelegate | GetCanBeginDelegate () |
| Public Member Functions inherited from FGComponent | |
| delegate void | EventDelegate< T > (T source) |
Detailed Description
Long-Press gesture: detects when the finger is held down without moving, for a specific duration
Member Function Documentation
§ OnActive()
|
protectedvirtual |
Method called on each frame that the gesture recognizer is in an active state
- Parameters
-
touches The active touches
- Returns
- The new state the gesture recognizer should be in
Implements GestureRecognizer.
§ OnBegin()
|
protectedvirtual |
Method called when the gesture recognizer has just started recognizing a valid gesture
- Parameters
-
touches The active touches
Implements GestureRecognizer.
§ RaiseOnLongPress()
|
protected |
Member Data Documentation
§ Duration
| float LongPressGestureRecognizer.Duration = 1.0f |
How long the finger must stay down without moving in order to validate the gesture
§ MoveTolerance
| float LongPressGestureRecognizer.MoveTolerance = 5.0f |
How far the finger is allowed to move around its starting position without breaking the gesture
Property Documentation
§ StartTime
|
get |
Time when the gesture last started
Event Documentation
§ OnLongPress
| EventDelegate<LongPressGestureRecognizer> LongPressGestureRecognizer.OnLongPress |
Event fired when the the gesture is recognized
The documentation for this class was generated from the following file:
- D:/workspace/Unity/MeshBaker/Assets/Plugins/FingerGestures/Components/LongPressGestureRecognizer.cs
