Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Cloth

The Cloth class provides an interface to cloth simulation physics.
Read time 7 minutesLast updated 2 days ago

Definition

[RequireComponent(typeof(Transform), typeof(SkinnedMeshRenderer))]public sealed class Cloth : Component

Properties

Property

Description

bendingStiffnessBending stiffness of the cloth.
capsuleCollidersAn array of CapsuleColliders which this Cloth instance should collide with.
clothSolverFrequencyNumber of cloth solver iterations per second.
coefficientsThe cloth skinning coefficients used to set up how the cloth interacts with the skinned mesh.
collisionMassScaleHow much to increase mass of colliding particles.
dampingDamp cloth motion.
enableContinuousCollisionEnable continuous collision to improve collision stability.
enabledIs this cloth enabled?
externalAccelerationA constant, external acceleration applied to the cloth.
frictionThe friction of the cloth when colliding with the character.
normalsThe current normals of the cloth object.
randomAccelerationA random, external acceleration applied to the cloth.
selfCollisionDistanceMinimum distance at which two cloth particles repel each other (default: 0.0).
selfCollisionStiffnessSelf-collision stiffness defines how strong the separating impulse should be for colliding particles.
sleepThresholdCloth's sleep threshold.
sphereCollidersAn array of ClothSphereColliderPairs which this Cloth instance should collide with.
stiffnessFrequencySets the stiffness frequency parameter.
stretchingStiffnessStretching stiffness of the cloth.
useGravityShould gravity affect the cloth simulation?
useTethersUse Tether Anchors.
useVirtualParticlesAdd one virtual particle per triangle to improve collision stability.
verticesThe current vertex positions of the cloth object.
worldAccelerationScaleHow much world-space acceleration of the character will affect cloth vertices.
worldVelocityScaleHow much world-space movement of the character will affect cloth vertices.

Methods

Method

Description

ClearTransformMotionClear the pending transform changes from affecting the cloth simulation.
GetSelfAndInterCollisionIndicesGet list of particles to be used for self and inter collision.
GetVirtualParticleIndicesGet list of indices to be used when generating virtual particles.
GetVirtualParticleWeightsGet weights to be used when generating virtual particles for cloth.
SetEnabledFadingFade the cloth simulation in or out.
SetSelfAndInterCollisionIndicesThis allows you to set the cloth indices used for self and inter collision.
SetVirtualParticleIndicesSet indices to use when generating virtual particles.
SetVirtualParticleWeightsSets weights to be used when generating virtual particles for cloth.

Inheritance

Inherited Members

Operators

Operator

Description

operator ==Compares two object references to see if they refer to the same object.
boolDetermines whether the object exists.
operator !=Compares if two objects refer to a different object.