#include <Leap.h>
Public Types | |
| enum | Joint { JOINT_MCP = 0, JOINT_PIP = 1, JOINT_DIP = 2, JOINT_TIP = 3 } |
| enum | Type { TYPE_THUMB = 0, TYPE_INDEX = 1, TYPE_MIDDLE = 2, TYPE_RING = 3, TYPE_PINKY = 4 } |
Public Member Functions | |
| def | __init__ |
| def | __str__ |
| def | bone |
| LEAP_EXPORT Bone | bone (Bone::Type boneIx) const |
| Finger (FingerImplementation *) | |
| LEAP_EXPORT | Finger () |
| LEAP_EXPORT | Finger (const Pointable &) |
| def | joint_position |
| LEAP_EXPORT Vector | jointPosition (Joint jointIx) const |
| std::string | toString () const |
| LEAP_EXPORT Type | type () const |
Static Public Member Functions | |
| static LEAP_EXPORT const Finger & | invalid () |
Public Attributes | |
| this | |
Static Public Attributes | |
| JOINT_DIP = LeapPython.Finger_JOINT_DIP | |
| JOINT_MCP = LeapPython.Finger_JOINT_MCP | |
| JOINT_PIP = LeapPython.Finger_JOINT_PIP | |
| JOINT_TIP = LeapPython.Finger_JOINT_TIP | |
| tuple | type = _swig_property(LeapPython.Finger_type_get) |
| TYPE_INDEX = LeapPython.Finger_TYPE_INDEX | |
| TYPE_MIDDLE = LeapPython.Finger_TYPE_MIDDLE | |
| TYPE_PINKY = LeapPython.Finger_TYPE_PINKY | |
| TYPE_RING = LeapPython.Finger_TYPE_RING | |
| TYPE_THUMB = LeapPython.Finger_TYPE_THUMB | |
Private Member Functions | |
| LEAP_EXPORT const char * | toCString () const |
Static Private Attributes | |
| tuple | __getattr__ = lambdaself,name:_swig_getattr(self, Finger, name) |
| __repr__ = _swig_repr | |
| tuple | __setattr__ = lambdaself,name,value:_swig_setattr(self, Finger, name, value) |
| __swig_destroy__ = LeapPython.delete_Finger | |
| dictionary | __swig_getmethods__ = {} |
| dictionary | __swig_setmethods__ = {} |
Detailed Description
The Finger class represents a tracked finger.
Fingers are Pointable objects that the Leap Motion software has classified as a finger. Get valid Finger objects from a Frame or a Hand object.
Fingers may be permanently associated to a hand. In this case the angular order of the finger IDs will be invariant. As fingers move in and out of view it is possible for the guessed ID of a finger to be incorrect. Consequently, it may be necessary for finger IDs to be exchanged. All tracked properties, such as velocity, will remain continuous in the API. However, quantities that are derived from the API output (such as a history of positions) will be discontinuous unless they have a corresponding ID exchange.
Note that Finger objects can be invalid, which means that they do not contain valid tracking data and do not correspond to a physical finger. Invalid Finger objects can be the result of asking for a Finger object using an ID from an earlier frame when no Finger objects with that ID exist in the current frame. A Finger object created from the Finger constructor is also invalid. Test for validity with the Finger::isValid() function.
- Since:
- 1.0
Member Enumeration Documentation
| enum Leap::Finger::Joint |
| enum Leap::Finger::Type |
Enumerates the names of the fingers.
Members of this enumeration are returned by Finger::type() to identify a Finger object.
- Since:
- 2.0
Constructor & Destructor Documentation
| Leap::Finger::Finger | ( | FingerImplementation * | ) |
| LEAP_EXPORT Leap::Finger::Finger | ( | const Pointable & | ) | [explicit] |
| def Leap::Finger::__init__ | ( | self, | |
| args | |||
| ) |
Member Function Documentation
| def Leap::Finger::__str__ | ( | self | ) |
Reimplemented from Leap::Pointable.
| def Leap::Finger::bone | ( | self, | |
| boneIx | |||
| ) |
| LEAP_EXPORT Bone Leap::Finger::bone | ( | Bone::Type | boneIx | ) | const |
The bone at a given bone index on this finger.
- Parameters:
-
boneIx An index value from the Bone::Type enumeration identifying the bone of interest.
- Returns:
- The Bone that has the specified bone type.
- Since:
- 2.0
| static LEAP_EXPORT const Finger& Leap::Finger::invalid | ( | ) | [static] |
Returns an invalid Finger object.
You can use the instance returned by this function in comparisons testing whether a given Finger instance is valid or invalid. (You can also use the Finger::isValid() function.)
- Returns:
- The invalid Finger instance.
- Since:
- 1.0
Reimplemented from Leap::Pointable.
| def Leap::Finger::joint_position | ( | self, | |
| jointIx | |||
| ) |
| LEAP_EXPORT Vector Leap::Finger::jointPosition | ( | Joint | jointIx | ) | const |
Deprecated as of version 2.0 Use 'bone' method instead.
| LEAP_EXPORT const char* Leap::Finger::toCString | ( | ) | const [private] |
Reimplemented from Leap::Pointable.
| std::string Leap::Finger::toString | ( | ) | const [inline] |
A string containing a brief, human readable description of the Finger object.
- Returns:
- A description of the Finger object as a string.
- Since:
- 1.0
Reimplemented from Leap::Pointable.
| LEAP_EXPORT Type Leap::Finger::type | ( | ) | const |
The name of this finger.
- Returns:
- The anatomical type of this finger as a member of the Finger::Type enumeration.
- Since:
- 2.0
Member Data Documentation
tuple Leap::Finger::__getattr__ = lambdaself,name:_swig_getattr(self, Finger, name) [static, private] |
Reimplemented from Leap::Pointable.
Leap::Finger::__repr__ = _swig_repr [static, private] |
Reimplemented from Leap::Pointable.
tuple Leap::Finger::__setattr__ = lambdaself,name,value:_swig_setattr(self, Finger, name, value) [static, private] |
Reimplemented from Leap::Pointable.
Leap::Finger::__swig_destroy__ = LeapPython.delete_Finger [static, private] |
Reimplemented from Leap::Pointable.
dictionary Leap::Finger::__swig_getmethods__ = {} [static, private] |
Reimplemented from Leap::Pointable.
dictionary Leap::Finger::__swig_setmethods__ = {} [static, private] |
Reimplemented from Leap::Pointable.
Leap::Finger::JOINT_DIP = LeapPython.Finger_JOINT_DIP [static] |
Leap::Finger::JOINT_MCP = LeapPython.Finger_JOINT_MCP [static] |
Leap::Finger::JOINT_PIP = LeapPython.Finger_JOINT_PIP [static] |
Leap::Finger::JOINT_TIP = LeapPython.Finger_JOINT_TIP [static] |
Reimplemented from Leap::Pointable.
tuple Leap::Finger::type = _swig_property(LeapPython.Finger_type_get) [static] |
Leap::Finger::TYPE_INDEX = LeapPython.Finger_TYPE_INDEX [static] |
Leap::Finger::TYPE_MIDDLE = LeapPython.Finger_TYPE_MIDDLE [static] |
Leap::Finger::TYPE_PINKY = LeapPython.Finger_TYPE_PINKY [static] |
Leap::Finger::TYPE_RING = LeapPython.Finger_TYPE_RING [static] |
Leap::Finger::TYPE_THUMB = LeapPython.Finger_TYPE_THUMB [static] |
The documentation for this class was generated from the following files: