Skip to main content

Editor.Components.FaceStretchVisual

Class

Visual component for stretching and deforming face meshes with named features.

Index

Example

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

// Create a FaceStretchVisual for face deformation effects
const obj = scene.createSceneObject('FaceStretch');
const visual = obj.addComponent('FaceStretchVisual') as Editor.Components.FaceStretchVisual;
visual.faceIndex = 0;

// Add a stretch feature and set its weight
visual.addFeature('eyes_grow');
visual.setFeatureWeight('eyes_grow', 0.7);
console.log(`FaceStretch: face=${visual.faceIndex}`);
console.log(` features: ${visual.getFeatureNames().join(', ')}`);
console.log(` eyes_grow weight: ${visual.getFeatureWeight('eyes_grow')}`);

Extends

Properties

enabled

enabled: boolean

Whether the component is active.

Inherited from

BaseMeshVisual.enabled


faceIndex

faceIndex: number

Index of the face mesh to deform.


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

BaseMeshVisual.hasPrefabChanges


horizontalAlignment

horizontalAlignment: Horizontal

Horizontal alignment of the mesh visual.

Inherited from

BaseMeshVisual.horizontalAlignment


id

readonly id: Uuid

The unique id of the entity.

Inherited from

BaseMeshVisual.id


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

BaseMeshVisual.isPrefabInstanceRoot


meshShadowMode

meshShadowMode: MeshShadowMode

Shadow rendering mode for the mesh.

Inherited from

BaseMeshVisual.meshShadowMode


meta

readonly meta: Meta

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

Inherited from

BaseMeshVisual.meta


name

name: string

Name of the component.

Inherited from

BaseMeshVisual.name


renderOrder

renderOrder: number

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

Inherited from

BaseMeshVisual.renderOrder


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

BaseMeshVisual.sceneObject


shadowColor

shadowColor: vec4

Color of the mesh shadow.

Inherited from

BaseMeshVisual.shadowColor


shadowDensity

shadowDensity: number

Opacity of the mesh shadow.

Inherited from

BaseMeshVisual.shadowDensity


stretchMode

stretchMode: StretchMode

How the mesh stretches to fit its container.

Inherited from

BaseMeshVisual.stretchMode


type

readonly type: string

The entity's type.

Inherited from

BaseMeshVisual.type


verticalAlignment

verticalAlignment: Vertical

Vertical alignment of the mesh visual.

Inherited from

BaseMeshVisual.verticalAlignment

Methods

addFeature()

addFeature(name): void

Register a new stretch feature by name.

Parameters

ParameterType
namestring

Returns

void


clearFeatures()

clearFeatures(): void

Remove all registered stretch features.

Returns

void


getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

BaseMeshVisual.getDirectlyReferencedEntities


getFeatureNames()

getFeatureNames(): string[]

Get all registered feature names.

Returns

string[]


getFeaturePoints()

getFeaturePoints(name): StretchPoint[]

Get the stretch points for a named feature.

Parameters

ParameterType
namestring

Returns

StretchPoint[]


getFeatureWeight()

getFeatureWeight(name): number

Get the blend weight for a named feature.

Parameters

ParameterType
namestring

Returns

number


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

BaseMeshVisual.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

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

BaseMeshVisual.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

BaseMeshVisual.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

BaseMeshVisual.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

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

BaseMeshVisual.isSame


removeFeature()

removeFeature(name): void

Unregister a stretch feature by name.

Parameters

ParameterType
namestring

Returns

void


setFeatureWeight()

setFeatureWeight(name, weight): void

Set the blend weight for a named feature.

Parameters

ParameterType
namestring
weightnumber

Returns

void


updateFeaturePoints()

updateFeaturePoints(name, points): void

Update the stretch points for a named feature.

Parameters

ParameterType
namestring
pointsStretchPoint[]

Returns

void