Interface FaceRenderObjectProvider

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: string): number;
    getExpressionWeights(): Float32Array;
    getLoadStatus(): LoadStatus;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

earGeometryEnabled eyeCornerGeometryEnabled eyeGeometryEnabled faceGeometryEnabled faceIndex mouthGeometryEnabled skullGeometryEnabled

Methods

getExpressionNames getExpressionWeightByName getExpressionWeights getLoadStatus getTypeName isOfType isSame

Properties

earGeometryEnabled

earGeometryEnabled: boolean

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

eyeCornerGeometryEnabled

eyeCornerGeometryEnabled: boolean

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

eyeGeometryEnabled

eyeGeometryEnabled: boolean

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

faceGeometryEnabled

faceGeometryEnabled: boolean

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

faceIndex

faceIndex: number

Index of the face this FaceRenderObjectProvider mirrors.

mouthGeometryEnabled

mouthGeometryEnabled: boolean

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

skullGeometryEnabled

skullGeometryEnabled: boolean

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

Methods

getExpressionNames

  • getExpressionNames(): string[]

  • Returns a list of all expression names being tracked.

    Returns string[]

getExpressionWeightByName

  • getExpressionWeightByName(expressionName): number

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

    Parameters

    • expressionName: string

    Returns number

getExpressionWeights

  • getExpressionWeights(): Float32Array

  • Returns a Float32Array of all expression weights being tracked.

    Returns Float32Array

getLoadStatus

getTypeName

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

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

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods