T Generic x, y, z, w vector. More...

#include <gz/math/Vector4.hh>

Public Member Functions
constexpr	Vector4 ()
	Constructor.

constexpr	Vector4 (const T &_x, const T &_y, const T &_z, const T &_w)
	Constructor with component values.

Vector4	Abs () const
	Get the absolute value of the vector.

T	AbsDot (const Vector4< T > &_v) const
	Return the absolute dot product of this vector and another vector. This is similar to the Dot function, except the absolute value of each component of the vector is used.

void	Correct ()
	Corrects any nan values.

T	Distance (const Vector4< T > &_pt) const
	Calc distance to the given point.

T	Distance (T _x, T _y, T _z, T _w) const
	Calc distance to the given point.

T	Dot (const Vector4< T > &_v) const
	Return the dot product of this vector and another vector.

bool	Equal (const Vector4 &_v, const T &_tol) const
	Equality test with tolerance.

bool	IsFinite () const
	See if a point is finite (e.g., not nan)

T	Length () const
	Returns the length (magnitude) of the vector.

T	Max () const
	Get the maximum value in the vector.

void	Max (const Vector4< T > &_v)
	Set this vector's components to the maximum of itself and the passed in vector.

T	Min () const
	Get the minimum value in the vector.

void	Min (const Vector4< T > &_v)
	Set this vector's components to the minimum of itself and the passed in vector.

void	Normalize ()
	Normalize the vector length.

Vector4	Normalized () const
	Return a normalized vector.

bool	operator!= (const Vector4< T > &_pt) const
	Not equal to operator.

const Vector4< T >	operator* (const Matrix4< T > &_m) const
	Matrix multiplication operator.

const Vector4< T >	operator* (const Vector4< T > &_pt) const
	Multiplication operator.

const Vector4< T >	operator* (T _v) const
	Multiplication operators.

const Vector4< T > &	operator*= (const Vector4< T > &_pt)
	Multiplication assignment operator.

const Vector4< T > &	operator*= (T _v)
	Multiplication assignment operator.

Vector4< T >	operator+ (const T _s) const
	Addition operators.

Vector4< T >	operator+ (const Vector4< T > &_v) const
	Addition operator.

const Vector4< T > &	operator+= (const T _s)
	Addition assignment operator.

const Vector4< T > &	operator+= (const Vector4< T > &_v)
	Addition operator.

Vector4	operator- () const
	Negation operator.

Vector4< T >	operator- (const T _s) const
	Subtraction operators.

Vector4< T >	operator- (const Vector4< T > &_v) const
	Subtraction operator.

const Vector4< T > &	operator-= (const T _s)
	Subtraction assignment operator.

const Vector4< T > &	operator-= (const Vector4< T > &_v)
	Subtraction assigment operators.

const Vector4< T >	operator/ (const Vector4< T > &_v) const
	Division assignment operator.

const Vector4< T >	operator/ (T _v) const
	Division assignment operator.

const Vector4< T > &	operator/= (const Vector4< T > &_v)
	Division assignment operator.

const Vector4< T > &	operator/= (T _v)
	Division operator.

bool	operator< (const Vector4< T > &_pt) const
	Less than operator.

Vector4< T > &	operator= (T _value)
	Assignment operator.

bool	operator== (const Vector4< T > &_v) const
	Equal to operator.

T &	operator[] (const std::size_t _index)
	Array subscript operator.

T	operator[] (const std::size_t _index) const
	Const-qualified array subscript operator.

void	Round ()
	Round to near whole number.

Vector4	Rounded () const
	Get a rounded version of this vector.

void	Set (T _x=0, T _y=0, T _z=0, T _w=0)
	Set the contents of the vector.

T	SquaredLength () const
	Return the square of the length (magnitude) of the vector.

T	Sum () const
	Return the sum of the values.

T &	W ()
	Return a mutable w value.

T	W () const
	Get the w value.

void	W (const T &_v)
	Set the w value.

T &	X ()
	Return a mutable x value.

T	X () const
	Get the x value.

void	X (const T &_v)
	Set the x value.

T &	Y ()
	Return a mutable y value.

T	Y () const
	Get the y value.

void	Y (const T &_v)
	Set the y value.

T &	Z ()
	Return a mutable z value.

T	Z () const
	Get the z value.

void	Z (const T &_v)
	Set the z value.

Static Public Attributes
static const Vector4 &	NaN = detail::gVector4NaN<T>
	math::Vector4(NaN, NaN, NaN, NaN)

static const Vector4< T > &	One = detail::gVector4One<T>
	math::Vector4(1, 1, 1, 1)

static const Vector4< T > &	Zero = detail::gVector4Zero<T>
	math::Vector4(0, 0, 0, 0)

