Navigation
API > API/Runtime > API/Runtime/ClothingSystemRuntimeInterface
Clothing simulation objects. Facade to the simulation interfaces to allow for a simplified implementation and multiple simulations to coexist with each other.
| Name | FClothingSimulationInstance |
| Type | struct |
| Header File | /Engine/Source/Runtime/ClothingSystemRuntimeInterface/Public/ClothingSimulationInstance.h |
| Include Path | #include "ClothingSimulationInstance.h" |
Syntax
USTRUCT ()
struct FClothingSimulationInstance
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| ClothingSimulationInstance.h | |||
| ClothingSimulationInstance.h | |||
FClothingSimulationInstance
(
USkeletalMeshComponent* SkeletalMeshComponent, |
Construct a new clothing simulation instance for the specified asset group and component. | ClothingSimulationInstance.h | |
| ClothingSimulationInstance.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FClothingSimulationInstance() |
ClothingSimulationInstance.h |
Structs
| Name | Remarks |
|---|---|
| FFactoryAssetGroup | Factory asset group. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ClothingSimulation | IClothingSimulationInterface * | ClothingSimulations are responsible for maintaining and simulating clothing actors. | ClothingSimulationInstance.h | |
| ClothingSimulationContext | IClothingSimulationContext * | ClothingSimulationContexts are a datastore for simulation data sent to the clothing thread. | ClothingSimulationInstance.h | |
| ClothingSimulationFactory | TObjectPtr< UClothingSimulationFactory > | Simulation factory. | ClothingSimulationInstance.h |
|
| ClothingSimulationInteractor | TObjectPtr< UClothingSimulationInteractor > | Objects responsible for interacting with the clothing simulation. | ClothingSimulationInstance.h |
|
| CurrentOwnerLODIndex | int32 | ClothingSimulationInstance.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddExternalCollisions
(
const FClothCollisionData& Collisions |
Add external dynamic collisions. | ClothingSimulationInstance.h | |
void AppendSimulationData
(
TMap< int32, FClothSimulData >& CurrentSimulationData, |
Append the simulation data. | ClothingSimulationInstance.h | |
void AppendUniqueCollisions
(
FClothCollisionData& OutCollisions, |
Append unique collision data from this simulation instance to the specified collision data. | ClothingSimulationInstance.h | |
void ClearExternalCollisions() |
Remove all dynamically added external collisions. | ClothingSimulationInstance.h | |
void FillContextAndPrepareTick
(
const USkeletalMeshComponent* OwnerComponent, |
Fill the simulation context and do any other related game-thread initialization. | ClothingSimulationInstance.h | |
FBoxSphereBounds GetBounds
(
const USkeletalMeshComponent* OwnerComponent |
Return this simulation bounds. | ClothingSimulationInstance.h | |
| Return the clothing simulation pointer. | ClothingSimulationInstance.h | ||
| Return the clothing simulation pointer. | ClothingSimulationInstance.h | ||
| Return the clothing simulation context. | ClothingSimulationInstance.h | ||
| Return the clothing simulation context. | ClothingSimulationInstance.h | ||
UClothingSimulationFactory * GetClothingSimulationFactory() |
Return the clothing simulation factory used to initialize this clothing simulation instance. | ClothingSimulationInstance.h | |
UClothingSimulationInteractor * GetClothingSimulationInteractor() |
Return a non const version of the clothing interactor (non const methods are used to update simulation parameters). | ClothingSimulationInstance.h | |
void GetCollisions
(
FClothCollisionData& Collisions, |
Return the collision data from this simulation instance. | ClothingSimulationInstance.h | |
void HardResetSimulation() |
Hard reset the cloth simulation | ClothingSimulationInstance.h | |
void RemoveAllClothingActors() |
Remove all actors. | ClothingSimulationInstance.h | |
void Simulate() |
Advance the simulation. This method may be called asynchronously. | ClothingSimulationInstance.h | |
void SyncClothingInteractor() |
Synchronize the simulation with the changes requested by the interactor. | ClothingSimulationInstance.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| ClothingSimulationInstance.h | |||
| ClothingSimulationInstance.h |