xn::HandTouchingFOVEdgeCapability Class Reference
[Production Nodes Functionality]

#include <XnCppWrapper.h>

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

List of all members.

Classes

struct  HandTouchingFOVEdgeCookie

Public Types

typedef void(XN_CALLBACK_TYPE * HandTouchingFOVEdge )(HandTouchingFOVEdgeCapability &touchingfov, XnUserID user, const XnPoint3D *pPosition, XnFloat fTime, XnDirection eDir, void *pCookie)

Public Member Functions

 HandTouchingFOVEdgeCapability (XnNodeHandle hNode)
 HandTouchingFOVEdgeCapability (const NodeWrapper &node)
XnStatus RegisterToHandTouchingFOVEdge (HandTouchingFOVEdge handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromHandTouchingFOVEdge (XnCallbackHandle hCallback)

Detailed Description

Allows access to Hand touching FOV edge capability functions.

Usage: Do not instantiate directly. Instead, use HandsGenerator::GetHandTouchingFOVEdgeCap() to obtain an instance.


Member Typedef Documentation

typedef void(XN_CALLBACK_TYPE* xn::HandTouchingFOVEdgeCapability::HandTouchingFOVEdge)(HandTouchingFOVEdgeCapability &touchingfov, XnUserID user, const XnPoint3D *pPosition, XnFloat fTime, XnDirection eDir, void *pCookie)

Callback for the hand getting close to the edge of the FOV

Parameters:
[in] touchingfov the hand touching fov edge capability that raised this event.
[in] user ID of the hand that disappeared.
[in] pPosition Position of the hand.
[in] fTime Timestamp, in seconds.
[in] eDir Direction of the FOV touched
[in] pCookie User-provided cookie that was given when registering to this event.

Constructor & Destructor Documentation

xn::HandTouchingFOVEdgeCapability::HandTouchingFOVEdgeCapability ( XnNodeHandle  hNode  )  [inline]

Ctor

Parameters:
[in] hNode Node handle
xn::HandTouchingFOVEdgeCapability::HandTouchingFOVEdgeCapability ( const NodeWrapper node  )  [inline]

Member Function Documentation

XnStatus xn::HandTouchingFOVEdgeCapability::RegisterToHandTouchingFOVEdge ( HandTouchingFOVEdge  handler,
void *  pCookie,
XnCallbackHandle hCallback 
) [inline]

Registers an event handler for the 'Hand Touching FOV Edge' event.

Parameters:
[in] handler Callback function to be invoked when the event is raised.
[in] pCookie User's cookie, to be delivered to the callback.
[out] hCallback Handle to the callback to be used for unregistering it.

For full details and usage of the parameters, see Registering to Events.

void xn::HandTouchingFOVEdgeCapability::UnregisterFromHandTouchingFOVEdge ( XnCallbackHandle  hCallback  )  [inline]

Unregisters an event handler for the 'Hand Touching FOV Edge' event.

Parameters:
[in] hCallback Handle received from registration.

For full details and usage of the parameter, see Unregistering from Events .


The documentation for this class was generated from the following file:
Generated on Thu Dec 20 21:49:33 2012 for OpenNI 1.5.4 by  doxygen 1.6.3