WebXRImageTracking | Babylon.js API documentation

Class WebXRImageTracking

Image tracking for immersive AR sessions. Providing a list of images and their estimated widths will enable tracking those images in the real world.

Hierarchy (View Summary)

WebXRAbstractFeature
- WebXRImageTracking

Constructors

constructor

new WebXRImageTracking(
_xrSessionManager: WebXRSessionManager,
options: IWebXRImageTrackingOptions,
): WebXRImageTracking
constructs the image tracking feature
Parameters
- _xrSessionManager: WebXRSessionManager
  the session manager for this module
- options: IWebXRImageTrackingOptions
  read-only options to be used in this module
Returns WebXRImageTracking
Overrides WebXRAbstractFeature.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:8687

Properties

`Optional`dependsOn

dependsOn?: string[]

The dependencies of this feature, if any

disableAutoAttach

disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposed

isDisposed: boolean

Is this feature disposed?

onFeatureAttachObservable

onFeatureAttachObservable: Observable<IWebXRFeature>

Observers registered here will be executed when the feature is attached

onFeatureDetachObservable

onFeatureDetachObservable: Observable<IWebXRFeature>

Observers registered here will be executed when the feature is detached

onTrackableImageFoundObservable

onTrackableImageFoundObservable: Observable<IWebXRTrackedImage>

An image was deemed trackable, and the system will start tracking it.

onTrackedImageUpdatedObservable

onTrackedImageUpdatedObservable: Observable<IWebXRTrackedImage>

The image was found and its state was updated.

onUntrackableImageFoundObservable

onUntrackableImageFoundObservable: Observable<number>

This will be triggered if the underlying system deems an image untrackable. The index is the index of the image from the array used to initialize the feature.

`Readonly`options

options: IWebXRImageTrackingOptions

read-only options to be used in this module

`Static` `Readonly`Name

Name: "xr-image-tracking"

The module's name

`Static` `Readonly`Version

Version: 1

The (Babylon) version of this module. This is an integer representing the implementation version. This number does not correspond to the WebXR specs version

Accessors

attached

get attached(): boolean
Is this feature attached

Returns boolean
Inherited from WebXRAbstractFeature.attached
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10881

xrNativeFeatureName

get xrNativeFeatureName(): string
The name of the native xr feature name (like anchor, hit-test, or hand-tracking)

Returns string
Inherited from WebXRAbstractFeature.xrNativeFeatureName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10859
set xrNativeFeatureName(name: string): void
The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
Parameters
- name: string
Returns void
Inherited from WebXRAbstractFeature.xrNativeFeatureName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10860

Methods

attach

attach(): boolean
attach this feature Will usually be called by the features manager

Returns boolean
true if successful.
Overrides WebXRAbstractFeature.attach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:8698

detach

detach(): boolean
detach this feature. Will usually be called by the features manager

Returns boolean
true if successful.
Overrides WebXRAbstractFeature.detach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:8705

dispose

dispose(): void
Dispose this feature and all of the resources attached

Returns void
Overrides WebXRAbstractFeature.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:8716

getTrackedImageById

getTrackedImageById(id: number): Nullable<IWebXRTrackedImage>
Get a tracked image by its ID.
Parameters
- id: number
  the id of the image to load (position in the init array)
Returns Nullable<IWebXRTrackedImage>
a trackable image, if exists in this location
- Defined in .temp/typedoc/docdirectory/doc.d.ts:8712

getXRSessionInitExtension

getXRSessionInitExtension(): Promise<Partial<XRSessionInit>>
Extends the session init object if needed

Returns Promise<Partial<XRSessionInit>>
augmentation object fo the xr session init object.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:8721

isCompatible

isCompatible(): boolean
This function will be executed during before enabling the feature and can be used to not-allow enabling it. Note that at this point the session has NOT started, so this is purely checking if the browser supports it

Returns boolean
whether or not the feature is compatible in this environment
Inherited from WebXRAbstractFeature.isCompatible
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10905

Class WebXRImageTracking

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebXRImageTracking

Properties

OptionaldependsOn

disableAutoAttach

isDisposed

onFeatureAttachObservable

onFeatureDetachObservable

onTrackableImageFoundObservable

onTrackedImageUpdatedObservable

onUntrackableImageFoundObservable

Readonlyoptions

Static ReadonlyName

Static ReadonlyVersion

Accessors

attached

Returns boolean

xrNativeFeatureName

Returns string

Parameters

Returns void

Methods

attach

Returns boolean

detach

Returns boolean

dispose

Returns void

getTrackedImageById

Parameters

Returns Nullable<IWebXRTrackedImage>

getXRSessionInitExtension

Returns Promise<Partial<XRSessionInit>>

isCompatible

Returns boolean

Settings

On This Page

`Optional`dependsOn

`Readonly`options

`Static` `Readonly`Name

`Static` `Readonly`Version