YiListItem.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_LIST_ITEM_H_
#define _YI_LIST_ITEM_H_

#include "binding/YiScriptableObject.h"
#include "deprecated/YiStreamedItem.h"
#include "import/YiViewTemplate.h"
#include "scenetree/YiSceneNode.h"

class CYISceneView;
class CYITimeline;
class CYITimelineTrack;

namespace yi
{
namespace deprecated
{
class CYIListView;
}
}

namespace yi
{

namespace deprecated
{

class CYIListItem : public yi::deprecated::CYIStreamedItem, public CYIAnimation::Listener, public CYISignalHandler, public CYIScriptableObject
{
public:
    enum CELLS_VALIGN_TYPE
    {
        VALIGN_CENTER = 0,
        VALIGN_TOP,
        VALIGN_BOTTOM
    };

    enum CELLS_HALIGN_TYPE
    {
        HALIGN_CENTER = 0,
        HALIGN_RIGHT,
        HALIGN_LEFT
    };

public:

    CYIListItem();
    virtual ~CYIListItem();

    void SetListView(CYIListView *pListView);

    CYIListView *GetListView() const;

    void SetItemOwnsView(bool bIsViewOwner);

    void SetIndexInList(int32_t nIndex);
    int32_t GetIndexInList() const;

    void SetPosition(float fX, float fY, bool bAnimate);

    void SetCellsRect(const YI_RECT_REL &rRect);

    void SetCellsRectVAlign(CELLS_VALIGN_TYPE eCellsRectVAlign);

    CELLS_VALIGN_TYPE GetCellsRectVAlign() const;

    void SetCellsRectHAlign(CELLS_HALIGN_TYPE eCellsRectHAlign);

    CELLS_HALIGN_TYPE GetCellsRectHAlign() const;

    void SetCellsRectPadding(float fHPadding, float fVPadding);

    void GetCellsRectPadding(float &rfHPadding, float &rfVPadding);

    float GetPositionX() const;
    float GetPositionY() const;

    virtual float GetHeight() const;

    virtual float GetWidth() const;

    virtual const YI_RECT_REL *GetCellsRect() const;

    virtual void IsInRange(float fPos, float fRangeWidth, bool &bIsInVisibleRange, bool &bIsInStreamInRange, bool &bIsInLoadRange) const override;
    virtual void    StreamIn() override;
    virtual void    StreamOut() override;
    virtual void    LoadIn() override;

    virtual void    LoadOut() override;
    virtual void    VisibleIn() override;
    virtual void    VisibleOut() override;
    virtual void Highlight(bool bHighlight);
    bool IsHighlighted() const;

    void GenerateView();
    CYISceneView *GetView() const;

    virtual CYITimeline *GetMoveTimeline() const;
    virtual CYITimelineTrack *GetPositionTrack() const;

    virtual void OnScrolled(const glm::vec3 &fDelta, float fNewPosition);

    virtual std::unique_ptr<CYISceneView> CreateView(CYISceneManager *pSceneManager);

    float GetStreamingRangeFactor() const;

    void SetStreamingRangeFactor(float fStreamingRangeFactor);

    float GetLoadRangeFactor() const;

    void SetLoadRangeFactor(float fStreamingRangeFactor);

    void SetListItemTemplate(const std::shared_ptr<CYIAssetViewTemplate> &pAssetViewTemplate);

    const std::shared_ptr<CYIAssetViewTemplate> &GetListItemTemplate() const;

protected:

    virtual void OnStreamIn();
    virtual void OnStreamOut();
    virtual void OnLoadIn();
    virtual void OnLoadOut();
    virtual void OnVisibleIn();
    virtual void OnVisibleOut();

    virtual void OnAnimate(CYIAnimation *pAnimation, float fDataPosition) override;

    void SetViewPosition();
    void OnFocusLost();

    void DeleteViewLater();

    std::shared_ptr<CYIAssetViewTemplate> m_pListItemTemplate;
    CYIListView                        *m_pListView;
    CYISceneView                       *m_pView;
    CYIAnimation                       *m_pMoveAnimation;
    float m_fX;
    float m_fY;
    float m_fWidth;
    float m_fHeight;
    YI_RECT_REL                        m_cellsRect;
    CELLS_VALIGN_TYPE                  m_eCellsRectVAlign;
    CELLS_HALIGN_TYPE                  m_eCellsRectHAlign;
    float m_fCellsRectVPadding;
    float m_fCellsRectHPadding;
    int32_t m_nIndex;
    float m_fAnimItemMoveMin;
    float m_fAnimItemMoveMax;
    float m_fStreamRangeFactor;
    float m_fLoadRangeFactor;

    glm::vec3                           m_MoveFrom;
    glm::vec3                           m_MoveTo;

    bool                                m_bTimelineDirectionReverse;
    bool                                m_bHighlighted;
    bool                                m_bIsViewOwner;

    static const int32_t s_nDefaultAnimDuration = 500;

private:
    void ApplyMoveTimeline(float fPosition);
};

} // namespace deprecated

} // namespace yi


inline float yi::deprecated::CYIListItem::GetStreamingRangeFactor() const
{
    return m_fStreamRangeFactor;
}

inline void yi::deprecated::CYIListItem::SetStreamingRangeFactor(float fStreamingRangeFactor)
{
    m_fStreamRangeFactor = fStreamingRangeFactor < 1.0f ? 1.0f : fStreamingRangeFactor;
}

inline float yi::deprecated::CYIListItem::GetLoadRangeFactor() const
{
    return m_fLoadRangeFactor;
}

inline void yi::deprecated::CYIListItem::SetLoadRangeFactor(float fLoadRangeFactor)
{
    m_fLoadRangeFactor = fLoadRangeFactor < m_fStreamRangeFactor ? m_fStreamRangeFactor : fLoadRangeFactor;
}

#endif // _YI_LIST_ITEM_H_