TGUI  1.6.1
Loading...
Searching...
No Matches
Rect.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2024 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
36TGUI_MODULE_EXPORT namespace tgui
37{
38 template <typename T>
39 class Rect
40 {
41 public:
42
48 constexpr Rect() = default;
49
55 template <typename U>
56 explicit constexpr Rect(const Rect<U>& rect) :
57 left {static_cast<T>(rect.left)},
58 top {static_cast<T>(rect.top)},
59 width {static_cast<T>(rect.width)},
60 height{static_cast<T>(rect.height)}
61 {
62 }
63
64#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !TGUI_DISABLE_SFML_CONVERSIONS
70 explicit constexpr Rect(sf::Rect<T> rect) :
71 left {rect.left},
72 top {rect.top},
73 width {rect.width},
74 height{rect.height}
75 {
76 }
77#endif
78
87 constexpr Rect(T rectLeft, T rectTop, T rectWidth, T rectHeight) :
88 left {rectLeft},
89 top {rectTop},
90 width {rectWidth},
91 height{rectHeight}
92 {
93 }
94
101 constexpr Rect(Vector2<T> position, Vector2<T> size) :
102 left {position.x},
103 top {position.y},
104 width {size.x},
105 height{size.y}
106 {
107 }
108
114 constexpr void setPosition(Vector2<T> position)
115 {
116 left = position.x;
117 top = position.y;
118 }
119
125 TGUI_NODISCARD constexpr Vector2<T> getPosition() const
126 {
127 return {left, top};
128 }
129
135 constexpr void setSize(Vector2<T> size)
136 {
137 width = size.x;
138 height = size.y;
139 }
140
146 TGUI_NODISCARD constexpr Vector2<T> getSize() const
147 {
148 return {width, height};
149 }
150
151#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !TGUI_DISABLE_SFML_CONVERSIONS
155 explicit operator sf::Rect<T>() const
156 {
157 return sf::Rect<T>{left, top, width, height};
158 }
159#endif
160
172 TGUI_NODISCARD constexpr bool contains(const Vector2<T>& pos) const
173 {
174 return (pos.x >= left) && (pos.x < left + width) && (pos.y >= top) && (pos.y < top + height);
175 }
176
186 TGUI_NODISCARD constexpr bool intersects(const Rect<T>& rect) const
187 {
188 // Compute the intersection boundaries
189 const T interLeft = std::max(left, rect.left);
190 const T interTop = std::max(top, rect.top);
191 const T interRight = std::min(left + width, rect.left + rect.width);
192 const T interBottom = std::min(top + height, rect.top + rect.height);
193
194 // If the intersection is valid (positive non zero area), then there is an intersection
195 return (interLeft < interRight) && (interTop < interBottom);
196 }
197
199 public:
200
201 T left = 0;
202 T top = 0;
203 T width = 0;
204 T height = 0;
205 };
206
210 template <typename T>
211 TGUI_NODISCARD constexpr bool operator==(const Rect<T>& left, const Rect<T>& right)
212 {
213 return (left.left == right.left) && (left.width == right.width)
214 && (left.top == right.top) && (left.height == right.height);
215 }
216
220 template <typename T>
221 TGUI_NODISCARD constexpr bool operator!=(const Rect<T>& left, const Rect<T>& right)
222 {
223 return !(left == right);
224 }
225
227
228 using FloatRect = Rect<float>;
229 using IntRect = Rect<int>;
230 using UIntRect = Rect<unsigned int>;
231}
232
234
235#endif // TGUI_RECT_HPP
Definition Rect.hpp:40
constexpr Rect()=default
Default constructor.
T width
Width of the rectangle.
Definition Rect.hpp:203
T height
Height of the rectangle.
Definition Rect.hpp:204
constexpr Rect(sf::Rect< T > rect)
Constructs the rectangle from an sf::Rect.
Definition Rect.hpp:70
constexpr bool intersects(const Rect< T > &rect) const
Check the intersection between two rectangles.
Definition Rect.hpp:186
constexpr Vector2< T > getSize() const
Returns the size of the rectangle.
Definition Rect.hpp:146
constexpr Rect(const Rect< U > &rect)
Constructs the rectangle from an another Rect with a different type.
Definition Rect.hpp:56
T left
Left coordinate of the rectangle.
Definition Rect.hpp:201
constexpr void setPosition(Vector2< T > position)
Sets the position of the rectangle.
Definition Rect.hpp:114
constexpr Vector2< T > getPosition() const
Returns the position of the rectangle.
Definition Rect.hpp:125
constexpr bool contains(const Vector2< T > &pos) const
Check if a point is inside the rectangle's area.
Definition Rect.hpp:172
T top
Top coordinate of the rectangle.
Definition Rect.hpp:202
constexpr void setSize(Vector2< T > size)
Sets the size of the rectangle.
Definition Rect.hpp:135
constexpr Rect(T rectLeft, T rectTop, T rectWidth, T rectHeight)
Constructs the rectangle from its position and size.
Definition Rect.hpp:87
constexpr Rect(Vector2< T > position, Vector2< T > size)
Constructs the rectangle from its position and size.
Definition Rect.hpp:101
Definition Vector2.hpp:41
T y
Y coordinate of the vector.
Definition Vector2.hpp:136
T x
X coordinate of the vector.
Definition Vector2.hpp:135
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:38