UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
Chaos::Softs::FPBDAnimDriveConstraint Class Referencefinal

#include <PBDAnimDriveConstraint.h>

Public Member Functions

 FPBDAnimDriveConstraint (const int32 InParticleOffset, const int32 InParticleCount, const TArray< FSolverVec3 > &InAnimationPositions, const TArray< FSolverVec3 > &InAnimationVelocities, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps, const FCollectionPropertyConstFacade &PropertyCollection)
 
 FPBDAnimDriveConstraint (const int32 InParticleOffset, const int32 InParticleCount, const TArray< FSolverVec3 > &InAnimationPositions, const TArray< FSolverVec3 > &, const TArray< FSolverVec3 > &InAnimationVelocities, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const TConstArrayView< FRealSingle > &DampingMultipliers)
 
 ~FPBDAnimDriveConstraint ()
 
FSolverVec2 GetStiffness () const
 
FSolverVec2 GetDamping () const
 
void SetProperties (const FCollectionPropertyConstFacade &PropertyCollection, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps)
 
void SetProperties (const FSolverVec2 &InStiffness, const FSolverVec2 &InDamping)
 
void ApplyProperties (const FSolverReal Dt, const int32 NumIterations)
 
TConstArrayView< FSolverVec3 > GetConstArrayView (const FSolverParticles &Particles, const TArray< FSolverVec3 > &Data) const
 
TConstArrayView< FSolverVec3 > GetConstArrayView (const FSolverParticlesRange &Particles, const TArray< FSolverVec3 > &Data) const
 
template<typename SolverParticlesOrRange >
void Apply (SolverParticlesOrRange &InParticles, const FSolverReal Dt) const
 
 UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME (AnimDriveStiffness, float)
 
 UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME (AnimDriveDamping, float)
 

Static Public Member Functions

static bool IsEnabled (const FCollectionPropertyConstFacade &PropertyCollection)
 

Constructor & Destructor Documentation

◆ FPBDAnimDriveConstraint() [1/2]

Chaos::Softs::FPBDAnimDriveConstraint::FPBDAnimDriveConstraint ( const int32  InParticleOffset,
const int32  InParticleCount,
const TArray< FSolverVec3 > &  InAnimationPositions,
const TArray< FSolverVec3 > &  InAnimationVelocities,
const TMap< FString, TConstArrayView< FRealSingle > > &  WeightMaps,
const FCollectionPropertyConstFacade &  PropertyCollection 
)
inline

◆ FPBDAnimDriveConstraint() [2/2]

Chaos::Softs::FPBDAnimDriveConstraint::FPBDAnimDriveConstraint ( const int32  InParticleOffset,
const int32  InParticleCount,
const TArray< FSolverVec3 > &  InAnimationPositions,
const TArray< FSolverVec3 > &  ,
const TArray< FSolverVec3 > &  InAnimationVelocities,
const TConstArrayView< FRealSingle > &  StiffnessMultipliers,
const TConstArrayView< FRealSingle > &  DampingMultipliers 
)
inline

◆ ~FPBDAnimDriveConstraint()

Chaos::Softs::FPBDAnimDriveConstraint::~FPBDAnimDriveConstraint ( )
inline

Member Function Documentation

◆ Apply()

template<typename SolverParticlesOrRange >
void Chaos::Softs::FPBDAnimDriveConstraint::Apply ( SolverParticlesOrRange &  InParticles,
const FSolverReal  Dt 
) const
inline

◆ ApplyProperties()

void Chaos::Softs::FPBDAnimDriveConstraint::ApplyProperties ( const FSolverReal  Dt,
const int32  NumIterations 
)
inline

◆ GetConstArrayView() [1/2]

TConstArrayView< FSolverVec3 > Chaos::Softs::FPBDAnimDriveConstraint::GetConstArrayView ( const FSolverParticles &  Particles,
const TArray< FSolverVec3 > &  Data 
) const
inline

◆ GetConstArrayView() [2/2]

TConstArrayView< FSolverVec3 > Chaos::Softs::FPBDAnimDriveConstraint::GetConstArrayView ( const FSolverParticlesRange &  Particles,
const TArray< FSolverVec3 > &  Data 
) const
inline

◆ GetDamping()

FSolverVec2 Chaos::Softs::FPBDAnimDriveConstraint::GetDamping ( ) const
inline

◆ GetStiffness()

FSolverVec2 Chaos::Softs::FPBDAnimDriveConstraint::GetStiffness ( ) const
inline

◆ IsEnabled()

static bool Chaos::Softs::FPBDAnimDriveConstraint::IsEnabled ( const FCollectionPropertyConstFacade &  PropertyCollection)
inlinestatic

◆ SetProperties() [1/2]

void Chaos::Softs::FPBDAnimDriveConstraint::SetProperties ( const FCollectionPropertyConstFacade &  PropertyCollection,
const TMap< FString, TConstArrayView< FRealSingle > > &  WeightMaps 
)
inline

◆ SetProperties() [2/2]

void Chaos::Softs::FPBDAnimDriveConstraint::SetProperties ( const FSolverVec2 &  InStiffness,
const FSolverVec2 &  InDamping 
)
inline

◆ UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME() [1/2]

Chaos::Softs::FPBDAnimDriveConstraint::UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME ( AnimDriveDamping  ,
float   
)

◆ UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME() [2/2]

Chaos::Softs::FPBDAnimDriveConstraint::UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME ( AnimDriveStiffness  ,
float   
)
The documentation for this class was generated from the following file: