Generic 4 x 4 matrix template. More...

#include <TMatrix44.h>

Collaboration diagram for sf::TMatrix44< T >:

Classes
union	data_type
	Storage union of the 4x4 matrix as array and 4 x4 array. It is initialized as a unit-matrix. More...

Public Types
enum	EAxis : unsigned int { axisX = 0 , axisY = 1 , axisZ = 2 , axisT = 3 }
	Enumerate for identifying a matrix axis. More...

typedef T	value_type
	Type accessible when implemented.

Public Member Functions
	TMatrix44 ()=default
	Default constructor which is by default a unit-matrix.

	TMatrix44 (T m00, T m01, T m02, T m03, T m10, T m11, T m12, T m13, T m20, T m21, T m22, T m23, T m30, T m31, T m32, T m33)
	Initialization constructor for 16 single floating point values.

	TMatrix44 (std::initializer_list< T[4]> list)
	Constructor using an initializer list.

	TMatrix44 (const T[4][4])
	Initialization constructor for 4x4 floating point values.

	TMatrix44 (const T *)
	Initialization constructor for 16 floating point values.

	TMatrix44 (const TVector3D< T > &v)
	Construct from a translation vector. Construct a translation transformation from a given 3D Vector.

	TMatrix44 (T tilt, T pan, T roll)
	Constructs a matrix from rotations for each axis.

	TMatrix44 (const TMatrix44 &)
	Copy constructor.

	TMatrix44 (TMatrix44 &&) noexcept
	Move constructor.

TMatrix44 &	unit ()
	Set or resets this instance as a unit/identity matrix. A unit matrix, also known as the identity matrix, is a square matrix in which all the elements along the main diagonal (from the top-left to the bottom-right) are 1, and all other elements are 0. It acts as the multiplicative identity in matrix algebra, meaning that multiplying any matrix by the identity matrix results in the original matrix itself.

T	determinant () const
	Gets the 3x3 determinant from this instance.

TMatrix44 &	invert ()
	Inverts this matrix.

TMatrix44	inverse () const
	Gets the inverted version of this instance. Call the method invert() to do this.

TMatrix44	transposed () const
	Get a transposed matrix of this instance.

TMatrix44 &	transpose ()
	Transpose this matrix.

TMatrix44 &	assign (const T[4][4])
	Assigns the 4x4 array structure to this matrix.

TMatrix44 &	assign (const T *)
	Assigns the 16 values from the pointer to this matrix.

TMatrix44 &	transposeAssign (const T[4][4])
	Assigns the transposed 4x4 array structure to this matrix.

TMatrix44 &	operator= (const TMatrix44 &)
	Assignment operator.

TMatrix44 &	operator= (TMatrix44 &&m) noexcept
	Assignment move operator.

TMatrix44 &	operator*= (const TMatrix44 &)
	Applies passed matrix on the axes of this matrix.

TVector3D< T >	operator^ (const TVector3D< T > &) const
	Applies matrix on the passed 3D vector including the translation. Calls method transformed() on the passed 3D-vector excluding the translation.

TVector3D< T >	operator* (const TVector3D< T > &) const
	Applies matrix on the passed 3D vector including the translation. Calls method transformed() on the passed 3D vector with the translation included.

value_type *	data ()
	Gets the pointer to the array of this matrix.

const value_type *	data () const
	Gets the pointer to the array of this matrix.

	operator T* ()
	Cast operator to the pointer of type 'T'.

	operator const T * () const
	Cast operator to the pointer of type 'T'.

bool	isEqual (const TMatrix44 &m, T tol=tolerance) const
	Compares the passed matrix within the set tolerance.

bool	isRotational () const
	Determines if the matrix is a rotation matrix.

bool	operator== (const TMatrix44 &) const
	Compare equal operator using the tolerance when comparing.

bool	operator!= (const TMatrix44 &) const
	Compare unequal operator using the tolerance when comparing.

void	copyTo (T[4][4], bool column_order=false) const
	Copies the matrix to a 4x4 array in row or column order.

void	copyTo (T *, bool column_order=false) const
	Copies the matrix to a 16-element deep array in row or column order..

