xn::UserGenerator Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::UserGenerator:

List of all members.

Classes
struct	UserCookie
Public Types
typedef void(XN_CALLBACK_TYPE *	UserHandler )(UserGenerator &generator, XnUserID user, void *pCookie)
Public Member Functions
XnStatus	GetCoM (XnUserID user, XnPoint3D &com) const
XnUInt16	GetNumberOfUsers () const
PoseDetectionCapability	GetPoseDetectionCap ()
SkeletonCapability	GetSkeletonCap ()
XnStatus	GetUserPixels (XnUserID user, SceneMetaData &smd)
XnStatus	GetUsers (XnUserID aUsers[], XnUInt16 &nUsers) const
XnStatus	RegisterUserCallbacks (UserHandler NewUserCB, UserHandler LostUserCB, void *pCookie, XnCallbackHandle &hCallback)
void	UnregisterUserCallbacks (XnCallbackHandle hCallback)
	UserGenerator (XnNodeHandle hNode=NULL)
XnStatus	Create (Context &context, Query *pQuery=NULL, EnumerationErrors *pErrors=NULL)
Private Types
typedef struct xn::UserGenerator::UserCookie	UserCookie
Static Private Member Functions
static void XN_CALLBACK_TYPE	LostUserCallback (XnNodeHandle hNode, XnUserID user, void *pCookie)
static void XN_CALLBACK_TYPE	NewUserCallback (XnNodeHandle hNode, XnUserID user, void *pCookie)

---

Detailed Description

Represents a User Generator node

Definition at line 3594 of file XnCppWrapper.h.

---

Member Typedef Documentation

typedef struct xn::UserGenerator::UserCookie xn::UserGenerator::UserCookie [private]

typedef void(XN_CALLBACK_TYPE* xn::UserGenerator::UserHandler)(UserGenerator &generator, XnUserID user, void *pCookie)

Definition at line 3609 of file XnCppWrapper.h.

---

Constructor & Destructor Documentation

xn::UserGenerator::UserGenerator

(

XnNodeHandle

hNode = NULL

)

[inline]

Ctor

Parameters:

hNode

[in] Node handle

Definition at line 3602 of file XnCppWrapper.h.

---

Member Function Documentation

XnStatus xn::UserGenerator::Create	(	Context &	context,
		Query *	pQuery = NULL,
		EnumerationErrors *	pErrors = NULL
	)		[inline]

Creates a user generator.

For full details and usage, see xnCreateUserGenerator

Definition at line 4629 of file XnCppWrapper.h.

XnStatus xn::UserGenerator::GetCoM	(	XnUserID	user,
		XnPoint3D &	com
	)		const [inline]

Get the center of mass of a user.

For full details and usage, see xnGetUserCoM

Definition at line 3630 of file XnCppWrapper.h.

XnUInt16 xn::UserGenerator::GetNumberOfUsers

(

)

const [inline]

Get current number of users.

For full details and usage, see xnGetNumberOfUsers

Definition at line 3614 of file XnCppWrapper.h.

PoseDetectionCapability xn::UserGenerator::GetPoseDetectionCap

(

)

[inline]

Gets an PoseDetectionCapability object for accessing Pose-Detection functionality. It is the application responsibility to check first if XN_CAPABILITY_POSE_DETECTION is supported by calling IsCapabilitySupported().

Definition at line 3693 of file XnCppWrapper.h.

SkeletonCapability xn::UserGenerator::GetSkeletonCap

(

)

[inline]

Gets an SkeletonCapability object for accessing Skeleton functionality. It is the application responsibility to check first if XN_CAPABILITY_SKELETON is supported by calling IsCapabilitySupported().

Definition at line 3683 of file XnCppWrapper.h.

XnStatus xn::UserGenerator::GetUserPixels	(	XnUserID	user,
		SceneMetaData &	smd
	)		[inline]

Get the pixels that belong to a user.

For full details and usage, see xnGetUserPixels

Definition at line 3638 of file XnCppWrapper.h.

XnStatus xn::UserGenerator::GetUsers	(	XnUserID	aUsers[],
		XnUInt16 &	nUsers
	)		const [inline]

Get the current users.

For full details and usage, see xnGetUsers

Definition at line 3622 of file XnCppWrapper.h.

static void XN_CALLBACK_TYPE xn::UserGenerator::LostUserCallback	(	XnNodeHandle	hNode,
		XnUserID	user,
		void *	pCookie
	)		[inline, static, private]

Definition at line 3714 of file XnCppWrapper.h.

static void XN_CALLBACK_TYPE xn::UserGenerator::NewUserCallback	(	XnNodeHandle	hNode,
		XnUserID	user,
		void *	pCookie
	)		[inline, static, private]

Definition at line 3707 of file XnCppWrapper.h.

XnStatus xn::UserGenerator::RegisterUserCallbacks	(	UserHandler	NewUserCB,
		UserHandler	LostUserCB,
		void *	pCookie,
		XnCallbackHandle &	hCallback
	)		[inline]

Register to user callbacks.

For full details and usage, see xnRegisterUserCallbacks

Definition at line 3646 of file XnCppWrapper.h.

void xn::UserGenerator::UnregisterUserCallbacks

(

XnCallbackHandle

hCallback

)

[inline]

Unregister from user callbacks.

For full details and usage, see xnUnregisterUserCallbacks

Definition at line 3671 of file XnCppWrapper.h.

---

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

• XnCppWrapper.h