Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Static Private Attributes
Leap::KeyTapGesture Class Reference

#include <Leap.h>

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

List of all members.

Public Member Functions

def __init__
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

Static Public Member Functions

static Type classType ()

Public Attributes

 this

Static Public Attributes

tuple class_type = staticmethod(LeapPython.KeyTapGesture_class_type)
tuple direction = _swig_property(LeapPython.KeyTapGesture_direction_get)
tuple pointable = _swig_property(LeapPython.KeyTapGesture_pointable_get)
tuple position = _swig_property(LeapPython.KeyTapGesture_position_get)
tuple progress = _swig_property(LeapPython.KeyTapGesture_progress_get)

Static Private Attributes

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

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

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

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 
)

Reimplemented from Leap::Gesture.

Definition at line 1053 of file Leap.py.


Member Function Documentation

static Type Leap::KeyTapGesture::classType ( ) [inline, static]

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.

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

The finger performing the key tap gesture.

Returns:
Pointable A Pointable object representing the tapping finger.
Since:
1.0

The position where the key tap is registered.

Returns:
Vector A Vector containing the coordinates of tap location.
Since:
1.0

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

Returns:
float The value 1.0.
Since:
1.0

Member Data Documentation

tuple Leap::KeyTapGesture::__getattr__ = lambdaself,name:_swig_getattr(self, KeyTapGesture, name) [static, private]

Reimplemented from Leap::Gesture.

Definition at line 1047 of file Leap.py.

Reimplemented from Leap::Gesture.

Definition at line 1048 of file Leap.py.

tuple Leap::KeyTapGesture::__setattr__ = lambdaself,name,value:_swig_setattr(self, KeyTapGesture, name, value) [static, private]

Reimplemented from Leap::Gesture.

Definition at line 1043 of file Leap.py.

Leap::KeyTapGesture::__swig_destroy__ = LeapPython.delete_KeyTapGesture [static, private]

Reimplemented from Leap::Gesture.

Definition at line 1071 of file Leap.py.

dictionary Leap::KeyTapGesture::__swig_getmethods__ = {} [static, private]

Reimplemented from Leap::Gesture.

Definition at line 1044 of file Leap.py.

dictionary Leap::KeyTapGesture::__swig_setmethods__ = {} [static, private]

Reimplemented from Leap::Gesture.

Definition at line 1040 of file Leap.py.

tuple Leap::KeyTapGesture::class_type = staticmethod(LeapPython.KeyTapGesture_class_type) [static]

Definition at line 1051 of file Leap.py.

tuple Leap::KeyTapGesture::direction = _swig_property(LeapPython.KeyTapGesture_direction_get) [static]

Definition at line 1064 of file Leap.py.

tuple Leap::KeyTapGesture::pointable = _swig_property(LeapPython.KeyTapGesture_pointable_get) [static]

Definition at line 1070 of file Leap.py.

tuple Leap::KeyTapGesture::position = _swig_property(LeapPython.KeyTapGesture_position_get) [static]

Definition at line 1061 of file Leap.py.

tuple Leap::KeyTapGesture::progress = _swig_property(LeapPython.KeyTapGesture_progress_get) [static]

Definition at line 1067 of file Leap.py.

Reimplemented from Leap::Gesture.

Definition at line 1053 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 Sat Jun 8 2019 18:47:25