Scripting API
FaceTrackingModule
Face

Face

Exposes details and key points of a three-dimensionally tracked face.

Example

Properties

PropertyDescription

cameraTransform

(get) cameraTransform: Mat4Signal
(set) (Not Available)


The face transform relative to the camera coordinate system, as a Mat4Signal.
Calling cameraTransform.applyToPoint(point), where point is a point in the face's local coordinate system, will return a point in the camera's local coordinate system.

chin

(get) chin: Chin
(set) (Not Available)


The Chin of the tracked face.

forehead

(get) forehead: Forehead
(set) (Not Available)


The Forehead of the tracked face.

id

(get) id: StringSignal
(set) (Not Available)


The unique ID assigned to a tracked face, as a StringSignal.
A unique ID is generated for every new face detected and tracked in the scene.

If a face loses tracking it will be assigned a new unique ID when it is tracked again - the effect will not recognise individual faces.

isTracked

(get) isTracked: BoolSignal
(set) (Not Available)


Indicates whether the face is being tracked in the current frame, with a BoolSignal.
If false, the value of the Face object's properties represent their value during the frame they were most recently tracked in.

leftCheek

(get) leftCheek: Cheek
(set) (Not Available)


The left Cheek of the tracked face.

leftEye

(get) leftEye: Eye
(set) (Not Available)


The left Eye of the tracked face.

leftEyebrow

(get) leftEyebrow: Eyebrow
(set) (Not Available)


The left Eyebrow of the tracked face.

mouth

(get) mouth: Mouth
(set) (Not Available)


The Mouth of the tracked face.

nose

(get) nose: Nose
(set) (Not Available)


The Nose of the tracked face.

rightCheek

(get) rightCheek: Cheek
(set) (Not Available)


The right Cheek of the tracked face.

rightEye

(get) rightEye: Eye
(set) (Not Available)


The right Eye of the tracked face.

rightEyebrow

(get) rightEyebrow: Eyebrow
(set) (Not Available)


The right Eyebrow of the tracked face.

Methods

MethodDescription

point

point(u: ScalarSignal | number, v: ScalarSignal | number): PointSignal


Returns a PointSignal with the point in the face's local coordinate system that corresponds to the specified UV point from the facial mesh texture map.
Use the Face.cameraTransform() method to convert the point to the camera coordinate system.

  • u - the U coordinate from the facial mesh texture map.
  • v - the V coordinate from the facial mesh texture map.