TMatrix44 &	setTiltPanRoll (T tilt, T pan, T roll)
	Sets/resets rotation part of the matrix according to tilt pan roll and does not touch the translation or scaling part.

void	getTiltPanRoll (T &tilt, T &pan, T &roll) const
	Translates rotation part of matrix to tilt, pan and roll values.

TMatrix44 &	rotate (T angle, const TVector3D< T > &vec, bool only=true)
	Applies rotation on the current matrix around a vector.

TMatrix44 &	rotate (T angle, T x, T y, T z, bool only=true)
	Applies rotation on the current matrix.

TMatrix44	rotated (T angle, T x, T y, T z, bool only=true) const
	Same as rotate() but only returns the changed matrix and does not affect this matrix.

TMatrix44	rotated (T angle, const TVector3D< T > &vec, bool only=true) const
	Same as rotate() but only returns the changed matrix and does not affect this matrix.

void	setPerspectiveProjection (T near_plane, T far_plane, T fov)
	Sets the projection for this matrix.

TMatrix44 &	multiply (const TMatrix44 &m)
	Multiplies this matrix with the passed one so that the given matrix is applied on the matrix axes.

TMatrix44	multiplied (const TMatrix44 &m) const
	Same as multiply() but returns the changed matrix and does not affect this matrix.

TMatrix44 &	rotate (const TMatrix44 &m)
	Multiplies this matrix only with the 3x3 part of the given matrix applying only rotation and scaling.

TMatrix44	rotated (const TMatrix44 &m) const
	Same as rotate() but returns the changed matrix and does not affect this matrix.

TVector3D< T >	transformed (const TVector3D< T > &v, bool translate) const
	Applies the matrix rotation up on a 3D-vector.

TMatrix44 &	clearTranslation ()
	Zero's or clears translation part of this instance.

TMatrix44 &	translate (const TVector3D< T > &v, bool only=true)
	Adds a translation to this instance using a 3D vector.

TMatrix44 &	translate (T x, T y, T z, bool only=true)
	Adds a translation of this instance using individual values for each axis.

TMatrix44	translated (const TVector3D< T > &v, bool only=true) const
	Same as translate() but does not change this matrix only returns the translated one.

TMatrix44	translated (T x, T y, T z, bool only=true) const
	Same as translate() but does not change this matrix only returns the translated one.

TVector3D< T >	getTranslation () const
	Gets translation part of matrix.

TMatrix44 &	setTranslation (const TVector3D< T > &v)
	Sets translation part of this matrix.

TMatrix44 &	setTranslation (T x, T y, T z)
	Sets translation part of this matrix.

TMatrix44 &	scale (T factor, bool translation=true)
	Multiplies this matrix by the given factor. Leave the matrix translation vector alone.

TMatrix44 &	scale (T x, T y, T z, bool translation=true)
	Multiplies this matrix by the given factors for x, y and z-axis. Leave the matrix translation vector alone.

TMatrix44 &	scale (TVector3D< T > factor, bool translation=true)
	Multiplies this matrix by the given factors for x, y and z-axis. Leave the matrix translation vector alone.

TVector3D< T >	getAxis (EAxis axis) const
	Gets the given axis of matrix as a 3D vector.

TMatrix44	orbit (T horizontal, T vertical) const
	Gets transformation of rotation around the local x- and y-axis of the current matrix.

TMatrix44	orientation () const
	Gets the orientation part of matrix.

void	setElement (unsigned int row, unsigned int column, T value)
	Sets the element specified by the row and column.

T	element (unsigned int row, unsigned int column) const
	Gets the element specified by the row and column.

T &	element (unsigned int row, unsigned int column)
	Gets the element reference specified by the row and column.

T &	operator() (int row, int column)
	Function operator for row column value manipulations. This is different from the element() method.

T	operator() (int row, int column) const
	Gets the element from row and column index. This is different from the element() method.

template<typename R >
void	toOpenGL (R *matrix) const
	Copies this matrix to a column-major matrix array compatible with OpenGL standard. A one-on-one copy is not possible, and a transpose of the 3x3 matrix part within is needed.

template<typename R >
std::array< R, 16 >	toOpenGL () const
	Gets a column-major matrix array buffer compatible with OpenGL standard. Essentially converts from a row-major to column-major and OpenGL compatible matrix. Useful when calling OpenGL functions glLoadMatrix[fd]() and glMultMatrix[fd]().

template<typename R >
TMatrix44 &	fromOpenGL (const R *matrix)
	Assigns a column-major matrix array compatible with the OpenGL standard. Essentially converts from an OpenGL having column-major to this row-major matrix. It assigns a transposed copy of the data to the internal storage matrix.

TQuaternion< T >	quaternion () const
	Convert the rotation matrix part to identity/unit quaternion. Calls TQuaternion::fromMatrix()

TMatrix44 &	resetOrientation ()
	Resets the orientation and leaves the translation as is.

TMatrix44 &	setOrientationXY (const TVector3D< T > &x_axis, const TVector3D< T > &y_axis, bool x_dominant=false)
	Set orientation using two vectors X and Y which spans a surface having a dominant axis. The non-dominant axis is corrected when not perpendicular to the dominant axis.

TMatrix44 &	setOrientationZY (const TVector3D< T > &z_axis, const TVector3D< T > &y_axis, bool z_dominant=false)
	Set orientation using two vectors Z and Y which spans a surface having a dominant axis. The non-dominant axis is corrected when not perpendicular to the dominant axis.

TMatrix44 &	insertGIGRotXYZ (T rx, T ry, T rz)
	Another way of applying rotation to the matrix.

std::string	toString (int digits=0) const
	Gets the string representation of the matrix formed like '({m00,m01,m02,m03},{m10,m11,m12,m13},{m20,m21,m22,m23},{m30,m31,m32,m33})'.

TMatrix44 &	fromString (const std::string &s, bool ignore_err=false) noexcept(false)
	Gets matrix values from the string representation formed like '({1,2,3,4},{11,12,13,14},{21,22,23,24},{31,32,33,34})'. Throws an exception when the string is not in the correct format.

Static Public Attributes
static constexpr auto	tolerance = TVector3D<T>::tolerance
	Tolerance for when comparing in the equal operator.

Protected Attributes
union sf::TMatrix44::data_type	_data = {1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1}

Detailed Description

template<typename T>
class sf::TMatrix44< T >

Generic 4 x 4 matrix template.

Member Typedef Documentation

◆ value_type

template<typename T >

typedef T sf::TMatrix44< T >::value_type

Type accessible when implemented.

Member Enumeration Documentation

◆ EAxis

template<typename T >

enum sf::TMatrix44::EAxis : unsigned int

Enumerate for identifying a matrix axis.

Enumerator
axisX	X-axis of the matrix.
axisY	Y-axis of the matrix.
axisZ	Z-axis of the matrix.
axisT	Translation axis of the matrix.

Constructor & Destructor Documentation

◆ TMatrix44() [1/9]

template<typename T >

sf::TMatrix44< T >::TMatrix44 ( )

default

Default constructor which is by default a unit-matrix.

◆ TMatrix44() [2/9]

template<typename T >

sf::TMatrix44< T >::TMatrix44	(	T	m00,
		T	m01,
		T	m02,
		T	m03,
		T	m10,
		T	m11,
		T	m12,
		T	m13,
		T	m20,
		T	m21,
		T	m22,
		T	m23,
		T	m30,
		T	m31,
		T	m32,
		T	m33
	)

Initialization constructor for 16 single floating point values.

◆ TMatrix44() [3/9]

template<typename T >

sf::TMatrix44< T >::TMatrix44 ( std::initializer_list< T[4]> list )

Constructor using an initializer list.

◆ TMatrix44() [4/9]

template<typename T >

sf::TMatrix44< T >::TMatrix44 ( const T [4][4] )

explicit

Initialization constructor for 4x4 floating point values.

◆ TMatrix44() [5/9]

template<typename T >

sf::TMatrix44< T >::TMatrix44 ( const T * )

explicit

Initialization constructor for 16 floating point values.

◆ TMatrix44() [6/9]

template<typename T >

sf::TMatrix44< T >::TMatrix44 ( const TVector3D< T > & v )

explicit

Construct from a translation vector. Construct a translation transformation from a given 3D Vector.

◆ TMatrix44() [7/9]

