Interface FaceRenderObjectProvider

Description

Mesh provider for a Face Mesh. Accessible through the control property on a Face Mesh RenderMesh.

Example

// @input Asset.RenderMesh faceMesh

var mouthCloseWeight = script.faceMesh.control.getExpressionWeightByName(Expressions.MouthClose);
interface FaceRenderObjectProvider {
    earGeometryEnabled: boolean;
    eyeCornerGeometryEnabled: boolean;
    eyeGeometryEnabled: boolean;
    faceGeometryEnabled: boolean;
    faceIndex: number;
    mouthGeometryEnabled: boolean;
    skullGeometryEnabled: boolean;
    getExpressionNames(): string[];
    getExpressionWeightByName(expressionName): number;
    getExpressionWeights(): Float32Array;
    getLoadStatus(): LoadStatus;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

earGeometryEnabled eyeCornerGeometryEnabled eyeGeometryEnabled faceGeometryEnabled faceIndex mouthGeometryEnabled skullGeometryEnabled

Methods

getExpressionNames getExpressionWeightByName getExpressionWeights getLoadStatus getTypeName isOfType isSame

Properties

earGeometryEnabled

earGeometryEnabled: boolean

Description

When true, ears will be included in the Face Mesh geometry.

eyeCornerGeometryEnabled

eyeCornerGeometryEnabled: boolean

Description

When true, a small area in the corners of the eyes will be included in the Face Mesh geometry.

eyeGeometryEnabled

eyeGeometryEnabled: boolean

Description

When true, eyes will be included in the Face Mesh geometry.

faceGeometryEnabled

faceGeometryEnabled: boolean

Description

When true, the general face (not including eyes and mouth) will be included in the Face Mesh geometry.

faceIndex

faceIndex: number

Description

Index of the face this FaceRenderObjectProvider mirrors.

mouthGeometryEnabled

mouthGeometryEnabled: boolean

Description

When true, the mouth will be included in the Face Mesh geometry.

skullGeometryEnabled

skullGeometryEnabled: boolean

Description

When true, the skull will be included in the Face Mesh geometry.

Methods

getExpressionNames

  • getExpressionNames(): string[]

  • Returns string[]

    Description

    Returns a list of all expression names being tracked.

getExpressionWeightByName

  • getExpressionWeightByName(expressionName): number

  • Parameters

    • expressionName: string

    Returns number

    Description

    Returns the weight of the expression with the passed in name. See Expressions for valid expression names.

getExpressionWeights

  • getExpressionWeights(): Float32Array

  • Returns Float32Array

    Description

    Returns a Float32Array of all expression weights being tracked.

getLoadStatus

getTypeName

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

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

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc