1. Epic GamesDeveloper
  3. FClothingSimulation

FClothingSimulation

Unreal Engine C++ API Reference > Plugins > ChaosCloth > ChaosCloth

Inheritance Hierarchy

References

   
Module ChaosCloth
Header /Engine/Plugins/Experimental/ChaosCloth/Source/Chaos/Public/ChaosCloth/ChaosClothingSimulation.h
Include #include "ChaosCloth/ChaosClothingSimulation.h"

Syntax

class FClothingSimulation : public FClothingSimulationCommon

Variables

  Type Name Description
Public variable friend FSkeletalMeshCacheAdapter  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void

DebugDrawElementIndices ( FCanvas* Canvas,
const FSceneView* SceneView
)

  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void

DebugDrawMaxDistanceValues ( FCanvas* Canvas,
const FSceneView* SceneView
)

  
Public function Const void

DebugDrawParticleIndices ( FCanvas* Canvas,
const FSceneView* SceneView
)

  
Public function Const void Editor only debug draw function.
Public function Const void Editor & runtime debug draw functions.
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function void  
Public function FClothingSimulationCloth *

GetCloth ( int32 ClothId
)

  
Public function FClothingSimulationSolver *  
Public function void Function to be called if any of the assets' configuration parameters have changed.
Public function void Function to be called if any of the assets' physics assets changes (colliders) This seems to only happen when UPhysicsAsset::RefreshPhysicsAssetChange is called with bFullClothRefresh set to false during changes created using the viewport manipulators.
Public function void

SetGravityOverride ( const FVector& InGravityOverride
)

  

Overridden from IClothingSimulation

  Type Name Description
Protected function Virtual void Called by the engine when an external object wants to inject collision data into this simulation above and beyond what is specified in the asset for the internal actors Examples: Scene collision, collision for parents we are attached to
Protected function Virtual void Called by the engine when external collisions are no longer necessary or when they need to be updated with some of the previous collisions removed.
Protected function Virtual void

CreateActor ( USkeletalMeshComponent* InOwnerComponent,
UClothingAssetBase* InAsset,
int32 SimDataIndex
)

 Create an actor for this simulation from the data in InAsset Simulation data for this actor should be written back to SimDataIndex in GetSimulationData
Protected function Virtual IClothingSimulationContext * Create a new context, will not be filled, call FillContext before simulating with this context
Protected function Virtual void Simulation should remove all of it's actors when next possible and free them
Protected function Virtual void Destroy a context object, engine will always pass a context created using CreateContext
Protected function Virtual Const FBoxSphereBounds

GetBounds ( const USkeletalMeshComponent* InOwnerComponent
)

 Return bounds in local space (or in world space if InOwnerComponent is null).
Protected function Virtual Const void

GetCollisions ( FClothCollisionData& OutCollisions,
bool bIncludeExternal
)

 Called by the engine to request data on all active collisions in a simulation.
Public function Virtual Const int32 Return the number of simulated cloths. Implementation must be thread safe.
Public function Virtual Const int32 Return the number of dynamic (simulated) particles. Implementation must be thread safe.
Public function Virtual Const int32 Return the number of iterations used by the solver.
Public function Virtual Const int32 Return the number of kinematic (fixed) particles. Implementation must be thread safe.
Public function Virtual Const int32 Return the number of substeps used by the solver.
Protected function Virtual Const void

GetSimulationData ( TMap< int32, FClothSimulData >& OutData,
USkeletalMeshComponent* InOwnerComponent,
USkinnedMeshComponent* InOverrideComponent
)

 Fill FClothSimulData map for the clothing simulation.
Public function Virtual Const float Return the simulation time in ms. Implementation must be thread safe.
Protected function Virtual void Initialize the simulation, will be called before any Simulate calls
Public function Virtual Const bool Return whether the simulation is teleported. Implementation must be thread safe.
Public function Virtual void Set the maximum number of iterations used by the solver.
Public function Virtual void

SetNumIterations ( int32
)

 Set the number of iterations used by the solver.
Public function Virtual void

SetNumSubsteps ( int32
)

 Set the number of substeps used by the solver.
Protected function Virtual Const bool Called by the engine to detect whether or not the simulation should run, essentially are there any actors that need to simulate in this simulation
Protected function Virtual void Shutdown the simulation, this should clear ALL resources as we no longer expect to call any other function on this simulation without first calling Initialize again.
Protected function Virtual void Run a single tick of the simulation.
Public function Virtual void

UpdateWorldForces ( const USkeletalMeshComponent* OwnerComponent
)

 Update the forces coming from the world.

Deprecated Functions

  Type Name Description
Public function Const void DebugDrawWindForces has been renamed DebugDrawWindAndPressureForces.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page