UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::Private::TIterationSettings< TIndexType > Class Template Reference

#include <IterationSettings.h>

Public Member Functions

 TIterationSettings ()
 
 TIterationSettings (const int32 InNumPositionIterations, const int32 InNumVelocityIterations, const int32 InNumProjectionInterations)
 
int32 GetNumPositionIterations () const
 
int32 GetNumVelocityIterations () const
 
int32 GetNumProjectionIterations () const
 
void SetNumPositionIterations (const int32 InNum)
 
void SetNumVelocityIterations (const int32 InNum)
 
void SetNumProjectionIterations (const int32 InNum)
 

Static Public Member Functions

static TIterationSettings< FIndexType > MakeEmpty ()
 
template<typename TOtherIndex >
static TIterationSettings< FIndexType > Merge (const TIterationSettings< FIndexType > &L, const TIterationSettings< TOtherIndex > &R)
 

Static Public Attributes

static const int32 InvalidIterations = INDEX_NONE
 
static const int32 MaxIterations = std::numeric_limits<FIndexType>::max()
 

Friends

bool operator== (const TIterationSettings &L, const TIterationSettings &R)
 
bool operator!= (const TIterationSettings &L, const TIterationSettings &R)
 

Detailed Description

template<typename TIndexType>
class Chaos::Private::TIterationSettings< TIndexType >

Iteration counts for use by bodies and constraints. A simulation island will use the maximum number of iterations of any body or constraint in the island. Iteration counts may be -1 which indicates that the configuration setting should be used.

Constructor & Destructor Documentation

◆ TIterationSettings() [1/2]

template<typename TIndexType >
Chaos::Private::TIterationSettings< TIndexType >::TIterationSettings ( )
inline

◆ TIterationSettings() [2/2]

template<typename TIndexType >
Chaos::Private::TIterationSettings< TIndexType >::TIterationSettings ( const int32  InNumPositionIterations,
const int32  InNumVelocityIterations,
const int32  InNumProjectionInterations 
)
inline

Member Function Documentation

◆ GetNumPositionIterations()

template<typename TIndexType >
int32 Chaos::Private::TIterationSettings< TIndexType >::GetNumPositionIterations ( ) const
inline

◆ GetNumProjectionIterations()

template<typename TIndexType >
int32 Chaos::Private::TIterationSettings< TIndexType >::GetNumProjectionIterations ( ) const
inline

◆ GetNumVelocityIterations()

template<typename TIndexType >
int32 Chaos::Private::TIterationSettings< TIndexType >::GetNumVelocityIterations ( ) const
inline

◆ MakeEmpty()

template<typename TIndexType >
static TIterationSettings< FIndexType > Chaos::Private::TIterationSettings< TIndexType >::MakeEmpty ( )
inlinestatic

◆ Merge()

template<typename TIndexType >
template<typename TOtherIndex >
static TIterationSettings< FIndexType > Chaos::Private::TIterationSettings< TIndexType >::Merge ( const TIterationSettings< FIndexType > &  L,
const TIterationSettings< TOtherIndex > &  R 
)
inlinestatic

◆ SetNumPositionIterations()

template<typename TIndexType >
void Chaos::Private::TIterationSettings< TIndexType >::SetNumPositionIterations ( const int32  InNum)
inline

◆ SetNumProjectionIterations()

template<typename TIndexType >
void Chaos::Private::TIterationSettings< TIndexType >::SetNumProjectionIterations ( const int32  InNum)
inline

◆ SetNumVelocityIterations()

template<typename TIndexType >
void Chaos::Private::TIterationSettings< TIndexType >::SetNumVelocityIterations ( const int32  InNum)
inline

Friends And Related Symbol Documentation

◆ operator!=

template<typename TIndexType >
bool operator!= ( const TIterationSettings< TIndexType > &  L,
const TIterationSettings< TIndexType > &  R 
)
friend

◆ operator==

template<typename TIndexType >
bool operator== ( const TIterationSettings< TIndexType > &  L,
const TIterationSettings< TIndexType > &  R 
)
friend

Member Data Documentation

◆ InvalidIterations

template<typename TIndexType >
const int32 Chaos::Private::TIterationSettings< TIndexType >::InvalidIterations = INDEX_NONE
static

◆ MaxIterations

template<typename TIndexType >
const int32 Chaos::Private::TIterationSettings< TIndexType >::MaxIterations = std::numeric_limits<FIndexType>::max()
static

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