A 3-component vector class. More...

#include <Vec3.h>

Public Types
using	ComponentType = Type

Public Member Functions
	XII_DECLARE_POD_TYPE ()

	xiiVec3Template ()
	default-constructed vector is uninitialized (for speed)

	xiiVec3Template (Type x, Type y, Type z)
	Initializes the vector with x,y,z.

	xiiVec3Template (Type v)
	Initializes all 3 components with xyz.

const xiiVec2Template< Type >	GetAsVec2 () const
	Returns a xiiVec2Template with x and y from this vector.

const xiiVec4Template< Type >	GetAsVec4 (Type w) const
	Returns a xiiVec4Template with x,y,z from this vector and w set to the parameter.

const xiiVec4Template< Type >	GetAsPositionVec4 () const
	Returns a xiiVec4Template with x,y,z from this vector and w set 1.

const xiiVec4Template< Type >	GetAsDirectionVec4 () const
	Returns a xiiVec4Template with x,y,z from this vector and w set 0.

const Type *	GetData () const
	Returns the data as an array.

Type *	GetData ()
	Returns the data as an array.

void	Set (Type xyz)
	Sets all 3 components to this value.

void	Set (Type x, Type y, Type z)
	Sets the vector to these values.

void	SetZero ()
	Sets the vector to all zero.

XII_DECLARE_IF_FLOAT_TYPE Type	GetLength () const
	Returns the length of the vector.

XII_DECLARE_IF_FLOAT_TYPE xiiResult	SetLength (Type fNewLength, Type fEpsilon=xiiMath::DefaultEpsilon< Type >())
	Tries to rescale the vector to the given length. If the vector is too close to zero, XII_FAILURE is returned and the vector is set to zero.

Type	GetLengthSquared () const
	Returns the squared length. Faster, since no square-root is taken. Useful, if one only wants to compare the lengths of two vectors.

XII_DECLARE_IF_FLOAT_TYPE Type	GetLengthAndNormalize ()
	Normalizes this vector and returns its previous length in one operation. More efficient than calling GetLength and then Normalize.

XII_DECLARE_IF_FLOAT_TYPE const xiiVec3Template< Type >	GetNormalized () const
	Returns a normalized version of this vector, leaves the vector itself unchanged.

XII_DECLARE_IF_FLOAT_TYPE void	Normalize ()
	Normalizes this vector.

XII_DECLARE_IF_FLOAT_TYPE xiiResult	NormalizeIfNotZero (const xiiVec3Template< Type > &vFallback=xiiVec3Template< Type >(1, 0, 0), Type fEpsilon=xiiMath::SmallEpsilon< Type >())
	Tries to normalize this vector. If the vector is too close to zero, XII_FAILURE is returned and the vector is set to the given fallback value.

bool	IsZero () const
	Returns, whether this vector is (0, 0, 0).

bool	IsZero (Type fEpsilon) const
	Returns, whether this vector is (0, 0, 0) within a given epsilon.

XII_DECLARE_IF_FLOAT_TYPE bool	IsNormalized (Type fEpsilon=xiiMath::HugeEpsilon< Type >()) const
	Returns, whether the squared length of this vector is between 0.999f and 1.001f.

bool	IsNaN () const
	Returns true, if any of x, y or z is NaN.

bool	IsValid () const
	Checks that all components are finite numbers.

XII_DECLARE_IF_FLOAT_TYPE Type	Distance (const xiiVec3Template< Type > &vPoint) const
	Returns the distance between two 3D Vectors.

Type	DistanceSquared (const xiiVec3Template< Type > &vPoint) const
	Returns the squared distance between two 3D Vectors. Faster, since no square-root is taken. Useful, if one only wants to compare the distance of two vectors regardless of the magnitude.

const xiiVec3Template< Type >	operator- () const
	Returns the negation of this vector.

void	operator+= (const xiiVec3Template< Type > &rhs)
	Adds rhs component-wise to this vector.

void	operator-= (const xiiVec3Template< Type > &rhs)
	Subtracts rhs component-wise from this vector.

void	operator*= (const xiiVec3Template< Type > &rhs)
	Multiplies rhs component-wise to this vector.

void	operator/= (const xiiVec3Template< Type > &rhs)
	Divides this vector component-wise by rhs.

void	*operator=** (Type f)
	Multiplies all components of this vector with f.

void	operator/= (Type f)
	Divides all components of this vector by f.

bool	IsIdentical (const xiiVec3Template< Type > &rhs) const
	Equality Check (bitwise)

bool	IsEqual (const xiiVec3Template< Type > &rhs, Type fEpsilon) const
	Equality Check with epsilon.

xiiAngle	GetAngleBetween (const xiiVec3Template< Type > &rhs) const
	Returns the positive angle between *this and rhs. Both this and rhs must be normalized.

Type	Dot (const xiiVec3Template< Type > &rhs) const
	Returns the Dot-product of the two vectors (commutative, order does not matter)

