UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target > Class Template Reference

#include <XPBDEmbeddedSpringConstraints.h>

Public Member Functions

 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 Attributes

static constexpr FSolverReal MinStiffness = (FSolverReal)0
 
static constexpr FSolverReal MaxStiffness = (FSolverReal)UE_BIG_NUMBER
 
static constexpr FSolverReal SoftMaxStiffness = (FSolverReal)1e14
 
static constexpr FSolverReal MinDampingRatio = (FSolverReal)0.
 
static constexpr FSolverReal MaxDampingRatio = (FSolverReal)1000.
 
static constexpr int32 N = Source + Target
 
static constexpr bool bCanUseISPC = INTEL_ISPC && TIsXPBDEmbeddedSpringSizePrecompiled<Source, Target>::Value
 

Protected Attributes

FPBDFlatWeightMap ExtensionStiffness
 
FPBDFlatWeightMap CompressionStiffness
 
FPBDFlatWeightMap DampingRatio
 

Constructor & Destructor Documentation

◆ TXPBDEmbeddedSpringConstraints()

template<int32 Source, int32 Target>
Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::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 
)

◆ ~TXPBDEmbeddedSpringConstraints()

Member Function Documentation

◆ Apply()

template<int32 Source, int32 Target>
void Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::Apply ( FSolverParticlesRange Particles,
const FSolverReal  Dt 
) const

◆ ApplyProperties()

template<int32 Source, int32 Target>
void Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::ApplyProperties ( const FSolverReal  ,
const int32   
)
inline

◆ GetCompressionStiffness()

template<int32 Source, int32 Target>
FSolverReal Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::GetCompressionStiffness ( const int32  ConstraintIndex) const
inline

◆ GetConstraints()

template<int32 Source, int32 Target>
const TArray< TVector< int32, N > > & Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::GetConstraints ( ) const
inline

◆ GetExtensionStiffness()

template<int32 Source, int32 Target>
FSolverReal Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::GetExtensionStiffness ( const int32  ConstraintIndex) const
inline

◆ GetSpringLengths()

template<int32 Source, int32 Target>
const TArray< FSolverReal > & Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::GetSpringLengths ( ) const
inline

◆ GetWeights()

template<int32 Source, int32 Target>
const TArray< TVector< FSolverReal, N > > & Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::GetWeights ( ) const
inline

◆ Init()

template<int32 Source, int32 Target>
void Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::Init ( )
inline

Member Data Documentation

◆ bCanUseISPC

template<int32 Source, int32 Target>
constexpr bool Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::bCanUseISPC = INTEL_ISPC && TIsXPBDEmbeddedSpringSizePrecompiled<Source, Target>::Value
staticconstexpr

◆ CompressionStiffness

template<int32 Source, int32 Target>
FPBDFlatWeightMap Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::CompressionStiffness
protected

◆ DampingRatio

template<int32 Source, int32 Target>
FPBDFlatWeightMap Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::DampingRatio
protected

◆ ExtensionStiffness

template<int32 Source, int32 Target>
FPBDFlatWeightMap Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::ExtensionStiffness
protected

◆ MaxDampingRatio

template<int32 Source, int32 Target>
constexpr FSolverReal Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::MaxDampingRatio = (FSolverReal)1000.
staticconstexpr

◆ MaxStiffness

template<int32 Source, int32 Target>
constexpr FSolverReal Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::MaxStiffness = (FSolverReal)UE_BIG_NUMBER
staticconstexpr

◆ MinDampingRatio

template<int32 Source, int32 Target>
constexpr FSolverReal Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::MinDampingRatio = (FSolverReal)0.
staticconstexpr

◆ MinStiffness

template<int32 Source, int32 Target>
constexpr FSolverReal Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::MinStiffness = (FSolverReal)0
staticconstexpr

◆ N

template<int32 Source, int32 Target>
constexpr int32 Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::N = Source + Target
staticconstexpr

◆ SoftMaxStiffness

template<int32 Source, int32 Target>
constexpr FSolverReal Chaos::Softs::TXPBDEmbeddedSpringConstraints< Source, Target >::SoftMaxStiffness = (FSolverReal)1e14
staticconstexpr

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