Interface FaceStretchVisual

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.

Example

// 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);
interface FaceStretchVisual {
    enabled: boolean;
    extentsTarget: ScreenTransform;
    faceIndex: number;
    horizontalAlignment: HorizontalAlignment;
    meshShadowMode: MeshShadowMode;
    shadowColor: vec4;
    shadowDensity: number;
    stretchMode: StretchMode;
    uniqueIdentifier: string;
    verticalAlignment: VerticalAlignment;
    destroy(): void;
    getFeatureWeight(feature): number;
    getRenderOrder(): number;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
    localAabbMax(): vec3;
    localAabbMin(): vec3;
    setFeatureWeight(feature, intensity): void;
    setRenderOrder(value): void;
    snap(camera): void;
    worldAabbMax(): vec3;
    worldAabbMin(): vec3;
}

Hierarchy (view full)

Properties

enabled extentsTarget faceIndex horizontalAlignment meshShadowMode shadowColor shadowDensity stretchMode uniqueIdentifier verticalAlignment

Methods

destroy getFeatureWeight getRenderOrder getSceneObject getTransform getTypeName isOfType isSame localAabbMax localAabbMin setFeatureWeight setRenderOrder snap worldAabbMax worldAabbMin

Properties

enabled

enabled: boolean

Description

If disabled, the Component will stop enacting its behavior.

extentsTarget

extentsTarget: ScreenTransform

Description

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.

faceIndex

faceIndex: number

Description

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

horizontalAlignment

horizontalAlignment: HorizontalAlignment

Description

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

meshShadowMode

meshShadowMode: MeshShadowMode

Description

None = 0, Caster = 1, Receiver = 2

shadowColor

shadowColor: vec4

Description

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

shadowDensity: number

Description

Density of shadows cast by this MeshVisual.

stretchMode

stretchMode: StretchMode

Description

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

Readonly uniqueIdentifier

uniqueIdentifier: string

verticalAlignment

verticalAlignment: VerticalAlignment

Description

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

Methods

destroy

getFeatureWeight

  • getFeatureWeight(feature): number

  • Parameters

    • feature: string

    Returns number

    Description

    Returns the weight of the face stretch feature named feature.

getRenderOrder

  • getRenderOrder(): number

  • Returns number

    Description

    Returns the order of this Visual in the render queue.

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the name of this object's type.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

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

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

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

localAabbMax

localAabbMin

setFeatureWeight

  • setFeatureWeight(feature, intensity): void

  • Parameters

    • feature: string
    • intensity: number

    Returns void

    Description

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

setRenderOrder

  • setRenderOrder(value): void

  • Parameters

    • value: number

    Returns void

    Description

    Sets the order of this Visual in the render queue.

snap

  • snap(camera): void

  • Parameters

    Returns void

    Description

    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.

worldAabbMax

worldAabbMin

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc