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

#include <XnCppWrapper.h>

Inheritance diagram for xn::UserGenerator:
Inheritance graph

Classes

struct  UserCookie
struct  UserSingleCookie

Public Types

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

Public Member Functions

 UserGenerator (XnNodeHandle hNode=NULL)
 UserGenerator (const NodeWrapper &other)
XnUInt16 GetNumberOfUsers () const
XnStatus GetUsers (XnUserID aUsers[], XnUInt16 &nUsers) const
XnStatus GetCoM (XnUserID user, XnPoint3D &com) const
XnStatus GetUserPixels (XnUserID user, SceneMetaData &smd) const
XnStatus RegisterUserCallbacks (UserHandler NewUserCB, UserHandler LostUserCB, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterUserCallbacks (XnCallbackHandle hCallback)
const SkeletonCapability GetSkeletonCap () const
SkeletonCapability GetSkeletonCap ()
const PoseDetectionCapability GetPoseDetectionCap () const
PoseDetectionCapability GetPoseDetectionCap ()
XnStatus RegisterToUserExit (UserHandler handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromUserExit (XnCallbackHandle hCallback)
XnStatus RegisterToUserReEnter (UserHandler handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromUserReEnter (XnCallbackHandle hCallback)
XnStatus Create (Context &context, Query *pQuery=NULL, EnumerationErrors *pErrors=NULL)
- Public Member Functions inherited from xn::Generator
 Generator (XnNodeHandle hNode=NULL)
 Generator (const NodeWrapper &other)
XnStatus StartGenerating ()
XnBool IsGenerating () const
XnStatus StopGenerating ()
XnStatus RegisterToGenerationRunningChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromGenerationRunningChange (XnCallbackHandle hCallback)
XnStatus RegisterToNewDataAvailable (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromNewDataAvailable (XnCallbackHandle hCallback)
XnBool IsNewDataAvailable (XnUInt64 *pnTimestamp=NULL) const
XnStatus WaitAndUpdateData ()
XnBool IsDataNew () const
const void * GetData ()
XnUInt32 GetDataSize () const
XnUInt64 GetTimestamp () const
XnUInt32 GetFrameID () const
const MirrorCapability GetMirrorCap () const
MirrorCapability GetMirrorCap ()
const
AlternativeViewPointCapability 
GetAlternativeViewPointCap () const
AlternativeViewPointCapability GetAlternativeViewPointCap ()
const FrameSyncCapability GetFrameSyncCap () const
FrameSyncCapability GetFrameSyncCap ()
- Public Member Functions inherited from xn::ProductionNode
 ProductionNode (XnNodeHandle hNode=NULL)
 ProductionNode (const NodeWrapper &other)
NodeInfo GetInfo () const
XnStatus AddNeededNode (ProductionNode &needed)
XnStatus RemoveNeededNode (ProductionNode &needed)
XnBool IsCapabilitySupported (const XnChar *strCapabilityName) const
XnStatus SetIntProperty (const XnChar *strName, XnUInt64 nValue)
XnStatus SetRealProperty (const XnChar *strName, XnDouble dValue)
XnStatus SetStringProperty (const XnChar *strName, const XnChar *strValue)
XnStatus SetGeneralProperty (const XnChar *strName, XnUInt32 nBufferSize, const void *pBuffer)
XnStatus GetIntProperty (const XnChar *strName, XnUInt64 &nValue) const
XnStatus GetRealProperty (const XnChar *strName, XnDouble &dValue) const
XnStatus GetStringProperty (const XnChar *strName, XnChar *csValue, XnUInt32 nBufSize) const
XnStatus GetGeneralProperty (const XnChar *strName, XnUInt32 nBufferSize, void *pBuffer) const
XnStatus LockForChanges (XnLockHandle *phLock)
void UnlockForChanges (XnLockHandle hLock)
XnStatus LockedNodeStartChanges (XnLockHandle hLock)
void LockedNodeEndChanges (XnLockHandle hLock)
const ErrorStateCapability GetErrorStateCap () const
ErrorStateCapability GetErrorStateCap ()
GeneralIntCapability GetGeneralIntCap (const XnChar *strCapability)
void GetContext (Context &context) const
- 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

Represents a User Generator node

Member Typedef Documentation

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

Constructor & Destructor Documentation

xn::UserGenerator::UserGenerator ( XnNodeHandle  hNode = NULL)
inline

Ctor

Parameters
hNode[in] Node handle
xn::UserGenerator::UserGenerator ( const NodeWrapper other)
inline

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

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

XnUInt16 xn::UserGenerator::GetNumberOfUsers ( ) const
inline

Get current number of users. For full details and usage, see xnGetNumberOfUsers

const PoseDetectionCapability xn::UserGenerator::GetPoseDetectionCap ( ) const
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().

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().

const SkeletonCapability xn::UserGenerator::GetSkeletonCap ( ) const
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().

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().

XnStatus xn::UserGenerator::GetUserPixels ( XnUserID  user,
SceneMetaData smd 
) const
inline

Get the pixels that belong to a user. For full details and usage, see xnGetUserPixels

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

Get the current users. For full details and usage, see xnGetUsers

XnStatus xn::UserGenerator::RegisterToUserExit ( UserHandler  handler,
void *  pCookie,
XnCallbackHandle hCallback 
)
inline

Register to when the user exits the scene (but not lost yet) For full details and usage, see xnRegisterToUserExit

XnStatus xn::UserGenerator::RegisterToUserReEnter ( UserHandler  handler,
void *  pCookie,
XnCallbackHandle hCallback 
)
inline

Register to when a user re-enters the scene after exiting. For full details and usage, see xnRegisterToUserReEnter

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

Register to user callbacks. For full details and usage, see xnRegisterUserCallbacks

void xn::UserGenerator::UnregisterFromUserExit ( XnCallbackHandle  hCallback)
inline

Unregister from when a user exits the scene. For full details and usage, see xnUnregisterFromUserExit

void xn::UserGenerator::UnregisterFromUserReEnter ( XnCallbackHandle  hCallback)
inline

Unregister from when a user re-enters the scene. For full details and usage, see xnUnregisterFromUserReEnter

void xn::UserGenerator::UnregisterUserCallbacks ( XnCallbackHandle  hCallback)
inline

Unregister from user callbacks. For full details and usage, see xnUnregisterUserCallbacks


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