![]() |
Leap C++ API Reference
0.7.9
|
The KeyTapGesture class represents a tapping gesture by a finger or tool. More...
Inherits Leap::Gesture.
Public Member Functions | |
Vector | direction () const |
The direction of finger tip motion. | |
KeyTapGesture () | |
Constructs a new KeyTapGesture object. | |
KeyTapGesture (const Gesture &rhs) | |
Constructs a KeyTapGesture object from an instance of the Gesture class. | |
Pointable | pointable () const |
The finger performing the key tap gesture. | |
Vector | position () const |
The position where the key tap is registered. | |
float | progress () const |
The progess value is always 1.0 for a key tap gesture. | |
![]() | |
int64_t | duration () const |
The elapsed duration of the recognized movement up to the frame containing this Gesture object, in microseconds. | |
float | durationSeconds () const |
The elapsed duration in seconds. | |
Frame | frame () const |
The Frame containing this Gesture instance. | |
Gesture () | |
Constructs a new Gesture object. | |
Gesture (const Gesture &rhs) | |
Constructs a new copy of an Gesture object. | |
HandList | hands () const |
The list of hands associated with this Gesture, if any. | |
int32_t | id () const |
The gesture ID. | |
bool | isValid () const |
Reports whether this Gesture instance represents a valid Gesture. | |
bool | operator!= (const Gesture &rhs) const |
Compare Gesture object inequality. | |
bool | operator== (const Gesture &rhs) const |
Compare Gesture object equality. | |
PointableList | pointables () const |
The list of fingers and tools associated with this Gesture, if any. | |
State | state () const |
The gesture state. | |
std::string | toString () const |
A string containing a brief, human-readable description of this Gesture. | |
Type | type () const |
The gesture type. | |
Static Public Member Functions | |
static Type | classType () |
The key tap gesture type. | |
![]() | |
static const Gesture & | invalid () |
Returns an invalid Gesture object. | |
Additional Inherited Members | |
![]() | |
enum | State { STATE_INVALID = -1, STATE_START = 1, STATE_UPDATE = 2, STATE_STOP = 3 } |
The possible gesture states. More... | |
enum | Type { TYPE_INVALID = -1, TYPE_SWIPE = 1, TYPE_CIRCLE = 4, TYPE_SCREEN_TAP = 5, TYPE_KEY_TAP = 6 } |
The supported types of gestures. More... | |
The KeyTapGesture class represents a tapping gesture by a finger or tool.
A key tap gesture is recognized when the tip of a finger rotates down toward the palm and then springs back to approximately the original postion, as if tapping. The tapping finger must pause briefly before beginning the tap.
Important: To use key tap gestures in your application, you must enable recognition of the key tap gesture. You can enable recognition with:
Key tap gestures are discrete. The KeyTapGesture object representing a tap always has the state, STATE_STOP. Only one KeyTapGesture object is created for each key tap gesture recognized.
You can set the minimum finger movement and velocity required for a movement to be recognized as a key tap as well as adjust the detection window for evaluating the movement using the config attribute of a connected Controller object. Use the following configuration keys to configure key tap recognition:
Key string | Value type | Default value | Units |
---|---|---|---|
Gesture.KeyTap.MinDownVelocity | float | 50 | mm/s |
Gesture.KeyTap.HistorySeconds | float | 0.1 | s |
Gesture.KeyTap.MinDistance | float | 5.0 | mm |
The following example demonstrates how to set the key tap configuration parameters:
Leap::KeyTapGesture::KeyTapGesture | ( | ) |
Constructs a new KeyTapGesture object.
An uninitialized KeyTapGesture object is considered invalid. Get valid instances of the KeyTapGesture class from a Frame object.
Leap::KeyTapGesture::KeyTapGesture | ( | const Gesture & | rhs | ) |
Constructs a KeyTapGesture object from an instance of the Gesture class.
rhs | The Gesture instance to specialize. This Gesture instance must be a KeyTapGesture object. |
|
inlinestatic |
The key tap gesture type.
Vector Leap::KeyTapGesture::direction | ( | ) | const |
The direction of finger tip motion.
Pointable Leap::KeyTapGesture::pointable | ( | ) | const |
Vector Leap::KeyTapGesture::position | ( | ) | const |
float Leap::KeyTapGesture::progress | ( | ) | const |
The progess value is always 1.0 for a key tap gesture.