Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Static Private Attributes | List of all members
Leap::PointableList Class Reference

#include <Leap.h>

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

Public Types

typedef ConstListIterator< PointableList, Pointableconst_iterator
 

Public Member Functions

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

Public Attributes

 this
 

Static Public Attributes

 frontmost = _swig_property(LeapPython.PointableList_frontmost_get)
 
 is_empty = _swig_property(LeapPython.PointableList_is_empty_get)
 
 leftmost = _swig_property(LeapPython.PointableList_leftmost_get)
 
 rightmost = _swig_property(LeapPython.PointableList_rightmost_get)
 

Static Private Attributes

 __getattr__ = lambdaself,name:_swig_getattr(self, PointableList, name)
 
 __repr__ = _swig_repr
 
 __setattr__ = lambdaself,name,value:_swig_setattr(self, PointableList, name, value)
 
 __swig_destroy__ = LeapPython.delete_PointableList
 
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 Interfaceoperator= (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 PointableList class represents a list of Pointable objects.

Pointable objects include entities that can be pointed, such as fingers and tools.

Get a PointableList object by calling Frame::pointables() or Hand::pointables().

Since
1.0

Definition at line 3476 of file Leap.h.

Member Typedef Documentation

A C++ iterator type for PointableList objects.

Since
1.0

Definition at line 3592 of file Leap.h.

Constructor & Destructor Documentation

Leap::PointableList::PointableList ( const ListBaseImplementation< Pointable > &  )
LEAP_EXPORT Leap::PointableList::PointableList ( )

Constructs an empty list of pointable entities.

Since
1.0
def Leap.PointableList.__init__ (   self)

Definition at line 1408 of file Leap.py.

Member Function Documentation

def Leap.PointableList.__getitem__ (   self,
  index 
)

Definition at line 1418 of file Leap.py.

def Leap.PointableList.__iter__ (   self)

Definition at line 1438 of file Leap.py.

def Leap.PointableList.__len__ (   self)

Definition at line 1415 of file Leap.py.

def Leap.PointableList.append (   self,
  args 
)

Definition at line 1421 of file Leap.py.

LEAP_EXPORT PointableList& Leap::PointableList::append ( const PointableList other)

Appends the members of the specified PointableList to this PointableList.

Parameters
otherA PointableList object containing Pointable objects to append to the end of this PointableList.
Since
1.0
LEAP_EXPORT PointableList& Leap::PointableList::append ( const FingerList other)

Appends the members of the specified FingerList to this PointableList.

Parameters
otherA FingerList object containing Finger objects to append to the end of this PointableList.
Since
1.0
LEAP_EXPORT PointableList& Leap::PointableList::append ( const ToolList other)

Appends the members of the specified ToolList to this PointableList.

Parameters
otherA ToolList object containing Tool objects to append to the end of this PointableList.
Since
1.0
LEAP_EXPORT const_iterator Leap::PointableList::begin ( ) const

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

Since
1.0
LEAP_EXPORT int Leap::PointableList::count ( ) const

Returns the number of pointable entities in this list.

Returns
The number of pointable entities in this list.
Since
1.0
LEAP_EXPORT const_iterator Leap::PointableList::end ( ) const

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

Since
1.0
def Leap.PointableList.extended (   self)

Definition at line 1424 of file Leap.py.

LEAP_EXPORT PointableList Leap::PointableList::extended ( ) const

Returns a new list containing those members of the current list that are extended. This includes all tools and any fingers whose isExtended() function is true.

Returns
The list of tools and extended fingers from the current list.
Since
2.0
LEAP_EXPORT Pointable Leap::PointableList::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 pointable, or invalid if list is empty.
Since
1.0
LEAP_EXPORT bool Leap::PointableList::isEmpty ( ) const

Reports whether the list is empty.

Returns
True, if the list has no members.
Since
1.0
LEAP_EXPORT Pointable Leap::PointableList::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 pointable, or invalid if list is empty.
Since
1.0
LEAP_EXPORT Pointable Leap::PointableList::operator[] ( int  index) const

Access a list member by its position in the list.

Parameters
indexThe zero-based list position index.
Returns
The Pointable object at the specified index.
Since
1.0
LEAP_EXPORT Pointable Leap::PointableList::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 pointable, or invalid if list is empty.
Since
1.0

Member Data Documentation

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

Definition at line 1405 of file Leap.py.

Leap.PointableList.__repr__ = _swig_repr
staticprivate

Definition at line 1406 of file Leap.py.

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

Definition at line 1401 of file Leap.py.

Leap.PointableList.__swig_destroy__ = LeapPython.delete_PointableList
staticprivate

Definition at line 1444 of file Leap.py.

dictionary Leap.PointableList.__swig_getmethods__ = {}
staticprivate

Definition at line 1402 of file Leap.py.

dictionary Leap.PointableList.__swig_setmethods__ = {}
staticprivate

Definition at line 1398 of file Leap.py.

Leap.PointableList.frontmost = _swig_property(LeapPython.PointableList_frontmost_get)
static

Definition at line 1437 of file Leap.py.

Leap.PointableList.is_empty = _swig_property(LeapPython.PointableList_is_empty_get)
static

Definition at line 1428 of file Leap.py.

Leap.PointableList.leftmost = _swig_property(LeapPython.PointableList_leftmost_get)
static

Definition at line 1431 of file Leap.py.

Leap.PointableList.rightmost = _swig_property(LeapPython.PointableList_rightmost_get)
static

Definition at line 1434 of file Leap.py.

Leap.PointableList.this

Definition at line 1413 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 Tue Jun 2 2020 03:58:01