core: move parts of the animation system to hyprutils (#8868)

* core: change animation manager to use Hyprutils::Animation

* config: move animation config to hyprutils animation tree

* use g_pAnimationManager->createAnimation and the new PHLANIMVAR template

* core: use CGenericAnimatedVariabled::{enabled,setConfig,getStyle} and adapt callbacks

* core: adapt animated variable usage (dereference the shared pointer)

* misc: bump CMakeLists to hyprutils 0.3.3

1 files changed, 19 insertions, 256 deletions

diff --git a/src/helpers/AnimatedVariable.hpp b/src/helpers/AnimatedVariable.hpp
index a1da00da..e7d5fd8c 100644
--- a/src/helpers/AnimatedVariable.hpp
+++ b/src/helpers/AnimatedVariable.hpp
@@ -1,15 +1,18 @@
 #pragma once
 
-#include <functional>
-#include <any>
-#include <chrono>
-#include <type_traits>
-#include "math/Math.hpp"
+#include <hyprutils/animation/AnimatedVariable.hpp>
+
 #include "Color.hpp"
 #include "../defines.hpp"
-#include "../debug/Log.hpp"
 #include "../desktop/DesktopTypes.hpp"
 
+enum eAVarDamagePolicy : int8_t {
+    AVARDAMAGE_NONE   = -1,
+    AVARDAMAGE_ENTIRE = 0,
+    AVARDAMAGE_BORDER,
+    AVARDAMAGE_SHADOW
+};
+
 enum eAnimatedVarType : int8_t {
     AVARTYPE_INVALID = -1,
     AVARTYPE_FLOAT,
@@ -42,20 +45,6 @@ struct STypeToAnimatedVarType_t<CHyprColor> {
 template <class T>
 inline constexpr eAnimatedVarType typeToeAnimatedVarType = STypeToAnimatedVarType_t<T>::value;
 
-enum eAVarDamagePolicy : int8_t {
-    AVARDAMAGE_NONE   = -1,
-    AVARDAMAGE_ENTIRE = 0,
-    AVARDAMAGE_BORDER,
-    AVARDAMAGE_SHADOW
-};
-
-class CAnimationManager;
-struct SAnimationPropertyConfig;
-class CHyprRenderer;
-class CWindow;
-class CWorkspace;
-class CLayerSurface;
-
 // Utility to define a concept as a list of possible type
 template <class T, class... U>
 concept OneOf = (... or std::same_as<T, U>);
@@ -66,245 +55,19 @@ concept OneOf = (... or std::same_as<T, U>);
 template <class T>
 concept Animable = OneOf<T, Vector2D, float, CHyprColor>;
 
-class CBaseAnimatedVariable {
-  public:
-    CBaseAnimatedVariable(eAnimatedVarType type);
-    void create(SAnimationPropertyConfig* pAnimConfig, PHLWINDOW pWindow, eAVarDamagePolicy policy);
-    void create(SAnimationPropertyConfig* pAnimConfig, PHLLS pLayer, eAVarDamagePolicy policy);
-    void create(SAnimationPropertyConfig* pAnimConfig, PHLWORKSPACE pWorkspace, eAVarDamagePolicy policy);
-    void create(SAnimationPropertyConfig* pAnimConfig, eAVarDamagePolicy policy);
-
-    CBaseAnimatedVariable(const CBaseAnimatedVariable&)            = delete;
-    CBaseAnimatedVariable(CBaseAnimatedVariable&&)                 = delete;
-    CBaseAnimatedVariable& operator=(const CBaseAnimatedVariable&) = delete;
-    CBaseAnimatedVariable& operator=(CBaseAnimatedVariable&&)      = delete;
-
-    virtual ~CBaseAnimatedVariable();
-
-    void         unregister();
-    void         registerVar();
-
-    virtual void warp(bool endCallback = true) = 0;
-
-    //
-    void setConfig(SAnimationPropertyConfig* pConfig) {
-        m_pConfig = pConfig;
-    }
-
-    SAnimationPropertyConfig* getConfig() {
-        return m_pConfig;
-    }
-
-    /* returns the spent (completion) % */
-    float getPercent();
-
-    /* returns the current curve value */
-    float getCurveValue();
-
-    // checks if an animation is in progress
-    bool isBeingAnimated() const {
-        return m_bIsBeingAnimated;
-    }
-
-    /*  sets a function to be ran when the animation finishes.
-        if an animation is not running, runs instantly.
-        if "remove" is set to true, will remove the callback when ran. */
-    void setCallbackOnEnd(std::function<void(void* thisptr)> func, bool remove = true) {
-        m_fEndCallback       = std::move(func);
-        m_bRemoveEndAfterRan = remove;
-
-        if (!isBeingAnimated())
-            onAnimationEnd();
-    }
-
-    /*  sets a function to be ran when an animation is started.
-        if "remove" is set to true, will remove the callback when ran. */
-    void setCallbackOnBegin(std::function<void(void* thisptr)> func, bool remove = true) {
-        m_fBeginCallback       = std::move(func);
-        m_bRemoveBeginAfterRan = remove;
-    }
-
-    /*  Sets the update callback, called every time the value is animated and a step is done
-        Warning: calling unregisterVar/registerVar in this handler will cause UB */
-    void setUpdateCallback(std::function<void(void* thisptr)> func) {
-        m_fUpdateCallback = std::move(func);
-    }
-
-    /*  resets all callbacks. Does not call any. */
-    void resetAllCallbacks() {
-        m_fBeginCallback       = nullptr;
-        m_fEndCallback         = nullptr;
-        m_fUpdateCallback      = nullptr;
-        m_bRemoveBeginAfterRan = false;
-        m_bRemoveEndAfterRan   = false;
-    }
-
-    PHLWINDOW getWindow() {
-        return m_pWindow.lock();
-    }
-
-  protected:
-    PHLWINDOWREF                          m_pWindow;
-    PHLWORKSPACEREF                       m_pWorkspace;
-    PHLLSREF                              m_pLayer;
-
-    SAnimationPropertyConfig*             m_pConfig = nullptr;
-
-    bool                                  m_bDummy           = true;
-    bool                                  m_bIsRegistered    = false;
-    bool                                  m_bIsBeingAnimated = false;
+struct SAnimationContext {
+    PHLWINDOWREF      pWindow;
+    PHLWORKSPACEREF   pWorkspace;
+    PHLLSREF          pLayer;
 
-    std::chrono::steady_clock::time_point animationBegin;
-
-    eAVarDamagePolicy                     m_eDamagePolicy = AVARDAMAGE_NONE;
-    eAnimatedVarType                      m_Type;
-
-    bool                                  m_bRemoveEndAfterRan   = true;
-    bool                                  m_bRemoveBeginAfterRan = true;
-    std::function<void(void* thisptr)>    m_fEndCallback;
-    std::function<void(void* thisptr)>    m_fBeginCallback;
-    std::function<void(void* thisptr)>    m_fUpdateCallback;
-
-    bool                                  m_bIsConnectedToActive = false;
-
-    void                                  connectToActive();
-
-    void                                  disconnectFromActive();
-
-    // methods
-    void onAnimationEnd() {
-        m_bIsBeingAnimated = false;
-        disconnectFromActive();
-
-        if (m_fEndCallback) {
-            // loading m_bRemoveEndAfterRan before calling the callback allows the callback to delete this animation safely if it is false.
-            auto removeEndCallback = m_bRemoveEndAfterRan;
-            m_fEndCallback(this);
-            if (removeEndCallback)
-                m_fEndCallback = nullptr; // reset
-        }
-    }
-
-    void onAnimationBegin() {
-        m_bIsBeingAnimated = true;
-        connectToActive();
-
-        if (m_fBeginCallback) {
-            m_fBeginCallback(this);
-            if (m_bRemoveBeginAfterRan)
-                m_fBeginCallback = nullptr; // reset
-        }
-    }
-
-    friend class CAnimationManager;
-    friend class CWorkspace;
-    friend class CLayerSurface;
-    friend class CHyprRenderer;
+    eAVarDamagePolicy eDamagePolicy = AVARDAMAGE_NONE;
 };
 
 template <Animable VarType>
-class CAnimatedVariable : public CBaseAnimatedVariable {
-  public:
-    CAnimatedVariable() : CBaseAnimatedVariable(typeToeAnimatedVarType<VarType>) {
-        ;
-    } // dummy var
-
-    void create(const VarType& value, SAnimationPropertyConfig* pAnimConfig, PHLWINDOW pWindow, eAVarDamagePolicy policy) {
-        create(pAnimConfig, pWindow, policy);
-        m_Value = value;
-        m_Goal  = value;
-    }
-    void create(const VarType& value, SAnimationPropertyConfig* pAnimConfig, PHLLS pLayer, eAVarDamagePolicy policy) {
-        create(pAnimConfig, pLayer, policy);
-        m_Value = value;
-        m_Goal  = value;
-    }
-    void create(const VarType& value, SAnimationPropertyConfig* pAnimConfig, PHLWORKSPACE pWorkspace, eAVarDamagePolicy policy) {
-        create(pAnimConfig, pWorkspace, policy);
-        m_Value = value;
-        m_Goal  = value;
-    }
-    void create(const VarType& value, SAnimationPropertyConfig* pAnimConfig, eAVarDamagePolicy policy) {
-        create(pAnimConfig, policy);
-        m_Value = value;
-        m_Goal  = value;
-    }
-
-    using CBaseAnimatedVariable::create;
-
-    CAnimatedVariable(const CAnimatedVariable&)            = delete;
-    CAnimatedVariable(CAnimatedVariable&&)                 = delete;
-    CAnimatedVariable& operator=(const CAnimatedVariable&) = delete;
-    CAnimatedVariable& operator=(CAnimatedVariable&&)      = delete;
-
-    ~CAnimatedVariable() = default;
-
-    // gets the current vector value (real time)
-    const VarType& value() const {
-        return m_Value;
-    }
-
-    // gets the goal vector value
-    const VarType& goal() const {
-        return m_Goal;
-    }
-
-    CAnimatedVariable& operator=(const VarType& v) {
-        if (v == m_Goal)
-            return *this;
+using CAnimatedVariable = Hyprutils::Animation::CGenericAnimatedVariable<VarType, SAnimationContext>;
 
-        m_Goal         = v;
-        animationBegin = std::chrono::steady_clock::now();
-        m_Begun        = m_Value;
-
-        onAnimationBegin();
-
-        return *this;
-    }
-
-    // Sets the actual stored value, without affecting the goal, but resets the timer
-    void setValue(const VarType& v) {
-        if (v == m_Value)
-            return;
-
-        m_Value        = v;
-        animationBegin = std::chrono::steady_clock::now();
-        m_Begun        = m_Value;
-
-        onAnimationBegin();
-    }
-
-    // Sets the actual value and goal
-    void setValueAndWarp(const VarType& v) {
-        m_Goal             = v;
-        m_bIsBeingAnimated = true;
-        warp();
-    }
-
-    void warp(bool endCallback = true) override {
-        if (!m_bIsBeingAnimated)
-            return;
-
-        m_Value = m_Goal;
-
-        m_bIsBeingAnimated = false;
-
-        if (m_fUpdateCallback)
-            m_fUpdateCallback(this);
-
-        if (endCallback)
-            onAnimationEnd();
-    }
-
-  private:
-    VarType m_Value{};
-    VarType m_Goal{};
-    VarType m_Begun{};
-
-    // owners
+template <Animable VarType>
+using PHLANIMVAR = SP<CAnimatedVariable<VarType>>;
 
-    friend class CAnimationManager;
-    friend class CWorkspace;
-    friend class CLayerSurface;
-    friend class CHyprRenderer;
-};
+template <Animable VarType>
+using PHLANIMVARREF = WP<CAnimatedVariable<VarType>>;