Skip to main content

Editor.Components.FaceMaskVisual

Class

Visual component for rendering face masks with optional mouth and teeth correction.

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;

// Create a FaceMaskVisual for face mask effects
const obj = scene.createSceneObject('FaceMask');
const visual = obj.addComponent('FaceMaskVisual') as Editor.Components.FaceMaskVisual;

// Configure face mask properties
visual.faceIndex = 0;
visual.drawMouth = true;
visual.enabledLipsFix = true;
visual.enabledTeethFix = true;
visual.teethFixAlpha = 0.8;
console.log(`FaceMask: face=${visual.faceIndex}, mouth=${visual.drawMouth}`);
console.log(` lipsFix=${visual.enabledLipsFix}, teethFix=${visual.enabledTeethFix}, alpha=${visual.teethFixAlpha}`);

Extends

Properties

drawMouth

drawMouth: boolean

Whether to render the mouth region.


enabled

enabled: boolean

Whether the component is active.

Inherited from

MaterialMeshVisual.enabled


enabledLipsFix

enabledLipsFix: boolean

Whether lip correction is applied.


enabledTeethFix

enabledTeethFix: boolean

Whether teeth correction is applied.


faceIndex

faceIndex: number

Index of the face this mask applies to.


hasPrefabChanges

readonly hasPrefabChanges: boolean

Whether this entity differs from its counterpart in the prefab or was added to the prefab instance. Always false outside prefab instances.

Inherited from

MaterialMeshVisual.hasPrefabChanges


horizontalAlignment

horizontalAlignment: Horizontal

Horizontal alignment of the mesh visual.

Inherited from

MaterialMeshVisual.horizontalAlignment


id

readonly id: Uuid

The unique id of the entity.

Inherited from

MaterialMeshVisual.id


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

MaterialMeshVisual.isPrefabInstanceRoot


mainMaterial

mainMaterial: Material

Primary material used for rendering.

Inherited from

MaterialMeshVisual.mainMaterial


maskCoordinates

maskCoordinates: vec2[]

2D coordinates defining the mask boundary.


maskOnMouthClosed

maskOnMouthClosed: Texture

Texture applied when the mouth is closed.


materials

materials: Material[]

Array of all materials on this mesh visual.

Inherited from

MaterialMeshVisual.materials


meshShadowMode

meshShadowMode: MeshShadowMode

Shadow rendering mode for the mesh.

Inherited from

MaterialMeshVisual.meshShadowMode


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

MaterialMeshVisual.meta


name

name: string

Name of the component.

Inherited from

MaterialMeshVisual.name


originalFaceIndex

originalFaceIndex: number

Original face index before modifications.


renderOrder

renderOrder: number

Determines the order in which this visual component is rendered relative to others.

Inherited from

MaterialMeshVisual.renderOrder


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

MaterialMeshVisual.sceneObject


shadowColor

shadowColor: vec4

Color of the mesh shadow.

Inherited from

MaterialMeshVisual.shadowColor


shadowDensity

shadowDensity: number

Opacity of the mesh shadow.

Inherited from

MaterialMeshVisual.shadowDensity


stretchMode

stretchMode: StretchMode

How the mesh stretches to fit its container.

Inherited from

MaterialMeshVisual.stretchMode


teethFixAlpha

teethFixAlpha: number

Alpha blending strength for teeth correction.


textureCoordinates

textureCoordinates: vec2[]

UV coordinates for texture mapping.


type

readonly type: string

The entity's type.

Inherited from

MaterialMeshVisual.type


useOriginalTexCoords

useOriginalTexCoords: boolean

Whether original texture coordinates are used.


useTextureFacePosition

useTextureFacePosition: boolean

Whether face position from the texture is used.


verticalAlignment

verticalAlignment: Vertical

Vertical alignment of the mesh visual.

Inherited from

MaterialMeshVisual.verticalAlignment

Methods

addMaterialAt()

addMaterialAt(value, pos?): void

Insert a material at the specified index.

Parameters

ParameterType
valueMaterial
pos?number

Returns

void

Inherited from

MaterialMeshVisual.addMaterialAt


clearMaterials()

clearMaterials(): void

Remove all materials.

Returns

void

Inherited from

MaterialMeshVisual.clearMaterials


getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

MaterialMeshVisual.getDirectlyReferencedEntities


getMaterialAt()

getMaterialAt(pos): Material

Retrieve the material at the specified index.

Parameters

ParameterType
posnumber

Returns

Material

Inherited from

MaterialMeshVisual.getMaterialAt


getMaterialsCount()

getMaterialsCount(): number

Get the total number of materials.

Returns

number

Inherited from

MaterialMeshVisual.getMaterialsCount


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

MaterialMeshVisual.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

MaterialMeshVisual.getOwnedEntities


getPrefabInstanceRoot()

getPrefabInstanceRoot(): Prefabable

Returns the nearest prefab instance root that contains this entity, starting with the entity itself, or null if it is not part of a prefab instance.

Returns

Prefabable

Inherited from

MaterialMeshVisual.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

MaterialMeshVisual.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

MaterialMeshVisual.getTypeName


indexOfMaterial()

indexOfMaterial(value): number

Find the index of a given material.

Parameters

ParameterType
valueMaterial

Returns

number

Inherited from

MaterialMeshVisual.indexOfMaterial


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

MaterialMeshVisual.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

MaterialMeshVisual.isSame


moveMaterial()

moveMaterial(origin, destination): void

Move a material from one index to another.

Parameters

ParameterType
originnumber
destinationnumber

Returns

void

Inherited from

MaterialMeshVisual.moveMaterial


removeMaterialAt()

removeMaterialAt(pos): void

Remove the material at the specified index.

Parameters

ParameterType
posnumber

Returns

void

Inherited from

MaterialMeshVisual.removeMaterialAt


setMaterialAt()

setMaterialAt(pos, value): void

Replace the material at the specified index.

Parameters

ParameterType
posnumber
valueMaterial

Returns

void

Inherited from

MaterialMeshVisual.setMaterialAt