Chaos::Softs::FXPBDSpringConstraints Class Reference

#include <XPBDSpringConstraints.h>

Inheritance diagram for Chaos::Softs::FXPBDSpringConstraints:

Public Member Functions
template<int32 Valence UE_REQUIRES>
	FXPBDSpringConstraints (const FSolverParticlesRange &Particles, const TArray< TVector< int32, Valence > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const TConstArrayView< FRealSingle > &DampingMultipliers, const FSolverVec2 &InStiffness, const FSolverVec2 &InDampingRatio)
template<int32 Valence UE_REQUIRES>
	FXPBDSpringConstraints (const FSolverParticlesRange &Particles, const TArray< TVector< int32, Valence > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const TConstArrayView< FRealSingle > &DampingMultipliers, const FSolverVec2 &InStiffness, const FSolverVec2 &InDampingRatio, bool bTrimKinematicConstraints)
template<int32 Valence UE_REQUIRES>
	FXPBDSpringConstraints (const FSolverParticles &Particles, int32 ParticleOffset, int32 ParticleCount, const TArray< TVector< int32, Valence > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const TConstArrayView< FRealSingle > &DampingMultipliers, const FSolverVec2 &InStiffness, const FSolverVec2 &InDampingRatio)
template<int32 Valence UE_REQUIRES>
	FXPBDSpringConstraints (const FSolverParticles &Particles, int32 ParticleOffset, int32 ParticleCount, const TArray< TVector< int32, Valence > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const TConstArrayView< FRealSingle > &DampingMultipliers, const FSolverVec2 &InStiffness, const FSolverVec2 &InDampingRatio, bool bTrimKinematicConstraints)
virtual	~FXPBDSpringConstraints () override
void	Init () const
void	SetProperties (const FSolverVec2 &InStiffness, const FSolverVec2 &InDampingRatio=FSolverVec2::ZeroVector)
void	ApplyProperties (const FSolverReal Dt, const int32 NumIterations)
template<typename SolverParticlesOrRange >
CHAOS_API void	Apply (SolverParticlesOrRange &Particles, const FSolverReal Dt) const
CHAOS_API void	UpdateLinearSystem (const FSolverParticlesRange &Particles, const FSolverReal Dt, FEvolutionLinearSystem &LinearSystem) const
const TArray< int32 > &	GetConstraintsPerColorStartIndex () const
template<typename SolverParticlesOrRange >
void	InitColor (const SolverParticlesOrRange &Particles)
template<typename SolverParticlesOrRange >
void	Apply (SolverParticlesOrRange &Particles, const FSolverReal Dt) const
Public Member Functions inherited from Chaos::Softs::FPBDSpringConstraintsBase
template<int32 Valence UE_REQUIRES>
	FPBDSpringConstraintsBase (const FSolverParticlesRange &Particles, const TArray< TVector< int32, Valence > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const FSolverVec2 &InStiffness, bool bTrimKinematicConstraints=false, FSolverReal MaxStiffness=FPBDStiffness::DefaultPBDMaxStiffness)
template<int32 Valence UE_REQUIRES>
	FPBDSpringConstraintsBase (const FSolverParticles &Particles, int32 InParticleOffset, int32 InParticleCount, const TArray< TVector< int32, Valence > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const FSolverVec2 &InStiffness, bool bTrimKinematicConstraints=false, FSolverReal MaxStiffness=FPBDStiffness::DefaultPBDMaxStiffness)
virtual	~FPBDSpringConstraintsBase ()
void	SetProperties (const FSolverVec2 &InStiffness)
void	ApplyProperties (const FSolverReal Dt, const int32 NumIterations)
const TArray< TVec2< int32 > > &	GetConstraints () const
void	ResetRestLengths (const TConstArrayView< FSolverVec3 > &Positions)

Static Public Attributes
static constexpr FSolverReal	MinStiffness = (FSolverReal)0
static constexpr FSolverReal	MaxStiffness = (FSolverReal)1e9
static constexpr FSolverReal	MinDampingRatio = (FSolverReal)0.
static constexpr FSolverReal	MaxDampingRatio = (FSolverReal)1000.

Protected Attributes
FPBDWeightMap	DampingRatio
TArray< TVec2< int32 > >	Constraints
const int32	ParticleOffset
const int32	ParticleCount
FPBDStiffness	Stiffness
Protected Attributes inherited from Chaos::Softs::FPBDSpringConstraintsBase
TArray< TVec2< int32 > >	Constraints
TArray< FSolverReal >	Dists
const int32	ParticleOffset
const int32	ParticleCount
FPBDStiffness	Stiffness

Additional Inherited Members
Protected Member Functions inherited from Chaos::Softs::FPBDSpringConstraintsBase
template<typename SolverParticlesOrRange >
FSolverVec3	GetDelta (const SolverParticlesOrRange &Particles, const int32 ConstraintIndex, const FSolverReal ExpStiffnessValue) const
void	CalculateRestLengths (const TConstArrayView< FSolverVec3 > &Positions, const TArrayView< FSolverReal > &DistsToCompute) const

Constructor & Destructor Documentation

FXPBDSpringConstraints() [1/4]

template<int32 Valence UE_REQUIRES>

Chaos::Softs::FXPBDSpringConstraints::FXPBDSpringConstraints ( const FSolverParticlesRange &  Particles, const TArray< TVector< int32, Valence > > &  InConstraints, const TConstArrayView< FRealSingle > &  StiffnessMultipliers, const TConstArrayView< FRealSingle > &  DampingMultipliers, const FSolverVec2 &  InStiffness, const FSolverVec2 &  InDampingRatio  )

inline

FXPBDSpringConstraints() [2/4]

template<int32 Valence UE_REQUIRES>

Chaos::Softs::FXPBDSpringConstraints::FXPBDSpringConstraints ( const FSolverParticlesRange &  Particles, const TArray< TVector< int32, Valence > > &  InConstraints, const TConstArrayView< FRealSingle > &  StiffnessMultipliers, const TConstArrayView< FRealSingle > &  DampingMultipliers, const FSolverVec2 &  InStiffness, const FSolverVec2 &  InDampingRatio, bool  bTrimKinematicConstraints  )

inline

FXPBDSpringConstraints() [3/4]

template<int32 Valence UE_REQUIRES>

Chaos::Softs::FXPBDSpringConstraints::FXPBDSpringConstraints ( const FSolverParticles &  Particles, int32  ParticleOffset, int32  ParticleCount, const TArray< TVector< int32, Valence > > &  InConstraints, const TConstArrayView< FRealSingle > &  StiffnessMultipliers, const TConstArrayView< FRealSingle > &  DampingMultipliers, const FSolverVec2 &  InStiffness, const FSolverVec2 &  InDampingRatio  )

inline

FXPBDSpringConstraints() [4/4]

template<int32 Valence UE_REQUIRES>

Chaos::Softs::FXPBDSpringConstraints::FXPBDSpringConstraints ( const FSolverParticles &  Particles, int32  ParticleOffset, int32  ParticleCount, const TArray< TVector< int32, Valence > > &  InConstraints, const TConstArrayView< FRealSingle > &  StiffnessMultipliers, const TConstArrayView< FRealSingle > &  DampingMultipliers, const FSolverVec2 &  InStiffness, const FSolverVec2 &  InDampingRatio, bool  bTrimKinematicConstraints  )

inline

~FXPBDSpringConstraints()

virtual Chaos::Softs::FXPBDSpringConstraints::~FXPBDSpringConstraints ( )

inlineoverridevirtual

Member Function Documentation

Apply() [1/2]

template<typename SolverParticlesOrRange >

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

Apply() [2/2]

template<typename SolverParticlesOrRange >

CHAOS_API void Chaos::Softs::FXPBDSpringConstraints::Apply	(	SolverParticlesOrRange &	Particles,
		const FSolverReal	Dt
	)		const

ApplyProperties()

void Chaos::Softs::FXPBDSpringConstraints::ApplyProperties ( const FSolverReal  Dt, const int32  NumIterations  )

inline

GetConstraintsPerColorStartIndex()

const TArray< int32 > & Chaos::Softs::FXPBDSpringConstraints::GetConstraintsPerColorStartIndex ( ) const

inline

Init()

void Chaos::Softs::FXPBDSpringConstraints::Init ( ) const

inline

InitColor()

template<typename SolverParticlesOrRange >

void Chaos::Softs::FXPBDSpringConstraints::InitColor

(

const SolverParticlesOrRange &

Particles

)

SetProperties()

void Chaos::Softs::FXPBDSpringConstraints::SetProperties ( const FSolverVec2 &  InStiffness, const FSolverVec2 &  InDampingRatio = FSolverVec2::ZeroVector  )

inline

UpdateLinearSystem()

void Chaos::Softs::FXPBDSpringConstraints::UpdateLinearSystem	(	const FSolverParticlesRange &	Particles,
		const FSolverReal	Dt,
		FEvolutionLinearSystem &	LinearSystem
	)		const

Member Data Documentation

Constraints

TArray<TVec2<int32> > Chaos::Softs::FPBDSpringConstraintsBase::Constraints

protected

DampingRatio

FPBDWeightMap Chaos::Softs::FXPBDSpringConstraints::DampingRatio

protected

MaxDampingRatio

constexpr FSolverReal Chaos::Softs::FXPBDSpringConstraints::MaxDampingRatio = (FSolverReal)1000.

staticconstexpr

MaxStiffness

constexpr FSolverReal Chaos::Softs::FXPBDSpringConstraints::MaxStiffness = (FSolverReal)1e9

staticconstexpr

MinDampingRatio

constexpr FSolverReal Chaos::Softs::FXPBDSpringConstraints::MinDampingRatio = (FSolverReal)0.

staticconstexpr

MinStiffness

constexpr FSolverReal Chaos::Softs::FXPBDSpringConstraints::MinStiffness = (FSolverReal)0

staticconstexpr

ParticleCount

const int32 Chaos::Softs::FPBDSpringConstraintsBase::ParticleCount

protected

ParticleOffset

const int32 Chaos::Softs::FPBDSpringConstraintsBase::ParticleOffset

protected

Stiffness

FPBDStiffness Chaos::Softs::FPBDSpringConstraintsBase::Stiffness

protected

---

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

• Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/XPBDSpringConstraints.h
• Engine/Source/Runtime/Experimental/Chaos/Private/Chaos/XPBDSpringConstraints.cpp