XnVSwipeDetector.h

Go to the documentation of this file.

/*******************************************************************************
*                                                                              *
*   PrimeSense NITE 1.3                                                        *
*   Copyright (C) 2010 PrimeSense Ltd.                                         *
*                                                                              *
*******************************************************************************/


#ifndef _XNV_SWIPE_DETECTOR_H_
#define _XNV_SWIPE_DETECTOR_H_

#include "XnVNiteDefs.h"
#include "XnVPointControl.h"
#include "XnVDirection.h"

#include "XnVSteadyDetector.h"

class XnVPointBuffer;
class XnVFloatFloatSpecificEvent;
class XnVGeneralSwipeSpecificEvent;
class XNV_NITE_API XnVSwipeDetector :
    public XnVPointControl
{
public:
    typedef void (XN_CALLBACK_TYPE *SwipeCB)(XnFloat fVelocity, XnFloat fAngle, void* pUserCxt);
    typedef void (XN_CALLBACK_TYPE *GeneralSwipeCB)(XnVDirection eDir, XnFloat fVelocity, XnFloat fAngle, void* pUserCxt);

    XnVSwipeDetector(XnBool bUseSteadyBeforeSwipe = true, const XnChar* strName = "XnVSwipeDetector");
    ~XnVSwipeDetector();

    void OnPrimaryPointCreate(const XnVHandPointContext* pContext, const XnPoint3D& ptFocus);
    void OnPrimaryPointUpdate(const XnVHandPointContext* pContext);
    void OnPrimaryPointReplace(XnUInt32 nOldId, const XnVHandPointContext* pContext);
    void OnPrimaryPointDestroy(XnUInt32 nID);
    void Reset();

    // Events
    XnCallbackHandle RegisterSwipeUp(void* cxt, SwipeCB pCB); // Add CB to list
    XnCallbackHandle RegisterSwipeDown(void* cxt, SwipeCB pCB); // Add CB to list
    XnCallbackHandle RegisterSwipeLeft(void* cxt, SwipeCB pCB); // Add CB to list
    XnCallbackHandle RegisterSwipeRight(void* cxt, SwipeCB pCB); // Add CB to list
    XnCallbackHandle RegisterSwipe(void* cxt, GeneralSwipeCB pCB);

    void UnregisterSwipeUp(XnCallbackHandle handle);
    void UnregisterSwipeDown(XnCallbackHandle handle);
    void UnregisterSwipeLeft(XnCallbackHandle handle);
    void UnregisterSwipeRight(XnCallbackHandle handle);
    void UnregisterSwipe(XnCallbackHandle handle);

    void SetMotionSpeedThreshold(XnFloat fThreshold);
    XnFloat GetMotionSpeedThreshold() const;

    void SetMotionTime(XnUInt32 nThreshold);
    XnUInt32 GetMotionTime() const;

    void SetXAngleThreshold(XnFloat fThreshold);
    XnFloat GetXAngleThreshold() const;

    void SetYAngleThreshold(XnFloat fThreshold);
    XnFloat GetYAngleThreshold() const;

    void SetSteadyMaxStdDev(XnFloat fStdDev);
    XnFloat GetSteadyMaxStdDev() const;

    XnFloat XN_API_DEPRECATED("Use GetSteadyMaxStdDev() instead")
        GetSteadyMaxVelocity() const;
    void XN_API_DEPRECATED("Use SetSteadyMaxStdDev() instead")
        SetSteadyMaxVelocity(XnFloat fVelocity);

    void SetSteadyDuration(XnUInt32 nDuration);
    XnUInt32 GetSteadyDuration() const;

    void SetUseSteady(XnBool bUse);
    XnBool GetUseSteady() const;
protected:
    XnStatus AddPoint(const XnPoint3D& pt, XnFloat fTime);

    static void XN_CALLBACK_TYPE Steady_Steady(XnUInt32 nId, XnFloat fVelocity, void* cxt);

    XnVPointBuffer* m_pMovementDetectionBuffer;

    static const XnFloat ms_fDefaultMotionDetectionVelocity;    // = 0.25f
    static const XnUInt32 ms_nDefaultMotionDetectionDuration;   // = 350 ms

    XnFloat m_fMotionDetectionSpeed;
    XnUInt32 m_nMotionDetectionTime;

    XnFloat m_fLowestVelocity;
    XnBool m_bWaitingForSlowdown;

    XnFloat m_fAngleXThreshold;
    XnFloat m_fAngleYThreshold;

    XnVFloatFloatSpecificEvent* m_pPendingEvent;
    XnVDirection m_ePendingDirection;
    XnFloat m_fPendingVelocity;
    XnFloat m_fPendingAngle;

    XnVFloatFloatSpecificEvent* m_pSwipeDownCBs;
    XnVFloatFloatSpecificEvent* m_pSwipeUpCBs;
    XnVFloatFloatSpecificEvent* m_pSwipeLeftCBs;
    XnVFloatFloatSpecificEvent* m_pSwipeRightCBs;

    XnVGeneralSwipeSpecificEvent* m_pSwipeCBs;

    XnBool m_bUseSteady;
    XnBool m_bInSteady;
    XnVSteadyDetector m_Steady;
}; // XnVSwipeDetector

#endif // _XNV_SWIPE_DETECTOR_H_