Options
All
  • Public
  • Public/Protected
  • All
Menu

Attaches content to a known image as it moves around in the camera view.

see

https://docs.zap.works/universal-ar/web-libraries/babylonjs/image-tracking/

Hierarchy

  • ImageTracker
    • ImageTracker

Index

Constructors

constructor

Properties

anchors

anchors: Map<string, ImageAnchor>

A map of the available image anchors by their respective IDs.

onNewAnchor

onNewAnchor: Event1<ImageAnchor>

Emitted when a new anchor is created by the tracker.

onNotVisible

onNotVisible: Event1<ImageAnchor>

Emitted when an anchor goes from being visible in the previous camera frame, to not being visible in the current frame.

onVisible

onVisible: Event1<ImageAnchor>

Emitted when an anchor becomes visible in a camera frame.

visible

visible: Set<ImageAnchor>

The set of currently visible anchors.

Accessors

enabled

  • get enabled(): boolean
  • set enabled(e: boolean): void
  • Gets/sets the enabled state of the image tracker. Disable when not in use to save computational resources during frame processing.

    Returns boolean

  • Gets/sets the enabled state of the image tracker. Disable when not in use to save computational resources during frame processing.

    Parameters

    • e: boolean

    Returns void

Methods

destroy

  • destroy(): void
  • Destroys the image tracker.

    Returns void

loadTarget

  • loadTarget(src: string | ArrayBuffer): Promise<void>
  • Parameters

    • src: string | ArrayBuffer

      A URL to, or an ArrayBuffer of, the target file from the source image you'd like to track.

    Returns Promise<void>

    A promise that's resolved once the file is downloaded. It may still take a few frames for the tracker to fully initialize and detect images.

Legend

  • Constructor
  • Property
  • Method

Generated using TypeDoc