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

#include <XnCppWrapper.h>

Inheritance diagram for xn::HandsGenerator:
Inheritance graph

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

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

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

const HandTouchingFOVEdgeCapability xn::HandsGenerator::GetHandTouchingFOVEdgeCap ( ) const
inline

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

HandTouchingFOVEdgeCapability xn::HandsGenerator::GetHandTouchingFOVEdgeCap ( )
inline

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

XnStatus xn::HandsGenerator::StopTracking ( XnUserID  user)
inline

Stop tracking a specific hand. For full details and usage, see xnStopTracking

XnStatus xn::HandsGenerator::StopTrackingAll ( )
inline

Stop tracking all hands. For full details and usage, see xnStopTrackingAll

void xn::HandsGenerator::UnregisterHandCallbacks ( XnCallbackHandle  hCallback)
inline

Unregister from hands callbacks. For full details and usage, see xnUnregisterHandCallbacks


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