1. Epic GamesDeveloper
  3. FClothSimulationProxy

FClothSimulationProxy

Cloth simulation proxy.

API > API/Plugins > API/Plugins/ChaosClothAssetEngine

Cloth simulation proxy. Class used to share data between the cloth simulation and the cloth component.

   
Name FClothSimulationProxy
Type class
Header File /Engine/Plugins/ChaosClothAsset/Source/ChaosClothAssetEngine/Public/ChaosClothAsset/ClothSimulationProxy.h
Include Path #include "ChaosClothAsset/ClothSimulationProxy.h"

Syntax

class FClothSimulationProxy : public FDataflowPhysicsSolverProxy

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  ChaosClothAsset/ClothSimulationProxy.h  
  ChaosClothAsset/ClothSimulationProxy.h  

FClothSimulationProxy ( const UChaosClothComponent& InClothComponent
)

   ChaosClothAsset/ClothSimulationProxy.h  
  ChaosClothAsset/ClothSimulationProxy.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FClothSimulationProxy()

   ChaosClothAsset/ClothSimulationProxy.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bHasInvalidReferenceBoneTransforms bool   ChaosClothAsset/ClothSimulationProxy.h  
bIsInitialized bool Whether the proxy has finished initialization, for internal use only. ChaosClothAsset/ClothSimulationProxy.h  
bIsPreProcessed bool Whether the proxy was initialized when Tick_GameThread/PreProcess_GameThread was called, for internal use only. ChaosClothAsset/ClothSimulationProxy.h  
bIsSimulating bool Whether the proxy has been running the simulation, for internal use only. ChaosClothAsset/ClothSimulationProxy.h  
bIsTeleported std::atomic< bool >   ChaosClothAsset/ClothSimulationProxy.h  
CacheData TUniquePtr< FClothingSimulationCacheData >   ChaosClothAsset/ClothSimulationProxy.h  
ClothComponent const UChaosClothComponent & Owner component. ChaosClothAsset/ClothSimulationProxy.h  
Cloths TArray< TUniquePtr<::Chaos::FClothingSimulationCloth > >   ChaosClothAsset/ClothSimulationProxy.h  
ClothSimulationContext TUniquePtr< FClothSimulationContext > Simulation context used to store the required component data for the duration of the simulation. ChaosClothAsset/ClothSimulationProxy.h  
ClothSimulationModels TArray< TSharedPtr< const FChaosClothSimulationModel > > The cloth simulation model used to create this simulation, ownership might get transferred to this proxy if it changes during the simulation. ChaosClothAsset/ClothSimulationProxy.h  
Colliders TArray< TUniquePtr<::Chaos::FClothingSimulationCollider > >   ChaosClothAsset/ClothSimulationProxy.h  
CollisionSourcesProxy TUniquePtr< FCollisionSourcesProxy > The collision data for the external collision sources. ChaosClothAsset/ClothSimulationProxy.h  
Configs TArray< TUniquePtr<::Chaos::FClothingSimulationConfig > >   ChaosClothAsset/ClothSimulationProxy.h  
CurrentSimulationData TMap< int32, FClothSimulData > Simulation data written back to the component after the simulation has taken place. ChaosClothAsset/ClothSimulationProxy.h  
LastLinearSolveError std::atomic< float >   ChaosClothAsset/ClothSimulationProxy.h  
LastLinearSolveIterations std::atomic< int32 >   ChaosClothAsset/ClothSimulationProxy.h  
MaxDeltaTime const float Cached value of the MaxPhysicsDeltaTime setting for the life of this proxy. ChaosClothAsset/ClothSimulationProxy.h  
Meshes TArray< TUniquePtr<::Chaos::FClothingSimulationMesh > >   ChaosClothAsset/ClothSimulationProxy.h  
NumCloths std::atomic< int32 > Properties that must be readable from all threads. ChaosClothAsset/ClothSimulationProxy.h  
NumDynamicParticles std::atomic< int32 >   ChaosClothAsset/ClothSimulationProxy.h  
NumIterations std::atomic< int32 >   ChaosClothAsset/ClothSimulationProxy.h  
NumKinematicParticles std::atomic< int32 >   ChaosClothAsset/ClothSimulationProxy.h  
NumSubsteps std::atomic< int32 >   ChaosClothAsset/ClothSimulationProxy.h  
ParallelInitializationTask FGraphEventRef Reference for the cloth async initialization parallel task, to detect whether or not initialization is not complete. ChaosClothAsset/ClothSimulationProxy.h  
ParallelTask FGraphEventRef Reference for the cloth parallel task, to detect whether or not a simulation is running. ChaosClothAsset/ClothSimulationProxy.h  
SimulationTime std::atomic< float >   ChaosClothAsset/ClothSimulationProxy.h  
Solver TUniquePtr<::Chaos::FClothingSimulationSolver > Simulation objects. ChaosClothAsset/ClothSimulationProxy.h  
SolverMode ESolverMode   ChaosClothAsset/ClothSimulationProxy.h  
Visualization PRAGMA_DISABLE_DEPRECATION_WARNINGSTUniquePtr<::Chaos::FClothVisualization >   ChaosClothAsset/ClothSimulationProxy.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FBoxSphereBounds CalculateBounds_AnyThread()

   ChaosClothAsset/ClothSimulationProxy.h  