template<typename T >

sf::TMatrix44< T >::TMatrix44	(	T	tilt,
		T	pan,
		T	roll
	)

Constructs a matrix from rotations for each axis.

See also: setTiltPanRoll()

◆ TMatrix44() [8/9]

template<typename T >

sf::TMatrix44< T >::TMatrix44 ( const TMatrix44< T > & )

Copy constructor.

◆ TMatrix44() [9/9]

template<typename T >

sf::TMatrix44< T >::TMatrix44 ( TMatrix44< T > && )

noexcept

Move constructor.

Member Function Documentation

◆ assign() [1/2]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::assign ( const T * )

Assigns the 16 values from the pointer to this matrix.

Returns: This matrix.

◆ assign() [2/2]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::assign ( const T [4][4] )

Assigns the 4x4 array structure to this matrix.

Returns: This matrix.

◆ clearTranslation()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::clearTranslation ( )

Zero's or clears translation part of this instance.

◆ copyTo() [1/2]

template<typename T >

void sf::TMatrix44< T >::copyTo	(	T *	,
		bool	column_order = `false`
	)		const

Copies the matrix to a 16-element deep array in row or column order..

◆ copyTo() [2/2]

template<typename T >

void sf::TMatrix44< T >::copyTo	(	T	[4][4],
		bool	column_order = `false`
	)		const

Copies the matrix to a 4x4 array in row or column order.

◆ data() [1/2]

template<typename T >

value_type * sf::TMatrix44< T >::data ( )

Gets the pointer to the array of this matrix.

Returns: Pointer.

◆ data() [2/2]

template<typename T >

const value_type * sf::TMatrix44< T >::data ( ) const

Gets the pointer to the array of this matrix.

Returns: Pointer.

◆ determinant()

template<typename T >

T sf::TMatrix44< T >::determinant ( ) const

Gets the 3x3 determinant from this instance.

Returns: Determinant 3x3 value.

◆ element() [1/2]

template<typename T >

T & sf::TMatrix44< T >::element	(	unsigned int	row,
		unsigned int	column
	)

Gets the element reference specified by the row and column.

Parameters

row	Row number between 0 and 3.
column	Column number between 0 and 3.

Returns: Matrix element value.

◆ element() [2/2]

template<typename T >

T sf::TMatrix44< T >::element	(	unsigned int	row,
		unsigned int	column
	)		const

Gets the element specified by the row and column.

Parameters

row	Row number between 0 and 3.
column	Column number between 0 and 3.

Returns: Matrix element value.

◆ fromOpenGL()

template<typename T >

template<typename R >

TMatrix44 & sf::TMatrix44< T >::fromOpenGL ( const R * matrix )

Assigns a column-major matrix array compatible with the OpenGL standard. Essentially converts from an OpenGL having column-major to this row-major matrix. It assigns a transposed copy of the data to the internal storage matrix.

Template Parameters

R	Type of the array pointer.

Returns: Itself.

◆ fromString()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::fromString	(	const std::string &	s,
		bool	ignore_err = `false`
	)

Gets matrix values from the string representation formed like '({1,2,3,4},{11,12,13,14},{21,22,23,24},{31,32,33,34})'. Throws an exception when the string is not in the correct format.

Parameters

s	Formatted string to read the values from.
ignore_err	Determines to throw an exception or not.

Exceptions

std::invalid_argument

Returns: This instance reference.

◆ getAxis()

template<typename T >

TVector3D< T > sf::TMatrix44< T >::getAxis ( EAxis axis ) const

Gets the given axis of matrix as a 3D vector.

Parameters

axis	Requested axis.

Returns: 3D-vector.

◆ getTiltPanRoll()

template<typename T >

void sf::TMatrix44< T >::getTiltPanRoll	(	T &	tilt,
		T &	pan,
		T &	roll
	)		const

Translates rotation part of matrix to tilt, pan and roll values.

Note: Only valid for rotation matrices without scaling info!

Parameters

tilt	Tilt angle in radians.
pan	Pan angle in radians.
roll	Roll angle in radians.

◆ getTranslation()

template<typename T >

TVector3D< T > sf::TMatrix44< T >::getTranslation ( ) const

