OpenNI 1.3.2
Classes | Public Types | Public Member Functions
xn::GestureGenerator Class Reference

#include <XnCppWrapper.h>

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

List of all members.

Classes

struct  GestureCookie
struct  GestureIntermediateStageCompletedCookie
struct  GestureReadyForNextIntermediateStageCookie

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)
typedef void(* GestureIntermediateStageCompleted )(GestureGenerator &generator, const XnChar *strGesture, const XnPoint3D *pPosition, void *pCookie)
typedef void(* GestureReadyForNextIntermediateStage )(GestureGenerator &generator, const XnChar *strGesture, const XnPoint3D *pPosition, void *pCookie)

Public Member Functions

 GestureGenerator (XnNodeHandle hNode=NULL)
 GestureGenerator (const NodeWrapper &other)
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) const
XnStatus EnumerateAllGestures (XnChar **astrGestures, XnUInt32 nNameLength, XnUInt16 &nGestures) const
XnBool IsGestureAvailable (const XnChar *strGesture) const
XnBool IsGestureProgressSupported (const XnChar *strGesture) const
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 RegisterToGestureIntermediateStageCompleted (GestureIntermediateStageCompleted handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromGestureIntermediateStageCompleted (XnCallbackHandle hCallback)
XnStatus RegisterToGestureReadyForNextIntermediateStage (GestureReadyForNextIntermediateStage handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromGestureReadyForNextIntermediateStageCallbacks (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::GestureIntermediateStageCompleted)(GestureGenerator &generator, const XnChar *strGesture, const XnPoint3D *pPosition, 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.
pCookie[in] A user-provided cookie that was given when registering to this event.
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::GestureReadyForNextIntermediateStage)(GestureGenerator &generator, const XnChar *strGesture, const XnPoint3D *pPosition, void *pCookie)

Callback for indication that a certain gesture is ready for its next stage (whatever that is)

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

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 
) const [inline]

Get the names of all gestures available.

For full details and usage, see xnEnumerateAllGestures

XnStatus xn::GestureGenerator::EnumerateGestures ( XnChar *&  astrGestures,
XnUInt16 &  nGestures 
) const [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) const [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) const [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

Register to when a gesture is in progress.

For full details and usage, see xnRegisterToGestureIntermediateStageCompleted

Register to when a gesture is ready for its next stage (specific to the gesture)

For full details and usage, see xnRegisterToGestureReadyForNextIntermediateStage

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

Unregister from when gestures are added or removed.

For full details and usage, see xnUnregisterFromGestureChange

Unregister from when a gesture is in progress.

For full details and usage, see xnUnregisterFromGestureIntermediateStageCompleted

Unregister from when a gesture is ready for its next stage.

For full details and usage, see xnUnregisterFromGestureReadyForNextIntermediateStage

Unregister from gesture callbacks.

For full details and usage, see xnUnregisterGestureCallbacks


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