nite::SkeletonJoint Class Reference

#include <NiTE.h>

Inheritance diagram for nite::SkeletonJoint:

[legend]

List of all members.

Public Member Functions
const Quaternion &	getOrientation () const
float	getOrientationConfidence () const
const Point3f &	getPosition () const
float	getPositionConfidence () const
JointType	getType () const

---

Detailed Description

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:

nite::Skeleton for more information about the Skeleton algorithm.

---

Member Function Documentation

const Quaternion& nite::SkeletonJoint::getOrientation

(

)

const [inline]

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

float nite::SkeletonJoint::getOrientationConfidence

(

)

const [inline]

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

const Point3f& nite::SkeletonJoint::getPosition

(

)

const [inline]

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.

float nite::SkeletonJoint::getPositionConfidence

(

)

const [inline]

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

JointType nite::SkeletonJoint::getType

(

)

const [inline]

Gets the type of the joint represented by this particular object.

Returns:

Type of the joint.

See also:

JointType enumeration for a list of all possible joint types.

---

The documentation for this class was generated from the following file:

• NiTE.h