FaceStretchVisual

Lens Studio v1.5.0+

Scripting Name: Component.FaceStretchVisual

Inherits from Visual

Description

Applies a face stretch effect. Face stretch features can be added to a FaceStretchVisual through the Inspector panel in Lens Studio. See the Face Stretch Guide for more information.

Methods

---

getFeatureWeight(String feature) : Number

Returns the weight of the face stretch feature named feature.

---

setFeatureWeight(String feature, Number intensity) : void

Sets the weight of the face stretch feature named feature to intensity. The intensity must be greater than -0.5 and less than 2.

Properties

---

faceIndex : Number

The index of the face the stretch will be applied to.

Inherited Methods

---

getRenderOrder() : Number

Returns the order of this Visual in the render queue.

---

setRenderOrder(Number value) : void

Sets the order of this Visual in the render queue.

---

destroy() : void

Destroys the component.

---

getSceneObject() : SceneObject

Returns the SceneObject the component is attached to.

---

getTransform() : Transform

Returns the Transform this component is attached to.

---

getTypeName() : String

Returns the name of this object’s type.

---

isSame(SerializableWithUID other) : Boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Inherited Properties

---

enabled : Boolean

If disabled, the Component will stop enacting its behavior.

Examples

// Changes the intensity of the first face stretch feature
//@input Component.FaceStretchVisual faceStretch
var feature = "Feature0";
var intensity = 2.0;

script.faceStretch.setFeatureWeight(feature, intensity);