MeshBaker
Public Attributes | Protected Member Functions | Properties | Events | List of all members
DragGestureRecognizer Class Reference

Drag gesture: a full finger press > move > release sequence More...

Inherits AveragedGestureRecognizer.

Public Attributes

float MoveTolerance = 5.0f
 How far the finger is allowed to move from its initial position without making the gesture fail 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 bool CanBegin (FingerGestures.IFingerList touches)
 This controls whether or not the gesture recognition should begin More...
 
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 RaiseOnDragBegin ()
 
void RaiseOnDragMove ()
 
void RaiseOnDragEnd ()
 
- 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)
 
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

Vector2 MoveDelta [get]
 Amount of motion performed since the last update 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< DragGestureRecognizerOnDragBegin
 Event fired when the finger moved past its MoveTolerance radius from the StartPosition MoveTolerance StartPosition More...
 
EventDelegate< DragGestureRecognizerOnDragMove
 Event fired when the finger moved since the last update Use MoveDelta to retrieve the amount of motion performed since last update MoveDelta More...
 
EventDelegate< DragGestureRecognizerOnDragEnd
 Event fired when the dragged finger is released More...
 
- Events inherited from GestureRecognizer
EventDelegate< GestureRecognizerOnStateChanged
 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

Drag gesture: a full finger press > move > release sequence

Member Function Documentation

§ CanBegin()

override bool DragGestureRecognizer.CanBegin ( FingerGestures.IFingerList  touches)
protectedvirtual

This controls whether or not the gesture recognition should begin

Parameters
touchesThe active touches

Reimplemented from GestureRecognizer.

§ OnActive()

override GestureState DragGestureRecognizer.OnActive ( FingerGestures.IFingerList  touches)
protectedvirtual

Method called on each frame that the gesture recognizer is in an active state

Parameters
touchesThe active touches
Returns
The new state the gesture recognizer should be in

Implements GestureRecognizer.

§ OnBegin()

override void DragGestureRecognizer.OnBegin ( FingerGestures.IFingerList  touches)
protectedvirtual

Method called when the gesture recognizer has just started recognizing a valid gesture

Parameters
touchesThe active touches

Implements GestureRecognizer.

§ RaiseOnDragBegin()

void DragGestureRecognizer.RaiseOnDragBegin ( )
protected

§ RaiseOnDragEnd()

void DragGestureRecognizer.RaiseOnDragEnd ( )
protected

§ RaiseOnDragMove()

void DragGestureRecognizer.RaiseOnDragMove ( )
protected

Member Data Documentation

§ MoveTolerance

float DragGestureRecognizer.MoveTolerance = 5.0f

How far the finger is allowed to move from its initial position without making the gesture fail

Property Documentation

§ MoveDelta

Vector2 DragGestureRecognizer.MoveDelta
get

Amount of motion performed since the last update

Event Documentation

§ OnDragBegin

EventDelegate<DragGestureRecognizer> DragGestureRecognizer.OnDragBegin

Event fired when the finger moved past its MoveTolerance radius from the StartPosition MoveTolerance StartPosition

§ OnDragEnd

EventDelegate<DragGestureRecognizer> DragGestureRecognizer.OnDragEnd

Event fired when the dragged finger is released

§ OnDragMove

EventDelegate<DragGestureRecognizer> DragGestureRecognizer.OnDragMove

Event fired when the finger moved since the last update Use MoveDelta to retrieve the amount of motion performed since last update MoveDelta


The documentation for this class was generated from the following file: