Fadeable.h

Go to the documentation of this file.

// Copyright (c) 2025 Dave R. Smith. All rights reserved.
// Malena Framework — Proprietary Software. See LICENSE for terms.
 
#pragma once
 
#ifndef MALENA_FADEABLE_H
#define MALENA_FADEABLE_H
#include <Malena/Core/malena_export.h>
#include <Malena/Traits/Base/Trait.h>
#include <Malena/Engine/Events/EventManager.h>
#include <Malena/Utilities/Tween.h>
#include <functional>
 
 
namespace ml
{
    class MALENA_API Fadeable : public Trait
    {
    public:
        Fadeable();
        virtual ~Fadeable();
 
        // ── Fade API ──────────────────────────────────────────────────────────

        void fadeTo(uint8_t               targetAlpha,
                    float                 duration   = 0.5f,
                    Tween                 tween      = LINEAR,
                    std::function<void()> onComplete = nullptr);

        void fadeIn(float                 duration   = 0.5f,
                    Tween                 tween      = LINEAR,
                    std::function<void()> onComplete = nullptr);

        void fadeOut(float                 duration   = 0.5f,
                     Tween                 tween      = LINEAR,
                     std::function<void()> onComplete = nullptr);

        void holdFor(float                 duration,
                     std::function<void()> onComplete = nullptr);

        void setAlpha(uint8_t alpha);

        uint8_t getAlpha() const;

        bool isFading() const;
 
    private:
        void tick();
 
        float  _alpha       = 255.f;
        float  _startAlpha  = 255.f;
        float  _targetAlpha = 255.f;
        float  _elapsed     = 0.f;
        float  _duration    = 0.f;
        bool   _active      = false;
        bool   _holding     = false;
        Tween  _tween       = LINEAR;
 
        std::function<void()> _onComplete;
 
        static float applyTween(float t, Tween tween);
    };
 
} // namespace ml
 
#include "../../../../src/Traits/Visual/Fadeable.cpp"
#endif