Animation.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_ANIMATION_HPP
#define TGUI_ANIMATION_HPP
 
#include <TGUI/Layout.hpp>
#include <TGUI/Duration.hpp>
 
#include <functional>
#include <memory>

 
namespace tgui
{
    class Widget;

    enum class ShowEffectType
    {
        Fade,          
        Scale,         
        SlideToRight,  
        SlideToLeft,   
        SlideToBottom, 
        SlideToTop,    
 
        SlideFromLeft = SlideToRight, 
        SlideFromRight = SlideToLeft, 
        SlideFromTop = SlideToBottom, 
        SlideFromBottom = SlideToTop  
    };

    enum class AnimationType
    {
        Move,       
        Resize,     
        Opacity,    
    };
 
    namespace priv
    {
 
        class TGUI_API Animation
        {
        public:
 
            // Move constructor has to be explicitly declared since this class has a destructor
            Animation(const Animation&) = default;
            Animation(Animation&&) = default;
            Animation& operator=(const Animation&) = default;
            Animation& operator=(Animation&&) = default;
            virtual ~Animation() = default;
 
            TGUI_NODISCARD AnimationType getType() const;
 
            virtual bool update(Duration elapsedTime) = 0;
            virtual void finish();
 
        protected:
            Animation(AnimationType type, std::shared_ptr<Widget> widget, Duration duration, std::function<void()> finishedCallback);
 
        protected:
            AnimationType m_type;
            std::shared_ptr<Widget> m_widget;
 
            Duration m_totalDuration;
            Duration m_elapsedTime;
 
            std::function<void()> m_finishedCallback;
        };

 
        class TGUI_API MoveAnimation : public Animation
        {
        public:
            MoveAnimation(std::shared_ptr<Widget> widget, Vector2f start, Layout2d end, Duration duration, std::function<void()> finishedCallback = nullptr);
 
            bool update(Duration elapsedTime) override;
 
            void finish() override;
 
        private:
            Vector2f m_startPos;
            Layout2d m_endPos;
        };

 
        class TGUI_API ResizeAnimation : public Animation
        {
        public:
            ResizeAnimation(std::shared_ptr<Widget> widget, Vector2f start, Layout2d end, Duration duration, std::function<void()> finishedCallback = nullptr);
 
            bool update(Duration elapsedTime) override;
 
            void finish() override;
 
        private:
            Vector2f m_startSize;
            Layout2d m_endSize;
        };

 
        class TGUI_API FadeAnimation : public Animation
        {
        public:
            FadeAnimation(std::shared_ptr<Widget> widget, float start, float end, Duration duration, std::function<void()> finishedCallback = nullptr);
 
            bool update(Duration elapsedTime) override;
 
            void finish() override;
 
        private:
            float m_startOpacity;
            float m_endOpacity;
        };

 
    } // namespace priv
} // namespace tgui

 
#endif // TGUI_ANIMATION_HPP