UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::Softs::FPBDAxialSpringConstraints Class Reference

#include <PBDAxialSpringConstraints.h>

+ Inheritance diagram for Chaos::Softs::FPBDAxialSpringConstraints:

Public Member Functions

 FPBDAxialSpringConstraints (const FSolverParticlesRange &Particles, const TArray< TVec3< int32 > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const FSolverVec2 &InStiffness, bool bTrimKinematicConstraints, bool bInitColor=true)
 
 FPBDAxialSpringConstraints (const FSolverParticles &Particles, int32 InParticleOffset, int32 InParticleCount, const TArray< TVec3< int32 > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const FSolverVec2 &InStiffness, bool bTrimKinematicConstraints, bool bInitColor=true)
 
virtual ~FPBDAxialSpringConstraints () override
 
template<typename SolverParticlesOrRange >
CHAOS_API void Apply (SolverParticlesOrRange &InParticles, const FSolverReal Dt) const
 
template<typename SolverParticlesOrRange >
TArray< int32InitColor (const SolverParticlesOrRange &InParticles)
 
template<typename SolverParticlesOrRange >
void Apply (SolverParticlesOrRange &Particles, const FSolverReal Dt) const
 
- Public Member Functions inherited from Chaos::Softs::FPBDAxialSpringConstraintsBase
 FPBDAxialSpringConstraintsBase (const FSolverParticlesRange &Particles, const TArray< TVec3< int32 > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const FSolverVec2 &InStiffness, bool bTrimKinematicConstraints, FSolverReal MaxStiffness=FPBDStiffness::DefaultPBDMaxStiffness)
 
 FPBDAxialSpringConstraintsBase (const FSolverParticles &Particles, int32 InParticleOffset, int32 InParticleCount, const TArray< TVec3< int32 > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const FSolverVec2 &InStiffness, bool bTrimKinematicConstraints, FSolverReal MaxStiffness=FPBDStiffness::DefaultPBDMaxStiffness)
 
virtual ~FPBDAxialSpringConstraintsBase ()
 
void SetProperties (const FSolverVec2 &InStiffness)
 
void ApplyProperties (const FSolverReal Dt, const int32 NumIterations)
 
const TArray< TVec3< int32 > > & GetConstraints () const
 
const TArray< FSolverReal > & GetBarys () const
 
void ResetRestLengths (const TConstArrayView< FSolverVec3 > &Positions)
 

Protected Member Functions

template<typename SolverParticlesOrRange >
CHAOS_API TArray< int32InitColor (const SolverParticlesOrRange &InParticles)
 
- Protected Member Functions inherited from Chaos::Softs::FPBDAxialSpringConstraintsBase
void CalculateRestLengths (const TConstArrayView< FSolverVec3 > &Positions, const TArrayView< FSolverReal > &DistsToCompute) const
 
template<typename VectorType >
VectorType GetSpringDiff (const VectorType &P1, const VectorType &P2, const VectorType &P3, const FSolverReal Bary) const
 
template<typename SolverParticlesOrRange >
FSolverVec3 GetDelta (const SolverParticlesOrRange &Particles, const int32 ConstraintIndex, const FSolverReal ExpStiffnessValue) const
 

Protected Attributes

TArray< TVec3< int32 > > Constraints
 
TArray< FSolverRealBarys
 
FPBDStiffness Stiffness
 
const int32 ParticleOffset
 
const int32 ParticleCount
 
- Protected Attributes inherited from Chaos::Softs::FPBDAxialSpringConstraintsBase
TArray< TVec3< int32 > > Constraints
 
const int32 ParticleOffset
 
const int32 ParticleCount
 
TArray< FSolverRealBarys
 
TArray< FSolverRealDists
 
FPBDStiffness Stiffness
 

Constructor & Destructor Documentation

◆ FPBDAxialSpringConstraints() [1/2]

Chaos::Softs::FPBDAxialSpringConstraints::FPBDAxialSpringConstraints ( const FSolverParticlesRange Particles,
const TArray< TVec3< int32 > > &  InConstraints,
const TConstArrayView< FRealSingle > &  StiffnessMultipliers,
const FSolverVec2 InStiffness,
bool  bTrimKinematicConstraints,
bool  bInitColor = true 
)
inline

◆ FPBDAxialSpringConstraints() [2/2]

Chaos::Softs::FPBDAxialSpringConstraints::FPBDAxialSpringConstraints ( const FSolverParticles Particles,
int32  InParticleOffset,
int32  InParticleCount,
const TArray< TVec3< int32 > > &  InConstraints,
const TConstArrayView< FRealSingle > &  StiffnessMultipliers,
const FSolverVec2 InStiffness,
bool  bTrimKinematicConstraints,
bool  bInitColor = true 
)
inline

◆ ~FPBDAxialSpringConstraints()

virtual Chaos::Softs::FPBDAxialSpringConstraints::~FPBDAxialSpringConstraints ( )
inlineoverridevirtual

Member Function Documentation

◆ Apply() [1/2]

CHAOS_API void Chaos::Softs::FPBDAxialSpringConstraints::Apply ( SolverParticlesOrRange InParticles,
const FSolverReal  Dt 
) const

◆ Apply() [2/2]

void Chaos::Softs::FPBDAxialSpringConstraints::Apply ( SolverParticlesOrRange Particles,
const FSolverReal  Dt 
) const

◆ InitColor() [1/2]

TArray< int32 > Chaos::Softs::FPBDAxialSpringConstraints::InitColor ( const SolverParticlesOrRange InParticles)

◆ InitColor() [2/2]

CHAOS_API TArray< int32 > Chaos::Softs::FPBDAxialSpringConstraints::InitColor ( const SolverParticlesOrRange InParticles)
protected

Member Data Documentation

◆ Barys

TArray<FSolverReal> Chaos::Softs::FPBDAxialSpringConstraintsBase::Barys
protected

◆ Constraints

TArray<TVec3<int32> > Chaos::Softs::FPBDAxialSpringConstraintsBase::Constraints
protected

◆ ParticleCount

const int32 Chaos::Softs::FPBDAxialSpringConstraintsBase::ParticleCount
protected

◆ ParticleOffset

const int32 Chaos::Softs::FPBDAxialSpringConstraintsBase::ParticleOffset
protected

◆ Stiffness

FPBDStiffness Chaos::Softs::FPBDAxialSpringConstraintsBase::Stiffness
protected

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