Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UClothConfigBase → UClothConfigCommon → UChaosClothConfig
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 |
|
| AnimDriveDamping | FChaosClothWeightedValue | The damping amount of the anim drive. | ChaosCloth/ChaosClothConfig.h |
|
| AnimDriveStiffness | FChaosClothWeightedValue | The strength of the constraint driving the cloth towards the animated goal mesh. | ChaosCloth/ChaosClothConfig.h |
|
| AreaStiffnessWeighted | FChaosClothWeightedValue | The stiffness of the surface area preservation constraints. | ChaosCloth/ChaosClothConfig.h |
|
| bEnableAngularAccelerationClamping | bool | Enable angular acceleration clamping. | ChaosCloth/ChaosClothConfig.h |
|
| bEnableAngularVelocityClamping | bool | Enable angular velocity clamping. | ChaosCloth/ChaosClothConfig.h |
|
| bEnableLinearAccelerationClamping | bool | Enable linear acceleration clamping. | ChaosCloth/ChaosClothConfig.h |
|
| bEnableLinearVelocityClamping | bool | Enable linear velocity clamping. | ChaosCloth/ChaosClothConfig.h |
|
| bEnableOuterDrag | bool | ChaosCloth/ChaosClothConfig.h |
|
|
| bEnableOuterLift | bool | ChaosCloth/ChaosClothConfig.h |
|
|
| BendingStiffnessWeighted | FChaosClothWeightedValue | The Stiffness of cross segments and bending elements constraints. | ChaosCloth/ChaosClothConfig.h |
|
| 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 |
|
| 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 |
|
| 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 |
|
| bUseCCD | bool | Use continuous collision detection (CCD) to prevent any missed collisions between fast moving particles and colliders. | ChaosCloth/ChaosClothConfig.h |
|
| 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 |
|
| bUseGravityOverride | bool | Use the config gravity value instead of world gravity. | ChaosCloth/ChaosClothConfig.h |
|
| bUseLegacyBackstop | bool | This parameter is automatically set by the migration code. | ChaosCloth/ChaosClothConfig.h |
|
| bUsePointBasedWindModel | bool | This parameter is automatically set by the migration code. | ChaosCloth/ChaosClothConfig.h |
|
| bUseSelfCollisions | bool | Enable self collision repulsion forces (point-face). | ChaosCloth/ChaosClothConfig.h |
|
| bUseSelfCollisionSpheres | bool | Enable sphere-based self collision repulsion forces. | ChaosCloth/ChaosClothConfig.h |
|
| bUseSelfIntersections | bool | Enable self intersection resolution. | ChaosCloth/ChaosClothConfig.h |
|
| 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 |
|
| DampingCoefficient | float | The amount of global damping applied to the cloth velocities, also known as point damping. | ChaosCloth/ChaosClothConfig.h |
|
| Density | float | The value used when Mass Mode is set to Density. | ChaosCloth/ChaosClothConfig.h |
|
| Drag | FChaosClothWeightedValue | The aerodynamic coefficient of drag applying on each particle. | ChaosCloth/ChaosClothConfig.h |
|
| EdgeStiffnessWeighted | FChaosClothWeightedValue | The Stiffness of segments constraints. | ChaosCloth/ChaosClothConfig.h |
|
| 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 |
|
| FlatnessRatio | FChaosClothWeightedValue | Calculate rest angles as a ratio between completely flat and whatever is the 3D rest angle. | ChaosCloth/ChaosClothConfig.h |
|
| FrictionCoefficient | float | Friction coefficient for cloth - collider interaction. | ChaosCloth/ChaosClothConfig.h |
|
| Gravity | FVector | The gravitational acceleration vector [cm/s^2]. | ChaosCloth/ChaosClothConfig.h |
|
| 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 |
|
| Lift | FChaosClothWeightedValue | The aerodynamic coefficient of lift applying on each particle. | ChaosCloth/ChaosClothConfig.h |
|
| 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 |
|
| LocalDampingCoefficient | float | The amount of local damping applied to the cloth velocities. | ChaosCloth/ChaosClothConfig.h |
|
| MassMode | EClothMassMode | How cloth particle mass is determined | ChaosCloth/ChaosClothConfig.h |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| SelfCollisionFriction | float | Friction coefficient for cloth - cloth interaction. | ChaosCloth/ChaosClothConfig.h |
|
| SelfCollisionSphereRadius | float | The radius of the spheres used in self collision centered at each vertex. | ChaosCloth/ChaosClothConfig.h |
|
| SelfCollisionSphereRadiusCullMultiplier | float | Multiplier for culling the self collision spheres. | ChaosCloth/ChaosClothConfig.h |
|
| SelfCollisionSphereStiffness | float | The stiffness of the springs used to control self collision. | ChaosCloth/ChaosClothConfig.h |
|
| SelfCollisionThickness | float | The radius of the spheres used in self collision. | ChaosCloth/ChaosClothConfig.h |
|
| 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 |
|
| TetherStiffness | FChaosClothWeightedValue | The tethers' stiffness of the long range attachment constraints. | ChaosCloth/ChaosClothConfig.h |
|
| TotalMass | float | The value used when Mass Mode is set to TotalMass. | ChaosCloth/ChaosClothConfig.h |
|
| UniformMass | float | The value used when the Mass Mode is set to Uniform Mass. | ChaosCloth/ChaosClothConfig.h |
|
| 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 |
|
| 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 |