Leap::ToolList Class Reference

#include <Leap.h>

Inheritance diagram for Leap::ToolList:

List of all members.

Public Types
typedef ConstListIterator < ToolList, Tool >	const_iterator
Public Member Functions
def	__getitem__
def	__init__
def	__iter__
def	__len__
def	append
LEAP_EXPORT ToolList &	append (const ToolList &other)
LEAP_EXPORT const_iterator	begin () const
LEAP_EXPORT int	count () const
LEAP_EXPORT const_iterator	end () const
LEAP_EXPORT Tool	frontmost () const
LEAP_EXPORT bool	isEmpty () const
LEAP_EXPORT Tool	leftmost () const
LEAP_EXPORT Tool	operator[] (int index) const
LEAP_EXPORT Tool	rightmost () const
	ToolList (const ListBaseImplementation< Tool > &)
LEAP_EXPORT	ToolList ()
Public Attributes
	this
Static Public Attributes
tuple	frontmost = _swig_property(LeapPython.ToolList_frontmost_get)
tuple	is_empty = _swig_property(LeapPython.ToolList_is_empty_get)
tuple	leftmost = _swig_property(LeapPython.ToolList_leftmost_get)
tuple	rightmost = _swig_property(LeapPython.ToolList_rightmost_get)
Static Private Attributes
tuple	__getattr__ = lambdaself,name:_swig_getattr(self, ToolList, name)
	__repr__ = _swig_repr
tuple	__setattr__ = lambdaself,name,value:_swig_setattr(self, ToolList, name, value)
	__swig_destroy__ = LeapPython.delete_ToolList
dictionary	__swig_getmethods__ = {}
dictionary	__swig_setmethods__ = {}

---

Detailed Description

The ToolList class represents a list of Tool objects.

Get a ToolList object by calling Frame::tools().

Since:

1.0

Definition at line 3764 of file Leap.h.

---

Member Typedef Documentation

typedef ConstListIterator<ToolList, Tool> Leap::ToolList::const_iterator

A C++ iterator type for ToolList objects.

Since:

1.0

Definition at line 3854 of file Leap.h.

---

Constructor & Destructor Documentation

Leap::ToolList::ToolList

(

const ListBaseImplementation< Tool > &

)

LEAP_EXPORT Leap::ToolList::ToolList

(

)

Constructs an empty list of tools.

Since:

1.0

def Leap::ToolList::__init__

(

self

)

Definition at line 1515 of file Leap.py.

---

Member Function Documentation

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

Definition at line 1525 of file Leap.py.

def Leap::ToolList::__iter__

(

self

)

Definition at line 1542 of file Leap.py.

def Leap::ToolList::__len__

(

self

)

Definition at line 1522 of file Leap.py.

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

Definition at line 1528 of file Leap.py.

LEAP_EXPORT ToolList& Leap::ToolList::append

(

const ToolList &

other

)

Appends the members of the specified ToolList to this ToolList.

Parameters:

other

A ToolList object containing Tool objects to append to the end of this ToolList.

Since:

1.0

LEAP_EXPORT const_iterator Leap::ToolList::begin

(

)

const

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

Since:

1.0

LEAP_EXPORT int Leap::ToolList::count

(

)

const

Returns the number of tools in this list.

Returns:

The number of tools in this list.

Since:

1.0

LEAP_EXPORT const_iterator Leap::ToolList::end

(

)

const

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

Since:

1.0

LEAP_EXPORT Tool Leap::ToolList::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 tool, or invalid if list is empty.

Since:

1.0

LEAP_EXPORT bool Leap::ToolList::isEmpty

(

)

const

Reports whether the list is empty.

Returns:

True, if the list has no members.

Since:

1.0

LEAP_EXPORT Tool Leap::ToolList::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 tool, or invalid if list is empty.

Since:

1.0

LEAP_EXPORT Tool Leap::ToolList::operator[]

(

int

index

)

const

Access a list member by its position in the list.

Parameters:

index

The zero-based list position index.

Returns:

The Tool object at the specified index.

Since:

1.0

LEAP_EXPORT Tool Leap::ToolList::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 tool, or invalid if list is empty.

Since:

1.0

---

Member Data Documentation

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

Reimplemented from Leap::Interface.

Definition at line 1512 of file Leap.py.

Leap::ToolList::__repr__ = _swig_repr [static, private]

Definition at line 1513 of file Leap.py.

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

Reimplemented from Leap::Interface.

Definition at line 1508 of file Leap.py.

Leap::ToolList::__swig_destroy__ = LeapPython.delete_ToolList [static, private]

Definition at line 1548 of file Leap.py.

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

Reimplemented from Leap::Interface.

Definition at line 1509 of file Leap.py.

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

Reimplemented from Leap::Interface.

Definition at line 1505 of file Leap.py.

tuple Leap::ToolList::frontmost = _swig_property(LeapPython.ToolList_frontmost_get) [static]

Definition at line 1541 of file Leap.py.

tuple Leap::ToolList::is_empty = _swig_property(LeapPython.ToolList_is_empty_get) [static]

Definition at line 1532 of file Leap.py.

tuple Leap::ToolList::leftmost = _swig_property(LeapPython.ToolList_leftmost_get) [static]

Definition at line 1535 of file Leap.py.

tuple Leap::ToolList::rightmost = _swig_property(LeapPython.ToolList_rightmost_get) [static]

Definition at line 1538 of file Leap.py.

Leap::ToolList::this

Definition at line 1515 of file Leap.py.

---

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

• Leap.h
• Leap.py