#include <Base/include/Framework/Math/Vector3.hpp>
template<typename T>
bpf::math::Vector<T, 3> class

Template parameters
T the number type

Contents

Static 3D vector class

Public static variables

static const Vector Zero
static const Vector Identity
static const Vector Right
static const Vector Up
static const Vector Forward

Public static functions

static auto Lerp(const Vector& v, const Vector& v1, const T t) -> Vector

Constructors, destructors, conversion operators

Vector(T x, T y, T z)
Vector(const Vector<T, 2>& other, const T val)
Vector()
Vector(const T val) explicit
Vector(const std::initializer_list<T>& lst)
Vector(const Vector& other)
Vector(Vector&& other) noexcept

Public functions

auto Dim() const -> fsize constexpr noexcept
auto operator()(fsize l) -> T&
auto operator()(fsize l) const -> const T&
auto operator*() const -> const T* noexcept
auto operator*() -> T* noexcept
auto operator=(const Vector& other) -> Vector&
auto operator=(Vector&& other) -> Vector& noexcept
auto operator+(const Vector& other) const -> Vector
auto operator-(const Vector& other) const -> Vector
auto operator*(const Vector& other) const -> Vector
auto operator/(const Vector& other) const -> Vector
auto operator*(const T other) const -> Vector
auto operator/(const T other) const -> Vector
void operator+=(const Vector& other)
void operator-=(const Vector& other)
void operator*=(const Vector& other)
void operator/=(const Vector& other)
void operator*=(const T other)
void operator/=(const T other)
auto operator-() const -> Vector
auto Dot(const Vector& other) const -> T
auto Distance(const Vector& other) const -> T
auto DistanceSquared(const Vector& other) const -> T
auto Norm() const -> T
auto NormSquared() const -> T
auto Normalize() const -> Vector
auto Cross(const Vector& other) const -> Vector
auto operator==(const Vector& other) const -> bool
auto operator!=(const Vector& other) const -> bool
auto operator<(const Vector& other) const -> bool
auto operator>(const Vector& other) const -> bool
auto operator<=(const Vector& other) const -> bool
auto operator>=(const Vector& other) const -> bool

Public variables

T X
T Y
T Z

Function documentation

template<typename T>
static Vector bpf::math::Vector<T, 3><T>::Lerp(const Vector& v, const Vector& v1, const T t)

Parameters
v first vector
v1 second vector
t interpolation factor
Returns new interpolated vector

Performs linear interpolation

template<typename T>
bpf::math::Vector<T, 3><T>::Vector(T x, T y, T z)

Parameters
x coordinate
y coordinate
z coordinate

Constructs a vector by individual coordinates

template<typename T>
bpf::math::Vector<T, 3><T>::Vector(const Vector<T, 2>& other, const T val)

Parameters
other the lower dimension vector
val the additional scalar

Constructs a vector by extension of a lower-dimension vector

template<typename T>
bpf::math::Vector<T, 3><T>::Vector()

Constructs a empty vector

template<typename T>
bpf::math::Vector<T, 3><T>::Vector(const T val) explicit

Parameters
val number to copy from

Constructs a vector from a scalar

template<typename T>
bpf::math::Vector<T, 3><T>::Vector(const std::initializer_list<T>& lst)

Parameters
lst the list to copy values from

Constructs a vector from an initializer list

template<typename T>
bpf::math::Vector<T, 3><T>::Vector(const Vector& other)

Copy constructor

template<typename T>
bpf::math::Vector<T, 3><T>::Vector(Vector&& other) noexcept

Move constructor

template<typename T>
fsize bpf::math::Vector<T, 3><T>::Dim() const constexpr noexcept

Returns unsigned constant expression

Returns the dimension of this vector

template<typename T>
T& bpf::math::Vector<T, 3><T>::operator()(fsize l)

Parameters
l the row number
Returns mutable cell value
Exceptions
IndexException if out of bounds

Obtains the value of a cell for modification

template<typename T>
const T& bpf::math::Vector<T, 3><T>::operator()(fsize l) const

Parameters
l the row number
Returns immutable cell value
Exceptions
IndexException if out of bounds

Obtains the value of a cell for reading

template<typename T>
const T* bpf::math::Vector<T, 3><T>::operator*() const noexcept

Returns immutable low-level C array

Returns a low-level C array, used to transfer to lower-level APIs

template<typename T>
T* bpf::math::Vector<T, 3><T>::operator*() noexcept

Returns mutable low-level C array

Returns a low-level C array, used to transfer to lower-level APIs

template<typename T>
Vector& bpf::math::Vector<T, 3><T>::operator=(const Vector& other)

Copy assignment operator

template<typename T>
Vector& bpf::math::Vector<T, 3><T>::operator=(Vector&& other) noexcept

Move assignment operator

template<typename T>
Vector bpf::math::Vector<T, 3><T>::operator+(const Vector& other) const

Parameters
other operand
Returns new vector

Performs element-wise addition

template<typename T>
Vector bpf::math::Vector<T, 3><T>::operator-(const Vector& other) const

Parameters
other operand
Returns new vector

Performs element-wise subtraction

template<typename T>
Vector bpf::math::Vector<T, 3><T>::operator*(const Vector& other) const

Parameters
other operand
Returns new vector

Performs element-wise multiplication

template<typename T>
Vector bpf::math::Vector<T, 3><T>::operator/(const Vector& other) const

Parameters
other operand
Returns new vector

Performs element-wise division

template<typename T>
Vector bpf::math::Vector<T, 3><T>::operator*(const T other) const

Parameters
other operand
Returns new vector

Performs vector-scalar multiplication

template<typename T>
Vector bpf::math::Vector<T, 3><T>::operator/(const T other) const

Parameters
other operand
Returns new vector

Performs vector-scalar division

template<typename T>
void bpf::math::Vector<T, 3><T>::operator+=(const Vector& other)

Parameters
other operand

Performs element-wise addition

template<typename T>
void bpf::math::Vector<T, 3><T>::operator-=(const Vector& other)

Parameters
other operand

Performs element-wise subtraction

template<typename T>
void bpf::math::Vector<T, 3><T>::operator*=(const Vector& other)

Parameters
other operand

Performs element-wise multiplication

template<typename T>
void bpf::math::Vector<T, 3><T>::operator/=(const Vector& other)

Parameters
other operand

Performs element-wise division

template<typename T>
void bpf::math::Vector<T, 3><T>::operator*=(const T other)

Parameters
other operand

Performs vector-scalar multiplication

template<typename T>
void bpf::math::Vector<T, 3><T>::operator/=(const T other)

Parameters
other operand

Performs vector-scalar division

template<typename T>
Vector bpf::math::Vector<T, 3><T>::operator-() const

Returns negated vector

Negates this vector

template<typename T>
T bpf::math::Vector<T, 3><T>::Dot(const Vector& other) const

Parameters
other operand
Returns number

Computes the dot product

template<typename T>
T bpf::math::Vector<T, 3><T>::Distance(const Vector& other) const

Parameters
other operand
Returns number

Computes the distance between two vectors

template<typename T>
T bpf::math::Vector<T, 3><T>::DistanceSquared(const Vector& other) const

Parameters
other operand
Returns number

Computes the squared distance between two vectors

template<typename T>
T bpf::math::Vector<T, 3><T>::Norm() const

Returns number

Computes the norm of this vector

template<typename T>
T bpf::math::Vector<T, 3><T>::NormSquared() const

Returns number

Computes the squared norm of this vector

template<typename T>
Vector bpf::math::Vector<T, 3><T>::Normalize() const

Returns normalized vector

Normalizes this vector (by dividing each component by Norm())

template<typename T>
Vector bpf::math::Vector<T, 3><T>::Cross(const Vector& other) const

Parameters
other operand
Returns new vector

Performs cross product

template<typename T>
bool bpf::math::Vector<T, 3><T>::operator==(const Vector& other) const

Parameters
other vector to compare with
Returns true if the two vectors are equal, false otherwise

Compare two vectors

template<typename T>
bool bpf::math::Vector<T, 3><T>::operator!=(const Vector& other) const

Parameters
other vector to compare with
Returns false if the two vectors are equal, true otherwise

Compare two vectors

template<typename T>
bool bpf::math::Vector<T, 3><T>::operator<(const Vector& other) const

Parameters
other vector to compare with
Returns true if this is less than other, false otherwise

Compare two vectors

template<typename T>
bool bpf::math::Vector<T, 3><T>::operator>(const Vector& other) const

Parameters
other vector to compare with
Returns true if this is greater than other, false otherwise

Compare two vectors

template<typename T>
bool bpf::math::Vector<T, 3><T>::operator<=(const Vector& other) const

Parameters
other vector to compare with
Returns true if this is less than or equal to, false otherwise

Compare two vectors

template<typename T>
bool bpf::math::Vector<T, 3><T>::operator>=(const Vector& other) const

Parameters
other vector to compare with
Returns true if this is greater than or equal to other, false otherwise

Compare two vectors

Variable documentation

template<typename T>
static const Vector bpf::math::Vector<T, 3><T>::Zero

Zero vector constant

template<typename T>
static const Vector bpf::math::Vector<T, 3><T>::Identity

Identity vector constant (1, 1, 1)

template<typename T>
static const Vector bpf::math::Vector<T, 3><T>::Right

Right vector constant

template<typename T>
static const Vector bpf::math::Vector<T, 3><T>::Up

Up vector constant

template<typename T>
static const Vector bpf::math::Vector<T, 3><T>::Forward

Forward vector constant

template<typename T>
T bpf::math::Vector<T, 3><T>::X

X coordinate

template<typename T>
T bpf::math::Vector<T, 3><T>::Y

Y coordinate

template<typename T>
T bpf::math::Vector<T, 3><T>::Z

Z coordinate