XnVPushDetector.h

Go to the documentation of this file.

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


#ifndef _XNV_PUSH_DETECTOR_H_
#define _XNV_PUSH_DETECTOR_H_

#include "XnVNiteDefs.h"
#include "XnVPointControl.h"
#include "XnV3DVector.h"

class XnVPointBuffer;
class XnVFloatFloatSpecificEvent;
class XnVFloatSpecificEvent;
class XNV_NITE_API XnVPushDetector :
    public XnVPointControl
{
public:
    typedef void (XN_CALLBACK_TYPE *PushCB)(XnFloat fVelocity, XnFloat fAngle, void* UserCxt);
    typedef void (XN_CALLBACK_TYPE *StabilizedCB)(XnFloat fVelocity, void* UserCxt);

    XnVPushDetector(const XnChar* strName = "XnVPushDetector");
    ~XnVPushDetector();

    void OnPrimaryPointCreate(const XnVHandPointContext* pContext, const XnPoint3D& ptFocus);
    void OnPrimaryPointUpdate(const XnVHandPointContext* pContext);

    XnCallbackHandle RegisterPush(void* cxt, PushCB pCB);
    XnCallbackHandle RegisterStabilized(void* cxt, StabilizedCB pCB);

    void UnregisterPush(XnCallbackHandle handle);
    void UnregisterStabilized(XnCallbackHandle handle);

    XnUInt32 GetPushDuration() const;

    void Reset();

    XnFloat GetPushImmediateMinimumVelocity() const;
    XnUInt32 GetPushImmediateDuration() const;
    XnUInt32 GetPushImmediateOffset() const;

    XnFloat GetPushPreviousMinimumVelocity() const;
    XnUInt32 GetPushPreviousDuration() const;
    XnUInt32 GetPushPreviousOffset() const;

    XnFloat GetPushMaximumAngleBetweenImmediateAndZ() const;
    XnFloat GetPushMinimumAngleBetweenImmediateAndPrevious() const;
    
    XnFloat GetStableMaximumVelocity() const;
    XnUInt32 GetStableDuration() const;

    void SetPushImmediateMinimumVelocity(XnFloat fVelocity);
    void SetPushImmediateDuration(XnUInt32 nDuration);
    void SetPushImmediateOffset(XnUInt32 nOffset);

    void SetPushPreviousMinimumVelocity(XnFloat fVelocity);
    void SetPushPreviousDuration(XnUInt32 nDuration);
    void SetPushPreviousOffset(XnUInt32 nOffset);

    void SetPushMaximumAngleBetweenImmediateAndZ(XnFloat fAngle);
    void SetPushMinimumAngleBetweenImmediateAndPrevious(XnFloat fAngle);

    void SetStableMaximumVelocity(XnFloat fVelocity);
    void SetStableDuration(XnUInt32 nDuration);
protected:
    XnBool IsPushDetected(const XnV3DVector& vImmediateVelocity, const XnV3DVector& vPreviousVelocity, XnFloat& fZAngle);
    XnBool IsStabilized(XnFloat fTime, XnFloat& fVelocity);
    void UpdateLines(XnFloat fTime);

    void AddPoint(const XnPoint3D& pt, XnFloat fTime);

    XnFloat AngleBetweenVectors(const XnV3DVector& v1, const XnV3DVector& v2);

    XnBool m_bPushDetected;

    XnVPointBuffer* m_pPoints;

    XnFloat m_fPushImmediateMinVelocity;
    XnUInt32 m_nPushImmediateOffset;
    XnUInt32 m_nPushImmediateDuration;

    XnFloat m_fPushPreviousMinVelocity;
    XnUInt32 m_nPushPreviousOffset;
    XnUInt32 m_nPushPreviousDuration;

    XnFloat m_fPushMaxAngleFromZ;
    XnFloat m_fPushMinAngleImmediateAndPrevious;

    XnFloat m_fStableMaxVelocity;
    XnUInt32 m_nStableDuration;

    // CBs
    void PushDetected(XnFloat fVelocity, XnFloat fAngle);
    void StabilizedDetected(XnFloat fVelocity);

    XnVFloatFloatSpecificEvent* m_pPushCBs;
    XnVFloatSpecificEvent* m_pStabilizedCBs;
}; // XnVPushDetector

#endif // _XNV_PUSH_DETECTOR_H_