Skip to main content

Editor.Components.ClothVisual.VertexBinding

Class

The same entity as in Lens Scripting.

Index

Example

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

// Create a ClothVisual component and inspect its vertexBindings
const obj = scene.createSceneObject('ClothObj');
const cloth = obj.addComponent('ClothVisual');

// VertexBinding properties: color (vec4), colorMask (vec4b), followObject (SceneObject)
const bindings = cloth.vertexBindings;
console.log('vertexBindings count:', bindings.length);

// If bindings exist, inspect the first one
if (bindings.length > 0) {
const binding = bindings[0];
console.log('binding color:', binding.color);
console.log('binding colorMask:', binding.colorMask);
if (!Editor.isNull(binding.followObject)) {
console.log('followObject:', binding.followObject.name);
}
}

Extends

Properties

color

color: vec4

RGBA color value for the vertex binding.


colorMask

colorMask: vec4b

Boolean mask controlling which color channels are active.


followObject

followObject: SceneObject

Scene object this vertex binding follows.


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Entity.id


meta

readonly meta: Meta

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

Inherited from

Entity.meta


type

readonly type: string

The entity's type.

Inherited from

Entity.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Entity.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Entity.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Entity.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Entity.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Entity.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Entity.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

Entity.isSame

See also

Editor.Components.ClothVisual.