Documentation

com.leapmotion.leap.Finger Class Reference

The Finger class represents a tracked finger. More...

Inherits com.leapmotion.leap.Pointable.

Public Member Functions

Finger ()
Constructs a Finger object.
Finger (Pointable arg0)
If the specified Pointable object represents a finger, creates a copy of it as a Finger object; otherwise, creates an invalid Finger object.
String toString ()
A string containing a brief, human readable description of the Finger object.
- Public Member Functions inherited from com.leapmotion.leap.Pointable
Vector direction ()
The direction in which this finger or tool is pointing.
boolean equals (Pointable arg0)
Compare Pointable object equality.
Frame frame ()
The Frame associated with this Pointable object.
Hand hand ()
The Hand associated with this finger or tool.
int id ()
A unique ID assigned to this Pointable object, whose value remains the same across consecutive frames while the tracked finger or tool remains visible.
boolean isFinger ()
Whether or not the Pointable is believed to be a finger.
boolean isTool ()
Whether or not the Pointable is believed to be a tool.
boolean isValid ()
Reports whether this is a valid Pointable object.
float length ()
The estimated length of the finger or tool in millimeters.
Pointable ()
Constructs a Pointable object.
Vector stabilizedTipPosition ()
The stabilized tip position of this Pointable.
float timeVisible ()
The duration of time this Pointable has been visible to the Leap Motion Controller.
Vector tipPosition ()
The tip position in millimeters from the Leap Motion origin.
Vector tipVelocity ()
The rate of change of the tip position in millimeters/second.
String toString ()
A string containing a brief, human readable description of the Pointable object.
float touchDistance ()
A value proportional to the distance between this Pointable object and the adaptive touch plane.
Pointable.Zone touchZone ()
The current touch zone of this Pointable object.
float width ()
The estimated width of the finger or tool in millimeters.

Static Public Member Functions

static Finger invalid ()
Returns an invalid Finger object.
- Static Public Member Functions inherited from com.leapmotion.leap.Pointable
static Pointable invalid ()
Returns an invalid Pointable object.

Detailed Description

The Finger class represents a tracked finger.

Fingers are Pointable objects that the Leap Motion software has classified as a finger. Get valid Finger objects from a Frame or a Hand object.

Fingers may be permanently associated to a hand. In this case the angular order of the finger IDs will be invariant. As fingers move in and out of view it is possible for the guessed ID of a finger to be incorrect. Consequently, it may be necessary for finger IDs to be exchanged. All tracked properties, such as velocity, will remain continuous in the API. However, quantities that are derived from the API output (such as a history of positions) will be discontinuous unless they have a corresponding ID exchange.

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

Since
1.0

Constructor & Destructor Documentation

com.leapmotion.leap.Finger.Finger ( )

Constructs a Finger object.

An uninitialized finger is considered invalid. Get valid Finger objects from a Frame or a Hand object.

Since
1.0
com.leapmotion.leap.Finger.Finger ( Pointable arg0 )

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

Finger finger = new Finger(pointableObject);
Since
1.0

Member Function Documentation

static Finger com.leapmotion.leap.Finger.invalid ( )
static

Returns an invalid Finger object.

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

if (!finger.equals(Finger.invalid())) {
// use the Finger data
}
Returns
The invalid Finger instance.
Since
1.0
String com.leapmotion.leap.Finger.toString ( )

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

Returns
A description of the Finger object as a string.
Since
1.0