Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Static Private Attributes | List of all members
Leap::KeyTapGesture Class Reference

#include <Leap.h>

Inheritance diagram for Leap::KeyTapGesture:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, args)
 
LEAP_EXPORT Vector direction () const
 
LEAP_EXPORT KeyTapGesture ()
 
LEAP_EXPORT KeyTapGesture (const Gesture &rhs)
 
LEAP_EXPORT Pointable pointable () const
 
LEAP_EXPORT Vector position () const
 
LEAP_EXPORT float progress () const
 
- Public Member Functions inherited from Leap::Gesture
def __eq__ (self, rhs)
 
def __init__ (self, args)
 
def __ne__ (self, rhs)
 
def __str__ (self)
 
LEAP_EXPORT int64_t duration () const
 
LEAP_EXPORT float durationSeconds () const
 
LEAP_EXPORT Frame frame () const
 
 Gesture (GestureImplementation *)
 
LEAP_EXPORT Gesture ()
 
LEAP_EXPORT Gesture (const Gesture &rhs)
 
LEAP_EXPORT HandList hands () const
 
LEAP_EXPORT int32_t id () const
 
LEAP_EXPORT bool isValid () const
 
LEAP_EXPORT bool operator!= (const Gesture &rhs) const
 
LEAP_EXPORT bool operator== (const Gesture &rhs) const
 
LEAP_EXPORT PointableList pointables () const
 
LEAP_EXPORT State state () const
 
std::string toString () const
 
LEAP_EXPORT Type type () const
 
- Public Member Functions inherited from Leap::Interface
def __init__ (self, args, kwargs)
 

Static Public Member Functions

static Type classType ()
 
- Static Public Member Functions inherited from Leap::Gesture
static LEAP_EXPORT const Gestureinvalid ()
 

Public Attributes

 this
 
- Public Attributes inherited from Leap::Gesture
 this
 

Static Public Attributes

 class_type = staticmethod(LeapPython.KeyTapGesture_class_type)
 
 direction = _swig_property(LeapPython.KeyTapGesture_direction_get)
 
 pointable = _swig_property(LeapPython.KeyTapGesture_pointable_get)
 
 position = _swig_property(LeapPython.KeyTapGesture_position_get)
 
 progress = _swig_property(LeapPython.KeyTapGesture_progress_get)
 
- Static Public Attributes inherited from Leap::Gesture
 duration = _swig_property(LeapPython.Gesture_duration_get)
 
 duration_seconds = _swig_property(LeapPython.Gesture_duration_seconds_get)
 
 frame = _swig_property(LeapPython.Gesture_frame_get)
 
 hands = _swig_property(LeapPython.Gesture_hands_get)
 
 id = _swig_property(LeapPython.Gesture_id_get)
 
 is_valid = _swig_property(LeapPython.Gesture_is_valid_get)
 
 pointables = _swig_property(LeapPython.Gesture_pointables_get)
 
 state = _swig_property(LeapPython.Gesture_state_get)
 
 STATE_INVALID = LeapPython.Gesture_STATE_INVALID
 
 STATE_START = LeapPython.Gesture_STATE_START
 
 STATE_STOP = LeapPython.Gesture_STATE_STOP
 
 STATE_UPDATE = LeapPython.Gesture_STATE_UPDATE
 
 type = _swig_property(LeapPython.Gesture_type_get)
 
 TYPE_CIRCLE = LeapPython.Gesture_TYPE_CIRCLE
 
 TYPE_INVALID = LeapPython.Gesture_TYPE_INVALID
 
 TYPE_KEY_TAP = LeapPython.Gesture_TYPE_KEY_TAP
 
 TYPE_SCREEN_TAP = LeapPython.Gesture_TYPE_SCREEN_TAP
 
 TYPE_SWIPE = LeapPython.Gesture_TYPE_SWIPE
 

Static Private Attributes

 __getattr__ = lambdaself,name:_swig_getattr(self, KeyTapGesture, name)
 
 __repr__ = _swig_repr
 
 __setattr__ = lambdaself,name,value:_swig_setattr(self, KeyTapGesture, name, value)
 
 __swig_destroy__ = LeapPython.delete_KeyTapGesture
 
dictionary __swig_getmethods__ = {}
 
dictionary __swig_setmethods__ = {}
 

Additional Inherited Members

- Public Types inherited from Leap::Gesture
enum  State { STATE_INVALID = -1, STATE_START = 1, STATE_UPDATE = 2, STATE_STOP = 3 }
 
enum  Type {
  TYPE_INVALID = -1, TYPE_SWIPE = 1, TYPE_CIRCLE = 4, TYPE_SCREEN_TAP = 5,
  TYPE_KEY_TAP = 6
}
 
