xn::PoseDetectionCapability Class Reference [C++ Reference]

#include <XnCppWrapper.h>

Inheritance diagram for xn::PoseDetectionCapability:

List of all members.

Classes
struct	PoseCookie
struct	PoseDetectionCookie
struct	PoseInProgressCookie
Public Types
typedef void(*	PoseDetection )(PoseDetectionCapability &pose, const XnChar *strPose, XnUserID user, void *pCookie)
typedef void(*	PoseInProgress )(PoseDetectionCapability &pose, const XnChar *strPose, XnUserID user, XnPoseDetectionStatus poseError, void *pCookie)
Public Member Functions
	PoseDetectionCapability (XnNodeHandle hNode)
	PoseDetectionCapability (const NodeWrapper &node)
XnUInt32	GetNumberOfPoses () const
XnStatus	GetAvailablePoses (XnChar **pstrPoses, XnUInt32 &nPoses) const
XnStatus	GetAllAvailablePoses (XnChar **pstrPoses, XnUInt32 nNameLength, XnUInt32 &nPoses) const
XnBool	IsPoseSupported (const XnChar *strPose)
XnStatus	GetPoseStatus (XnUserID userID, const XnChar *poseName, XnUInt64 &poseTime, XnPoseDetectionStatus &eStatus, XnPoseDetectionState &eState)
XnStatus	StartPoseDetection (const XnChar *strPose, XnUserID user)
XnStatus	StopPoseDetection (XnUserID user)
XnStatus	StopSinglePoseDetection (XnUserID user, const XnChar *strPose)
XnStatus	RegisterToPoseCallbacks (PoseDetection PoseStartCB, PoseDetection PoseEndCB, void *pCookie, XnCallbackHandle &hCallback)
void	UnregisterFromPoseCallbacks (XnCallbackHandle hCallback)
XnStatus	RegisterToPoseDetected (PoseDetection handler, void *pCookie, XnCallbackHandle &hCallback)
XnStatus	RegisterToOutOfPose (PoseDetection handler, void *pCookie, XnCallbackHandle &hCallback)
void	UnregisterFromPoseDetected (XnCallbackHandle hCallback)
void	UnregisterFromOutOfPose (XnCallbackHandle hCallback)
XnStatus	RegisterToPoseInProgress (PoseInProgress handler, void *pCookie, XnCallbackHandle &hCallback)
void	UnregisterFromPoseInProgress (XnCallbackHandle hCallback)

---

Detailed Description

Allows access to Pose Detection capability functions. see Pose Detection Capability for additional details.

---

Member Typedef Documentation

typedef void(* xn::PoseDetectionCapability::PoseDetection)(PoseDetectionCapability &pose, const XnChar *strPose, XnUserID user, void *pCookie)

Callback for indication that a specific user has entered a pose, or left it.

Parameters:

	pose	[in] The node that raised the event.
	strPose	[in] The pose that is relevant to the callback.
	user	[in] The id of the user that entered the pose or left it.
	pCookie	[in] A user-provided cookie that was given when registering to this event.

typedef void(* xn::PoseDetectionCapability::PoseInProgress)(PoseDetectionCapability &pose, const XnChar *strPose, XnUserID user, XnPoseDetectionStatus poseError, void *pCookie)

Callback for indication of the current status of pose detection for a user

Parameters:

	pose	[in] The node that raised the event.
	strPose	[in] The pose that is relevant to the callback.
	user	[in] The id of the user that entered the pose or left it.
	poseError	[in] The current status of the pose detection
	pCookie	[in] A user-provided cookie that was given when registering to this event.

---

Constructor & Destructor Documentation

xn::PoseDetectionCapability::PoseDetectionCapability

(

XnNodeHandle

hNode

)

[inline]

Ctor

Parameters:

hNode

[in] Node handle

xn::PoseDetectionCapability::PoseDetectionCapability

(

const NodeWrapper &

node

)

[inline]

---

Member Function Documentation

