UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FClothPhysicalMeshData Struct Reference

#include <ClothPhysicalMeshData.h>

Public Member Functions

CLOTHINGSYSTEMRUNTIMECOMMON_API FClothPhysicalMeshData ()
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS ~FClothPhysicalMeshData ()=default
 
 FClothPhysicalMeshData (const FClothPhysicalMeshData &)=default
 
FClothPhysicalMeshDataoperator= (const FClothPhysicalMeshData &)=default
 
PRAGMA_ENABLE_DEPRECATION_WARNINGS CLOTHINGSYSTEMRUNTIMECOMMON_API void MigrateFrom (FClothPhysicalMeshData &ClothPhysicalMeshData)
 
CLOTHINGSYSTEMRUNTIMECOMMON_API void MigrateFrom (UClothPhysicalMeshDataBase_Legacy *ClothPhysicalMeshDataBase)
 
CLOTHINGSYSTEMRUNTIMECOMMON_API void Reset (const int32 InNumVerts, const int32 InNumIndices)
 
CLOTHINGSYSTEMRUNTIMECOMMON_API void ClearWeightMaps ()
 
CLOTHINGSYSTEMRUNTIMECOMMON_API void BuildSelfCollisionData (float SelfCollisionRadius)
 
CLOTHINGSYSTEMRUNTIMECOMMON_API void CalculateInverseMasses ()
 
CLOTHINGSYSTEMRUNTIMECOMMON_API void CalculateNumInfluences ()
 
CLOTHINGSYSTEMRUNTIMECOMMON_API void CalculateTethers (bool bUseEuclideanDistance, bool bUseGeodesicDistance)
 
template<typename T >
bool HasWeightMap (const T Target) const
 
template<typename T >
const FPointWeightMapFindWeightMap (const T Target) const
 
template<typename T >
FPointWeightMapFindWeightMap (const T Target)
 
template<typename T >
FPointWeightMapAddWeightMap (const T Target)
 
template<typename T >
FPointWeightMapFindOrAddWeightMap (const T Target)
 
template<typename T >
const FPointWeightMapGetWeightMap (const T Target) const
 
template<typename T >
FPointWeightMapGetWeightMap (const T Target)
 

Public Attributes

TArray< FVector3fVertices
 
TArray< FVector3fNormals
 
TArray< uint32Indices
 
TMap< uint32, FPointWeightMapWeightMaps
 
TArray< floatInverseMasses
 
TArray< FClothVertBoneDataBoneData
 
TSet< int32SelfCollisionVertexSet
 
FClothTetherData EuclideanTethers
 
FClothTetherData GeodesicTethers
 
int32 MaxBoneWeights
 
int32 NumFixedVerts
 
TArray< uint32SelfCollisionIndices
 

Detailed Description

Spatial simulation data for a mesh.

Constructor & Destructor Documentation

◆ FClothPhysicalMeshData() [1/2]

FClothPhysicalMeshData::FClothPhysicalMeshData ( )

Construct an empty cloth physical mesh with default common targets.

◆ ~FClothPhysicalMeshData()

PRAGMA_DISABLE_DEPRECATION_WARNINGS FClothPhysicalMeshData::~FClothPhysicalMeshData ( )
default

◆ FClothPhysicalMeshData() [2/2]

FClothPhysicalMeshData::FClothPhysicalMeshData ( const FClothPhysicalMeshData )
default

Member Function Documentation

◆ AddWeightMap()

template<typename T >
FPointWeightMap & FClothPhysicalMeshData::AddWeightMap ( const T  Target)
inline

Retrieve a pointer to a registered vertex weight array by unique

Parameters
Id,oradd one if it doesn't exist already.

◆ BuildSelfCollisionData()

void FClothPhysicalMeshData::BuildSelfCollisionData ( float  SelfCollisionRadius)

Build the self collision indices with the specified radius.

◆ CalculateInverseMasses()

void FClothPhysicalMeshData::CalculateInverseMasses ( )

Recalculate the node inverse masses.

◆ CalculateNumInfluences()

void FClothPhysicalMeshData::CalculateNumInfluences ( )

Recalculate the number of influences for the bone data.

◆ CalculateTethers()

void FClothPhysicalMeshData::CalculateTethers ( bool  bUseEuclideanDistance,
bool  bUseGeodesicDistance 
)

Recalculate the long range attachment tethers.

◆ ClearWeightMaps()

void FClothPhysicalMeshData::ClearWeightMaps ( )

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

◆ FindOrAddWeightMap()

template<typename T >
FPointWeightMap & FClothPhysicalMeshData::FindOrAddWeightMap ( const T  Target)
inline

Retrieve a pointer to a registered vertex weight array by unique

Parameters
Id,oradd one if it doesn't exist already.

◆ FindWeightMap() [1/2]

template<typename T >
FPointWeightMap * FClothPhysicalMeshData::FindWeightMap ( const T  Target)
inline

Retrieve a pointer to a registered vertex weight array by unique

Parameters
Id,ornullptr if none is found.

◆ FindWeightMap() [2/2]

template<typename T >
const FPointWeightMap * FClothPhysicalMeshData::FindWeightMap ( const T  Target) const
inline

Retrieve a pointer to a registered vertex weight array by unique

Parameters
Id,ornullptr if none is found.

◆ GetWeightMap() [1/2]

template<typename T >
FPointWeightMap & FClothPhysicalMeshData::GetWeightMap ( const T  Target)
inline

Retrieve a registered vertex weight array by unique

Parameters
Id.The array must exists or this function will assert.

◆ GetWeightMap() [2/2]

template<typename T >
const FPointWeightMap & FClothPhysicalMeshData::GetWeightMap ( const T  Target) const
inline

Retrieve a registered vertex weight array by unique

Parameters
Id.The array must exists or this function will assert.

◆ HasWeightMap()

template<typename T >
bool FClothPhysicalMeshData::HasWeightMap ( const T  Target) const
inline

Retrieve whether a vertex weight array has already been registered.

◆ MigrateFrom() [1/2]

void FClothPhysicalMeshData::MigrateFrom ( FClothPhysicalMeshData ClothPhysicalMeshData)

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

◆ MigrateFrom() [2/2]

void FClothPhysicalMeshData::MigrateFrom ( UClothPhysicalMeshDataBase_Legacy ClothPhysicalMeshDataBase)

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

◆ operator=()

FClothPhysicalMeshData & FClothPhysicalMeshData::operator= ( const FClothPhysicalMeshData )
default

◆ Reset()

void FClothPhysicalMeshData::Reset ( const int32  InNumVerts,
const int32  InNumIndices 
)

Reset the default common targets for this cloth physical mesh.

Member Data Documentation

◆ BoneData

TArray<FClothVertBoneData> FClothPhysicalMeshData::BoneData

◆ EuclideanTethers

FClothTetherData FClothPhysicalMeshData::EuclideanTethers

◆ GeodesicTethers

FClothTetherData FClothPhysicalMeshData::GeodesicTethers

◆ Indices

TArray<uint32> FClothPhysicalMeshData::Indices

◆ InverseMasses

TArray<float> FClothPhysicalMeshData::InverseMasses

◆ MaxBoneWeights

int32 FClothPhysicalMeshData::MaxBoneWeights

◆ Normals

TArray<FVector3f> FClothPhysicalMeshData::Normals

◆ NumFixedVerts

int32 FClothPhysicalMeshData::NumFixedVerts

◆ SelfCollisionIndices

TArray<uint32> FClothPhysicalMeshData::SelfCollisionIndices

◆ SelfCollisionVertexSet

TSet<int32> FClothPhysicalMeshData::SelfCollisionVertexSet

◆ Vertices

TArray<FVector3f> FClothPhysicalMeshData::Vertices

◆ WeightMaps

TMap<uint32, FPointWeightMap> FClothPhysicalMeshData::WeightMaps

The documentation for this struct was generated from the following files: