Leap::HandList Class Reference

#include <Leap.h>

Inheritance diagram for Leap::HandList:

Public Types
typedef ConstListIterator< HandList, Hand >	const_iterator

Public Member Functions
def	__getitem__ (self, index)
def	__init__ (self)
def	__iter__ (self)
def	__len__ (self)
def	append (self, other)
LEAP_EXPORT HandList &	append (const HandList &other)
LEAP_EXPORT const_iterator	begin () const
LEAP_EXPORT int	count () const
LEAP_EXPORT const_iterator	end () const
LEAP_EXPORT Hand	frontmost () const
	HandList (const ListBaseImplementation< Hand > &)
LEAP_EXPORT	HandList ()
LEAP_EXPORT bool	isEmpty () const
LEAP_EXPORT Hand	leftmost () const
LEAP_EXPORT Hand	operator[] (int index) const
LEAP_EXPORT Hand	rightmost () const
Public Member Functions inherited from Leap::Interface
def	__init__ (self, args, kwargs)

Public Attributes
	this

Static Public Attributes
	frontmost = _swig_property(LeapPython.HandList_frontmost_get)
	is_empty = _swig_property(LeapPython.HandList_is_empty_get)
	leftmost = _swig_property(LeapPython.HandList_leftmost_get)
	rightmost = _swig_property(LeapPython.HandList_rightmost_get)

Static Private Attributes
	__getattr__ = lambdaself,name:_swig_getattr(self, HandList, name)
	__repr__ = _swig_repr
	__setattr__ = lambdaself,name,value:_swig_setattr(self, HandList, name, value)
	__swig_destroy__ = LeapPython.delete_HandList
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 HandList class represents a list of Hand objects.

Get a HandList object by calling Frame::hands().

Since

1.0

Definition at line 3883 of file Leap.h.

Member Typedef Documentation

typedef ConstListIterator<HandList, Hand> Leap::HandList::const_iterator

A C++ iterator type for this HandList objects.

Since

1.0

Definition at line 3975 of file Leap.h.

Constructor & Destructor Documentation

Leap::HandList::HandList

(

const ListBaseImplementation< Hand > &

)

LEAP_EXPORT Leap::HandList::HandList

(

)

Constructs an empty list of hands.

Since

1.0

def Leap.HandList.__init__

(

self

)

Definition at line 1564 of file Leap.py.

Member Function Documentation

def Leap.HandList.__getitem__	(		self,
			index
	)

Definition at line 1574 of file Leap.py.

def Leap.HandList.__iter__

(

self

)

Definition at line 1591 of file Leap.py.

def Leap.HandList.__len__

(

self

)

Definition at line 1571 of file Leap.py.

def Leap.HandList.append	(		self,
			other
	)

Definition at line 1577 of file Leap.py.

LEAP_EXPORT HandList& Leap::HandList::append

(

const HandList &

other

)

Appends the members of the specified HandList to this HandList.

Parameters

other

A HandList object containing Hand objects to append to the end of this HandList.

LEAP_EXPORT const_iterator Leap::HandList::begin

(

)

const

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

Since

1.0

LEAP_EXPORT int Leap::HandList::count

(

)

const

Returns the number of hands in this list.

Returns

The number of hands in this list.

Since

1.0

LEAP_EXPORT const_iterator Leap::HandList::end

(

)

const

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

Since

1.0

LEAP_EXPORT Hand Leap::HandList::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 hand, or invalid if list is empty.

Since

1.0

LEAP_EXPORT bool Leap::HandList::isEmpty

(

)

const

Reports whether the list is empty.

Returns

True, if the list has no members.

Since

1.0

LEAP_EXPORT Hand Leap::HandList::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).

Note: to determine whether a hand is the left hand, use the Hand::isLeft() function.

Returns

The leftmost hand, or invalid if list is empty.

Since

1.0

LEAP_EXPORT Hand Leap::HandList::operator[]

(

int

index

)

const

Access a list member by its position in the list.

Parameters

index

The zero-based list position index.

Returns

The Hand object at the specified index.

Since

1.0

LEAP_EXPORT Hand Leap::HandList::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).

Note: to determine whether a hand is the right hand, use the Hand::isRight() function.

Returns

The rightmost hand, or invalid if list is empty.

Since

1.0

Member Data Documentation

Leap.HandList.__getattr__ = lambdaself,name:_swig_getattr(self, HandList, name)

staticprivate

Definition at line 1561 of file Leap.py.

Leap.HandList.__repr__ = _swig_repr

staticprivate

Definition at line 1562 of file Leap.py.

Leap.HandList.__setattr__ = lambdaself,name,value:_swig_setattr(self, HandList, name, value)

staticprivate

Definition at line 1557 of file Leap.py.

Leap.HandList.__swig_destroy__ = LeapPython.delete_HandList

staticprivate

Definition at line 1597 of file Leap.py.

dictionary Leap.HandList.__swig_getmethods__ = {}

staticprivate

Definition at line 1558 of file Leap.py.

dictionary Leap.HandList.__swig_setmethods__ = {}

staticprivate

Definition at line 1554 of file Leap.py.

Leap.HandList.frontmost = _swig_property(LeapPython.HandList_frontmost_get)

static

Definition at line 1590 of file Leap.py.

Leap.HandList.is_empty = _swig_property(LeapPython.HandList_is_empty_get)

static

Definition at line 1581 of file Leap.py.

Leap.HandList.leftmost = _swig_property(LeapPython.HandList_leftmost_get)

static

Definition at line 1584 of file Leap.py.

Leap.HandList.rightmost = _swig_property(LeapPython.HandList_rightmost_get)

static

Definition at line 1587 of file Leap.py.

Leap.HandList.this

Definition at line 1569 of file Leap.py.

---

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

• Leap.h
• Leap.py