Gets translation part of matrix.

Returns: Translation vector.

◆ insertGIGRotXYZ()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::insertGIGRotXYZ	(	T	rx,
		T	ry,
		T	rz
	)

Another way of applying rotation to the matrix.

Parameters

rx	X in Radians.
ry	Y in Radians
rz	Z in Radians.

◆ inverse()

template<typename T >

TMatrix44 sf::TMatrix44< T >::inverse ( ) const

Gets the inverted version of this instance. Call the method invert() to do this.

Exceptions

std::range_error

See also: invert()

◆ invert()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::invert ( )

Inverts this matrix.

Exceptions

std::range_error

◆ isEqual()

template<typename T >

bool sf::TMatrix44< T >::isEqual	(	const TMatrix44< T > &	m,
		T	tol = `tolerance`
	)		const

Compares the passed matrix within the set tolerance.

Parameters

m	Matrix to compare with.
tol	The tolerance when comparing which has a default.

Returns: True when equal.

◆ isRotational()

template<typename T >

bool sf::TMatrix44< T >::isRotational ( ) const

Determines if the matrix is a rotation matrix.

Returns

◆ multiplied()

template<typename T >

TMatrix44 sf::TMatrix44< T >::multiplied ( const TMatrix44< T > & m ) const

Same as multiply() but returns the changed matrix and does not affect this matrix.

Returns: This matrix reference.

◆ multiply()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::multiply ( const TMatrix44< T > & m )

Multiplies this matrix with the passed one so that the given matrix is applied on the matrix axes.

Returns: This matrix reference.

◆ operator const T *()

template<typename T >

sf::TMatrix44< T >::operator const T * ( ) const

Cast operator to the pointer of type 'T'.

Returns: Const pointer.

◆ operator T*()

template<typename T >

sf::TMatrix44< T >::operator T* ( )

Cast operator to the pointer of type 'T'.

Returns: Pointer.

◆ operator!=()

template<typename T >

bool sf::TMatrix44< T >::operator!= ( const TMatrix44< T > & ) const

Compare unequal operator using the tolerance when comparing.

Returns: True when unequal.

◆ operator()() [1/2]

template<typename T >

T & sf::TMatrix44< T >::operator()	(	int	row,
		int	column
	)

Function operator for row column value manipulations. This is different from the element() method.

Parameters

row	Row index.
column	Column index.

Returns: Reference to the value.

◆ operator()() [2/2]

template<typename T >

T sf::TMatrix44< T >::operator()	(	int	row,
		int	column
	)		const

Gets the element from row and column index. This is different from the element() method.

Parameters

row	Row index.
column	Column index.

Returns: Value of the element.

◆ operator*()

template<typename T >

TVector3D< T > sf::TMatrix44< T >::operator* ( const TVector3D< T > & ) const

Applies matrix on the passed 3D vector including the translation. Calls method transformed() on the passed 3D vector with the translation included.

Returns: Modified 3D-vector.

◆ operator*=()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::operator*= ( const TMatrix44< T > & )

Applies passed matrix on the axes of this matrix.

Returns: This modified matrix.

◆ operator=() [1/2]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::operator= ( const TMatrix44< T > & )

Assignment operator.

◆ operator=() [2/2]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::operator= ( TMatrix44< T > && m )

noexcept

Assignment move operator.

◆ operator==()

template<typename T >

bool sf::TMatrix44< T >::operator== ( const TMatrix44< T > & ) const

Compare equal operator using the tolerance when comparing.

Returns: True when equal.

◆ operator^()

template<typename T >

TVector3D< T > sf::TMatrix44< T >::operator^ ( const TVector3D< T > & ) const

Applies matrix on the passed 3D vector including the translation. Calls method transformed() on the passed 3D-vector excluding the translation.

Returns: Modified 3D-vector.

◆ orbit()

template<typename T >

TMatrix44 sf::TMatrix44< T >::orbit	(	T	horizontal,
		T	vertical
	)		const

Gets transformation of rotation around the local x- and y-axis of the current matrix.

Parameters

horizontal
vertical

Returns: The matrix.

◆ orientation()

template<typename T >

TMatrix44 sf::TMatrix44< T >::orientation ( ) const

Gets the orientation part of matrix.

◆ quaternion()

template<typename T >

TQuaternion< T > sf::TMatrix44< T >::quaternion ( ) const

Convert the rotation matrix part to identity/unit quaternion. Calls TQuaternion::fromMatrix()

Returns: A Quaternion instance.

◆ resetOrientation()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::resetOrientation ( )

Resets the orientation and leaves the translation as is.

Returns: This instance reference.

◆ rotate() [1/3]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::rotate ( const TMatrix44< T > & m )

Multiplies this matrix only with the 3x3 part of the given matrix applying only rotation and scaling.

Returns: This matrix reference.

◆ rotate() [2/3]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::rotate	(	T	angle,
		const TVector3D< T > &	vec,
		bool	only = `true`
	)

Applies rotation on the current matrix around a vector.

Parameters

angle	Angle of rotation in radians.
vec	Vector to rotating around.
only	When true, it only rotates and leaves the translation untouched.

Returns: Itself.

◆ rotate() [3/3]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::rotate	(	T	angle,
		T	x,
		T	y,
		T	z,
		bool	only = `true`
	)

Applies rotation on the current matrix.

Parameters

angle	Angle of rotation in radians.
x	Rotation around the horizontal (x-axis).
y	Rotation around the vertical (y-axis).
z	Rotation around the forward (z-axis).
only	When true, it only rotates and leaves the translation untouched.

Returns: Itself.

◆ rotated() [1/3]

template<typename T >

TMatrix44 sf::TMatrix44< T >::rotated ( const TMatrix44< T > & m ) const

Same as rotate() but returns the changed matrix and does not affect this matrix.

Returns: This matrix reference.

◆ rotated() [2/3]

template<typename T >

TMatrix44 sf::TMatrix44< T >::rotated	(	T	angle,
		const TVector3D< T > &	vec,
		bool	only = `true`
	)		const

Same as rotate() but only returns the changed matrix and does not affect this matrix.

Parameters

angle	Angle of rotation.
vec	Vector to rotating around.
only	When true, it only rotates and leaves the translation untouched.

Returns: Rotated matrix.

◆ rotated() [3/3]

template<typename T >

TMatrix44 sf::TMatrix44< T >::rotated	(	T	angle,
		T	x,
		T	y,
		T	z,
		bool	only = `true`
	)		const

Same as rotate() but only returns the changed matrix and does not affect this matrix.

Parameters

angle	Angle of rotation.
x	Rotation around the horizontal (x-axis).
y	Rotation around the vertical (y-axis).
z	Rotation around the forward (z-axis).
only	When true, it only rotates and leaves the translation untouched.

Returns: Rotated matrix.

◆ scale() [1/3]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::scale	(	T	factor,
		bool	translation = `true`
	)

Multiplies this matrix by the given factor. Leave the matrix translation vector alone.

Parameters

factor	Scaling factor.
translation	When true he translation is scaled as well.

Returns: Itself

◆ scale() [2/3]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::scale	(	T	x,
		T	y,
		T	z,
		bool	translation = `true`
	)

Multiplies this matrix by the given factors for x, y and z-axis. Leave the matrix translation vector alone.

Parameters

x	Scaling x-factor.
y	Scaling y-factor.
z	Scaling z-factor.
translation	When true he translation is scaled as well.

Returns: Itself

◆ scale() [3/3]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::scale	(	TVector3D< T >	factor,
		bool	translation = `true`
	)

Multiplies this matrix by the given factors for x, y and z-axis. Leave the matrix translation vector alone.

Parameters

factor	All scaling factors given by a 3D vector.
translation	When true he translation is scaled as well.

Returns: Itself

◆ setElement()

template<typename T >

void sf::TMatrix44< T >::setElement	(	unsigned int	row,
		unsigned int	column,
		T	value
	)

Sets the element specified by the row and column.

Parameters

row	Row number between 0 and 3.
column	Column number between 0 and 3.
value	Element value.

◆ setOrientationXY()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::setOrientationXY	(	const TVector3D< T > &	x_axis,
		const TVector3D< T > &	y_axis,
		bool	x_dominant = `false`
	)

