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

#include <XPBDEmbeddedSpringConstraints.h>

+ Inheritance diagram for Chaos::Softs::FXPBDVertexConstraints:

Public Member Functions

CHAOS_API FXPBDVertexConstraints (const FSolverParticlesRange &Particles, const FCollectionPropertyConstFacade &PropertyCollection, const FEmbeddedSpringConstraintFacade &SpringConstraintFacade)
 
CHAOS_API void SetProperties (const FCollectionPropertyConstFacade &PropertyCollection)
 
- Public Member Functions inherited from Chaos::Softs::TXPBDEmbeddedSpringConstraints< 1, 1 >
 TXPBDEmbeddedSpringConstraints (const FSolverParticlesRange &Particles, const TConstArrayView< TArray< int32 > > &InSourceIndices, const TConstArrayView< TArray< FRealSingle > > &InSourceWeights, const TConstArrayView< TArray< int32 > > &InTargetIndices, const TConstArrayView< TArray< FRealSingle > > &InTargetWeights, const TConstArrayView< FRealSingle > &InSpringLengths, const TConstArrayView< FRealSingle > &InExtensionStiffnessMultipliers, const TConstArrayView< FRealSingle > &InCompressionStiffnessMultipliers, const TConstArrayView< FRealSingle > &InDampingMultipliers, const FSolverVec2 &InExtensionStiffness, const FSolverVec2 &InCompressionStiffness, const FSolverVec2 &InDampingRatio)
 
virtual ~TXPBDEmbeddedSpringConstraints ()=default
 
void Init ()
 
void ApplyProperties (const FSolverReal, const int32)
 
void Apply (FSolverParticlesRange &Particles, const FSolverReal Dt) const
 
const TArray< TVector< int32, N > > & GetConstraints () const
 
const TArray< TVector< FSolverReal, N > > & GetWeights () const
 
const TArray< FSolverReal > & GetSpringLengths () const
 
FSolverReal GetExtensionStiffness (const int32 ConstraintIndex) const
 
FSolverReal GetCompressionStiffness (const int32 ConstraintIndex) const
 

Static Public Member Functions

static bool IsEnabled (const FCollectionPropertyConstFacade &PropertyCollection)
 

Static Public Attributes

static constexpr FSolverReal DefaultStiffness = (FSolverReal)100.
 
static constexpr FSolverReal DefaultDamping = (FSolverReal)1.
 
- Static Public Attributes inherited from Chaos::Softs::TXPBDEmbeddedSpringConstraints< 1, 1 >
static constexpr FSolverReal MinStiffness
 
static constexpr FSolverReal MaxStiffness
 
static constexpr FSolverReal SoftMaxStiffness
 
static constexpr FSolverReal MinDampingRatio
 
static constexpr FSolverReal MaxDampingRatio
 
static constexpr int32 N
 
static constexpr bool bCanUseISPC
 

Additional Inherited Members

- Protected Attributes inherited from Chaos::Softs::TXPBDEmbeddedSpringConstraints< 1, 1 >
FPBDFlatWeightMap ExtensionStiffness
 
FPBDFlatWeightMap CompressionStiffness
 
FPBDFlatWeightMap DampingRatio
 

Constructor & Destructor Documentation

◆ FXPBDVertexConstraints()

Chaos::Softs::FXPBDVertexConstraints::FXPBDVertexConstraints ( const FSolverParticlesRange Particles,
const FCollectionPropertyConstFacade PropertyCollection,
const FEmbeddedSpringConstraintFacade SpringConstraintFacade 
)

Member Function Documentation

◆ IsEnabled()

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

◆ SetProperties()

void Chaos::Softs::FXPBDVertexConstraints::SetProperties ( const FCollectionPropertyConstFacade PropertyCollection)

Member Data Documentation

◆ DefaultDamping

constexpr FSolverReal Chaos::Softs::FXPBDVertexConstraints::DefaultDamping = (FSolverReal)1.
staticconstexpr

◆ DefaultStiffness

constexpr FSolverReal Chaos::Softs::FXPBDVertexConstraints::DefaultStiffness = (FSolverReal)100.
staticconstexpr

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