YiStreamer.h

Go to the documentation of this file.

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

#include "scenetree/YiAABB.h"
#include "signal/YiSignalHandler.h"
#include "view/YiSceneView.h"

#include <glm/fwd.hpp>

class CYILayoutConfig;
class CYINodeAdapter;
class CYISceneManager;
class CYISceneNode;
class CYIStreamableView;
class CYIStreamerSlots;

class CYIStreamer
{
    friend class CYIStreamerSlots;
    friend class CYIStreamableView;

public:
    CYIStreamer();
    virtual ~CYIStreamer();

    void SetAdapter(std::unique_ptr<CYINodeAdapter> pAdapter);

    const CYINodeAdapter *GetAdapter() const;

    CYINodeAdapter *GetAdapter();

    bool RequestFocusOnItem(uint32_t uIndex, CYIFocus::FOCUS_DIRECTION eDirection = CYIFocus::FOCUS_FORWARD, CYIFocus::FOCUS_ROOT_RULE eFocusRootRule = CYIFocus::FOCUS_ROOT_DESCENDANTS_UPDATE_CONTEXT, const CYIAABB &previousFocusRect = CYIAABB());

    bool IsStreamedIn(uint32_t uIndex) const;

    CYISceneNode *GetStreamedNode(uint32_t uIndex) const;

    uint32_t GetItemIndex(CYISceneNode *pStreamableItem) const;

protected:
    void Init(CYISceneManager *pSceneManager);

    void UpdateStreamedStateOfAllItems();

    virtual void StreamedIn(uint32_t uIndex, CYISceneNode *pStreamedItem);

    virtual void OnStreamedIn(uint32_t uIndex, CYISceneNode *pStreamedItem);

    virtual void StreamedOut(uint32_t uIndex, CYISceneNode *pStreamedItem);

    virtual void OnStreamedOut(uint32_t uIndex, CYISceneNode *pStreamedItem);

    virtual void InsertItem(uint32_t uIndex, std::unique_ptr<CYISceneNode> pItem) = 0;

    virtual std::unique_ptr<CYISceneNode> RemoveItem(uint32_t uIndex, CYISceneNode *pItem) = 0;

    virtual void ReorderItem(uint32_t uFromIndex, uint32_t uToIndex, CYISceneNode *pItem) = 0;

    virtual bool IsItemInStreamingRegion(CYISceneNode *pItem) const = 0;

    virtual CYISceneNode *GetItem(uint32_t uIndex) const = 0;

    virtual bool CanBeStreamedOut(uint32_t uIndex, CYISceneNode *pNode) const = 0;

    virtual void OnFocusGainedForItem(uint32_t uIndex);

    virtual void FocusGainedForItem(uint32_t uIndex);

    virtual void OnFocusLostForItem(uint32_t uIndex);

    virtual void FocusLostForItem(uint32_t uIndex);

private:
    void CreateItemsFromAdapter();
    void InsertItemPriv(uint32_t uIndex);
    void RemoveAllItems();
    void RemoveItemPriv(uint32_t uIndex);
    void MoveItemPriv(uint32_t uFromIndex, uint32_t uToIndex);
    void OnAdapterItemAdded(uint32_t uIndex);
    void OnAdapterItemRemoved(uint32_t uIndex);
    void OnAdapterItemMoved(uint32_t uFromIndex, uint32_t uToIndex);
    void StreamIn(uint32_t uIndex, CYIStreamableView *pView);
    void StreamOut(uint32_t uIndex, CYIStreamableView *pView);
    void UpdateAllIndices();

    std::unique_ptr<CYINodeAdapter> m_pAdapter;
    CYISceneManager *m_pSceneManager;
    uint32_t m_uItems;
    std::unique_ptr<CYIStreamerSlots> m_pSlots;

    YI_DISALLOW_COPY_AND_ASSIGN(CYIStreamer)
};

#endif // _YI_STREAMER_H_