Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. FCollectionClothConstFacade

FCollectionClothConstFacade

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. Const access (read only) version.

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

Syntax

class FCollectionClothConstFacade

Derived Classes

Constructors

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

FCollectionClothConstFacade ( const TSharedRef< const class FConstClothCollection >& ClothCollection
)

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothConstFacade ( const TSharedRef< const FManagedArrayCollection >& ManagedArrayCollection
)

   ChaosClothAsset/CollectionClothFacade.h  
  ChaosClothAsset/CollectionClothFacade.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FCollectionClothConstFacade()

   ChaosClothAsset/CollectionClothFacade.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BuildSimulationMesh ( TArray< FVector3f >& Positions,
TArray< FVector3f >& Normals,
TArray< uint32 >& Indices,
TArray< FVector2f >& PatternsPositions,
TArray< uint32 >& PatternsIndices,
TArray< uint32 >& PatternToWeldedIndices,
TArray< TArray< int32 > >* OptionalWeldedToPatternIndices
) const

   ChaosClothAsset/CollectionClothFacade.h  

uint32 CalculateTypeHash ( bool bIncludeWeightMaps,
uint32 PreviousHash
) const

   ChaosClothAsset/CollectionClothFacade.h  

uint32 CalculateUserDefinedAttributesTypeHash ( const FName& GroupName,
uint32 PreviousHash
) const

   ChaosClothAsset/CollectionClothFacade.h  

uint32 CalculateWeightMapTypeHash ( uint32 PreviousHash
) const

   ChaosClothAsset/CollectionClothFacade.h  

int32 FindRenderPatternByFaceIndex ( int32 FaceIndex
) const

 Convenience to find which render pattern a render face belongs to ChaosClothAsset/CollectionClothFacade.h  

int32 FindRenderPatternByVertex ( int32 VertexIndex
) const

 Convenience to find which render pattern a render vertex belongs to ChaosClothAsset/CollectionClothFacade.h  

int32 FindSimAccessoryMeshIndexByName ( const FName& AccessoryMeshName
) const

 Lookup sim accessory mesh by name. Returns INDEX_NONE if not found. ChaosClothAsset/CollectionClothFacade.h  

int32 FindSimMorphTargetIndexByName ( const FString& MorphTargetName
) const

 Lookup sim morph target by name. Returns INDEX_NONE if not found. ChaosClothAsset/CollectionClothFacade.h  

int32 FindSimPatternByFaceIndex ( int32 FaceIndex
) const

 Convenience to find which sim pattern a sim face belongs to ChaosClothAsset/CollectionClothFacade.h  

int32 FindSimPatternByVertex2D ( int32 Vertex2DIndex
) const

 Convenience to find which sim pattern a 2D vertex belongs to ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FString > GetCustomResizingRegionSet()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< int32 > GetCustomResizingRegionType()

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothFabricConstFacade GetFabric ( int32 FabricIndex
) const

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

int32 GetNumCustomResizingRegions()

   ChaosClothAsset/CollectionClothFacade.h  

int32 GetNumFabrics()

 Return the number of fabrics in this collection. ChaosClothAsset/CollectionClothFacade.h  

int32 GetNumRenderFaces()

   ChaosClothAsset/CollectionClothFacade.h  

int32 GetNumRenderPatterns()

 Return the number of patterns in this collection. ChaosClothAsset/CollectionClothFacade.h  

int32 GetNumRenderVertices()

 Return the total number of render vertices for this collection. ChaosClothAsset/CollectionClothFacade.h  

int32 GetNumSeams()

 Return the number of seams in this collection. ChaosClothAsset/CollectionClothFacade.h  

int32 GetNumSimAccessoryMeshes()

 Return the number of accessory meshes in this collection. ChaosClothAsset/CollectionClothFacade.h  

int32 GetNumSimFaces()

 Return the total number of simulation faces for this collection across all patterns. ChaosClothAsset/CollectionClothFacade.h  

int32 GetNumSimMorphTargets()

 Return the number of sim morph targets in this collection. ChaosClothAsset/CollectionClothFacade.h  

int32 GetNumSimMorphTargetVertices()

 Return the total number of sim morph target vertices in this collection. ChaosClothAsset/CollectionClothFacade.h  

int32 GetNumSimPatterns()

 Return the number of patterns in this collection. ChaosClothAsset/CollectionClothFacade.h  

int32 GetNumSimVertices2D()

 Return the total number of 2D simulation vertices for this collection. ChaosClothAsset/CollectionClothFacade.h  

int32 GetNumSimVertices3D()

 Return the total number of 3D simulation vertices for this collection. ChaosClothAsset/CollectionClothFacade.h  

const FString & GetPhysicsAssetPathName()

   ChaosClothAsset/CollectionClothFacade.h  

const FSoftObjectPath & GetPhysicsAssetSoftObjectPathName()

 Return the physics asset path names used for this collection. ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FVector3f > GetPreResizedSimPosition3D()

   ChaosClothAsset/CollectionClothFacade.h  

FName GetReferenceBoneName()

 Return the reference bone name used for this collection. ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< TArray< int32 > > GetRenderBoneIndices()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< TArray< float > > GetRenderBoneWeights()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FLinearColor > GetRenderColor()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< float > GetRenderCustomResizingBlend()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< TArray< FVector4f > > GetRenderDeformerNormalBaryCoordsAndDist()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< int32 > GetRenderDeformerNumInfluences()

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

TConstArrayView< TArray< FVector4f > > GetRenderDeformerPositionBaryCoordsAndDist()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< TArray< FIntVector3 > > GetRenderDeformerSimIndices3D()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< float > GetRenderDeformerSkinningBlend()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< TArray< FVector4f > > GetRenderDeformerTangentBaryCoordsAndDist()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< TArray< float > > GetRenderDeformerWeight()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FIntVector3 > GetRenderIndices()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FString > GetRenderMaterialPathName()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FSoftObjectPath > GetRenderMaterialSoftObjectPathName()

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

TConstArrayView< FVector3f > GetRenderNormal()

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothRenderPatternConstFacade GetRenderPattern ( int32 PatternIndex
) const

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

TConstArrayView< FVector3f > GetRenderPosition()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FVector3f > GetRenderTangentU()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FVector3f > GetRenderTangentV()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< TArray< FVector2f > > GetRenderUVs()

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothSeamConstFacade GetSeam ( int32 SeamIndex
) const

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

TConstArrayView< TArray< int32 > > GetSeamStitchLookup()

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothSimAccessoryMeshConstFacade GetSimAccessoryMesh ( int32 MeshIndex
) const

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

TConstArrayView< FName > GetSimAccessoryMeshBoneIndicesAttribute()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FName > GetSimAccessoryMeshBoneWeightsAttribute()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FName > GetSimAccessoryMeshName()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FName > GetSimAccessoryMeshNormalAttribute()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FName > GetSimAccessoryMeshPosition3DAttribute()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< TArray< int32 > > GetSimBoneIndices()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< TArray< float > > GetSimBoneWeights()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< float > GetSimCustomResizingBlend()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< int32 > GetSimImportVertexID()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FIntVector3 > GetSimIndices2D()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FIntVector3 > GetSimIndices3D()

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothSimMorphTargetConstFacade GetSimMorphTarget ( int32 MorphTargetIndex
) const

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

TConstArrayView< FString > GetSimMorphTargetName()

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

TConstArrayView< FVector3f > GetSimMorphTargetPositionDelta()

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

TConstArrayView< int32 > GetSimMorphTargetSimVertex3DIndex()

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

TConstArrayView< FVector3f > GetSimMorphTargetTangentZDelta()

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

TConstArrayView< FVector3f > GetSimNormal()

   ChaosClothAsset/CollectionClothFacade.h  

FCollectionClothSimPatternConstFacade GetSimPattern ( int32 PatternIndex
) const

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

TConstArrayView< FVector2f > GetSimPosition2D()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< FVector3f > GetSimPosition3D()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< TArray< int32 > > GetSimVertex2DLookup()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< int32 > GetSimVertex3DLookup()

   ChaosClothAsset/CollectionClothFacade.h  

const FString & GetSkeletalMeshPathName()

   ChaosClothAsset/CollectionClothFacade.h  

const FSoftObjectPath & GetSkeletalMeshSoftObjectPathName()

 Return the skeleton asset path names used for this collection. ChaosClothAsset/CollectionClothFacade.h  

float GetSolverAirDamping()

 Return the solver air damping used for this collection. ChaosClothAsset/CollectionClothFacade.h  

const FVector3f & GetSolverGravity()

 Return the solver gravity vector used for this collection. ChaosClothAsset/CollectionClothFacade.h  

int32 GetSolverSubSteps()

 Return the solver sub steps used for this collection. ChaosClothAsset/CollectionClothFacade.h  

float GetSolverTimeStep()

 Return the solver time step used for this collection. ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< TArray< int32 > > GetTetherKinematicIndex()

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< TArray< float > > GetTetherReferenceLength()

   ChaosClothAsset/CollectionClothFacade.h  

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

   ChaosClothAsset/CollectionClothFacade.h  

TArray< FName > GetUserDefinedAttributeNames ( const FName& GroupName
) const

   ChaosClothAsset/CollectionClothFacade.h  

TConstArrayView< float > GetWeightMap ( const FName& Name
) const

   ChaosClothAsset/CollectionClothFacade.h  

TArray< FName > GetWeightMapNames()

 Return the name of all user weight maps on this cloth collection. ChaosClothAsset/CollectionClothFacade.h  

bool HasSolverElement()

 Return true if the solver group has one element ChaosClothAsset/CollectionClothFacade.h  

bool HasUserDefinedAttribute ( const FName& Name,
const FName& GroupName
) const

   ChaosClothAsset/CollectionClothFacade.h  

bool HasValidData()

 Return whether the facade has a non-empty sim and render mesh data. ChaosClothAsset/CollectionClothFacade.h  

bool HasValidRenderData()

 Return whether the facade has a non-empty sim mesh data. ChaosClothAsset/CollectionClothFacade.h  

bool HasValidSimulationData()

 Return whether the facade has a non-empty simulation mesh data. ChaosClothAsset/CollectionClothFacade.h  

bool HasWeightMap ( const FName& Name
) const

 Return whether this cloth collection has the specified weight map. ChaosClothAsset/CollectionClothFacade.h  

bool IsValid ( EClothCollectionExtendedSchemas OptionalSchemas
) const

 Return whether the facade is defined on the collection. ChaosClothAsset/CollectionClothFacade.h  

Protected

Static

Name Remarks Include Path Unreal Specifiers

static TArray< FName > GetValidClothCollectionGroupName()

   ChaosClothAsset/CollectionClothFacade.h  

static bool IsValidClothCollectionGroupName ( const FName& GroupName
)

   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