Rect.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#pragma once

// Headers
#include <SFML/System/Vector2.hpp>
 
#include <optional>
 
 
namespace sf
{
template <typename T>
class Rect
{
public:
    constexpr Rect() = default;

    constexpr Rect(Vector2<T> position, Vector2<T> size);

    template <typename U>
    constexpr explicit Rect(const Rect<U>& rectangle);

    [[nodiscard]] constexpr bool contains(Vector2<T> point) const;

    [[nodiscard]] constexpr std::optional<Rect<T>> findIntersection(const Rect<T>& rectangle) const;

    [[nodiscard]] constexpr Vector2<T> getCenter() const;

    // Member data
    Vector2<T> position{}; 
    Vector2<T> size{};     
};

template <typename T>
[[nodiscard]] constexpr bool operator==(const Rect<T>& lhs, const Rect<T>& rhs);

template <typename T>
[[nodiscard]] constexpr bool operator!=(const Rect<T>& lhs, const Rect<T>& rhs);
 
// Create type aliases for the most common types
using IntRect   = Rect<int>;
using FloatRect = Rect<float>;
 
} // namespace sf
 
#include <SFML/Graphics/Rect.inl>