Class WebXRPlaneDetector
Hierarchy
-
WebXRAbstractFeature
- WebXRPlaneDetector
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
construct a new Plane Detector
Parameters
-
_xrSessionManager: WebXRSessionManager
an instance of xr Session manager
-
Optional _options: IWebXRPlaneDetectorOptions
configuration to use when constructing this feature
Returns WebXRPlaneDetector
-
Properties
disable
Should auto-attach be disabled?
is
Is this feature disposed?
on
Observers registered here will be executed when a new plane was added to the session
on
Observers registered here will be executed when a plane is no longer detected in the session
on
Observers registered here will be executed when an existing plane updates (for example - expanded) This can execute N times every frame
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
Parameters
-
Optional force: boolean
should attachment be forced (even when already attached)
Returns boolean
true if successful, false is failed or already attached
-
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
is
-
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
The plane detector is used to detect planes in the real world when in AR For more information see https://github.com/immersive-web/real-world-geometry/