1. Epic GamesDeveloper
  3. Chaos

Chaos

Unreal Engine C++ API Reference > Runtime > ChaosCore

Classes

  Type Name Description
Public class GivensRotation Class for givens rotation.  
Public struct Pair    
Public class PMatrix    
Public class TAABB    
Public class TArrayCollection    
Public class TArrayCollectionArray    
Public class TArrayCollectionArrayBase    
Public class TArrayFaceND    
Public class TArrayND    
Public class TArrayNDBase    
Public class TObjectPool    
Public class TObjectPoolDeleter A deleter for use with TUniquePtr and a TObjectPool item  
Public class TRigidTransform    
Public class TRotation    
Public struct TSimdInt32 A TNumLanes-wide set of integers.  
Public struct TSimdRealf A TNumLanes-wide set of single-precision floats.  
Public struct TSimdSelector The result of Simd comparison operations and used in SimdSelect.  
Public struct TSimdValue Used to store any value type in a TNumLanes-wide set.  
Public struct TSimdVec3f A TNumLanes-wide set of floating point 3-vectors.  
Public class TVector    
Public struct TVectorTraits    
Public class VectorND    

Constants

Name Description
Chaos::Private::SimdAlignment WIP: Not ready for public use.

Typedefs

Name Description
FAABB3  
FAABB3f  
FMatrix33  
FMatrix44  
FReal Common data types for the Chaos physics engine.
FRealDouble Specific precision types, this should be used in very targeted places where the use of a specific type is necessary over using FReal
FRealSingle  
FRigidTransform3  
FRigidTransform3f  
FRigidTransformRealSingle3  
FRotation3  
FRotation3f  
FSimd4Int32  
FSimd4Realf WIP: Not ready for public use.
FSimd4Selector  
FSimd4Vec3f  
FTransformPair  
FVec2  
FVec2f  
FVec3  
FVec3f  
FVec4  
PMatrix33d  
TMatrix33  
TRequiresDestructor The type needs to have a destructor run when the pool pointer is freed.
TRotation3  
TTrivialDestruct The type needs no destruction and can just be abandoned on free.
TVec2  
TVec3  
TVec4  

Functions

  Type Name Description
Public function float

Chaos::ConvertDoubleToFloat ( double DoubleValue
)

  
Public function TVec3< float >

Chaos::ConvertDoubleToFloat ( TVec3< double > DoubleValue
)

  
Public function double

Chaos::ConvertFloatToDouble ( float FloatValue
)

  
Public function TVec3< double >

Chaos::ConvertFloatToDouble ( TVec3< float > FloatValue
)

  
Public function void

Chaos::dRdFCorotated ( const PMatrix< T, 3, 3 >& F,
TVector< T, 81 >& dRdF
)

 3X3 version of dRdF indexing of diff: dRdF[9*(i*3+j)+(m*3+n)] = dR.GetAt(m, n) /dF.GetAt (i, j):
Public function void

Chaos::FlipSign ( int i,
PMatrix< T, 3, 3 >& U,
TVector< T, 3 >& sigma
)

 Helper function of 3X3 SVD for flipping signs due to flipping signs of sigma.
Public function FString  
Public function uint32

Chaos::GetTypeHash ( const Chaos::TVector< T, 3 >& V
)

  
Public function uint32

Chaos::GetTypeHash ( const Chaos::TVector< T, 2 >& V
)

  
Public function void

Chaos::MakeLambdaShape ( PMatrix< T, 3, 3 >& H,
PMatrix< T, 3, 3 >& U,
PMatrix< T, 3, 3 >& V
)

 Make a 3X3 matrix to lambda shape original form of H: x x x x x x x x x after : x 0 0 x x 0 x 0 x
Public function Pair< T1, T2 >

Chaos::MakePair ( const T1& First,
const T2& Second
)

  
Public function void

Chaos::MakeUpperBidiag ( PMatrix< T, 3, 3 >& H,
PMatrix< T, 3, 3 >& U,
PMatrix< T, 3, 3 >& V
)

 Make a 3X3 matrix to upper bidiagonal form original form of H: x x x x x x x x x after zero chase: x x 0 0 x x 0 0 x
Public function TVector< T, 3 >

Chaos::operator* ( const T S,
const TVector< T, 3 >& V
)

  
Public function TVector< T, 3 >

Chaos::operator/ ( const T S,
const TVector< T, 3 >& V
)

  
Public function bool

Chaos::operator== ( const Pair< T1, T2 >& First,
const Pair< T1, T2 >& Second
)

  
Public function bool

Chaos::operator> ( const Pair< T1, T2 >& First,
const Pair< T1, T2 >& Second
)

  
Public function void

Chaos::PolarDecomposition ( const PMatrix< T, 2, 2 >& A,
PMatrix< T, 2, 2 >& R,
PMatrix< T, 2, 2 >& S_Sym
)

 2x2 polar decomposition.
Public function void

Chaos::PolarDecomposition ( const PMatrix< T, 3, 3 >& A,
PMatrix< T, 3, 3 >& R,
PMatrix< T, 3, 3 >& S_Sym
)

 3X3 polar decomposition.
Public function void

Chaos::PolarDecomposition ( const PMatrix< T, 2, 2 >& A,
GivensRotation< T >& R,
PMatrix< T, 2, 2 >& S_Sym
)

 2x2 polar decomposition.
Public function FSimd4Realf

Chaos::Private::SimdAdd ( const FSimd4Realf& InL,
const FSimd4Realf& InR
)

  
Public function FSimd4Vec3f  
Public function bool  
Public function FSimd4Selector  
Public function bool 4-wide Logical operations
Public function FSimd4Vec3f  
Public function FSimd4Realf  
Public function FSimd4Realf  
Public function FSimd4Selector  
Public function FSimd4Vec3f

Chaos::Private::SimdGatherAligned ( const FVec3f& InA,
const FVec3f& InB,
const FVec3f& InC,
const FVec3f& InD
)

 4-wide Gather/Scatter operations Convert 4 row-vectors into 3 column-vectors NOTE: The input vectors must be 16-byte aligned and padded to 16 bytes to avoid reading past valid memory
Public function FSimd4Selector  
Public function FSimd4Selector  
Public function FSimd4Selector  
Public function FSimd4Selector  
Public function FSimd4Realf  
Public function FSimd4Selector

Chaos::Private::SimdLess ( const FSimd4Int32& InL,
const FSimd4Int32& InR
)

  
Public function FSimd4Selector

Chaos::Private::SimdLess ( const FSimd4Realf& InL,
const FSimd4Realf& InR
)

  
Public function FSimd4Realf

Chaos::Private::SimdMax ( const FSimd4Realf& InL,
const FSimd4Realf& InR
)

  
Public function FSimd4Realf

Chaos::Private::SimdMin ( const FSimd4Realf& InL,
const FSimd4Realf& InR
)

  
Public function FSimd4Vec3f  
Public function FSimd4Vec3f  
Public function FSimd4Realf  
Public function FSimd4Vec3f  
Public function FSimd4Vec3f  
Public function FSimd4Realf 4-wide Math operations
Public function FSimd4Selector  
Public function FSimd4Selector  
Public function FSimd4Selector  
Public function FSimd4Realf

Chaos::Private::SimdSelect ( const FSimd4Selector& InSelector,
const FSimd4Realf& InL,
const FSimd4Realf& InR
)

  
Public function FSimd4Realf  
Public function FSimd4Realf  
Public function FSimd4Vec3f  
Public function FSimd4Realf  
Public function VectorRegister4Float Calculates the cross product of two vectors (XYZ components).
Public function VectorRegister4Double Calculates the cross product of two vectors (XYZ components).
Public function VectorRegister4Float Calculates the dot product of two vectors and returns a vector with the result in the first component.
Public function VectorRegister4Float  
Public function void

Chaos::Process ( PMatrix< T, 3, 3 >& B,
PMatrix< T, 3, 3 >& U,
TVector< T, 3 >& sigma,
PMatrix< T, 3, 3 >& V
)

 Helper function of 3X3 SVD for Processing 2X2 SVD.
Public function FArchive &

Chaos::SerializeReal ( FArchive& Ar,
TVector< T, d >& ValueIn
)

 This is used as
Public function void

Chaos::SingularValueDecomposition ( const PMatrix< T, 2, 2 >& A,
const PMatrix< T, 2, 2 >& U,
const TVector< T, 2 >& Sigma,
const PMatrix< T, 2, 2 >& V,
const T tol
)

 2x2 SVD (singular value decomposition) A=USV'
Public function void

Chaos::SingularValueDecomposition ( const PMatrix< T, 2, 2 >& A,
GivensRotation< T >& U,
const TVector< T, 2 >& Sigma,
GivensRotation< T >& V,
const T tol
)

 2x2 SVD (singular value decomposition) A=USV'
Public function int

Chaos::SingularValueDecomposition ( const PMatrix< T, 3, 3 >& A,
PMatrix< T, 3, 3 >& U,
TVector< T, 3 >& sigma,
PMatrix< T, 3, 3 >& V,
T tol
)

 3X3 SVD (singular value decomposition) A=USV'
Public function void

Chaos::Sort0 ( PMatrix< T, 3, 3 >& U,
TVector< T, 3 >& sigma,
PMatrix< T, 3, 3 >& V
)

 Helper function of 3X3 SVD for sorting singular values.
Public function void

Chaos::Sort1 ( PMatrix< T, 3, 3 >& U,
TVector< T, 3 >& sigma,
PMatrix< T, 3, 3 >& V
)

 Helper function of 3X3 SVD for Sorting singular values.
Public function void

Chaos::SwapCols ( PMatrix< T, 3, 3 >& A,
const int i1,
const int i2
)

 IMPORTANT: test this function before testing polar:
Public function void  
Public function void  
Public function void  
Public function void LWC_TODO : Perf pessimization : this is sub-optimal but will do until we sort the serialization out.
Public function void LWC_TODO : Perf pessimization : this is sub-optimal but will do until we sort the serialization out.
Public function void

Chaos::TryBulkSerializeArrayNDBaseForDoubles ( FArchive& Ar,
TArray< DOUBLE_T >& DoubleTypedArray
)

 LWC_TODO : Perf pessimization : this is sub-optimal but will do until we sort the serialization out.
Public function T

Chaos::WilkinsonShift ( const T a1,
const T b1,
const T a2
)

 Compute WilkinsonShift of the block a1 b1 b1 a2 based on the WilkinsonShift formula mu = c + d - sign (d) \ sqrt (d*d + b*b), where d = (a-c)/2.
Public function void

Chaos::ZeroChase ( PMatrix< T, 3, 3 >& H,
PMatrix< T, 3, 3 >& U,
PMatrix< T, 3, 3 >& V
)

 Zero chasing the 3X3 matrix to bidiagonal form original form of H: x x 0 x x x 0 0 x after zero chase: x x 0 0 x x 0 0 x
Public function T

TMakeVectorRegister ( float X,
float Y,
float Z,
float W
)

  
Public function T

TMakeVectorRegisterConstant ( float X,
float Y,
float Z,
float W
)

  
Public function VectorRegister4Float  
Public function T Copyright Epic Games, Inc. All Rights Reserved.
Public function VectorRegister4Float Combines two vectors using bitwise NOT AND (treating each vector as a 128 bit field)
Public function VectorRegister4Double  
Public function VectorRegister4Int Cast VectorRegister4Float in VectorRegister4Int
Public function VectorRegister4Float Cast VectorRegister4Int in VectorRegister4Float
Public function VectorRegister4Float Moves the lower 2 SP FP values of b to the upper 2 SP FP values of the result.
Public function VectorRegister4Float Selects and interleaves the higher two SP FP values from A and B.
Public function VectorRegister4Float Selects and interleaves the lower two SP FP values from A and B.
Public function VectorRegister4Double Selects and interleaves the lower two DP FP values from A and B.

Variables

  Type Name Description
Public variable bool bRealTypeCompatibleWithISPC ISPC optimization supports float and double, this allows classes that uses ISPC to branch to the right implementation without having to check the actual underlying type of FReal
Public variable const TCHAR *const ChaosVersionGUID NOTE: if you get a merge conflict on the GUID, you must replace it with a new GUID - do not accept the source or target or you will likely get DDC version conflicts resulting in crashes during load.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page