GUICarousel.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 GUICAROUSEL__H_
#define GUICAROUSEL__H_
 
// necessary includes
#include "GUICompositeObject.h"
 
// @guiliani_doxygen toplevel_control Carousel
// @endguiliani_doxygen
class CGUICarousel : public CGUICompositeObject
{
public:
    CGUICarousel(
            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);
 
    virtual ~CGUICarousel() {}
 
    virtual eC_Bool SetValue(const CGUIValue& rkValue)
    {
        // Rotate to child object with index given by value
        RotateToObject(GetChild(rkValue.ToInt()));
        CGUIObject::SetValue(rkValue);
        return true; 
    }
 
    virtual void SetWidth(const eC_Value& vX);
    virtual void SetHeight(const eC_Value& vX);
 
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
 
    virtual eC_Bool AddObject(CGUIObject* pkObject);
    virtual void RemoveObject(CGUIObject* pkObject);
 
    virtual eC_Bool IsHighlightable() const { return false; }
 
    void SetRadius(const eC_Value vRadius) { m_vRadius = vRadius; ArrangeChildren(); }
 
    eC_Value GetRadius() const
    {
        return m_vRadius;
    }
 
    eC_Value GetTiltAngle() const
    {
        return m_vTiltAngle;
    }
 
    eC_Bool Decrease();
 
    eC_Bool Increase();
 
    void RotateToObject(CGUIObject* pkObject);
 
    void JumpToObject(CGUIObject* pkObject);
 
    CGUIObject* GetSelectedObject() { return GetChild(m_iCarouselItemIndex); }
 
    eC_Int GetSelectedIndex() const
    {
        return m_iCarouselItemIndex;
    }
 
    void GetOriginalSize(const eC_UInt uiIndex, eC_Value& vWidth, eC_Value& vHeight)
    {
        vWidth = eC_FromInt(0);
        vHeight = eC_FromInt(0);
 
        if (uiIndex < GetNumberOfChildren())
        {
            sSizeStorage kSize = (*m_OriginalSizes.GetAt(uiIndex));
            vWidth = kSize.kRect.GetWidth();
            vHeight = kSize.kRect.GetHeight();
        }
    }
 
    virtual eC_Bool DoKeyDown(
        const GUIKeyIdentifier_t& eKeyID,
        const eC_UInt& uiModifiers);
 
    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);
 
    void SetTiltAngle(const eC_Value vTiltAngle);
 
    void EnableFlowMode(const eC_Bool bEnable) { m_bFlowMode = bEnable; }
 
    void SetNumberOfFlowModeEntries(const eC_UInt uiNOFEntries) { m_uiNOFEntries = uiNOFEntries; }
 
    void SetPerspectiveFactor(const eC_Value vPerspectiveFactor) { m_vPerspectiveFactor = vPerspectiveFactor; }
 
    void SetVertical(const eC_Bool bVertical) { m_bVertical = bVertical; }
 
    static void SetInvertInput(const eC_Bool bInvert) { ms_bInvertInput = bInvert; }
 
#ifdef GUILIANI_STREAM_GUI
    CGUICarousel();
 
    virtual void ReadFromStream();
#endif
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
protected:
    struct sSizeStorage {
        CGUIObject* pObj;
        CGUIRect     kRect;
    };
 
    struct ZOrderEntry {
        CGUIObject* pkObject;
        eC_Value    vScaleFactor;
    };
 
    void SetSelectedObject(CGUIObject* pkObject);
 
    eC_Value GetDegreesPerChild();
 
    virtual void ArrangeChildren();
 
    void EnforceFocusBehaviour();
 
    eC_TListDoubleLinked<sSizeStorage> m_OriginalSizes;
    eC_Value    m_vRotationAngle;
    eC_Value    m_vTargetAngle;
    eC_Value    m_vTiltAngle;
    eC_Int      m_iCarouselItemIndex;
    eC_Bool     m_bRotateByCursorKeys;
    eC_Value    m_vRadius;
    eC_Bool     m_bDragging;
    eC_Value    m_vPerspectiveFactor;
    eC_Bool     m_bFlowMode;
    eC_UInt     m_uiNOFEntries;
    eC_Bool     m_bKineticAnimation;
    eC_Value    m_vDragSpeed;
    eC_Bool     m_bVertical;
    static eC_Bool ms_bInvertInput;
 
};
#endif