Detailed Description

template<typename T>
class gz::math::Vector4< T >

T Generic x, y, z, w vector.

Constructor & Destructor Documentation

◆ Vector4() [1/2]

template<typename T >

constexpr Vector4 ( )

inlineconstexpr

Constructor.

Referenced by Vector4< T >::Abs(), Vector4< T >::Distance(), and Vector4< T >::operator-().

◆ Vector4() [2/2]

template<typename T >

constexpr Vector4	(	const T &	_x,
		const T &	_y,
		const T &	_z,
		const T &	_w
	)

inlineconstexpr

Constructor with component values.

Parameters

[in]	_x	value along x axis
[in]	_y	value along y axis
[in]	_z	value along z axis
[in]	_w	value along w axis

Member Function Documentation

◆ Abs()

template<typename T >

Vector4 Abs ( ) const

inline

Get the absolute value of the vector.

Returns: a vector with positive elements

References Vector4< T >::Vector4().

◆ AbsDot()

template<typename T >

T AbsDot ( const Vector4< T > & _v ) const

inline

Return the absolute dot product of this vector and another vector. This is similar to the Dot function, except the absolute value of each component of the vector is used.

result = abs(x1 * x2) + abs(y1 * y2) + abs(z1 * z2) + abs(w1 * w2)

Parameters

[in] _v the vector

Returns: The absolute dot product

◆ Correct()

template<typename T >

void Correct ( )

inline

Corrects any nan values.

References std::isfinite().

◆ Distance() [1/2]

template<typename T >

T Distance ( const Vector4< T > & _pt ) const

inline

Calc distance to the given point.

Parameters

[in] _pt the point

Returns: the distance

Referenced by Vector4< T >::Distance().

◆ Distance() [2/2]

template<typename T >

T Distance	(	T	_x,
		T	_y,
		T	_z,
		T	_w
	)		const

inline

Calc distance to the given point.

Parameters

[in]	_x	value along x
[in]	_y	value along y
[in]	_z	value along z
[in]	_w	value along w

Returns: the distance

References Vector4< T >::Vector4(), and Vector4< T >::Distance().

◆ Dot()

template<typename T >

T Dot ( const Vector4< T > & _v ) const

inline

Return the dot product of this vector and another vector.

Parameters

[in] _v the vector

Returns: the dot product

◆ Equal()

template<typename T >

bool Equal	(	const Vector4< T > &	_v,
		const T &	_tol
	)		const

inline

Equality test with tolerance.

Parameters

[in]	_v	the vector to compare to
[in]	_tol	equality tolerance.

Returns: true if the elements of the vectors are equal within the tolerence specified by _tol.

Referenced by Vector4< T >::operator==().

◆ IsFinite()

template<typename T >

bool IsFinite ( ) const

inline

See if a point is finite (e.g., not nan)

Returns: true if finite, false otherwise

References std::isfinite().

◆ Length()

template<typename T >

T Length ( ) const

inline

Returns the length (magnitude) of the vector.

Returns: The length

References Vector4< T >::SquaredLength().

Referenced by Vector4< T >::Normalize().

◆ Max() [1/2]

template<typename T >

T Max ( ) const

inline

Get the maximum value in the vector.

Returns: the maximum element

References std::max_element().

◆ Max() [2/2]

template<typename T >

void Max ( const Vector4< T > & _v )

inline

Set this vector's components to the maximum of itself and the passed in vector.

Parameters

[in] _v the maximum clamping vector

References std::max().

◆ Min() [1/2]

template<typename T >

T Min ( ) const

inline

Get the minimum value in the vector.

Returns: the minimum element

References std::min_element().

◆ Min() [2/2]

template<typename T >

void Min ( const Vector4< T > & _v )

inline

Set this vector's components to the minimum of itself and the passed in vector.

Parameters

[in] _v the minimum clamping vector

References std::min().

◆ Normalize()

template<typename T >

void Normalize ( )

inline

Normalize the vector length.

References Vector4< T >::Length().

◆ Normalized()

template<typename T >

Vector4 Normalized ( ) const

inline

Return a normalized vector.

Returns: unit length vector

◆ operator!=()

template<typename T >

bool operator!= ( const Vector4< T > & _pt ) const

inline

Not equal to operator.

Parameters

[in] _pt the other vector

Returns: false if each component is equal within a default tolerence (1e-6), true otherwise

◆ operator*() [1/3]

template<typename T >

const Vector4< T > operator* ( const Matrix4< T > & _m ) const

inline

Matrix multiplication operator.

Parameters

[in] _m matrix

Returns: the vector multiplied by _m

◆ operator*() [2/3]

template<typename T >

