Skip to main content

RetouchVisual

Class

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

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Index

Example

// Sets a Retouch component's teeth whitening intensity

//@input Component.RetouchVisual retouchVisual

script.retouchVisual.teethWhiteningIntensity = 0.4;

Extends

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

Default Value

true

Inherited from

MaterialMeshVisual.enabled


extentsTarget

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.

Default Value

null

Inherited from

MaterialMeshVisual.extentsTarget


eyeSharpeningEnabled

readonly eyeSharpeningEnabled: boolean

Since

Lens Scripting Version 213


eyeWhiteningEnabled

readonly eyeWhiteningEnabled: boolean

Since

Lens Scripting Version 213


eyeWhiteningIntensity

eyeWhiteningIntensity: number

The strength of the eye whitening effect.

Default Value

0.9

faceIndex

faceIndex: number

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

Default Value

0

horizontalAlignment

horizontalAlignment: HorizontalAlignment

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

Default Value

HorizontalAlignment.Center

Inherited from

MaterialMeshVisual.horizontalAlignment


isBeingDestroyed

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

Since

Lens Scripting Version 364

Example

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

Inherited from

MaterialMeshVisual.isBeingDestroyed


isEnabledInHierarchy

readonly isEnabledInHierarchy: boolean

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

Inherited from

MaterialMeshVisual.isEnabledInHierarchy


mainMaterial

mainMaterial: Material

Returns the first Material.

Since

Lens Scripting Version 304

Default Value

null

Inherited from

MaterialMeshVisual.mainMaterial


mainPass

mainPass: Pass

Returns the mainPass of the mainMaterial.

Since

Lens Scripting Version 304

Default Value

null

Inherited from

MaterialMeshVisual.mainPass


materials

materials: Material[]

Get the array of materials used by the MaterialMeshVisual.

Since

Lens Scripting Version 304

Default Value

[]

Inherited from

MaterialMeshVisual.materials


meshShadowMode

meshShadowMode: MeshShadowMode

None = 0, Caster = 1, Receiver = 2

Default Value

MeshShadowMode.None

Inherited from

MaterialMeshVisual.meshShadowMode


propertyOverrides

readonly propertyOverrides: PropertyOverrides

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

Since

Lens Scripting Version 304

Inherited from

MaterialMeshVisual.propertyOverrides


renderOrder

renderOrder: number

The order in which the visual should be rendered.

Since

Lens Scripting Version 323

Default Value

0

Inherited from

MaterialMeshVisual.renderOrder


sceneObject

readonly sceneObject: SceneObject

The SceneObject this component is on.

Inherited from

MaterialMeshVisual.sceneObject


shadowColor

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.

Default Value

(1, 1, 1, 1)

Inherited from

MaterialMeshVisual.shadowColor


shadowDensity

shadowDensity: number

Density of shadows cast by this MeshVisual.

Default Value

1

Inherited from

MaterialMeshVisual.shadowDensity


sharpenEyeIntensity

sharpenEyeIntensity: number

The strength of the eye sharpening effect.

Default Value

0.9

softSkinEnabled

readonly softSkinEnabled: boolean

Since

Lens Scripting Version 213


softSkinIntensity

softSkinIntensity: number

The strength of the soft-skin effect.

Default Value

0.9

stretchMode

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.

Default Value

StretchMode.Stretch

Inherited from

MaterialMeshVisual.stretchMode


teethWhiteningEnabled

readonly teethWhiteningEnabled: boolean

Since

Lens Scripting Version 213


teethWhiteningIntensity

teethWhiteningIntensity: number

The strength of the teeth whitening effect.

Default Value

0.9

trackingScope

trackingScope: FaceTrackingScope | TextureTrackingScope | PersonTrackingScope

The tracking context this effect is being applied to.

Since

Lens Scripting Version 309

Default Value

null

trackingStatus

readonly 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

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

MaterialMeshVisual.uniqueIdentifier


verticalAlignment

verticalAlignment: VerticalAlignment

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

Default Value

VerticalAlignment.Center

Inherited from

MaterialMeshVisual.verticalAlignment

Accessors

mainPassOverrides

Get Signature

get mainPassOverrides(): PassPropertyOverrides

Overrides the mainPass on the material, without affecting other visuals referencing the same material. Reads give a PassPropertyOverrides. See PropertyOverrides.

Since

Lens Scripting Version 304

Default Value
{}
Returns

PassPropertyOverrides

Set Signature

set mainPassOverrides(value): void

Parameters
ParameterType
valuePassPropertyOverrides | {[key: string]: any; }
Returns

void

Inherited from

MaterialMeshVisual.mainPassOverrides

Methods

addMaterial()

addMaterial(material): void

Adds a Material to use for rendering.

Parameters

ParameterType
materialMaterial

Returns

void

Since

Lens Scripting Version 304

Inherited from

MaterialMeshVisual.addMaterial


clearMaterials()

clearMaterials(): void

Clears all Materials.

Returns

void

Since

Lens Scripting Version 304

Inherited from

MaterialMeshVisual.clearMaterials


destroy()

destroy(): void

Destroys the component.

Returns

void

Inherited from

MaterialMeshVisual.destroy


getMaterial()

getMaterial(index): Material

Returns the Material at index index.

Parameters

ParameterType
indexnumber

Returns

Material

Since

Lens Scripting Version 304

Inherited from

MaterialMeshVisual.getMaterial


getMaterialsCount()

getMaterialsCount(): number

Returns the number of Materials used for rendering.

Returns

number

Since

Lens Scripting Version 304

Inherited from

MaterialMeshVisual.getMaterialsCount


getRenderOrder()

getRenderOrder(): number

Returns the order of this Visual in the render queue.

Returns

number

Inherited from

MaterialMeshVisual.getRenderOrder


getSceneObject()

getSceneObject(): SceneObject

Returns the SceneObject the component is attached to.

Returns

SceneObject

Inherited from

MaterialMeshVisual.getSceneObject


getTransform()

getTransform(): Transform

Returns the Transform this component is attached to.

Returns

Transform

Inherited from

MaterialMeshVisual.getTransform


getTypeName()

static getTypeName(): TypeName<RetouchVisual>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<RetouchVisual>

Overrides

MaterialMeshVisual.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

MaterialMeshVisual.getTypeName


isAuto()

isAuto(): boolean

Returns

boolean

Since

Lens Scripting Version 213


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

MaterialMeshVisual.isOfType


isSame()

isSame(other): boolean

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

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

MaterialMeshVisual.isSame


localAabbMax()

localAabbMax(): vec3

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

Returns

vec3

Since

Lens Scripting Version 156

Inherited from

MaterialMeshVisual.localAabbMax


localAabbMin()

localAabbMin(): vec3

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

Returns

vec3

Since

Lens Scripting Version 156

Inherited from

MaterialMeshVisual.localAabbMin


setRenderOrder()

setRenderOrder(value): void

Sets the order of this Visual in the render queue.

Parameters

ParameterType
valuenumber

Returns

void

Inherited from

MaterialMeshVisual.setRenderOrder


snap()

snap(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.

Parameters

ParameterType
cameraCamera

Returns

void

Inherited from

MaterialMeshVisual.snap


worldAabbMax()

worldAabbMax(): vec3

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

Returns

vec3

Since

Lens Scripting Version 156

Inherited from

MaterialMeshVisual.worldAabbMax


worldAabbMin()

worldAabbMin(): vec3

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

Returns

vec3

Since

Lens Scripting Version 156

Inherited from

MaterialMeshVisual.worldAabbMin

See also

Retouch guide.