|
MeshBaker
|
The main interface to the FingerGestures library. More...
Inherits MonoBehaviour.
Inherited by MouseGestures, and TouchScreenGestures.
Classes | |
| class | DefaultComponentCreationFlags |
| class | DefaultComponents |
| This holds a reference to all the default components/gesture recognizers automatically created at initialization More... | |
| class | Finger |
| Finger More... | |
| class | FingerList |
| A finger list implementation with support for write access More... | |
| interface | IFingerList |
| Represent a read-only list of fingers, augmented with a bunch of utility methods More... | |
| interface | ITouchFilter |
| A touch filter can be used to alter the content of the input touches list initially given to each Gesture Recognizer More... | |
| class | SingleFingerFilter |
| A single-finger touch filter that: More... | |
Public Types | |
| enum | FingerPhase { FingerPhase.None, FingerPhase.Began, FingerPhase.Moved, FingerPhase.Stationary, FingerPhase.Ended } |
| Finger Phase More... | |
| enum | SwipeDirection { SwipeDirection.Right = 1 << 0, SwipeDirection.Left = 1 << 1, SwipeDirection.Up = 1 << 2, SwipeDirection.Down = 1 << 3, SwipeDirection.None = 0, SwipeDirection.All = Right | Left | Up | Down, SwipeDirection.Vertical = Up | Down, SwipeDirection.Horizontal = Right | Left } |
| Supported swipe gesture directions More... | |
Public Member Functions | |
| delegate void | FingerDownEventHandler (int fingerIndex, Vector2 fingerPos) |
| Delegate for the OnFingerDown event More... | |
| delegate void | FingerUpEventHandler (int fingerIndex, Vector2 fingerPos, float timeHeldDown) |
| Delegate for the OnFingerUp event More... | |
| delegate void | FingerStationaryBeginEventHandler (int fingerIndex, Vector2 fingerPos) |
| Delegate for the OnFingerStationaryBegin event More... | |
| delegate void | FingerStationaryEventHandler (int fingerIndex, Vector2 fingerPos, float elapsedTime) |
| Delegate for the OnFingerStationary event More... | |
| delegate void | FingerStationaryEndEventHandler (int fingerIndex, Vector2 fingerPos, float elapsedTime) |
| Delegate for the OnFingerStationaryEnd event More... | |
| delegate void | FingerMoveEventHandler (int fingerIndex, Vector2 fingerPos) |
| Delegate for the OnFingerMoveBegin, OnFingerMove, OnFingerMoveEnd events More... | |
| delegate void | FingerLongPressEventHandler (int fingerIndex, Vector2 fingerPos) |
| Delegate for the OnFingernLongPress event More... | |
| delegate void | FingerTapEventHandler (int fingerIndex, Vector2 fingerPos, int tapCount) |
| Delegate for the OnFingernTap event More... | |
| delegate void | FingerSwipeEventHandler (int fingerIndex, Vector2 startPos, SwipeDirection direction, float velocity) |
| Delegate for the OnFingernSwipe event More... | |
| delegate void | FingerDragBeginEventHandler (int fingerIndex, Vector2 fingerPos, Vector2 startPos) |
| Delegate for the OnFingernDragBegin event More... | |
| delegate void | FingerDragMoveEventHandler (int fingerIndex, Vector2 fingerPos, Vector2 delta) |
| Delegate for the OnFingernDragMove event More... | |
| delegate void | FingerDragEndEventHandler (int fingerIndex, Vector2 fingerPos) |
| Delegate for the OnFingernDragEnd event More... | |
| delegate void | LongPressEventHandler (Vector2 fingerPos) |
| Delegate for the OnLongPress event More... | |
| delegate void | TapEventHandler (Vector2 fingerPos, int tapCount) |
| Delegate for the OnTap event More... | |
| delegate void | SwipeEventHandler (Vector2 startPos, FingerGestures.SwipeDirection direction, float velocity) |
| Delegate for the OnSwipe event More... | |
| delegate void | DragBeginEventHandler (Vector2 fingerPos, Vector2 startPos) |
| Delegate for the OnDragBegin event More... | |
| delegate void | DragMoveEventHandler (Vector2 fingerPos, Vector2 delta) |
| Delegate for the OnDragMove event More... | |
| delegate void | DragEndEventHandler (Vector2 fingerPos) |
| Delegate for the OnDragEnd event More... | |
| delegate void | PinchEventHandler (Vector2 fingerPos1, Vector2 fingerPos2) |
| Delegate for the OnPinchBegin and OnPinchEnd events More... | |
| delegate void | PinchMoveEventHandler (Vector2 fingerPos1, Vector2 fingerPos2, float delta) |
| Delegate for the OnPinchMove event More... | |
| delegate void | RotationBeginEventHandler (Vector2 fingerPos1, Vector2 fingerPos2) |
| Delegate for the OnRotationBegin event More... | |
| delegate void | RotationMoveEventHandler (Vector2 fingerPos1, Vector2 fingerPos2, float rotationAngleDelta) |
| Delegate for the OnRotationMove event More... | |
| delegate void | RotationEndEventHandler (Vector2 fingerPos1, Vector2 fingerPos2, float totalRotationAngle) |
| Delegate for the OnRotationEnd event More... | |
| delegate void | FingersUpdatedEventDelegate () |
Static Public Member Functions | |
| static Finger | GetFinger (int index) |
| Get a finger by its index More... | |
| static SwipeDirection | GetSwipeDirection (Vector3 dir, float tolerance) |
| Extract a swipe direction from a direction vector and a tolerance percent More... | |
| static bool | AllFingersMoving (params Finger[] fingers) |
| Check if all the fingers in the list are moving More... | |
| static bool | FingersMovedInOppositeDirections (Finger finger0, Finger finger1, float minDOT) |
| Check if the input fingers are moving in opposite direction More... | |
| static float | SignedAngle (Vector2 from, Vector2 to) |
| returns signed angle in radians between "from" -> "to" More... | |
Public Attributes | |
| FingerGesturesPrefabs | defaultPrefabs |
| DefaultComponentCreationFlags | defaultCompFlags |
Protected Member Functions | |
| virtual void | OnEnable () |
| virtual void | Start () |
| virtual void | Update () |
| abstract FingerPhase | GetPhase (Finger finger) |
| Return the new phase of the finger for this frame More... | |
| abstract Vector2 | GetPosition (Finger finger) |
| Return the new position of the finger on the screen for this frame More... | |
Properties | |
| static FingerGestures | Instance [get] |
| Access to the FingerGestures singleton instance More... | |
| static IFingerList | Touches [get] |
| List of fingers currently touching the screen More... | |
| abstract int | MaxFingers [get] |
| Maximum number of simultaneous fingers supported More... | |
| static DefaultComponents | Defaults [get] |
| Get access to the default components / gesture recognizers More... | |
Events | |
| static FingerDownEventHandler | OnFingerDown |
Event fired when a finger's OnDown event fires
| |
| static FingerUpEventHandler | OnFingerUp |
Event fired when a finger's OnUp event fires
| |
| static FingerStationaryBeginEventHandler | OnFingerStationaryBegin |
Event fired when a finger's default motion detector OnStationaryBegin event fires
| |
| static FingerStationaryEventHandler | OnFingerStationary |
Event fired when a finger's default motion detector OnStationary event fires
| |
| static FingerStationaryEndEventHandler | OnFingerStationaryEnd |
Event fired when a finger's default motion detector OnStationaryEnd event fires
| |
| static FingerMoveEventHandler | OnFingerMoveBegin |
Event fired when a finger's default motion detector OnMoveBegin event fires
| |
| static FingerMoveEventHandler | OnFingerMove |
Event fired when a finger's default motion detector OnMove event fires
| |
| static FingerMoveEventHandler | OnFingerMoveEnd |
Event fired when a finger's default motion detector OnMoveEnd event fires
| |
| static FingerLongPressEventHandler | OnFingerLongPress |
| Event fired when a finger's long-press gesture recognizer OnLongPress event fires More... | |
| static FingerDragBeginEventHandler | OnFingerDragBegin |
Event fired when a finger's drag gesture recognizer OnDragBegin event fires
| |
| static FingerDragMoveEventHandler | OnFingerDragMove |
Event fired when a finger's drag gesture recognizer OnDragMove event fires
| |
| static FingerDragEndEventHandler | OnFingerDragEnd |
Event fired when a finger's drag gesture recognizer OnDragEnd event fires DragGestureRecognizer.OnDragEnd
| |
| static FingerTapEventHandler | OnFingerTap |
| Event fired when a finger's tap gesture recognizer OnTap event fires More... | |
| static FingerSwipeEventHandler | OnFingerSwipe |
| Event fired when a finger's swipe gesture recognizer OnSwipe event fires More... | |
| static LongPressEventHandler | OnLongPress |
| Event fired when the default long-press gesture recognizer OnLongPress event fires More... | |
| static DragBeginEventHandler | OnDragBegin |
| Event fired when the default drag gesture recognizer's OnDragBegin event fires More... | |
| static DragMoveEventHandler | OnDragMove |
| Event fired when the default drag gesture recognizer's OnDragMove event fires More... | |
| static DragEndEventHandler | OnDragEnd |
| Event fired when the default drag gesture recognizer's OnDragEnd event fires More... | |
| static TapEventHandler | OnTap |
| Event fired when the default tap gesture recognizer's OnTap event fires More... | |
| static SwipeEventHandler | OnSwipe |
| Event fired when the default swipe gesture recognizer's OnSwipe event fires More... | |
| static PinchEventHandler | OnPinchBegin |
| Event fired when the default pinch gesture recognizer's OnPinchBegin event fires More... | |
| static PinchMoveEventHandler | OnPinchMove |
| Event fired when the default pinch gesture recognizer's OnPinchMove event fires More... | |
| static PinchEventHandler | OnPinchEnd |
Event fired when the default pinch gesture recognizer's OnPinchEnd event fires
| |
| static RotationBeginEventHandler | OnRotationBegin |
Event fired when the default pinch gesture recognizer's OnRotationBegin event fires
| |
| static RotationMoveEventHandler | OnRotationMove |
Event fired when the default pinch gesture recognizer's OnRotationMove event fires
| |
| static RotationEndEventHandler | OnRotationEnd |
Event fired when the default pinch gesture recognizer's OnRotationEnd event fires
| |
| static DragBeginEventHandler | OnTwoFingerDragBegin |
| Event fired when the default two-finger drag gesture recognizer's OnDragBegin event fires More... | |
| static DragMoveEventHandler | OnTwoFingerDragMove |
| Event fired when the default two-finger drag gesture recognizer's OnDragMove event fires More... | |
| static DragEndEventHandler | OnTwoFingerDragEnd |
| Event fired when the default two-finger drag gesture recognizer's OnDragEnd event fires More... | |
| static TapEventHandler | OnTwoFingerTap |
| Event fired when the default two-finger tap gesture recognizer's OnTap event fires More... | |
| static SwipeEventHandler | OnTwoFingerSwipe |
| Event fired when the default two-finger tap gesture recognizer's OnSwipe event fires More... | |
| static LongPressEventHandler | OnTwoFingerLongPress |
| Event fired when the default two-finger long-press gesture recognizer's OnLongPress event fires More... | |
| static FingersUpdatedEventDelegate | OnFingersUpdated |
The main interface to the FingerGestures library.
Most of the methods are static because FingerGestures is meant to be a singleton.
|
strong |
Finger Phase
| Enumerator | |
|---|---|
| None | |
| Began | The finger just touched the screen |
| Moved | The finger just moved |
| Stationary | The finger is stationary |
| Ended | The finger was lifted off the screen |
|
strong |
|
static |
Check if all the fingers in the list are moving
| delegate void FingerGestures.DragBeginEventHandler | ( | Vector2 | fingerPos, |
| Vector2 | startPos | ||
| ) |
Delegate for the OnDragBegin event
| fingerPos | The current finger position on the screen |
| startPos | The initial screen position the gesture started from |
<remark>These two values can differ if the drag gesture recognizer's MoveThreshold is non-zero</remark>
| delegate void FingerGestures.DragEndEventHandler | ( | Vector2 | fingerPos | ) |
Delegate for the OnDragEnd event
| fingerPos | Current position of the finger on the screen |
| delegate void FingerGestures.DragMoveEventHandler | ( | Vector2 | fingerPos, |
| Vector2 | delta | ||
| ) |
Delegate for the OnDragMove event
| fingerPos | Current finger position on the screen |
| delta | How much the finger has moved since the last update. This is the difference between the previous finger position and the new one. |
| delegate void FingerGestures.FingerDownEventHandler | ( | int | fingerIndex, |
| Vector2 | fingerPos | ||
| ) |
Delegate for the OnFingerDown event
| fingerIndex | 0-based index uniquely indentifying a specific finger |
| fingerPos | Current position of the finger on the screen |
| delegate void FingerGestures.FingerDragBeginEventHandler | ( | int | fingerIndex, |
| Vector2 | fingerPos, | ||
| Vector2 | startPos | ||
| ) |
Delegate for the OnFingernDragBegin event
| fingerIndex | 0-based index uniquely indentifying a specific finger |
| fingerPos | Current position of the finger on the screen |
| startPos | The initial finger position on the screen. |
<remark>Since the finger has to move beyond a certain treshold distance (specified by the moveThreshold property) before the gesture registers as a drag motion, fingerPos and startPos are likely to be different if you specified a non-zero moveThreshold.</remark>
| delegate void FingerGestures.FingerDragEndEventHandler | ( | int | fingerIndex, |
| Vector2 | fingerPos | ||
| ) |
Delegate for the OnFingernDragEnd event
| fingerIndex | 0-based index uniquely indentifying a specific finger |
| fingerPos | Current position of the finger on the screen |
| delegate void FingerGestures.FingerDragMoveEventHandler | ( | int | fingerIndex, |
| Vector2 | fingerPos, | ||
| Vector2 | delta | ||
| ) |
Delegate for the OnFingernDragMove event
| fingerIndex | 0-based index uniquely indentifying a specific finger |
| fingerPos | Current position of the finger on the screen |
| delta | How much the finger has moved since the last update. This is the difference between the previous finger position and the new one. |
| delegate void FingerGestures.FingerLongPressEventHandler | ( | int | fingerIndex, |
| Vector2 | fingerPos | ||
| ) |
Delegate for the OnFingernLongPress event
| fingerIndex | 0-based index uniquely indentifying a specific finger |
| fingerPos | Current position of the finger on the screen |
| delegate void FingerGestures.FingerMoveEventHandler | ( | int | fingerIndex, |
| Vector2 | fingerPos | ||
| ) |
Delegate for the OnFingerMoveBegin, OnFingerMove, OnFingerMoveEnd events
| fingerIndex | 0-based index uniquely indentifying a specific finger |
| fingerPos | Current position of the finger on the screen |
|
static |
Check if the input fingers are moving in opposite direction
| delegate void FingerGestures.FingerStationaryBeginEventHandler | ( | int | fingerIndex, |
| Vector2 | fingerPos | ||
| ) |
Delegate for the OnFingerStationaryBegin event
| fingerIndex | 0-based index uniquely indentifying a specific finger |
| fingerPos | Current position of the finger on the screen |
| delegate void FingerGestures.FingerStationaryEndEventHandler | ( | int | fingerIndex, |
| Vector2 | fingerPos, | ||
| float | elapsedTime | ||
| ) |
Delegate for the OnFingerStationaryEnd event
| fingerIndex | 0-based index uniquely indentifying a specific finger |
| fingerPos | Current position of the finger on the screen |
| elapsedTime | How much time has elapsed, in seconds, since the last OnFingerStationaryBegin fired on this finger |
| delegate void FingerGestures.FingerStationaryEventHandler | ( | int | fingerIndex, |
| Vector2 | fingerPos, | ||
| float | elapsedTime | ||
| ) |
Delegate for the OnFingerStationary event
| fingerIndex | 0-based index uniquely indentifying a specific finger |
| fingerPos | Current position of the finger on the screen |
| elapsedTime | How much time has elapsed, in seconds, since the last OnFingerStationaryBegin fired on this finger |
| delegate void FingerGestures.FingersUpdatedEventDelegate | ( | ) |
| delegate void FingerGestures.FingerSwipeEventHandler | ( | int | fingerIndex, |
| Vector2 | startPos, | ||
| SwipeDirection | direction, | ||
| float | velocity | ||
| ) |
Delegate for the OnFingernSwipe event
| fingerIndex | 0-based index uniquely indentifying a specific finger |
| startPos | Initial position of the finger |
| direction | Direction of the swipe gesture |
| velocity | How quickly the finger has moved (in screen pixels per second) |
| delegate void FingerGestures.FingerTapEventHandler | ( | int | fingerIndex, |
| Vector2 | fingerPos, | ||
| int | tapCount | ||
| ) |
Delegate for the OnFingernTap event
| fingerIndex | 0-based index uniquely indentifying a specific finger |
| fingerPos | Current position of the finger on the screen |
| tapCount | How many times the user has consecutively tapped his finger at this location |
| delegate void FingerGestures.FingerUpEventHandler | ( | int | fingerIndex, |
| Vector2 | fingerPos, | ||
| float | timeHeldDown | ||
| ) |
Delegate for the OnFingerUp event
| fingerIndex | 0-based index uniquely indentifying a specific finger |
| fingerPos | Current position of the finger on the screen |
| timeHeldDown | How long the finger has been held down before getting released, in seconds |
|
static |
Get a finger by its index
|
protectedpure virtual |
Return the new phase of the finger for this frame
Implemented in TouchScreenGestures, and MouseGestures.
|
protectedpure virtual |
Return the new position of the finger on the screen for this frame
Implemented in TouchScreenGestures, and MouseGestures.
|
static |
Extract a swipe direction from a direction vector and a tolerance percent
| dir | The non-constrained direction vector. Must be normalized. |
| tolerance | Percentage of tolerance |
| delegate void FingerGestures.LongPressEventHandler | ( | Vector2 | fingerPos | ) |
Delegate for the OnLongPress event
| fingerPos | Screen position where the press occured |
|
protectedvirtual |
| delegate void FingerGestures.PinchEventHandler | ( | Vector2 | fingerPos1, |
| Vector2 | fingerPos2 | ||
| ) |
Delegate for the OnPinchBegin and OnPinchEnd events
| fingerPos1 | First finger screen position |
| fingerPos2 | Second finger screen position |
| delegate void FingerGestures.PinchMoveEventHandler | ( | Vector2 | fingerPos1, |
| Vector2 | fingerPos2, | ||
| float | delta | ||
| ) |
Delegate for the OnPinchMove event
| fingerPos1 | First finger screen position |
| fingerPos2 | Second finger screen position |
| delta | How much the distance between the two fingers has changed since the last update. A negative value means the two fingers got closer, while a positive value means they moved further apart |
| delegate void FingerGestures.RotationBeginEventHandler | ( | Vector2 | fingerPos1, |
| Vector2 | fingerPos2 | ||
| ) |
Delegate for the OnRotationBegin event
| fingerPos1 | First finger screen position |
| fingerPos2 | Second finger screen position |
| delegate void FingerGestures.RotationEndEventHandler | ( | Vector2 | fingerPos1, |
| Vector2 | fingerPos2, | ||
| float | totalRotationAngle | ||
| ) |
Delegate for the OnRotationEnd event
| fingerPos1 | First finger screen position |
| fingerPos2 | Second finger screen position |
| totalRotationAngle | Total rotation performed during the gesture, in degrees |
| delegate void FingerGestures.RotationMoveEventHandler | ( | Vector2 | fingerPos1, |
| Vector2 | fingerPos2, | ||
| float | rotationAngleDelta | ||
| ) |
Delegate for the OnRotationMove event
| fingerPos1 | First finger screen position |
| fingerPos2 | Second finger screen position |
| rotationAngleDelta | Angle difference, in degrees, since the last update. |
|
static |
returns signed angle in radians between "from" -> "to"
|
protectedvirtual |
Reimplemented in TouchScreenGestures, and MouseGestures.
| delegate void FingerGestures.SwipeEventHandler | ( | Vector2 | startPos, |
| FingerGestures.SwipeDirection | direction, | ||
| float | velocity | ||
| ) |
Delegate for the OnSwipe event
| startPos | Initial finger position when the swipe gesture started |
| direction | Direction of the swipe gesture |
| velocity | How quickly the finger has moved (in screen pixels per second) |
| delegate void FingerGestures.TapEventHandler | ( | Vector2 | fingerPos, |
| int | tapCount | ||
| ) |
Delegate for the OnTap event
| fingerPos | Screen position where the tap occured |
| tapCount | Number of conseuctive taps the user has performed at this location |
|
protectedvirtual |
Reimplemented in TouchScreenGestures.
| DefaultComponentCreationFlags FingerGestures.defaultCompFlags |
| FingerGesturesPrefabs FingerGestures.defaultPrefabs |
|
staticget |
Get access to the default components / gesture recognizers
|
staticget |
Access to the FingerGestures singleton instance
|
get |
Maximum number of simultaneous fingers supported
|
staticget |
List of fingers currently touching the screen
|
static |
Event fired when the default drag gesture recognizer's OnDragBegin event fires
|
static |
Event fired when the default drag gesture recognizer's OnDragEnd event fires
|
static |
Event fired when the default drag gesture recognizer's OnDragMove event fires
|
static |
Event fired when a finger's OnDown event fires
|
static |
Event fired when a finger's drag gesture recognizer OnDragBegin event fires
|
static |
Event fired when a finger's drag gesture recognizer OnDragEnd event fires DragGestureRecognizer.OnDragEnd
|
static |
Event fired when a finger's drag gesture recognizer OnDragMove event fires
|
static |
Event fired when a finger's long-press gesture recognizer OnLongPress event fires
|
static |
Event fired when a finger's default motion detector OnMove event fires
|
static |
Event fired when a finger's default motion detector OnMoveBegin event fires
|
static |
Event fired when a finger's default motion detector OnMoveEnd event fires
|
static |
Event fired when a finger's default motion detector OnStationary event fires
|
static |
Event fired when a finger's default motion detector OnStationaryBegin event fires
|
static |
Event fired when a finger's default motion detector OnStationaryEnd event fires
|
static |
|
static |
Event fired when a finger's swipe gesture recognizer OnSwipe event fires
|
static |
Event fired when a finger's tap gesture recognizer OnTap event fires
|
static |
Event fired when a finger's OnUp event fires
|
static |
Event fired when the default long-press gesture recognizer OnLongPress event fires
|
static |
Event fired when the default pinch gesture recognizer's OnPinchBegin event fires
|
static |
Event fired when the default pinch gesture recognizer's OnPinchEnd event fires
|
static |
Event fired when the default pinch gesture recognizer's OnPinchMove event fires
|
static |
Event fired when the default pinch gesture recognizer's OnRotationBegin event fires
|
static |
Event fired when the default pinch gesture recognizer's OnRotationEnd event fires
|
static |
Event fired when the default pinch gesture recognizer's OnRotationMove event fires
|
static |
Event fired when the default swipe gesture recognizer's OnSwipe event fires
|
static |
Event fired when the default tap gesture recognizer's OnTap event fires
|
static |
Event fired when the default two-finger drag gesture recognizer's OnDragBegin event fires
|
static |
Event fired when the default two-finger drag gesture recognizer's OnDragEnd event fires
|
static |
Event fired when the default two-finger drag gesture recognizer's OnDragMove event fires
|
static |
Event fired when the default two-finger long-press gesture recognizer's OnLongPress event fires
|
static |
Event fired when the default two-finger tap gesture recognizer's OnSwipe event fires
|
static |
Event fired when the default two-finger tap gesture recognizer's OnTap event fires
1.8.12