1. Epic GamesDeveloper
  3. FClothingSimulationMesh

FClothingSimulationMesh

Mesh simulation node.

API > API/Plugins > API/Plugins/ChaosCloth

Mesh simulation node.

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

Syntax

class FClothingSimulationMesh

Derived Classes

Constructors

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

FClothingSimulationMesh ( const FString& InDebugName
)

   ChaosCloth/ChaosClothingSimulationMesh.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FClothingSimulationMesh()

   ChaosCloth/ChaosClothingSimulationMesh.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DebugName FString Debug name of the source component. ChaosCloth/ChaosClothingSimulationMesh.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyMorphTarget ( int32 LODIndex,
int32 ActiveMorphTargetIndex,
float ActiveMorphTargetWeight,
const TArrayView< Softs::FSolverVec3 >& InOutPositions,
const TArrayView< Softs::FSolverVec3 >& InOutNormals
) const

 Apply a Morph Target to a given set of positions ChaosCloth/ChaosClothingSimulationMesh.h  

virtual int32 FindMorphTargetByName ( int32 LODIndex,
const FString& Name
) const

 Return the MorphTargetIndex for a given Morph Target Name, if it exists. ChaosCloth/ChaosClothingSimulationMesh.h  

virtual const FClothingSimulationAccessoryMesh * GetAccessoryMesh ( int32 LODIndex,
const FName& AccessoryMeshName
) const

 Return the Accessory Mesh if it exists. ChaosCloth/ChaosClothingSimulationMesh.h  

virtual TConstArrayView< FName > GetAllAccessoryMeshNames ( int32 LODIndex
) const

   ChaosCloth/ChaosClothingSimulationMesh.h  

virtual TConstArrayView< FString > GetAllMorphTargetNames ( int32 LODIndex
) const

 Get a list of all MorphTargets for a given LODIndex. (Index matches FindMorphTargetByName) ChaosCloth/ChaosClothingSimulationMesh.h  

TConstArrayView< FClothVertBoneData > GetBoneData ( int32 LODIndex
) const

 Return the bone data containing bone weights and influences. ChaosCloth/ChaosClothingSimulationMesh.h  

TConstArrayView< int32 > GetBoneMap()

 Return the bone map used to remap the used bones index into the correct skinning matrix index. ChaosCloth/ChaosClothingSimulationMesh.h  

const TArray< FTransform > & GetBoneTransforms()

 Return the bone transforms as required when updating the collider pose. ChaosCloth/ChaosClothingSimulationMesh.h  

const FTransform & GetComponentToWorldTransform()

 Return the transform of the bone treated as the root of the simulation space. ChaosCloth/ChaosClothingSimulationMesh.h  

const FString & GetDebugName()

   ChaosCloth/ChaosClothingSimulationMesh.h  

FClothingSimulationDefaultAccessoryMesh GetDefaultAccessoryMesh ( int32 LODIndex
) const

   ChaosCloth/ChaosClothingSimulationMesh.h  

TMap< FString, TConstArrayView< int32 > > GetFaceIntMaps ( int32 LODIndex
) const

 Return the specified LOD's face int maps. ChaosCloth/ChaosClothingSimulationMesh.h  

TMap< FString, const TSet< int32 > * > GetFaceSets ( int32 LODIndex
) const

 Return the specified LOD's face sets. ChaosCloth/ChaosClothingSimulationMesh.h  

TConstArrayView< uint32 > GetIndices ( int32 LODIndex
) const

 Return the specified LOD's triangle indices for this mesh. ChaosCloth/ChaosClothingSimulationMesh.h  

int32 GetLODIndex ()

 Return the cloth mesh LOD Index. ChaosCloth/ChaosClothingSimulationMesh.h  

virtual int32 GetLODIndexFromOwnerLODIndex ( int32 OwnerLODIndex
) const

 Return the cloth mesh LOD Index for a given owner LOD index. ChaosCloth/ChaosClothingSimulationMesh.h  

virtual TSharedPtr< const FManagedArrayCollection > GetManagedArrayCollection ( int32 LODIndex
) const

 Return the associated ManagedArrayCollection for this LOD, if it exists. ChaosCloth/ChaosClothingSimulationMesh.h  

virtual TConstArrayView< int32 > GetMorphTargetIndices ( int32 LODIndex,
int32 MorphTargetIndex
) const

 Get all Morph Target indices for a given MorphTargetIndex (e.g., index returned by FindMorphTargetByName). ChaosCloth/ChaosClothingSimulationMesh.h  

virtual TConstArrayView< FVector3f > GetMorphTargetPositionDeltas ( int32 LODIndex,
int32 MorphTargetIndex
) const

 Get all Morph Target position deltas for a given MorphTargetIndex (e.g., index returned by FindMorphTargetByName). ChaosCloth/ChaosClothingSimulationMesh.h  

virtual TConstArrayView< FVector3f > GetMorphTargetTangentZDeltas ( int32 LODIndex,
int32 MorphTargetIndex
) const

 Get all Morph Target tangent z (normal) deltas for a given MorphTargetIndex (e.g., index returned by FindMorphTargetByName). ChaosCloth/ChaosClothingSimulationMesh.h  

