#include <Leap.h>
Public Member Functions | |
| def | __init__ |
| LEAP_EXPORT Vector | center () const |
| LEAP_EXPORT | CircleGesture () |
| LEAP_EXPORT | CircleGesture (const Gesture &rhs) |
| LEAP_EXPORT Vector | normal () const |
| LEAP_EXPORT Pointable | pointable () const |
| LEAP_EXPORT float | progress () const |
| LEAP_EXPORT float | radius () const |
Static Public Member Functions | |
| static Type | classType () |
Public Attributes | |
| this | |
Static Public Attributes | |
| tuple | center = _swig_property(LeapPython.CircleGesture_center_get) |
| tuple | class_type = staticmethod(LeapPython.CircleGesture_class_type) |
| tuple | normal = _swig_property(LeapPython.CircleGesture_normal_get) |
| tuple | pointable = _swig_property(LeapPython.CircleGesture_pointable_get) |
| tuple | progress = _swig_property(LeapPython.CircleGesture_progress_get) |
| tuple | radius = _swig_property(LeapPython.CircleGesture_radius_get) |
Static Private Attributes | |
| tuple | __getattr__ = lambdaself,name:_swig_getattr(self, CircleGesture, name) |
| __repr__ = _swig_repr | |
| tuple | __setattr__ = lambdaself,name,value:_swig_setattr(self, CircleGesture, name, value) |
| __swig_destroy__ = LeapPython.delete_CircleGesture | |
| dictionary | __swig_getmethods__ = {} |
| dictionary | __swig_setmethods__ = {} |
Detailed Description
The CircleGesture classes represents a circular finger movement.
A circle movement is recognized when the tip of a finger draws a circle within the Leap Motion Controller field of view.
**Important:** To use circle gestures in your application, you must enable recognition of the circle gesture. You can enable recognition with:
Circle gestures are continuous. The CircleGesture objects for the gesture have three possible states:
**State::STATE_START** -- The circle gesture has just started. The movement has progressed far enough for the recognizer to classify it as a circle.
**State::STATE_UPDATE** -- The circle gesture is continuing.
**State::STATE_STOP** -- The circle gesture is finished.
You can set the minimum radius and minimum arc length required for a movement to be recognized as a circle using the config attribute of a connected Controller object. Use the following keys to configure circle recognition:
==================================== ========== ============= ======= Key string Value type Default value Units ==================================== ========== ============= ======= Gesture.Circle.MinRadius float 5.0 mm Gesture.Circle.MinArc float 1.5 * pi radians ==================================== ========== ============= =======
The following example demonstrates how to set the circle configuration parameters:
The Controller object must be connected to the Leap Motion service/daemon before setting the configuration parameters.
- Since:
- 1.0
Constructor & Destructor Documentation
Constructs a new CircleGesture object.
An uninitialized CircleGesture object is considered invalid. Get valid instances of the CircleGesture class from a Frame object.
- Since:
- 1.0
| LEAP_EXPORT Leap::CircleGesture::CircleGesture | ( | const Gesture & | rhs | ) |
Constructs a CircleGesture object from an instance of the Gesture class.
- Parameters:
-
rhs The Gesture instance to specialize. This Gesture instance must be a CircleGesture object.
- Since:
- 1.0
| def Leap::CircleGesture::__init__ | ( | self, | |
| args | |||
| ) |
Reimplemented from Leap::Gesture.
Member Function Documentation
| LEAP_EXPORT Vector Leap::CircleGesture::center | ( | ) | const |
| static Type Leap::CircleGesture::classType | ( | ) | [inline, static] |
| LEAP_EXPORT Vector Leap::CircleGesture::normal | ( | ) | const |
Returns the normal vector for the circle being traced.
If you draw the circle clockwise, the normal vector points in the same general direction as the pointable object drawing the circle. If you draw the circle counterclockwise, the normal points back toward the pointable. If the angle between the normal and the pointable object drawing the circle is less than 90 degrees, then the circle is clockwise.
- Returns:
- Vector the normal vector for the circle being traced
- Since:
- 1.0
| LEAP_EXPORT float Leap::CircleGesture::progress | ( | ) | const |
The number of times the finger tip has traversed the circle.
Progress is reported as a positive number of the number. For example, a progress value of .5 indicates that the finger has gone halfway around, while a value of 3 indicates that the finger has gone around the the circle three times.
Progress starts where the circle gesture began. Since the circle must be partially formed before the Leap Motion software can recognize it, progress will be greater than zero when a circle gesture first appears in the frame.
- Returns:
- float A positive number indicating the gesture progress.
- Since:
- 1.0
| LEAP_EXPORT float Leap::CircleGesture::radius | ( | ) | const |
The radius of the circle.
- Returns:
- The circle radius in mm.
- Since:
- 1.0
Member Data Documentation
tuple Leap::CircleGesture::__getattr__ = lambdaself,name:_swig_getattr(self, CircleGesture, name) [static, private] |
Reimplemented from Leap::Gesture.
Leap::CircleGesture::__repr__ = _swig_repr [static, private] |
Reimplemented from Leap::Gesture.
tuple Leap::CircleGesture::__setattr__ = lambdaself,name,value:_swig_setattr(self, CircleGesture, name, value) [static, private] |
Reimplemented from Leap::Gesture.
Leap::CircleGesture::__swig_destroy__ = LeapPython.delete_CircleGesture [static, private] |
Reimplemented from Leap::Gesture.
dictionary Leap::CircleGesture::__swig_getmethods__ = {} [static, private] |
Reimplemented from Leap::Gesture.
dictionary Leap::CircleGesture::__swig_setmethods__ = {} [static, private] |
Reimplemented from Leap::Gesture.
tuple Leap::CircleGesture::center = _swig_property(LeapPython.CircleGesture_center_get) [static] |
tuple Leap::CircleGesture::class_type = staticmethod(LeapPython.CircleGesture_class_type) [static] |
tuple Leap::CircleGesture::normal = _swig_property(LeapPython.CircleGesture_normal_get) [static] |
tuple Leap::CircleGesture::pointable = _swig_property(LeapPython.CircleGesture_pointable_get) [static] |
tuple Leap::CircleGesture::progress = _swig_property(LeapPython.CircleGesture_progress_get) [static] |
tuple Leap::CircleGesture::radius = _swig_property(LeapPython.CircleGesture_radius_get) [static] |
Reimplemented from Leap::Gesture.
The documentation for this class was generated from the following files: