Class WebVRController
Hierarchy
Implements
Index
Constructors
Properties
- browser
Gamepad - controller
Type - device
Position - device
Rotation Quaternion - device
Scale Factor - hand
- id
- index
- isXR
- on
Main Button State Changed Observable - on
Pad State Changed Observable - on
Pad Values Changed Observable - on
Secondary Button State Changed Observable - on
Trigger State Changed Observable - pad
- position
- raw
Pose - rotation
Quaternion - type
- DUALSHOCK
- GAMEPAD
- GENERIC
- POINTING_
POSE - POSE_
ENABLED - XBOX
Accessors
Methods
Constructors
constructor
-
Creates a new WebVRController from a gamepad
Parameters
-
vrGamepad: any
the gamepad that the WebVRController should be created from
Returns WebVRController
-
Properties
browser
The browser gamepad
controller
The type of controller (Eg. Windows mixed reality)
device
The device position in babylon space
device
The device rotation in babylon space
device
The scale factor of the device in babylon space
handSearch playground for hand
'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
idSearch playground for id
The id of the gamepad
indexSearch playground for index
The index of the gamepad
isXRSearch playground for isXR
If the controller is used in a webXR session
on
Fired when the main button state has changed
on
Fired when the pad state has changed
on
Fired when controllers stick values have changed
on
Fired when the secondary button state has changed
on
Fired when the trigger state has changed
padSearch playground for pad
X and Y axis corresponding to the controllers joystick
positionSearch playground for position
(Likely devicePosition should be used instead) The device position in its room space
raw
The raw pose from the device
rotation
(Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
typeSearch playground for type
Specifies what type of gamepad this represents
Static DUALSHOCKSearch playground for DUALSHOCK
Represents an Dual Shock controller
Static GAMEPADSearch playground for GAMEPAD
Represents a gamepad controller
Static GENERICSearch playground for GENERIC
Represents a generic controller
Static Readonly POINTING_
Name of the child mesh that can be used to cast a ray from the controller
Static POSE_
Represents a pose-enabled controller
Static XBOXSearch playground for XBOX
Represents an XBox controller
Accessors
default
-
The default controller model for the controller
Returns Nullable<AbstractMesh>
is
-
Specifies if the gamepad has been connected
Returns boolean
left
-
Gets the left joystick
Returns StickValues
-
Sets the left joystick values
Parameters
-
newValues: StickValues
Returns any
-
mesh
-
The mesh that is attached to the controller
Returns Nullable<AbstractMesh>
right
-
Gets the right joystick
Returns StickValues
-
Sets the right joystick value
Parameters
-
newValues: StickValues
Returns any
-
Methods
attach
-
Attaches a mesh to the controller
Parameters
-
mesh: AbstractMesh
the mesh to be attached
Returns void
-
attach
-
Attaches the controllers mesh to a camera
Parameters
-
camera: TargetCamera
the camera the mesh should be attached to
Returns void
-
disposeSearch playground for dispose
-
Disposes of th webVRController
Returns void
get
-
Gets the ray of the controller in the direction the controller is pointing
Parameters
-
Optional length: number
the length the resulting ray should be
Returns Ray
a ray in the direction the controller is pointing
-
Abstract init
-
Loads a mesh and attaches it to the controller
Parameters
-
scene: Scene
the scene the mesh should be added to
-
Optional meshLoaded: (mesh: AbstractMesh) => void
callback for when the mesh has been loaded
-
-
Parameters
-
mesh: AbstractMesh
Returns void
-
-
-
Returns void
-
on
-
Fired when a controller button's state has changed
Parameters
-
callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void
the callback containing the button that was modified
-
-
Parameters
-
controlledIndex: number
-
buttonIndex: number
-
state: ExtendedGamepadButton
Returns void
-
-
-
Returns void
-
onleftstickchangedSearch playground for onleftstickchanged
-
Callback triggered when the left joystick has changed
Parameters
-
callback: (values: StickValues) => void
-
-
Parameters
-
values: StickValues
Returns void
-
-
-
Returns void
-
onrightstickchangedSearch playground for onrightstickchanged
-
Callback triggered when the right joystick has changed
Parameters
-
callback: (values: StickValues) => void
-
-
Parameters
-
values: StickValues
Returns void
-
-
-
Returns void
-
updateSearch playground for update
-
Updates the state of the controller and mesh based on the current position and rotation of the controller
Returns void
update
-
Updates the state of the pose enbaled controller based on the raw pose data from the device
Parameters
-
poseData: DevicePose
raw pose fromthe device
Returns void
-
Defines the WebVRController object that represents controllers tracked in 3D space
Use WebXR instead