FaceMeshLoader | @zappar/zappar-threejs

Loader for adaptive face mesh data.

see: https://docs.zap.works/universal-ar/web-libraries/threejs/face-tracking/

Hierarchy

Loader
- FaceMeshLoader

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FaceMeshLoader(manager?: LoadingManager): FaceMeshLoader

Inherited from THREE.Loader.constructor
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:6
Parameters
- Optional manager: LoadingManager
Returns FaceMeshLoader

Properties

crossOrigin

crossOrigin: string

default: 'anonymous'

manager

manager: LoadingManager

path

path: string

default: ''

requestHeader

requestHeader: {}

default: {}

Type declaration

[header: string]: string

resourcePath

resourcePath: string

default: ''

withCredentials

withCredentials: boolean

default:: false

Methods

load

load(options?: string | FaceMeshLoaderOptions, onLoad?: (i: FaceMesh) => void, onProgress?: () => void, onError?: (message?: unknown) => void): FaceMesh

- Defined in src/loaders/facemeshloader.ts:32
Loads the data for a face mesh.

Parameters
- Optional options: string | FaceMeshLoaderOptions
  
  A URL or ArrayBuffer of the source mesh data or defines if some face features should be filled with polygons.
- Optional onLoad: (i: FaceMesh) => void
  
  Callback which returns the FaceMesh once it's loaded.
  - - (i: FaceMesh): void
    - Parameters
      - i: FaceMesh
      Returns void
- Optional onProgress: () => void
  - - (): void
    - Returns void
- Optional onError: (message?: unknown) => void
  
  Callback which is called if there's an error loading the mesh.
  - - (message?: unknown): void
    - Parameters
      - Optional message: unknown
      Returns void
Returns FaceMesh

The FaceMesh.

loadAsync

loadAsync(url: string, onProgress?: (event: ProgressEvent<EventTarget>) => void): Promise<any>

Inherited from THREE.Loader.loadAsync
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:40
Parameters
- url: string
- Optional onProgress: (event: ProgressEvent<EventTarget>) => void
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      - event: ProgressEvent<EventTarget>
      Returns void
Returns Promise<any>

loadFace

loadFace(options?: FaceMeshLoaderOptions, onLoad?: (i: FaceMesh) => void, onProgress?: () => void, onError?: (message?: unknown) => void): FaceMesh

- Defined in src/loaders/facemeshloader.ts:71
Loads the default face mesh.

Parameters
- Optional options: FaceMeshLoaderOptions
  
  Defines if some face features should be filled with polygons.
- Optional onLoad: (i: FaceMesh) => void
  
  Callback which returns the FaceMesh once it's loaded.
  - - (i: FaceMesh): void
    - Parameters
      - i: FaceMesh
      Returns void
- Optional onProgress: () => void
  - - (): void
    - Returns void
- Optional onError: (message?: unknown) => void
  
  Callback which is called if there's an error loading the mesh.
  - - (message?: unknown): void
    - Parameters
      - Optional message: unknown
      Returns void
Returns FaceMesh

The FaceMesh.

loadFullHeadSimplified

loadFullHeadSimplified(options?: FaceMeshLoaderOptions, onLoad?: (i: FaceMesh) => void, onProgress?: () => void, onError?: (message?: unknown) => void): FaceMesh

- Defined in src/loaders/facemeshloader.ts:107
Loads the full head simplified mesh which covers the whole of the user's head, including some neck. It's ideal for drawing into the depth buffer in order to mask out the back of 3D models placed on the user's head.

Parameters
- Optional options: FaceMeshLoaderOptions
  
  Defines if some face features should be filled with polygons.
- Optional onLoad: (i: FaceMesh) => void
  
  Callback which returns the FaceMesh once it's loaded.
  - - (i: FaceMesh): void
    - Parameters
      - i: FaceMesh
      Returns void
- Optional onProgress: () => void
  - - (): void
    - Returns void
- Optional onError: (message?: unknown) => void
  
  Callback which is called if there's an error loading the mesh.
  - - (message?: unknown): void
    - Parameters
      - Optional message: unknown
      Returns void
Returns FaceMesh

The FaceMesh.

setCrossOrigin

setCrossOrigin(crossOrigin: string): FaceMeshLoader

Inherited from THREE.Loader.setCrossOrigin
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:42
Parameters
- crossOrigin: string
Returns FaceMeshLoader

setPath

setPath(path: string): FaceMeshLoader

Inherited from THREE.Loader.setPath
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:44
Parameters
- path: string
Returns FaceMeshLoader

setRequestHeader

setRequestHeader(requestHeader: {}): FaceMeshLoader

Inherited from THREE.Loader.setRequestHeader
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:46
Parameters
- requestHeader: {}
  - [header: string]: string
Returns FaceMeshLoader

setResourcePath

setResourcePath(resourcePath: string): FaceMeshLoader

Inherited from THREE.Loader.setResourcePath
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:45
Parameters
- resourcePath: string
Returns FaceMeshLoader

setWithCredentials

setWithCredentials(value: boolean): FaceMeshLoader

Inherited from THREE.Loader.setWithCredentials
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:43
Parameters
- value: boolean
Returns FaceMeshLoader

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional manager: LoadingManager

Returns FaceMeshLoader

Properties

crossOrigin

manager

path

requestHeader

Type declaration

[header: string]: string

resourcePath

withCredentials

Methods

load

Parameters

Optional options: string | FaceMeshLoaderOptions

Optional onLoad: (i: FaceMesh) => void

Parameters

i: FaceMesh

Returns void

Optional onProgress: () => void

Returns void

Optional onError: (message?: unknown) => void

Parameters

Optional message: unknown

Returns void

Returns FaceMesh

loadAsync

Parameters

url: string

Optional onProgress: (event: ProgressEvent<EventTarget>) => void

Parameters

event: ProgressEvent<EventTarget>

Returns void

Returns Promise<any>

loadFace

Parameters

Optional options: FaceMeshLoaderOptions

Optional onLoad: (i: FaceMesh) => void

Parameters

i: FaceMesh

Returns void

Optional onProgress: () => void

Returns void

Optional onError: (message?: unknown) => void

Parameters

Optional message: unknown

Returns void

Returns FaceMesh

loadFullHeadSimplified

Parameters

Optional options: FaceMeshLoaderOptions

Optional onLoad: (i: FaceMesh) => void

Parameters

i: FaceMesh

Returns void

Optional onProgress: () => void

Returns void

Optional onError: (message?: unknown) => void

Parameters

Optional message: unknown

Returns void

Returns FaceMesh

setCrossOrigin

Parameters

crossOrigin: string

Returns FaceMeshLoader

setPath

Parameters

path: string

Returns FaceMeshLoader

setRequestHeader

Parameters