Class Cloth

Physical simulation actor for cloth objects made of vertices that are simulated as cloth particles with physical properties, forces, and constraints to affect cloth behavior.

System.Object
Object
SceneObject
Actor
Cloth
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[ActorContextMenu("New/Physics/Cloth")]
[ActorToolbox("Physics")]
[Unmanaged]
public class Cloth : Actor, ISerializable

Constructors

Cloth()

Initializes a new instance of the Cloth.

Declaration
public Cloth()

Properties

Collision

Gets or sets the cloth response to collisions settings.

Declaration
[EditorOrder(20)]
[EditorDisplay("Cloth", null)]
[Unmanaged]
public Cloth.CollisionSettings Collision { get; set; }
Property Value
Cloth.CollisionSettings

Fabric

Gets or sets the cloth's fabric settings (material's stiffness and compression response).

Declaration
[EditorOrder(40)]
[EditorDisplay("Cloth", null)]
[Unmanaged]
public Cloth.FabricSettings Fabric { get; set; }
Property Value
Cloth.FabricSettings

Force

Gets or sets the cloth response to forces settings.

Declaration
[EditorOrder(10)]
[EditorDisplay("Cloth", null)]
[Unmanaged]
public Cloth.ForceSettings Force { get; set; }
Property Value
Cloth.ForceSettings

Mesh

Gets or sets the mesh to use for the cloth simulation (single mesh from specific LOD). Always from the parent static or animated model actor.

Declaration
[EditorOrder(0)]
[EditorDisplay("Cloth", null)]
[Unmanaged]
public ModelInstanceActor.MeshReference Mesh { get; set; }
Property Value
ModelInstanceActor.MeshReference

Simulation

Gets or sets the cloth simulation settings.

Declaration
[EditorOrder(30)]
[EditorDisplay("Cloth", null)]
[Unmanaged]
public Cloth.SimulationSettings Simulation { get; set; }
Property Value
Cloth.SimulationSettings

Methods

ClearInteria()

Sets the inertia derived from transform change to zero (once). It will reset any cloth object movement effects as it was teleported.

Declaration
[Unmanaged]
public void ClearInteria()

GetPaint()

Gets the cloth particles paint data with per-particle max distance (normalized 0-1, 0 makes particle immovable). Returned value is empty if cloth was not initialized or doesn't use paint feature.

Declaration
[Unmanaged]
public float[] GetPaint()
Returns
System.Single[]

GetParticles()

Gets the cloth particles data with per-particle XYZ position (in local cloth-space).

Declaration
[Unmanaged]
public Float3[] GetParticles()
Returns
Float3[]

Rebuild()

Recreates the cloth by removing current instance data and creating a new physical cloth object.

Declaration
[Unmanaged]
public void Rebuild()

SetPaint(Single[])

Sets the cloth particles paint data with per-particle max distance (normalized 0-1, 0 makes particle immovable). The size of the input data had to match the cloth size. Set to empty to remove paint.

Declaration
[Unmanaged]
public void SetPaint(float[] value)
Parameters
System.Single[] value

SetParticles(Float3[])

Sets the cloth particles data with per-particle XYZ position (in local cloth-space). The size of the input data had to match the cloth size.

Declaration
[Unmanaged]
public void SetParticles(Float3[] value)
Parameters
Float3[] value

Extension Methods