OpenNI 1.5.2
Classes | Public Types | Public Member Functions
xn::HandsGenerator Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::HandsGenerator:
Inheritance graph
[legend]

List of all members.

Classes

struct  HandCookie

Public Types

typedef void(* HandCreate )(HandsGenerator &generator, XnUserID user, const XnPoint3D *pPosition, XnFloat fTime, void *pCookie)
typedef void(* HandUpdate )(HandsGenerator &generator, XnUserID user, const XnPoint3D *pPosition, XnFloat fTime, void *pCookie)
typedef void(* HandDestroy )(HandsGenerator &generator, XnUserID user, XnFloat fTime, void *pCookie)

Public Member Functions

 HandsGenerator (XnNodeHandle hNode=NULL)
 HandsGenerator (const NodeWrapper &other)
XnStatus RegisterHandCallbacks (HandCreate CreateCB, HandUpdate UpdateCB, HandDestroy DestroyCB, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterHandCallbacks (XnCallbackHandle hCallback)
XnStatus StopTracking (XnUserID user)
XnStatus StopTrackingAll ()
XnStatus StartTracking (const XnPoint3D &ptPosition)
XnStatus SetSmoothing (XnFloat fSmoothingFactor)
const HandTouchingFOVEdgeCapability GetHandTouchingFOVEdgeCap () const
HandTouchingFOVEdgeCapability GetHandTouchingFOVEdgeCap ()
XnStatus Create (Context &context, Query *pQuery=NULL, EnumerationErrors *pErrors=NULL)

Detailed Description

Represents a Hands Generator node


Member Typedef Documentation

typedef void(* xn::HandsGenerator::HandCreate)(HandsGenerator &generator, XnUserID user, const XnPoint3D *pPosition, XnFloat fTime, void *pCookie)

Callback for the creation of a new hand.

Parameters:
generator[in] the generator that raised this event.
user[in] The id of the new hand.
pPosition[in] The position in which the hand was created.
fTime[in] Timestamp, in seconds.
pCookie[in] A user-provided cookie that was given when registering to this event.
typedef void(* xn::HandsGenerator::HandDestroy)(HandsGenerator &generator, XnUserID user, XnFloat fTime, void *pCookie)

Callback for the disappearance of a hand.

Parameters:
generator[in] the generator that raised this event.
user[in] The id of the hand that disappeared.
fTime[in] Timestamp, in seconds.
pCookie[in] A user-provided cookie that was given when registering to this event.
typedef void(* xn::HandsGenerator::HandUpdate)(HandsGenerator &generator, XnUserID user, const XnPoint3D *pPosition, XnFloat fTime, void *pCookie)

Callback for a new position of an already-existing hand.

Parameters:
generator[in] the generator that raised this event.
user[in] The id of the hand that moved.
pPosition[in] The new position of the relevant hand.
fTime[in] Timestamp, in seconds.
pCookie[in] A user-provided cookie that was given when registering to this event.

Constructor & Destructor Documentation

Ctor

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

Member Function Documentation

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

Creates an hands generator.

For full details and usage, see xnCreateHandsGenerator

Gets an HandTouchingFOVEdgeCapability object for accessing hand touching FOV edge callbacks functionality. It is the application responsibility to check first if XN_CAPABILITY_HAND_TOUCHING_FOV_EDGE is supported by calling IsCapabilitySupported().

Gets an HandTouchingFOVEdgeCapability object for accessing hand touching FOV edge callbacks functionality. It is the application responsibility to check first if XN_CAPABILITY_HAND_TOUCHING_FOV_EDGE is supported by calling IsCapabilitySupported().

XnStatus xn::HandsGenerator::RegisterHandCallbacks ( HandCreate  CreateCB,
HandUpdate  UpdateCB,
HandDestroy  DestroyCB,
void *  pCookie,
XnCallbackHandle hCallback 
) [inline]

Register to hands callbacks.

For full details and usage, see xnRegisterHandCallbacks

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

Change smoothing factor.

For full details and usage, see xnSetTrackingSmoothing

XnStatus xn::HandsGenerator::StartTracking ( const XnPoint3D ptPosition) [inline]

Start tracking at a specific position.

For full details and usage, see xnStartTracking

Stop tracking a specific hand.

For full details and usage, see xnStopTracking

Stop tracking all hands.

For full details and usage, see xnStopTrackingAll

Unregister from hands callbacks.

For full details and usage, see xnUnregisterHandCallbacks


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