MyGUI_Canvas.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_CANVAS_H_
#define MYGUI_CANVAS_H_
 
#include "MyGUI_Prerequest.h"
#include "MyGUI_Widget.h"
#include "MyGUI_ITexture.h"
 
namespace MyGUI
{
 
    class MYGUI_EXPORT Canvas : public Widget, public ITextureInvalidateListener
    {
        MYGUI_RTTI_DERIVED(Canvas)
 
    public:
        Canvas();
 
        struct Event
        {
            Event(bool _textureChanged, bool _widgetResized, bool _requested) :
                textureChanged(_textureChanged),
                widgetResized(_widgetResized),
                requested(_requested)
            {
            }
 
            bool textureChanged;
            bool widgetResized;
 
            bool requested;
        };
 
        using EventHandle_CanvasPtr = delegates::MultiDelegate<Canvas*>;
        using EventHandle_CanvasPtrEvent = delegates::Delegate<Canvas*, Event>;
 
        enum TextureResizeMode
        {
            // Размер указаный при создании текстуры увеличиваеться до степени двойки и больше не меняется.
            // Текстура всегда растягиваеться во весь виджет.
            TRM_PT_CONST_SIZE,
 
            // Размер указаный при создании текстуры игнорируется.
            // Текстура всегда больше размера окна и кратна степени двойки.
            // Если размер виджета становится больше чем размер текстуры, текстура пересоздается.
            // Текстура всегда отображатся пиксель в пиксель на виджет, образуя рабочую область текстуры.
            TRM_PT_VIEW_REQUESTED,
 
            // Размер указаный при создании текстуры игнорируется.
            // Текстура всегда больше размера окна и кратна степени двойки.
            // Если размер виджета становится больше чем размер текстуры, текстура пересоздается.
            // Текстура всегда растягиваеться во весь виджет.
            TRM_PT_VIEW_ALL
        };
 
    public:
        void createTexture(
            TextureResizeMode _resizeMode,
            TextureUsage _usage = getDefaultTextureUsage(),
            PixelFormat _format = getDefaultTextureFormat());
 
        void createTexture(
            int _width,
            int _height,
            TextureResizeMode _resizeMode,
            TextureUsage _usage = getDefaultTextureUsage(),
            PixelFormat _format = getDefaultTextureFormat());
 
        void createTexture(
            const IntSize& _size,
            TextureResizeMode _resizeMode,
            TextureUsage _usage = getDefaultTextureUsage(),
            PixelFormat _format = getDefaultTextureFormat());
 
        void destroyTexture();
 
        void updateTexture();
 
        void* lock(TextureUsage _usage = TextureUsage::Write);
 
        void unlock();
 
        bool isLocked() const;
 
        int getTextureRealWidth() const;
 
        int getTextureRealHeight() const;
 
        IntSize getTextureRealSize() const;
 
        int getTextureSrcWidth() const;
 
        int getTextureSrcHeight() const;
 
        IntSize getTextureSrcSize() const;
 
        PixelFormat getTextureFormat() const;
 
        const std::string& getTextureName() const;
 
        void setSize(const IntSize& _size) override;
        void setCoord(const IntCoord& _coord) override;
 
        using Widget::setPosition;
        using Widget::setSize;
        using Widget::setCoord;
 
        TextureResizeMode getResizeMode() const;
 
        void setResizeMode(TextureResizeMode _value);
 
        bool isTextureSrcSize() const;
 
        bool isTextureCreated() const;
 
        bool isTextureManaged() const;
 
        ITexture* getTexture() const;
 
        void setTextureManaged(bool _value);
 
        static TextureUsage getDefaultTextureUsage();
 
        static PixelFormat getDefaultTextureFormat();
 
        /*events:*/
        EventHandle_CanvasPtr eventPreTextureChanges;
 
        EventHandle_CanvasPtrEvent requestUpdateCanvas;
 
    protected:
        void shutdownOverride() override;
        void initialiseOverride() override;
 
        void _destroyTexture(bool _sendEvent);
 
        void validate(int& _width, int& _height, TextureUsage& _usage, PixelFormat& _format) const;
 
        void createExactTexture(int _width, int _height, TextureUsage _usage, PixelFormat _format);
 
        bool checkCreate(int _width, int _height) const;
 
        void resize(const IntSize& _size);
 
        void correctUV();
 
        void frameAdvise(bool _advise);
 
        void frameEntered(float _time);
 
        void textureInvalidate(ITexture* _texture) override;
 
        void _setUVSet(const FloatRect& _rect);
 
    protected:
        ITexture* mTexture{nullptr};
 
        IntSize mReqTexSize;
 
        std::string mGenTexName;
 
        TextureResizeMode mTexResizeMode{TRM_PT_CONST_SIZE};
 
        uint8* mTexData{nullptr};
 
        bool mTexManaged{true};
 
        bool mFrameAdvise{false};
 
        bool mInvalidateData{false};
    };
 
} // namespace MyGUI
 
#endif // MYGUI_CANVAS_H_