FaceStretchVisual

Lens Studio v1.5.0+

Scripting Name: Component.FaceStretchVisual

Inherits from BaseMeshVisual

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

---

snap(Camera camera) : void

Projects screen positions from camera’s view onto the mesh’s UVs. If the MeshVisual’s material uses the same texture as the camera input, the MeshVisual will look identical to the part of the screen it covers.

---

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.

---

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.

---

getTypeName() : String

Returns the name of this object’s type.

---

isOfType(String type) : Boolean

Returns true if the object matches or derives from the passed in type.

Inherited Properties

---

extentsTarget : ScreenTransform

When a ScreenTransform is present on this SceneObject, and extentsTarget is a child of this SceneObject, extentsTarget will be repositioned to match the exact area this MeshVisual is being rendered. Very useful for Image and Text components.

---

horizontalAlignment : HorizontalAlignment

When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be positioned horizontally depending on stretchMode.

---

meshShadowMode : Number

None = 0, Caster = 1, Receiver = 2

---

shadowColor : vec4

Affects the color of shadows being cast by this MeshVisual. The color of the cast shadow is a mix between shadowColor and the material’s base texture color. The alpha value of shadowColor controls the mixing of these two colors, with 0 = shadowColor and 1 = shadowColor * textureColor.

---

shadowDensity : Number

Density of shadows cast by this MeshVisual.

---

stretchMode : StretchMode

When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be stretched relative to the ScreenTransform’s boundaries.

---

verticalAlignment : VerticalAlignment

When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be positioned vertically depending on stretchMode.

---

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);