const xiiVec3Template< Type >	CrossRH (const xiiVec3Template< Type > &rhs) const
	Returns the Cross-product of the two vectors (NOT commutative, order DOES matter)

const xiiVec3Template< Type >	CompMin (const xiiVec3Template< Type > &rhs) const
	Returns the component-wise minimum of *this and rhs.

const xiiVec3Template< Type >	CompMax (const xiiVec3Template< Type > &rhs) const
	Returns the component-wise maximum of *this and rhs.

const xiiVec3Template< Type >	CompClamp (const xiiVec3Template< Type > &vLow, const xiiVec3Template< Type > &vHigh) const
	Returns the component-wise clamped value of *this between low and high.

const xiiVec3Template< Type >	CompMul (const xiiVec3Template< Type > &rhs) const
	Returns the component-wise multiplication of *this and rhs.

const xiiVec3Template< Type >	CompDiv (const xiiVec3Template< Type > &rhs) const
	Returns the component-wise division of *this and rhs.

const xiiVec3Template< Type >	Abs () const
	brief Returns the component-wise absolute of *this.

XII_DECLARE_IF_FLOAT_TYPE xiiResult	CalculateNormal (const xiiVec3Template< Type > &v1, const xiiVec3Template< Type > &v2, const xiiVec3Template< Type > &v3)
	Calculates the normal of the triangle defined by the three vertices. Vertices are assumed to be ordered counter-clockwise.

XII_DECLARE_IF_FLOAT_TYPE void	MakeOrthogonalTo (const xiiVec3Template< Type > &vNormal)
	Modifies this direction vector to be orthogonal to the given (normalized) direction vector. The result is NOT normalized.

XII_DECLARE_IF_FLOAT_TYPE const xiiVec3Template< Type >	GetOrthogonalVector () const
	Returns some arbitrary vector orthogonal to this one. The vector is NOT normalized.

XII_DECLARE_IF_FLOAT_TYPE const xiiVec3Template< Type >	GetReflectedVector (const xiiVec3Template< Type > &vNormal) const
	Returns this vector reflected at vNormal.

XII_DECLARE_IF_FLOAT_TYPE const xiiVec3Template< Type >	GetRefractedVector (const xiiVec3Template< Type > &vNormal, Type fRefIndex1, Type fRefIndex2) const
	Returns this vector, refracted at vNormal, using the refraction index of the current medium and the medium it enters.

Static Public Member Functions
static XII_DECLARE_IF_FLOAT_TYPE xiiVec3Template< Type >	MakeNaN ()
	Returns a vector with all components set to Not-a-Number (NaN).

static xiiVec3Template< Type >	MakeZero ()
	Returns a vector with all components set to zero.

static xiiVec3Template< Type >	MakeAxisX ()
	Returns a vector initialized to the X unit vector (1, 0, 0).

static xiiVec3Template< Type >	MakeAxisY ()
	Returns a vector initialized to the Y unit vector (0, 1, 0).

static xiiVec3Template< Type >	MakeAxisZ ()
	Returns a vector initialized to the Z unit vector (0, 0, 1).

static xiiVec3Template< Type >	Make (Type x, Type y, Type z)
	Returns a vector initialized to x,y,z.

static XII_DECLARE_IF_FLOAT_TYPE xiiVec3Template< Type >	MakeRandomPointInSphere (xiiRandom &inout_rng)
	Returns a random point inside a unit sphere (radius 1).

static XII_DECLARE_IF_FLOAT_TYPE xiiVec3Template< Type >	MakeRandomDirection (xiiRandom &inout_rng)
	Creates a random direction vector. The vector is normalized.

static XII_DECLARE_IF_FLOAT_TYPE xiiVec3Template< Type >	MakeRandomDeviationX (xiiRandom &inout_rng, const xiiAngle &maxDeviation)
	Creates a random vector around the x axis with a maximum deviation angle of maxDeviation. The vector is normalized. The deviation angle must be larger than zero.

static XII_DECLARE_IF_FLOAT_TYPE xiiVec3Template< Type >	MakeRandomDeviationX (xiiRandom &inout_rng, const xiiAngled &maxDeviation)
	Creates a random vector around the x axis with a maximum deviation angle of maxDeviation. The vector is normalized. The deviation angle must be larger than zero.

static XII_DECLARE_IF_FLOAT_TYPE xiiVec3Template< Type >	MakeRandomDeviationY (xiiRandom &inout_rng, const xiiAngle &maxDeviation)
	Creates a random vector around the y axis with a maximum deviation angle of maxDeviation. The vector is normalized. The deviation angle must be larger than zero.

static XII_DECLARE_IF_FLOAT_TYPE xiiVec3Template< Type >	MakeRandomDeviationY (xiiRandom &inout_rng, const xiiAngled &maxDeviation)
	Creates a random vector around the y axis with a maximum deviation angle of maxDeviation. The vector is normalized. The deviation angle must be larger than zero.

