Leap::FingerList Class Reference

#include <Leap.h>

Inheritance diagram for Leap::FingerList:

Public Types
typedef ConstListIterator< FingerList, Finger >	const_iterator

Public Member Functions
def	__getitem__ (self, index)
def	__init__ (self)
def	__iter__ (self)
def	__len__ (self)
def	append (self, other)
LEAP_EXPORT FingerList &	append (const FingerList &other)
LEAP_EXPORT const_iterator	begin () const
LEAP_EXPORT int	count () const
LEAP_EXPORT const_iterator	end () const
def	extended (self)
LEAP_EXPORT FingerList	extended () const
def	finger_type (self, 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 Member Functions inherited from Leap::Interface
def	__init__ (self, args, kwargs)

Public Attributes
	this

Static Public Attributes
	frontmost = _swig_property(LeapPython.FingerList_frontmost_get)
	is_empty = _swig_property(LeapPython.FingerList_is_empty_get)
	leftmost = _swig_property(LeapPython.FingerList_leftmost_get)
	rightmost = _swig_property(LeapPython.FingerList_rightmost_get)

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

Additional Inherited Members
Protected Member Functions inherited from Leap::Interface
template<typename T >
T *	get () const
LEAP_EXPORT	Interface (void *owner)
LEAP_EXPORT	Interface (Implementation *reference, void *owner)
LEAP_EXPORT	Interface (const Interface &rhs)
	Interface (class SharedObject *object)
LEAP_EXPORT Interface &	operator= (const Interface &rhs)
virtual LEAP_EXPORT	~Interface ()
Static Protected Member Functions inherited from Leap::Interface
static LEAP_EXPORT void	deleteCString (const char *cstr)
Protected Attributes inherited from Leap::Interface
class SharedObject *	m_object

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

const_iterator

typedef ConstListIterator<FingerList, Finger> Leap::FingerList::const_iterator

A C++ iterator type for FingerList objects.

Since

1.0

Definition at line 3734 of file Leap.h.

Constructor & Destructor Documentation

FingerList() [1/2]

Leap::FingerList::FingerList

(

const ListBaseImplementation< Finger > &

)

FingerList() [2/2]

LEAP_EXPORT Leap::FingerList::FingerList

(

)

Constructs an empty list of fingers.

Since

1.0

__init__()

def Leap.FingerList.__init__

(

self

)

Definition at line 1460 of file Leap.py.

Member Function Documentation

__getitem__()

def Leap.FingerList.__getitem__	(		self,
			index
	)

Definition at line 1470 of file Leap.py.

__iter__()

def Leap.FingerList.__iter__

(

self

)

Definition at line 1493 of file Leap.py.

__len__()

def Leap.FingerList.__len__

(

self

)

Definition at line 1467 of file Leap.py.

append() [1/2]

def Leap.FingerList.append	(		self,
			other
	)

Definition at line 1473 of file Leap.py.

append() [2/2]

LEAP_EXPORT FingerList& Leap::FingerList::append

(

const FingerList &

other

)

Appends the members of the specified FingerList to this FingerList.

Parameters

other

A FingerList object containing Finger objects to append to the end of this FingerList.

Since

1.0

begin()

LEAP_EXPORT const_iterator Leap::FingerList::begin

(

)

const

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

Since

1.0

count()

LEAP_EXPORT int Leap::FingerList::count

(

)

const

Returns the number of fingers in this list.

Returns

The number of fingers in this list.

Since

1.0

end()

LEAP_EXPORT const_iterator Leap::FingerList::end

(

)

const

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

Since

1.0

extended() [1/2]

def Leap.FingerList.extended

(

self

)

Definition at line 1476 of file Leap.py.

extended() [2/2]

LEAP_EXPORT FingerList Leap::FingerList::extended

(

)

const

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

finger_type()

def Leap.FingerList.finger_type	(		self,
			type
	)

Definition at line 1479 of file Leap.py.

fingerType()

LEAP_EXPORT FingerList Leap::FingerList::fingerType

(

Finger::Type

type

)

const

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

frontmost()

LEAP_EXPORT Finger Leap::FingerList::frontmost

(

)

const

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

isEmpty()

LEAP_EXPORT bool Leap::FingerList::isEmpty

(

)

const

Reports whether the list is empty.

Returns

True, if the list has no members.

Since

1.0

leftmost()

LEAP_EXPORT Finger Leap::FingerList::leftmost

(

)

const

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

operator[]()

LEAP_EXPORT Finger Leap::FingerList::operator[]

(

int

index

)

const

Access a list member by its position in the list.

Parameters

index

The zero-based list position index.

Returns

The Finger object at the specified index.

Since

1.0

rightmost()

LEAP_EXPORT Finger Leap::FingerList::rightmost

(

)

const

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

__getattr__

Leap.FingerList.__getattr__ = lambda self, name: _swig_getattr(self, FingerList, name)

staticprivate

Definition at line 1457 of file Leap.py.

__repr__

Leap.FingerList.__repr__ = _swig_repr

staticprivate

Definition at line 1458 of file Leap.py.

__setattr__

Leap.FingerList.__setattr__ = lambda self, name, value: _swig_setattr(self, FingerList, name, value)

staticprivate

Definition at line 1453 of file Leap.py.

__swig_destroy__

Leap.FingerList.__swig_destroy__ = LeapPython.delete_FingerList

staticprivate

Definition at line 1499 of file Leap.py.

__swig_getmethods__

dictionary Leap.FingerList.__swig_getmethods__ = {}

staticprivate

Definition at line 1454 of file Leap.py.

__swig_setmethods__

dictionary Leap.FingerList.__swig_setmethods__ = {}

staticprivate

Definition at line 1450 of file Leap.py.

frontmost

Leap.FingerList.frontmost = _swig_property(LeapPython.FingerList_frontmost_get)

static

Definition at line 1492 of file Leap.py.

is_empty

Leap.FingerList.is_empty = _swig_property(LeapPython.FingerList_is_empty_get)

static

Definition at line 1483 of file Leap.py.

leftmost

Leap.FingerList.leftmost = _swig_property(LeapPython.FingerList_leftmost_get)

static

Definition at line 1486 of file Leap.py.

rightmost

Leap.FingerList.rightmost = _swig_property(LeapPython.FingerList_rightmost_get)

static

Definition at line 1489 of file Leap.py.

this

Leap.FingerList.this

Definition at line 1465 of file Leap.py.

---

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

• Leap.h
• Leap.py