Class WebXRWalkingLocomotion
Hierarchy
-
WebXRAbstractFeature
- WebXRWalkingLocomotion
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Construct a new Walking Locomotion feature.
Parameters
-
sessionManager: WebXRSessionManager
manager for the current XR session
-
options: IWebXRWalkingLocomotionOptions
creation options, prominently including the vector target for locomotion
Returns WebXRWalkingLocomotion
-
Properties
disable
Should auto-attach be disabled?
is
Is this feature disposed?
xr
The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
Accessors
attached
-
Is this feature attached
Returns boolean
locomotion
-
The target to be articulated by walking locomotion. When the walking locomotion feature detects walking in place, this element's X and Z coordinates will be modified to reflect locomotion. This target should be either the XR space's origin (i.e., the parent node of the WebXRCamera) or the WebXRCamera itself. Note that the WebXRCamera path will modify the position of the WebXRCamera directly and is thus discouraged.
Returns WebXRCamera | TransformNode
-
The target to be articulated by walking locomotion. When the walking locomotion feature detects walking in place, this element's X and Z coordinates will be modified to reflect locomotion. This target should be either the XR space's origin (i.e., the parent node of the WebXRCamera) or the WebXRCamera itself. Note that the WebXRCamera path will modify the position of the WebXRCamera directly and is thus discouraged.
Parameters
-
locomotionTarget: WebXRCamera | TransformNode
Returns any
-
Static Name
-
The module's name.
Returns string
Static Version
-
The (Babylon) version of this module. This is an integer representing the implementation version. This number has no external basis.
Returns number
Methods
attachSearch playground for attach
-
Attaches the feature. Typically called automatically by the features manager.
Returns boolean
true if attach succeeded, false otherwise
detachSearch playground for detach
-
Detaches the feature. Typically called automatically by the features manager.
Returns boolean
true if detach succeeded, false otherwise
disposeSearch playground for dispose
-
Dispose this feature and all of the resources attached
Returns void
is
-
Checks whether this feature is compatible with the current WebXR session. Walking locomotion is only compatible with "immersive-vr" sessions.
Returns boolean
true if compatible, false otherwise
A module that will enable VR locomotion by detecting when the user walks in place.