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;
        };

        typedef delegates::CMultiDelegate1<Canvas*> EventHandle_CanvasPtr;
        typedef delegates::CDelegate2<Canvas*, Event> EventHandle_CanvasPtrEvent;

        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;

        virtual void setSize(const IntSize& _value);
        virtual void setCoord(const IntCoord& _value);

        void setSize(int _width, int _height);
        void setCoord(int _left, int _top, int _width, int _height);

        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:
        virtual void shutdownOverride();
        virtual void initialiseOverride();

        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);

        virtual void textureInvalidate(ITexture* _texture);

        void _setUVSet(const FloatRect& _rect);

    protected:
        ITexture* mTexture;

        IntSize mReqTexSize;

        std::string mGenTexName;

        TextureResizeMode mTexResizeMode;

        uint8* mTexData;

        bool mTexManaged;

        bool mFrameAdvise;

        bool mInvalidateData;
    };

} // namespace MyGUI

#endif // __MYGUI_CANVAS_H__