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 > UClothingSimulationInteractor

Light Theme

Dark Theme

UClothingSimulationInteractor

If a clothing simulation is able to be interacted with at runtime then a derived interactor should be created, and at least the basic API implemented for that simulation.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UClothingSimulationInteractor

	UChaosClothingSimulationInteractor
	UClothingSimulationInteractorNv

References

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

Syntax

class UClothingSimulationInteractor : public UObject

Remarks

If a clothing simulation is able to be interacted with at runtime then a derived interactor should be created, and at least the basic API implemented for that simulation. Only write to the simulation and context during the call to Sync, as that is guaranteed to be a safe place to access this data.

Variables

		Name	Description
	TMap< FName, UC...	ClothingInteractors	Cloth interactors currently created.

Functions

	Name	Description
void	ClothConfigUpdated()	Called to update the cloth config without restarting the simulation.
UClothingInt...	CreateClothingInteractor()
void	CreateClothingInteractor ( const UClothingAssetBase* Clot..., int32 ClothingId )	Create a cloth specific interactor.
void	DestroyClothingInteractors()	Destroy all interactors.
void	DisableGravityOverride()	Disable any currently set gravity override.
void	EnableGravityOverride ( const FVector& InVector )	Set a new gravity override and enable the override.
UClothingInt...	GetClothingInteractor ( const FString& ClothingAssetName )	Return a cloth interactor for this simulation.
int32	GetNumCloths()	Return the number of cloths run by the simulation.
int32	GetNumDynamicParticles()	Return the number of dynamic (simulated) particles.
int32	GetNumIterations()	Return the solver number of iterations.
int32	GetNumKinematicParticles()	Return the number of kinematic (animated) particles.
int32	GetNumSubsteps()	Return the solver number of subdivisions./ This could be different from the number set if the simulation hasn't updated yet.
float	GetSimulationTime()	Return the instant average simulation time in ms.
void	PhysicsAssetUpdated()	Called to update collision status without restarting the simulation.
void	SetAnimDriveSpringStiffness ( float InStiffness )	Set the stiffness of the spring force for the animation drive.
void	SetNumIterations ( int32 NumIterations )	Set the number of solver iterations.
void	SetNumSubsteps ( int32 NumSubsteps )	Set the number of substeps or subdivisions.
void	Sync ( IClothingSimulation* Simulatio..., IClothingSimulationContext* Co... )	Sync the interactor to the provided context for the clothing simulation to use on its next update.

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

Take our survey

Dismiss