Enables the tracking of faces in three-dimensional space and exposes classes that describe key points of a detected face.
Importing this module automatically enables thecapability within the project's *Properties*.
For two-dimensional face tracking, see the FaceTracking2D
module.
Property | Description |
---|---|
| (get) count: ScalarSignal The number of faces currently tracked in the scene, as a ScalarSignal . |
Method | Description |
---|---|
| createFaceMeshSceneObject(initialState?: {[key: string]: any}): Promise<FaceMesh> Creates a new dynamic FaceMesh object in the scene.
Note: This API requires "Scripting Dynamic Instantiation" capability to be enabled. |
| createFaceTrackerSceneObject(initialState?: {[key: string]: any}): Promise<FaceTracker> Creates a new dynamic FaceTracker object in the scene.
Note: This API requires "Scripting Dynamic Instantiation" capability to be enabled. |
| face(index: number): Face Returns a Face object from the array of detected faces.
|
Class | Description |
---|---|
Cheek | Exposes key points of the cheek of a detected Face object.Key points are returned in the detected face's local coordinate system. Use Face.cameraTransform.applyToPoint() to convert the point to the camera's coordinate system. |
Chin | Exposes key points of the chin of a detected Face object.Key points are returned in the detected face's local coordinate system. Use Face.cameraTransform.applyToPoint() to convert the point to the camera's coordinate system. |
Eye | Exposes details and key points of the eye of a detected Face object.Key points are returned in the detected face's local coordinate system. Use Face.cameraTransform.applyToPoint() to convert the point to the camera's coordinate system. |
Eyebrow | Exposes key points of the eyebrow of a detected Face object.Key points are returned in the detected face's local coordinate system. Use Face.cameraTransform.applyToPoint() to convert the point to the camera's coordinate system. |
Face | Exposes details and key points of a three-dimensionally tracked face. |
Forehead | Exposes key points of the forehead of a detected Face object.Key points are returned in the detected face's local coordinate system. Use Face.cameraTransform.applyToPoint() to convert the point to the camera's coordinate system. |
Mouth | Exposes details and key points of the mouth of a detected Face object.Key points are returned in the detected face's local coordinate system. Use Face.cameraTransform.applyToPoint() to convert the point to the camera's coordinate system. |
Nose | Exposes key points of the nose of a detected Face object.Key points are returned in the detected face's local coordinate system. Use Face.cameraTransform.applyToPoint() to convert the point to the camera's coordinate system. |