Class WebXRBackgroundRemover
Hierarchy (View Summary)
- WebXRAbstractFeature
- WebXRBackgroundRemover
Constructors
constructor
-
new WebXRBackgroundRemover(
_xrSessionManager: WebXRSessionManager,
options?: IWebXRBackgroundRemoverOptions,
): WebXRBackgroundRemoverconstructs a new background remover module
Parameters
- _xrSessionManager: WebXRSessionManager
the session manager for this module
- options: IWebXRBackgroundRemoverOptions = {}
read-only options to be used in this module
Returns WebXRBackgroundRemover
- _xrSessionManager: WebXRSessionManager
Properties
Optionaldepends
The dependencies of this feature, if any
disable
Should auto-attach be disabled?
is
Is this feature disposed?
on
registered observers will be triggered when the background state changes
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
[Empty Object] read-only options to be used in this module
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
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. Will usually be called by the features manager
Returns boolean
true if successful.
dispose
-
Dispose this feature and all of the resources attached
Returns void
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
A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.