Preparing search index...

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

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    drawMouth: boolean

    Whether to render the mouth region.

    enabled: boolean

    Whether the component is active.

    enabledLipsFix: boolean

    Whether lip correction is applied.

    enabledTeethFix: boolean

    Whether teeth correction is applied.

    faceIndex: number

    Index of the face this mask applies to.

    horizontalAlignment: Horizontal

    Horizontal alignment of the mesh visual.

    id: Uuid

    The unique id of the entity.

    mainMaterial: Material

    Primary material used for rendering.

    maskCoordinates: vec2[]

    2D coordinates defining the mask boundary.

    maskOnMouthClosed: Texture

    Texture applied when the mouth is closed.

    materials: Material[]

    Array of all materials on this mesh visual.

    meshShadowMode: MeshShadowMode

    Shadow rendering mode for the mesh.

    meta: Meta

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

    name: string

    Name of the component.

    originalFaceIndex: number

    Original face index before modifications.

    renderOrder: number

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

    sceneObject: SceneObject

    Scene object this component is attached to.

    shadowColor: vec4

    Color of the mesh shadow.

    shadowDensity: number

    Opacity of the mesh shadow.

    stretchMode: StretchMode

    How the mesh stretches to fit its container.

    teethFixAlpha: number

    Alpha blending strength for teeth correction.

    textureCoordinates: vec2[]

    UV coordinates for texture mapping.

    type: string

    The entity's type.

    useOriginalTexCoords: boolean

    Whether original texture coordinates are used.

    useTextureFacePosition: boolean

    Whether face position from the texture is used.

    verticalAlignment: Vertical

    Vertical alignment of the mesh visual.

    Methods

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Move a material from one index to another.

      Parameters

      • origin: number
      • destination: number

      Returns void