1. Epic GamesDeveloper
  3. TMatrix

TMatrix

API > API/Runtime > API/Runtime/Core

   
Name TMatrix
Type struct
Header File /Engine/Source/Runtime/Core/Public/Math/MathFwd.h
Include Path #include "Math/MathFwd.h"
Source /Engine/Source/Runtime/Core/Public/Math/Sphere.h

Syntax

template<typename T>  
struct TMatrix

Derived Classes

TMatrix derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

TMatrix ( const TPlane< T >& InX,
const TPlane< T >& InY,
const TPlane< T >& InZ,
const TPlane< T >& InW
)

 Constructors. Math/Matrix.h  

TMatrix ( const TMatrix< FArg >& From
)

 Conversion to other type. Math/Matrix.h  
Constructor. Math/Matrix.h  

TMatrix ()

 Constructors. Math/Matrix.h  

TMatrix ( const TVector< T >& InX,
const TVector< T >& InY,
const TVector< T >& InZ,
const TVector< T >& InW
)

 Constructor. Math/Matrix.h  

Typedefs

Name Type Remarks Include Path
FReal T   Math/Matrix.h

Constants

Name Type Remarks Include Path
Identity const TMatrix   Math/Matrix.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
M T   Math/Matrix.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TMatrix< T > ApplyScale ( T Scale
) const

 Apply Scale to this matrix Math/Matrix.h  

uint32 ComputeHash()

 For debugging purpose, could be changed Math/Matrix.h  

TMatrix< T > ConcatTranslation ( const TVector< T >& Translation
) const

 Returns a matrix with an additional translation concatenated. Math/Matrix.h  

bool ContainsNaN ()

 Returns true if any element of this matrix is NaN Math/Matrix.h  

void DebugPrint()

 Output ToString Math/Matrix.h  

T Determinant()

   Math/Matrix.h  

void DiagnosticCheckNaN()

   Math/Matrix.h  

bool Equals ( const TMatrix< T >& Other,
T Tolerance
) const

 Error-tolerant comparison. Math/Matrix.h  

TVector< T > ExtractScaling ( T Tolerance
)

 Remove any scaling from this matrix (ie magnitude of each row is 1) and return the 3D scale vector that was initially present with error Tolerance Math/Matrix.h  

TVector< T > GetColumn ( int32 i
) const

 Get a column of this matrix Math/Matrix.h  

bool GetFrustumBottomPlane ( TPlane< T >& OuTPln
) const

   Math/Matrix.h  

bool GetFrustumFarPlane ( TPlane< T >& OuTPln
) const

   Math/Matrix.h  

bool GetFrustumLeftPlane ( TPlane< T >& OuTPln
) const

   Math/Matrix.h  

bool GetFrustumNearPlane ( TPlane< T >& OuTPln
) const

 Frustum plane extraction. Math/Matrix.h  

bool GetFrustumRightPlane ( TPlane< T >& OuTPln
) const

   Math/Matrix.h  

bool GetFrustumTopPlane ( TPlane< T >& OuTPln
) const

   Math/Matrix.h  

TMatrix< T > GetMatrixWithoutScale ( T Tolerance
) const

 Returns matrix after RemoveScaling with error Tolerance. Math/Matrix.h  

T GetMaximumAxisScale()

   Math/Matrix.h  

T GetMinimumAxisScale()

   Math/Matrix.h  

TVector< T > GetOrigin()

   Math/Matrix.h  

void GetScaledAxes ( TVector< T >& X,
TVector< T >& Y,
TVector< T >& Z
) const

 Get axes of this matrix scaled by the scale of the matrix Math/Matrix.h  

TVector< T > GetScaledAxis ( EAxis::Type Axis
) const

 Get axis of this matrix scaled by the scale of the matrix Math/Matrix.h  

TVector< T > GetScaleVector ( T Tolerance
) const

 Return a 3D scale vector calculated from this matrix (where each component is the magnitude of a row vector) with error Tolerance. Math/Matrix.h  

TMatrix< T > GetTransposed()

   Math/Matrix.h  

void GetUnitAxes ( TVector< T >& X,
TVector< T >& Y,
TVector< T >& Z
) const

 Get unit length axes of this matrix Math/Matrix.h  

TVector< T > GetUnitAxis ( EAxis::Type Axis
) const

 Get unit length axis of this matrix Math/Matrix.h  

TMatrix< T > Inverse ()

 Inverse. zero & NaN matrices are silently changed to identity. Math/Matrix.h  
Get the inverse of this matrix. Math/Matrix.h  

TVector< T > InverseTransformPosition ( const TVector< T >& V
) const

 Inverts the matrix and then transforms V - correctly handles scaling in this matrix. Math/Matrix.h  

TVector< T > InverseTransformVector ( const TVector< T >& V
) const

 Transform a direction vector by the inverse of this matrix - will not take into account translation part. Math/Matrix.h  

void Mirror ( EAxis::Type MirrorAxis,
EAxis::Type FlipAxis
)

 Utility for mirroring this transform across a certain plane, and flipping one of the axis as well. Math/Matrix.h  

void RemoveScaling ( T Tolerance
)

 NOTE: There is some compiler optimization issues with WIN64 that cause FORCEINLINE to cause a crash Remove any scaling from this matrix (ie magnitude of each row is 1) with error Tolerance Math/Matrix.h  

TMatrix< T > RemoveTranslation()

 Remove any translation from this matrix. Math/Matrix.h  

UE::Math::TRotator< T > Rotator()

   Math/Matrix.h  

T RotDeterminant()

 Calculate determinant of rotation 3x3 matrix Math/Matrix.h  

void ScaleTranslation ( const TVector< T >& Scale3D
)

 Scale the translation part of the matrix by the supplied vector. Math/Matrix.h  

bool Serialize ( FArchive& Ar
)

   Math/Matrix.h  

bool SerializeFromMismatchedTag ( FName StructTag,
FArchive& Ar
)

   Math/Matrix.h  

void SetAxes ( const TVector< T >* Axis0,
const TVector< T >* Axis1,
const TVector< T >* Axis2,
const TVector< T >* Origin
)

 Update the axes of the matrix if any value is NULL do not update that axis Math/Matrix.h  

void SetAxis ( int32 i,
const TVector< T >& Axis
)

 Set an axis of this matrix Math/Matrix.h  

void SetColumn ( int32 i,
TVector< T > Value
)

 Set a column of this matrix Math/Matrix.h  

void SetIdentity()

 Set this to the identity matrix. Math/Matrix.h  

void SetOrigin ( const TVector< T >& NewOrigin
)

 Set the origin of the coordinate system to the given vector. Math/Matrix.h  

void To3x4MatrixTranspose ( float* Out
) const

      

void To3x4MatrixTranspose ( T* Out
) const

 Convert this Atom to the 3x4 transpose of the transformation matrix. Math/Matrix.h  
Transform a rotation matrix into a quaternion. Math/Matrix.h  

FString ToString()

 Get a textual representation of the vector. Math/Matrix.h  

TVector4< T > TransformFVector4 ( const TVector4< T >& V
) const

 Homogeneous transform. Math/Matrix.h  

TVector4< T > TransformPosition ( const TVector< T >& V
) const

 Transform a location - will take into account translation part of the TMatrix. Math/Matrix.h  

TVector4< T > TransformVector ( const TVector< T >& V
) const

 Transform a direction vector - will not take into account translation part of the TMatrix. Math/Matrix.h  

TMatrix< T > TransposeAdjoint()

   Math/Matrix.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ErrorEnsure ( const TCHAR* Message
)

 Output an error message and trigger an ensure Math/Matrix.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const TMatrix< T >& Other
) const

 Checks whether another Matrix is not equal to this, within specified tolerance. Math/Matrix.h  

TMatrix< T > operator* ( const TMatrix< T >& Other
) const

 Gets the result of multiplying a Matrix to this. Math/Matrix.h  

TMatrix< T > operator* ( T Other
) const

 This isn't applying SCALE, just multiplying the value to all members - i.e. weighting Math/Matrix.h  

void operator*= ( const TMatrix< T >& Other
)

 Multiply this by a matrix. Math/Matrix.h  

void operator*= ( T Other
)

 Multiply this matrix by a weighting factor. Math/Matrix.h  

TMatrix< T > operator+ ( const TMatrix< T >& Other
) const

 Gets the result of adding a matrix to this. Math/Matrix.h  

void operator+= ( const TMatrix< T >& Other
)

 Adds to this matrix. Math/Matrix.h  

bool operator== ( const TMatrix< T >& Other
) const

 Checks whether two matrix are identical. Math/Matrix.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page