Plasma Engine  2.0
Loading...
Searching...
No Matches
plMat4Template< Type > Class Template Reference

A 4x4 component matrix class. More...

#include <Mat4.h>

Public Types

using ComponentType = Type
 

Public Member Functions

 PL_DECLARE_POD_TYPE ()
 
PL_ALWAYS_INLINE Type & Element (plInt32 iColumn, plInt32 iRow)
 
PL_ALWAYS_INLINE Type Element (plInt32 iColumn, plInt32 iRow) const
 
 plMat4Template ()
 Default Constructor DOES NOT INITIALIZE the matrix, at all.
 
 plMat4Template (const Type *const pData, plMatrixLayout::Enum layout)
 Copies 16 values from pData into the matrix. Can handle the data in row-major or column-major order.
 
 plMat4Template (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".
 
 plMat4Template (const plMat3Template< Type > &mRotation, const plVec3Template< Type > &vTranslation)
 Creates a transformation matrix from a rotation and a translation.
 
void GetAsArray (Type *out_pData, plMatrixLayout::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 plMat3Template< Type > &mRotation, const plVec3Template< 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 plMat4Template< Type > GetTranspose () const
 Returns the transpose of this matrix.
 
plResult Invert (Type fEpsilon=plMath::SmallEpsilon< Type >())
 Inverts this matrix. Return value indicates whether the matrix could be inverted.
 
const plMat4Template< Type > GetInverse (Type fEpsilon=plMath::SmallEpsilon< Type >()) const
 Returns the inverse of this matrix.
 
bool IsZero (Type fEpsilon=plMath::DefaultEpsilon< Type >()) const
 Checks whether all elements are zero.
 
bool IsIdentity (Type fEpsilon=plMath::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.
 
plVec4Template< Type > GetRow (plUInt32 uiRow) const
 Returns all 4 components of the i-th row.
 
void SetRow (plUInt32 uiRow, const plVec4Template< Type > &vRow)
 Sets all 4 components of the i-th row.
 
plVec4Template< Type > GetColumn (plUInt32 uiColumn) const
 Returns all 4 components of the i-th column.
 
void SetColumn (plUInt32 uiColumn, const plVec4Template< Type > &vColumn)
 Sets all 4 components of the i-th column.
 
plVec4Template< Type > GetDiagonal () const
 Returns all 4 components on the diagonal of the matrix.
 
void SetDiagonal (const plVec4Template< Type > &vDiag)
 Sets all 4 components on the diagonal of the matrix.
 
const plVec3Template< Type > GetTranslationVector () const
 Returns the first 3 components of the last column.
 
void SetTranslationVector (const plVec3Template< Type > &v)
 Sets the first 3 components of the last column.
 
void SetRotationalPart (const plMat3Template< Type > &mRotation)
 Sets the 3x3 rotational part of the matrix.
 
const plMat3Template< Type > GetRotationalPart () const
 Returns the 3x3 rotational and scaling part of the matrix.
 
const plVec3Template< Type > GetScalingFactors () const
 Returns the 3 scaling factors that are encoded in the matrix.
 
plResult SetScalingFactors (const plVec3Template< Type > &vXYZ, Type fEpsilon=plMath::DefaultEpsilon< Type >())
 Tries to set the three scaling factors in the matrix. Returns PL_FAILURE if the matrix columns cannot be normalized and thus no rescaling is possible.
 
const plVec3Template< Type > TransformPosition (const plVec3Template< Type > &v) const
 Matrix-vector multiplication, assuming the 4th component of the vector is one (default behavior).
 
void TransformPosition (plVec3Template< Type > *pV, plUInt32 uiNumVectors, plUInt32 uiStride=sizeof(plVec3Template< Type >)) const
 Matrix-vector multiplication, assuming the 4th component of the vector is one (default behavior).
 
const plVec3Template< Type > TransformDirection (const plVec3Template< 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 (plVec3Template< Type > *pV, plUInt32 uiNumVectors, plUInt32 uiStride=sizeof(plVec3Template< Type >)) const
 Matrix-vector multiplication, assuming the 4th component of the vector is zero. So, rotation/scaling only. Useful as an optimization.
 
const plVec4Template< Type > Transform (const plVec4Template< Type > &v) const
 Matrix-vector multiplication.
 
void Transform (plVec4Template< Type > *pV, plUInt32 uiNumVectors, plUInt32 uiStride=sizeof(plVec4Template< Type >)) const
 Matrix-vector multiplication.
 
void operator*= (Type f)
 Component-wise multiplication (commutative)
 
void operator/= (Type f)
 Component-wise division.
 
bool IsIdentical (const plMat4Template< Type > &rhs) const
 Equality Check.
 
bool IsEqual (const plMat4Template< Type > &rhs, Type fEpsilon) const
 Equality Check with epsilon.
 

Static Public Member Functions

static plMat4Template< Type > MakeZero ()
 Returns a zero matrix.
 
static plMat4Template< Type > MakeIdentity ()
 Returns an identity matrix.
 
static plMat4Template< Type > MakeFromRowMajorArray (const Type *const pData)
 Creates a matrix from 16 values that are in row-major layout.
 
static plMat4Template< Type > MakeFromColumnMajorArray (const Type *const pData)
 Creates a matrix from 16 values that are in column-major layout.
 
static plMat4Template< 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 plMat4Template< Type > MakeTranslation (const plVec3Template< Type > &vTranslation)
 Creates a matrix with all zero values, except the last column, which is set to x, y, z, 1.
 
static plMat4Template< Type > MakeTransformation (const plMat3Template< Type > &mRotation, const plVec3Template< Type > &vTranslation)
 Creates a transformation matrix from a rotation and a translation.
 
static plMat4Template< Type > MakeScaling (const plVec3Template< Type > &vScale)
 Creates a matrix with all zero values, except along the diagonal, which is set to x, y, z, 1.
 
static plMat4Template< Type > MakeRotationX (plAngle angle)
 Creates a matrix that is a rotation matrix around the X-axis.
 
static plMat4Template< Type > MakeRotationY (plAngle angle)
 Creates a matrix that is a rotation matrix around the Y-axis.
 
static plMat4Template< Type > MakeRotationZ (plAngle angle)
 Creates a matrix that is a rotation matrix around the Z-axis.
 
static plMat4Template< Type > MakeAxisRotation (const plVec3Template< Type > &vAxis, plAngle 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 plMat4Template< Type >

A 4x4 component matrix class.

Constructor & Destructor Documentation

◆ plMat4Template()

template<typename Type >
plMat4Template< Type >::plMat4Template ( const Type *const pData,
plMatrixLayout::Enum layout )

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

Parameters
pDataThe array of Type values from which to set the matrix data.
layoutThe 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: