XnVSlider1D.h

Go to the documentation of this file.

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


#ifndef _XNV_SLIDER_1D_H_
#define _XNV_SLIDER_1D_H_

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

class XnVPointBuffer;
class XnVFloatSpecificEvent;
class XnVDirectionSpecificEvent;

class XNV_NITE_API XnVSlider1D
{
public:
    typedef void (XN_CALLBACK_TYPE* ValueChangeCB)(XnFloat fValue, void* cxt);
    typedef void (XN_CALLBACK_TYPE* OffAxisMovementCB)(XnVDirection eDir, void* cxt);

    XnVSlider1D(XnVAxis eAxis, const XnPoint3D& ptInitialPosition, XnPoint3D ptMinPoint, XnPoint3D ptMaxPoint,
        XnFloat fMinOutput, XnFloat fMaxOutput,
        XnFloat fOffAxisDetectionAngle = ms_fOffAxisDefaultDetectionAngle,
        XnFloat fOffAxisDetectionMinimumVelocity = ms_fDefaultMinimumOffAxisVelocity); 
    XnVSlider1D(XnVAxis eAxis, const XnPoint3D& ptInitialPosition, XnFloat fSliderLength, XnFloat fInitialValue,
        XnFloat fMinOutput, XnFloat fMaxOutput,
        XnFloat fOffAxisDetectionAngle = ms_fOffAxisDefaultDetectionAngle,
        XnFloat fOffAxisDetectionMinimumVelocity = ms_fDefaultMinimumOffAxisVelocity);

    ~XnVSlider1D();

    void Reinitialize(XnVAxis eAxis, const XnPoint3D& ptInitialPoint, const XnPoint3D& ptMinPoint,
        const XnPoint3D& ptMaxPoint, XnFloat fMinOutput, XnFloat fMaxOutput);
    void Reinitialize(XnVAxis eAxis, const XnPoint3D& ptInitialPoint, XnFloat fSliderLength,
        XnFloat fInitialValue, XnFloat fMinOutput, XnFloat fMaxOutput);

    XnFloat ValueAtPosition(const XnPoint3D& pt);

    XnStatus Update(const XnPoint3D& pt, XnFloat fTime, XnBool bCheckOffAxis = true);

    void LostPoint();

    XnCallbackHandle RegisterValueChange(void* cxt, ValueChangeCB CB);
    XnCallbackHandle RegisterOffAxisMovement(void* cxt, OffAxisMovementCB CB);

    void UnregisterValueChange(XnCallbackHandle hCB);
    void UnregisterOffAxisMovement(XnCallbackHandle hCB);

    XnFloat GetValue() const;
    const XnPoint3D& GetPosition() const;
    XnBool IsValid() const;

    XnVAxis GetAxis() const;

    XnFloat  GetOffAxisDetectionVelocity() const;
    XnFloat  GetOffAxisDetectionAngle() const;
    XnUInt32 GetOffAxisDetectionTime() const;

    void SetOffAxisDetectionVelocity(XnFloat fVelocity);
    void SetOffAxisDetectionAngle(XnFloat fAngle);
    void SetOffAxisDetectionTime(XnUInt32 nTime);
protected:
    void ValueChange(XnFloat fValue);
    void OffAxisMovement(XnVDirection eDir);

    XnVSlider1D(XnVAxis eAxis, XnBool bDraggable, const XnPoint3D& ptInitialPosition, XnFloat fSliderLength,
        XnFloat fInitialValue, XnFloat fMinOutput, XnFloat fMaxOutput,
        XnFloat fOffAxisDetectionAngle = ms_fOffAxisDefaultDetectionAngle,
        XnFloat fOffAxisDetectionMinimumVelocity = ms_fDefaultMinimumOffAxisVelocity);

    void InitializeFromPoint(const XnPoint3D& ptInitialPosition, const XnPoint3D& ptMinPoint, const XnPoint3D& ptMaxPoint,
        XnBool bVertical, XnFloat& fSliderLength, XnFloat& fInitialValue);
    void Initialize(XnVAxis eAxis, XnBool bDraggable, const XnPoint3D& ptInitialPosition, XnFloat fSliderLength,
        XnFloat fInitialValue, XnFloat fMinOutput, XnFloat fMaxOutput, XnFloat fOffAxisDetectionAngle,
        XnFloat fOffAxisDetectionMinimumMovement);

    XnVDirection CheckForOffAxisMovement(const XnPoint3D& pt, XnFloat fTime);
    XnInt32 CheckOffAxis(XnFloat fPrimaryAxisDelta, XnFloat fOffAxisDelta);


    static const XnFloat ms_fDefaultMinimumOffAxisVelocity;     // = 0.15f m/s
    static const XnFloat ms_fOffAxisDefaultDetectionAngle;          // = 60.0f
    static const XnUInt32 ms_nDefaultTimeForOffAxisDetection;       // = 350 ms

    XnFloat m_fOffAxisDetectionMinimumVelocity;
    XnFloat m_fOffAxisDetectionAngle;
    XnUInt32 m_nOffAxisDetectionTime;

    XnVAxis m_eAxis;
    XnBool m_bIsDraggable;

    XnFloat m_fCurrentOutput;
    XnPoint3D m_ptCurrentPosition;

    XnFloat m_fOutputMinimum, m_fOutputMaximum;
    XnFloat m_fMaxOutputMajorAxisPosition, m_fMinOutputMajorAxisPosition;

    XnVPointBuffer* m_pPointBuffer;

    XnVFloatSpecificEvent* m_pValueChangeCBs;
    XnVDirectionSpecificEvent* m_pOffAxisMovementCBs;
};

#endif // _XNV_SLIDER_1D_H_