void CompleteParallelSimulation_GameThread()

 Wait for the parallel task to complete if one was running, and update the simulation data. ChaosClothAsset/ClothSimulationProxy.h  

PRAGMA_ENABLE_DEPRECATION_WARNINGSconst ::Chaos::FClothVisualizationNoGC * GetClothVisualization()

   ChaosClothAsset/ClothSimulationProxy.h  
Return a map of all simulation data as used by the skeletal rendering code. ChaosClothAsset/ClothSimulationProxy.h  

float GetLinearSolveError()

   ChaosClothAsset/ClothSimulationProxy.h  

int32 GetNumCloths()

   ChaosClothAsset/ClothSimulationProxy.h  

int32 GetNumDynamicParticles()

   ChaosClothAsset/ClothSimulationProxy.h  

int32 GetNumIterations()

   ChaosClothAsset/ClothSimulationProxy.h  

int32 GetNumKinematicParticles()

   ChaosClothAsset/ClothSimulationProxy.h  

int32 GetNumLinearSolveIterations()

   ChaosClothAsset/ClothSimulationProxy.h  

int32 GetNumSubsteps()

   ChaosClothAsset/ClothSimulationProxy.h  

float GetSimulationTime()

   ChaosClothAsset/ClothSimulationProxy.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSconst ::Chaos::FClothVisualization * GetVisualization()

   ChaosClothAsset/ClothSimulationProxy.h  

bool HasCacheData()

   ChaosClothAsset/ClothSimulationProxy.h  

bool IsParallelSimulationTaskValid()

 Returns true if a parallel simulation task has been launched and the simulation data has not been updated, i.e., CompleteParallelSimulation_GameThread will do something. ChaosClothAsset/ClothSimulationProxy.h  

bool IsTeleported()

   ChaosClothAsset/ClothSimulationProxy.h  

virtual void PostConstructor()

   ChaosClothAsset/ClothSimulationProxy.h  
Post setup, required for when the simulation didn't run. ChaosClothAsset/ClothSimulationProxy.h  
Write data back onto the game thread once the simulation is done. ChaosClothAsset/ClothSimulationProxy.h  

void PreProcess_GameThread ( float DeltaTime,
bool bForceWaitForInitialization
)

 Prepare the proxy before the simulation is setup. ChaosClothAsset/ClothSimulationProxy.h  

bool PreSimulate_GameThread ( float DeltaTime
)

 Prepare the simulation data. For specialized usage when not calling Tick_GameThread. ChaosClothAsset/ClothSimulationProxy.h  

bool Tick_GameThread ( float DeltaTime
)

 Start the simulation if it isn't paused or suspended and return true, or simply update the existing simulation data and return false otherwise. ChaosClothAsset/ClothSimulationProxy.h  

Protected

Name Remarks Include Path Unreal Specifiers

void FillSimulationContext ( float DeltaTime,
bool bIsInitialization
)

   ChaosClothAsset/ClothSimulationProxy.h  

void InitializeConfigs()

   ChaosClothAsset/ClothSimulationProxy.h  

void PostConstructorInternal ( bool bAsyncInitialization
)

   ChaosClothAsset/ClothSimulationProxy.h  

void PreProcess_Internal ( float DeltaTime
)

   ChaosClothAsset/ClothSimulationProxy.h  

bool SetupSimulationData ( float DeltaTime
)

   ChaosClothAsset/ClothSimulationProxy.h  

void Tick()

   ChaosClothAsset/ClothSimulationProxy.h  

void WriteSimulationData()

   ChaosClothAsset/ClothSimulationProxy.h  

Operators

Name Remarks Include Path Unreal Specifiers
  ChaosClothAsset/ClothSimulationProxy.h  
  ChaosClothAsset/ClothSimulationProxy.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page