1. Epic GamesDeveloper
  3. UChaosClothAsset

UChaosClothAsset

Cloth asset for pattern based simulation.

API > API/Plugins > API/Plugins/ChaosClothAssetEngine

Cloth asset for pattern based simulation.

   
Name UChaosClothAsset
Type class
Header File /Engine/Plugins/ChaosClothAsset/Source/ChaosClothAssetEngine/Public/ChaosClothAsset/ClothAsset.h
Include Path #include "ChaosClothAsset/ClothAsset.h"

Syntax

UCLASS (MinimalAPI, HideCategories=Object, BlueprintType, prioritizeCategories=("Dataflow"))  
class UChaosClothAsset : public UChaosClothAssetBase

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UChaosClothAsset ( const FObjectInitializer& ObjectInitializer
)

   ChaosClothAsset/ClothAsset.h  
  ChaosClothAsset/ClothAsset.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UChaosClothAsset()

   ChaosClothAsset/ClothAsset.h  

Structs

Name Remarks
FBuilder Builder utility struct, nested struct of UChaosClothAsset.

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AssetGuid FGuid A unique identifier as used by the section rendering code. ChaosClothAsset/ClothAsset.h  
ClothCollections TArray< TSharedRef< const FManagedArrayCollection > > Cloth Collection containing this asset data. One per LOD. ChaosClothAsset/ClothAsset.h  
ClothSimulationModel TSharedPtr< FChaosClothSimulationModel > Simulation mesh Lods as fed to the solver for constraints creation. ChaosClothAsset/ClothAsset.h  
MeshModel TSharedPtr< FSkeletalMeshModel > Source mesh geometry information (not used at runtime). ChaosClothAsset/ClothAsset.h  
PhysicsAsset TObjectPtr< UPhysicsAsset > Physics asset used for collision. Set by the Dataflow evaluation. ChaosClothAsset/ClothAsset.h
  • EditAnywhere
  • Category=Collision
  • Meta=(EditCondition="!bHasDataflowAsset")
Skeleton TObjectPtr< USkeleton > Skeleton asset used at creation time. ChaosClothAsset/ClothAsset.h
  • EditAnywhere
  • Setter=SetSkeleton
  • Category=Skeleton
  • Meta=(EditCondition="!bHasDataflowAsset")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Build ( const TArray< TSharedRef< const FManagedArrayCollection > >& InClothCollections,
TArray< FChaosClothAssetLodTransitionDataCache >* InOutTransitionCache,
FText* ErrorText,
FText* VerboseText
)

 Rebuild this asset from the specified managed array collection data. ChaosClothAsset/ClothAsset.h  

void Build ( TArray< FChaosClothAssetLodTransitionDataCache >* InOutTransitionCache
)

   ChaosClothAsset/ClothAsset.h  
Copy the draped simulation mesh patterns into the render mesh data. ChaosClothAsset/ClothAsset.h  
Return the enclosed Cloth Collections. ChaosClothAsset/ClothAsset.h  
  ChaosClothAsset/ClothAsset.h  

FString GetDataflowTerminal()

 Return the Dataflow graph asset associated to this cloth asset if any. ChaosClothAsset/ClothAsset.h  

void SetClothCollections ( TArray< TSharedRef< const FManagedArrayCollection > >&& InClothCollections
)

 Set new Cloth Collections for this Cloth Asset. ChaosClothAsset/ClothAsset.h  

void SetDataflowTerminal ( const FString& InDataflowTerminal
)

 Set the name of the Dataflow terminal node for this cloth asset. ChaosClothAsset/ClothAsset.h  

void SetPhysicsAsset ( UPhysicsAsset* InPhysicsAsset
)

 Set the physics asset for this cloth. ChaosClothAsset/ClothAsset.h  

void SetReferenceSkeleton ( const FReferenceSkeleton* ReferenceSkeleton,
bool bRebuildModels,
bool bRebindMeshes
)

   ChaosClothAsset/ClothAsset.h  

void UpdateSkeletonFromCollection ( bool bRebuildModels
)

   ChaosClothAsset/ClothAsset.h  

Overridden from UChaosClothAssetBase

Name Remarks Include Path Unreal Specifiers

virtual void CacheDerivedData ( FSkinnedAssetCompilationContext* Context
)

 Load render data from DDC if the data is cached, otherwise generate render data and save into DDC ChaosClothAsset/ClothAsset.h  

virtual FGuid GetAssetGuid ( int32 ModelIndex
) const

 Return the asset GUID used to match the render sections for this asset model. ChaosClothAsset/ClothAsset.h  

virtual TSharedPtr< const FChaosClothSimulationModel > GetClothSimulationModel ( int32
) const

 Return the cloth simulation ready LOD model data. ChaosClothAsset/ClothAsset.h  

virtual FName GetClothSimulationModelName ( int32 ModelIndex
) const

 Return the name of the specified cloth simulation models in this asset. ChaosClothAsset/ClothAsset.h  

virtual const TArray< TSharedRef< const FManagedArrayCollection > > & GetCollections ( int32 ModelIndex
) const

 Return the collections for this asset model (one per LOD). ChaosClothAsset/ClothAsset.h  

virtual int32 GetNumClothSimulationModels()

 Return the number of cloth simulation models in this asset. ChaosClothAsset/ClothAsset.h  

virtual const UPhysicsAsset * GetPhysicsAssetForModel ( int32 ModelIndex
) const

 Return the physics asset used for the simulation by this asset model. ChaosClothAsset/ClothAsset.h  

virtual bool HasValidClothSimulationModels()

 Return whether the asset has any valid cloth simulation models and is simulation enabled. ChaosClothAsset/ClothAsset.h  

virtual void SetReferenceSkeleton ( const FReferenceSkeleton* ReferenceSkeleton
)

   ChaosClothAsset/ClothAsset.h  

Overridden from USkinnedAsset

Name Remarks Include Path Unreal Specifiers

virtual FString BuildDerivedDataKey ( const ITargetPlatform* TargetPlatform
)

   ChaosClothAsset/ClothAsset.h  

virtual void BuildLODModel ( FSkeletalMeshRenderData& RenderData,
const ITargetPlatform* TargetPlatform,
int32 LODIndex
)

 Build a LOD model for the targeted platform. ChaosClothAsset/ClothAsset.h  

virtual FSkeletalMeshModel * GetImportedModel()

   ChaosClothAsset/ClothAsset.h  

virtual UPhysicsAsset * GetPhysicsAsset()

   ChaosClothAsset/ClothAsset.h  

virtual const USkeleton * GetSkeleton ()

   ChaosClothAsset/ClothAsset.h  

virtual USkeleton * GetSkeleton ()

   ChaosClothAsset/ClothAsset.h  

virtual bool IsInitialBuildDone()

   ChaosClothAsset/ClothAsset.h  

virtual void SetSkeleton ( USkeleton* InSkeleton
)

   ChaosClothAsset/ClothAsset.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   ChaosClothAsset/ClothAsset.h  

virtual void PostLoad()

   ChaosClothAsset/ClothAsset.h  

virtual void Serialize ( FArchive& Ar
)

   ChaosClothAsset/ClothAsset.h  

Static

Name Remarks Include Path Unreal Specifiers

static void OnLodStrippingQualityLevelChanged ( IConsoleVariable*
)

   ChaosClothAsset/ClothAsset.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page