Lens Scripting API

    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, Expand)

    Index

    Constructors

    constructor

    Properties

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

    Methods

    addMaterial clearMaterials destroy getMaterial getMaterialsCount getRenderOrder getSceneObject getTransform getTypeName isAuto isOfType isSame localAabbMax localAabbMin setRenderOrder snap worldAabbMax worldAabbMin

    Constructors

    Properties

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    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.

    eyeSharpeningEnabled: boolean
    eyeWhiteningEnabled: boolean
    eyeWhiteningIntensity: number

    The strength of the eye whitening effect.

    faceIndex: number

    The index of the face the effect is being applied to.

    horizontalAlignment: HorizontalAlignment

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

    lookupTexture: Texture
    mainMaterial: Material

    Returns the first Material.

    mainPass: Pass

    Returns the mainPass of the mainMaterial.

    mainPassOverrides: any

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

    maskTexture: Texture

    The Texture used to mask the effect.

    materials: Material[]

    Get the array of materials used by the MaterialMeshVisual.

    meshShadowMode: MeshShadowMode

    None = 0, Caster = 1, Receiver = 2

    propertyOverrides: PropertyOverrides

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

    sceneObject: SceneObject

    The scene object 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.

    shadowDensity: number

    Density of shadows cast by this MeshVisual.

    sharpenEyeIntensity: number

    The strength of the eye sharpening effect.

    softSkinEnabled: boolean
    softSkinIntensity: number

    The strength of the soft-skin effect.

    softSkinRadius: number

    The blur radius of the soft skin effect.

    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.

    teethWhiteningEnabled: boolean
    teethWhiteningIntensity: number

    The strength of the teeth whitening effect.

    trackingScope: PersonTrackingScope | TextureTrackingScope | FaceTrackingScope

    The tracking context this effect is being applied to.

    uniqueIdentifier: string
    verticalAlignment: VerticalAlignment

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

    Methods

    • Returns boolean

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

      Parameters

      • type: string

      Returns boolean

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR