UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::FConstraintBase Class Referenceabstract

#include <PBDConstraintBaseData.h>

+ Inheritance diagram for Chaos::FConstraintBase:

Public Types

typedef TVector< TGeometryParticleHandle< FReal, 3 > *, 2 > FParticleHandlePair
 

Public Member Functions

virtual ~FConstraintBase ()
 
CHAOS_API FConstraintBase (EConstraintType InType)
 
EConstraintType GetType () const
 
bool IsType (EConstraintType InType)
 
CHAOS_API bool IsValid () const
 
bool IsDirty () const
 
bool IsDirty (const EChaosPropertyFlags CheckBits) const
 
void ClearDirtyFlags ()
 
const FDirtyChaosPropertyFlagsGetDirtyFlags () const
 
template<typename T = IPhysicsProxyBase>
T * GetProxy ()
 
CHAOS_API void SetProxy (IPhysicsProxyBase *InProxy)
 
void SyncRemoteData (FDirtyPropertiesManager &Manager, int32 DataIdx, FDirtyChaosProperties &RemoteData)
 

Protected Member Functions

virtual void SyncRemoteDataImp (FDirtyPropertiesManager &Manager, int32 DataIdx, FDirtyChaosProperties &RemoteData)=0
 

Protected Attributes

EConstraintType Type
 
class IPhysicsProxyBaseProxy
 
FDirtyChaosPropertyFlags DirtyFlags
 

Member Typedef Documentation

◆ FParticleHandlePair

Constructor & Destructor Documentation

◆ ~FConstraintBase()

virtual Chaos::FConstraintBase::~FConstraintBase ( )
inlinevirtual

◆ FConstraintBase()

Chaos::FConstraintBase::FConstraintBase ( EConstraintType  InType)

Member Function Documentation

◆ ClearDirtyFlags()

void Chaos::FConstraintBase::ClearDirtyFlags ( )
inline

◆ GetDirtyFlags()

const FDirtyChaosPropertyFlags & Chaos::FConstraintBase::GetDirtyFlags ( ) const
inline

◆ GetProxy()

template<typename T = IPhysicsProxyBase>
T * Chaos::FConstraintBase::GetProxy ( )
inline

◆ GetType()

EConstraintType Chaos::FConstraintBase::GetType ( ) const
inline

◆ IsDirty() [1/2]

bool Chaos::FConstraintBase::IsDirty ( ) const
inline

◆ IsDirty() [2/2]

bool Chaos::FConstraintBase::IsDirty ( const EChaosPropertyFlags  CheckBits) const
inline

◆ IsType()

bool Chaos::FConstraintBase::IsType ( EConstraintType  InType)
inline

◆ IsValid()

bool Chaos::FConstraintBase::IsValid ( ) const

◆ SetProxy()

void Chaos::FConstraintBase::SetProxy ( IPhysicsProxyBase InProxy)

◆ SyncRemoteData()

void Chaos::FConstraintBase::SyncRemoteData ( FDirtyPropertiesManager Manager,
int32  DataIdx,
FDirtyChaosProperties RemoteData 
)
inline

◆ SyncRemoteDataImp()

virtual void Chaos::FConstraintBase::SyncRemoteDataImp ( FDirtyPropertiesManager Manager,
int32  DataIdx,
FDirtyChaosProperties RemoteData 
)
protectedpure virtual

Member Data Documentation

◆ DirtyFlags

FDirtyChaosPropertyFlags Chaos::FConstraintBase::DirtyFlags
protected

◆ Proxy

class IPhysicsProxyBase* Chaos::FConstraintBase::Proxy
protected

◆ Type

EConstraintType Chaos::FConstraintBase::Type
protected

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