Navigation
API > API/Plugins > API/Plugins/ChaosCloth
Chaos config settings shared between all instances of a skeletal mesh. Unlike UChaosClothConfig, these settings contain common cloth simulation parameters that cannot change between the various clothing assets assigned to a specific skeletal mesh. @seealso UChaosClothConfig.
| Name | UChaosClothSharedSimConfig |
| Type | class |
| Header File | /Engine/Plugins/ChaosCloth/Source/ChaosCloth/Public/ChaosCloth/ChaosClothConfig.h |
| Include Path | #include "ChaosCloth/ChaosClothConfig.h" |
Syntax
UCLASS (MinimalAPI)
class UChaosClothSharedSimConfig : public UClothSharedConfigCommon
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UClothConfigBase → UClothConfigCommon → UClothSharedConfigCommon → UChaosClothSharedSimConfig
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UChaosClothSharedSimConfig() |
ChaosCloth/ChaosClothConfig.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UChaosClothSharedSimConfig() |
ChaosCloth/ChaosClothConfig.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUseLocalSpaceSimulation | bool | Enable local space simulation to help with jitter due to floating point precision errors if the character is far away from the world origin. | ChaosCloth/ChaosClothConfig.h | |
| bUseXPBDConstraints | bool | Enable the XPBD constraints that resolve stiffness independently from the number of iterations Experimental, this feature might be removed without warning, not for production use | ChaosCloth/ChaosClothConfig.h | |
| IterationCount | int32 | The number of time step dependent solver iterations. | ChaosCloth/ChaosClothConfig.h |
|
| MaxIterationCount | int32 | The maximum number of solver iterations. | ChaosCloth/ChaosClothConfig.h |
|
| SubdivisionCount | int32 | The number of solver substeps. | ChaosCloth/ChaosClothConfig.h |
|
Functions
Public
Overridden from UClothConfigCommon
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void MigrateFrom
(
const FClothConfig_Legacy& ClothConfig |
Migrate from the legacy FClothConfig structure. | ChaosCloth/ChaosClothConfig.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeChainProperty
(
FPropertyChangedChainEvent& ChainEvent |
Called after changes in any of the asset properties. | ChaosCloth/ChaosClothConfig.h | |
virtual void PostLoad() |
PostLoad override used to deal with updates/changes in properties. | ChaosCloth/ChaosClothConfig.h | |
virtual void Serialize
(
FArchive& Ar |
Serialize override used to set the current custom version. | ChaosCloth/ChaosClothConfig.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUseDampingOverride_DEPRECATED | bool | Use shared config damping rather than per cloth damping. | ChaosCloth/ChaosClothConfig.h | |
| bUseGravityOverride_DEPRECATED | bool | Use the config gravity value instead of world gravity. | ChaosCloth/ChaosClothConfig.h | |
| CollisionThickness_DEPRECATED | float | The radius of cloth points when considering collisions against collider shapes. | ChaosCloth/ChaosClothConfig.h | |
| Damping_DEPRECATED | float | The amount of cloth damping. Override the per cloth damping coefficients. | ChaosCloth/ChaosClothConfig.h | |
| Gravity_DEPRECATED | FVector | The gravitational acceleration vector [cm/s^2]. | ChaosCloth/ChaosClothConfig.h | |
| GravityScale_DEPRECATED | float | Scale factor applied to the world gravity and also to the clothing simulation interactor gravity. Does not affect the gravity if set using the override below. | ChaosCloth/ChaosClothConfig.h | |
| SelfCollisionThickness_DEPRECATED | float | The radius of the spheres used in self collision. | ChaosCloth/ChaosClothConfig.h |