UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Chaos::Softs::FPBDSpringConstraintsBase Class Reference

#include <PBDSpringConstraintsBase.h>

+ Inheritance diagram for Chaos::Softs::FPBDSpringConstraintsBase:

Public Member Functions

template<int32 Valence UE_REQUIRES>
 FPBDSpringConstraintsBase (const FSolverParticlesRange &Particles, const TArray< TVector< int32, Valence > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const FSolverVec2 &InStiffness, bool bTrimKinematicConstraints=false, FSolverReal MaxStiffness=FPBDStiffness::DefaultPBDMaxStiffness)
 
template<int32 Valence UE_REQUIRES>
 FPBDSpringConstraintsBase (const FSolverParticles &Particles, int32 InParticleOffset, int32 InParticleCount, const TArray< TVector< int32, Valence > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const FSolverVec2 &InStiffness, bool bTrimKinematicConstraints=false, FSolverReal MaxStiffness=FPBDStiffness::DefaultPBDMaxStiffness)
 
virtual ~FPBDSpringConstraintsBase ()
 
void SetProperties (const FSolverVec2 &InStiffness)
 
void ApplyProperties (const FSolverReal Dt, const int32 NumIterations)
 
const TArray< TVec2< int32 > > & GetConstraints () const
 
void ResetRestLengths (const TConstArrayView< FSolverVec3 > &Positions)
 

Protected Member Functions

template<typename SolverParticlesOrRange >
FSolverVec3 GetDelta (const SolverParticlesOrRange &Particles, const int32 ConstraintIndex, const FSolverReal ExpStiffnessValue) const
 
void CalculateRestLengths (const TConstArrayView< FSolverVec3 > &Positions, const TArrayView< FSolverReal > &DistsToCompute) const
 

Protected Attributes

TArray< TVec2< int32 > > Constraints
 
TArray< FSolverReal > Dists
 
const int32 ParticleOffset
 
const int32 ParticleCount
 
FPBDStiffness Stiffness
 

Constructor & Destructor Documentation

◆ FPBDSpringConstraintsBase() [1/2]

template<int32 Valence UE_REQUIRES>
Chaos::Softs::FPBDSpringConstraintsBase::FPBDSpringConstraintsBase ( const FSolverParticlesRange &  Particles,
const TArray< TVector< int32, Valence > > &  InConstraints,
const TConstArrayView< FRealSingle > &  StiffnessMultipliers,
const FSolverVec2 &  InStiffness,
bool  bTrimKinematicConstraints = false,
FSolverReal  MaxStiffness = FPBDStiffness::DefaultPBDMaxStiffness 
)
inline

◆ FPBDSpringConstraintsBase() [2/2]

template<int32 Valence UE_REQUIRES>
Chaos::Softs::FPBDSpringConstraintsBase::FPBDSpringConstraintsBase ( const FSolverParticles &  Particles,
int32  InParticleOffset,
int32  InParticleCount,
const TArray< TVector< int32, Valence > > &  InConstraints,
const TConstArrayView< FRealSingle > &  StiffnessMultipliers,
const FSolverVec2 &  InStiffness,
bool  bTrimKinematicConstraints = false,
FSolverReal  MaxStiffness = FPBDStiffness::DefaultPBDMaxStiffness 
)
inline

◆ ~FPBDSpringConstraintsBase()

virtual Chaos::Softs::FPBDSpringConstraintsBase::~FPBDSpringConstraintsBase ( )
inlinevirtual

Member Function Documentation

◆ ApplyProperties()

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

◆ CalculateRestLengths()

void Chaos::Softs::FPBDSpringConstraintsBase::CalculateRestLengths ( const TConstArrayView< FSolverVec3 > &  Positions,
const TArrayView< FSolverReal > &  DistsToCompute 
) const
inlineprotected

◆ GetConstraints()

const TArray< TVec2< int32 > > & Chaos::Softs::FPBDSpringConstraintsBase::GetConstraints ( ) const
inline

◆ GetDelta()

template<typename SolverParticlesOrRange >
FSolverVec3 Chaos::Softs::FPBDSpringConstraintsBase::GetDelta ( const SolverParticlesOrRange &  Particles,
const int32  ConstraintIndex,
const FSolverReal  ExpStiffnessValue 
) const
inlineprotected

◆ ResetRestLengths()

void Chaos::Softs::FPBDSpringConstraintsBase::ResetRestLengths ( const TConstArrayView< FSolverVec3 > &  Positions)
inline

◆ SetProperties()

void Chaos::Softs::FPBDSpringConstraintsBase::SetProperties ( const FSolverVec2 &  InStiffness)
inline

Member Data Documentation

◆ Constraints

TArray<TVec2<int32> > Chaos::Softs::FPBDSpringConstraintsBase::Constraints
protected

◆ Dists

TArray<FSolverReal> Chaos::Softs::FPBDSpringConstraintsBase::Dists
protected

◆ ParticleCount

const int32 Chaos::Softs::FPBDSpringConstraintsBase::ParticleCount
protected

◆ ParticleOffset

const int32 Chaos::Softs::FPBDSpringConstraintsBase::ParticleOffset
protected

◆ Stiffness

FPBDStiffness Chaos::Softs::FPBDSpringConstraintsBase::Stiffness
protected
The documentation for this class was generated from the following file: