FaceStretchVisual
ClassUsed to apply deformation effects to specific regions of a tracked face.
- Available on all platforms
Index
Properties
Methods
Remarks
Face Stretch features can be added to a FaceStretchVisual through the Inspector panel in Lens Studio.
Example
// 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);
Extends
Properties
enabled
enabled:
boolean
If disabled, the Component will stop enacting its behavior.
Default Value
true
Inherited from
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
faceIndex
faceIndex:
number
The index of the face the stretch will be 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
BaseMeshVisual.horizontalAlignment
isBeingDestroyed
readonlyisBeingDestroyed: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
BaseMeshVisual.isBeingDestroyed
isEnabledInHierarchy
readonlyisEnabledInHierarchy:boolean
Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.
Inherited from
BaseMeshVisual.isEnabledInHierarchy
meshShadowMode
meshShadowMode:
MeshShadowMode
None = 0, Caster = 1, Receiver = 2
Default Value
MeshShadowMode.None
Inherited from
renderOrder
renderOrder:
number
The order in which the visual should be rendered.
Since
Lens Scripting Version 323
Default Value
0
Inherited from
sceneObject
readonlysceneObject:SceneObject
The SceneObject this component is on.
Inherited from
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
shadowDensity
shadowDensity:
number
Density of shadows cast by this MeshVisual.
Default Value
1
Inherited from
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
trackingScope
trackingScope:
FaceTrackingScope|TextureTrackingScope|PersonTrackingScope
The tracking context this effect is being applied to.
Since
Lens Scripting Version 309
Default Value
null
trackingStatus
readonlytrackingStatus: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
readonlyuniqueIdentifier:string
Since
Lens Scripting Version 176
Inherited from
BaseMeshVisual.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
BaseMeshVisual.verticalAlignment
Methods
addFeature()
addFeature(
name):void
Add a feature to the face stretch effect.
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Since
Lens Scripting Version 193
clearFeatures()
clearFeatures():
void
Remove all features from the face stretch effect.
Returns
void
Since
Lens Scripting Version 193
destroy()
destroy():
void
Destroys the component.
Returns
void
Inherited from
getFeatureNames()
getFeatureNames():
string[]
Get an array of all the feature names on the face stretch effect.
Returns
string[]
Since
Lens Scripting Version 193
getFeaturePoints()
getFeaturePoints(
name):StretchPoint[]
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
Since
Lens Scripting Version 193
getFeatureWeight()
getFeatureWeight(
feature):number
Returns the weight of the face stretch feature named feature.
Parameters
| Parameter | Type |
|---|---|
feature | string |
Returns
number
getRenderOrder()
getRenderOrder():
number
Returns the order of this Visual in the render queue.
Returns
number
Inherited from
getSceneObject()
getSceneObject():
SceneObject
Returns the SceneObject the component is attached to.
Returns
Inherited from
getTransform()
getTransform():
Transform
Returns the Transform this component is attached to.
Returns
Inherited from
getTypeName()
staticgetTypeName():TypeName<FaceStretchVisual>
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<FaceStretchVisual>
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean
Inherited from
localAabbMax()
localAabbMax():
vec3
Range maximum of the local-space axis-aligned bounding box (AABB) of the visual.
Returns
Since
Lens Scripting Version 156
Inherited from
localAabbMin()
localAabbMin():
vec3
Range minimum of the local-space axis-aligned bounding box (AABB) of the visual.
Returns
Since
Lens Scripting Version 156
Inherited from
removeFeature()
removeFeature(
name):void
Remove a feature from the face stretch effect.
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Since
Lens Scripting Version 193
setFeatureWeight()
setFeatureWeight(
feature,intensity):void
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
| Parameter | Type |
|---|---|
feature | string |
intensity | number |
Returns
void
setRenderOrder()
setRenderOrder(
value):void
Sets the order of this Visual in the render queue.
Parameters
| Parameter | Type |
|---|---|
value | number |
Returns
void
Inherited from
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
| Parameter | Type |
|---|---|
camera | Camera |
Returns
void
Inherited from
updateFeaturePoints()
updateFeaturePoints(
name,points):void
Update the points on the provided face stretch feature.
Parameters
| Parameter | Type |
|---|---|
name | string |
points | StretchPoint[] |
Returns
void
Since
Lens Scripting Version 193
worldAabbMax()
worldAabbMax():
vec3
Range maximum of the world-space axis-aligned bounding box (AABB) of the visual.
Returns
Since
Lens Scripting Version 156
Inherited from
worldAabbMin()
worldAabbMin():
vec3
Range minimum of the world-space axis-aligned bounding box (AABB) of the visual.
Returns
Since
Lens Scripting Version 156
Inherited from
See also
- Face Stretch guide.
- Distort example.