A 4x4 component matrix class. More...

#include <Mat4.h>

Public Types
using	ComponentType = Type

Public Member Functions
	EZ_DECLARE_POD_TYPE ()

EZ_ALWAYS_INLINE Type &	Element (ezInt32 iColumn, ezInt32 iRow)

EZ_ALWAYS_INLINE Type	Element (ezInt32 iColumn, ezInt32 iRow) const

	ezMat4Template ()
	Default Constructor DOES NOT INITIALIZE the matrix, at all.

	ezMat4Template (const Type *const pData, ezMatrixLayout::Enum layout)
	Copies 16 values from pData into the matrix. Can handle the data in row-major or column-major order. More...

	ezMat4Template (Type c1r1, Type c2r1, Type c3r1, Type c4r1, Type c1r2, Type c2r2, Type c3r2, Type c4r2, Type c1r3, Type c2r3, Type c3r3, Type c4r3, Type c1r4, Type c2r4, Type c3r4, Type c4r4)
	Sets each element manually: Naming is "column-n row-m".

	ezMat4Template (const ezMat3Template< Type > &mRotation, const ezVec3Template< Type > &vTranslation)
	Creates a transformation matrix from a rotation and a translation.

void	GetAsArray (Type *out_pData, ezMatrixLayout::Enum layout) const
	Copies the 16 values of this matrix into the given array. 'layout' defines whether the data should end up in column-major or row-major format.

void	SetTransformationMatrix (const ezMat3Template< Type > &mRotation, const ezVec3Template< Type > &vTranslation)
	Sets a transformation matrix from a rotation and a translation.

void	SetZero ()
	Sets all elements to zero.

void	SetIdentity ()
	Sets all elements to zero, except the diagonal, which is set to one.

void	Transpose ()
	Transposes this matrix.

const ezMat4Template< Type >	GetTranspose () const
	Returns the transpose of this matrix.

ezResult	Invert (Type fEpsilon=ezMath::SmallEpsilon< Type >())
	Inverts this matrix. Return value indicates whether the matrix could be inverted.

const ezMat4Template< Type >	GetInverse (Type fEpsilon=ezMath::SmallEpsilon< Type >()) const
	Returns the inverse of this matrix.

bool	IsZero (Type fEpsilon=ezMath::DefaultEpsilon< Type >()) const
	Checks whether all elements are zero.

bool	IsIdentity (Type fEpsilon=ezMath::DefaultEpsilon< Type >()) const
	Checks whether this is an identity matrix.

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

bool	IsNaN () const
	Checks whether any component is NaN.

ezVec4Template< Type >	GetRow (ezUInt32 uiRow) const
	Returns all 4 components of the i-th row.

void	SetRow (ezUInt32 uiRow, const ezVec4Template< Type > &vRow)
	Sets all 4 components of the i-th row.

ezVec4Template< Type >	GetColumn (ezUInt32 uiColumn) const
	Returns all 4 components of the i-th column.

void	SetColumn (ezUInt32 uiColumn, const ezVec4Template< Type > &vColumn)
	Sets all 4 components of the i-th column.

ezVec4Template< Type >	GetDiagonal () const
	Returns all 4 components on the diagonal of the matrix.

void	SetDiagonal (const ezVec4Template< Type > &vDiag)
	Sets all 4 components on the diagonal of the matrix.

const ezVec3Template< Type >	GetTranslationVector () const
	Returns the first 3 components of the last column.

void	SetTranslationVector (const ezVec3Template< Type > &v)
	Sets the first 3 components of the last column.

void	SetRotationalPart (const ezMat3Template< Type > &mRotation)
	Sets the 3x3 rotational part of the matrix.

const ezMat3Template< Type >	GetRotationalPart () const
	Returns the 3x3 rotational and scaling part of the matrix.

const ezVec3Template< Type >	GetScalingFactors () const
	Returns the 3 scaling factors that are encoded in the matrix.

ezResult	SetScalingFactors (const ezVec3Template< Type > &vXYZ, Type fEpsilon=ezMath::DefaultEpsilon< Type >())
	Tries to set the three scaling factors in the matrix. Returns EZ_FAILURE if the matrix columns cannot be normalized and thus no rescaling is possible.

const ezVec3Template< Type >	TransformPosition (const ezVec3Template< Type > &v) const
	Matrix-vector multiplication, assuming the 4th component of the vector is one (default behavior).

void	TransformPosition (ezVec3Template< Type > *pV, ezUInt32 uiNumVectors, ezUInt32 uiStride=sizeof(ezVec3Template< Type >)) const
	Matrix-vector multiplication, assuming the 4th component of the vector is one (default behavior).

const ezVec3Template< Type >	TransformDirection (const ezVec3Template< Type > &v) const
	Matrix-vector multiplication, assuming the 4th component of the vector is zero. So, rotation/scaling only. Useful as an optimization.

void	TransformDirection (ezVec3Template< Type > *pV, ezUInt32 uiNumVectors, ezUInt32 uiStride=sizeof(ezVec3Template< Type >)) const
	Matrix-vector multiplication, assuming the 4th component of the vector is zero. So, rotation/scaling only. Useful as an optimization.

const ezVec4Template< Type >	Transform (const ezVec4Template< Type > &v) const
	Matrix-vector multiplication.

void	Transform (ezVec4Template< Type > *pV, ezUInt32 uiNumVectors, ezUInt32 uiStride=sizeof(ezVec4Template< Type >)) const
	Matrix-vector multiplication.

void	operator*= (Type f)
	Component-wise multiplication (commutative)

void	operator/= (Type f)
	Component-wise division.

bool	IsIdentical (const ezMat4Template< Type > &rhs) const
	Equality Check.

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

Static Public Member Functions
static ezMat4Template< Type >	MakeZero ()
	Returns a zero matrix.

static ezMat4Template< Type >	MakeIdentity ()
	Returns an identity matrix.

static ezMat4Template< Type >	MakeFromRowMajorArray (const Type *const pData)
	Creates a matrix from 16 values that are in row-major layout.

static ezMat4Template< Type >	MakeFromColumnMajorArray (const Type *const pData)
	Creates a matrix from 16 values that are in column-major layout.

static ezMat4Template< Type >	MakeFromValues (Type c1r1, Type c2r1, Type c3r1, Type c4r1, Type c1r2, Type c2r2, Type c3r2, Type c4r2, Type c1r3, Type c2r3, Type c3r3, Type c4r3, Type c1r4, Type c2r4, Type c3r4, Type c4r4)
	Creates a matrix from 16 values. Naming is "column-n row-m".

static ezMat4Template< Type >	MakeTranslation (const ezVec3Template< Type > &vTranslation)
	Creates a matrix with all zero values, except the last column, which is set to x, y, z, 1.

static ezMat4Template< Type >	MakeTransformation (const ezMat3Template< Type > &mRotation, const ezVec3Template< Type > &vTranslation)
	Creates a transformation matrix from a rotation and a translation.

static ezMat4Template< Type >	MakeScaling (const ezVec3Template< Type > &vScale)
	Creates a matrix with all zero values, except along the diagonal, which is set to x, y, z, 1.

static ezMat4Template< Type >	MakeRotationX (ezAngle angle)
	Creates a matrix that is a rotation matrix around the X-axis.

static ezMat4Template< Type >	MakeRotationY (ezAngle angle)
	Creates a matrix that is a rotation matrix around the Y-axis.

static ezMat4Template< Type >	MakeRotationZ (ezAngle angle)
	Creates a matrix that is a rotation matrix around the Z-axis.

static ezMat4Template< Type >	MakeAxisRotation (const ezVec3Template< Type > &vAxis, ezAngle angle)
	Creates a matrix that is a rotation matrix around the given axis.

Public Attributes
Type	m_fElementsCM [16]
	The matrix as a 16-element Type array (column-major)

Detailed Description

template<typename Type>
class ezMat4Template< Type >

A 4x4 component matrix class.

Constructor & Destructor Documentation

◆ ezMat4Template()

template<typename Type >

ezMat4Template< Type >::ezMat4Template	(	const Type *const	pData,
		ezMatrixLayout::Enum	layout
	)

Copies 16 values from pData into the matrix. Can handle the data in row-major or column-major order.

Parameters

pData	The array of Type values from which to set the matrix data.
layout	The layout in which pData stores the matrix. The data will get transposed, if necessary. The data should be in column-major format, if you want to prevent unnecessary transposes.

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

/home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/Math/Declarations.h
/home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/Math/Mat4.h
/home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/Math/Implementation/AllClasses_inl.h
/home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/Math/Implementation/Mat4_inl.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

template<typename Type> class ezMat4Template< Type >

Constructor & Destructor Documentation

◆ ezMat4Template()

template<typename Type>
class ezMat4Template< Type >