XnVSelectableSlider1D.h

Go to the documentation of this file.

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


#ifndef _XNV_SELECTABLE_SLIDER_1D_H_
#define _XNV_SELECTABLE_SLIDER_1D_H_

#include "XnVPointControl.h"
#include "XnVMultiItemHysteresis1D.h"
#include "XnVSlider1D.h"

class XnVBorderScrollController1D;

class XnVIntSpecificEvent;
class XnVIntDirectionSpecificEvent;
class XnVFloatSpecificEvent;
class XnVDirectionSpecificEvent;

class XNV_NITE_API XnVSelectableSlider1D :
    public XnVPointControl
{
public:
    typedef void (XN_CALLBACK_TYPE *ItemHoverCB)(XnInt32 nItemIndex, void* pUserCxt);
    typedef void (XN_CALLBACK_TYPE *ItemSelectCB)(XnInt32 nItemIndex, XnVDirection nDirection, void* pUserCxt);
    typedef void (XN_CALLBACK_TYPE *ScrollCB)(XnFloat fScrollValue, void* pUserCxt);
    typedef void (XN_CALLBACK_TYPE *ValueChangeCB)(XnFloat fValue, void* pUserCxt);
    typedef void (XN_CALLBACK_TYPE *OffAxisMovementCB)(XnVDirection dir, void* pUserCxt);

    XnVSelectableSlider1D(XnInt32 nCount, XnFloat fBorderWidth = 0, XnVAxis eAxis = AXIS_X,
        XnBool bRecenter = TRUE, 
        XnFloat fHysteresisRatio = XnVMultiItemHysteresis1D::ms_fDefaultHysteresisRatio,
        XnFloat fPrimarySliderSize = ms_fDefaultPrimarySliderSize, XnFloat fFirstValue = 0.5,
        const XnChar* strName = "XnVSelectableSlider1D");

    ~XnVSelectableSlider1D();

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

    static const XnFloat ms_fDefaultPrimarySliderSize;  // = 250

    XnCallbackHandle RegisterItemHover(void* cxt, ItemHoverCB pCB);
    XnCallbackHandle RegisterItemSelect(void* cxt, ItemSelectCB pCB);
    XnCallbackHandle RegisterScroll(void* cxt, ScrollCB pCB);
    XnCallbackHandle RegisterValueChange(void* cxt, ValueChangeCB pCB);
    XnCallbackHandle RegisterOffAxisMovement(void* cxt, OffAxisMovementCB pCB);

    void UnregisterItemHover(XnCallbackHandle handle);
    void UnregisterItemSelect(XnCallbackHandle handle);
    void UnregisterScroll(XnCallbackHandle handle);
    void UnregisterValueChange(XnCallbackHandle handle);
    void UnregisterOffAxisMovement(XnCallbackHandle handle);

    void ItemHover(XnInt32 nItemIndex);
    void ItemSelect(XnVDirection nDirection);
    void Scroll(XnFloat fScrollValue);

    void Reposition(const XnPoint3D& ptCenter);
    void GetCenter(XnPoint3D& ptCenter) const;

    XnUInt32 GetItemCount() const;
    void SetItemCount(XnUInt32 nItems);

    XnFloat GetBorderWidth() const;
    XnStatus SetBorderWidth(XnFloat fWidth);

    XnFloat GetSliderSize() const;
    void SetSliderSize(XnFloat fSliderSize);

    void SetValueChangeOnOffAxis(XnBool bReport);
    XnBool GetValueChangeOnOffAxis() const;

    void SetHysteresisRatio(XnFloat fRatio);
    XnFloat GetHysteresisRatio() const;
protected:
    XnFloat GetFirstValue() const;

    XnFloat GetLeftScrollRegionEnd() const;
    XnFloat GetRightScrollRegionEnd() const;

    void PointCreated(const XnPoint3D& ptPos);
    void PointDeleted(XnBool bReason);
    void PointMoved(const XnPoint3D& ptPos, XnFloat fTime);

    void SetFirstValue(XnFloat fValue);

    void InternalCreateSlider(XnBool bPrimaryAxis, XnVAxis eAxis, const XnPoint3D& ptInitialPoint, XnFloat fInitialValue);

    // Is this needed public?
    void ValueChange(XnFloat fValue);
    void OffAxisMovement(XnVDirection dir);

    static void XN_CALLBACK_TYPE PrimarySlider_OffAxisMovement(XnVDirection eDir, void* pContext);
    static void XN_CALLBACK_TYPE PrimarySlider_ValueChange(XnFloat fValue, void* pContext);
    static void XN_CALLBACK_TYPE SecondarySlider_OffAxisMovement(XnVDirection eDir, void* pContext);
    static void XN_CALLBACK_TYPE SecondarySlider_ValueChange(XnFloat fValue, void* pContext);
    static void XN_CALLBACK_TYPE Hysteresis_ItemSelected(XnInt32 nItem, void* pContext);
    static void XN_CALLBACK_TYPE OffAxisHysteresis_ItemSelected(XnInt32 nItem, void* pContext);
    static void XN_CALLBACK_TYPE Scroller_Scrolled(XnFloat fScrollValue, void* pContext);

    void PrimarySlider_OffAxisMovement(XnVDirection eDir);
    void SecondarySlider_OffAxisMovement(XnVDirection eDir);
    void UpdatePrimarySlider(XnFloat fVal);
    void UpdateSecondarySlider(XnFloat fVal);
    void OffAxisHysteresis_ItemSelected(XnInt32 nItem);

    static const XnFloat ms_fSecondarySliderSize;   // = 150

    XnVMultiItemHysteresis1D* m_pHysteresis;
    XnVMultiItemHysteresis1D* m_pOffAxisHysteresis;
    XnVBorderScrollController1D* m_pScroller;

    XnBool m_bPositioned;
    XnBool m_bRecenter;

    XnBool m_bValueChangeOnOffAxis;

    XnVSlider1D* m_pSlider;             // Pointer to current active
    XnVSlider1D* m_pPrimarySlider;
    XnVSlider1D* m_pSecondarySlider;

    //Events this object is registered to:
    XnUInt32 m_nOffAxisHandle;
    XnUInt32 m_nValueChangeHandle;

    XnFloat m_fPrimarySliderSize;
    XnFloat m_fPrimarySliderValueAtChange;

    XnFloat m_fFirstValue;
    XnBool m_bFirstPointCreated;

    XnVAxis m_ePrimaryAxisDirection;
    XnUInt32 m_nItemCount;

    XnInt32 m_nLastHover;

    XnPoint3D m_ptCenter;

    XnCallbackHandle m_hPrimaryHysteresisItemSelect;
    XnCallbackHandle m_hSecondaryHysteresisItemSelect;
    XnCallbackHandle m_hScrollerScroll;

    XnCallbackHandle m_hPrimarySliderOffAxis;
    XnCallbackHandle m_hPrimarySliderValueChange;
    XnCallbackHandle m_hSecondarySliderOffAxis;
    XnCallbackHandle m_hSecondarySliderValueChange;

    XnVIntSpecificEvent* m_pItemHoverCBs;
    XnVIntDirectionSpecificEvent* m_pItemSelectCBs;
    XnVFloatSpecificEvent* m_pScrollCBs;
    XnVFloatSpecificEvent* m_pValueChangeCBs;
    XnVDirectionSpecificEvent* m_pOffAxisMovementCBs;
}; // XnVSelectableSlider1D

#endif // _XNV_SELECTABLE_SLIDER_1D_H_