Leap::ScreenTapGesture Class Reference

#include <Leap.h>

Inheritance diagram for Leap::ScreenTapGesture:

List of all members.

Public Member Functions
def	__init__
LEAP_EXPORT Vector	direction () const
LEAP_EXPORT Pointable	pointable () const
LEAP_EXPORT Vector	position () const
LEAP_EXPORT float	progress () const
LEAP_EXPORT	ScreenTapGesture ()
LEAP_EXPORT	ScreenTapGesture (const Gesture &rhs)
Static Public Member Functions
static Type	classType ()
Public Attributes
	this
Static Public Attributes
tuple	class_type = staticmethod(LeapPython.ScreenTapGesture_class_type)
tuple	direction = _swig_property(LeapPython.ScreenTapGesture_direction_get)
tuple	pointable = _swig_property(LeapPython.ScreenTapGesture_pointable_get)
tuple	position = _swig_property(LeapPython.ScreenTapGesture_position_get)
tuple	progress = _swig_property(LeapPython.ScreenTapGesture_progress_get)
Static Private Attributes
tuple	__getattr__ = lambdaself,name:_swig_getattr(self, ScreenTapGesture, name)
	__repr__ = _swig_repr
tuple	__setattr__ = lambdaself,name,value:_swig_setattr(self, ScreenTapGesture, name, value)
	__swig_destroy__ = LeapPython.delete_ScreenTapGesture
dictionary	__swig_getmethods__ = {}
dictionary	__swig_setmethods__ = {}

---

Detailed Description

The ScreenTapGesture class represents a tapping gesture by a finger or tool.

A screen tap gesture is recognized when the tip of a finger pokes forward and then springs back to approximately the original position, as if tapping a vertical screen. The tapping finger must pause briefly before beginning the tap.

**Important:** To use screen tap gestures in your application, you must enable recognition of the screen tap gesture. You can enable recognition with:

ScreenTap gestures are discrete. The ScreenTapGesture object representing a tap always has the state, STATE_STOP. Only one ScreenTapGesture object is created for each screen tap gesture recognized.

You can set the minimum finger movement and velocity required for a movement to be recognized as a screen tap as well as adjust the detection window for evaluating the movement using the config attribute of a connected Controller object. Use the following keys to configure screen tap recognition:

==================================== ========== ============= ======= Key string Value type Default value Units ==================================== ========== ============= ======= Gesture.ScreenTap.MinForwardVelocity float 50 mm/s Gesture.ScreenTap.HistorySeconds float 0.1 s Gesture.ScreenTap.MinDistance float 5.0 mm ==================================== ========== ============= =======

The following example demonstrates how to set the screen 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 2393 of file Leap.h.

---

Constructor & Destructor Documentation

LEAP_EXPORT Leap::ScreenTapGesture::ScreenTapGesture

(

)

Constructs a new ScreenTapGesture object.

An uninitialized ScreenTapGesture object is considered invalid. Get valid instances of the ScreenTapGesture class from a Frame object.

Since:

1.0

LEAP_EXPORT Leap::ScreenTapGesture::ScreenTapGesture

(

const Gesture &

rhs

)

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

Parameters:

rhs	The Gesture instance to specialize. This Gesture instance must be a ScreenTapGesture object.

Since:

1.0

def Leap::ScreenTapGesture::__init__	(		self,
			args
	)

Reimplemented from Leap::Gesture.

Definition at line 1012 of file Leap.py.

---

Member Function Documentation

static Type Leap::ScreenTapGesture::classType

(

)

[inline, static]

The screen tap gesture type.

Returns:

Type The type value designating a screen tap gesture.

Since:

1.0

Definition at line 2404 of file Leap.h.

LEAP_EXPORT Vector Leap::ScreenTapGesture::direction

(

)

const

The direction of finger tip motion.

Returns:

Vector A unit direction vector.

Since:

1.0

LEAP_EXPORT Pointable Leap::ScreenTapGesture::pointable

(

)

const

The finger performing the screen tap gesture.

Returns:

Pointable A Pointable object representing the tapping finger.

Since:

1.0

LEAP_EXPORT Vector Leap::ScreenTapGesture::position

(

)

const

The position where the screen tap is registered.

Returns:

Vector A Vector containing the coordinates of screen tap location.

Since:

1.0

LEAP_EXPORT float Leap::ScreenTapGesture::progress

(

)

const

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

Returns:

float The value 1.0.

Since:

1.0

---

Member Data Documentation

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

Reimplemented from Leap::Gesture.

Definition at line 1006 of file Leap.py.

Leap::ScreenTapGesture::__repr__ = _swig_repr [static, private]

Reimplemented from Leap::Gesture.

Definition at line 1007 of file Leap.py.

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

Reimplemented from Leap::Gesture.

Definition at line 1002 of file Leap.py.

Leap::ScreenTapGesture::__swig_destroy__ = LeapPython.delete_ScreenTapGesture [static, private]

Reimplemented from Leap::Gesture.

Definition at line 1030 of file Leap.py.

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

Reimplemented from Leap::Gesture.

Definition at line 1003 of file Leap.py.

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

Reimplemented from Leap::Gesture.

Definition at line 999 of file Leap.py.

tuple Leap::ScreenTapGesture::class_type = staticmethod(LeapPython.ScreenTapGesture_class_type) [static]

Definition at line 1010 of file Leap.py.

tuple Leap::ScreenTapGesture::direction = _swig_property(LeapPython.ScreenTapGesture_direction_get) [static]

Definition at line 1023 of file Leap.py.

tuple Leap::ScreenTapGesture::pointable = _swig_property(LeapPython.ScreenTapGesture_pointable_get) [static]

Definition at line 1029 of file Leap.py.

tuple Leap::ScreenTapGesture::position = _swig_property(LeapPython.ScreenTapGesture_position_get) [static]

Definition at line 1020 of file Leap.py.

tuple Leap::ScreenTapGesture::progress = _swig_property(LeapPython.ScreenTapGesture_progress_get) [static]

Definition at line 1026 of file Leap.py.

Leap::ScreenTapGesture::this

Reimplemented from Leap::Gesture.

Definition at line 1012 of file Leap.py.

---

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

• Leap.h
• Leap.py