Carousel.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.
 
//
// Carousel.h
//
 
#ifndef MALENA_CAROUSEL_H
#define MALENA_CAROUSEL_H
 
#include <Malena/Core/malena_export.h>
#include <Malena/Core/Core.h>
#include <Malena/Traits/Base/Customizable.h>
#include <Malena/Manifests/Manifest.h>
#include <Malena/Graphics/Primitives/Rectangle.h>
#include <Malena/Resources/FontManager.h>
#include <list>
#include <optional>
#include <Malena/Utilities/ShaderLibrary.h>
#include <Malena/Core/Component.h>
 
namespace ml
{
    class MALENA_API CarouselManifest : public ml::Manifest
    {
    public:
        enum class Flag  { SCROLLING, SHOW_ARROWS };

        enum class State { SCROLL_IDLE, SCROLL_LEFT, SCROLL_RIGHT };

        enum class ArrowPlacement { SIDES, TOP, OVERLAY };

        enum class ArrowSide { LEFT, RIGHT };

        using Style = ShaderLibrary::Style;
    };

    class MALENA_API Carousel : public ComponentWith<CarouselManifest>
    {
    public:
        using Flag           = CarouselManifest::Flag;
        using State          = CarouselManifest::State;
        using Style          = CarouselManifest::Style;
        using ArrowPlacement = CarouselManifest::ArrowPlacement;
        using ArrowSide      = CarouselManifest::ArrowSide;
 
    private:
        std::list<ml::Core*> _components;
        sf::RenderTexture    _renderTexture;
        sf::Sprite           _sprite;
        sf::View             _carouselView;
 
        // Shader
        CarouselManifest::Style          _currentStyle = CarouselManifest::Style::DEFAULT;
        sf::Shader*                      _shader = nullptr;
        std::unique_ptr<sf::Shader>      _ownedShader;
        std::function<void(sf::Shader&)> _shaderUniformSetter;
        float                            _shaderTime = 0.f;
        ShaderLibrary::Params            _shaderParams;
 
        // Scroll state
        float _spacing      = 10.f;
        float _speed        = 1.f;
        float _viewX        = 0.f;
        float _targetViewX  = 0.f;
        int   _previewCount = 5;
 
        sf::Vector2f _position = {0.f, 0.f};
 
        // Arrow controls
        ml::Rectangle              _leftArrow;
        ml::Rectangle              _rightArrow;
        sf::Text                   _leftLabel;
        sf::Text                   _rightLabel;
        ArrowPlacement             _arrowPlacement  = ArrowPlacement::SIDES;
        float                      _arrowSize       = 40.f;
        sf::Color                  _arrowColor      = sf::Color(80,  80,  80,  200);
        sf::Color                  _arrowHoverColor = sf::Color(120, 120, 120, 230);
        std::optional<sf::Texture> _leftArrowTexture;
        std::optional<sf::Texture> _rightArrowTexture;
        std::optional<sf::Vector2f> _leftArrowManualPos;
        std::optional<sf::Vector2f> _rightArrowManualPos;
 
        void updateView();
        void wrapComponents();
        void updateRenderTextureSize();
        void updateArrowPositions();
        void drawTexture();
        void loadShaderForStyle(Style style);
        void initArrows();
        bool isOnLeftArrow(sf::Vector2f screenPos) const;
        bool isOnRightArrow(sf::Vector2f screenPos) const;
 
    protected:
        void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
    public:
        Carousel();
 
        Carousel(const Carousel&)            = delete;
        Carousel& operator=(const Carousel&) = delete;
 
        // ── Item management ──────────────────────────────────────────────────

        void add(ml::Core& component);

        void remove(ml::Core& component);
 
        // ── Positionable overrides ───────────────────────────────────────────
 
        void          setPosition(const sf::Vector2f& position) override;
        sf::Vector2f  getPosition() const override;
        sf::FloatRect getGlobalBounds() const override;
        sf::RenderStates getRenderStates() const override;
 
        // ── Navigation ───────────────────────────────────────────────────────

        void next();

        void previous();
 
        // ── Content settings ─────────────────────────────────────────────────

        void  setSpacing(float spacing);

        float getSpacing() const;

        void  setSpeed(float speed);

        float getSpeed() const;

        void setPreviewCount(int count);

        int  getPreviewCount() const;
 
        // ── Shader settings ──────────────────────────────────────────────────

        void  setStyle(Style style);

        Style getStyle() const;

        void setShader(sf::Shader* shader, std::function<void(sf::Shader&)> uniformSetter);

        void setShaderParams(const ShaderLibrary::Params& params);

        ShaderLibrary::Params& getShaderParams();
 
        // ── Arrow settings ───────────────────────────────────────────────────

        void showArrows(bool show);

        void setArrowPlacement(ArrowPlacement placement);

        void setArrowSize(float size);

        void setArrowColor(sf::Color color);

        void setArrowHoverColor(sf::Color color);

        void setArrowTexture(ArrowSide side, sf::Texture texture);

        void setArrowPosition(ArrowSide side, sf::Vector2f position);

        void clearArrowPosition(ArrowSide side);
    };
 
} // namespace ml
 
#endif // MALENA_CAROUSEL_H