Set orientation using two vectors X and Y which spans a surface having a dominant axis. The non-dominant axis is corrected when not perpendicular to the dominant axis.

Parameters

x_axis	Vector X, which spans the XY area.
y_axis	Vector Y, which spans the XY area.
x_dominant	When true, dominant is the X-axis.

Returns: This instance reference.

Exceptions

std::invalid_argument

◆ setOrientationZY()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::setOrientationZY	(	const TVector3D< T > &	z_axis,
		const TVector3D< T > &	y_axis,
		bool	z_dominant = `false`
	)

Set orientation using two vectors Z and Y which spans a surface having a dominant axis. The non-dominant axis is corrected when not perpendicular to the dominant axis.

Parameters

z_axis	Vector Z, which spans the ZY area.
y_axis	Vector Y, which spans the ZY area.
z_dominant	When true, dominant is the Z-axis.

Returns: This instance reference.

Exceptions

std::invalid_argument

◆ setPerspectiveProjection()

template<typename T >

void sf::TMatrix44< T >::setPerspectiveProjection	(	T	near_plane,
		T	far_plane,
		T	fov
	)

Sets the projection for this matrix.

Parameters

near_plane	Near plane of the camera frustum.
far_plane	Far plane of the camera frustum.
fov	Field of view in radians.

See also: https://learnwebgl.brown37.net/08_projections/projections_perspective.html

◆ setTiltPanRoll()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::setTiltPanRoll	(	T	tilt,
		T	pan,
		T	roll
	)

Sets/resets rotation part of the matrix according to tilt pan roll and does not touch the translation or scaling part.

Parameters

tilt	Tilt is a rotation around the horizontal (x-axis).
pan	Pan is a rotation around the vertical (y-axis).
roll	Roll is a rotation around the forward (z-axis).

Returns: This matrix.

◆ setTranslation() [1/2]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::setTranslation ( const TVector3D< T > & v )

Sets translation part of this matrix.

Returns: Itself.

◆ setTranslation() [2/2]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::setTranslation	(	T	x,
		T	y,
		T	z
	)

Sets translation part of this matrix.

Returns: Itself.

◆ toOpenGL() [1/2]

template<typename T >

template<typename R >

std::array< R, 16 > sf::TMatrix44< T >::toOpenGL ( ) const

Gets a column-major matrix array buffer compatible with OpenGL standard. Essentially converts from a row-major to column-major and OpenGL compatible matrix. Useful when calling OpenGL functions glLoadMatrix[fd]() and glMultMatrix[fd]().

Template Parameters

R	Type of the array.

Returns: A column-major matrix array buffer.

◆ toOpenGL() [2/2]

template<typename T >

template<typename R >

void sf::TMatrix44< T >::toOpenGL ( R * matrix ) const

Copies this matrix to a column-major matrix array compatible with OpenGL standard. A one-on-one copy is not possible, and a transpose of the 3x3 matrix part within is needed.

Parameters

matrix Array pointer expected to be at least of 16-element length.

◆ toString()

template<typename T >

std::string sf::TMatrix44< T >::toString ( int digits = 0 ) const

Gets the string representation of the matrix formed like '({m00,m01,m02,m03},{m10,m11,m12,m13},{m20,m21,m22,m23},{m30,m31,m32,m33})'.

◆ transformed()

template<typename T >

TVector3D< T > sf::TMatrix44< T >::transformed	(	const TVector3D< T > &	v,
		bool	translate
	)		const

Applies the matrix rotation up on a 3D-vector.

Parameters

v	3D vector.
translate	When true, the translation part is included.

Returns: Rotated and translated 3D-vector.

◆ translate() [1/2]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::translate	(	const TVector3D< T > &	v,
		bool	only = `true`
	)

Adds a translation to this instance using a 3D vector.

Parameters

v	Vector to additionally translate to.
only	When true, the translation is applied without transformation.

Returns: This instance reference.

◆ translate() [2/2]

template<typename T >

TMatrix44 & sf::TMatrix44< T >::translate	(	T	x,
		T	y,
		T	z,
		bool	only = `true`
	)

Adds a translation of this instance using individual values for each axis.

Parameters

