Chaos::Softs::FPBDEdgeSpringConstraints Class Reference

#include <PBDSpringConstraints.h>

Inheritance diagram for Chaos::Softs::FPBDEdgeSpringConstraints:

Public Member Functions
	FPBDEdgeSpringConstraints (const FSolverParticlesRange &Particles, const TArray< TVec3< int32 > > &InConstraints, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps, const FCollectionPropertyConstFacade &PropertyCollection, bool bTrimKinematicConstraints=false)
	FPBDEdgeSpringConstraints (const FSolverParticles &Particles, int32 ParticleOffset, int32 ParticleCount, const TArray< TVec3< int32 > > &InConstraints, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps, const FCollectionPropertyConstFacade &PropertyCollection, bool bTrimKinematicConstraints=false)
CHAOS_API	FPBDEdgeSpringConstraints (const FSolverParticlesRange &Particles, const FTriangleMesh &TriangleMesh, const TArray< TVec3< FVec2f > > &FaceVertexPatternPositions, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps, const FCollectionPropertyConstFacade &PropertyCollection, bool bTrimKinematicConstraints=false)
virtual	~FPBDEdgeSpringConstraints () override=default
CHAOS_API void	SetProperties (const FCollectionPropertyConstFacade &PropertyCollection, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps)
CHAOS_API void	ApplyProperties (const FSolverReal Dt, const int32 NumIterations)
CHAOS_API void	ResetRestLengths (const TConstArrayView< FSolverVec3 > &Positions)
	UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME (EdgeSpringStiffness, float)
	UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME (EdgeSpringWarpScale, float)
	UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME (EdgeSpringWeftScale, float)
Public Member Functions inherited from Chaos::Softs::FPBDSpringConstraints
template<int32 Valence>
	FPBDSpringConstraints (const FSolverParticlesRange &Particles, const TArray< TVector< int32, Valence > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const FSolverVec2 &InStiffness, bool bTrimKinematicConstraints=false, bool bInitColor=true, typename TEnableIf< Valence >=2 &&Valence<=4 >::Type *=nullptr)
template<int32 Valence>
	FPBDSpringConstraints (const FSolverParticles &Particles, int32 InParticleOffset, int32 InParticleCount, const TArray< TVector< int32, Valence > > &InConstraints, const TConstArrayView< FRealSingle > &StiffnessMultipliers, const FSolverVec2 &InStiffness, bool bTrimKinematicConstraints=false, bool bInitColor=true, typename TEnableIf< Valence >=2 &&Valence<=4 >::Type *=nullptr)
virtual	~FPBDSpringConstraints () override
template<typename SolverParticlesOrRange >
CHAOS_API void	Apply (SolverParticlesOrRange &Particles, const FSolverReal Dt) const
const TArray< int32 > &	GetConstraintsPerColorStartIndex () const
template<typename SolverParticlesOrRange >
TArray< int32 >	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 Member Functions
static bool	IsEnabled (const FCollectionPropertyConstFacade &PropertyCollection)

Additional Inherited Members
Protected Types inherited from Chaos::Softs::FPBDSpringConstraints
typedef FPBDSpringConstraintsBase	Base
Protected Member Functions inherited from Chaos::Softs::FPBDSpringConstraints
template<typename SolverParticlesOrRange >
CHAOS_API TArray< int32 >	InitColor (const SolverParticlesOrRange &InParticles)
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
Protected Attributes inherited from Chaos::Softs::FPBDSpringConstraints
TArray< TVec2< int32 > >	Constraints
FPBDStiffness	Stiffness
const int32	ParticleOffset
const int32	ParticleCount
Protected Attributes inherited from Chaos::Softs::FPBDSpringConstraintsBase
TArray< TVec2< int32 > >	Constraints
TArray< FSolverReal >	Dists
const int32	ParticleOffset
const int32	ParticleCount
FPBDStiffness	Stiffness

Constructor & Destructor Documentation

FPBDEdgeSpringConstraints() [1/3]

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

inline

FPBDEdgeSpringConstraints() [2/3]

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

inline

FPBDEdgeSpringConstraints() [3/3]

Chaos::Softs::FPBDEdgeSpringConstraints::FPBDEdgeSpringConstraints	(	const FSolverParticlesRange &	Particles,
		const FTriangleMesh &	TriangleMesh,
		const TArray< TVec3< FVec2f > > &	FaceVertexPatternPositions,
		const TMap< FString, TConstArrayView< FRealSingle > > &	WeightMaps,
		const FCollectionPropertyConstFacade &	PropertyCollection,
		bool	bTrimKinematicConstraints = false
	)

This version of the constructor supports Warp and Weft Scale

~FPBDEdgeSpringConstraints()

virtual Chaos::Softs::FPBDEdgeSpringConstraints::~FPBDEdgeSpringConstraints ( )

overridevirtualdefault

Member Function Documentation

ApplyProperties()

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

IsEnabled()

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

inlinestatic

ResetRestLengths()

void Chaos::Softs::FPBDEdgeSpringConstraints::ResetRestLengths

(

const TConstArrayView< FSolverVec3 > &

Positions

)

SetProperties()

void Chaos::Softs::FPBDEdgeSpringConstraints::SetProperties	(	const FCollectionPropertyConstFacade &	PropertyCollection,
		const TMap< FString, TConstArrayView< FRealSingle > > &	WeightMaps
	)

UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME() [1/3]

Chaos::Softs::FPBDEdgeSpringConstraints::UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME	(	EdgeSpringStiffness	,
		float
	)

UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME() [2/3]

Chaos::Softs::FPBDEdgeSpringConstraints::UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME	(	EdgeSpringWarpScale	,
		float
	)

UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME() [3/3]

Chaos::Softs::FPBDEdgeSpringConstraints::UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME	(	EdgeSpringWeftScale	,
		float
	)

---

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

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