Class WebXRDomOverlaySince
Hierarchy (View Summary)
- WebXRAbstractFeature
- WebXRDomOverlay
Constructors
constructor
-
new WebXRDomOverlay(
_xrSessionManager: WebXRSessionManager,
options: IWebXRDomOverlayOptions,
): WebXRDomOverlayCreates a new instance of the dom-overlay feature
Parameters
- _xrSessionManager: WebXRSessionManager
an instance of WebXRSessionManager
- options: IWebXRDomOverlayOptions
options to use when constructing this feature
Returns WebXRDomOverlay
- _xrSessionManager: WebXRSessionManager
Properties
Optionaldepends
The dependencies of this feature, if any
disable
Should auto-attach be disabled?
is
Is this feature disposed?
on
Observers registered here will be executed when the feature is attached
on
Observers registered here will be executed when the feature is detached
Readonlyoptions
options to use when constructing this feature
Static ReadonlyName
The module's name
Static ReadonlyVersion
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
dom
-
The type of DOM overlay (null when not supported). Provided by UA and remains unchanged for duration of session.
Returns Nullable<WebXRDomOverlayType>
xr
-
get xrNativeFeatureName(): string
The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
Returns string
-
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
Methods
attach
-
attach this feature Will usually be called by the features manager
Returns boolean
true if successful.
detach
-
detach this feature.
Returns boolean
true if successful, false if failed or already detached
dispose
-
Dispose this feature and all of the resources attached
Returns void
get
-
Extends the session init object if needed
Returns Promise<XRSessionInit>
augmentation object for 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
DOM Overlay Feature
5.0.0