x	X-axis value to translate.
y	Y-axis value to translate.
z	Z-axis value to translate.
only	When true, the translation is applied without transformation.

Returns: This instance reference.

◆ translated() [1/2]

template<typename T >

TMatrix44 sf::TMatrix44< T >::translated	(	const TVector3D< T > &	v,
		bool	only = `true`
	)		const

Same as translate() but does not change this matrix only returns the translated one.

Parameters

v	Vector to additionally translate to.
only	When true, the translation is applied without transformation.

Returns: A modified instance.

◆ translated() [2/2]

template<typename T >

TMatrix44 sf::TMatrix44< T >::translated	(	T	x,
		T	y,
		T	z,
		bool	only = `true`
	)		const

Same as translate() but does not change this matrix only returns the translated one.

Parameters

x	X-axis value to translate.
y	Y-axis value to translate.
z	Z-axis value to translate.
only	When true, the translation is applied without transformation.

Returns: A modified instance.

◆ transpose()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::transpose ( )

Transpose this matrix.

Returns: This matrix

◆ transposeAssign()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::transposeAssign ( const T [4][4] )

Assigns the transposed 4x4 array structure to this matrix.

Returns: This matrix.

◆ transposed()

template<typename T >

TMatrix44 sf::TMatrix44< T >::transposed ( ) const

Get a transposed matrix of this instance.

Returns: Transposed matrix.

◆ unit()

template<typename T >

TMatrix44 & sf::TMatrix44< T >::unit ( )

Set or resets this instance as a unit/identity matrix. A unit matrix, also known as the identity matrix, is a square matrix in which all the elements along the main diagonal (from the top-left to the bottom-right) are 1, and all other elements are 0. It acts as the multiplicative identity in matrix algebra, meaning that multiplying any matrix by the identity matrix results in the original matrix itself.

Returns: Itself.

Member Data Documentation

◆ _data

template<typename T >

union sf::TMatrix44::data_type sf::TMatrix44< T >::_data = {1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1}

protected

◆ tolerance

template<typename T >

constexpr auto sf::TMatrix44< T >::tolerance = TVector3D<T>::tolerance

staticconstexpr

Tolerance for when comparing in the equal operator.

Used as: std::fabs(x1 - x2) < tolerance

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

TMatrix44.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ value_type

Member Enumeration Documentation

◆ EAxis

Constructor & Destructor Documentation

◆ TMatrix44() [1/9]

◆ TMatrix44() [2/9]

◆ TMatrix44() [3/9]

◆ TMatrix44() [4/9]

◆ TMatrix44() [5/9]

◆ TMatrix44() [6/9]

◆ TMatrix44() [7/9]

◆ TMatrix44() [8/9]

◆ TMatrix44() [9/9]

Member Function Documentation

◆ assign() [1/2]

◆ assign() [2/2]

◆ clearTranslation()

◆ copyTo() [1/2]

◆ copyTo() [2/2]

◆ data() [1/2]

◆ data() [2/2]

◆ determinant()

◆ element() [1/2]

◆ element() [2/2]

◆ fromOpenGL()

◆ fromString()

◆ getAxis()

◆ getTiltPanRoll()

◆ getTranslation()

◆ insertGIGRotXYZ()

◆ inverse()

◆ invert()

◆ isEqual()

◆ isRotational()

◆ multiplied()

◆ multiply()

◆ operator const T *()

◆ operator T*()

◆ operator!=()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator*()

◆ operator*=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator^()

◆ orbit()

◆ orientation()

◆ quaternion()

◆ resetOrientation()

◆ rotate() [1/3]

◆ rotate() [2/3]

◆ rotate() [3/3]

◆ rotated() [1/3]

◆ rotated() [2/3]

◆ rotated() [3/3]

◆ scale() [1/3]

◆ scale() [2/3]

◆ scale() [3/3]

◆ setElement()

◆ setOrientationXY()

◆ setOrientationZY()

◆ setPerspectiveProjection()

◆ setTiltPanRoll()

◆ setTranslation() [1/2]

◆ setTranslation() [2/2]

◆ toOpenGL() [1/2]

◆ toOpenGL() [2/2]

◆ toString()

◆ transformed()

◆ translate() [1/2]

◆ translate() [2/2]