Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > ClothingSystemRuntimeInterface > IClothingSimulation

Light Theme

Dark Theme

IClothingSimulation

Base class for clothing simulators.

Windows

MacOS

Linux

Inheritance Hierarchy

IClothingSimulation

FClothingSimulationCommon

FClothingSimulation

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

	Name	Description
	IClothingSimulation()

Destructors

	Name	Description
	~IClothingSimulation()

Functions

	Name	Description
void	AddExternalCollisions ( const FClothCollisionData& InData )	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
void	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.
void	CreateActor ( USkeletalMeshComponent* InOwne..., 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
IClothingSim...	CreateContext()	Create a new context, will not be filled, call FillContext before simulating with this context
void	DestroyActors()	Simulation should remove all of it's actors when next possible and free them
void	DestroyContext ( IClothingSimulationContext* In... )	Destroy a context object, engine will always pass a context created using CreateContext
void	FillContext ( USkeletalMeshComponent* InComp..., float InDeltaTime, IClothingSimulationContext* In... )	Fills an existing context for a single simulation step, called by the engine on the game thread prior to simulation
void	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 ( const USkeletalMeshComponent* ... )	Get the bounds of the simulation mesh in local simulation space
void	GetCollisions ( FClothCollisionData& OutCollisions, bool bIncludeExternal )	Called by the engine to request data on all active collisions in a simulation.
int32	GetNumCloths()	Return the number of simulated cloths. Implementation must be thread safe.
int32	GetNumDynamicParticles()	Return the number of dynamic (simulated) particles. Implementation must be thread safe.
int32	GetNumIterations()	Return the number of iterations used by the solver.
int32	GetNumKinematicParticles()	Return the number of kinematic (fixed) particles. Implementation must be thread safe.
int32	GetNumSubsteps()	Return the number of substeps used by the solver.
void	GetSimulationData ( TMap< int32, FClothSimulData >& Ou..., USkeletalMeshComponent* InOwne..., USkinnedMeshComponent* InOverr... )	Fill FClothSimulData map for the clothing simulation.
float	GetSimulationTime()	Return the simulation time in ms. Implementation must be thread safe.
void	Initialize()	Initialize the simulation, will be called before any Simulate calls
bool	IsTeleported()	Return whether the simulation is teleported. Implementation must be thread safe.
void	SetNumIterations ( int32 )	Set the number of iterations used by the solver.
void	SetNumSubsteps ( int32 )	Set the number of substeps used by the solver.
bool	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
void	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.
void	Simulate ( IClothingSimulationContext* In... )	Run a single tick of the simulation.
void	UpdateWorldForces ( const USkeletalMeshComponent* ... )	Update the forces coming from the world.

Deprecated Functions

		Name	Description
	void	PostActorCreationInitialize()	No longer required.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss