com.primesense.nite
Class SkeletonJoint

java.lang.Object
  extended by com.primesense.nite.SkeletonJoint

public class SkeletonJoint
extends java.lang.Object

This class provides a data structure to store the output of the Skeleton algorithm.
The basic purpose of the skeleton algorithm is to locate each of a user's joints, and to estimate the position and orientation of each joint in space. The output from the Skeleton algorithm is stored as a series of SkeletonJoint objects.

See Also:
Skeleton

Method Summary
 JointType getJointType()
          Gets the type of the joint represented by this particular object.
 Quaternion getOrientation()
          Get the current orientation of the joint represented by this object.
 float getOrientationConfidence()
          Indicates how sure the NiTE skeleton algorithm is about the orientation data stored about this joint.
 Point3D<java.lang.Float> getPosition()
          Get the current position of the joint.
 float getPositionConfidence()
          Indicates how sure the NiTE skeleton algorithm is about the position data stored about this joint.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getJointType

public JointType getJointType()
Gets the type of the joint represented by this particular object.

Returns:
Type of the joint.
See Also:
JointType

getPosition

public Point3D<java.lang.Float> getPosition()
Get the current position of the joint. This will be represented as a point in space. The coordinates used are "real world" coordinates. See the OpenNI2 documentation for more information on coordinate systems.

A confidence value is also available via the getPositionConfidence() function to indicate how sure the algorithm is of this value.

Returns:
Position in space of the joint.

getPositionConfidence

public float getPositionConfidence()
Indicates how sure the NiTE skeleton algorithm is about the position data stored about this joint. The value is between 0 and 1, with increasing value indicating increasing confidence.

Returns:
Confidence value between 0 and 1

getOrientation

public Quaternion getOrientation()
Get the current orientation of the joint represented by this object. This orientation will be represented by a Quaternion.

A confidence value is also available via the getOrientationConfidence() function to indicate how sure the algorithm is of this value.

Returns:
Joint orientation

getOrientationConfidence

public float getOrientationConfidence()
Indicates how sure the NiTE skeleton algorithm is about the orientation data stored about this joint. The value is between 0 and 1, with increasing value indicating increasing confidence.

Returns:
Confidence value between 0 and 1