- Protected Member Functions inherited from Leap::Interface
template<typename T >
T * get () const
 
LEAP_EXPORT Interface (void *owner)
 
LEAP_EXPORT Interface (Implementation *reference, void *owner)
 
LEAP_EXPORT Interface (const Interface &rhs)
 
 Interface (class SharedObject *object)
 
LEAP_EXPORT Interfaceoperator= (const Interface &rhs)
 
virtual LEAP_EXPORT ~Interface ()
 
- Static Protected Member Functions inherited from Leap::Interface
static LEAP_EXPORT void deleteCString (const char *cstr)
 
- Protected Attributes inherited from Leap::Interface
class SharedObject * m_object
 

Detailed Description

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 position, as if tapping. The tapping finger must pause briefly before beginning the tap.

Leap_Gesture_Tap.png

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 3.0 mm ==================================== ========== ============= =======

The following example demonstrates how to set the key tap configuration parameters:

The Controller object must be connected to the Leap Motion service/daemon before setting the configuration parameters.

Since
1.0

Definition at line 2509 of file Leap.h.

Constructor & Destructor Documentation

LEAP_EXPORT 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.

Since
1.0
LEAP_EXPORT Leap::KeyTapGesture::KeyTapGesture ( const Gesture rhs)

Constructs a KeyTapGesture object from an instance of the Gesture class.

Parameters
rhsThe Gesture instance to specialize. This Gesture instance must be a KeyTapGesture object.
Since
1.0
def Leap.KeyTapGesture.__init__ (   self,
  args 
)

Definition at line 1053 of file Leap.py.

Member Function Documentation

static Type Leap::KeyTapGesture::classType ( )
inlinestatic

The key tap gesture type.

Returns
Type The type value designating a key tap gesture.
Since
1.0

Definition at line 2520 of file Leap.h.

LEAP_EXPORT Vector Leap::KeyTapGesture::direction ( ) const

The direction of finger tip motion.

Returns
Vector A unit direction vector if the finger tip is moving; otherwise, a zero-vector.
Since
1.0
LEAP_EXPORT Pointable Leap::KeyTapGesture::pointable ( ) const

The finger performing the key tap gesture.

Returns
Pointable A Pointable object representing the tapping finger.
Since
1.0
LEAP_EXPORT Vector Leap::KeyTapGesture::position ( ) const

The position where the key tap is registered.

Returns
Vector A Vector containing the coordinates of tap location.
Since
1.0
LEAP_EXPORT float Leap::KeyTapGesture::progress ( ) const

The progress value is always 1.0 for a key tap gesture.

Returns
float The value 1.0.
Since
1.0

Member Data Documentation

Leap.KeyTapGesture.__getattr__ = lambdaself,name:_swig_getattr(self, KeyTapGesture, name)
staticprivate

Definition at line 1047 of file Leap.py.

Leap.KeyTapGesture.__repr__ = _swig_repr
staticprivate

Definition at line 1048 of file Leap.py.

Leap.KeyTapGesture.__setattr__ = lambdaself,name,value:_swig_setattr(self, KeyTapGesture, name, value)
staticprivate

Definition at line 1043 of file Leap.py.

Leap.KeyTapGesture.__swig_destroy__ = LeapPython.delete_KeyTapGesture
staticprivate

Definition at line 1071 of file Leap.py.

dictionary Leap.KeyTapGesture.__swig_getmethods__ = {}
staticprivate

Definition at line 1044 of file Leap.py.

dictionary Leap.KeyTapGesture.__swig_setmethods__ = {}
staticprivate

Definition at line 1040 of file Leap.py.

Leap.KeyTapGesture.class_type = staticmethod(LeapPython.KeyTapGesture_class_type)
static

Definition at line 1051 of file Leap.py.

Leap.KeyTapGesture.direction = _swig_property(LeapPython.KeyTapGesture_direction_get)
static

Definition at line 1064 of file Leap.py.

Leap.KeyTapGesture.pointable = _swig_property(LeapPython.KeyTapGesture_pointable_get)
static

Definition at line 1070 of file Leap.py.

Leap.KeyTapGesture.position = _swig_property(LeapPython.KeyTapGesture_position_get)
static

Definition at line 1061 of file Leap.py.

Leap.KeyTapGesture.progress = _swig_property(LeapPython.KeyTapGesture_progress_get)
static

Definition at line 1067 of file Leap.py.

Leap.KeyTapGesture.this

Definition at line 1058 of file Leap.py.


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


leap_motion
Author(s): Florian Lier , Mirza Shah , Isaac IY Saito
autogenerated on Tue Jun 2 2020 03:58:01