Lens Scripting API
    Preparing search index...

    Class RetouchVisual

    Adds subtle retouching effects to detected faces such as soft skin, teeth whitening, etc.

    Retouch guide.

    // Sets a Retouch component's teeth whitening intensity

    //@input Component.RetouchVisual retouchVisual

    script.retouchVisual.teethWhiteningIntensity = 0.4;

    Hierarchy (View Summary)

    Index

    Properties

    enabled extentsTarget eyeSharpeningEnabled eyeWhiteningEnabled eyeWhiteningIntensity faceIndex horizontalAlignment isBeingDestroyed isEnabledInHierarchy lookupTexture mainMaterial mainPass mainPassOverrides maskTexture materials meshShadowMode propertyOverrides renderOrder sceneObject shadowColor shadowDensity sharpenEyeIntensity softSkinEnabled softSkinIntensity softSkinRadius stretchMode teethWhiteningEnabled teethWhiteningIntensity trackingScope trackingStatus uniqueIdentifier verticalAlignment

    Methods

    addMaterial clearMaterials destroy getMaterial getMaterialsCount getRenderOrder getSceneObject getTransform getTypeName isAuto isOfType isSame localAabbMax localAabbMin setRenderOrder snap 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
    eyeSharpeningEnabled: boolean

    Lens Scripting Version 213

    eyeWhiteningEnabled: boolean

    Lens Scripting Version 213

    eyeWhiteningIntensity: number

    The strength of the eye whitening effect.

    0.9
    faceIndex: number

    The index of the face the effect is being 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.

    lookupTexture: Texture

    This property is no longer supported.

    null
    mainMaterial: Material

    Returns the first Material.

    Lens Scripting Version 304

    null
    mainPass: Pass

    Returns the mainPass of the mainMaterial.

    Lens Scripting Version 304

    null
    mainPassOverrides: PassPropertyOverrides

    Overrides the mainPass on the material, without affecting other visuals referencing the same material.

    Lens Scripting Version 304

    maskTexture: Texture

    The Texture used to mask the effect.

    This property is no longer supported.

    null
    materials: Material[]

    Get the array of materials used by the MaterialMeshVisual.

    Lens Scripting Version 304

    []
    meshShadowMode: MeshShadowMode

    None = 0, Caster = 1, Receiver = 2

    MeshShadowMode.None
    propertyOverrides: PropertyOverrides

    Overrides the property on the material, without affecting other visuals referencing the same material.

    Lens Scripting Version 304

    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
    sharpenEyeIntensity: number

    The strength of the eye sharpening effect.

    0.9
    softSkinEnabled: boolean

    Lens Scripting Version 213

    softSkinIntensity: number

    The strength of the soft-skin effect.

    0.9
    softSkinRadius: number

    The blur radius of the soft skin effect.

    Capability is no longer supported.

    0.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
    teethWhiteningEnabled: boolean

    Lens Scripting Version 213

    teethWhiteningIntensity: number

    The strength of the teeth whitening effect.

    0.9
    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

    • Returns the number of Materials used for rendering.

      Returns number

      Lens Scripting Version 304

    • Returns boolean

      Lens Scripting Version 213

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

      Parameters

      • type: string

      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

    • 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

    • 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