CCanvas.h

/*
!@
MIT License
 
Copyright (c) 2019 Skylicht Technology CO., LTD
 
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
This file is part of the "Skylicht Engine".
https://github.com/skylicht-lab/skylicht-engine
!#
*/
 
#pragma once
 
#include "Components/CComponentSystem.h"
 
#include "Camera/CCamera.h"
 
#include "GUI/CGUIElement.h"
#include "GUI/CGUIImage.h"
#include "GUI/CGUIText.h"
#include "GUI/CGUISprite.h"
#include "GUI/CGUIRect.h"
#include "GUI/CGUIMask.h"
#include "GUI/CGUILayout.h"
#include "GUI/CGUIFitSprite.h"
#include "GUI/CGUIElipse.h"
 
#include "Entity/CEntityPrefab.h"
#include "Entity/CEntityManager.h"
 
namespace Skylicht
{

    class SKYLICHT_API CCanvas : public CComponentSystem
    {
    protected:
        core::rectf m_rect;

        core::rectf m_defaultRect;

        CGUIElement* m_root;

        int m_sortDepth;

        float m_scaleGUI;

        bool m_haveScaleGUI;

        bool m_is3DBillboard;

        core::matrix4 m_renderWorldTransform;

        CCamera* m_renderCamera;

        CGUIMask* m_currentMask;

        CEntityPrefab* m_entityMgr;

        std::vector<IEntitySystem*> m_systems;

        CFastArray<CEntity*> m_depth[MAX_ENTITY_DEPTH];

        CFastArray<CEntity*> m_alives;
 
    public:
        bool IsInEditor;

        bool DrawOutline;
 
    public:
 
        std::function<void(CGUIElement*)> OnGUILoaded;
 
        std::function<void(CGUIText*)> OnLocalize;
 
    public:
        CCanvas();

        virtual ~CCanvas();

        virtual void initComponent();

        virtual void updateComponent();

        virtual void onResize();

        void updateEntities();

        void render(CCamera* camera);

        CGUIElement* getHitTest(CCamera* camera, float x, float y, const core::recti& viewport);

        inline CEntityPrefab* getEntityManager()
        {
            return m_entityMgr;
        }
 
    public:
        inline void setSortDepth(int d)
        {
            m_sortDepth = d;
        }

        inline int getSortDepth()
        {
            return m_sortDepth;
        }

        inline void setRect(const core::rectf& r)
        {
            m_rect = r;
        }

        inline void setDefaultRect(const core::rectf& r)
        {
            m_defaultRect = r;
        }

        inline const core::rectf& getDefaultRect()
        {
            return m_defaultRect;
        }

        void applyGUIScale(float widthOrHeight = 1.0f);

        void resetGUIScale();

        const core::vector3df& getRootScale();

        inline CGUIElement* getRootElement()
        {
            return m_root;
        }

        inline void setEnable3DBillboard(bool b)
        {
            m_is3DBillboard = b;
        }

        inline bool is3DBillboardEnabled()
        {
            return m_is3DBillboard;
        }

        void removeAllElements();

        CGUIElement* createElement();

        CGUIElement* createElement(const core::rectf& r);

        CGUIElement* createElement(CGUIElement* e, const core::rectf& r);
 
        // ---- Image ----

        CGUIImage* createImage();

        CGUIImage* createImage(const core::rectf& r);

        CGUIImage* createImage(CGUIElement* e, const core::rectf& r);
 
        // ---- Text ----

        CGUIText* createText(IFont* font);

        CGUIText* createText(const core::rectf& r, IFont* font);

        CGUIText* createText(CGUIElement* e, IFont* font);

        CGUIText* createText(CGUIElement* e, const core::rectf& r, IFont* font);
 
        // ---- Sprite ----

        CGUISprite* createSprite(SFrame* frame);

        CGUISprite* createSprite(const core::rectf& r, SFrame* frame);

        CGUISprite* createSprite(CGUIElement* e, SFrame* frame);

        CGUISprite* createSprite(CGUIElement* e, const core::rectf& r, SFrame* frame);
 
        // ---- Mask ----

        CGUIMask* createMask(const core::rectf& r);

        CGUIMask* createMask(CGUIElement* e, const core::rectf& r);
 
        // ---- Rect ----

        CGUIRect* createRect(const video::SColor& c);

        CGUIRect* createRect(const core::rectf& r, const video::SColor& c);

        CGUIRect* createRect(CGUIElement* e, const core::rectf& r, const video::SColor& c);
 
        // ---- Elipse ----

        CGUIElipse* createElipse(const video::SColor& c);

        CGUIElipse* createElipse(const core::rectf& r, const video::SColor& c);

        CGUIElipse* createElipse(CGUIElement* e, const core::rectf& r, const video::SColor& c);
 
        // ---- Layout ----

        CGUILayout* createLayout();

        CGUILayout* createLayout(const core::rectf& r);

        CGUILayout* createLayout(CGUIElement* e, const core::rectf& r);
 
        // ---- Fit Sprite ----

        CGUIFitSprite* createFitSprite(SFrame* frame);

        CGUIFitSprite* createFitSprite(const core::rectf& r, SFrame* frame);

        CGUIFitSprite* createFitSprite(CGUIElement* e, SFrame* frame);

        CGUIFitSprite* createFitSprite(CGUIElement* e, const core::rectf& r, SFrame* frame);
 
        // ---- Null element creation (for importer) ----

        virtual CGUIElement* createNullElement(CGUIElement* parent, const char* type);

        virtual CGUIElement* createNullElement(CGUIElement* parent, const wchar_t* type);

        const core::matrix4& getRenderWorldTransform()
        {
            return m_renderWorldTransform;
        }

        inline void setRenderWorldTransform(core::matrix4& w)
        {
            m_renderWorldTransform = w;
        }

        inline CCamera* getRenderCamera()
        {
            return m_renderCamera;
        }

        CGUIElement* getGUIByID(const char* id);

        CGUIElement* getGUIByPath(const char* path);

        CGUIElement* searchGUI(const char* name);

        CGUIElement* getGUIByPath(CGUIElement* search, const char* path);

        CGUIElement* searchGUI(CGUIElement* search, const char* name);

        template<typename T>
        std::vector<T*> getElementsInChild(bool addThis);

        void updateLocalizedText();
 
        bool isClipped(CGUIElement* element);
    };
 
    template<typename T>
    std::vector<T*> CCanvas::getElementsInChild(bool addThis)
    {
        std::vector<T*> result;
        std::queue<CGUIElement*> queueObjs;
 
        if (addThis == true)
            queueObjs.push(m_root);
        else
        {
            for (CGUIElement*& obj : m_root->getChilds())
                queueObjs.push(obj);
        }
 
        while (queueObjs.size() != 0)
        {
            CGUIElement* obj = queueObjs.front();
            queueObjs.pop();
 
            T* type = dynamic_cast<T*>(obj);
            if (type != NULL)
                result.push_back(type);
 
            for (CGUIElement*& child : obj->m_childs)
                queueObjs.push(child);
        }
 
        return result;
    }
}