Class WebXRTrackedImage

Represents a tracked image detected during a WebXR session. Contains position, rotation, and tracking state information for a detected marker image.

Properties:

Access image URL and physical dimensions
Get current position and rotation in world space
Check tracking state (tracked vs emulated)
Apply transform to 3D objects

Index

Constructors

Properties

measuredSize state

Accessors

bitmap model url widthInMeters

Methods

applyToObject getPosition getQuaternion

Constructors

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

Properties

`Readonly`measuredSize

measuredSize: number

The measured size of the detected image in the real world. May differ from widthInMeters if the physical marker doesn't match the configured size.

`Readonly`state

state: "tracked" | "emulated"

Current tracking state of the image:

tracked - Image is currently being tracked by the system
emulated - Tracking is being emulated (less accurate)

Accessors

bitmap

get bitmap(): ImageBitmap
The ImageBitmap used for tracking

Returns ImageBitmap

model

get model(): WebXRImageTrackingModel
The WebXRImageTrackingModel configuration for this tracked image

Returns WebXRImageTrackingModel

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

Methods

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