const Vector4< T > operator* ( const Vector4< T > & _pt ) const

inline

Multiplication operator.

Remarks: Performs element wise multiplication, which has limited use.

Parameters

[in] _pt another vector

Returns: result vector

◆ operator*() [3/3]

template<typename T >

const Vector4< T > operator* ( T _v ) const

inline

Multiplication operators.

Parameters

[in] _v scaling factor

Returns: a scaled vector

◆ operator*=() [1/2]

template<typename T >

const Vector4< T > & operator*= ( const Vector4< T > & _pt )

inline

Multiplication assignment operator.

Remarks: Performs element wise multiplication, which has limited use.

Parameters

[in] _pt a vector

Returns: this

◆ operator*=() [2/2]

template<typename T >

const Vector4< T > & operator*= ( T _v )

inline

Multiplication assignment operator.

Parameters

[in] _v scaling factor

Returns: this

◆ operator+() [1/2]

template<typename T >

Vector4< T > operator+ ( const T _s ) const

inline

Addition operators.

Parameters

[in] _s the scalar addend

Returns: sum vector

◆ operator+() [2/2]

template<typename T >

Vector4< T > operator+ ( const Vector4< T > & _v ) const

inline

Addition operator.

Parameters

[in] _v the vector to add

Returns: a sum vector

◆ operator+=() [1/2]

template<typename T >

const Vector4< T > & operator+= ( const T _s )

inline

Addition assignment operator.

Parameters

[in] _s scalar addend

Returns: this

◆ operator+=() [2/2]

template<typename T >

const Vector4< T > & operator+= ( const Vector4< T > & _v )

inline

Addition operator.

Parameters

[in] _v the vector to add

Returns: this vector

◆ operator-() [1/3]

template<typename T >

Vector4 operator- ( ) const

inline

Negation operator.

Returns: negative of this vector

References Vector4< T >::Vector4().

◆ operator-() [2/3]

template<typename T >

Vector4< T > operator- ( const T _s ) const

inline

Subtraction operators.

Parameters

[in] _s the scalar subtrahend

Returns: difference vector

◆ operator-() [3/3]

template<typename T >

Vector4< T > operator- ( const Vector4< T > & _v ) const

inline

Subtraction operator.

Parameters

[in] _v the vector to substract

Returns: a vector

◆ operator-=() [1/2]

template<typename T >

const Vector4< T > & operator-= ( const T _s )

inline

Subtraction assignment operator.

Parameters

[in] _s scalar subtrahend

Returns: this

◆ operator-=() [2/2]

template<typename T >

const Vector4< T > & operator-= ( const Vector4< T > & _v )

inline

Subtraction assigment operators.

Parameters

[in] _v the vector to substract

Returns: this vector

◆ operator/() [1/2]

template<typename T >

const Vector4< T > operator/ ( const Vector4< T > & _v ) const

inline

Division assignment operator.

Remarks: Performs element wise division, which has limited use.

Parameters

[in] _v the vector to perform element wise division with

Returns: a result vector

◆ operator/() [2/2]

template<typename T >

const Vector4< T > operator/ ( T _v ) const

inline

Division assignment operator.

Remarks: Performs element wise division, which has limited use.

Parameters

[in] _v another vector

Returns: a result vector

◆ operator/=() [1/2]

template<typename T >

const Vector4< T > & operator/= ( const Vector4< T > & _v )

inline

Division assignment operator.

Remarks: Performs element wise division, which has limited use.

Parameters

[in] _v the vector to perform element wise division with

Returns: this

◆ operator/=() [2/2]

template<typename T >

const Vector4< T > & operator/= ( T _v )

inline

Division operator.

Parameters

[in] _v scaling factor

Returns: a vector

◆ operator<()

template<typename T >

bool operator< ( const Vector4< T > & _pt ) const

inline

Less than operator.

Parameters

[in] _pt Vector to compare.

Returns: True if this vector's X(), Y(), Z() or W() value is less than the given vector's corresponding values.

◆ operator=()

template<typename T >

Vector4< T > & operator= ( T _value )

inline

Assignment operator.

Parameters

[in] _value

◆ operator==()

template<typename T >

bool operator== ( const Vector4< T > & _v ) const

inline

Equal to operator.

Parameters

[in] _v the other vector

Returns: true if each component is equal within a default tolerence (1e-6), false otherwise

References Vector4< T >::Equal().

◆ operator[]() [1/2]

template<typename T >

T & operator[] ( const std::size_t _index )

inline

Array subscript operator.

Parameters

[in] _index The index, where 0 == x, 1 == y, 2 == z, 3 == w. The index is clamped to the range (0,3).

Returns: The value.

