Lens Scripting API

    Class FaceRenderObjectProvider

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

    // @input Asset.RenderMesh faceMesh

    var mouthCloseWeight = script.faceMesh.control.getExpressionWeightByName(Expressions.MouthClose);

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    earGeometryEnabled eyeCornerGeometryEnabled eyeGeometryEnabled faceGeometryEnabled faceIndex mouthGeometryEnabled onExpressionWeightsUpdate skullGeometryEnabled trackingScope

    Methods

    getExpressionNames getExpressionWeightByName getExpressionWeights getLoadStatus getTypeName isOfType isSame

    Constructors

    Properties

    earGeometryEnabled: boolean

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

    eyeCornerGeometryEnabled: boolean

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

    eyeGeometryEnabled: boolean

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

    faceGeometryEnabled: boolean

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

    faceIndex: number

    Index of the face this FaceRenderObjectProvider mirrors.

    mouthGeometryEnabled: boolean

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

    onExpressionWeightsUpdate: event1<NamedValues, void>

    An event that will fire each time new expression weights are available.

    skullGeometryEnabled: boolean

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

    trackingScope: PersonTrackingScope | TextureTrackingScope | FaceTrackingScope

    The tracking context this effect is being applied to.

    Methods

    • Returns a list of all expression names being tracked.

      Returns string[]

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

      Parameters

      • expressionName: string

      Returns number

    • Returns a Float32Array of all expression weights being tracked.

      Returns Float32Array

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

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR