1. Epic GamesDeveloper
  3. FExternalForces

FExternalForces

API > API/Runtime > API/Runtime/Chaos

   
Name FExternalForces
Type class
Header File /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/SoftsExternalForces.h
Include Path #include "Chaos/SoftsExternalForces.h"

Syntax

class FExternalForces : public Chaos::Softs::FExternalForcesBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FExternalForces ( const FSolverParticlesRange& Particles,
const TArray< FSolverVec3 >& InNormals,
const TMap< FString, TConstArrayView< FRealSingle > >& WeightMaps,
const FCollectionPropertyConstFacade& PropertyCollection
)

 We don't have the solver values at the time this is constructed. Chaos/SoftsExternalForces.h  

Structs

Name Remarks
FFictitiousAngularScaleIndex  
FGravityOverrideIndex  
FGravityScaleIndex  
FUseGravityOverrideIndex  
FUsePointBasedWindModelIndex  

Typedefs

Name Type Remarks Include Path
Base FExternalForcesBase   Chaos/SoftsExternalForces.h

Constants

Name Type Remarks Include Path
bDefaultUseGravityOverride bool   Chaos/SoftsExternalForces.h
bDefaultUsePointBasedWindModel bool   Chaos/SoftsExternalForces.h
DefaultFictitiousAngularScale FSolverReal   Chaos/SoftsExternalForces.h
DefaultGravityScale FSolverReal   Chaos/SoftsExternalForces.h
DefaultGravityZOverride FSolverReal   Chaos/SoftsExternalForces.h
FictitiousAngularScaleName const FName   Chaos/SoftsExternalForces.h
GravityOverrideName const FName   Chaos/SoftsExternalForces.h
GravityScaleName const FName   Chaos/SoftsExternalForces.h
UseGravityOverrideName const FName   Chaos/SoftsExternalForces.h
UsePointBasedWindModelName const FName   Chaos/SoftsExternalForces.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bPerSoftBodyGravityOverrideEnabled bool   Chaos/SoftsExternalForces.h  
FictitiousAngularScaleIndex Chaos::Softs::FExternalForces::FFictitiousAngularScaleIndex   Chaos/SoftsExternalForces.h  
FictitiousAngularVelocityNoScale FSolverVec3 Fictitious Forces Chaos/SoftsExternalForces.h  
GravityOverrideIndex Chaos::Softs::FExternalForces::FGravityOverrideIndex   Chaos/SoftsExternalForces.h  
GravityScaleIndex Chaos::Softs::FExternalForces::FGravityScaleIndex   Chaos/SoftsExternalForces.h  
ParticleCount const int32   Chaos/SoftsExternalForces.h  
SolverGravity FSolverVec3 "Solver" level properties (set from Solver-level BP) Chaos/SoftsExternalForces.h  
UseGravityOverrideIndex Chaos::Softs::FExternalForces::FUseGravityOverrideIndex   Chaos/SoftsExternalForces.h  
UsePointBasedWindModelIndex Chaos::Softs::FExternalForces::FUsePointBasedWindModelIndex   Chaos/SoftsExternalForces.h  
WorldGravityMultiplier FSolverReal "World" level properties (this comes from a world-level CVar) Chaos/SoftsExternalForces.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SetFictitiousForcesData ( const FSolverVec3& InFictitiousAngularVelocityNoScale,
const FSolverVec3& InReferenceSpaceLocation
)

   Chaos/SoftsExternalForces.h  

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

 This should be called after all other data is set as it will populate the final base class values. Chaos/SoftsExternalForces.h  

void SetSolverGravityProperties ( const FSolverVec3& InSolverGravity,
bool bInPerSoftBodyGravityOverrideEnabled
)

   Chaos/SoftsExternalForces.h  

void SetSolverWind ( const FSolverVec3& SolverWind,
const FSolverReal InLegacyWindAdaptation
)

   Chaos/SoftsExternalForces.h  

void SetWorldGravityMultiplier ( FSolverReal InWorldGravityMultiplier
)

   Chaos/SoftsExternalForces.h  

