1. Epic GamesDeveloper
  3. UChaosClothConfig

UChaosClothConfig

Hiding categories that will be used in the future.

API > API/Plugins > API/Plugins/ChaosCloth

Holds initial, asset level config for clothing actors.

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

Syntax

UCLASS (HideCategories=(Collision), MinimalAPI)  
class UChaosClothConfig : public UClothConfigCommon

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UChaosClothConfig()

   ChaosCloth/ChaosClothConfig.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UChaosClothConfig()

   ChaosCloth/ChaosClothConfig.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AngularVelocityScale float The amount of angular velocities sent to the local cloth space from the reference bone (the closest bone to the root on which the cloth section has been skinned, or the root itself if the cloth isn't skinned). ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1")
AnimDriveDamping FChaosClothWeightedValue The damping amount of the anim drive. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1")
AnimDriveStiffness FChaosClothWeightedValue The strength of the constraint driving the cloth towards the animated goal mesh. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1")
AreaStiffnessWeighted FChaosClothWeightedValue The stiffness of the surface area preservation constraints. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Material Properties"
  • DisplayName="Area Stiffness"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1")
bEnableAngularAccelerationClamping bool Enable angular acceleration clamping. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(InlineEditConditionToggle)
bEnableAngularVelocityClamping bool Enable angular velocity clamping. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(InlineEditConditionToggle)
bEnableLinearAccelerationClamping bool Enable linear acceleration clamping. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(InlineEditConditionToggle)
bEnableLinearVelocityClamping bool Enable linear velocity clamping. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(InlineEditConditionToggle)
bEnableOuterDrag bool   ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Environmental Properties"
  • Meta=(InlineEditConditionToggle)
bEnableOuterLift bool   ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Environmental Properties"
  • Meta=(InlineEditConditionToggle)
BendingStiffnessWeighted FChaosClothWeightedValue The Stiffness of cross segments and bending elements constraints. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Material Properties"
  • DisplayName="Bending Stiffness"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1")
BucklingRatio float Once the element has bent such that it's folded more than this ratio from its rest angle ("buckled"), switch to using Buckling Stiffness instead of Bending Stiffness. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Material Properties"
  • DisplayName="Buckling Ratio"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1", EditCondition="bUseBendingElements")
BucklingStiffnessWeighted FChaosClothWeightedValue Bending will use this stiffness instead of Bending Stiffness once the cloth has buckled, i.e., bent beyond a certain angle. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Material Properties"
  • DisplayName="Buckling Stiffness"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1", EditCondition="bUseBendingElements")
bUseBendingElements bool Enable the more accurate bending element constraints instead of the faster cross-edge spring constraints used for controlling bending stiffness. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Material Properties"
bUseCCD bool Use continuous collision detection (CCD) to prevent any missed collisions between fast moving particles and colliders. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Collision Properties"
bUseContinuousCollisionDetection bool Enable continuous collision detection. ChaosCloth/ChaosClothConfig.h  
bUseGeodesicDistance bool Use geodesic instead of euclidean distance calculations for the Long Range Attachment constraint, which is slower at setup but more accurate at establishing the correct position and length of the tethers, and therefore is less prone to artifacts during the simulation. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Long Range Attachment"
bUseGravityOverride bool Use the config gravity value instead of world gravity. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Environmental Properties"
  • Meta=(InlineEditConditionToggle)
bUseLegacyBackstop bool This parameter is automatically set by the migration code. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Collision Properties"
bUsePointBasedWindModel bool This parameter is automatically set by the migration code. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Environmental Properties"
bUseSelfCollisions bool Enable self collision repulsion forces (point-face). ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Collision Properties"
bUseSelfCollisionSpheres bool Enable sphere-based self collision repulsion forces. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Collision Properties"
  • Meta=(EditCondition="!bUseSelfCollisions")
bUseSelfIntersections bool Enable self intersection resolution. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Collision Properties"
  • Meta=(EditCondition="bUseSelfCollisions")
bUseTetrahedralConstraints bool Enable tetrahedral constraints. ChaosCloth/ChaosClothConfig.h  
bUseThinShellVolumeConstraints bool Enable thin shell volume constraints. ChaosCloth/ChaosClothConfig.h  
CollisionThickness float The added thickness of collision shapes. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Collision Properties"
  • Meta=(UIMin="0", UIMax="100", ClampMin="0", ClampMax="1000")
DampingCoefficient float The amount of global damping applied to the cloth velocities, also known as point damping. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Environmental Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1")
Density float The value used when Mass Mode is set to Density. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Mass Properties"
  • Meta=(UIMin="0.001", UIMax="1", ClampMin="0", EditCondition="MassMode == EClothMassMode::Density")
Drag FChaosClothWeightedValue The aerodynamic coefficient of drag applying on each particle. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Environmental Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="10", EditCondition="!bUsePointBasedWindModel")
EdgeStiffnessWeighted FChaosClothWeightedValue The Stiffness of segments constraints. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Material Properties"
  • DisplayName="Edge Stiffness"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1")
FictitiousAngularScale float The portion of the angular velocity that is used to calculate the strength of all fictitious forces (e.g. centrifugal force). ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="2")
FlatnessRatio FChaosClothWeightedValue Calculate rest angles as a ratio between completely flat and whatever is the 3D rest angle. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Material Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1", EditCondition="bUseBendingElements")
FrictionCoefficient float Friction coefficient for cloth - collider interaction. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Collision Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="10")
Gravity FVector The gravitational acceleration vector [cm/s^2]. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Environmental Properties"
  • Meta=(EditCondition="bUseGravityOverride")
GravityScale 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
  • EditAnywhere
  • Category="Environmental Properties"
Lift FChaosClothWeightedValue The aerodynamic coefficient of lift applying on each particle. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Environmental Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="10", EditCondition="!bUsePointBasedWindModel")
LinearVelocityScale FVector The amount of linear velocities sent to the local cloth space from the reference bone (the closest bone to the root on which the cloth section has been skinned, or the root itself if the cloth isn't skinned). ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1")
LocalDampingCoefficient float The amount of local damping applied to the cloth velocities. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Environmental Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1")
MassMode EClothMassMode How cloth particle mass is determined ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Mass Properties"
MaxAngularAcceleration float The maximum amount of angular acceleration sent to the local cloth space from the reference bone (the closest bone to the root on which the cloth section has been skinned, or the root itself if the cloth isn't skinned). ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(ClampMin="0", EditCondition="bEnableAngularAccelerationClamping")
MaxAngularVelocity float The maximum amount of angular velocity sent to the local cloth space from the reference bone (the closest bone to the root on which the cloth section has been skinned, or the root itself if the cloth isn't skinned). ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(ClampMin="0", EditCondition="bEnableAngularVelocityClamping")
MaxLinearAcceleration FVector3f The maximum amount of linear acceleration sent to the local cloth space from the reference bone (the closest bone to the root on which the cloth section has been skinned, or the root itself if the cloth isn't skinned). ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(ClampMin="0", EditCondition="bEnableLinearAccelerationClamping")
MaxLinearVelocity FVector3f The maximum amount of linear velocity sent to the local cloth space from the reference bone (the closest bone to the root on which the cloth section has been skinned, or the root itself if the cloth isn't skinned). ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
  • Meta=(ClampMin="0", EditCondition="bEnableLinearVelocityClamping")
MinPerParticleMass float This is a lower bound to cloth particle masses. ChaosCloth/ChaosClothConfig.h  
OuterDrag FChaosClothWeightedValue The aerodynamic coefficient of drag applying on each particle when the air velocity is moving against the mesh normal direction. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Environmental Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="10", EditCondition="bEnableOuterDrag")
OuterLift FChaosClothWeightedValue The aerodynamic coefficient of lift applying on each particle when the air velocity is moving against the mesh normal direction. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Environmental Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="10", EditCondition="bEnableOuterLift")
Pressure FChaosClothWeightedValue Pressure force strength applied in the normal direction(use negative value to push toward backface) If an enabled Weight Map (Mask with values in the range [0;1]) targeting the "Pressure" is added to the cloth, then both the Low and High values will be used in conjunction with the per particle Weight stored in the Weight Map to interpolate the final value from them. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Environmental Properties"
  • Meta=(UIMin="-10", UIMax="10", ClampMin="-100", ClampMax="100")
SelfCollisionFriction float Friction coefficient for cloth - cloth interaction. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Collision Properties"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="10", EditCondition="bUseSelfCollisions")
SelfCollisionSphereRadius float The radius of the spheres used in self collision centered at each vertex. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Collision Properties"
  • Meta=(EditCondition="!bUseSelfCollisions && bUseSelfCollisionSpheres", UIMin="0", UIMax="100", ClampMin="0", ClampMax="1000")
SelfCollisionSphereRadiusCullMultiplier float Multiplier for culling the self collision spheres. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Collision Properties"
  • Meta=(EditCondition="!bUseSelfCollisions && bUseSelfCollisionSpheres", ClampMin="1")
SelfCollisionSphereStiffness float The stiffness of the springs used to control self collision. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Collision Properties"
  • Meta=(EditCondition="!bUseSelfCollisions && bUseSelfCollisionSpheres", UIMin="0", UIMax="100", ClampMin="0", ClampMax="1000")
SelfCollisionThickness float The radius of the spheres used in self collision. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Collision Properties"
  • Meta=(UIMin="0", UIMax="100", ClampMin="0", ClampMax="1000", EditCondition="bUseSelfCollisions")
ShapeTargetStiffness float The stiffness of the shape target constraints. ChaosCloth/ChaosClothConfig.h  
TetherScale FChaosClothWeightedValue The limit scale of the long range attachment constraints (aka tether limit). ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Long Range Attachment"
  • Meta=(UIMin="1.", UIMax="1.1", ClampMin="0.01", ClampMax="10")
TetherStiffness FChaosClothWeightedValue The tethers' stiffness of the long range attachment constraints. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Long Range Attachment"
  • Meta=(UIMin="0", UIMax="1", ClampMin="0", ClampMax="1")
TotalMass float The value used when Mass Mode is set to TotalMass. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Mass Properties"
  • Meta=(UIMin="0.001", UIMax="10", ClampMin="0", EditCondition="MassMode == EClothMassMode::TotalMass")
UniformMass float The value used when the Mass Mode is set to Uniform Mass. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Mass Properties"
  • Meta=(UIMin="0.000001", UIMax="0.001", ClampMin="0", EditCondition="MassMode == EClothMassMode::UniformMass")
VelocityScaleSpace EChaosSoftsSimulationSpace All vector properties in this section (e.g., Linear Velocity Scale, Max Linear Acceleration) will be evaluated in this space. ChaosCloth/ChaosClothConfig.h
  • EditAnywhere
  • Category="Animation Properties"
VolumeStiffness float The stiffness of the volume preservation constraints. ChaosCloth/ChaosClothConfig.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetMassValue()

 Return the mass value, from whichever mass mode (Density, UniformMass, or TotalMass) is selected. ChaosCloth/ChaosClothConfig.h  

virtual void MigrateFrom ( const UClothSharedConfigCommon* ClothSharedConfig
)

 Migrate from shared config. ChaosCloth/ChaosClothConfig.h  

Overridden from UClothConfigCommon

Name Remarks Include Path Unreal Specifiers

virtual void MigrateFrom ( const FClothConfig_Legacy&
)

 Migrate from the legacy FClothConfig structure. ChaosCloth/ChaosClothConfig.h  

Overridden from UClothConfigBase

Name Remarks Include Path Unreal Specifiers

virtual float GetSelfCollisionRadius()

 Return the self collision radius to precomute self collision data. ChaosCloth/ChaosClothConfig.h  

virtual bool NeedsInverseMasses()

 Return wherether to pre-compute Inverse Masses. ChaosCloth/ChaosClothConfig.h  

virtual bool NeedsSelfCollisionData()

   ChaosCloth/ChaosClothConfig.h  

virtual bool NeedsTethers()

 Return wherether to pre-compute the Long Range Attachment tethers. ChaosCloth/ChaosClothConfig.h  

virtual bool TethersUseGeodesicDistance()

 Return whether tethers need to be calculated using geodesic distances instead of eclidean. ChaosCloth/ChaosClothConfig.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

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
AnimDriveSpringStiffness_DEPRECATED float   ChaosCloth/ChaosClothConfig.h  
AreaStiffness_DEPRECATED float The stiffness of the area preservation constraints. ChaosCloth/ChaosClothConfig.h  
BendingStiffness_DEPRECATED float The Stiffness of the bending constraints. ChaosCloth/ChaosClothConfig.h  
DragCoefficient_DEPRECATED float   ChaosCloth/ChaosClothConfig.h  
EdgeStiffness_DEPRECATED float Deprecated properties. ChaosCloth/ChaosClothConfig.h  
LiftCoefficient_DEPRECATED float   ChaosCloth/ChaosClothConfig.h  
LimitScale_DEPRECATED float   ChaosCloth/ChaosClothConfig.h  
StrainLimitingStiffness_DEPRECATED float   ChaosCloth/ChaosClothConfig.h  
TetherMode_DEPRECATED EChaosClothTetherMode   ChaosCloth/ChaosClothConfig.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page