MyGUI_ImageBox.h

Go to the documentation of this file.

/*
 * This source file is part of MyGUI. For the latest info, see http://mygui.info/
 * Distributed under the MIT License
 * (See accompanying file COPYING.MIT or copy at http://opensource.org/licenses/MIT)
 */
 
#ifndef MYGUI_IMAGE_BOX_H_
#define MYGUI_IMAGE_BOX_H_
 
#include "MyGUI_Prerequest.h"
#include "MyGUI_Widget.h"
#include "MyGUI_ResourceImageSet.h"
#include "MyGUI_ImageInfo.h"
 
namespace MyGUI
{
 
    class MYGUI_EXPORT ImageBox : public Widget, public MemberObsolete<ImageBox>
    {
        MYGUI_RTTI_DERIVED(ImageBox)
 
    public:
        //------------------------------------------------------------------------------//
        // The simple interface
        //------------------------------------------------------------------------------//
 
        /* Set texture and size of image _tile
            @param _texture file name or texture name
            @param _coord - part of texture where we take tiles
            @param _tile size
        */
        void setImageInfo(std::string_view _texture, const IntCoord& _coord, const IntSize& _tile);
 
        /* Set texture
            @param _texture file name or texture name
        */
        void setImageTexture(std::string_view _texture);
 
        void setImageRect(const IntRect& _rect);
 
        void setImageCoord(const IntCoord& _coord);
 
        void setImageTile(const IntSize& _tile);
 
        void setImageIndex(size_t _index);
        size_t getImageIndex() const;
 
        IntSize getImageSize() const;
 
        //------------------------------------------------------------------------------//
        // The expanded interface
        //------------------------------------------------------------------------------//
 
        size_t getItemCount() const;
 
        void setItemSelect(size_t _index);
        size_t getItemSelect() const;
        void resetItemSelect();
 
        void insertItem(size_t _index, const IntCoord& _item);
        void addItem(const IntCoord& _item);
        void setItem(size_t _index, const IntCoord& _item);
 
        void deleteItem(size_t _index);
        void deleteAllItems();
 
        // работа с фреймами анимированных индексов
        void addItemFrame(size_t _index, const IntCoord& _item);
 
        void insertItemFrame(size_t _index, size_t _indexFrame, const IntCoord& _item);
 
        void addItemFrameDuplicate(size_t _index, size_t _indexSourceFrame);
 
        void insertItemFrameDuplicate(size_t _index, size_t _indexFrame, size_t _indexSourceFrame);
 
        void setItemFrame(size_t _index, size_t _indexFrame, const IntCoord& _item);
 
        void deleteItemFrame(size_t _index, size_t _indexFrame);
 
        void deleteAllItemFrames(size_t _index);
 
        void setItemFrameRate(size_t _index, float _rate);
 
        float getItemFrameRate(size_t _index) const;
 
        //------------------------------------------------------------------------------//
        // The interface with support of resources
        //------------------------------------------------------------------------------//
 
        bool setItemResource(std::string_view _name);
 
        void setItemGroup(std::string_view _group);
        void setItemName(std::string_view _name);
 
        void setItemResourcePtr(ResourceImageSetPtr _resource);
        void setItemResourceInfo(const ImageIndexInfo& _info);
 
        ResourceImageSetPtr getItemResource() const;
        void setItemResourceInfo(ResourceImageSetPtr _resource, std::string_view _group, std::string_view _name);
 
    protected:
        void shutdownOverride() override;
 
        void setPropertyOverride(std::string_view _key, std::string_view _value) override;
 
    private:
        void frameEntered(float _frame);
 
        void recalcIndexes();
        void updateSelectIndex(size_t _index);
 
        void frameAdvise(bool _advise);
 
        void _setUVSet(const FloatRect& _rect);
 
    private:
        // кусок в текстуре наших картинок
        IntRect mRectImage;
        // размер одной картинки
        IntSize mSizeTile;
        // размер текстуры
        IntSize mSizeTexture;
        // текущая картинка
        size_t mIndexSelect{ITEM_NONE};
 
        VectorImages mItems;
 
        bool mFrameAdvise{false};
        float mCurrentTime{0};
        size_t mCurrentFrame{0};
 
        ResourceImageSetPtr mResource{nullptr};
        std::string mItemName;
        std::string mItemGroup;
        std::string mCurrentTextureName;
    };
 
} // namespace MyGUI
 
#endif // MYGUI_IMAGE_BOX_H_