References gz::math::clamp(), gz::math::GZ_THREE_SIZE_T, and gz::math::GZ_ZERO_SIZE_T.

◆ operator[]() [2/2]

template<typename T >

T operator[] ( const std::size_t _index ) const

inline

Const-qualified array subscript operator.

Parameters

[in] _index The index, where 0 == x, 1 == y, 2 == z, 3 == w. The index is clamped to the range (0,3).

Returns: The value.

References gz::math::clamp(), gz::math::GZ_THREE_SIZE_T, and gz::math::GZ_ZERO_SIZE_T.

◆ Round()

template<typename T >

void Round ( )

inline

Round to near whole number.

References std::nearbyint().

◆ Rounded()

template<typename T >

Vector4 Rounded ( ) const

inline

Get a rounded version of this vector.

Returns: a rounded vector

◆ Set()

template<typename T >

void Set	(	T	_x = `0`,
		T	_y = `0`,
		T	_z = `0`,
		T	_w = `0`
	)

inline

Set the contents of the vector.

Parameters

[in]	_x	value along x axis
[in]	_y	value along y axis
[in]	_z	value along z axis
[in]	_w	value along w axis

◆ SquaredLength()

template<typename T >

T SquaredLength ( ) const

inline

Return the square of the length (magnitude) of the vector.

Returns: the length

Referenced by Vector4< T >::Length().

◆ Sum()

template<typename T >

T Sum ( ) const

inline

Return the sum of the values.

Returns: the sum

◆ W() [1/3]

template<typename T >

T & W ( )

inline

Return a mutable w value.

Returns: The w component of the vector

◆ W() [2/3]

template<typename T >

T W ( ) const

inline

Get the w value.

Returns: The w component of the vector

◆ W() [3/3]

template<typename T >

void W ( const T & _v )

inline

Set the w value.

Parameters

[in] _v Value for the w component.

◆ X() [1/3]

template<typename T >

T & X ( )

inline

Return a mutable x value.

Returns: The x component of the vector

◆ X() [2/3]

template<typename T >

T X ( ) const

inline

Get the x value.

Returns: The x component of the vector

◆ X() [3/3]

template<typename T >

void X ( const T & _v )

inline

Set the x value.

Parameters

[in] _v Value for the x component.

◆ Y() [1/3]

template<typename T >

T & Y ( )

inline

Return a mutable y value.

Returns: The y component of the vector

◆ Y() [2/3]

template<typename T >

T Y ( ) const

inline

Get the y value.

Returns: The y component of the vector

◆ Y() [3/3]

template<typename T >

void Y ( const T & _v )

inline

Set the y value.

Parameters

[in] _v Value for the y component.

◆ Z() [1/3]

template<typename T >

T & Z ( )

inline

Return a mutable z value.

Returns: The z component of the vector

◆ Z() [2/3]

template<typename T >

T Z ( ) const

inline

Get the z value.

Returns: The z component of the vector

◆ Z() [3/3]

template<typename T >

void Z ( const T & _v )

inline

Set the z value.

Parameters

[in] _v Value for the z component.

Member Data Documentation

◆ NaN

template<typename T >

const Vector4< T > & NaN = detail::gVector4NaN<T>

static

math::Vector4(NaN, NaN, NaN, NaN)

◆ One

template<typename T >

const Vector4< T > & One = detail::gVector4One<T>

static

math::Vector4(1, 1, 1, 1)

◆ Zero

template<typename T >

const Vector4< T > & Zero = detail::gVector4Zero<T>

static

math::Vector4(0, 0, 0, 0)

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

Vector4.hh

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Vector4() [1/2]

◆ Vector4() [2/2]

Member Function Documentation

◆ Abs()

◆ AbsDot()

◆ Correct()

◆ Distance() [1/2]

◆ Distance() [2/2]

◆ Dot()

◆ Equal()

◆ IsFinite()

◆ Length()

◆ Max() [1/2]

◆ Max() [2/2]

◆ Min() [1/2]

◆ Min() [2/2]

◆ Normalize()

◆ Normalized()

◆ operator!=()

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/3]

◆ operator-() [2/3]

◆ operator-() [3/3]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator<()

◆ operator=()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Round()

◆ Rounded()

◆ Set()

◆ SquaredLength()

◆ Sum()

◆ W() [1/3]

◆ W() [2/3]

◆ W() [3/3]

◆ X() [1/3]

◆ X() [2/3]

◆ X() [3/3]

◆ Y() [1/3]

◆ Y() [2/3]

◆ Y() [3/3]

◆ Z() [1/3]

◆ Z() [2/3]

◆ Z() [3/3]

Member Data Documentation

◆ NaN

◆ One

◆ Zero