Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Static Private Attributes
Leap::FingerList Class Reference

#include <Leap.h>

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

List of all members.

Public Types

typedef ConstListIterator
< FingerList, Finger
const_iterator

Public Member Functions

def __getitem__
def __init__
def __iter__
def __len__
def append
LEAP_EXPORT FingerListappend (const FingerList &other)
LEAP_EXPORT const_iterator begin () const
LEAP_EXPORT int count () const
LEAP_EXPORT const_iterator end () const
def extended
LEAP_EXPORT FingerList extended () const
def finger_type
 FingerList (const ListBaseImplementation< Finger > &)
LEAP_EXPORT FingerList ()
LEAP_EXPORT FingerList fingerType (Finger::Type type) const
LEAP_EXPORT Finger frontmost () const
LEAP_EXPORT bool isEmpty () const
LEAP_EXPORT Finger leftmost () const
LEAP_EXPORT Finger operator[] (int index) const
LEAP_EXPORT Finger rightmost () const

Public Attributes

 this

Static Public Attributes

tuple frontmost = _swig_property(LeapPython.FingerList_frontmost_get)
tuple is_empty = _swig_property(LeapPython.FingerList_is_empty_get)
tuple leftmost = _swig_property(LeapPython.FingerList_leftmost_get)
tuple rightmost = _swig_property(LeapPython.FingerList_rightmost_get)

Static Private Attributes

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

Detailed Description

The FingerList class represents a list of Finger objects.

Get a FingerList object by calling Frame::fingers().

Since:
1.0

Definition at line 3622 of file Leap.h.


Member Typedef Documentation

A C++ iterator type for FingerList objects.

Since:
1.0

Definition at line 3734 of file Leap.h.


Constructor & Destructor Documentation

Leap::FingerList::FingerList ( const ListBaseImplementation< Finger > &  )

Constructs an empty list of fingers.

Since:
1.0

Definition at line 1460 of file Leap.py.


Member Function Documentation

def Leap::FingerList::__getitem__ (   self,
  index 
)

Definition at line 1470 of file Leap.py.

Definition at line 1493 of file Leap.py.

def Leap::FingerList::__len__ (   self)

Definition at line 1467 of file Leap.py.

def Leap::FingerList::append (   self,
  other 
)

Definition at line 1473 of file Leap.py.

Appends the members of the specified FingerList to this FingerList.

Parameters:
otherA FingerList object containing Finger objects to append to the end of this FingerList.
Since:
1.0

The C++ iterator set to the beginning of this FingerList.

Since:
1.0

Returns the number of fingers in this list.

Returns:
The number of fingers in this list.
Since:
1.0

The C++ iterator set to the end of this FingerList.

Since:
1.0

Definition at line 1476 of file Leap.py.

Returns a new list containing those fingers in the current list that are extended.

Returns:
The list of extended fingers from the current list.
Since:
2.0
def Leap::FingerList::finger_type (   self,
  type 
)

Definition at line 1479 of file Leap.py.

Returns a list containing fingers from the current list of a given finger type by modifying the existing list.

Returns:
The list of matching fingers from the current list.
Since:
2.0

The member of the list that is farthest to the front within the standard Leap Motion frame of reference (i.e has the smallest Z coordinate).

Returns:
The frontmost finger, or invalid if list is empty.
Since:
1.0

Reports whether the list is empty.

Returns:
True, if the list has no members.
Since:
1.0

The member of the list that is farthest to the left within the standard Leap Motion frame of reference (i.e has the smallest X coordinate).

Returns:
The leftmost finger, or invalid if list is empty.
Since:
1.0
LEAP_EXPORT Finger Leap::FingerList::operator[] ( int  index) const

Access a list member by its position in the list.

Parameters:
indexThe zero-based list position index.
Returns:
The Finger object at the specified index.
Since:
1.0

The member of the list that is farthest to the right within the standard Leap Motion frame of reference (i.e has the largest X coordinate).

Returns:
The rightmost finger, or invalid if list is empty.
Since:
1.0

Member Data Documentation

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

Reimplemented from Leap::Interface.

Definition at line 1457 of file Leap.py.

Definition at line 1458 of file Leap.py.

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

Reimplemented from Leap::Interface.

Definition at line 1453 of file Leap.py.

Leap::FingerList::__swig_destroy__ = LeapPython.delete_FingerList [static, private]

Definition at line 1499 of file Leap.py.

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

Reimplemented from Leap::Interface.

Definition at line 1454 of file Leap.py.

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

Reimplemented from Leap::Interface.

Definition at line 1450 of file Leap.py.

tuple Leap::FingerList::frontmost = _swig_property(LeapPython.FingerList_frontmost_get) [static]

Definition at line 1492 of file Leap.py.

tuple Leap::FingerList::is_empty = _swig_property(LeapPython.FingerList_is_empty_get) [static]

Definition at line 1483 of file Leap.py.

tuple Leap::FingerList::leftmost = _swig_property(LeapPython.FingerList_leftmost_get) [static]

Definition at line 1486 of file Leap.py.

tuple Leap::FingerList::rightmost = _swig_property(LeapPython.FingerList_rightmost_get) [static]

Definition at line 1489 of file Leap.py.

Definition at line 1460 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