1. Epic GamesDeveloper
  3. FCollectionClothFacade

FCollectionClothFacade

Cloth Asset collection facade class focused on draping and pattern information.

API > API/Plugins > API/Plugins/ChaosClothAsset

Cloth Asset collection facade class focused on draping and pattern information. Non-const access (read/write) version.

   
Name FCollectionClothFacade
Type class
Header File /Engine/Plugins/ChaosClothAsset/Source/ChaosClothAsset/Public/ChaosClothAsset/CollectionClothFacade.h
Include Path #include "ChaosClothAsset/CollectionClothFacade.h"

Syntax

class FCollectionClothFacade : public UE::Chaos::ClothAsset::FCollectionClothConstFacade

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  ChaosClothAsset/CollectionClothFacade.h  
  ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothFacade ( const TSharedRef< class FClothCollection >& InClothCollection
)

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothFacade ( const TSharedRef< FManagedArrayCollection >& ManagedArrayCollection
)

   ChaosClothAsset/CollectionClothFacade.h  
  ChaosClothAsset/CollectionClothFacade.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FCollectionClothFacade()

   ChaosClothAsset/CollectionClothFacade.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddFabric()

 Add a new fabric to this cloth and return its index in the fabric list. ChaosClothAsset/CollectionClothFacade.h  
Add a new fabric to this cloth and return the fabric facade set to its index. ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothRenderPatternFacade AddGetRenderPattern()

 Add a new pattern to this cloth LOD, and return the cloth pattern facade set to its index. ChaosClothAsset/CollectionClothFacade.h  
Add a new seam to this cloth and return the seam facade set to its index. ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothSimAccessoryMeshFacade AddGetSimAccessoryMesh()

 Add a new accessory mesh to this cloth and return the accessory mesh facade set to its index. ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothSimMorphTargetFacade AddGetSimMorphTarget()

 Add a new sim morph target to this cloth, and return the morph target facade set to its index. ChaosClothAsset/CollectionClothFacade.h  
Add a new pattern to this cloth LOD, and return the cloth pattern facade set to its index. ChaosClothAsset/CollectionClothFacade.h  

int32 AddRenderPattern()

 Add a new pattern to this cloth LOD and return its index in the LOD pattern list. ChaosClothAsset/CollectionClothFacade.h  

int32 AddSeam()

 Add a new seam to this cloth and return its index in the seam list. ChaosClothAsset/CollectionClothFacade.h  

int32 AddSimAccessoryMesh()

 Add a new accessory mesh to this cloth and return its index in the accessory mesh list. ChaosClothAsset/CollectionClothFacade.h  

int32 AddSimMorphTarget()

 Add a sim morph target to this cloth and return its index in the sim morph target pattern list ChaosClothAsset/CollectionClothFacade.h  

int32 AddSimPattern()

 Add a new pattern to this cloth LOD and return its index in the LOD pattern list. ChaosClothAsset/CollectionClothFacade.h  

bool AddUserDefinedAttribute ( const FName& Name,
const FName& GroupName,
const FName& GroupDependency
)

 GroupName must be an existing group as defined in ClothCollectionGroup. Returns success ChaosClothAsset/CollectionClothFacade.h  

void AddWeightMap ( const FName& Name
)

 Add a new weight map to this cloth. Access is then done per pattern. ChaosClothAsset/CollectionClothFacade.h  

void Append ( const FCollectionClothConstFacade& Other
)

 Append data from another cloth collection. ChaosClothAsset/CollectionClothFacade.h  

void CompactSeamStitchLookup()

 Compact SeamStitchLookup to remove any references to INDEX_NONE that may have been created by deleting stitches. ChaosClothAsset/CollectionClothFacade.h  
Remove all morph target vertices with invalid indices. ChaosClothAsset/CollectionClothFacade.h  

void CompactSimVertex2DLookup()

 Compact SimVertex2DLookup to remove any references to INDEX_NONE that may have been created by deleting 2D vertices. ChaosClothAsset/CollectionClothFacade.h  

void DefineSchema ( EClothCollectionExtendedSchemas OptionalSchemas
)

 Create this facade's groups and attributes. ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FString > GetCustomResizingRegionSet()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< int32 > GetCustomResizingRegionType()

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothFabricFacade GetFabric ( int32 FabricIndex
)

 Return a fabric facade for the specified fabric index. ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FVector3f > GetPreResizedSimPosition3D()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< TArray< int32 > > GetRenderBoneIndices()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< TArray< float > > GetRenderBoneWeights()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FLinearColor > GetRenderColor()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< float > GetRenderCustomResizingBlend()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< TArray< FVector4f > > GetRenderDeformerNormalBaryCoordsAndDist()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< int32 > GetRenderDeformerNumInfluences()

 Return a view of all the render deformer number of influences used on this collection across all patterns. ChaosClothAsset/CollectionClothFacade.h  

TArrayView< TArray< FVector4f > > GetRenderDeformerPositionBaryCoordsAndDist()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< TArray< FIntVector3 > > GetRenderDeformerSimIndices3D()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< float > GetRenderDeformerSkinningBlend()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< TArray< FVector4f > > GetRenderDeformerTangentBaryCoordsAndDist()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< TArray< float > > GetRenderDeformerWeight()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FIntVector3 > GetRenderIndices()

 SetNumRenderFaces per pattern within pattern facade. ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FString > GetRenderMaterialPathName()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FSoftObjectPath > GetRenderMaterialSoftObjectPathName()

 Return a view of all the render materials used on this collection across all patterns. ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FVector3f > GetRenderNormal()

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothRenderPatternFacade GetRenderPattern ( int32 PatternIndex
)

 Return a pattern facade for the specified pattern index. ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FVector3f > GetRenderPosition()

 SetNumRenderVertices per pattern within pattern facade. ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FVector3f > GetRenderTangentU()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FVector3f > GetRenderTangentV()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< TArray< FVector2f > > GetRenderUVs()

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothSeamFacade GetSeam ( int32 SeamIndex
)

 Return a seam facade for the specified seam index. ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothSimAccessoryMeshFacade GetSimAccessoryMesh ( int32 MeshIndex
)

 Return an accessory mesh facade for the specified accessory mesh index. ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FName > GetSimAccessoryMeshBoneIndicesAttribute()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FName > GetSimAccessoryMeshBoneWeightsAttribute()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FName > GetSimAccessoryMeshName()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FName > GetSimAccessoryMeshNormalAttribute()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FName > GetSimAccessoryMeshPosition3DAttribute()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< TArray< int32 > > GetSimBoneIndices()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< TArray< float > > GetSimBoneWeights()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< float > GetSimCustomResizingBlend()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< int32 > GetSimImportVertexID()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FIntVector3 > GetSimIndices2D()

 SetNumSimFaces per pattern within pattern facade. ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FIntVector3 > GetSimIndices3D()

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothSimMorphTargetFacade GetSimMorphTarget ( int32 MorphTargetIndex
)

 Return a sim morph target facade for the specified morph target index. ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FVector3f > GetSimMorphTargetPositionDelta()

 Return a view of all sim morph target position deltas ChaosClothAsset/CollectionClothFacade.h  

TArrayView< int32 > GetSimMorphTargetSimVertex3DIndex()

 Return a view of all sim morph target sim vertex 3d indices ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FVector3f > GetSimMorphTargetTangentZDelta()

 Return a view of all sim morph target tangent z deltas ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FVector3f > GetSimNormal()

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothSimPatternFacade GetSimPattern ( int32 PatternIndex
)

 Return a pattern facade for the specified pattern index. ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FVector2f > GetSimPosition2D()

 SetNumSimVertices2D per pattern within pattern facade. ChaosClothAsset/CollectionClothFacade.h  

TArrayView< FVector3f > GetSimPosition3D()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< TArray< int32 > > GetTetherKinematicIndex()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< TArray< float > > GetTetherReferenceLength()

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< T > GetUserDefinedAttribute ( const FName& Name,
const FName& GroupName
)

   ChaosClothAsset/CollectionClothFacade.h  

TArrayView< float > GetWeightMap ( const FName& Name
)

   ChaosClothAsset/CollectionClothFacade.h  

void Initialize ( const FCollectionClothConstFacade& Other
)

 Initialize the cloth using another cloth collection. ChaosClothAsset/CollectionClothFacade.h  

void InitializeCookedOnly ( const FCollectionClothConstFacade& Other
)

 Copy only data that is not stripped on cook ChaosClothAsset/CollectionClothFacade.h  

void PostSerialize ( const FArchive& Ar
)

 Post-Serialize upgrade cloth collection ChaosClothAsset/CollectionClothFacade.h  

void RemoveAllSimVertices3D()

   ChaosClothAsset/CollectionClothFacade.h  

void RemoveFabrics ( const TArray< int32 >& SortedDeletionList
)

 Remove a sorted list of fabrics. ChaosClothAsset/CollectionClothFacade.h  

void RemoveRenderPatterns ( const TArray< int32 >& SortedDeletionList
)

 Remove a sorted list of render patterns. ChaosClothAsset/CollectionClothFacade.h  

void RemoveSeams ( const TArray< int32 >& SortedDeletionList
)

 Remove a sorted list of seams. ChaosClothAsset/CollectionClothFacade.h  

void RemoveSimAccessoryMeshes ( const TArray< int32 >& SortedDeletionList
)

 Remove a sorted list of accessory meshes. ChaosClothAsset/CollectionClothFacade.h  

void RemoveSimMorphTargets ( const TArray< int32 >& SortedDeletionList
)

 Remove a sorted list of sim morph targets. ChaosClothAsset/CollectionClothFacade.h  

void RemoveSimMorphTargetVertices3D ( const TArray< int32 >& SortedDeletionList
)

 Remove a sorted list of sim morph target vertices. ChaosClothAsset/CollectionClothFacade.h  

void RemoveSimPatterns ( const TArray< int32 >& SortedDeletionList
)

 Remove a sorted list of sim patterns. ChaosClothAsset/CollectionClothFacade.h  

void RemoveSimVertices3D ( int32 NumSimVertices
)

 This will remove the 3D vertices, but the associated seams and 2D vertices will still exist, and point to INDEX_NONE ChaosClothAsset/CollectionClothFacade.h  

void RemoveSimVertices3D ( const TArray< int32 >& SortedDeletionList
)

   ChaosClothAsset/CollectionClothFacade.h  

void RemoveUserDefinedAttribute ( const FName& Name,
const FName& GroupName
)

   ChaosClothAsset/CollectionClothFacade.h  

void RemoveWeightMap ( const FName& Name
)

 Remove a weight map from this cloth. ChaosClothAsset/CollectionClothFacade.h  

void Reset()

 Remove all LODs from this cloth. ChaosClothAsset/CollectionClothFacade.h  

void SetNumCustomResizingRegions ( int32 NumGroups
)

   ChaosClothAsset/CollectionClothFacade.h  

void SetNumFabrics ( int32 NumFabrics
)

 Set the new number of fabrics to this cloth. ChaosClothAsset/CollectionClothFacade.h  

void SetNumRenderPatterns ( int32 NumPatterns
)

 Set the new number of patterns to this cloth LOD. ChaosClothAsset/CollectionClothFacade.h  

void SetNumSeams ( int32 NumSeams
)

 Set the new number of seams to this cloth. ChaosClothAsset/CollectionClothFacade.h  

void SetNumSimAccessoryMeshes ( int32 NumMeshes,
bool bCookedOnly
)

 Set the new number of accessory meshes to this cloth. ChaosClothAsset/CollectionClothFacade.h  

void SetNumSimMorphTargets ( int32 NumMorphTargets,
bool bCookedOnly
)

 Set the new number of sim morph targets to this cloth. ChaosClothAsset/CollectionClothFacade.h  

void SetNumSimPatterns ( int32 NumPatterns
)

 Set the new number of patterns to this cloth LOD. ChaosClothAsset/CollectionClothFacade.h  

void SetPhysicsAssetPathName ( const FString& PathName
)

   ChaosClothAsset/CollectionClothFacade.h  

void SetPhysicsAssetSoftObjectPathName ( const FSoftObjectPath& PathName
)

 Set the physics asset path name. ChaosClothAsset/CollectionClothFacade.h  

void SetReferenceBoneName ( const FName& BoneName
)

 Set the reference bone name for this asset. ChaosClothAsset/CollectionClothFacade.h  

void SetSkeletalMeshPathName ( const FString& PathName
)

   ChaosClothAsset/CollectionClothFacade.h  

void SetSkeletalMeshSoftObjectPathName ( const FSoftObjectPath& PathName
)

 Set the skeletal mesh asset path name and the reference skeleton that will be used with this asset. ChaosClothAsset/CollectionClothFacade.h  

void SetSolverAirDamping ( const float SolverAirDamping
)

 Set the solver air damping ChaosClothAsset/CollectionClothFacade.h  

void SetSolverGravity ( const FVector3f& SolverGravity
)

 Set the solver gravity ChaosClothAsset/CollectionClothFacade.h  

void SetSolverSubSteps ( const int32 SolverSubSteps
)

 Set the solver substeps ChaosClothAsset/CollectionClothFacade.h  

void SetSolverTimeStep ( const float SolverTimeStep
)

 Set the solver time step ChaosClothAsset/CollectionClothFacade.h  

Operators

Name Remarks Include Path Unreal Specifiers
  ChaosClothAsset/CollectionClothFacade.h  
  ChaosClothAsset/CollectionClothFacade.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page