HandΒΆ

The Hand class reports the physical characteristics of a detected hand. More...

Inherits Interface.

Public Member Functions

Arm arm ()
 The arm to which this hand is attached. More...
 
Matrix basis ()
 The orientation of the hand as a basis matrix. More...
 
float confidence ()
 How confident we are with a given hand pose. More...
 
Vector direction ()
 The direction from the palm position toward the fingers. More...
 
boolean equals (Hand arg0)
 Compare Hand object equality. More...
 
Finger finger (int id)
 The Finger object with the specified ID attached to this hand. More...
 
FingerList fingers ()
 The list of Finger objects detected in this frame that are attached to this hand, given in order from thumb to pinky. More...
 
Frame frame ()
 The Frame associated with this Hand. More...
 
float grabAngle ()
 The angle between the fingers and the hand of a grab hand pose. More...
 
float grabStrength ()
 Deprecated. More...
 
 Hand ()
 Constructs a Hand object. More...
 
int id ()
 A unique ID assigned to this Hand object, whose value remains the same across consecutive frames while the tracked hand remains visible. More...
 
boolean isLeft ()
 Identifies whether this Hand is a left hand. More...
 
boolean isRight ()
 Identifies whether this Hand is a right hand. More...
 
boolean isValid ()
 Reports whether this is a valid Hand object. More...
 
Vector palmNormal ()
 The normal vector to the palm. More...
 
Vector palmPosition ()
 The center position of the palm in millimeters from the Leap Motion Controller origin. More...
 
Vector palmVelocity ()
 The rate of change of the palm position in millimeters/second. More...
 
float palmWidth ()
 The estimated width of the palm when the hand is in a flat position. More...
 
float pinchDistance ()
 The distance between the thumb and index finger of a pinch hand pose. More...
 
float pinchStrength ()
 Deprecated. More...
 
Pointable pointable (int id)
 The Pointable object with the specified ID associated with this hand. More...
 
PointableList pointables ()
 The list of Pointable objects detected in this frame that are associated with this hand, given in arbitrary order. More...
 
float rotationAngle (Frame sinceFrame)
 The angle of rotation around the rotation axis derived from the change in orientation of this hand, and any associated fingers, between the current frame and the specified frame. More...
 
float rotationAngle (Frame sinceFrame, Vector axis)
 The angle of rotation around the specified axis derived from the change in orientation of this hand, and any associated fingers, between the current frame and the specified frame. More...
 
Vector rotationAxis (Frame sinceFrame)
 The axis of rotation derived from the change in orientation of this hand, and any associated fingers, between the current frame and the specified frame. More...
 
Matrix rotationMatrix (Frame sinceFrame)
 The transform matrix expressing the rotation derived from the change in orientation of this hand, and any associated fingers, between the current frame and the specified frame. More...
 
float rotationProbability (Frame sinceFrame)
 The estimated probability that the hand motion between the current frame and the specified frame is intended to be a rotating motion. More...
 
float scaleFactor (Frame sinceFrame)
 The scale factor derived from this hand's motion between the current frame and the specified frame. More...
 
float scaleProbability (Frame sinceFrame)
 The estimated probability that the hand motion between the current frame and the specified frame is intended to be a scaling motion. More...
 
Vector sphereCenter ()
 The center of a sphere fit to the curvature of this hand. More...
 
float sphereRadius ()
 The radius of a sphere fit to the curvature of this hand. More...
 
Vector stabilizedPalmPosition ()
 The stabilized palm position of this Hand. More...
 
float timeVisible ()
 The duration of time this Hand has been visible to the Leap Motion Controller. More...
 
String toString ()
 A string containing a brief, human readable description of the Hand object. More...
 
Vector translation (Frame sinceFrame)
 The change of position of this hand between the current frame and the specified frame. More...
 
float translationProbability (Frame sinceFrame)
 The estimated probability that the hand motion between the current frame and the specified frame is intended to be a translating motion. More...
 
Vector wristPosition ()
 The position of the wrist of this hand. More...
 

Static Public Member Functions

static Hand invalid ()
 Returns an invalid Hand object. More...
 

Detailed Description

The Hand class reports the physical characteristics of a detected hand.

Hand tracking data includes a palm position and velocity; vectors for the palm normal and direction to the fingers; properties of a sphere fit to the hand; and lists of the attached fingers.

Get Hand objects from a Frame object:

Frame frame = controller.frame(); // controller is a Controller object
HandList hands = frame.hands();
Hand firstHand = hands.get(0);

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

Since
1.0

Constructor & Destructor Documentation

Hand ( )

Constructs a Hand object.

An uninitialized hand is considered invalid. Get valid Hand objects from a Frame object.

Hand leftmostHand = frame.hands().leftmost();
Since
1.0

Member Function Documentation

Arm arm ( )

The arm to which this hand is attached.

If the arm is not completely in view, Arm attributes are estimated based on the attributes of entities that are in view combined with typical human anatomy.

Hand hand = frame.hands().frontmost();
Arm arm = hand.arm();
Returns
The Arm object for this hand.
Since
2.0.3
Matrix basis ( )

The orientation of the hand as a basis matrix.

The basis is defined as follows:

xAxis Positive in the direction of the pinky

yAxis Positive above the hand

zAxis Positive in the direction of the wrist

Note: Since the left hand is a mirror of the right hand, the basis matrix will be left-handed for left hands.

Matrix basis = hand.basis();
Vector xBasis = basis.getXBasis();
Vector yBasis = basis.getYBasis();
Vector zBasis = basis.getZBasis();
Returns
The basis of the hand as a matrix.
Since
2.0
float confidence ( )

How confident we are with a given hand pose.

The confidence level ranges between 0.0 and 1.0 inclusive.

float confidence = hand.confidence();
Since
2.0
Vector direction ( )

The direction from the palm position toward the fingers.

The direction is expressed as a unit vector pointing in the same direction as the directed line from the palm position to the fingers.

You can use the palm direction vector to compute the pitch and yaw angles of the palm with respect to the horizontal plane:

float pitch = hand.direction().pitch();
float yaw = hand.direction().yaw();
float roll = hand.palmNormal().roll();
Returns
The Vector pointing from the palm position toward the fingers.
Since
1.0
boolean equals ( Hand  arg0)

Compare Hand object equality.

Boolean handIsEqual = thisHand.equals(thatHand);

Two Hand objects are equal if and only if both Hand objects represent the exact same physical hand in the same frame and both Hand objects are valid.

Since
1.0
Finger finger ( int  id)

The Finger object with the specified ID attached to this hand.

Use the Hand::finger() function to retrieve a Finger object attached to this hand using an ID value obtained from a previous frame. This function always returns a Finger object, but if no finger with the specified ID is present, an invalid Finger object is returned.

Finger fingerOnHandByID = hand.finger(fingerID);

Note that ID values persist across frames, but only until tracking of a particular object is lost. If tracking of a finger is lost and subsequently regained, the new Finger object representing that finger may have a different ID than that representing the finger in an earlier frame.

Parameters
idThe ID value of a Finger object from a previous frame.
Returns
The Finger object with the matching ID if one exists for this hand in this frame; otherwise, an invalid Finger object is returned.
Since
1.0
FingerList fingers ( )

The list of Finger objects detected in this frame that are attached to this hand, given in order from thumb to pinky.

The list cannot be empty.

Use PointableList::extended() to remove non-extended fingers from the list.

// hand is a Hand object
PointableList pointables = hand.pointables();
FingerList fingers = hand.fingers();
Returns
The FingerList containing all Finger objects attached to this hand.
Since
1.0
Frame frame ( )

The Frame associated with this Hand.

Frame frameForHand = hand.frame();
Returns
The associated Frame object, if available; otherwise, an invalid Frame object is returned.
Since
1.0
float grabAngle ( )

The angle between the fingers and the hand of a grab hand pose.

The angle is computed by looking at the angle between the direction of the 4 fingers and the direction of the hand. Thumb is not considered when computing the angle. The angle is 0 radian for an open hand, and reaches pi radians when the pose is a tight fist.

Returns
The angle of a grab hand pose between 0 and pi radians (0 and 180 degrees).
Since
3.0
float grabStrength ( )

Deprecated.

Use grabAngle() instead.

Since
2.0
Deprecated:
3.0
int id ( )

A unique ID assigned to this Hand object, whose value remains the same across consecutive frames while the tracked hand remains visible.

If tracking is lost (for example, when a hand is occluded by another hand or when it is withdrawn from or reaches the edge of the Leap Motion Controller field of view), the Leap Motion software may assign a new ID when it detects the hand in a future frame.

Use the ID value with the Frame::hand() function to find this Hand object in future frames:

Hand knownHand = frame.hand(handID);
Returns
The ID of this hand.
Since
1.0
static Hand invalid ( )
static

Returns an invalid Hand object.

if (!hand.equals(Hand.invalid())) {
//Process hand data...
}

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

Returns
The invalid Hand instance.
Since
1.0
boolean isLeft ( )

Identifies whether this Hand is a left hand.

String handName = hand.isLeft() ? "Left hand" : "Right hand";
Returns
True if the hand is identified as a left hand.
Since
2.0
boolean isRight ( )

Identifies whether this Hand is a right hand.

if(hand.isRight()){
// .. Do right handed stuff
}
Returns
True if the hand is identified as a right hand.
Since
2.0
boolean isValid ( )

Reports whether this is a valid Hand object.

if (hand.isValid()) {
//Process hand data...
}
Returns
True, if this Hand object contains valid tracking data.
Since
1.0
Vector palmNormal ( )

The normal vector to the palm.

If your hand is flat, this vector will point downward, or "out" of the front surface of your palm.

Leap_Palm_Vectors.png

The direction is expressed as a unit vector pointing in the same direction as the palm normal (that is, a vector orthogonal to the palm).

You can use the palm normal vector to compute the roll angle of the palm with respect to the horizontal plane:

float pitch = hand.direction().pitch();
float yaw = hand.direction().yaw();
float roll = hand.palmNormal().roll();
Returns
The Vector normal to the plane formed by the palm.
Since
1.0
Vector palmPosition ( )

The center position of the palm in millimeters from the Leap Motion Controller origin.

Vector handCenter = hand.palmPosition();
Returns
The Vector representing the coordinates of the palm position.
Since
1.0
Vector palmVelocity ( )

The rate of change of the palm position in millimeters/second.

Vector handSpeed = hand.palmVelocity();
Returns
The Vector representing the coordinates of the palm velocity.
Since
1.0
float palmWidth ( )

The estimated width of the palm when the hand is in a flat position.

float handWidth = hand.palmWidth();
Returns
The width of the palm in millimeters
Since
2.0
float pinchDistance ( )

The distance between the thumb and index finger of a pinch hand pose.

The distance is computed by looking at the shortest distance between the last 2 phalanges of the thumb and those of the index finger. This pinch measurement only takes thumb and index finger into account.

Returns
The distance between the thumb and index finger of a pinch hand pose in millimeters.
Since
3.0
float pinchStrength ( )

Deprecated.

Use pinchDistance() instead.

Since
2.0
Deprecated:
3.0
Pointable pointable ( int  id)

The Pointable object with the specified ID associated with this hand.

Use the Hand::pointable() function to retrieve a Pointable object associated with this hand using an ID value obtained from a previous frame. This function always returns a Pointable object, but if no finger with the specified ID is present, an invalid Pointable object is returned.

Pointable knownPointable = hand.pointable(pointableID);

Note that the ID values assigned to fingers are based on the hand ID. Hand IDs persist across frames, but only until tracking of that hand is lost. If tracking of the hand is lost and subsequently regained, the new Hand object and its child Finger objects will have a different ID than in an earlier frame.

Parameters
idThe ID value of a Pointable object from a previous frame.
Returns
The Pointable object with the matching ID if one exists for this hand in this frame; otherwise, an invalid Pointable object is returned.
Since
1.0
PointableList pointables ( )

The list of Pointable objects detected in this frame that are associated with this hand, given in arbitrary order.

The list will always contain 5 fingers.

Use PointableList::extended() to remove non-extended fingers from the list.

// hand is a Hand object
PointableList pointables = hand.pointables();
FingerList fingers = hand.fingers();
Returns
The PointableList containing all Pointable objects associated with this hand.
Since
1.0
float rotationAngle ( Frame  sinceFrame)

The angle of rotation around the rotation axis derived from the change in orientation of this hand, and any associated fingers, between the current frame and the specified frame.

float rotationOfHand = hand.rotationAngle(startFrame);
Parameters
sinceFrameThe starting frame for computing the relative rotation.
Returns
A positive value representing the heuristically determined rotational change of the hand between the current frame and that specified in the sinceFrame parameter.
Deprecated:
3.0
float rotationAngle ( Frame  sinceFrame,
Vector  axis 
)

The angle of rotation around the specified axis derived from the change in orientation of this hand, and any associated fingers, between the current frame and the specified frame.

float rotationAroundYAxis = hand.rotationAngle(startFrame, Vector.yAxis());
Parameters
sinceFrameThe starting frame for computing the relative rotation.
axisThe axis to measure rotation around.
Returns
A value representing the heuristically determined rotational change of the hand between the current frame and that specified in the sinceFrame parameter around the specified axis.
Deprecated:
3.0
Vector rotationAxis ( Frame  sinceFrame)

The axis of rotation derived from the change in orientation of this hand, and any associated fingers, between the current frame and the specified frame.

Vector axisOfHandRotation = hand.rotationAxis(startFrame);
Parameters
sinceFrameThe starting frame for computing the relative rotation.
Returns
A normalized direction Vector representing the heuristically determined axis of rotational change of the hand between the current frame and that specified in the sinceFrame parameter.
Deprecated:
3.0
Matrix rotationMatrix ( Frame  sinceFrame)

The transform matrix expressing the rotation derived from the change in orientation of this hand, and any associated fingers, between the current frame and the specified frame.

Matrix handRotationTransform = hand.rotationMatrix(startFrame);
Parameters
sinceFrameThe starting frame for computing the relative rotation.
Returns
A transformation Matrix representing the heuristically determined rotational change of the hand between the current frame and that specified in the sinceFrame parameter.
Deprecated:
3.0
float rotationProbability ( Frame  sinceFrame)

The estimated probability that the hand motion between the current frame and the specified frame is intended to be a rotating motion.

float rotationIntentFactor = hand.rotationProbability(startFrame);
Parameters
sinceFrameThe starting frame for computing the relative rotation.
Returns
A value between 0 and 1 representing the estimated probability that the hand motion between the current frame and the specified frame is intended to be a rotating motion.
Deprecated:
3.0
float scaleFactor ( Frame  sinceFrame)

The scale factor derived from this hand's motion between the current frame and the specified frame.

float handScaleMotion = hand.scaleFactor(startFrame);
Parameters
sinceFrameThe starting frame for computing the relative scaling.
Returns
A positive value representing the heuristically determined scaling change ratio of the hand between the current frame and that specified in the sinceFrame parameter.
Deprecated:
3.0
float scaleProbability ( Frame  sinceFrame)

The estimated probability that the hand motion between the current frame and the specified frame is intended to be a scaling motion.

float scaleIntentFactor = hand.scaleProbability(startFrame);
Parameters
sinceFrameThe starting frame for computing the relative scaling.
Returns
A value between 0 and 1 representing the estimated probability that the hand motion between the current frame and the specified frame is intended to be a scaling motion.
Deprecated:
3.0
Vector sphereCenter ( )

The center of a sphere fit to the curvature of this hand.

Vector sphereCenter = hand.sphereCenter();

This sphere is placed roughly as if the hand were holding a ball.

Leap_Hand_Ball.png
Returns
The Vector representing the center position of the sphere.
Since
1.0
float sphereRadius ( )

The radius of a sphere fit to the curvature of this hand.

This sphere is placed roughly as if the hand were holding a ball. Thus the size of the sphere decreases as the fingers are curled into a fist.

float sphereDiameter = 2 * hand.sphereRadius();
Returns
The radius of the sphere in millimeters.
Since
1.0
Vector stabilizedPalmPosition ( )

The stabilized palm position of this Hand.

Smoothing and stabilization is performed in order to make this value more suitable for interaction with 2D content. The stabilized position lags behind the palm position by a variable amount, depending primarily on the speed of movement.

Vector filteredHandPosition = hand.stabilizedPalmPosition();
Returns
A modified palm position of this Hand object with some additional smoothing and stabilization applied.
Since
1.0
float timeVisible ( )

The duration of time this Hand has been visible to the Leap Motion Controller.

float lifetimeOfThisHandObject = hand.timeVisible();
Returns
The duration (in seconds) that this Hand has been tracked.
Since
1.0
String toString ( )

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

Returns
A description of the Hand as a string.
Since
1.0
Vector translation ( Frame  sinceFrame)

The change of position of this hand between the current frame and the specified frame.

Vector linearHandMovement = hand.translation(startFrame);
Parameters
sinceFrameThe starting frame for computing the translation.
Returns
A Vector representing the heuristically determined change in hand position between the current frame and that specified in the sinceFrame parameter.
Deprecated:
3.0
float translationProbability ( Frame  sinceFrame)

The estimated probability that the hand motion between the current frame and the specified frame is intended to be a translating motion.

float translationIntentFactor = hand.translationProbability(startFrame);
Parameters
sinceFrameThe starting frame for computing the translation.
Returns
A value between 0 and 1 representing the estimated probability that the hand motion between the current frame and the specified frame is intended to be a translating motion.
Deprecated:
3.0
Vector wristPosition ( )

The position of the wrist of this hand.

Returns
A vector containing the coordinates of the wrist position in millimeters.
Since
2.0.3