UILayout.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "UIUtility.hpp"
 
#include "CeresEngine/Foundation/Constraint/Constraint.hpp"
#include "CeresEngine/Foundation/Constraint/ConstraintStrength.hpp"
#include "CeresEngine/Foundation/Constraint/ConstraintVariable.hpp"
 
namespace CeresEngine::Constraint {
    class ConstraintSolver;
}
 
namespace CeresEngine {
    class UIView;
 
    using UILayoutAnchor = Constraint::ConstraintVariable;
 
//    /// A `UILayoutAnchor` variable that is linked to a view.
//    class UILayoutAttribute : public Constraint::AbstractVariable {
//    protected:
//        UIView& mView;
//
//    public:
//        explicit UILayoutAttribute(UIView& view, const String& varName);
//
//    public:
//        /// The view linked to this layout anchor variable.
//        UIView& getView() const { return mView; }
//
//    public: // AbstractVariable
//        /// \copydoc AbstractVariable::isExternal
//        [[nodiscard]] bool isExternal() const final { return true; }
//
//        /// \copydoc AbstractVariable::isPivotable
//        [[nodiscard]] bool isPivotable() const final { return false; }
//
//        /// \copydoc AbstractVariable::isRestricted
//        [[nodiscard]] bool isRestricted() const final { return false; }
//
//        /// \copydoc AbstractVariable::isFloat
//        [[nodiscard]] bool isFloat() const final { return true; }
//
//        /// \copydoc AbstractVariable::getName
//        [[nodiscard]] String getName() const final;
//
//        /// \copydoc AbstractVariable::toString
//        [[nodiscard]] String toString() const final { return getName(); }
//    };
//
//    /// A `UILayoutAttribute` variable that is linked to a view.
//    class UILayoutAnchorVariable : public UILayoutAttribute {
//    private:
//        /// The anchor value. This is just an internal value used during layout
//        /// computation.
//        double mValue = 0.0;
//
//    public:
//        using UILayoutAttribute::UILayoutAttribute;
//
//    public: // AbstractVariable
//        /// \copydoc AbstractVariable::setValue
//        void setValue(double newValue) final { mValue = newValue; }
//
//        /// \copydoc AbstractVariable::getValue
//        [[nodiscard]] double getValue() const final { return mValue; }
//    };
//
//    // ---------------------------------------------------------------------------------------------
//
//    /// A `UILayoutAttribute` variable that is linked to a view.
//    class UILayoutFrameAttribute : public UILayoutAttribute {
//    protected:
//        /// The `UIView` frame rectangle.
//        UIRect& mFrame;
//
//    public:
//        /// Creates a new `UILayoutAttribute` for the frame rectangle.
//        /// \param view     The view that owns the attribute.
//        /// \param varName  The name of view variable being controlled.
//        /// \param frame    A reference to the frame rectangle to be controlled.
//        explicit UILayoutFrameAttribute(UIView& view, const String& varName, UIRect& frame);
//
//    protected:
//        virtual const double& getProperty(const UIRect& frame) const = 0;
//
//        double& getProperty(UIRect& frame) const { return const_cast<double&>(getProperty(const_cast<const UIRect&>(frame))); }
//
//    public: // AbstractVariable
//        /// \copydoc AbstractVariable::setValue
//        void setValue(double newValue) final;
//
//        /// \copydoc AbstractVariable::getValue
//        [[nodiscard]] double getValue() const final;
//    };
//
//    class UILayoutSizeWidthAttribute final : public UILayoutFrameAttribute {
//    public:
//        using UILayoutFrameAttribute::UILayoutFrameAttribute;
//
//    protected: // UILayoutFrameAttribute
//        /// \copydoc UILayoutFrameAttribute::getProperty
//        const double& getProperty(const UIRect& rect) const final { return rect.size.width; }
//    };
//
//    class UILayoutSizeHeightAttribute final : public UILayoutFrameAttribute {
//    public:
//        using UILayoutFrameAttribute::UILayoutFrameAttribute;
//
//    protected: // UILayoutFrameAttribute
//        /// \copydoc UILayoutFrameAttribute::getProperty
//        const double& getProperty(const UIRect& rect) const final { return rect.size.height; }
//    };
//
//    class UILayoutLocationXAttribute final : public UILayoutFrameAttribute {
//    public:
//        using UILayoutFrameAttribute::UILayoutFrameAttribute;
//
//    protected: // UILayoutFrameAttribute
//        /// \copydoc UILayoutFrameAttribute::getProperty
//        const double& getProperty(const UIRect& rect) const final { return rect.origin.x; }
//    };
//
//    class UILayoutLocationYAttribute final : public UILayoutFrameAttribute {
//    public:
//        using UILayoutFrameAttribute::UILayoutFrameAttribute;
//
//    protected: // UILayoutFrameAttribute
//        /// \copydoc UILayoutFrameAttribute::getProperty
//        const double& getProperty(const UIRect& rect) const final { return rect.origin.y; }
//    };
 
    // ---------------------------------------------------------------------------------------------
 
    using UILayoutConstraint = Constraint::Constraint;
 
    using UILayoutStrength = Constraint::ConstraintStrength;
 
    class UILayoutSolver;
 
}