HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
box_constraints.hpp
1// Copyright Take Vos 2022.
2// Distributed under the Boost Software License, Version 1.0.
3// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
4
5#pragma once
6
7#include "../geometry/module.hpp"
8#include "../utility/module.hpp"
9#include <cstdint>
10#include <limits>
11#include <concepts>
12
13namespace hi { inline namespace v1 {
14
23 extent2i minimum = {};
24 extent2i preferred = {};
25 extent2i maximum = {};
26 marginsi margins = {};
27 marginsi padding = {};
28
29 hi::alignment alignment = hi::alignment{};
30
31 constexpr box_constraints() noexcept = default;
32 constexpr box_constraints(box_constraints const&) noexcept = default;
33 constexpr box_constraints(box_constraints&&) noexcept = default;
34 constexpr box_constraints& operator=(box_constraints const&) noexcept = default;
35 constexpr box_constraints& operator=(box_constraints&&) noexcept = default;
36 [[nodiscard]] constexpr friend bool operator==(box_constraints const&, box_constraints const&) noexcept = default;
37
38 constexpr box_constraints(
39 extent2i minimum,
40 extent2i preferred,
41 extent2i maximum,
42 hi::alignment alignment = hi::alignment{},
44 hi::marginsi padding = hi::marginsi{}) noexcept :
45 minimum(minimum), preferred(preferred), maximum(maximum), margins(margins), padding(padding), alignment(alignment)
46 {
47 hi_axiom(holds_invariant());
48 }
49
50 [[nodiscard]] constexpr box_constraints internalize_margins() const noexcept
51 {
52 auto r = *this;
53 r.padding += r.margins;
54
55 r.minimum.width() += r.margins.left() + r.margins.right();
56 r.preferred.width() += r.margins.left() + r.margins.right();
57 r.maximum.width() += r.margins.left() + r.margins.right();
58
59 r.minimum.height() += r.margins.bottom() + r.margins.top();
60 r.preferred.height() += r.margins.bottom() + r.margins.top();
61 r.maximum.height() += r.margins.bottom() + r.margins.top();
62
63 r.margins = 0;
64 hi_axiom(r.holds_invariant());
65 return r;
66 }
67
68 [[nodiscard]] constexpr box_constraints constrain(extent2i new_minimum, extent2i new_maximum) const noexcept
69 {
70 hi_assert(new_minimum <= new_maximum);
71
72 auto r = *this;
73
74 inplace_max(r.minimum, new_minimum);
75 inplace_min(r.maximum, new_maximum);
76
77 inplace_max(r.preferred, r.minimum);
78 inplace_max(r.maximum, r.preferred);
79 hi_axiom(r.holds_invariant());
80 return r;
81 }
82
83 constexpr box_constraints& operator+=(extent2i const& rhs) noexcept
84 {
85 minimum.width() += rhs.width();
86 preferred.width() += rhs.width();
87 maximum.width() += rhs.width();
88 minimum.height() += rhs.height();
89 preferred.height() += rhs.height();
90 maximum.height() += rhs.height();
91
92 hi_axiom(holds_invariant());
93 return *this;
94 }
95
96 [[nodiscard]] constexpr box_constraints operator+(extent2i const& rhs) const noexcept
97 {
98 auto r = *this;
99 r += rhs;
100 return r;
101 }
102
103 [[deprecated]] constexpr box_constraints& operator+=(extent2 const& rhs) noexcept
104 {
105 *this += narrow_cast<extent2i>(rhs);
106 return *this;
107 }
108
109 [[nodiscard]] constexpr bool holds_invariant() const noexcept
110 {
111 if (alignment == horizontal_alignment::flush or alignment == horizontal_alignment::justified) {
112 return false;
113 }
114 if (minimum > preferred or preferred > maximum) {
115 return false;
116 }
117 return true;
118 }
119
120 [[nodiscard]] friend constexpr box_constraints max(box_constraints const& lhs, extent2i const& rhs) noexcept
121 {
122 auto r = lhs;
123 inplace_max(r.minimum, rhs);
124 inplace_max(r.preferred, rhs);
125 inplace_max(r.maximum, rhs);
126
127 hi_axiom(r.holds_invariant());
128 return r;
129 }
130
138 [[nodiscard]] friend constexpr box_constraints max(box_constraints const& lhs, box_constraints const& rhs) noexcept
139 {
140 auto r = lhs;
141 inplace_max(r.minimum, rhs.minimum);
142 inplace_max(r.preferred, rhs.preferred);
143 inplace_max(r.maximum, rhs.maximum);
144 inplace_max(r.margins, rhs.margins);
145 inplace_max(r.padding, rhs.padding);
146
147 hi_axiom(r.holds_invariant());
148 return r;
149 }
150
151 template<std::convertible_to<box_constraints>... Args>
152 [[nodiscard]] friend constexpr box_constraints
153 max(box_constraints const& first, box_constraints const& second, box_constraints const& third, Args const&...args) noexcept
154 {
155 return max(first, max(second, third, args...));
156 }
157};
158
159}} // namespace hi::v1
#define hi_assert(expression,...)
Assert if expression is true.
Definition assert.hpp:184
#define hi_axiom(expression,...)
Specify an axiom; an expression that is true.
Definition assert.hpp:238
geo::extent< int, 2 > extent2i
A 2D extent.
Definition extent.hpp:512
DOXYGEN BUG.
Definition algorithm.hpp:13
geometry/margins.hpp
Definition cache.hpp:11
2D constraints.
Definition box_constraints.hpp:22
friend constexpr box_constraints max(box_constraints const &lhs, box_constraints const &rhs) noexcept
Makes a constraint that encompasses both given constraints.
Definition box_constraints.hpp:138