Outline.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_OUTLINE_HPP
#define TGUI_OUTLINE_HPP
 
#include <TGUI/Vector2.hpp>
#include <TGUI/AbsoluteOrRelativeValue.hpp>

 
TGUI_MODULE_EXPORT namespace tgui
{
 
    class TGUI_API Outline
    {
    public:

        constexpr Outline(AbsoluteOrRelativeValue size = 0) :
            m_left  {size},
            m_top   {size},
            m_right {size},
            m_bottom{size}
        {
        }

        template <typename T, typename = typename std::enable_if_t<std::is_arithmetic<T>::value, T>>
        constexpr Outline(T size) :
            m_left  {size},
            m_top   {size},
            m_right {size},
            m_bottom{size}
        {
        }

        constexpr Outline(AbsoluteOrRelativeValue width, AbsoluteOrRelativeValue height) :
            m_left  {width},
            m_top   {height},
            m_right {width},
            m_bottom{height}
        {
        }

        constexpr Outline(AbsoluteOrRelativeValue leftBorderWidth, AbsoluteOrRelativeValue topBorderHeight, AbsoluteOrRelativeValue rightBorderWidth, AbsoluteOrRelativeValue bottomBorderHeight) :
            m_left  {leftBorderWidth},
            m_top   {topBorderHeight},
            m_right {rightBorderWidth},
            m_bottom{bottomBorderHeight}
        {
        }

        TGUI_NODISCARD constexpr float getLeft() const
        {
            return m_left.getValue();
        }

        TGUI_NODISCARD constexpr float getTop() const
        {
            return m_top.getValue();
        }

        TGUI_NODISCARD constexpr float getRight() const
        {
            return m_right.getValue();
        }

        TGUI_NODISCARD constexpr float getBottom() const
        {
            return m_bottom.getValue();
        }

        TGUI_NODISCARD constexpr Vector2f getOffset() const
        {
            return {getLeft(), getTop()};
        }

        TGUI_NODISCARD constexpr bool operator==(const Outline& outline) const
        {
            return (getLeft() == outline.getLeft()) && (getTop() == outline.getTop()) && (getRight() == outline.getRight()) && (getBottom() == outline.getBottom());
        }

        TGUI_NODISCARD constexpr bool operator!=(const Outline& outline) const
        {
            return !(*this == outline);
        }

        TGUI_NODISCARD constexpr Outline operator+(const Outline& other) const
        {
            return {getLeft() + other.getLeft(),
                    getTop() + other.getTop(),
                    getRight() + other.getRight(),
                    getBottom() + other.getBottom()};
        }

        TGUI_NODISCARD constexpr Outline operator-(const Outline& other) const
        {
            return {getLeft() - other.getLeft(),
                    getTop() - other.getTop(),
                    getRight() - other.getRight(),
                    getBottom() - other.getBottom()};
        }

        constexpr Outline& operator+=(const Outline& other)
        {
            m_left = getLeft() + other.getLeft();
            m_top = getTop() + other.getTop();
            m_right = getRight() + other.getRight();
            m_bottom = getBottom() + other.getBottom();
            return *this;
        }

        constexpr Outline& operator-=(const Outline& other)
        {
            m_left = getLeft() - other.getLeft();
            m_top = getTop() - other.getTop();
            m_right = getRight() - other.getRight();
            m_bottom = getBottom() - other.getBottom();
            return *this;
        }

        constexpr void updateParentSize(Vector2f newParentSize)
        {
            m_left.updateParentSize(newParentSize.x);
            m_top.updateParentSize(newParentSize.y);
            m_right.updateParentSize(newParentSize.x);
            m_bottom.updateParentSize(newParentSize.y);
        }

        TGUI_NODISCARD String toString() const
        {
            return U"(" + m_left.toString() + U", " + m_top.toString() + U", " + m_right.toString() + U", " + m_bottom.toString() + U")";
        }

    private:
 
        AbsoluteOrRelativeValue m_left = 0;      
        AbsoluteOrRelativeValue m_top = 0;       
        AbsoluteOrRelativeValue m_right = 0;     
        AbsoluteOrRelativeValue m_bottom = 0;    
    };

 
    using Borders = Outline;
    using Padding = Outline;

}

 
#endif // TGUI_OUTLINE_HPP