static XII_DECLARE_IF_FLOAT_TYPE xiiVec3Template< Type >	MakeRandomDeviationZ (xiiRandom &inout_rng, const xiiAngle &maxDeviation)
	Creates a random vector around the z axis with a maximum deviation angle of maxDeviation. The vector is normalized. The deviation angle must be larger than zero.

static XII_DECLARE_IF_FLOAT_TYPE xiiVec3Template< Type >	MakeRandomDeviationZ (xiiRandom &inout_rng, const xiiAngled &maxDeviation)
	Creates a random vector around the z axis with a maximum deviation angle of maxDeviation. The vector is normalized. The deviation angle must be larger than zero.

static XII_DECLARE_IF_FLOAT_TYPE xiiVec3Template< Type >	MakeRandomDeviation (xiiRandom &inout_rng, const xiiAngle &maxDeviation, const xiiVec3Template< Type > &vNormal)
	Creates a random vector around the given normal with a maximum deviation.

static XII_DECLARE_IF_FLOAT_TYPE xiiVec3Template< Type >	MakeRandomDeviation (xiiRandom &inout_rng, const xiiAngled &maxDeviation, const xiiVec3Template< Type > &vNormal)
	Creates a random vector around the given normal with a maximum deviation.

Public Attributes
Type	x

Type	y

Type	z

Detailed Description

template<typename Type>
class xiiVec3Template< Type >

A 3-component vector class.

Member Function Documentation

◆ IsNormalized()

template<typename Type>

XII_IMPLEMENT_IF_FLOAT_TYPE XII_FORCE_INLINE bool xiiVec3Template< Type >::IsNormalized ( Type fEpsilon = xiiMath::HugeEpsilon<Type>() ) const

Returns, whether the squared length of this vector is between 0.999f and 1.001f.

Note: Normalization, especially with SSE is not very precise. So this function checks whether the (squared) length is between a lower and upper limit.

◆ MakeOrthogonalTo()

template<typename Type>

XII_IMPLEMENT_IF_FLOAT_TYPE void xiiVec3Template< Type >::MakeOrthogonalTo ( const xiiVec3Template< Type > & vNormal )

Modifies this direction vector to be orthogonal to the given (normalized) direction vector. The result is NOT normalized.

Note: This function may fail, e.g. create a vector that is zero, if the given normal is parallel to the vector itself. If you need to handle such cases, you should manually check afterwards, whether the result is zero, or cannot be normalized.

◆ MakeRandomDeviation() [1/2]

template<typename Type>

XII_IMPLEMENT_IF_FLOAT_TYPE xiiVec3Template< Type > xiiVec3Template< Type >::MakeRandomDeviation	(	xiiRandom &	inout_rng,
		const xiiAngle &	maxDeviation,
		const xiiVec3Template< Type > &	vNormal )

staticnodiscard

Creates a random vector around the given normal with a maximum deviation.

Note: If you are going to do this many times with the same axis, rather than calling this function, instead manually do what this function does (see inline code) and only compute the quaternion once.

◆ MakeRandomDeviation() [2/2]

template<typename Type>

XII_IMPLEMENT_IF_FLOAT_TYPE xiiVec3Template< Type > xiiVec3Template< Type >::MakeRandomDeviation	(	xiiRandom &	inout_rng,
		const xiiAngled &	maxDeviation,
		const xiiVec3Template< Type > &	vNormal )

staticnodiscard

Creates a random vector around the given normal with a maximum deviation.

Note: If you are going to do this many times with the same axis, rather than calling this function, instead manually do what this function does (see inline code) and only compute the quaternion once.

◆ operator*=()

template<typename Type>

XII_FORCE_INLINE void xiiVec3Template< Type >::operator*= ( const xiiVec3Template< Type > & rhs )

Multiplies rhs component-wise to this vector.

Test: this is new

◆ operator/=()

template<typename Type>

XII_FORCE_INLINE void xiiVec3Template< Type >::operator/= ( const xiiVec3Template< Type > & rhs )

Divides this vector component-wise by rhs.

Test: this is new

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

/home/runner/work/XII/XII/Source/Engine/Foundation/Math/Declarations.h
/home/runner/work/XII/XII/Source/Engine/Foundation/Math/Vec3.h
/home/runner/work/XII/XII/Source/Engine/Foundation/Math/Implementation/AllClassesRandom_inl.h
/home/runner/work/XII/XII/Source/Engine/Foundation/Math/Implementation/Vec3_inl.h
/home/runner/work/XII/XII/Source/Engine/Foundation/Math/Implementation/Vec4_inl.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ IsNormalized()

◆ MakeOrthogonalTo()

◆ MakeRandomDeviation() [1/2]

◆ MakeRandomDeviation() [2/2]

◆ operator*=()

◆ operator/=()