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

#include <XnCppWrapper.h>

Inheritance diagram for xn::GestureGenerator:
Inheritance graph

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

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

Ctor

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

Member Function Documentation

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

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

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

Creates a Gesture Generator.

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

Get the names of all gestures available.

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

Get the names of all gestures available.

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

Get the names of the gestures that are currently active.

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

Get the names of the gestures that are currently active.

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

Check if a specific gesture is available in this generator.

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

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

XnStatus xn::GestureGenerator::RegisterGestureCallbacks ( GestureRecognized  RecognizedCB,
GestureProgress  ProgressCB,
void *  pCookie,
XnCallbackHandle hCallback 
)
inline
XnStatus xn::GestureGenerator::RegisterToGestureChange ( StateChangedHandler  handler,
void *  pCookie,
XnCallbackHandle hCallback 
)
inline

Register to when gestures are added or removed.

XnStatus xn::GestureGenerator::RegisterToGestureIntermediateStageCompleted ( GestureIntermediateStageCompleted  handler,
void *  pCookie,
XnCallbackHandle hCallback 
)
inline

Register to when a gesture is in progress.

XnStatus xn::GestureGenerator::RegisterToGestureReadyForNextIntermediateStage ( GestureReadyForNextIntermediateStage  handler,
void *  pCookie,
XnCallbackHandle hCallback 
)
inline

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

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

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

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

Unregister from when gestures are added or removed.

void xn::GestureGenerator::UnregisterFromGestureIntermediateStageCompleted ( XnCallbackHandle  hCallback)
inline

Unregister from when a gesture is in progress.

void xn::GestureGenerator::UnregisterFromGestureReadyForNextIntermediateStageCallbacks ( XnCallbackHandle  hCallback)
inline

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

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

Unregister from gesture callbacks.


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