#include <XnCppWrapper.h>

Inheritance diagram for xn::SkeletonCapability:

Classes
struct	SkeletonCookie
Public Types
typedef void(XN_CALLBACK_TYPE *	CalibrationEnd )(SkeletonCapability &skeleton, XnUserID user, XnBool bSuccess, void *pCookie)
typedef void(XN_CALLBACK_TYPE *	CalibrationStart )(SkeletonCapability &skeleton, XnUserID user, void *pCookie)
Public Member Functions
XnStatus	AbortCalibration (XnUserID user)
XnStatus	ClearCalibrationData (XnUInt32 nSlot)
XnStatus	EnumerateActiveJoints (XnSkeletonJoint *pJoints, XnUInt16 &nJoints)
XnStatus	GetCalibrationPose (XnChar *strPose)
XnStatus	GetSkeletonJoint (XnUserID user, XnSkeletonJoint eJoint, XnSkeletonJointTransformation &Joint) const
XnStatus	GetSkeletonJointOrientation (XnUserID user, XnSkeletonJoint eJoint, XnSkeletonJointOrientation &Joint) const
XnStatus	GetSkeletonJointPosition (XnUserID user, XnSkeletonJoint eJoint, XnSkeletonJointPosition &Joint) const
XnBool	IsCalibrated (XnUserID user)
XnBool	IsCalibrating (XnUserID user)
XnBool	IsCalibrationData (XnUInt32 nSlot)
XnBool	IsJointActive (XnSkeletonJoint eJoint, XnBool bState)
XnBool	IsJointAvailable (XnSkeletonJoint eJoint) const
XnBool	IsProfileAvailable (XnSkeletonProfile eProfile) const
XnBool	IsTracking (XnUserID user)
XnStatus	LoadCalibrationData (XnUserID user, XnUInt32 nSlot)
XnBool	NeedPoseForCalibration ()
XnStatus	RegisterCalibrationCallbacks (CalibrationStart CalibrationStartCB, CalibrationEnd CalibrationEndCB, void *pCookie, XnCallbackHandle &hCallback)
XnStatus	RegisterToJointConfigurationChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
XnStatus	RequestCalibration (XnUserID user, XnBool bForce)
XnStatus	Reset (XnUserID user)
XnStatus	SaveCalibrationData (XnUserID user, XnUInt32 nSlot)
XnStatus	SetJointActive (XnSkeletonJoint eJoint, XnBool bState)
XnStatus	SetSkeletonProfile (XnSkeletonProfile eProfile)
XnStatus	SetSmoothing (XnFloat fSmoothingFactor)
	SkeletonCapability (XnNodeHandle hNode)
XnStatus	StartTracking (XnUserID user)
XnStatus	StopTracking (XnUserID user)
void	UnregisterCalibrationCallbacks (XnCallbackHandle hCallback)
void	UnregisterFromJointConfigurationChange (XnCallbackHandle hCallback)
Private Types
typedef struct xn::SkeletonCapability::SkeletonCookie	SkeletonCookie
Static Private Member Functions
static void XN_CALLBACK_TYPE	CalibrationEndCallback (XnNodeHandle hNode, XnUserID user, XnBool bSuccess, void *pCookie)
static void XN_CALLBACK_TYPE	CalibrationStartCallback (XnNodeHandle hNode, XnUserID user, void *pCookie)

Detailed Description

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

Definition at line 3181 of file XnCppWrapper.h.

Member Typedef Documentation

