1. Epic GamesDeveloper
  3. UClothingSimulationInteractor

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.

API > API/Runtime > API/Runtime/ClothingSystemRuntimeInterface

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, BlueprintType, MinimalAPI)  
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

  Type Name Description
Public variable UProperty TMap< FName, TObjectPtr< UClothingInteractor > > ClothingInteractors Cloth interactors currently created.

Functions

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category void Called to update the cloth config without restarting the simulation.
Protected function Virtual UClothingInteractor *  
Public function void

CreateClothingInteractor ( const UClothingAssetBase* ClothingAsset,
int32 ClothingId
)

 Create a cloth specific interactor.
Public function void Destroy all interactors.
Public function Virtual UFunction BlueprintCallable, Category void Disable any currently set gravity override.
Public function Virtual UFunction BlueprintCallable, Category void

EnableGravityOverride ( const FVector& InVector
)

 Set a new gravity override and enable the override.
Public function Const UFunction BlueprintCallable, Category UClothingInteractor *

GetClothingInteractor ( const FString& ClothingAssetName
)

 Return a cloth interactor for this simulation.
Public function Const UFunction BlueprintCallable, Category int32 Return the number of cloths run by the simulation.
Public function Const UFunction BlueprintCallable, Category int32 Return the number of dynamic (simulated) particles.
Public function Const UFunction BlueprintCallable, Category int32 Return the solver number of iterations.
Public function Const UFunction BlueprintCallable, Category int32 Return the number of kinematic (animated) particles.
Public function Const UFunction BlueprintCallable, Category int32 Return the solver number of subdivisions./ This could be different from the number set if the simulation hasn't updated yet.
Public function Const UFunction BlueprintCallable, Category float Return the instant average simulation time in ms.
Public function Virtual UFunction BlueprintCallable, Category void Called to update collision status without restarting the simulation.
Public function Virtual UFunction BlueprintCallable, Category void

SetAnimDriveSpringStiffness ( float InStiffness
)

 Set the stiffness of the spring force for the animation drive.
Public function Virtual UFunction BlueprintCallable, Category void

SetMaxNumIterations ( int32 MaxNumIterations
)

 Set the maximum number of solver iterations.
Public function Virtual UFunction BlueprintCallable, Category void

SetNumIterations ( int32 NumIterations
)

 Set the number of time dependent solver iterations.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

SetNumSubsteps ( int32 NumSubsteps
)

 Set the number of substeps or subdivisions.
Public function Virtual void Sync the interactor to the provided context for the clothing simulation to use on its next update.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page