1. Epic GamesDeveloper
  3. IClothingSimulation

IClothingSimulation

Base class for clothing simulators.

API > API/Runtime > API/Runtime/ClothingSystemRuntimeInterface

References

   
Module ClothingSystemRuntimeInterface
Header /Engine/Source/Runtime/ClothingSystemRuntimeInterface/Public/ClothingSimulationInterface.h
Include #include "ClothingSimulationInterface.h"

Syntax

class IClothingSimulation

Remarks

Base class for clothing simulators.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function 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 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 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 IClothingSimulationContext * Create a new context, will not be filled, call FillContext before simulating with this context
Protected function void Simulation should remove all of it's actors when next possible and free them
Protected function void Destroy a context object, engine will always pass a context created using CreateContext
Protected function void

FillContext ( USkeletalMeshComponent* InComponent,
float InDeltaTime,
IClothingSimulationContext* InOutContext
)

 Fills an existing context for a single simulation step, called by the engine on the game thread prior to simulation
Protected function void

FillContext ( USkeletalMeshComponent* InComponent,
float InDeltaTime,
IClothingSimulationContext* InOutContext,
bool bIsInitialization
)

 Fills an existing context for a single simulation step, called by the engine on the game thread prior to simulation
Public function Virtual Const void Called by the engine once per physics tick to gather non-cycle stats (num sim verts etc.) Will not be called if STATS is not defined, not required to be implemented if no need for stats.
Protected function Const FBoxSphereBounds

GetBounds ( const USkeletalMeshComponent* InOwnerComponent
)

 Get the bounds of the simulation mesh in local simulation space
Protected function 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 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 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 Set the number of iterations used by the solver.
Public function Virtual void Set the number of substeps used by the solver.
Protected function 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 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 void Run a single tick of the simulation.
Public function Virtual void

UpdateWorldForces ( const USkeletalMeshComponent* OwnerComponent
)

 Update the forces coming from the world.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page