Leap Motion Java API Reference  0.8.0
com.leapmotion.leap.PointableList Class Reference

The PointableList class represents a list of Pointable objects. More...

Inherits com.leapmotion.leap.Interface, and Iterable< Pointable >.

Public Member Functions

PointableList append (PointableList other)
 Appends the members of the specifed PointableList to this PointableList.
 
PointableList append (FingerList other)
 Appends the members of the specifed FingerList to this PointableList.
 
PointableList append (ToolList other)
 Appends the members of the specifed ToolList to this PointableList.
 
int count ()
 Returns the number of pointable entities in this list.
 
boolean empty ()
 Deprecated.
 
Pointable frontmost ()
 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).
 
Pointable get (int index)
 Access a list member by its position in the list.
 
boolean isEmpty ()
 Reports whether the list is empty.
 
Pointable leftmost ()
 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).
 
 PointableList ()
 Constructs an empty list of pointable entities.
 
Pointable rightmost ()
 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).
 

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().

Constructor & Destructor Documentation

com.leapmotion.leap.PointableList.PointableList ( )

Constructs an empty list of pointable entities.

Member Function Documentation

PointableList com.leapmotion.leap.PointableList.append ( PointableList  other)

Appends the members of the specifed PointableList to this PointableList.

Parameters
otherA PointableList object containing Pointable objects to append to the end of this PointableList.
PointableList com.leapmotion.leap.PointableList.append ( FingerList  other)

Appends the members of the specifed FingerList to this PointableList.

Parameters
otherA FingerList object containing Finger objects to append to the end of this PointableList.
PointableList com.leapmotion.leap.PointableList.append ( ToolList  other)

Appends the members of the specifed ToolList to this PointableList.

Parameters
otherA ToolList object containing Tool objects to append to the end of this PointableList.
int com.leapmotion.leap.PointableList.count ( )

Returns the number of pointable entities in this list.

Returns
The number of pointable entities in this list.
boolean com.leapmotion.leap.PointableList.empty ( )

Deprecated.

Use PointableList::isEmpty() instead.

See Also
PointableList::isEmpty()
Pointable com.leapmotion.leap.PointableList.frontmost ( )

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.
Pointable com.leapmotion.leap.PointableList.get ( int  index)

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.
boolean com.leapmotion.leap.PointableList.isEmpty ( )

Reports whether the list is empty.

Returns
True, if the list has no members.
Pointable com.leapmotion.leap.PointableList.leftmost ( )

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.
Pointable com.leapmotion.leap.PointableList.rightmost ( )

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.