1. Epic GamesDeveloper
  3. ChaosCloth

ChaosCloth

Unreal Engine C++ API Reference > Plugins > ChaosCloth

Classes

  Type Name Description
Public struct UStruct FChaosClothWeightedValue Copyright Epic Games, Inc. All Rights Reserved.  
Public class FClothConstraints    
Public struct FClothingCacheSchema    
Public struct FClothingPatternData    
Public class FClothingSimulation    
Public class FClothingSimulationCloth Cloth simulation node.  
Public class FClothingSimulationCollider Collider simulation node.  
Public class FClothingSimulationConfig Cloth simulation properties.  
Public class FClothingSimulationSkeletalMesh    
Public class FClothingSimulationSolver Solver simulation node.  
Public class FClothVisualization    
Public class IChaosClothModuleInterface    
Public class UClass MinimalAPI HideCategories UChaosClothConfig Hiding categories that will be used in the future.  
Public class UClass MinimalAPI BlueprintType UChaosClothingInteractor    
Public class UClass MinimalAPI UChaosClothingSimulationFactory    
Public class UClass MinimalAPI BlueprintType UChaosClothingSimulationInteractor    
Public class UClass MinimalAPI UChaosClothSharedSimConfig Chaos config settings shared between all instances of a skeletal mesh.  

Constants

Name Description
bChaos_CalculateBounds_ISPC_Enabled Support run-time toggling on supported platforms in non-shipping configurations.
bChaos_GetSimData_ISPC_Enabled Support run-time toggling on supported platforms in non-shipping configurations.
bChaos_PreSimulationTransforms_ISPC_Enabled  
bChaos_PreSubstepInterpolation_ISPC_Enabled  
bChaos_SkinPhysicsMesh_ISPC_Enabled Support run-time toggling on supported platforms in non-shipping configurations.

Typedefs

Name Description
FChaosClothingInteractorCommand  
FChaosClothingInteractorConfigCommand Command signature for handling synced command buffer.
FChaosClothingSimulationInteractorCommand  
FClothingSimulationContext  

Enums

  Type Name Description
Public enum UEnum EChaosClothTetherMode Long range attachment options. Deprecated.  

Functions

  Type Name Description
Public function Virtual    
Public function  

Chaos::FClothingSimulationMesh ( const UClothingAssetCommon* InAsset,
const USkeletalMeshComponent* InSkeletalMeshComponent
)

 Use the FClothingSimulationSkeletalMesh constructor instead.
Public function  

Chaos::FClothingSimulationMesh ( FClothingSimulationMesh&&
)

  
Public function  

Chaos::FClothingSimulationMesh ( const FClothingSimulationMesh&
)

  
Public function Virtual Const const UClothingAssetCommon * Use the FClothingSimulationSkeletalMesh::GetAsset() instead.
Public function Virtual Const TConstArrayView< FClothVertBoneData >

Chaos::GetBoneData ( int32 LODIndex
)

  
Public function Virtual Const TConstArrayView< int32 >  
Public function Virtual Const const TArray< FTransform > &  
Public function Virtual Const const FTransform &  
Private function Const const FClothingSimulationContextCommon *  
Public function Const const FString &  
Public function Virtual Const TConstArrayView< uint32 >

Chaos::GetIndices ( int32 LODIndex
)

  
Public function Virtual Const int32  
Public function Virtual Const TConstArrayView< FVector3f >

Chaos::GetNormals ( int32 LODIndex
)

  
Public function Virtual Const int32  
Public function Virtual Const int32

Chaos::GetNumPatternPoints ( int32 LODIndex
)

  
Public function Virtual Const int32

Chaos::GetNumPoints ( int32 LODIndex
)

  
Public function Virtual Const int32

Chaos::GetOwnerLODIndex ( int32 LODIndex
)

  
Public function Virtual Const TConstArrayView< uint32 >

Chaos::GetPatternIndices ( int32 LODIndex
)

  
Public function Virtual Const TConstArrayView< FVector2f >

Chaos::GetPatternPositions ( int32 LODIndex
)

  
Public function Virtual Const TConstArrayView< uint32 >  
Public function Virtual Const TConstArrayView< FVector3f >

Chaos::GetPositions ( int32 LODIndex
)

  
Public function Virtual Const int32  
Public function Virtual Const FTransform  
Public function Virtual Const const TArray< FMatrix44f > &  
Public function Virtual Const Softs::FSolverReal Return this mesh uniform scale as the maximum of the three axis scale value.
Public function Virtual Const const USkeletalMeshComponent * Use the FClothingSimulationSkeletalMesh::GetSkeletalMeshComponent() instead.
Public function Virtual Const TArray< TConstArrayView< TTuple< int32, int32, float > > >

Chaos::GetTethers ( int32 LODIndex,
bool bUseGeodesicTethers
)

  
Public function Virtual Const TConstArrayView< FMeshToMeshVertData >  
Public function Virtual Const TConstArrayView< FMeshToMeshVertData >

Chaos::GetTransitionUpSkinData ( int32 LODIndex
)

  
Public function Virtual Const TMap< FString, int32 >  
Public function Virtual Const TArray< FName >  
Public function Virtual Const TArray< TConstArrayView< FRealSingle > >

Chaos::GetWeightMaps ( int32 LODIndex
)

  
Public function Virtual Const bool

Chaos::IsValidLODIndex ( int32 LODIndex
)

  
Public function FClothingSimulationMesh &  
Public function FClothingSimulationMesh &  
Private function Const void

Chaos::SkinPhysicsMesh ( int32 LODIndex,
const FVec3& LocalSpaceLocation,
Softs::FSolverVec3* OutPositions,
Softs::FSolverVec3* OutNormals
)

  
Public function void

Chaos::Update ( FClothingSimulationSolver* Solver,
int32 PrevLODIndex,
int32 LODIndex,
int32 PrevOffset,
int32 Offset
)

 Update the mesh for the next solver step, doing skinning and matching the shapes during LOD changes.
Public function Const bool

Chaos::WrapDeformLOD ( int32 PrevLODIndex,
int32 LODIndex,
const Softs::FSolverVec3* Normals,
const Softs::FSolverVec3* Positions,
Softs::FSolverVec3* OutPositions
)

 Deform the specified positions to match the shape of the previous LOD.
Public function Const bool

Chaos::WrapDeformLOD ( int32 PrevLODIndex,
int32 LODIndex,
const Softs::FSolverVec3* Normals,
const Softs::FPAndInvM* PositionAndInvMs,
const Softs::FSolverVec3* Velocities,
Softs::FPAndInvM* OutPositionAndInvMs0,
Softs::FSolverVec3* OutPositions1,
Softs::FSolverVec3* OutVelocities
)

 Deform the specified positions and transfer velocities to match the dynamics of the previous LOD.

Variables

  Type Name Description
Private variable const UClothingAssetCommon * Asset  
Private variable FString DebugName Debug name of the source component.
Public variable   FClothingSimulationMesh This class is becoming an abstract interface, do not use directly. Use FClothingSimulationSkeletalMesh instead.
Private variable const USkeletalMeshComponent * SkeletalMeshComponent  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page