XnStatus xn::PoseDetectionCapability::GetAllAvailablePoses	(	XnChar **	pstrPoses,
		XnUInt32	nNameLength,
		XnUInt32 &	nPoses
	)			const [inline]

Get the names of the supported poses.

For full details and usage, see xnGetAvailablePoses

XnStatus xn::PoseDetectionCapability::GetAvailablePoses	(	XnChar **	pstrPoses,
		XnUInt32 &	nPoses
	)			const [inline]

Get the names of the supported poses.

For full details and usage, see xnGetAvailablePoses

XnUInt32 xn::PoseDetectionCapability::GetNumberOfPoses

(

)

const [inline]

Get the number of the supported poses.

For full details and usage, see xnGetNumberOfPoses

XnStatus xn::PoseDetectionCapability::GetPoseStatus	(	XnUserID	userID,
		const XnChar *	poseName,
		XnUInt64 &	poseTime,
		XnPoseDetectionStatus &	eStatus,
		XnPoseDetectionState &	eState
	)			[inline]

XnBool xn::PoseDetectionCapability::IsPoseSupported

(

const XnChar *

strPose

)

[inline]

XnStatus xn::PoseDetectionCapability::RegisterToOutOfPose	(	PoseDetection	handler,
		void *	pCookie,
		XnCallbackHandle &	hCallback
	)			[inline]

Register to callback when a use is no longer in pose.

For full details and usage, see xnRegisterToOutOfPose

XnStatus xn::PoseDetectionCapability::RegisterToPoseCallbacks	(	PoseDetection	PoseStartCB,
		PoseDetection	PoseEndCB,
		void *	pCookie,
		XnCallbackHandle &	hCallback
	)			[inline]

Register to callbacks for pose events.

For full details and usage, see xnRegisterToPoseCallbacks

XnStatus xn::PoseDetectionCapability::RegisterToPoseDetected	(	PoseDetection	handler,
		void *	pCookie,
		XnCallbackHandle &	hCallback
	)			[inline]

Register to callback when a user is in pose.

For full details and usage, see xnRegisterToPoseDetected

XnStatus xn::PoseDetectionCapability::RegisterToPoseInProgress	(	PoseInProgress	handler,
		void *	pCookie,
		XnCallbackHandle &	hCallback
	)			[inline]

Register to callback for status when pose is detected.

For full details and usage, see xnRegisterToPoseDetectionInProgress

XnStatus xn::PoseDetectionCapability::StartPoseDetection	(	const XnChar *	strPose,
		XnUserID	user
	)			[inline]

Start detection of a specific pose for a specific user.

For full details and usage, see xnStartPoseDetection

XnStatus xn::PoseDetectionCapability::StopPoseDetection

(

XnUserID

user

)

[inline]

Stop detection of poses for a specific user.

For full details and usage, see xnStopPoseDetection

XnStatus xn::PoseDetectionCapability::StopSinglePoseDetection	(	XnUserID	user,
		const XnChar *	strPose
	)			[inline]

Stop detection of a specific pose for a specific user.

For full details and usage, see xnStopSinglePoseDetection

void xn::PoseDetectionCapability::UnregisterFromOutOfPose

(

XnCallbackHandle

hCallback

)

[inline]

Unregister from out of pose callback.

For full details and usage, see xnUnregisterFromOutOfPose

void xn::PoseDetectionCapability::UnregisterFromPoseCallbacks

(

XnCallbackHandle

hCallback

)

[inline]

Unregister from calibration callbacks.

For full details and usage, see xnUnregisterCalibrationCallbacks

void xn::PoseDetectionCapability::UnregisterFromPoseDetected

(

XnCallbackHandle

hCallback

)

[inline]

Unregister from pose detected callback.

For full details and usage, see xnUnregisterFromPoseDetected

void xn::PoseDetectionCapability::UnregisterFromPoseInProgress

(

XnCallbackHandle

hCallback

)

[inline]

Unregister from pose status callback.

For full details and usage, see xnUnregisterFromPoseDetectionInProgress

---

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

• XnCppWrapper.h