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

The Tool class represents a tracked tool. More...

Inherits Leap.Pointable.

Public Member Functions

 Tool ()
 Constructs a Tool object.
 
 Tool (Pointable arg0)
 If the specified Pointable object represents a tool, creates a copy of it as a Tool object; otherwise, creates an invalid Tool object.
 
override string ToString ()
 A string containing a brief, human readable description of the Tool object.
 
- Public Member Functions inherited from Leap.Pointable
bool Equals (Pointable arg0)
 Compare Pointable object equality.
 
 Pointable ()
 Constructs a Pointable object.
 
override string ToString ()
 A string containing a brief, human readable description of the Pointable object.
 

Properties

static new Tool Invalid [get]
 Returns an invalid Tool object.
 
- Properties inherited from Leap.Pointable
Vector Direction [get]
 The direction in which this finger or tool is pointing.
 
Frame Frame [get]
 The Frame associated with this Pointable object.
 
Hand Hand [get]
 The Hand associated with this finger or tool.
 
int Id [get]
 A unique ID assigned to this Pointable object, whose value remains the same across consecutive frames while the tracked finger or tool remains visible.
 
static Pointable Invalid [get]
 Returns an invalid Pointable object.
 
bool IsFinger [get]
 Whether or not the Pointable is believed to be a finger.
 
bool IsTool [get]
 Whether or not the Pointable is believed to be a tool.
 
bool IsValid [get]
 Reports whether this is a valid Pointable object.
 
float Length [get]
 The estimated length of the finger or tool in millimeters.
 
Vector StabilizedTipPosition [get]
 The stabilized tip position of this Pointable.
 
Vector TipPosition [get]
 The tip position in millimeters from the Leap Motion origin.
 
Vector TipVelocity [get]
 The rate of change of the tip position in millimeters/second.
 
float TouchDistance [get]
 A value proportional to the distance between this Pointable object and the adaptive touch plane.
 
Pointable.Zone TouchZone [get]
 The current touch zone of this Pointable object.
 
float Width [get]
 The estimated width of the finger or tool in millimeters.
 

Additional Inherited Members

- Public Types inherited from Leap.Pointable
enum  Zone { ZONENONE = 0, ZONEHOVERING = 1, ZONETOUCHING = 2 }
 Defines the values for reporting the state of a Pointable object in relation to an adaptive touch plane. More...
 

Detailed Description

The Tool class represents a tracked tool.

Tools are Pointable objects that the Leap Motion software has classified as a tool. Tools are longer, thinner, and straighter than a typical finger. Get valid Tool objects from a Frame or a Hand object.

Note that Tool objects can be invalid, which means that they do not contain valid tracking data and do not correspond to a physical tool. Invalid Tool objects can be the result of asking for a Tool object using an ID from an earlier frame when no Tool objects with that ID exist in the current frame. A Tool object created from the Tool constructor is also invalid. Test for validity with the Tool::isValid() function.

Constructor & Destructor Documentation

Leap.Tool.Tool ( )
inline

Constructs a Tool object.

An uninitialized tool is considered invalid. Get valid Tool objects from a Frame or a Hand object.

Leap.Tool.Tool ( Pointable  arg0)
inline

If the specified Pointable object represents a tool, creates a copy of it as a Tool object; otherwise, creates an invalid Tool object.

Member Function Documentation

override string Leap.Tool.ToString ( )
inline

A string containing a brief, human readable description of the Tool object.

Returns
A description of the Tool object as a string.

Property Documentation

new Tool Leap.Tool.Invalid
staticget

Returns an invalid Tool object.

You can use the instance returned by this function in comparisons testing whether a given Tool instance is valid or invalid. (You can also use the Tool::isValid() function.)

Returns
The invalid Tool instance.