Editor.Components.ClothVisual
ClassSimulates cloth physics with stretching, bending, and collision interactions.
Index
Properties
- bendMode
- bendStiffness
- colliders
- collisionEnabled
- collisionFriction
- collisionOffset
- collisionStiffness
- debugModeEnabled
- enabled
- frameRate
- friction
- gravity
- hasPrefabChanges
- horizontalAlignment
- id
- isPrefabInstanceRoot
- iterations
- mainMaterial
- mass
- materials
- maxAcceleration
- mesh
- meshShadowMode
- meta
- name
- renderOrder
- sceneObject
- shadowColor
- shadowDensity
- stretchMode
- stretchStiffness
- type
- updateNormalsEnabled
- vertexBindings
- verticalAlignment
Methods
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
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
readonlyhasPrefabChanges: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
readonlyid:Uuid
The unique id of the entity.
Inherited from
isPrefabInstanceRoot
readonlyisPrefabInstanceRoot: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
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
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
name:
string
Name of the component.
Inherited from
renderOrder
renderOrder:
number
Determines the order in which this visual component is rendered relative to others.
Inherited from
MaterialMeshVisual.renderOrder
sceneObject
readonlysceneObject: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
readonlytype:string
The entity's type.
Inherited from
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
| Parameter | Type |
|---|---|
value | Material |
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
| Parameter | Type |
|---|---|
pos | number |
Returns
Inherited from
MaterialMeshVisual.getMaterialAt
getMaterialsCount()
getMaterialsCount():
number
Get the total number of materials.
Returns
number
Inherited from
MaterialMeshVisual.getMaterialsCount
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
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
Inherited from
MaterialMeshVisual.getPrefabInstanceRoot
getTypeName()
staticgetTypeName():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
| Parameter | Type |
|---|---|
value | Material |
Returns
number
Inherited from
MaterialMeshVisual.indexOfMaterial
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean
Inherited from
moveMaterial()
moveMaterial(
origin,destination):void
Move a material from one index to another.
Parameters
| Parameter | Type |
|---|---|
origin | number |
destination | number |
Returns
void
Inherited from
MaterialMeshVisual.moveMaterial
removeMaterialAt()
removeMaterialAt(
pos):void
Remove the material at the specified index.
Parameters
| Parameter | Type |
|---|---|
pos | number |
Returns
void
Inherited from
MaterialMeshVisual.removeMaterialAt
setMaterialAt()
setMaterialAt(
pos,value):void
Replace the material at the specified index.
Parameters
| Parameter | Type |
|---|---|
pos | number |
value | Material |
Returns
void
Inherited from
MaterialMeshVisual.setMaterialAt
Nested types
Enumerations
| Enumeration | Description |
|---|---|
| BendMode | The same entity as in Lens Scripting. |
Classes
| Class | Description |
|---|---|
| VertexBinding | The same entity as in Lens Scripting. |