GUIWheelContainer.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef GUIWHEELCONTAINER_H
#define GUIWHEELCONTAINER_H
 
#include "GUICompositeObject.h"
#include "GUIEasing.h"
#include "GUIImageResource.h"
#include "GUINinePatch.h"
 
#include "GUICommonEnums.h"
 
// @guiliani_doxygen toplevel_control Wheel-Container
// @endguiliani_doxygen
 
class CGUIWheelContainer : public CGUICompositeObject
{
public:
    CGUIWheelContainer(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY,
        const eC_Value& vWidth, const eC_Value& vHeight,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIWheelContainer();
 
    CGUIWheelContainer(const CGUIWheelContainer& kToBeCopied);
 
    CGUIWheelContainer& operator=(const CGUIWheelContainer& kSource);
 
    virtual ~CGUIWheelContainer();
 
    virtual void AdaptWheel();
 
    virtual eC_Bool AddObject(CGUIObject* pkObject);
 
    virtual void RemoveObject(CGUIObject* pkObject);
 
    virtual void ScrollTo(eC_UInt uiNodeIndex);
 
    virtual void ScrollToAnimated(eC_UInt uiNodeIndex);
 
    virtual eC_UInt GetCurrentIndex();
 
    // Methods derived from CGUIObject 
    virtual eC_Bool DoDraw();
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
    //virtual eC_Bool DoClick(const eC_Value& vAbsX, const eC_Value& vAbsY);
    virtual eC_Bool DoButtonDown(const eC_Value& vAbsX, const eC_Value& vAbsY);
    virtual eC_Bool DoDrag(const eC_Value& vDeltaX, const eC_Value& vDeltaY, const eC_Value& vAbsX, const eC_Value& vAbsY);
    virtual eC_Bool DoDragEnd(const eC_Value& vAbsX, const eC_Value& vAbsY);
    virtual eC_Bool SetValue(const CGUIValue& rkValue);
 
    virtual void SetWidth(const eC_Value& vX);
    virtual void SetHeight(const eC_Value& vY);
 
    void SetCyclic(eC_Bool bCyclic);
 
    eC_Bool IsCyclic() const;
 
    void SetDirection(const CGUICommonEnums::Orientation_t& eDirection);
 
    CGUICommonEnums::Orientation_t GetDirection() const;
 
    void SetTargetSnappingPosition(const eC_Value& vTargetSnappingPos);
 
    eC_Value GetTargetSnappingPosition() const;
 
    void SetMinimumDragDistance(const eC_Value& vMinimumDragDistance);
 
    eC_Value GetMinimumDragDistance() const;
 
    void SetSwipeDistance(const eC_Value& vSwipeDistance);
 
    eC_Value GetSwipeDistance() const;
 
    void SetCenterChildren(const eC_Bool& bCenterChildren);
 
    eC_Bool GetCenterChildren() const;
 
    void SetBGImage(const ImageResource_t& eBGImage);
 
    ImageResource_t GetBGImage() const;
 
    void SetEasing(
        const CGUIEasing::EasingType_t& eEasing,
        const eC_Value& vEasingTime);
 
    void GetEasing(
        CGUIEasing::EasingType_t& eEasing,
        eC_Value& vEasingTime) const;
 
#if defined(GUILIANI_STREAM_GUI)
    virtual void ReadFromStream();
#endif
 
#if defined(GUILIANI_WRITE_GUI)
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
    CGUINinePatch& GetNinePatch()
    {
        return m_kNinePatch;
    }
 
protected:
    virtual void AdjustNodesPosition();
 
    virtual void AdjustCurrentScrollPosAndNode();
 
    virtual void SetCurrentNode(eC_UInt uiNodeIndex);
    
    virtual eC_UInt GetCurrentNode();
    
    virtual ObjectPtrList::SafeIterator GetCurrentNodeSafeIter();
    
    virtual eC_UInt GetNodeIndexFromIter(const ObjectPtrList::Iterator &kNodeIter);
    
    virtual void SetCurrentNodeSafeIter(const ObjectPtrList::SafeIterator &kNodeSafeIter);
     
    virtual ObjectPtrList::Iterator GetNextNodeCyclic(ObjectPtrList::Iterator kIter, eC_Bool& bWrapped);
     
    virtual ObjectPtrList::Iterator GetPreviousNodeCyclic(ObjectPtrList::Iterator kIter);
 
    virtual eC_Value GetCurrentScrollPosForCurrentDirection();
 
    virtual void SetCurrentScrollPosForCurrentDirection(eC_Value vCurrentScrollPos);
 
    virtual void StartScrollingAnimation();
 
    virtual void StopScrollingAnimation();
 
    void SetScrollPosition(const eC_Value& vScrollPosition);
 
    void GetNodeIndexForPosition(const eC_Value& vOffset, eC_Int &iIndex, eC_Int &iCycle, eC_Value& vScrollPos);
 
    eC_Value GetPositionForNodeIndex(const eC_Int &iIndex, const eC_Int &iCycle, const eC_Value& vScrollPos);
 
private:
    void Init();
    void DeInit();
 
    eC_Value GetTotalSize();
 
private:
    ObjectPtrList::SafeIterator m_kCurrentNodeSafeIter;
    eC_UInt m_uiCurrentNodeIndex; 
    eC_Value m_vCurrentScrollPosX; 
    eC_Value m_vCurrentScrollPosY;  
 
    eC_Value m_vTargetPos;
 
    // Used for animation
    // Animation start position
    eC_Int m_iAniStartNodeIndex;
    eC_Int m_iAniStartNodeCycle;
    eC_Value m_vAniStartScrollPos;
    // Animation target position
    eC_Int m_iAniTargetNodeIndex;
    eC_Int m_iAniTargetNodeCycle;
    eC_Value m_vAniTargetScrollPos;
 
    eC_Bool m_bCyclic;
 
    eC_UInt m_uiDragTimeStamp;
    eC_UInt m_uiDragStarted; 
    CGUIPoint m_kDragStart; 
    eC_Value m_vDistance; 
 
    ImageResource_t  m_eBGImage; 
 
    CGUICommonEnums::Orientation_t m_eDirection; 
 
    CGUIEasing::EasingType_t m_eEasingType; 
 
    eC_Value m_vEasingDuration; 
 
    CGUINinePatch m_kNinePatch; 
 
    eC_Value m_vTargetSnappingPos; 
    eC_Value m_vMinimumDragDistance; 
    eC_Value m_vSwipeDistance; 
 
    eC_Value m_vScrollPos;
 
    eC_Bool m_bCenterChildren;
};
 
#endif // GUIWHEEL_H