CUIBase.h

/*
!@
MIT License
 
Copyright (c) 2023 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 "Graphics2D/GUI/CGUIElement.h"
#include "Graphics2D/CCanvas.h"
 
#include "Motion/CMotion.h"
#include "Motion/CColorMotion.h"
#include "Motion/CAlphaMotion.h"
#include "Motion/CPositionMotion.h"
#include "Motion/CScaleMotion.h"
#include "Motion/CRotationMotion.h"
#include "Motion/CFrameMotion.h"
#include "Motion/CVisibleMotion.h"
 
namespace Skylicht
{
    namespace UI
    {
        class CUIContainer;

        class CUIBase
        {
        protected:
            CUIContainer* m_container;
            CGUIElement* m_element;
 
            core::vector3df m_rectTransform[4];
 
            std::vector<CMotion*> m_motions[(int)EMotionEvent::NumEvent];
 
            bool m_enable;
            bool m_visible;
 
            bool m_isPointerHover;
            bool m_isPointerDown;
 
            bool m_skipPointerEventWhenDrag;
            bool m_continueGameEvent;
            bool m_continueKeyEvent;
 
            int m_pointerId;
            float m_pointerDownX;
            float m_pointerDownY;
 
            int m_soundId[4];
 
            void* m_userData;
 
        public:
            std::function<void(int, float, float)> OnPointerHover;
            std::function<void(int, float, float)> OnPointerOut;
            std::function<void(int, float, float)> OnPointerDown;
            std::function<void(int, float, float)> OnPointerUp;
            std::function<void(int, float, float, bool)> OnPointerMove;
 
            std::function<void(CUIBase*)> OnPressed;
            std::function<void(CUIBase*)> OnFocus;
            std::function<void(CUIBase*)> OnLostFocus;
            std::function<void(CUIBase*, const SEvent&)> OnKeyEvent;
 
            std::function<void(CUIBase*, EMotionEvent)> OnMotionFinish[(int)EMotionEvent::NumEvent];
 
        public:
            CUIBase(CUIContainer* container, CGUIElement* element);

            virtual ~CUIBase();

            void remove();
 
            virtual void update();

            virtual void setEnable(bool b);

            virtual void setVisible(bool b);

            inline bool isEnable()
            {
                return m_enable;
            }

            inline bool isVisible()
            {
                return m_visible;
            }

            inline int getPointerId()
            {
                return m_pointerId;
            }

            inline void setPointerId(int id)
            {
                m_pointerId = id;
            }

            void resetTouch();

            inline void setContinueGameEvent(bool b)
            {
                m_continueGameEvent = b;
            }

            inline bool isContinueGameEvent()
            {
                return m_continueGameEvent;
            }
 
            inline bool isContinueKeyEvent()
            {
                return m_continueKeyEvent;
            }

            inline void setSkipPointerEventWhenDrag(bool b)
            {
                m_skipPointerEventWhenDrag = b;
            }

            inline bool isPointerHover()
            {
                return m_isPointerHover;
            }

            inline bool isPointerDown()
            {
                return m_isPointerDown;
            }

            inline CGUIElement* getElement()
            {
                return m_element;
            }

            inline CCanvas* getCanvas()
            {
                if (m_element)
                    return m_element->getCanvas();
                return NULL;
            }

            inline CUIContainer* getContainer()
            {
                return m_container;
            }

            core::vector3df* getRectTransform();
 
            void getRectTransform(CGUIElement* element, core::vector3df* t);

            virtual void onPointerHover(int pointerId, float pointerX, float pointerY);

            virtual void onPointerOut(int pointerId, float pointerX, float pointerY);

            virtual void onPointerDown(int pointerId, float pointerX, float pointerY);

            virtual void onPointerUp(int pointerId, float pointerX, float pointerY);

            virtual void onPointerMove(int pointerId, float pointerX, float pointerY);

            virtual void onPressed();

            virtual void onFocus();

            virtual void onLostFocus();

            virtual void onKeyEvent(const SEvent& event);

            void startMotion(EMotionEvent event);

            void stopMotion(EMotionEvent event);

            bool isMotionPlaying(EMotionEvent event);

            virtual CMotion* addMotion(EMotionEvent event, CMotion* motion);

            virtual CMotion* addMotion(EMotionEvent event, CGUIElement* element, CMotion* motion);

            bool removeMotion(EMotionEvent event, CMotion* motion);

            void removeMotions(EMotionEvent event);

            std::vector<CMotion*>& getMotions(EMotionEvent event)
            {
                return m_motions[(int)event];
            }

            void convertToUICoordinate(float& pointerX, float& pointerY);

            void convertWorldToLocal(CGUIElement* element, float& x, float& y);

            void convertLocalToWorld(CGUIElement* element, float& x, float& y);

            virtual bool acceptDragFocus()
            {
                return false;
            }

            inline void setSoundId(int slot, int soundId)
            {
                m_soundId[slot] = soundId;
            }

            inline int getSoundId(int slot)
            {
                return m_soundId[slot];
            }

            inline void setUserData(void* data)
            {
                m_userData = data;
            }

            void* getUserData()
            {
                return m_userData;
            }
        };
    }
}