Skip to main content

Editor.Components.StretchPoint

Class

Defines a mesh vertex stretch point for FaceStretchVisual deformation.

Index

Example

// StretchPoint describes a single control point for a FaceStretchVisual feature.
// index — vertex index into the face mesh the stretch is anchored to.
// See the face-mesh vertex layout in the Lens Scripting reference:
// https://developers.snap.com/lens-studio/api/lens-scripting/classes/Built-In.FaceStretchVisual
// delta — displacement applied to that vertex (local-space vec3).
// weight — blend amount applied to this point (0..1).
const point = new Editor.Components.StretchPoint();
point.index = 3; // vertex #3 on the face mesh
point.delta = new vec3(0.5, 1.0, 0.0);
point.weight = 0.75;

// Points are typically assembled into an array and handed to
// FaceStretchVisual.updateFeaturePoints(featureName, points).
const points: Editor.Components.StretchPoint[] = [point];
console.log(`StretchPoint feature: ${points.length} point(s), first at vertex ${points[0].index}`);

Constructors

Constructor

new StretchPoint(): StretchPoint

Create a new StretchPoint instance.

Returns

StretchPoint

Properties

delta

delta: vec3

The displacement vector applied to the vertex.


index

index: number

The vertex index in the mesh.


weight

weight: number

The blend weight for the stretch effect.