OpenNI 1.3.2
Classes | Public Types | Public Member Functions | List of all members
xn::SkeletonCapability Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::SkeletonCapability:
Inheritance graph

Public Types

typedef void(* CalibrationStart )(SkeletonCapability &skeleton, XnUserID user, void *pCookie)
 
typedef void(* CalibrationEnd )(SkeletonCapability &skeleton, XnUserID user, XnBool bSuccess, void *pCookie)
 
typedef void(* CalibrationInProgress )(SkeletonCapability &skeleton, XnUserID user, XnCalibrationStatus calibrationError, void *pCookie)
 
typedef void(* CalibrationComplete )(SkeletonCapability &skeleton, XnUserID user, XnCalibrationStatus calibrationError, void *pCookie)
 

Public Member Functions

 SkeletonCapability (XnNodeHandle hNode)
 
 SkeletonCapability (const NodeWrapper &node)
 
XnBool IsJointAvailable (XnSkeletonJoint eJoint) const
 
XnBool IsProfileAvailable (XnSkeletonProfile eProfile) const
 
XnStatus SetSkeletonProfile (XnSkeletonProfile eProfile)
 
XnStatus SetJointActive (XnSkeletonJoint eJoint, XnBool bState)
 
XnBool IsJointActive (XnSkeletonJoint eJoint, XnBool) const
 
XnBool IsJointActive (XnSkeletonJoint eJoint) const
 
XnStatus RegisterToJointConfigurationChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
 
void UnregisterFromJointConfigurationChange (XnCallbackHandle hCallback)
 
XnStatus EnumerateActiveJoints (XnSkeletonJoint *pJoints, XnUInt16 &nJoints) const
 
XnStatus GetSkeletonJoint (XnUserID user, XnSkeletonJoint eJoint, XnSkeletonJointTransformation &Joint) const
 
XnStatus GetSkeletonJointPosition (XnUserID user, XnSkeletonJoint eJoint, XnSkeletonJointPosition &Joint) const
 
XnStatus GetSkeletonJointOrientation (XnUserID user, XnSkeletonJoint eJoint, XnSkeletonJointOrientation &Joint) const
 
XnBool IsTracking (XnUserID user) const
 
XnBool IsCalibrated (XnUserID user) const
 
XnBool IsCalibrating (XnUserID user) const
 
XnStatus RequestCalibration (XnUserID user, XnBool bForce)
 
XnStatus AbortCalibration (XnUserID user)
 
XnStatus SaveCalibrationDataToFile (XnUserID user, const XnChar *strFileName)
 
XnStatus LoadCalibrationDataFromFile (XnUserID user, const XnChar *strFileName)
 
XnStatus SaveCalibrationData (XnUserID user, XnUInt32 nSlot)
 
XnStatus LoadCalibrationData (XnUserID user, XnUInt32 nSlot)
 
XnStatus ClearCalibrationData (XnUInt32 nSlot)
 
XnBool IsCalibrationData (XnUInt32 nSlot) const
 
XnStatus StartTracking (XnUserID user)
 
XnStatus StopTracking (XnUserID user)
 
XnStatus Reset (XnUserID user)
 
XnBool NeedPoseForCalibration () const
 
XnStatus GetCalibrationPose (XnChar *strPose) const
 
XnStatus SetSmoothing (XnFloat fSmoothingFactor)
 
XnStatus RegisterCalibrationCallbacks (CalibrationStart CalibrationStartCB, CalibrationEnd CalibrationEndCB, void *pCookie, XnCallbackHandle &hCallback)
 
void UnregisterCalibrationCallbacks (XnCallbackHandle hCallback)
 
XnStatus RegisterToCalibrationStart (CalibrationStart handler, void *pCookie, XnCallbackHandle &hCallback)
 
XnStatus UnregisterFromCalibrationStart (XnCallbackHandle hCallback)
 
XnStatus RegisterToCalibrationInProgress (CalibrationInProgress handler, void *pCookie, XnCallbackHandle &hCallback)
 
void UnregisterFromCalibrationInProgress (XnCallbackHandle hCallback)
 
XnStatus RegisterToCalibrationComplete (CalibrationComplete handler, void *pCookie, XnCallbackHandle &hCallback)
 
void UnregisterFromCalibrationComplete (XnCallbackHandle hCallback)
 
- Public Member Functions inherited from xn::Capability
 Capability (XnNodeHandle hNode)
 
 Capability (const NodeWrapper &node)
 
- Public Member Functions inherited from xn::NodeWrapper
 NodeWrapper (XnNodeHandle hNode)
 
 NodeWrapper (const NodeWrapper &other)
 
NodeWrapperoperator= (const NodeWrapper &other)
 
 ~NodeWrapper ()
 
 operator XnNodeHandle () const
 
XnNodeHandle GetHandle () const
 
XnBool operator== (const NodeWrapper &other)
 
XnBool operator!= (const NodeWrapper &other)
 
XnBool IsValid () const
 
const XnChar * GetName () const
 
XnStatus AddRef ()
 
void Release ()
 
XnStatus Ref ()
 
void Unref ()
 
void SetHandle (XnNodeHandle hNode)
 
void TakeOwnership (XnNodeHandle hNode)
 

Detailed Description

Allows access to Skeleton capability functions. see Skeleton Capability for additional details.

Member Typedef Documentation

typedef void(* xn::SkeletonCapability::CalibrationComplete)(SkeletonCapability &skeleton, XnUserID user, XnCalibrationStatus calibrationError, void *pCookie)

Callback for indication that a specific user's skeleton has now completed the calibration process, with a status

Parameters
hNode[in] The node that raised the event.
user[in] The id of the user for which calibration was attempted.
calibrationError[in] The status in which the calibration has ended.
pCookie[in] A user-provided cookie that was given when registering to this event.
typedef void(* xn::SkeletonCapability::CalibrationEnd)(SkeletonCapability &skeleton, XnUserID user, XnBool bSuccess, void *pCookie)

Callback for indication that a specific user's skeleton has now completed the calibration process

Parameters
hNode[in] The node that raised the event.
user[in] The id of the user for which calibration was attempted.
bSuccess[in] An indication of whether or not the calibration attempt succeeded.
pCookie[in] A user-provided cookie that was given when registering to this event.
typedef void(* xn::SkeletonCapability::CalibrationInProgress)(SkeletonCapability &skeleton, XnUserID user, XnCalibrationStatus calibrationError, void *pCookie)

Callback for indication that a specific user's skeleton is calibrating, and its current status

Parameters
hNode[in] The node that raised the event.
user[in] The id of the user for which calibration was attempted.
calibrationError[in] the current status of the calibration
pCookie[in] A user-provided cookie that was given when registering to this event.
typedef void(* xn::SkeletonCapability::CalibrationStart)(SkeletonCapability &skeleton, XnUserID user, void *pCookie)

Callback for indication that a specific user's skeleton is now starting the calibration process

Parameters
skeleton[in] The node that raised the event.
user[in] The id of the user that's being calibrated.
pCookie[in] A user-provided cookie that was given when registering to this event.

Constructor & Destructor Documentation

xn::SkeletonCapability::SkeletonCapability ( XnNodeHandle  hNode)
inline

Ctor

Parameters
hNode[in] Node handle
xn::SkeletonCapability::SkeletonCapability ( const NodeWrapper node)
inline

Member Function Documentation

XnStatus xn::SkeletonCapability::AbortCalibration ( XnUserID  user)
inline

stop calibration

For full details and usage, see xnAbortSkeletonCalibration

XnStatus xn::SkeletonCapability::ClearCalibrationData ( XnUInt32  nSlot)
inline

Clear the requested slot from any saved calibration data.

For full details and usage, see xnClearSkeletonCalibrationData

XnStatus xn::SkeletonCapability::EnumerateActiveJoints ( XnSkeletonJoint pJoints,
XnUInt16 &  nJoints 
) const
inline

Get all active joints.

For full details and usage, see xnEnumerateActiveJoints

XnStatus xn::SkeletonCapability::GetCalibrationPose ( XnChar *  strPose) const
inline

Get the pose that is required for calibration.

For full details and usage, see xnGetSkeletonCalibrationPose

XnStatus xn::SkeletonCapability::GetSkeletonJoint ( XnUserID  user,
XnSkeletonJoint  eJoint,
XnSkeletonJointTransformation Joint 
) const
inline

Get a specific joint's full information.

For full details and usage, see xnGetSkeletonJoint

XnStatus xn::SkeletonCapability::GetSkeletonJointOrientation ( XnUserID  user,
XnSkeletonJoint  eJoint,
XnSkeletonJointOrientation Joint 
) const
inline

Get a specific joint's orientation.

For full details and usage, see xnGetSkeletonJointOrientation

XnStatus xn::SkeletonCapability::GetSkeletonJointPosition ( XnUserID  user,
XnSkeletonJoint  eJoint,
XnSkeletonJointPosition Joint 
) const
inline

Get a specific joint's position.

For full details and usage, see xnGetSkeletonJointPosition

XnBool xn::SkeletonCapability::IsCalibrated ( XnUserID  user) const
inline

Check if skeleton is being calibrated.

For full details and usage, see xnIsSkeletonCalibrated

XnBool xn::SkeletonCapability::IsCalibrating ( XnUserID  user) const
inline

Check if skeleton is being calibrated.

For full details and usage, see xnIsSkeletonCalibrating

XnBool xn::SkeletonCapability::IsCalibrationData ( XnUInt32  nSlot) const
inline

Check if a specific slot already holds calibration data.

For full details and usage, see xnIsSkeletonCalibrationData

XnBool xn::SkeletonCapability::IsJointActive ( XnSkeletonJoint  eJoint,
XnBool   
) const
inline

Check if joint is currently active.

For full details and usage, see xnIsJointActive

XnBool xn::SkeletonCapability::IsJointActive ( XnSkeletonJoint  eJoint) const
inline

Check if joint is currently active.

For full details and usage, see xnIsJointActive

XnBool xn::SkeletonCapability::IsJointAvailable ( XnSkeletonJoint  eJoint) const
inline

Check if generator supports a specific joint.

For full details and usage, see xnIsJointAvailable

XnBool xn::SkeletonCapability::IsProfileAvailable ( XnSkeletonProfile  eProfile) const
inline

Check if generator supports a specific profile.

For full details and usage, see xnIsProfileAvailable

XnBool xn::SkeletonCapability::IsTracking ( XnUserID  user) const
inline

Check if skeleton is being tracked.

For full details and usage, see xnIsSkeletonTracking

XnStatus xn::SkeletonCapability::LoadCalibrationData ( XnUserID  user,
XnUInt32  nSlot 
)
inline

Load previously saved calibration data.

For full details and usage, see xnLoadSkeletonCalibrationData

XnStatus xn::SkeletonCapability::LoadCalibrationDataFromFile ( XnUserID  user,
const XnChar *  strFileName 
)
inline

Load previously saved calibration data from file.

For full details and usage, see xnLoadSkeletonCalibrationDataFromFile

XnBool xn::SkeletonCapability::NeedPoseForCalibration ( ) const
inline

Check if a specific pose is required for calibration.

For full details and usage, see xnNeedPoseForSkeletonCalibration

XnStatus xn::SkeletonCapability::RegisterCalibrationCallbacks ( CalibrationStart  CalibrationStartCB,
CalibrationEnd  CalibrationEndCB,
void *  pCookie,
XnCallbackHandle hCallback 
)
inline

Register to calibration callbacks.

For full details and usage, see xnRegisterCalibrationCallbacks

XnStatus xn::SkeletonCapability::RegisterToCalibrationComplete ( CalibrationComplete  handler,
void *  pCookie,
XnCallbackHandle hCallback 
)
inline

Register to when calibration is complete, with status.

For full details and usage, see xnRegisterToCalibrationComplete

XnStatus xn::SkeletonCapability::RegisterToCalibrationInProgress ( CalibrationInProgress  handler,
void *  pCookie,
XnCallbackHandle hCallback 
)
inline

Register to calibration status while calibration is in progress.

For full details and usage, see xnRegisterToCalibrationInProgress

XnStatus xn::SkeletonCapability::RegisterToCalibrationStart ( CalibrationStart  handler,
void *  pCookie,
XnCallbackHandle hCallback 
)
inline

Register to calibration start callback.

For full details and usage, see xnRegisterToCalibrationStart

XnStatus xn::SkeletonCapability::RegisterToJointConfigurationChange ( StateChangedHandler  handler,
void *  pCookie,
XnCallbackHandle hCallback 
)
inline

Register to joint configuration changes - when joints are activated and deactivated.

For full details and usage, see xnRegisterToJointConfigurationChange

XnStatus xn::SkeletonCapability::RequestCalibration ( XnUserID  user,
XnBool  bForce 
)
inline

Request calibration when possible.

For full details and usage, see xnRequestSkeletonCalibration

XnStatus xn::SkeletonCapability::Reset ( XnUserID  user)
inline

Reset the skeleton - discard calibration.

For full details and usage, see xnResetSkeleton

XnStatus xn::SkeletonCapability::SaveCalibrationData ( XnUserID  user,
XnUInt32  nSlot 
)
inline

Save the calibration data.

For full details and usage, see xnSaveSkeletonCalibrationData

XnStatus xn::SkeletonCapability::SaveCalibrationDataToFile ( XnUserID  user,
const XnChar *  strFileName 
)
inline

Save the calibration data to file.

For full details and usage, see xnSaveSkeletonCalibrationDataToFile

XnStatus xn::SkeletonCapability::SetJointActive ( XnSkeletonJoint  eJoint,
XnBool  bState 
)
inline

Change the state of a specific joint, to be active or inactive.

For full details and usage, see xnSetJointActive

XnStatus xn::SkeletonCapability::SetSkeletonProfile ( XnSkeletonProfile  eProfile)
inline

Set the profile. this will set some joints to be active, and others to be inactive.

For full details and usage, see xnSetSkeletonProfile

XnStatus xn::SkeletonCapability::SetSmoothing ( XnFloat  fSmoothingFactor)
inline

Set the skeleton's smoothing factor.

For full details and usage, see xnSetSkeletonSmoothing

XnStatus xn::SkeletonCapability::StartTracking ( XnUserID  user)
inline

Start tracking a skeleton.

For full details and usage, see xnStartSkeletonTracking

XnStatus xn::SkeletonCapability::StopTracking ( XnUserID  user)
inline

Stop tracking a skeleton.

For full details and usage, see xnStopSkeletonTracking

void xn::SkeletonCapability::UnregisterCalibrationCallbacks ( XnCallbackHandle  hCallback)
inline

Unregister from calibration callbacks.

For full details and usage, see xnUnregisterCalibrationCallbacks

void xn::SkeletonCapability::UnregisterFromCalibrationComplete ( XnCallbackHandle  hCallback)
inline

Unregister from calibration complete with status.

For full details and usage, see xnUnregisterFromCalibrationComplete

void xn::SkeletonCapability::UnregisterFromCalibrationInProgress ( XnCallbackHandle  hCallback)
inline

Unregister from calibration status while in progress.

For full details and usage, see xnUnregisterFromCalibrationInProgress

XnStatus xn::SkeletonCapability::UnregisterFromCalibrationStart ( XnCallbackHandle  hCallback)
inline

Unregister from calibration start callback.

For full details and usage, see xnUnregisterFromCalibrationStart

void xn::SkeletonCapability::UnregisterFromJointConfigurationChange ( XnCallbackHandle  hCallback)
inline

Unregister from joint configuration changes.

For full details and usage, see xnUnregisterFromJointConfigurationChange


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