Vector3.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>
 
 
namespace sf
{
template <typename T>
class Vector3
{
public:
    constexpr Vector3() = default;

    constexpr Vector3(T x, T y, T z);

    template <typename U>
    constexpr explicit Vector3(const Vector3<U>& vector);

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

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

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

    [[nodiscard]] constexpr T dot(const Vector3& rhs) const;

    [[nodiscard]] constexpr Vector3 cross(const Vector3& rhs) const;

    [[nodiscard]] constexpr Vector3 componentWiseMul(const Vector3& rhs) const;

    [[nodiscard]] constexpr Vector3 componentWiseDiv(const Vector3& rhs) const;

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

template <typename T>
[[nodiscard]] constexpr Vector3<T> operator-(const Vector3<T>& left);

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

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

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

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

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

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

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

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

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

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

template <typename T>
[[nodiscard]] constexpr bool operator!=(const Vector3<T>& left, const Vector3<T>& right);
 
// Define the most common types
using Vector3i = Vector3<int>;
using Vector3f = Vector3<float>;
 
} // namespace sf
 
#include <SFML/System/Vector3.inl>