OpenNI 1.5.4: xn::HandTouchingFOVEdgeCapability Class Reference

OpenNI

xn::HandTouchingFOVEdgeCapability Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::HandTouchingFOVEdgeCapability:

List of all members.

Classes

struct  HandTouchingFOVEdgeCookie

Public Types

typedef void(* 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::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]touchingfovthe hand touching fov edge capability that raised this event.
[in]userID of the hand that disappeared.
[in]pPositionPosition of the hand.
[in]fTimeTimestamp, in seconds.
[in]eDirDirection of the FOV touched
[in]pCookieUser-provided cookie that was given when registering to this event.

Constructor & Destructor Documentation

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

Ctor

Parameters:
[in]hNodeNode 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]handlerCallback function to be invoked when the event is raised.
[in]pCookieUser's cookie, to be delivered to the callback.
[out]hCallbackHandle 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]hCallbackHandle 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 Wed May 16 2012 10:16:07 for OpenNI 1.5.4 by   doxygen 1.7.5.1