A 3D vector in space. More...

#include <geometry.h>

Public Types
using	Real = std::conditional_t<std::is_floating_point_v<T>, T, float>
	Type used for lengths and angles. Integer vectors use float so results are not truncated.

Public Member Functions
	Vec3 ()=default
	Default constructor for the Vec3 class.

	Vec3 (T x, T y, T z)
	Constructor for the Vec3 class.

Real	angle (const Vec3 &other) const
	Get angle between two vectors (in 3D space).

Real	distance (const Vec3 &other) const
	Get distance between two vectors.

T	dot (const Vec3 &other) const
	Calculate the dot product of two vectors.

Vec3	cross (const Vec3 &other) const
	Calculate the cross product of two vectors.

Real	magnitude () const
	Calculate the magnitude of the vector.

Vec3	operator+ (const Vec3 &other) const
	Addition operator for the Vec3 class.

Vec3	operator- (const Vec3 &other) const
	Subtraction operator for the Vec3 class.

Vec3	operator* (const T scalar) const
	Multiplication operator for the Vec3 class.

Vec3	operator/ (const T scalar) const
	Division operator for the Vec3 class.

Vec3	operator% (const T scalar) const
	Modulo the Vec3 object by a scalar.

Vec3 &	operator+= (const Vec3 &other)
	Addition assignment operator for the Vec3 class.

Vec3 &	operator-= (const Vec3 &other)
	Subtraction assignment operator for the Vec3 class.

Vec3 &	operator*= (const T scalar)
	Multiplication assignment operator for the Vec3 class.

Vec3 &	operator/= (const T scalar)
	Division assignment operator for the Vec3 class.

Vec3 &	operator%= (const T scalar)
	Modulo assignment operator for the Vec3 class.

bool	operator== (const Vec3 &other) const =default
	Equality operator for the Vec3 class.

Public Attributes
T	x { 0 }
	The x component of the vector.

T	y { 0 }
	The y component of the vector.

T	z { 0 }
	The z component of the vector.

Detailed Description

template<typename T>
class asw::Vec3< T >

A 3D vector in space.

This class represents a 3D vector in space. It is used to represent points, directions, and sizes.

Definition at line 288 of file geometry.h.

Member Typedef Documentation

◆ Real

template<typename T >

using asw::Vec3< T >::Real = std::conditional_t<std::is_floating_point_v<T>, T, float>

Type used for lengths and angles. Integer vectors use float so results are not truncated.

Definition at line 292 of file geometry.h.

Constructor & Destructor Documentation

◆ Vec3() [1/2]

template<typename T >

asw::Vec3< T >::Vec3 ( )

default

Default constructor for the Vec3 class.

◆ Vec3() [2/2]

template<typename T >

asw::Vec3< T >::Vec3	(	T	x,
		T	y,
		T	z )

inline

Constructor for the Vec3 class.

Parameters

x	The x component of the vector.
y	The y component of the vector.
z	The z component of the vector.

Definition at line 304 of file geometry.h.

Member Function Documentation

◆ angle()

template<typename T >

Real asw::Vec3< T >::angle ( const Vec3< T > & other ) const

inline

Get angle between two vectors (in 3D space).

Returns: The angle of the vector in radians.

Definition at line 315 of file geometry.h.

◆ cross()

template<typename T >

Vec3 asw::Vec3< T >::cross ( const Vec3< T > & other ) const

inline

Calculate the cross product of two vectors.

Parameters

other The vector to cross with.

Returns: Vec3 The cross product of the vectors.

Definition at line 352 of file geometry.h.

◆ distance()

template<typename T >

Real asw::Vec3< T >::distance ( const Vec3< T > & other ) const

inline

Get distance between two vectors.

Returns: The distance between the vectors.

Definition at line 331 of file geometry.h.

◆ dot()

template<typename T >

T asw::Vec3< T >::dot ( const Vec3< T > & other ) const

inline

Calculate the dot product of two vectors.

Parameters

other The vector to dot with.

Returns: T The dot product of the vectors.

Definition at line 342 of file geometry.h.

◆ magnitude()

template<typename T >

Real asw::Vec3< T >::magnitude ( ) const

inline

Calculate the magnitude of the vector.

Returns: The magnitude of the vector.

Definition at line 362 of file geometry.h.

◆ operator%()

template<typename T >

Vec3 asw::Vec3< T >::operator% ( const T scalar ) const

inline

Modulo the Vec3 object by a scalar.

Parameters

scalar The scalar to modulo by

Returns: Vec3 The result of the modulo

Definition at line 412 of file geometry.h.

◆ operator%=()

template<typename T >

Vec3 & asw::Vec3< T >::operator%= ( const T scalar )

inline

Modulo assignment operator for the Vec3 class.

Parameters

scalar The scalar to modulo by.

Returns: Vec3& The result of the modulo operation.

Definition at line 474 of file geometry.h.

◆ operator*()

template<typename T >

Vec3 asw::Vec3< T >::operator* ( const T scalar ) const

inline

Multiplication operator for the Vec3 class.

Parameters

scalar The scalar to multiply by.

Returns: Vec3 The scaled vector.

Definition at line 392 of file geometry.h.

◆ operator*=()

template<typename T >

Vec3 & asw::Vec3< T >::operator*= ( const T scalar )

inline

Multiplication assignment operator for the Vec3 class.

Parameters

scalar The scalar to multiply by.

Returns: Vec3& The scaled vector.

Definition at line 448 of file geometry.h.

◆ operator+()

template<typename T >

Vec3 asw::Vec3< T >::operator+ ( const Vec3< T > & other ) const

inline

Addition operator for the Vec3 class.

Parameters

other The vector to add.

Returns: Vec3 The sum of the vectors.

Definition at line 372 of file geometry.h.

◆ operator+=()

template<typename T >

Vec3 & asw::Vec3< T >::operator+= ( const Vec3< T > & other )

inline

Addition assignment operator for the Vec3 class.

Parameters

other The vector to add.

Returns: Vec3& The sum of the vectors.

Definition at line 422 of file geometry.h.

◆ operator-()

template<typename T >

Vec3 asw::Vec3< T >::operator- ( const Vec3< T > & other ) const

inline

Subtraction operator for the Vec3 class.

Parameters

other The vector to subtract.

Returns: Vec3 The difference of the vectors.

Definition at line 382 of file geometry.h.

◆ operator-=()

template<typename T >

Vec3 & asw::Vec3< T >::operator-= ( const Vec3< T > & other )

inline

Subtraction assignment operator for the Vec3 class.

Parameters

other The vector to subtract.

Returns: Vec3& The difference of the vectors.

Definition at line 435 of file geometry.h.

◆ operator/()

template<typename T >

Vec3 asw::Vec3< T >::operator/ ( const T scalar ) const

inline

Division operator for the Vec3 class.

Parameters

scalar The scalar to divide by.

Returns: Vec3 The scaled vector.

Definition at line 402 of file geometry.h.

◆ operator/=()

template<typename T >

Vec3 & asw::Vec3< T >::operator/= ( const T scalar )

inline

Division assignment operator for the Vec3 class.

Parameters

scalar The scalar to divide by.

Returns: Vec3& The scaled vector.

Definition at line 461 of file geometry.h.

◆ operator==()

template<typename T >

bool asw::Vec3< T >::operator== ( const Vec3< T > & other ) const

default

Equality operator for the Vec3 class.

Parameters

other The vector to compare.

Returns: bool True if the vectors are equal.

Member Data Documentation

◆ x

template<typename T >

T asw::Vec3< T >::x { 0 }

The x component of the vector.

Definition at line 490 of file geometry.h.

◆ y

template<typename T >

T asw::Vec3< T >::y { 0 }

The y component of the vector.

Definition at line 493 of file geometry.h.

◆ z

template<typename T >

T asw::Vec3< T >::z { 0 }

The z component of the vector.

Definition at line 496 of file geometry.h.

The documentation for this class was generated from the following file:

include/asw/modules/geometry.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ Real

Constructor & Destructor Documentation

◆ Vec3() [1/2]

◆ Vec3() [2/2]

Member Function Documentation

◆ angle()

◆ cross()

◆ distance()

◆ dot()

◆ magnitude()

◆ operator%()

◆ operator%=()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator==()

Member Data Documentation

◆ x

◆ y

◆ z