IAnuraMask

interface IAnuraMask {
    objectFit: ObjectFit;
    checkConstraints(
        face: DfxFace,
        annotations: Annotations,
    ): ConstraintResults;
    draw(drawables: Drawables, constraints?: ConstraintResults): void;
    getSvg(): SVGSVGElement;
    resize(
        resizeInfo: IMaskResize,
        settings?: Partial<AnuraMaskSettings>,
    ): void;
    setIntermediateResults(points: Points): void;
    setLoadingState(isLoading: boolean): void;
    setMaskVisibility(isVisible: boolean): void;
    setText(text: string, animation?: AnimationType): void;
}

Hierarchy

  • IMask
    • IAnuraMask

Implemented by

Properties

objectFit

objectFit: ObjectFit

Methods

checkConstraints

  • checkConstraints(face: DfxFace, annotations: Annotations): ConstraintResults

  • Parameters

    • face: DfxFace
    • annotations: Annotations

    Returns ConstraintResults

draw

  • draw(drawables: Drawables, constraints?: ConstraintResults): void

  • Parameters

    • drawables: Drawables
    • Optionalconstraints: ConstraintResults

    Returns void

getSvg

  • getSvg(): SVGSVGElement

  • Returns SVGSVGElement

resize

setIntermediateResults

  • setIntermediateResults(points: Points): void

  • Parameters

    • points: Points

    Returns void

setLoadingState

  • setLoadingState(isLoading: boolean): void

  • Parameters

    • isLoading: boolean

    Returns void

setMaskVisibility

  • setMaskVisibility(isVisible: boolean): void

  • Parameters

    • isVisible: boolean

    Returns void

setText

  • setText(text: string, animation?: AnimationType): void

  • Parameters

    • text: string
    • Optionalanimation: AnimationType

    Returns void

Settings

On This Page

Properties
Methods