OpenNI 1.0.0

xn::GestureGenerator Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::GestureGenerator:

List of all members.

Classes

struct  GestureCookie

Public Types

typedef void(* GestureRecognized )(GestureGenerator &generator, const XnChar *strGesture, const XnPoint3D *pIDPosition, const XnPoint3D *pEndPosition, void *pCookie)
typedef void(* GestureProgress )(GestureGenerator &generator, const XnChar *strGesture, const XnPoint3D *pPosition, XnFloat fProgress, void *pCookie)

Public Member Functions

 GestureGenerator (XnNodeHandle hNode=NULL)
XnStatus AddGesture (const XnChar *strGesture, XnBoundingBox3D *pArea)
XnStatus RemoveGesture (const XnChar *strGesture)
XnStatus GetActiveGestures (XnChar *&astrGestures, XnUInt16 &nGestures) const
XnStatus GetAllActiveGestures (XnChar **astrGestures, XnUInt32 nNameLength, XnUInt16 &nGestures) const
XnStatus EnumerateGestures (XnChar *&astrGestures, XnUInt16 &nGestures)
XnStatus EnumerateAllGestures (XnChar **astrGestures, XnUInt32 nNameLength, XnUInt16 &nGestures)
XnBool IsGestureAvailable (const XnChar *strGesture)
XnBool IsGestureProgressSupported (const XnChar *strGesture)
XnStatus RegisterGestureCallbacks (GestureRecognized RecognizedCB, GestureProgress ProgressCB, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterGestureCallbacks (XnCallbackHandle hCallback)
XnStatus RegisterToGestureChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromGestureChange (XnCallbackHandle hCallback)
XnStatus Create (Context &context, Query *pQuery=NULL, EnumerationErrors *pErrors=NULL)

Detailed Description

Represents a Gestures Generator


Member Typedef Documentation

typedef void(* xn::GestureGenerator::GestureProgress)(GestureGenerator &generator, const XnChar *strGesture, const XnPoint3D *pPosition, XnFloat fProgress, void *pCookie)

Callback for indication that a certain gesture is in progress

Parameters:
generator[in] The node that raised the event.
strGesture[in] The gesture that is on its way to being recognized.
pPosition[in] The current position of the hand that is performing the gesture.
fProgress[in] The percentage of the gesture that was already performed.
pCookie[in] A user-provided cookie that was given when registering to this event.
typedef void(* xn::GestureGenerator::GestureRecognized)(GestureGenerator &generator, const XnChar *strGesture, const XnPoint3D *pIDPosition, const XnPoint3D *pEndPosition, void *pCookie)

Callback for the recognition of a gesture

Parameters:
generator[in] The node that raised the event.
strGesture[in] The gesture that was recognized.
pIDPosition[in] The position in which the gesture was identified.
pEndPosition[in] The position of the hand that performed the gesture at the end of the gesture.
pCookie[in] A user-provided cookie that was given when registering to this event.

Constructor & Destructor Documentation

xn::GestureGenerator::GestureGenerator ( XnNodeHandle  hNode = NULL) [inline]

Ctor

Parameters:
hNode[in] Node handle

Member Function Documentation

XnStatus xn::GestureGenerator::AddGesture ( const XnChar *  strGesture,
XnBoundingBox3D pArea 
) [inline]

Turn on gesture. The generator will now look for this gesture.

For full details and usage, see xnAddGesture

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

Creates a Gesture Generator.

For full details and usage, see xnCreateGestureGenerator

XnStatus xn::GestureGenerator::EnumerateAllGestures ( XnChar **  astrGestures,
XnUInt32  nNameLength,
XnUInt16 &  nGestures 
) [inline]

Get the names of all gestures available.

For full details and usage, see xnEnumerateGestures

XnStatus xn::GestureGenerator::EnumerateGestures ( XnChar *&  astrGestures,
XnUInt16 &  nGestures 
) [inline]

Get the names of all gestures available.

For full details and usage, see xnEnumerateGestures

XnStatus xn::GestureGenerator::GetActiveGestures ( XnChar *&  astrGestures,
XnUInt16 &  nGestures 
) const [inline]

Get the names of the gestures that are currently active.

For full details and usage, see xnGetActiveGestures

XnStatus xn::GestureGenerator::GetAllActiveGestures ( XnChar **  astrGestures,
XnUInt32  nNameLength,
XnUInt16 &  nGestures 
) const [inline]

Get the names of the gestures that are currently active.

For full details and usage, see xnGetActiveGestures

XnBool xn::GestureGenerator::IsGestureAvailable ( const XnChar *  strGesture) [inline]

Check if a specific gesture is available in this generator.

For full details and usage, see xnIsGestureAvailable

XnBool xn::GestureGenerator::IsGestureProgressSupported ( const XnChar *  strGesture) [inline]

Check if the specific gesture supports 'in progress' callbacks.

For full details and usage, see xnIsGestureProgressSupported

XnStatus xn::GestureGenerator::RegisterGestureCallbacks ( GestureRecognized  RecognizedCB,
GestureProgress  ProgressCB,
void *  pCookie,
XnCallbackHandle hCallback 
) [inline]
For full details and usage, see RegisterGestureCallbacks

XnStatus xn::GestureGenerator::RegisterToGestureChange ( StateChangedHandler  handler,
void *  pCookie,
XnCallbackHandle hCallback 
) [inline]

Register to when gestures are added or removed.

For full details and usage, see xnRegisterToGestureChange

XnStatus xn::GestureGenerator::RemoveGesture ( const XnChar *  strGesture) [inline]

Turn off gesture. The generator will no longer look for this gesture.

For full details and usage, see xnRemoveGesture

void xn::GestureGenerator::UnregisterFromGestureChange ( XnCallbackHandle  hCallback) [inline]

Unregister from when gestures are added or removed.

For full details and usage, see xnUnregisterFromGestureChange

void xn::GestureGenerator::UnregisterGestureCallbacks ( XnCallbackHandle  hCallback) [inline]

Unregister from gesture callbacks.

For full details and usage, see xnUnregisterGestureCallbacks


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