1. Epic GamesDeveloper
  3. FClothingSimulationCloth

FClothingSimulationCloth

Cloth simulation node.

API > API/Plugins > API/Plugins/ChaosCloth

Cloth simulation node.

   
Name FClothingSimulationCloth
Type class
Header File /Engine/Plugins/ChaosCloth/Source/ChaosCloth/Public/ChaosCloth/ChaosClothingSimulationCloth.h
Include Path #include "ChaosCloth/ChaosClothingSimulationCloth.h"

Syntax

class FClothingSimulationCloth

Constructors

Name Remarks Include Path Unreal Specifiers
  ChaosCloth/ChaosClothingSimulationCloth.h  
  ChaosCloth/ChaosClothingSimulationCloth.h  
  ChaosCloth/ChaosClothingSimulationCloth.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FClothingSimulationCloth()

   ChaosCloth/ChaosClothingSimulationCloth.h  

Structs

Name Remarks
FLODData  

Enums

Public

Name Remarks
EMassMode  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AppliedReferenceSpaceAngularVelocity FVec3   ChaosCloth/ChaosClothingSimulationCloth.h  
AppliedReferenceSpaceVelocity FVec3   ChaosCloth/ChaosClothingSimulationCloth.h  
bNeedsReset bool   ChaosCloth/ChaosClothingSimulationCloth.h  
bNeedsTeleport bool   ChaosCloth/ChaosClothingSimulationCloth.h  
bUseLODIndexOverride bool   ChaosCloth/ChaosClothingSimulationCloth.h  
Colliders TArray< FClothingSimulationCollider * >   ChaosCloth/ChaosClothingSimulationCloth.h  
Config FClothingSimulationConfig *   ChaosCloth/ChaosClothingSimulationCloth.h  
GroupId uint32   ChaosCloth/ChaosClothingSimulationCloth.h  
LODData TArray< TUniquePtr< FLODData > > LOD data. ChaosCloth/ChaosClothingSimulationCloth.h  
LODIndexOverride int32   ChaosCloth/ChaosClothingSimulationCloth.h  
LODIndices TMap< FClothingSimulationSolver *, int32 >   ChaosCloth/ChaosClothingSimulationCloth.h  
MaxDistancesMultiplier FRealSingle   ChaosCloth/ChaosClothingSimulationCloth.h  
Mesh FClothingSimulationMesh * Cloth parameters. ChaosCloth/ChaosClothingSimulationCloth.h  
NumActiveDynamicParticles int32   ChaosCloth/ChaosClothingSimulationCloth.h  
NumActiveKinematicParticles int32 Stats. ChaosCloth/ChaosClothingSimulationCloth.h  
PropertyCollection TSharedPtr< FManagedArrayCollection >   ChaosCloth/ChaosClothingSimulationCloth.h  
ReferenceSpaceTransform FRigidTransform3 Reference space transform. ChaosCloth/ChaosClothingSimulationCloth.h  
TimeSinceLastReset FRealSingle   ChaosCloth/ChaosClothingSimulationCloth.h  
TimeSinceLastTeleport FRealSingle   ChaosCloth/ChaosClothingSimulationCloth.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Add ( FClothingSimulationSolver* Solver
)

 - Solver interface - ChaosCloth/ChaosClothingSimulationCloth.h  

void AddCollider ( FClothingSimulationCollider* InCollider
)

   ChaosCloth/ChaosClothingSimulationCloth.h  

FAABB3 CalculateBoundingBox ( const FClothingSimulationSolver* Solver
) const

 Return the current bounding box based on a given solver, not thread safe, call must be done right after the solver update. ChaosCloth/ChaosClothingSimulationCloth.h  

TSet< FString > GetAllMorphTargetNames()

   ChaosCloth/ChaosClothingSimulationCloth.h  

TSet< FString > GetAllWeightMapNames()

 Return list of weight map names available across all LODs. ChaosCloth/ChaosClothingSimulationCloth.h  

TConstArrayView< Softs::FSolverVec3 > GetAnimationNormals ( const FClothingSimulationSolver* Solver
) const

 Return the solver's input normals for this cloth source current LOD, not thread safe, call must be done right after the solver update. ChaosCloth/ChaosClothingSimulationCloth.h  

TConstArrayView< Softs::FSolverVec3 > GetAnimationPositions ( const FClothingSimulationSolver* Solver
) const

 - Debugging/visualization functions Return the solver's input positions for this cloth source current LOD, not thread safe, call must be done right after the solver update. ChaosCloth/ChaosClothingSimulationCloth.h  

TConstArrayView< Softs::FSolverVec3 > GetAnimationVelocities ( const FClothingSimulationSolver* Solver
) const

 Return the solver's input normals for this cloth source current LOD, not thread safe, call must be done right after the solver update. ChaosCloth/ChaosClothingSimulationCloth.h  

const TArray< FClothingSimulationCollider * > & GetColliders()

   ChaosCloth/ChaosClothingSimulationCloth.h  
  ChaosCloth/ChaosClothingSimulationCloth.h  

int32 GetCurrentMorphTargetIndex ( const FClothingSimulationSolver* Solver
) const

   ChaosCloth/ChaosClothingSimulationCloth.h  

FRealSingle GetCurrentMorphTargetWeight ( const FClothingSimulationSolver* Solver
) const

   ChaosCloth/ChaosClothingSimulationCloth.h  

TConstArrayView< int32 > GetFaceIntMapByName ( const FClothingSimulationSolver* Solver,
const FString& Name
) const

 Return the face int map of the specified name if available on the current LOD, or an empty array view otherwise. ChaosCloth/ChaosClothingSimulationCloth.h  

TConstArrayView< int32 > GetFaceIntMapByProperty ( const FClothingSimulationSolver* Solver,
const FString& Property
) const

 Return the face int map of the specified property name if it exists and is available on the current LOD, or an empty array view otherwise. ChaosCloth/ChaosClothingSimulationCloth.h  

TVec3< FRealSingle > GetGravity ( const FClothingSimulationSolver* Solver
) const

 Return the current gravity as applied by the solver using the various overrides, not thread safe, call must be done right after the solver update. ChaosCloth/ChaosClothingSimulationCloth.h  

uint32 GetGroupId()

   ChaosCloth/ChaosClothingSimulationCloth.h  

uint32 GetLODIndex ( const FClothingSimulationSolver* Solver
) const

   ChaosCloth/ChaosClothingSimulationCloth.h  
- Node property getters/setters ChaosCloth/ChaosClothingSimulationCloth.h  

int32 GetNumActiveDynamicParticles()

   ChaosCloth/ChaosClothingSimulationCloth.h  

int32 GetNumActiveKinematicParticles()

   ChaosCloth/ChaosClothingSimulationCloth.h  

int32 GetNumParticles ( const FClothingSimulationSolver* Solver
) const

 Return the current LOD num particles, or 0 if no LOD is currently selected. ChaosCloth/ChaosClothingSimulationCloth.h  

int32 GetOffset ( const FClothingSimulationSolver* Solver
) const

   ChaosCloth/ChaosClothingSimulationCloth.h  

TConstArrayView< Softs::FSolverVec3 > GetOldAnimationPositions ( const FClothingSimulationSolver* Solver
) const

 Return the solver's input positions for this cloth source current LOD, not thread safe, call must be done right after the solver update. ChaosCloth/ChaosClothingSimulationCloth.h  

TConstArrayView< Softs::FSolverReal > GetParticleInvMasses ( const FClothingSimulationSolver* Solver
) const

 Return the solver's inverse masses for this cloth current LOD, not thread safe, call must be done right after the solver update. ChaosCloth/ChaosClothingSimulationCloth.h  

TConstArrayView< Softs::FSolverVec3 > GetParticleNormals ( const FClothingSimulationSolver* Solver
) const

 Return the solver's normals for this cloth current LOD, not thread safe, call must be done right after the solver update. ChaosCloth/ChaosClothingSimulationCloth.h  

TConstArrayView< Softs::FSolverVec3 > GetParticlePositions ( const FClothingSimulationSolver* Solver
) const

 Return the solver's positions for this cloth current LOD, not thread safe, call must be done right after the solver update. ChaosCloth/ChaosClothingSimulationCloth.h  

int32 GetParticleRangeId ( const FClothingSimulationSolver* Solver
) const

 Return the current LOD ParticleRangeId, or INDEX_NONE if no LOD is currently selected. ChaosCloth/ChaosClothingSimulationCloth.h  

TConstArrayView< Softs::FSolverVec3 > GetParticleVelocities ( const FClothingSimulationSolver* Solver
) const

 Return the solver's velocities for this cloth current LOD, not thread safe, call must be done right after the solver update. ChaosCloth/ChaosClothingSimulationCloth.h  

int32 GetReferenceBoneIndex()

 Return the reference bone index for this cloth. ChaosCloth/ChaosClothingSimulationCloth.h  

const FRigidTransform3 & GetReferenceSpaceTransform()

 Return the local reference space transform for this cloth. ChaosCloth/ChaosClothingSimulationCloth.h  

const TArray< TConstArrayView< TTuple< int32, int32, float > > > & GetTethers ( const FClothingSimulationSolver* Solver
) const

 Return the current LOD tethers. ChaosCloth/ChaosClothingSimulationCloth.h  

FRealSingle GetTimeSinceLastReset()

   ChaosCloth/ChaosClothingSimulationCloth.h  

FRealSingle GetTimeSinceLastTeleport()

   ChaosCloth/ChaosClothingSimulationCloth.h  

const FTriangleMesh & GetTriangleMesh ( const FClothingSimulationSolver* Solver
) const

 Return the current LOD mesh. ChaosCloth/ChaosClothingSimulationCloth.h  

TConstArrayView< FRealSingle > GetWeightMapByName ( const FClothingSimulationSolver* Solver,
const FString& Name
) const

 Return the weight map of the specified name if available on the current LOD, or an empty array view otherwise. ChaosCloth/ChaosClothingSimulationCloth.h  

TConstArrayView< FRealSingle > GetWeightMapByProperty ( const FClothingSimulationSolver* Solver,
const FString& Property
) const

 Return the weight map of the specified property name if it exists and is available on the current LOD, or an empty array view otherwise. ChaosCloth/ChaosClothingSimulationCloth.h  

void PostUpdate ( FClothingSimulationSolver* Solver
)

   ChaosCloth/ChaosClothingSimulationCloth.h  

void PreUpdate ( FClothingSimulationSolver* Solver
)

   ChaosCloth/ChaosClothingSimulationCloth.h  

void Remove ( FClothingSimulationSolver* Solver
)

   ChaosCloth/ChaosClothingSimulationCloth.h  

void RemoveCollider ( FClothingSimulationCollider* InCollider
)

   ChaosCloth/ChaosClothingSimulationCloth.h  

void RemoveColliders()

   ChaosCloth/ChaosClothingSimulationCloth.h  

void Reset()

   ChaosCloth/ChaosClothingSimulationCloth.h  

void SetColliders ( TArray< FClothingSimulationCollider* >&& InColliders
)

   ChaosCloth/ChaosClothingSimulationCloth.h  

void SetConfig ( FClothingSimulationConfig* InConfig
)

   ChaosCloth/ChaosClothingSimulationCloth.h  

void SetMaxDistancesMultiplier ( FRealSingle InMaxDistancesMultiplier
)

 - Animatable property setters - ChaosCloth/ChaosClothingSimulationCloth.h  

void SetMesh ( FClothingSimulationMesh* InMesh
)

   ChaosCloth/ChaosClothingSimulationCloth.h  

void Teleport()

   ChaosCloth/ChaosClothingSimulationCloth.h  

void Update ( FClothingSimulationSolver* Solver
)

   ChaosCloth/ChaosClothingSimulationCloth.h  

void UpdateFromCache ( const FClothingSimulationCacheData& CacheData
)

   ChaosCloth/ChaosClothingSimulationCloth.h  

Operators

Name Remarks Include Path Unreal Specifiers
  ChaosCloth/ChaosClothingSimulationCloth.h  
  ChaosCloth/ChaosClothingSimulationCloth.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page