TConstArrayView< FVector3f > GetNormals ( int32 LODIndex
) const

 Return the source mesh normals (pre-skinning). ChaosCloth/ChaosClothingSimulationMesh.h  

int32 GetNumLODs()

 Return the number of LODs on this mesh. ChaosCloth/ChaosClothingSimulationMesh.h  

int32 GetNumPatternPoints ( int32 LODIndex
) const

 Return the number of pattern points (2d, unwelded) for the specified LOD, or 0 if patterns are not supported or the LOD is empty or invalid. ChaosCloth/ChaosClothingSimulationMesh.h  

int32 GetNumPoints ( int32 LODIndex
) const

 Return the number of points for the specified LOD, or 0 if the LOD is empty or invalid. ChaosCloth/ChaosClothingSimulationMesh.h  

int32 GetOwnerLODIndex ( int32 LODIndex
) const

 Return the owner component LOD Index from the specified cloth mesh LOD index, or 0 if the owner LOD cannot be determined. ChaosCloth/ChaosClothingSimulationMesh.h  

TConstArrayView< uint32 > GetPatternIndices ( int32 LODIndex
) const

 Return the specified LOD's pattern (unwelded) triangle indices for this mesh, or empty array if patterns are not supported. ChaosCloth/ChaosClothingSimulationMesh.h  

TConstArrayView< FVector2f > GetPatternPositions ( int32 LODIndex
) const

 Return the source mesh 2d pattern positions. ChaosCloth/ChaosClothingSimulationMesh.h  

TConstArrayView< uint32 > GetPatternToWeldedIndices ( int32 LODIndex
) const

 Return the specified LOD's map from pattern (unwelded) vertices to (welded) vertices, or empty array if patterns are not supported. ChaosCloth/ChaosClothingSimulationMesh.h  

TConstArrayView< FVector3f > GetPositions ( int32 LODIndex
) const

 Return the source mesh positions (pre-skinning). ChaosCloth/ChaosClothingSimulationMesh.h  

int32 GetReferenceBoneIndex()

 Return the bone to treat as the root of the simulation space. ChaosCloth/ChaosClothingSimulationMesh.h  

FName GetReferenceBoneName()

   ChaosCloth/ChaosClothingSimulationMesh.h  

FTransform GetReferenceBoneTransform()

 Return the transform of the bone treated as the root of the simulation space. ChaosCloth/ChaosClothingSimulationMesh.h  

const TArray< FMatrix44f > & GetRefToLocalMatrices()

 Return the skinning matrices. ChaosCloth/ChaosClothingSimulationMesh.h  

virtual Softs::FSolverReal GetScale()

 Return this mesh uniform scale as the maximum of the three axis scale value. ChaosCloth/ChaosClothingSimulationMesh.h  

TArray< TConstArrayView< TTuple< int32, int32, float > > > GetTethers ( int32 LODIndex,
bool bUseGeodesicTethers
) const

 Return the tethers connections for the long range attachment into convenient parallel friendly batches. ChaosCloth/ChaosClothingSimulationMesh.h  

TConstArrayView< FMeshToMeshVertData > GetTransitionDownSkinData ( int32 LODIndex
) const

 Return the transition down data (PrevLODIndex > LODIndex), for matching shapes during LOD changes. ChaosCloth/ChaosClothingSimulationMesh.h  

TConstArrayView< FMeshToMeshVertData > GetTransitionUpSkinData ( int32 LODIndex
) const

 Return the transition up data (PrevLODIndex < LODIndex), for matching shapes during LOD changes. ChaosCloth/ChaosClothingSimulationMesh.h  

TMap< FString, const TSet< int32 > * > GetVertexSets ( int32 LODIndex
) const

 Return the specified LOD's vertex sets. ChaosCloth/ChaosClothingSimulationMesh.h  

TMap< FString, int32 > GetWeightMapIndices ( int32 LODIndex
) const

 Return a map of all weight map names associated with this mesh to the index in the array returned by GetWeightMaps. ChaosCloth/ChaosClothingSimulationMesh.h  

TArray< FName > GetWeightMapNames ( int32 LODIndex
) const

 Return all weight maps associated with this mesh returned in the same order as GetWeightMaps. ChaosCloth/ChaosClothingSimulationMesh.h  

TArray< TConstArrayView< FRealSingle > > GetWeightMaps ( int32 LODIndex
) const

 Return the specified LOD's weight map. ChaosCloth/ChaosClothingSimulationMesh.h  

bool IsValidLODIndex ( int32 LODIndex
) const

 Return whether the specified LOD index is valid. ChaosCloth/ChaosClothingSimulationMesh.h  

void Update ( FClothingSimulationSolver* Solver,
int32 PrevLODIndex,
int32 LODIndex,
int32 PrevOffset,
int32 Offset,
int32 ActiveMorphTargetIndex,
float ActiveMorphTargetWeight
)

 Update the mesh for the next solver step, doing skinning and matching the shapes during LOD changes. ChaosCloth/ChaosClothingSimulationMesh.h  

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

 Deform the specified positions to match the shape of the previous LOD. ChaosCloth/ChaosClothingSimulationMesh.h  

bool 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
) const

 Deform the specified positions and transfer velocities to match the dynamics of the previous LOD. ChaosCloth/ChaosClothingSimulationMesh.h  

Operators

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page