Lens Scripting API
    Preparing search index...

    Class FaceStretchVisual

    Used to apply deformation effects to specific regions of a tracked face.

    Face Stretch features can be added to a FaceStretchVisual through the Inspector panel in Lens Studio.

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

    Hierarchy (View Summary)

    Index

    Properties

    enabled extentsTarget faceIndex horizontalAlignment isBeingDestroyed isEnabledInHierarchy meshShadowMode renderOrder sceneObject shadowColor shadowDensity stretchMode trackingScope trackingStatus uniqueIdentifier verticalAlignment

    Methods

    addFeature clearFeatures destroy getFeatureNames getFeaturePoints getFeatureWeight getRenderOrder getSceneObject getTransform getTypeName isOfType isSame localAabbMax localAabbMin removeFeature setFeatureWeight setRenderOrder snap updateFeaturePoints worldAabbMax worldAabbMin

    Properties

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

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

    null
    faceIndex: number

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

    0
    horizontalAlignment: HorizontalAlignment

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

    HorizontalAlignment.Center
    isBeingDestroyed: boolean

    Returns true if this Component is currently being destroyed. Becomes true as soon as destruction begins via Component#destroy or destruction of its owning SceneObject, before any OnDestroyEvent callbacks fire.

    Lens Scripting Version 364

    if (!script.isBeingDestroyed) {
        // Component is still fully alive
    }
    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    meshShadowMode: MeshShadowMode

    None = 0, Caster = 1, Receiver = 2

    MeshShadowMode.None
    renderOrder: number

    The order in which the visual should be rendered.

    Lens Scripting Version 323

    0
    sceneObject: SceneObject

    The SceneObject this component is on.

    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.

    (1, 1, 1, 1)
    shadowDensity: number

    Density of shadows cast by this MeshVisual.

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

    StretchMode.Stretch
    trackingScope: PersonTrackingScope | TextureTrackingScope | FaceTrackingScope

    The tracking context this effect is being applied to.

    Lens Scripting Version 309

    null
    trackingStatus: TrackingStatus

    Access to the TrackingStatus for this Component. Can be used to check if tracking is available and subscribe to events for status changes.

    uniqueIdentifier: string

    Lens Scripting Version 176

    verticalAlignment: VerticalAlignment

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

    VerticalAlignment.Center

    Methods

    • Add a feature to the face stretch effect.

      Parameters

      • name: string

      Returns void

      Lens Scripting Version 193

    • Remove all features from the face stretch effect.

      Returns void

      Lens Scripting Version 193

    • Get an array of all the feature names on the face stretch effect.

      Returns string[]

      Lens Scripting Version 193

    • Parameters

      • name: string

      Returns StretchPoint[]

      Lens Scripting Version 193

    • Returns the weight of the face stretch feature named feature.

      Parameters

      • feature: string

      Returns number

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

      Parameters

      • type: string

      Returns boolean

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

      Parameters

      Returns boolean

    • Range maximum of the local-space axis-aligned bounding box (AABB) of the visual.

      Returns vec3

      Lens Scripting Version 156

    • Range minimum of the local-space axis-aligned bounding box (AABB) of the visual.

      Returns vec3

      Lens Scripting Version 156

    • Remove a feature from the face stretch effect.

      Parameters

      • name: string

      Returns void

      Lens Scripting Version 193

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

      Parameters

      • feature: string
      • intensity: number

      Returns void

    • Sets the order of this Visual in the render queue.

      Parameters

      • value: number

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

      Parameters

      Returns void

    • Update the points on the provided face stretch feature.

      Parameters

      Returns void

      Lens Scripting Version 193

    • Range maximum of the world-space axis-aligned bounding box (AABB) of the visual.

      Returns vec3

      Lens Scripting Version 156

    • Range minimum of the world-space axis-aligned bounding box (AABB) of the visual.

      Returns vec3

      Lens Scripting Version 156

    Settings

    Member Visibility

    On This Page

    Properties
    Methods