Lens Scripting API
    Preparing search index...

    Class Head

    Used to move and rotate SceneObjects in sync with the user's head movements.

    Head Attached 3D Objects guide.

    // Switch to the next available face on tap when Head component is active
    // @input Component.Head head
    const numFaceToIterate = 2;
    script.createEvent("TapEvent").bind(function() {
        if (script.head.getSceneObject().isEnabledInHierarchy) {
            nextFaceIndex = (script.head.faceIndex + 1) % numFaceToIterate;
            script.head.faceIndex = nextFaceIndex;
        }
    })

    // Change the attachment point type to HeadCenter
    //@input Component.Head head
    script.head.setAttachmentPointType(AttachmentPointType.HeadCenter);

    Hierarchy (View Summary)

    Index

    Properties

    enabled faceIndex isEnabledInHierarchy onLandmarksUpdate sceneObject trackingScope uniqueIdentifier

    Methods

    destroy getFacesCount getLandmark getLandmarkCount getLandmarks getSceneObject getTransform getTypeName isOfType isSame setAttachmentPointType

    Properties

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    faceIndex: number

    The index of the face this head is attached to.

    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    onLandmarksUpdate: event1<vec2[], void>

    Triggered when the landmarks on the head are updated.

    sceneObject: SceneObject

    The SceneObject this component is on.

    trackingScope: TextureTrackingScope | PersonTrackingScope | FaceTrackingScope

    The tracking context this effect is being applied to.

    uniqueIdentifier: string

    Methods

    • Destroys the component.

      Returns void

    • Returns number

      For finding out whether any faces are tracked you should use SceneObject.isEnabledInHierarchy on the object containing the Head component instead. You can check for a given count by assigning face index on the Head Component.

      / **
       * Gets the count of enabled Head components (faces) in the scene hierarchy
       * @param {SceneObject} parentObject - The parent object of head binding components to search from
       * @returns {number} The number of enabled Head components found
       * /
      function getFacesCount(parentObject) {
          return getComponentsRecursive(parentObject, "Component.Head")
              .filter(head => head.isEnabledInHierarchy)
              .length;
      }


      / **
       * Recursively searches through scene object hierarchy to find all components of a specific type
       * @param {SceneObject} object - The scene object to search
       * @param {string} componentType - The type of component to find (e.g., "Component.Head")
       * @param {Component[]} results - Optional array to accumulate results
       * @returns {Component[]} Array of all matching components found in the hierarchy
       * /
      function getComponentsRecursive(object, componentType, results) {
          results = results || [];
          // Get all components of the specified type from current object
          var components = object.getComponents(componentType);
          for (var i=0; i<components.length; i++) {
              results.push(components[i]);
          }
          // Recursively search all child objects
          var childCount = object.getChildrenCount();
          for (var j=0; j<childCount; j++) {
              getComponentsRecursive(object.getChild(j), componentType, results);
          }
          return results;
      }

      Returns the total number of faces currently being tracked.

    • Returns the screen position of the face landmark at the passed in index.

      Parameters

      • index: number

      Returns vec2

      Use Head#onLandmarksUpdate

    • Returns the number of face landmarks being tracked.

      Returns number

      Use Head#onLandmarksUpdate

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    • Changes the attachment point type used to anchor this object to a face.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods