Vector2.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
 
#include <SFML/System/Export.hpp>
 
#include <SFML/System/Angle.hpp>
 
 
namespace sf
{
template <typename T>
class Vector2
{
public:
    constexpr Vector2() = default;

    constexpr Vector2(T x, T y);

    template <typename U>
    constexpr explicit Vector2(Vector2<U> vector);

    SFML_SYSTEM_API Vector2(T r, Angle phi);

    [[nodiscard]] SFML_SYSTEM_API T length() const;

    [[nodiscard]] constexpr T lengthSquared() const;

    [[nodiscard]] SFML_SYSTEM_API Vector2 normalized() const;

    [[nodiscard]] SFML_SYSTEM_API Angle angleTo(Vector2 rhs) const;

    [[nodiscard]] SFML_SYSTEM_API Angle angle() const;

    [[nodiscard]] SFML_SYSTEM_API Vector2 rotatedBy(Angle phi) const;

    [[nodiscard]] SFML_SYSTEM_API Vector2 projectedOnto(Vector2 axis) const;

    [[nodiscard]] constexpr Vector2 perpendicular() const;

    [[nodiscard]] constexpr T dot(Vector2 rhs) const;

    [[nodiscard]] constexpr T cross(Vector2 rhs) const;

    [[nodiscard]] constexpr Vector2 componentWiseMul(Vector2 rhs) const;

    [[nodiscard]] constexpr Vector2 componentWiseDiv(Vector2 rhs) const;
 

    // Member data
    T x{}; 
    T y{}; 
 

    // Static member data
    // NOLINTBEGIN(readability-identifier-naming)
    static const Vector2 UnitX; 
    static const Vector2 UnitY; 
    // NOLINTEND(readability-identifier-naming)
};
 
// Define the most common types
using Vector2i = Vector2<int>;
using Vector2u = Vector2<unsigned int>;
using Vector2f = Vector2<float>;

template <typename T>
[[nodiscard]] constexpr Vector2<T> operator-(Vector2<T> right);

template <typename T>
constexpr Vector2<T>& operator+=(Vector2<T>& left, Vector2<T> right);

template <typename T>
constexpr Vector2<T>& operator-=(Vector2<T>& left, Vector2<T> right);

template <typename T>
[[nodiscard]] constexpr Vector2<T> operator+(Vector2<T> left, Vector2<T> right);

template <typename T>
[[nodiscard]] constexpr Vector2<T> operator-(Vector2<T> left, Vector2<T> right);

template <typename T>
[[nodiscard]] constexpr Vector2<T> operator*(Vector2<T> left, T right);

template <typename T>
[[nodiscard]] constexpr Vector2<T> operator*(T left, Vector2<T> right);

template <typename T>
constexpr Vector2<T>& operator*=(Vector2<T>& left, T right);

template <typename T>
[[nodiscard]] constexpr Vector2<T> operator/(Vector2<T> left, T right);

template <typename T>
constexpr Vector2<T>& operator/=(Vector2<T>& left, T right);

template <typename T>
[[nodiscard]] constexpr bool operator==(Vector2<T> left, Vector2<T> right);

template <typename T>
[[nodiscard]] constexpr bool operator!=(Vector2<T> left, Vector2<T> right);
 
} // namespace sf
 
#include <SFML/System/Vector2.inl>