Class WebXRImageTracking
Hierarchy
-
WebXRAbstractFeature
- WebXRImageTracking
Implements
Index
Constructors
Properties
Accessors
Methods
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 Auto AttachSearch playground for disableAutoAttach
Should auto-attach be disabled?
is DisposedSearch playground for isDisposed
Is this feature disposed?
on Trackable Image Found ObservableSearch playground for onTrackableImageFoundObservable
An image was deemed trackable, and the system will start tracking it.
on Tracked Image Updated ObservableSearch playground for onTrackedImageUpdatedObservable
The image was found and its state was updated.
on Untrackable Image Found ObservableSearch playground for onUntrackableImageFoundObservable
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 Native Feature NameSearch playground for xrNativeFeatureName
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 Tracked Image ByIdSearch playground for getTrackedImageById
-
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 Init ExtensionSearch playground for getXRSessionInitExtension
-
Extends the session init object if needed
Returns Promise<Partial<XRSessionInit>>
augmentation object fo the xr session init object.
is CompatibleSearch playground for isCompatible
-
Check if the needed objects are defined. This does not mean that the feature is enabled, but that the objects needed are well defined.
Returns boolean
Image tracking for immersive AR sessions. Providing a list of images and their estimated widths will enable tracking those images in the real world.