Skip to main content

Editor.Components.ClothVisual

Class

Simulates cloth physics with stretching, bending, and collision interactions.

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;

// Create a scene object with a ClothVisual for cloth simulation
const obj = scene.createSceneObject('ClothObj');
const cloth = obj.addComponent('ClothVisual') as Editor.Components.ClothVisual;

// Configure simulation properties
cloth.gravity = new vec3(0, -9.8, 0);
cloth.mass = 1.0;
cloth.stretchStiffness = 0.8;
cloth.bendStiffness = 0.3;
cloth.friction = 0.5;
cloth.iterations = 10;
cloth.collisionEnabled = true;

console.log(`ClothVisual: gravity=${cloth.gravity}, mass=${cloth.mass}`);
console.log(` stretch=${cloth.stretchStiffness}, bend=${cloth.bendStiffness}, friction=${cloth.friction}`);
console.log(` iterations=${cloth.iterations}, collision=${cloth.collisionEnabled}`);

Extends

Properties

bendMode

bendMode: BendMode

Bending calculation method for the cloth simulation.


bendStiffness

bendStiffness: number

Resistance to bending, from 0 to 1.


colliders

colliders: ColliderComponent[]

Physics colliders the cloth can collide with.


collisionEnabled

collisionEnabled: boolean

Whether cloth collides with physics colliders.


collisionFriction

collisionFriction: number

Friction applied during cloth-collider contact.


collisionOffset

collisionOffset: number

Distance offset for collision detection.


collisionStiffness

collisionStiffness: number

How stiffly cloth responds to collisions.


debugModeEnabled

debugModeEnabled: boolean

Whether debug visualization is rendered.


enabled

enabled: boolean

Whether the component is active.

Inherited from

MaterialMeshVisual.enabled


frameRate

frameRate: number

Simulation updates per second.


friction

friction: number

Air resistance and internal cloth damping.


gravity

gravity: vec3

Gravity acceleration vector applied to the cloth.


hasPrefabChanges

readonly hasPrefabChanges: boolean

Whether this entity differs from its counterpart in the prefab or was added to the prefab instance. Always false outside prefab instances.

Inherited from

MaterialMeshVisual.hasPrefabChanges


horizontalAlignment

horizontalAlignment: Horizontal

Horizontal alignment of the mesh visual.

Inherited from

MaterialMeshVisual.horizontalAlignment


id

readonly id: Uuid

The unique id of the entity.

Inherited from

MaterialMeshVisual.id


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

MaterialMeshVisual.isPrefabInstanceRoot


iterations

iterations: number

Constraint solver iterations per frame.


mainMaterial

mainMaterial: Material

Primary material used for rendering.

Inherited from

MaterialMeshVisual.mainMaterial


mass

mass: number

Total cloth mass in kilograms.


materials

materials: Material[]

Array of all materials on this mesh visual.

Inherited from

MaterialMeshVisual.materials


maxAcceleration

maxAcceleration: number

Maximum acceleration any vertex can experience.


mesh

mesh: RenderMesh

RenderMesh defining the cloth geometry.


meshShadowMode

meshShadowMode: MeshShadowMode

Shadow rendering mode for the mesh.

Inherited from

MaterialMeshVisual.meshShadowMode


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

MaterialMeshVisual.meta


name

name: string

Name of the component.

Inherited from

MaterialMeshVisual.name


renderOrder

renderOrder: number

Determines the order in which this visual component is rendered relative to others.

Inherited from

MaterialMeshVisual.renderOrder


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

MaterialMeshVisual.sceneObject


shadowColor

shadowColor: vec4

Color of the mesh shadow.

Inherited from

MaterialMeshVisual.shadowColor


shadowDensity

shadowDensity: number

Opacity of the mesh shadow.

Inherited from

MaterialMeshVisual.shadowDensity


stretchMode

stretchMode: StretchMode

How the mesh stretches to fit its container.

Inherited from

MaterialMeshVisual.stretchMode


stretchStiffness

stretchStiffness: number

Resistance to stretching, from 0 to 1.


type

readonly type: string

The entity's type.

Inherited from

MaterialMeshVisual.type


updateNormalsEnabled

updateNormalsEnabled: boolean

Whether normals are recalculated each frame.


vertexBindings

vertexBindings: VertexBinding[]

Array of pinned or constrained vertex bindings.


verticalAlignment

verticalAlignment: Vertical

Vertical alignment of the mesh visual.

Inherited from

MaterialMeshVisual.verticalAlignment

Methods

addMaterialAt()

addMaterialAt(value, pos?): void

Insert a material at the specified index.

Parameters

ParameterType
valueMaterial
pos?number

Returns

void

Inherited from

MaterialMeshVisual.addMaterialAt


clearMaterials()

clearMaterials(): void

Remove all materials.

Returns

void

Inherited from

MaterialMeshVisual.clearMaterials


getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

MaterialMeshVisual.getDirectlyReferencedEntities


getMaterialAt()

getMaterialAt(pos): Material

Retrieve the material at the specified index.

Parameters

ParameterType
posnumber

Returns

Material

Inherited from

MaterialMeshVisual.getMaterialAt


getMaterialsCount()

getMaterialsCount(): number

Get the total number of materials.

Returns

number

Inherited from

MaterialMeshVisual.getMaterialsCount


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

MaterialMeshVisual.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

MaterialMeshVisual.getOwnedEntities


getPrefabInstanceRoot()

getPrefabInstanceRoot(): Prefabable

Returns the nearest prefab instance root that contains this entity, starting with the entity itself, or null if it is not part of a prefab instance.

Returns

Prefabable

Inherited from

MaterialMeshVisual.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

MaterialMeshVisual.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

MaterialMeshVisual.getTypeName


indexOfMaterial()

indexOfMaterial(value): number

Find the index of a given material.

Parameters

ParameterType
valueMaterial

Returns

number

Inherited from

MaterialMeshVisual.indexOfMaterial


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

MaterialMeshVisual.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

MaterialMeshVisual.isSame


moveMaterial()

moveMaterial(origin, destination): void

Move a material from one index to another.

Parameters

ParameterType
originnumber
destinationnumber

Returns

void

Inherited from

MaterialMeshVisual.moveMaterial


removeMaterialAt()

removeMaterialAt(pos): void

Remove the material at the specified index.

Parameters

ParameterType
posnumber

Returns

void

Inherited from

MaterialMeshVisual.removeMaterialAt


setMaterialAt()

setMaterialAt(pos, value): void

Replace the material at the specified index.

Parameters

ParameterType
posnumber
valueMaterial

Returns

void

Inherited from

MaterialMeshVisual.setMaterialAt

Nested types

Enumerations

EnumerationDescription
BendModeThe same entity as in Lens Scripting.

Classes

ClassDescription
VertexBindingThe same entity as in Lens Scripting.