Class WebXRImageTracking
Hierarchy
- WebXRAbstractFeature
- WebXRImageTracking
Index
Constructors
constructor
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
Properties
disable
Should auto-attach be disabled?
is
Is this feature disposed?
on
An image was deemed trackable, and the system will start tracking it.
on
The image was found and its state was updated.
on
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 optionsSearch playground for options
read-only options to be used in this module
xr
The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
Static Readonly NameSearch playground for Name
The module's name
Static Readonly VersionSearch playground for Version
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
Is this feature attached
Returns boolean
Methods
attachSearch playground for attach
attach this feature Will usually be called by the features manager
Returns boolean
true if successful.
detachSearch playground for detach
detach this feature. Will usually be called by the features manager
Returns boolean
true if successful.
disposeSearch playground for dispose
Dispose this feature and all of the resources attached
Returns void
get
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
getXRSession
Extends the session init object if needed
Returns Promise<Partial<XRSessionInit>>
augmentation object fo the xr session init object.
is
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
Image tracking for immersive AR sessions. Providing a list of images and their estimated widths will enable tracking those images in the real world.