Animate.h

Go to the documentation of this file.

// Copyright (c) 2025 Dave R. Smith.
// Malena Framework — Licensed under PolyForm Noncommercial 1.0.0; commercial use requires a paid license. See LICENSE.
 
//
// Animate.h — per-object animation facade.
//
// Obtained via Positionable::animate(). Drives the owner's position (and any
// app-supplied property) through the shared AnimationManager, using delta-time
// Tweeners and Easing curves. Replaces the old moveTo/moveDistance code.
//
 
#ifndef MALENA_ANIMATE_H
#define MALENA_ANIMATE_H
 
#pragma once
 
#include <Malena/Animation/AnimationManager.h>
#include <Malena/Animation/Easing.h>
#include <Malena/Animation/Tweener.h>
#include <SFML/System/Vector2.hpp>
#include <functional>
#include <memory>
 
namespace ml
{
    class Positionable;

    class MALENA_API Animate
    {
    public:
        explicit Animate(Positionable* owner) : _owner(owner) {}
        ~Animate() { cancel(); }
 
        Animate(const Animate&)            = delete;
        Animate& operator=(const Animate&) = delete;

        Animate& move(sf::Vector2f to, float seconds,
                      Easing::Fn ease = Easing::EaseOutCubic,
                      std::function<void()> onComplete = {});

        Animate& moveBy(sf::Vector2f delta, float seconds,
                        Easing::Fn ease = Easing::EaseOutCubic,
                        std::function<void()> onComplete = {});

        template<class T>
        Animate& value(T from, T to, float seconds, Easing::Fn ease,
                       std::function<void(const T&)> apply,
                       std::function<void()> onComplete = {})
        {
            auto tw = std::make_shared<Tweener<T>>(from, to, seconds, ease);
            tw->onUpdate(std::move(apply));
            if (onComplete) tw->onComplete(std::move(onComplete));
            AnimationManager::add(_owner, [tw](float dt) { tw->update(dt); return tw->done(); });
            return *this;
        }

        void cancel();

        [[nodiscard]] bool active() const;
 
    private:
        Positionable* _owner;
    };
 
} // namespace ml
 
#endif // MALENA_ANIMATE_H