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

#include <SoftsExternalForces.h>

+ Inheritance diagram for Chaos::Softs::FExternalForcesBase:

Public Member Functions

 FExternalForcesBase (const FSolverParticlesRange &Particles, const FSolverVec3 &InGravity, const FSolverVec2 &InGravityScale, const TConstArrayView< FRealSingle > &InGravityScaleMultipliers, const TArray< FSolverVec3 > &InNormals)
 
virtual ~FExternalForcesBase ()
 
void Apply (FSolverParticlesRange &Particles, const FSolverReal Dt) const
 
void UpdateLinearSystem (const FSolverParticlesRange &Particles, const FSolverReal Dt, FEvolutionLinearSystem &LinearSystem) const
 
bool UsePointBasedWindModel () const
 
const FSolverVec3GetGravity () const
 
bool HasPerParticleGravity () const
 
FSolverVec3 GetScaledGravity (int32 ParticleIndex) const
 
const FSolverVec3GetFictitiousAngularVelocity () const
 
const FSolverVec3GetReferenceSpaceLocation () const
 

Protected Attributes

FSolverVec3 Gravity
 
bool bApplyGravityScale
 
FPBDFlatWeightMap GravityScale
 
FSolverVec3 FictitiousAngularVelocity
 
FSolverVec3 ReferenceSpaceLocation
 
bool bUsePointBasedWindModel
 
FSolverVec3 PointBasedWind
 
FSolverReal LegacyWindAdaptation
 
const TArray< FSolverVec3 > & Normals
 

Constructor & Destructor Documentation

◆ FExternalForcesBase()

Chaos::Softs::FExternalForcesBase::FExternalForcesBase ( const FSolverParticlesRange Particles,
const FSolverVec3 InGravity,
const FSolverVec2 InGravityScale,
const TConstArrayView< FRealSingle > &  InGravityScaleMultipliers,
const TArray< FSolverVec3 > &  InNormals 
)
inline

◆ ~FExternalForcesBase()

virtual Chaos::Softs::FExternalForcesBase::~FExternalForcesBase ( )
inlinevirtual

Member Function Documentation

◆ Apply()

void Chaos::Softs::FExternalForcesBase::Apply ( FSolverParticlesRange Particles,
const FSolverReal  Dt 
) const
inline

◆ GetFictitiousAngularVelocity()

const FSolverVec3 & Chaos::Softs::FExternalForcesBase::GetFictitiousAngularVelocity ( ) const
inline

◆ GetGravity()

const FSolverVec3 & Chaos::Softs::FExternalForcesBase::GetGravity ( ) const
inline

◆ GetReferenceSpaceLocation()

const FSolverVec3 & Chaos::Softs::FExternalForcesBase::GetReferenceSpaceLocation ( ) const
inline

◆ GetScaledGravity()

FSolverVec3 Chaos::Softs::FExternalForcesBase::GetScaledGravity ( int32  ParticleIndex) const
inline

◆ HasPerParticleGravity()

bool Chaos::Softs::FExternalForcesBase::HasPerParticleGravity ( ) const
inline

◆ UpdateLinearSystem()

void Chaos::Softs::FExternalForcesBase::UpdateLinearSystem ( const FSolverParticlesRange Particles,
const FSolverReal  Dt,
FEvolutionLinearSystem LinearSystem 
) const
inline

◆ UsePointBasedWindModel()

bool Chaos::Softs::FExternalForcesBase::UsePointBasedWindModel ( ) const
inline

Member Data Documentation

◆ bApplyGravityScale

bool Chaos::Softs::FExternalForcesBase::bApplyGravityScale
protected

◆ bUsePointBasedWindModel

bool Chaos::Softs::FExternalForcesBase::bUsePointBasedWindModel
protected

◆ FictitiousAngularVelocity

FSolverVec3 Chaos::Softs::FExternalForcesBase::FictitiousAngularVelocity
protected

◆ Gravity

FSolverVec3 Chaos::Softs::FExternalForcesBase::Gravity
protected

◆ GravityScale

FPBDFlatWeightMap Chaos::Softs::FExternalForcesBase::GravityScale
protected

◆ LegacyWindAdaptation

FSolverReal Chaos::Softs::FExternalForcesBase::LegacyWindAdaptation
protected

◆ Normals

const TArray<FSolverVec3>& Chaos::Softs::FExternalForcesBase::Normals
protected

◆ PointBasedWind

FSolverVec3 Chaos::Softs::FExternalForcesBase::PointBasedWind
protected

◆ ReferenceSpaceLocation

FSolverVec3 Chaos::Softs::FExternalForcesBase::ReferenceSpaceLocation
protected

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