UClothConfigNv

Holds initial, asset level config for clothing actors.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

ClothingSystemRuntimeNv

Header

/Engine/Source/Runtime/ClothingSystemRuntimeNv/Public/ClothConfigNv.h

Include

#include "ClothConfigNv.h"

Syntax

class UClothConfigNv : public UClothConfigCommon

Remarks

Holds initial, asset level config for clothing actors.

Variables

Name Description

Public variable

FVector

 

AngularDrag

Drag applied to angular particle movement, higher values should limit material bending (per-axis)

Public variable

FVector

 

AngularInertiaScale

Scale for angular particle inertia, how much movement should translate to angular motion (per-axis)

Public variable

float

 

AnimDriveDamperStiffness

Default damper stiffness for anim drive if an anim drive is in use.

Public variable

float

 

AnimDriveSpringStiffness

Default spring stiffness for anim drive if an anim drive is in use.

Public variable

FClothConstrain...

 

BendConstraint

Constraint data for bend constraints.

Public variable

bool

 

bUseGravityOverride

Use gravity override value vs gravity scale

Public variable

FVector

 

CentrifugalInertiaScale

Scale for centrifugal particle inertia, how much movement should translate to angular motion (per-axis)

Public variable

EClothingWindMe...

 

ClothingWindMethod

How wind should be processed, Accurate uses drag and lift to make the cloth react differently, legacy applies similar forces to all clothing without drag and lift (similar to APEX)

Public variable

float

 

CollisionThickness

'Thickness' of the simulated cloth, used to adjust collisions

Public variable

FVector

 

Damping

Damping of particle motion per-axis.

Public variable

float

 

Friction

Friction of the surface when colliding.

Public variable

FVector

 

GravityOverride

Direct gravity override value.

Public variable

float

 

GravityScale

Scale of gravity effect on particles.

Public variable

FClothConstrain...

 

HorizontalConstraint

Constraint data for horizontal constraints.

Public variable

FVector

 

LinearDrag

Drag applied to linear particle movement per-axis.

Public variable

FVector

 

LinearInertiaScale

Scale for linear particle inertia, how much movement should translate to linear motion (per-axis)

Public variable

float

 

SelfCollisionCullScale

Scale to use for the radius of the culling checks for self collisions.

Public variable

float

 

SelfCollisionRadius

Size of self collision spheres centered on each vert.

Public variable

float

 

SelfCollisionStiffness

Stiffness of the spring force that will resolve self collisions.

Public variable

FClothConstrain...

 

ShearConstraint

Constraint data for shear constraints.

Public variable

float

 

SolverFrequency

Frequency of the position solver, lower values will lead to stretchier, bouncier cloth.

Public variable

float

 

StiffnessFrequency

Frequency for stiffness calculations, lower values will degrade stiffness of constraints.

Public variable

float

 

TetherLimit

Scale for the limit of particle tethers (how far they can separate)

Public variable

float

 

TetherStiffness

Scale for stiffness of particle tethers between each other.

Public variable

FClothConstrain...

 

VerticalConstraint

Constraint data for vertical constraints.

Public variable

float

 

WindDragCoefficient

Drag coefficient for wind calculations, higher values mean wind has more lateral effect on cloth.

Public variable

float

 

WindLiftCoefficient

Lift coefficient for wind calculations, higher values make cloth rise easier in wind.

Constructors

Name Description

Public function

UClothConfigNv()

Functions

Name Description

Public function Const

bool

 

UseSelfCollisions()

Return whether this Nv config has self collision.

Overridden from UClothConfigCommon

Name Description

Public function Virtual

void

 

MigrateFrom

(
    const FClothConfig_Legacy& ClothCo...
)

Migrate from the legacy FClothConfig structure.

Public function Virtual Const

bool

 

MigrateTo

(
    FClothConfig_Legacy& ClothConfig
)

Migrate to the legacy FClothConfig structure.

Overridden from UClothConfigBase

Name Description

Public function Virtual Const

float

 

NeedsSelfCollisionIndices()

Return the collision radius required to calculate the self collision indices, or 0.f if self collision is disabled.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Update the deprecated properties.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Set up custom version serialization.

Deprecated Variables

Deprecated Functions

Name Description

Public function Virtual Const

bool

 

HasSelfCollision()

This function is deprecated. Please use NeedsSelfCollisionIndices or UseSelfCollisions instead.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss