Class WebXRTrackedImage

constructor

• new WebXRTrackedImage(
      context: WebXRImageTracking,
      trackedImage: WebXRImageTrackingModel,
      bitmap: ImageBitmap,
      measuredSize: number,
      state: "tracked" | "emulated",
      pose: any,
  ): WebXRTrackedImage

  Parameters

  • context: WebXRImageTracking
  • trackedImage: WebXRImageTrackingModel
  • bitmap: ImageBitmap
  • measuredSize: number
  • state: "tracked" | "emulated"
  • pose: any

  Returns WebXRTrackedImage

ReadonlymeasuredSize

Readonlystate

bitmap

• get bitmap(): ImageBitmap

  The ImageBitmap used for tracking

  Returns ImageBitmap

model

• get model(): WebXRImageTrackingModel

  The WebXRImageTrackingModel configuration for this tracked image. Use this to access the assigned 3D object, marker settings, and other image tracking configuration. Available on each WebXRTrackedImage received from the image-tracking CustomEvent (event.detail).

  Returns WebXRImageTrackingModel

  Example

  tracker.addEventListener("image-tracking", event => {
    for (const img of event.detail.trackedImages) {
      const model = img.model;
      // Access the assigned 3D object
      const obj = model.object;
      // Access other settings
      console.log(model.widthInMeters, model.hideWhenTrackingIsLost);
    }
  });
  Copy

trackedModel

• get trackedModel(): undefined | AssetReference

  The 3D object or prefab assigned to this tracked image marker in the WebXRImageTrackingModel. Use this to access the object associated with an AR image tracking marker from the image-tracking CustomEvent. Shorthand for this.model.object.

  Returns undefined | AssetReference

  Example

  tracker.addEventListener("image-tracking", event => {
    for (const img of event.detail.trackedImages) {
      const obj = img.trackedModel;
      // verbose alternative: img.model.object
    }
  });
  Copy

url

• get url(): string

  URL of the tracked marker image

  Returns string

widthInMeters

• get widthInMeters(): number

  Physical width of the marker in meters

  Returns number

applyToObject

• applyToObject(object: Object3D, t01?: undefined | number): void

  Apply the tracked image's position and rotation to a 3D object. Optionally applies smoothing to reduce jitter.

  Parameters

  • object: Object3D

    The 3D object to update
  • t01: undefined | number = undefined

    Interpolation factor (0-1) for smoothing. If undefined or >= 1, no smoothing is applied. When smoothing is enabled, larger position/rotation changes will automatically reduce the smoothing to prevent lag.

  Returns void

getPosition

• getPosition(vec: Vector3): Vector3

  Copy the current world position of the tracked image to a Vector3.

  Parameters

  • vec: Vector3

    The vector to store the position in

  Returns Vector3

  The input vector with the position copied to it

getQuaternion

• getQuaternion(quat: Quaternion): Quaternion

  Copy the current world rotation of the tracked image to a Quaternion.

  Parameters

  • quat: Quaternion

    The quaternion to store the rotation in

  Returns Quaternion

  The input quaternion with the rotation copied to it