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

#include <XPBDAxialSpringConstraints.h>

+ Inheritance diagram for Chaos::Softs::FXPBDAxialSpringConstraints:

Public Member Functions

 FXPBDAxialSpringConstraints (const FSolverParticlesRange &Particles, const TArray< TVec3< int32 > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const FSolverVec2 &InStiffness, bool bTrimKinematicConstraints)
 
 FXPBDAxialSpringConstraints (const FSolverParticles &Particles, int32 ParticleOffset, int32 ParticleCount, const TArray< TVec3< int32 > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const FSolverVec2 &InStiffness, bool bTrimKinematicConstraints)
 
virtual ~FXPBDAxialSpringConstraints () override
 
void SetProperties (const FSolverVec2 &InStiffness)
 
void ApplyProperties (const FSolverReal, const int32)
 
void Init () const
 
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)
 

Static Public Attributes

static constexpr FSolverReal MinStiffness = (FSolverReal)1e-4
 
static constexpr FSolverReal MaxStiffness = (FSolverReal)1e7
 

Protected Attributes

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

Additional Inherited Members

- 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
 

Constructor & Destructor Documentation

◆ FXPBDAxialSpringConstraints() [1/2]

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

◆ FXPBDAxialSpringConstraints() [2/2]

Chaos::Softs::FXPBDAxialSpringConstraints::FXPBDAxialSpringConstraints ( const FSolverParticles Particles,
int32  ParticleOffset,
int32  ParticleCount,
const TArray< TVec3< int32 > > &  InConstraints,
const TConstArrayView< FRealSingle > &  StiffnessMultipliers,
const FSolverVec2 InStiffness,
bool  bTrimKinematicConstraints 
)
inline

◆ ~FXPBDAxialSpringConstraints()

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

Member Function Documentation

◆ Apply()

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

◆ ApplyProperties()

void Chaos::Softs::FXPBDAxialSpringConstraints::ApplyProperties ( const FSolverReal  ,
const int32   
)
inline

◆ Init()

void Chaos::Softs::FXPBDAxialSpringConstraints::Init ( ) const
inline

◆ SetProperties()

void Chaos::Softs::FXPBDAxialSpringConstraints::SetProperties ( const FSolverVec2 InStiffness)
inline

Member Data Documentation

◆ Constraints

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

◆ MaxStiffness

constexpr FSolverReal Chaos::Softs::FXPBDAxialSpringConstraints::MaxStiffness = (FSolverReal)1e7
staticconstexpr

◆ MinStiffness

constexpr FSolverReal Chaos::Softs::FXPBDAxialSpringConstraints::MinStiffness = (FSolverReal)1e-4
staticconstexpr

◆ 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 file: