1. Epic GamesDeveloper
  3. FClothPhysicalMeshData

FClothPhysicalMeshData

Spatial simulation data for a mesh.

API > API/Runtime > API/Runtime/ClothingSystemRuntimeCommon

Spatial simulation data for a mesh.

   
Name FClothPhysicalMeshData
Type struct
Header File /Engine/Source/Runtime/ClothingSystemRuntimeCommon/Public/ClothPhysicalMeshData.h
Include Path #include "ClothPhysicalMeshData.h"

Syntax

USTRUCT ()  
struct FClothPhysicalMeshData

Constructors

Name Remarks Include Path Unreal Specifiers
Construct an empty cloth physical mesh with default common targets. ClothPhysicalMeshData.h  
  ClothPhysicalMeshData.h  

Destructors

Name Remarks Include Path Unreal Specifiers

PRAGMA_DISABLE_DEPRECATION_WARNINGS ~FClothPhysicalMeshData()

   ClothPhysicalMeshData.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BoneData TArray< FClothVertBoneData > Indices and weights for each vertex, used to skin the mesh to create the reference pose. ClothPhysicalMeshData.h
  • EditAnywhere
  • Category=SimMesh
EuclideanTethers FClothTetherData Long range attachment tethers, using euclidean (beeline) distance to find the closest attachment. ClothPhysicalMeshData.h
  • EditAnywhere
  • Category=SimMesh
GeodesicTethers FClothTetherData Long range attachment tethers, using geodesic (surface) distance to find the closest attachment. ClothPhysicalMeshData.h
  • EditAnywhere
  • Category=SimMesh
Indices TArray< uint32 > Indices of the simulation mesh triangles. ClothPhysicalMeshData.h
  • EditAnywhere
  • Category=SimMesh
InverseMasses TArray< float > Inverse mass for each vertex in the physical mesh. ClothPhysicalMeshData.h
  • EditAnywhere
  • Category=SimMesh
MaxBoneWeights int32 Maximum number of bone weights of any vetex. ClothPhysicalMeshData.h
  • EditAnywhere
  • Category=SimMesh
Normals TArray< FVector3f > Normal at each vertex. ClothPhysicalMeshData.h
  • EditAnywhere
  • Category=SimMesh
NumFixedVerts int32 Number of fixed verts in the simulation mesh (fixed verts are just skinned and do not simulate) ClothPhysicalMeshData.h
  • EditAnywhere
  • Category=SimMesh
SelfCollisionIndices TArray< uint32 >   ClothPhysicalMeshData.h  
SelfCollisionVertexSet TSet< int32 > Valid indices to use for self collisions (reduced set of Indices) ClothPhysicalMeshData.h
  • EditAnywhere
  • Category=SimMesh
VertexColors TArray< FColor > Color at each vertex. ClothPhysicalMeshData.h
  • EditAnywhere
  • Category=SimMesh
Vertices TArray< FVector3f > Positions of each simulation vertex. ClothPhysicalMeshData.h
  • EditAnywhere
  • Category=SimMesh
WeightMaps TMap< uint32, FPointWeightMap > The weight maps, or masks, used by this mesh, sorted by their target id. ClothPhysicalMeshData.h
  • EditAnywhere
  • Category=SimMesh

Functions

Public

Name Remarks Include Path Unreal Specifiers

FPointWeightMap & AddWeightMap ( const T Target
)

 Retrieve a pointer to a registered vertex weight array by unique ClothPhysicalMeshData.h  

void BuildSelfCollisionData ( float SelfCollisionRadius
)

 Build the self collision indices with the specified radius. ClothPhysicalMeshData.h  

void CalculateInverseMasses()

 Recalculate the node inverse masses. ClothPhysicalMeshData.h  

void CalculateNumInfluences()

 Recalculate the number of influences for the bone data. ClothPhysicalMeshData.h  

void CalculateTethers ( bool bUseEuclideanDistance,
bool bUseGeodesicDistance
)

 Recalculate the long range attachment tethers. ClothPhysicalMeshData.h  

void ClearWeightMaps()

 Clear out any default weight maps and delete any other ones. ClothPhysicalMeshData.h  

FPointWeightMap & FindOrAddWeightMap ( const T Target
)

 Retrieve a pointer to a registered vertex weight array by unique ClothPhysicalMeshData.h  

const FPointWeightMap * FindWeightMap ( const T Target
) const

 Retrieve a pointer to a registered vertex weight array by unique ClothPhysicalMeshData.h  

FPointWeightMap * FindWeightMap ( const T Target
)

 Retrieve a pointer to a registered vertex weight array by unique ClothPhysicalMeshData.h  

FPointWeightMap & GetWeightMap ( const T Target
)

 Retrieve a registered vertex weight array by unique ClothPhysicalMeshData.h  

const FPointWeightMap & GetWeightMap ( const T Target
) const

 Retrieve a registered vertex weight array by unique ClothPhysicalMeshData.h  

bool HasWeightMap ( const T Target
) const

 Retrieve whether a vertex weight array has already been registered. ClothPhysicalMeshData.h  

void MigrateFrom ( UClothPhysicalMeshDataBase_Legacy* ClothPhysicalMeshDataBase
)

 Migrate from the legacy physical mesh data class, used to migrate LOD data from the UClothLODDataCommon_Legacy. ClothPhysicalMeshData.h  

void MigrateFrom ( FClothPhysicalMeshData& ClothPhysicalMeshData
)

 Migrate from same, used to migrate LOD data from the UClothLODDataCommon_Legacy. ClothPhysicalMeshData.h  

void Reset ( const int32 InNumVerts,
const int32 InNumIndices
)

 Reset the default common targets for this cloth physical mesh. ClothPhysicalMeshData.h  

Operators

Name Remarks Include Path Unreal Specifiers
  ClothPhysicalMeshData.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
AnimDriveMultipliers_DEPRECATED TArray< float >   ClothPhysicalMeshData.h  
BackstopDistances_DEPRECATED TArray< float >   ClothPhysicalMeshData.h  
BackstopRadiuses_DEPRECATED TArray< float >   ClothPhysicalMeshData.h  
MaxDistances_DEPRECATED TArray< float > Deprecated. Use WeightMaps instead. ClothPhysicalMeshData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page