Positionable.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.
 
//
// Created by Dave Smith on 11/13/22.
//
 
#ifndef MALENA_PORTFOLIO_POSITIONABLE_H
#define MALENA_PORTFOLIO_POSITIONABLE_H
 
#pragma once
 
#include <Malena/Core/malena_export.h>
#include <SFML/Graphics.hpp>
#include <memory>
#include <Malena/Traits/Base/Trait.h>
 
namespace ml
{
    class Animate;
    class MALENA_API Positionable : public Trait
    {
    public:
        // Positionable stores NO animation member (that would delete the copy
        // assignment the framework relies on for value-type shapes). The Animate
        // controller is owned in an external pointer-keyed registry; this destructor
        // releases it. Declared out-of-line so Animate stays a forward declaration here.
        virtual ~Positionable();

        Animate& animate();
 
        // ── Retained-anchor control ──────────────────────────────────────────
        // The relative-layout helpers below (setBelow/center*/…) are RETAINED by
        // default: each records a live constraint against its reference and is
        // re-solved on window resize, so layouts stay correct when the window
        // changes. A direct setPosition detaches them (manual control wins).

        void unanchored();

        void centerInWindow();
        void centerXInWindow(float offset = 0.f);
        void centerYInWindow(float offset = 0.f);
 
        // Pin an edge to the window's inside edge, @p margin px inward (retained).
        void anchorLeftInWindow(float margin = 0.f);
        void anchorRightInWindow(float margin = 0.f);
        void anchorTopInWindow(float margin = 0.f);
        void anchorBottomInWindow(float margin = 0.f);

        virtual void setPosition(const sf::Vector2f& position) {}

        virtual sf::Vector2f getPosition() const { return {}; }

        virtual sf::FloatRect getGlobalBounds() const { return {}; }
 
        // ── Relative layout helpers ──────────────────────────────────────────

        template<class T>
        void setRightOf(T& obj, float spacing = 0);

        template<class T>
        void setLeftOf(T& obj, float spacing = 0);

        template<class T>
        void setBelow(T& obj, float spacing = 0);

        template<class T>
        void setAbove(T& obj, float spacing = 0);

        template<class T>
        void center(T& obj);

        template<class T>
        void centerHorizonally(T& obj);

        template<class T>
        void centerVertically(T& obj);

        void centerText(sf::Text& obj);
    };
 
} // namespace ml
 
#include "../../../../src/Traits/Spatial/Positionable.tpp"
#endif // MALENA_PORTFOLIO_POSITIONABLE_H