SFML - Simple and Fast Multimedia Library

SFML 3.0.2
Loading...
Searching...
No Matches
Rect.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2025 Laurent Gomila (laurent@sfml-dev.org)
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#pragma once
26
28// Headers
30#include <SFML/System/Vector2.hpp>
31
32#include <optional>
33
34
35namespace sf
36{
41template <typename T>
42 class Rect
43{
44public:
52 constexpr Rect() = default;
53
64 constexpr Rect(Vector2<T> position, Vector2<T> size);
65
70 template <typename U>
71 constexpr explicit operator Rect<U>() const;
72
86 [[nodiscard]] constexpr bool contains(Vector2<T> point) const;
87
98 [[nodiscard]] constexpr std::optional<Rect<T>> findIntersection(const Rect<T>& rectangle) const;
99
106 [[nodiscard]] constexpr Vector2<T> getCenter() const;
107
109 // Member data
111 Vector2<T> position{};
112 Vector2<T> size{};
113};
114
127template <typename T>
128[[nodiscard]] constexpr bool operator==(const Rect<T>& lhs, const Rect<T>& rhs);
129
142template <typename T>
143[[nodiscard]] constexpr bool operator!=(const Rect<T>& lhs, const Rect<T>& rhs);
144
145// Create type aliases for the most common types
146 using IntRect = Rect<int>;
147 using FloatRect = Rect<float>;
148
149} // namespace sf
150
151#include <SFML/Graphics/Rect.inl>
152
153
Vector2.hpp
sf::Rect
Utility class for manipulating 2D axis aligned rectangles.
Definition Rect.hpp:43
sf::Rect::Rect
constexpr Rect(Vector2< T > position, Vector2< T > size)
Construct the rectangle from position and size.
sf::Rect< int >::size
Vector2< int > size
Definition Rect.hpp:112
sf::Rect::operator!=
constexpr bool operator!=(const Rect< T > &lhs, const Rect< T > &rhs)
Overload of binary operator!=.
sf::Rect< int >::position
Vector2< int > position
Definition Rect.hpp:111
sf::Rect::Rect
constexpr Rect()=default
Default constructor.
sf::Rect::findIntersection
constexpr std::optional< Rect< T > > findIntersection(const Rect< T > &rectangle) const
Check the intersection between two rectangles.
sf::Rect::operator==
constexpr bool operator==(const Rect< T > &lhs, const Rect< T > &rhs)
Overload of binary operator==.
sf::Rect::getCenter
constexpr Vector2< T > getCenter() const
Get the position of the center of the rectangle.
sf::Rect::contains
constexpr bool contains(Vector2< T > point) const
Check if a point is inside the rectangle's area.
sf::Vector2
Class template for manipulating 2-dimensional vectors.
Definition Vector2.hpp:41
sf
Definition AudioResource.hpp:36
sf::FloatRect
Rect< float > FloatRect
Definition Rect.hpp:147
sf::IntRect
Rect< int > IntRect
Definition Rect.hpp:146