Transform.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/Graphics/Export.hpp>
 
#include <SFML/Graphics/Rect.hpp>
 
#include <SFML/System/Vector2.hpp>
 
#include <array>
 
 
namespace sf
{
class Angle;

class Transform
{
public:
    constexpr Transform() = default;

    constexpr Transform(float a00, float a01, float a02, float a10, float a11, float a12, float a20, float a21, float a22);

    [[nodiscard]] constexpr const float* getMatrix() const;

    [[nodiscard]] constexpr Transform getInverse() const;

    [[nodiscard]] constexpr Vector2f transformPoint(Vector2f point) const;

    [[nodiscard]] constexpr FloatRect transformRect(const FloatRect& rectangle) const;

    constexpr Transform& combine(const Transform& transform);

    constexpr Transform& translate(Vector2f offset);

    SFML_GRAPHICS_API Transform& rotate(Angle angle);

    SFML_GRAPHICS_API Transform& rotate(Angle angle, Vector2f center);

    constexpr Transform& scale(Vector2f factors);

    constexpr Transform& scale(Vector2f factors, Vector2f center);

    // Static member data
    // NOLINTNEXTLINE(readability-identifier-naming)
    static const Transform Identity; 
 
private:
    // Member data
    // clang-format off
    std::array<float, 16> m_matrix{1.f, 0.f, 0.f, 0.f,
                                   0.f, 1.f, 0.f, 0.f,
                                   0.f, 0.f, 1.f, 0.f,
                                   0.f, 0.f, 0.f, 1.f}; 
    // clang-format off
};

[[nodiscard]] constexpr Transform operator*(const Transform& left, const Transform& right);

constexpr Transform& operator*=(Transform& left, const Transform& right);

[[nodiscard]] constexpr Vector2f operator*(const Transform& left, Vector2f right);

[[nodiscard]] constexpr bool operator==(const Transform& left, const Transform& right);

[[nodiscard]] constexpr bool operator!=(const Transform& left, const Transform& right);
 
} // namespace sf
 
#include <SFML/Graphics/Transform.inl>