Air-Trap/Vec3_8hpp_source.html

/*

** EPITECH PROJECT, 2025

** R-Type

** File description:

** Vec3.hpp, Vector of 3 class declaration

*/


/*

** MIT License

**

** Copyright (c) 2025 Robin Toillon

**

** Permission is hereby granted, free of charge, to any person obtaining

** a copy of this software and associated documentation files (the

** "Software"), to deal in the Software without restriction, including

** without limitation the rights to use, copy, modify, merge, publish,

** distribute, sublicense, and/or sell copies of the Software, and to

** permit persons to whom the Software is furnished to do so, subject to

** the following conditions:

**

** The above copyright notice and this permission notice shall be

** included in all copies or substantial portions of the Software.

**

** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

** CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

** SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

*/


#ifndef RTYPE_VEC3_HPP_

    #define RTYPE_VEC3_HPP_


    #include "RType/Assert.hpp"

    #include "RType/Math/details/VecBase.hpp"


namespace rtp

{

    template <Numeric T>


    struct Vec3 : details::VecBase<T, 3> {

        T x{};

        T y{};

        T z{};

        constexpr Vec3(void) = default;


        constexpr Vec3(T x, T y, T z) noexcept;


        constexpr ~Vec3() = default;


        [[nodiscard]]

        constexpr bool operator==(const Vec3 &) const noexcept = default;


        [[nodiscard]]

        constexpr auto &operator[](this auto &self, size_t index) noexcept;


        [[nodiscard]]

        constexpr auto cross(const Vec3 &other) const noexcept

            -> Vec3;

    };


    using Vec3f = Vec3<float>;

    using Vec3d = Vec3<double>;

    using Vec3i = Vec3<int>;

    using Vec3u = Vec3<unsigned int>;

}


    #include "Vec3.tpp"


#endif /* !RTYPE_VEC3_HPP_ */

Assert.hpp
Assertion and verification macros for runtime checks.

Vec3.tpp

VecBase.hpp
Declaration of the CRTP base vector class.

rtp

rtp::Vec3
A 3-dimensional vector.
Definition Vec3.hpp:53

rtp::Vec3::x
T x
X coordinate.
Definition Vec3.hpp:54

rtp::Vec3::operator[]
constexpr auto & operator[](this auto &self, size_t index) noexcept
Accesses the coordinate at the specified index.

rtp::Vec3::Vec3
constexpr Vec3(void)=default
Default constructor.

rtp::Vec3::cross
constexpr auto cross(const Vec3 &other) const noexcept -> Vec3
The cross product of two 3D vectors.

rtp::Vec3::~Vec3
constexpr ~Vec3()=default
Default destructor.

rtp::Vec3::operator==
constexpr bool operator==(const Vec3 &) const noexcept=default
Checks if two vectors are exactly equal.

rtp::Vec3::y
T y
Y coordinate.
Definition Vec3.hpp:55

rtp::Vec3::z
T z
Z coordinate.
Definition Vec3.hpp:56

rtp::Vec3::Vec3
constexpr Vec3(T x, T y, T z) noexcept
Parameterized constructor.

rtp::details::VecBase
CRTP base class for vectors.
Definition VecBase.hpp:60