| IClothingSimulation
|
Module |
|
Header |
/Engine/Source/Runtime/ClothingSystemRuntimeInterface/Public/ClothingSimulationInterface.h |
Include |
#include "ClothingSimulationInterface.h" |
class IClothingSimulation
Base class for clothing simulators.
Name | Description | |
---|---|---|
|
IClothingSimulation() |
Name | Description | |
---|---|---|
|
~IClothingSimulation() |
Name | Description | ||
---|---|---|---|
|
AddExternalCollisions ( |
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 |
|
|
ClearExternalCollisions() |
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. |
|
|
CreateActor ( |
Create an actor for this simulation from the data in InAsset Simulation data for this actor should be written back to SimDataIndex in GetSimulationData |
|
|
IClothingSim... |
CreateContext() |
Create a new context, will not be filled, call FillContext before simulating with this context |
|
DestroyActors() |
Simulation should remove all of it's actors when next possible and free them |
|
|
DestroyContext ( |
Destroy a context object, engine will always pass a context created using CreateContext |
|
|
FillContext ( |
Fills an existing context for a single simulation step, called by the engine on the game thread prior to simulation |
|
|
GatherStats() |
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. |
|
|
FBoxSphereBo... |
GetBounds ( |
Get the bounds of the simulation mesh in local simulation space |
|
GetCollisions ( |
Called by the engine to request data on all active collisions in a simulation. |
|
|
GetSimulationData ( |
Fill FClothSimulData map for the clothing simulation. |
|
|
Initialize() |
Initialize the simulation, will be called before any Simulate calls |
|
|
PostActorCreationInitialize() |
Do any required initialization after all the actors have been loaded |
|
|
ShouldSimulate() |
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 |
|
|
Shutdown() |
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. |
|
|
Simulate ( |
Run a single tick of the simulation. |