RetouchVisual
Lens Studio v1.5.0+
Scripting Name: Component.RetouchVisual
Inherits from MaterialMeshVisual
Description
Visual effect used to add subtle retouching effects to detected faces (soft skin, teeth whitening, etc.). To learn more, visit the Retouch Guide.
Properties
eyeWhiteningIntensity : Number
The strength of the eye whitening effect.
faceIndex : Number
The index of the face the effect is being applied to.
sharpenEyeIntensity : Number
The strength of the eye sharpening effect.
softSkinIntensity : Number
The strength of the soft-skin effect.
teethWhiteningIntensity : Number
The strength of the teeth whitening effect.
Inherited Methods
addMaterial(Material material) : void
Adds a Material to use for rendering.
clearMaterials() : void
Clears all Materials.
getMaterial(Number index) : Material
Returns the Material at index index.
getMaterialsCount() : Number
Returns the number of Materials used for rendering.
localAabbMax() : vec3
Range maximum of the local-space axis-aligned bounding box (AABB) of the visual.
localAabbMin() : vec3
Range minimum of the local-space axis-aligned bounding box (AABB) of the visual.
snap(Camera 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.
worldAabbMax() : vec3
Range maximum of the world-space axis-aligned bounding box (AABB) of the visual.
worldAabbMin() : vec3
Range minimum of the world-space axis-aligned bounding box (AABB) of the visual.
getRenderOrder() : Number
Returns the order of this Visual in the render queue.
setRenderOrder(Number value) : void
Sets the order of this Visual in the render queue.
destroy() : void
Destroys the component.
getSceneObject() : SceneObject
Returns the SceneObject the component is attached to.
getTransform() : Transform
Returns the Transform this component is attached to.
getTypeName() : String
Returns the name of this object’s type.
isOfType(String type) : Boolean
Returns true if the object matches or derives from the passed in type.
isSame(ScriptObject other) : Boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Inherited Properties
mainMaterial : Material
Returns the first Material.
mainPass : Pass
Returns the mainPass of the mainMaterial.
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.
horizontalAlignment : HorizontalAlignment
When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be positioned horizontally depending on stretchMode.
meshShadowMode : Number
None = 0, Caster = 1, Receiver = 2
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.
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.
verticalAlignment : VerticalAlignment
When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be positioned vertically depending on stretchMode.
enabled : Boolean
If disabled, the Component will stop enacting its behavior.
Examples
// Sets a Retouch component's teeth whitening intensity
//@input Component.RetouchVisual retouchVisual
script.retouchVisual.teethWhiteningIntensity = 0.4;
Still Looking for help?
Visit Support