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
	bool	bDirty	Flag to control sync calls.

Functions

	Name	Description
void	ClothConfigUpdated()	Called to update the cloth config without restarting the simulation.
void	DisableGravityOverride()	Disable any currently set gravity override.
void	EnableGravityOverride ( const FVector& InVector )	Set a new gravity override and enable the override.
bool	IsDirty()
void	MarkDirty()	Intended to be called by functions on the interactor to message to the owning skeletal mesh component that this interactor requires a sync.
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	Sync ( IClothingSimulation* InSimulat..., IClothingSimulationContext* In... )	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