API

Interface IWebXRTrackedImage

An object representing an image tracked by the system

interface IWebXRTrackedImage {
    emulated?: boolean;
    id: number;
    originalBitmap: ImageBitmap;
    ratio?: number;
    realWorldWidth?: number;
    transformationMatrix: Matrix;
    xrTrackingResult?: any;
}
Index
emulated?: boolean

Is the transformation provided emulated. If it is, the system "guesses" its real position. Otherwise it can be considered as exact position.

id: number

The ID of this image (which is the same as the position in the array that was used to initialize the feature)

originalBitmap: ImageBitmap

Just in case it is needed - the image bitmap that is being tracked

ratio?: number

The width/height ratio of this image. can be used to calculate the size of the detected object/image

realWorldWidth?: number

Width in real world (meters)

transformationMatrix: Matrix

A transformation matrix of this current image in the current reference space.

xrTrackingResult?: any

The native XR result image tracking result, untouched