TGUI 1.x-dev
Loading...
Searching...
No Matches
Rect.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2026 Bruno Van de Velde (vdv_b@tgui.eu)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef TGUI_RECT_HPP
26#define TGUI_RECT_HPP
27
28#include <TGUI/Vector2.hpp>
29
30#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !TGUI_DISABLE_SFML_CONVERSIONS
31 #include <SFML/Graphics/Rect.hpp>
32#endif
33
35
36namespace tgui
37{
38 template <typename T>
39 class Rect
40 {
41 public:
47 constexpr Rect() = default;
48
54 template <typename U>
55 explicit constexpr Rect(const Rect<U>& rect) :
56 left{static_cast<T>(rect.left)},
57 top{static_cast<T>(rect.top)},
58 width{static_cast<T>(rect.width)},
59 height{static_cast<T>(rect.height)}
60 {
61 }
62
63#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !TGUI_DISABLE_SFML_CONVERSIONS
69 explicit constexpr Rect(sf::Rect<T> rect) :
70#if SFML_VERSION_MAJOR >= 3
71 left{rect.position.x},
72 top{rect.position.y},
73 width{rect.size.x},
74 height{rect.size.y}
75#else
76 left{rect.left},
77 top{rect.top},
78 width{rect.width},
79 height{rect.height}
80#endif
81 {
82 }
83#endif
84
93 constexpr Rect(T rectLeft, T rectTop, T rectWidth, T rectHeight) :
94 left{rectLeft},
95 top{rectTop},
96 width{rectWidth},
97 height{rectHeight}
98 {
99 }
100
107 constexpr Rect(Vector2<T> position, Vector2<T> size) :
108 left{position.x},
109 top{position.y},
110 width{size.x},
111 height{size.y}
112 {
113 }
114
120 constexpr void setPosition(Vector2<T> position)
121 {
122 left = position.x;
123 top = position.y;
124 }
125
131 [[nodiscard]] constexpr Vector2<T> getPosition() const
132 {
133 return {left, top};
134 }
135
141 constexpr void setSize(Vector2<T> size)
142 {
143 width = size.x;
144 height = size.y;
145 }
146
152 [[nodiscard]] constexpr Vector2<T> getSize() const
153 {
154 return {width, height};
155 }
156
157#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !TGUI_DISABLE_SFML_CONVERSIONS
161 explicit operator sf::Rect<T>() const
162 {
163 return sf::Rect<T>{{left, top}, {width, height}};
164 }
165#endif
166
178 [[nodiscard]] constexpr bool contains(const Vector2<T>& pos) const
179 {
180 return (pos.x >= left) && (pos.x < left + width) && (pos.y >= top) && (pos.y < top + height);
181 }
182
192 [[nodiscard]] constexpr bool intersects(const Rect<T>& rect) const
193 {
194 // Compute the intersection boundaries
195 const T interLeft = std::max(left, rect.left);
196 const T interTop = std::max(top, rect.top);
197 const T interRight = std::min(left + width, rect.left + rect.width);
198 const T interBottom = std::min(top + height, rect.top + rect.height);
199
200 // If the intersection is valid (positive non zero area), then there is an intersection
201 return (interLeft < interRight) && (interTop < interBottom);
202 }
203
205
206 public:
207 T left = 0;
208 T top = 0;
209 T width = 0;
210 T height = 0;
211 };
212
216 template <typename T>
217 [[nodiscard]] constexpr bool operator==(const Rect<T>& left, const Rect<T>& right)
218 {
219 return (left.left == right.left) && (left.width == right.width) && (left.top == right.top) && (left.height == right.height);
220 }
221
225 template <typename T>
226 [[nodiscard]] constexpr bool operator!=(const Rect<T>& left, const Rect<T>& right)
227 {
228 return !(left == right);
229 }
230
232
233 using FloatRect = Rect<float>;
234 using IntRect = Rect<int>;
235 using UIntRect = Rect<unsigned int>;
236} // namespace tgui
237
238#endif // TGUI_RECT_HPP
Definition Rect.hpp:40
constexpr Rect()=default
Default constructor.
float width
Definition Rect.hpp:209
float height
Definition Rect.hpp:210
constexpr Rect(sf::Rect< T > rect)
Constructs the rectangle from an sf::Rect.
Definition Rect.hpp:69
constexpr bool intersects(const Rect< T > &rect) const
Check the intersection between two rectangles.
Definition Rect.hpp:192
constexpr Vector2< T > getSize() const
Returns the size of the rectangle.
Definition Rect.hpp:152
constexpr Rect(const Rect< U > &rect)
Constructs the rectangle from an another Rect with a different type.
Definition Rect.hpp:55
float left
Definition Rect.hpp:207
constexpr void setPosition(Vector2< T > position)
Sets the position of the rectangle.
Definition Rect.hpp:120
constexpr Vector2< T > getPosition() const
Returns the position of the rectangle.
Definition Rect.hpp:131
constexpr bool contains(const Vector2< T > &pos) const
Check if a point is inside the rectangle's area.
Definition Rect.hpp:178
float top
Definition Rect.hpp:208
constexpr void setSize(Vector2< T > size)
Sets the size of the rectangle.
Definition Rect.hpp:141
constexpr Rect(T rectLeft, T rectTop, T rectWidth, T rectHeight)
Constructs the rectangle from its position and size.
Definition Rect.hpp:93
constexpr Rect(Vector2< T > position, Vector2< T > size)
Constructs the rectangle from its position and size.
Definition Rect.hpp:107
Definition Vector2.hpp:42
T y
Y coordinate of the vector.
Definition Vector2.hpp:144
T x
X coordinate of the vector.
Definition Vector2.hpp:143
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:37