Static

Name Remarks Include Path Unreal Specifiers

static float GetFictitiousAngularScale ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  
  Chaos/SoftsExternalForces.h  

static FVector3f GetGravityOverride ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector3f& Default
)

   Chaos/SoftsExternalForces.h  

static FString GetGravityOverrideString ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FString& Default
)

   Chaos/SoftsExternalForces.h  

static float GetGravityScale ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  

static FString GetGravityScaleString ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FString& Default
)

   Chaos/SoftsExternalForces.h  

static float GetHighFictitiousAngularScale ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  

static FVector3f GetHighGravityOverride ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector3f& Default
)

   Chaos/SoftsExternalForces.h  

static float GetHighGravityScale ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  

static bool GetHighUseGravityOverride ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const bool& Default
)

   Chaos/SoftsExternalForces.h  

static bool GetHighUsePointBasedWindModel ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const bool& Default
)

   Chaos/SoftsExternalForces.h  

static float GetLowFictitiousAngularScale ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  

static FVector3f GetLowGravityOverride ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector3f& Default
)

   Chaos/SoftsExternalForces.h  

static float GetLowGravityScale ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  

static bool GetLowUseGravityOverride ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const bool& Default
)

   Chaos/SoftsExternalForces.h  

static bool GetLowUsePointBasedWindModel ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const bool& Default
)

   Chaos/SoftsExternalForces.h  

static bool GetUseGravityOverride ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const bool& Default
)

   Chaos/SoftsExternalForces.h  

static FString GetUseGravityOverrideString ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FString& Default
)

   Chaos/SoftsExternalForces.h  

static bool GetUsePointBasedWindModel ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const bool& Default
)

   Chaos/SoftsExternalForces.h  
  Chaos/SoftsExternalForces.h  

static TPair< float, float > GetWeightedFictitiousAngularScale ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  

static FVector2f GetWeightedFloatFictitiousAngularScale ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/SoftsExternalForces.h  

static FVector2f GetWeightedFloatFictitiousAngularScale ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  

static FVector2f GetWeightedFloatGravityOverride ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  

static FVector2f GetWeightedFloatGravityOverride ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/SoftsExternalForces.h  

static FVector2f GetWeightedFloatGravityScale ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  

static FVector2f GetWeightedFloatGravityScale ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/SoftsExternalForces.h  

static FVector2f GetWeightedFloatUseGravityOverride ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/SoftsExternalForces.h  

static FVector2f GetWeightedFloatUseGravityOverride ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  

static FVector2f GetWeightedFloatUsePointBasedWindModel ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/SoftsExternalForces.h  

static FVector2f GetWeightedFloatUsePointBasedWindModel ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  

static TPair< FVector3f, FVector3f > GetWeightedGravityOverride ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector3f& Default
)

   Chaos/SoftsExternalForces.h  

static TPair< float, float > GetWeightedGravityScale ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/SoftsExternalForces.h  

static TPair< bool, bool > GetWeightedUseGravityOverride ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const bool& Default
)

   Chaos/SoftsExternalForces.h  

static TPair< bool, bool > GetWeightedUsePointBasedWindModel ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const bool& Default
)

   Chaos/SoftsExternalForces.h  

static bool IsFictitiousAngularScaleAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/SoftsExternalForces.h  

static bool IsFictitiousAngularScaleEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/SoftsExternalForces.h  

static bool IsGravityOverrideAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/SoftsExternalForces.h  

static bool IsGravityOverrideEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/SoftsExternalForces.h  

static bool IsGravityScaleAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/SoftsExternalForces.h  

static bool IsGravityScaleEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/SoftsExternalForces.h  

static bool IsUseGravityOverrideAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/SoftsExternalForces.h  

static bool IsUseGravityOverrideEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/SoftsExternalForces.h  

static bool IsUsePointBasedWindModelAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/SoftsExternalForces.h  

static bool IsUsePointBasedWindModelEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/SoftsExternalForces.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page