FaceTrackingModule Overview
FaceTrackingModule Overview
Nose

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.

Example

//============================================================================
// Bind the position of a plane to the position of the user's nose
//
// Project setup:
// - One plane: plane0
//
// Required project capabilities:
// - Face Tracking (auto added on FaceTracking module import)
//
//============================================================================

// Load in the required modules
const Scene = require('Scene');
const FaceTracking = require('FaceTracking');

(async function () {  // Enables async/await in JS [part 1]

  // Locate the plane in the scene and the first detected face
  const [plane, face] = await Promise.all([
    Scene.root.findFirst('plane0'),
    FaceTracking.face(0)
  ]);

  // Get the nose object from the detected face
  const nose = face.nose;

  // Bind the position of the plane to the position of the bridge of the nose
  plane.transform.x = face.cameraTransform.applyToPoint(nose.bridge).x;
  plane.transform.y = face.cameraTransform.applyToPoint(nose.bridge).y;

})(); // Enables async/await in JS [part 2]

Properties

PropertyDescription
bridge
(get) bridge: PointSignal
(set) (Not Available)


The location of the bridge of the nose, as a PointSignal.
leftNostril
(get) leftNostril: PointSignal
(set) (Not Available)


The location of the left nostril, as a PointSignal.
rightNostril
(get) rightNostril: PointSignal
(set) (Not Available)


The location of the right nostril, as a PointSignal.
tip
(get) tip: PointSignal
(set) (Not Available)


The location of the tip of the nose, as a PointSignal.

Methods

This module exposes no methods.

Was this article helpful?