typedef void(XN_CALLBACK_TYPE* 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.

Definition at line 3415 of file XnCppWrapper.h.

typedef void(XN_CALLBACK_TYPE* 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.

Definition at line 3406 of file XnCppWrapper.h.

typedef struct xn::SkeletonCapability::SkeletonCookie xn::SkeletonCapability::SkeletonCookie [private]

Constructor & Destructor Documentation

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

Ctor

Parameters:

hNode [in] Node handle

Definition at line 3189 of file XnCppWrapper.h.

Member Function Documentation

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

stop calibration

For full details and usage, see xnAbortSkeletonCalibration

Definition at line 3314 of file XnCppWrapper.h.

static void XN_CALLBACK_TYPE xn::SkeletonCapability::CalibrationEndCallback	(	XnNodeHandle	hNode,
		XnUserID	user,
		XnBool	bSuccess,
		void *	pCookie
	)		`[inline, static, private]`

Definition at line 3468 of file XnCppWrapper.h.

static void XN_CALLBACK_TYPE xn::SkeletonCapability::CalibrationStartCallback	(	XnNodeHandle	hNode,
		XnUserID	user,
		void *	pCookie
	)		`[inline, static, private]`

Definition at line 3461 of file XnCppWrapper.h.

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

Clear the requested slot from any saved calibration data.

For full details and usage, see xnClearSkeletonCalibrationData

Definition at line 3338 of file XnCppWrapper.h.

XnStatus xn::SkeletonCapability::EnumerateActiveJoints	(	XnSkeletonJoint *	pJoints,
		XnUInt16 &	nJoints
	)		`[inline]`

Get all active joints.

For full details and usage, see xnEnumerateActiveJoints

Definition at line 3250 of file XnCppWrapper.h.

XnStatus xn::SkeletonCapability::GetCalibrationPose ( XnChar * strPose ) [inline]

Get the pose that is required for calibration.

For full details and usage, see xnGetSkeletonCalibrationPose

Definition at line 3386 of file XnCppWrapper.h.

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

Definition at line 3258 of file XnCppWrapper.h.

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

Definition at line 3274 of file XnCppWrapper.h.

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

Definition at line 3266 of file XnCppWrapper.h.

XnBool xn::SkeletonCapability::IsCalibrated ( XnUserID user ) [inline]

Check if skeleton is being calibrated.

For full details and usage, see xnIsSkeletonCalibrated

Definition at line 3290 of file XnCppWrapper.h.

XnBool xn::SkeletonCapability::IsCalibrating ( XnUserID user ) [inline]

Check if skeleton is being calibrated.

For full details and usage, see xnIsSkeletonCalibrating

Definition at line 3298 of file XnCppWrapper.h.

XnBool xn::SkeletonCapability::IsCalibrationData ( XnUInt32 nSlot ) [inline]

Check if a specific slot already holds calibration data.

For full details and usage, see xnIsSkeletonCalibrationData

Definition at line 3346 of file XnCppWrapper.h.

XnBool xn::SkeletonCapability::IsJointActive	(	XnSkeletonJoint	eJoint,
		XnBool	bState
	)		`[inline]`

Check if joint is currently active.

For full details and usage, see xnIsJointActive

Definition at line 3226 of file XnCppWrapper.h.

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

Check if generator supports a specific joint.

For full details and usage, see xnIsJointAvailable

Definition at line 3194 of file XnCppWrapper.h.

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

Check if generator supports a specific profile.

For full details and usage, see xnIsProfileAvailable

Definition at line 3202 of file XnCppWrapper.h.

XnBool xn::SkeletonCapability::IsTracking ( XnUserID user ) [inline]

Check if skeleton is being tracked.

For full details and usage, see xnIsSkeletonTracking

Definition at line 3282 of file XnCppWrapper.h.

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

Load previously saved calibration data.

For full details and usage, see xnLoadSkeletonCalibrationData

Definition at line 3330 of file XnCppWrapper.h.

XnBool xn::SkeletonCapability::NeedPoseForCalibration ( ) [inline]

Check if a specific pose is required for calibration.

For full details and usage, see xnNeedPoseForSkeletonCalibration

Definition at line 3378 of file XnCppWrapper.h.

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

Register to calibration callbacks.

For full details and usage, see xnRegisterCalibrationCallbacks

Definition at line 3420 of file XnCppWrapper.h.

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

Definition at line 3234 of file XnCppWrapper.h.

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

Request calibration when possible.

For full details and usage, see xnRequestSkeletonCalibration

Definition at line 3306 of file XnCppWrapper.h.

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

Reset the skeleton - discard calibration.

For full details and usage, see xnResetSkeleton

Definition at line 3370 of file XnCppWrapper.h.

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

Save the calibration data.

For full details and usage, see xnSaveSkeletonCalibrationData

Definition at line 3322 of file XnCppWrapper.h.

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

Definition at line 3218 of file XnCppWrapper.h.

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

Definition at line 3210 of file XnCppWrapper.h.

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

Set the skeleton's smoothing factor.

For full details and usage, see xnSetSkeletonSmoothing

Definition at line 3394 of file XnCppWrapper.h.

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

Start tracking a skeleton.

For full details and usage, see xnStartSkeletonTracking

Definition at line 3354 of file XnCppWrapper.h.

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

Stop tracking a skeleton.

For full details and usage, see xnStopSkeletonTracking

Definition at line 3362 of file XnCppWrapper.h.

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

Unregister from calibration callbacks.

For full details and usage, see xnUnregisterCalibrationCallbacks

Definition at line 3445 of file XnCppWrapper.h.

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

Unregister from joint configuration changes.

For full details and usage, see xnUnregisterFromJointConfigurationChange

Definition at line 3242 of file XnCppWrapper.h.

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

XnCppWrapper.h

Classes

Public Types

Public Member Functions

Private Types

Static Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation