Leap Motion C# API Reference  0.8.0
Leap.ToolList Class Reference

The ToolList class represents a list of Tool objects. More...

Inherits Leap.Interface, and IEnumerable< Tool >.

Public Member Functions

ToolList Append (ToolList other)
 Appends the members of the specifed ToolList to this ToolList.
 
 ToolList ()
 Constructs an empty list of tools.
 

Properties

int Count [get]
 Returns the number of tools in this list.
 
bool Empty [get]
 Deprecated.
 
Tool Frontmost [get]
 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).
 
bool IsEmpty [get]
 Reports whether the list is empty.
 
Tool Leftmost [get]
 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).
 
Tool Rightmost [get]
 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 ToolList class represents a list of Tool objects.

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

Constructor & Destructor Documentation

Leap.ToolList.ToolList ( )
inline

Constructs an empty list of tools.

Member Function Documentation

ToolList Leap.ToolList.Append ( ToolList  other)
inline

Appends the members of the specifed ToolList to this ToolList.

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

Property Documentation

int Leap.ToolList.Count
get

Returns the number of tools in this list.

Returns
The number of tools in this list.
bool Leap.ToolList.Empty
get

Deprecated.

Use ToolList::isEmpty() instead.

See Also
ToolList::isEmpty()
Tool Leap.ToolList.Frontmost
get

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.
bool Leap.ToolList.IsEmpty
get

Reports whether the list is empty.

Returns
True, if the list has no members.
Tool Leap.ToolList.Leftmost
get

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.
Tool Leap.ToolList.Rightmost
get

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.