UChaosClothConfig

Hiding categories that will be used in the future.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ChaosCloth

Header

/Engine/Plugins/Experimental/ChaosCloth/Source/Chaos/Public/ChaosCloth/ChaosClothConfig.h

Include

#include "ChaosCloth/ChaosClothConfig.h"

Syntax

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

Remarks

Holds initial, asset level config for clothing actors.

Variables

Name Description

Public variable UProperty Category, EditAnywhere, Meta

float

 

AngularVelocityScale

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).

Public variable UProperty Category, EditAnywhere, Meta

FChaosClothWeig...

 

AnimDriveDamping

The damping amount of the anim drive.

Public variable UProperty Category, EditAnywhere, Meta

FChaosClothWeig...

 

AnimDriveStiffness

The strength of the constraint driving the cloth towards the animated goal mesh.

Public variable UProperty Category, EditAnywhere, Meta displayname

FChaosClothWeig...

 

AreaStiffnessWeighted

The stiffness of the surface area preservation constraints.

Public variable UProperty Category, EditAnywhere, Meta displayname

FChaosClothWeig...

 

BendingStiffnessWeighted

The Stiffness of cross segments and bending elements constraints.

Public variable UProperty Category, EditAnywhere

bool

 

bUseBendingElements

Enable the more accurate bending element constraints instead of the faster cross-edge spring constraints used for controlling bending stiffness.

Public variable UProperty Category, EditAnywhere

bool

 

bUseCCD

Use continuous collision detection (CCD) to prevent any missed collisions between fast moving particles and colliders.

Public variable UProperty

bool

 

bUseContinuousCollisionDetection

Enable continuous collision detection.

Public variable UProperty Category, EditAnywhere

bool

 

bUseGeodesicDistance

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.

Public variable UProperty Category, EditAnywhere, Meta

bool

 

bUseGravityOverride

Use the config gravity value instead of world gravity.

Public variable UProperty Category, EditAnywhere

bool

 

bUseLegacyBackstop

This parameter is automatically set by the migration code.

Public variable UProperty Category, EditAnywhere

bool

 

bUsePointBasedWindModel

This parameter is automatically set by the migration code.

Public variable UProperty Category, EditAnywhere, Meta

bool

 

bUseSelfCollisions

Enable self collision.

Public variable UProperty

bool

 

bUseTetrahedralConstraints

Enable tetrahedral constraints.

Public variable UProperty

bool

 

bUseThinShellVolumeConstraints

Enable thin shell volume constraints.

Public variable UProperty Category, EditAnywhere, Meta

float

 

CollisionThickness

The added thickness of collision shapes.

Public variable UProperty Category, EditAnywhere, Meta

float

 

DampingCoefficient

The amount of damping applied to the cloth velocities.

Public variable UProperty Category, EditAnywhere, Meta

float

 

Density

The value used when Mass Mode is set to Density.

Public variable UProperty Category, EditAnywhere, Meta

FChaosClothWeig...

 

Drag

The aerodynamic coefficient of drag applying on each particle.

Public variable UProperty Category, EditAnywhere, Meta displayname

FChaosClothWeig...

 

EdgeStiffnessWeighted

The Stiffness of segments constraints.

Public variable UProperty Category, EditAnywhere, Meta

float

 

FictitiousAngularScale

The portion of the angular velocity that is used to calculate the strength of all fictitious forces (e.g. centrifugal force).

Public variable UProperty Category, EditAnywhere, Meta

float

 

FrictionCoefficient

Friction coefficient for cloth - collider interaction.

Public variable UProperty Category, EditAnywhere, Meta

FVector

 

Gravity

The gravitational acceleration vector [cm/s^2].

Public variable UProperty Category, EditAnywhere

float

 

GravityScale

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.

Public variable UProperty Category, EditAnywhere, Meta

FChaosClothWeig...

 

Lift

The aerodynamic coefficient of lift applying on each particle.

Public variable UProperty Category, EditAnywhere, Meta

FVector

 

LinearVelocityScale

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).

Public variable UProperty Category, EditAnywhere

EClothMassMode

 

MassMode

How cloth particle mass is determined

Public variable UProperty

float

 

MinPerParticleMass

This is a lower bound to cloth particle masses.

Public variable UProperty Category, EditAnywhere, Meta

float

 

SelfCollisionThickness

The radius of the spheres used in self collision.

Public variable UProperty

float

 

ShapeTargetStiffness

The stiffness of the shape target constraints.

Public variable UProperty Category, EditAnywhere, Meta

FChaosClothWeig...

 

TetherScale

The limit scale of the long range attachment constraints (aka tether limit).

Public variable UProperty Category, EditAnywhere, Meta

FChaosClothWeig...

 

TetherStiffness

The tethers' stiffness of the long range attachment constraints.

Public variable UProperty Category, EditAnywhere, Meta

float

 

TotalMass

The value used when Mass Mode is set to TotalMass.

Public variable UProperty Category, EditAnywhere, Meta

float

 

UniformMass

The value used when the Mass Mode is set to Uniform Mass.

Public variable UProperty

float

 

VolumeStiffness

The stiffness of the volume preservation constraints.

Constructors

Name Description

Public function

UChaosClothConfig()

Destructors

Name Description

Public function Virtual

~UChaosClothConfig()

Functions

Name Description

Public function Const

float

 

GetMassValue()

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

Public function Virtual

void

 

MigrateFrom

(
    const UClothSharedConfigCommon*...
)

Migrate from shared config.

Overridden from UClothConfigCommon

Name Description

Public function Virtual

void

 

MigrateFrom

(
    const FClothConfig_Legacy&
)

Migrate from the legacy FClothConfig structure.

Overridden from UClothConfigBase

Name Description

Public function Virtual Const

bool

 

NeedsInverseMasses()

Return wherether to pre-compute Inverse Masses.

Public function Virtual Const

bool

 

NeedsTethers()

Return wherether to pre-compute the Long Range Attachment tethers.

Public function Virtual Const

bool

 

TethersUseGeodesicDistance()

Return whether tethers need to be calculated using geodesic distances instead of eclidean.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

PostLoad override used to deal with updates/changes in properties.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Serialize override used to set the current custom version.

Deprecated Variables

Name Description

Public variable UProperty

float

 

AnimDriveSpringStiffness_DEPRECATED

Public variable UProperty

float

 

AreaStiffness_DEPRECATED

The stiffness of the area preservation constraints.

Public variable UProperty

float

 

BendingStiffness_DEPRECATED

The Stiffness of the bending constraints.

Public variable UProperty

float

 

DragCoefficient_DEPRECATED

Public variable UProperty

float

 

EdgeStiffness_DEPRECATED

Deprecated properties.

Public variable UProperty

float

 

LiftCoefficient_DEPRECATED

Public variable UProperty

float

 

LimitScale_DEPRECATED

Public variable UProperty

float

 

StrainLimitingStiffness_DEPRECATED

Public variable UProperty

EChaosClothTeth...

 

TetherMode_DEPRECATED