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::FXPBDAreaSpringConstraints Class Referencefinal

#include <XPBDAxialSpringConstraints.h>

+ Inheritance diagram for Chaos::Softs::FXPBDAreaSpringConstraints:

Public Member Functions

 FXPBDAreaSpringConstraints (const FSolverParticlesRange &Particles, const TArray< TVec3< int32 > > &InConstraints, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps, const FCollectionPropertyConstFacade &PropertyCollection, bool bTrimKinematicConstraints)
 
 FXPBDAreaSpringConstraints (const FSolverParticles &Particles, int32 ParticleOffset, int32 ParticleCount, const TArray< TVec3< int32 > > &InConstraints, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps, const FCollectionPropertyConstFacade &PropertyCollection, bool bTrimKinematicConstraints)
 
virtual ~FXPBDAreaSpringConstraints () override=default
 
void SetProperties (const FCollectionPropertyConstFacade &PropertyCollection, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps)
 
- Public Member Functions inherited from Chaos::Softs::FXPBDAxialSpringConstraints
 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 Member Functions

static bool IsEnabled (const FCollectionPropertyConstFacade &PropertyCollection)
 

Additional Inherited Members

- Static Public Attributes inherited from Chaos::Softs::FXPBDAxialSpringConstraints
static constexpr FSolverReal MinStiffness = (FSolverReal)1e-4
 
static constexpr FSolverReal MaxStiffness = (FSolverReal)1e7
 
- 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 inherited from Chaos::Softs::FXPBDAxialSpringConstraints
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< FSolverReal > Barys
 
TArray< FSolverReal > Dists
 
FPBDStiffness Stiffness
 

Constructor & Destructor Documentation

◆ FXPBDAreaSpringConstraints() [1/2]

Chaos::Softs::FXPBDAreaSpringConstraints::FXPBDAreaSpringConstraints ( const FSolverParticlesRange &  Particles,
const TArray< TVec3< int32 > > &  InConstraints,
const TMap< FString, TConstArrayView< FRealSingle > > &  WeightMaps,
const FCollectionPropertyConstFacade &  PropertyCollection,
bool  bTrimKinematicConstraints 
)
inline

◆ FXPBDAreaSpringConstraints() [2/2]

Chaos::Softs::FXPBDAreaSpringConstraints::FXPBDAreaSpringConstraints ( const FSolverParticles &  Particles,
int32  ParticleOffset,
int32  ParticleCount,
const TArray< TVec3< int32 > > &  InConstraints,
const TMap< FString, TConstArrayView< FRealSingle > > &  WeightMaps,
const FCollectionPropertyConstFacade &  PropertyCollection,
bool  bTrimKinematicConstraints 
)
inline

◆ ~FXPBDAreaSpringConstraints()

virtual Chaos::Softs::FXPBDAreaSpringConstraints::~FXPBDAreaSpringConstraints ( )
overridevirtualdefault

Member Function Documentation

◆ IsEnabled()

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

◆ SetProperties()

void Chaos::Softs::FXPBDAreaSpringConstraints::SetProperties ( const FCollectionPropertyConstFacade &  PropertyCollection,
const TMap< FString, TConstArrayView< FRealSingle > > &  WeightMaps 
)
inline
The documentation for this class was generated from the following file: