Class FreeCameraMouseWheelInput
Hierarchy
- BaseCameraMouseWheelInput
- FreeCameraMouseWheelInput
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns FreeCameraMouseWheelInput
Properties
cameraSearch playground for camera
Defines the camera the input is attached to.
on Changed ObservableSearch playground for onChangedObservable
Observable for when a mouse wheel move event occurs.
wheel PrecisionXSearch playground for wheelPrecisionX
How fast is the camera moves in relation to X axis mouseWheel events. Use negative value to reverse direction.
wheel PrecisionYSearch playground for wheelPrecisionY
How fast is the camera moves in relation to Y axis mouseWheel events. Use negative value to reverse direction.
wheel PrecisionZSearch playground for wheelPrecisionZ
How fast is the camera moves in relation to Z axis mouseWheel events. Use negative value to reverse direction.
Accessors
wheelXMove Relative
Get the configured movement axis (relative to camera's orientation) the mouse wheel's X axis controls.
Returns Nullable<Coordinate>
The configured axis or null if none.
Set which movement axis (relative to camera's orientation) the mouse wheel's X axis controls.
Parameters
axis: Nullable<Coordinate>
The axis to be moved. Set null to clear.
Returns void
wheelXMove Scene
Get the configured movement axis (relative to the scene) the mouse wheel's X axis controls.
Returns Nullable<Coordinate>
The configured axis or null if none.
Set which movement axis (relative to the scene) the mouse wheel's X axis controls.
Parameters
axis: Nullable<Coordinate>
The axis to be moved. Set null to clear.
Returns void
wheelXRotate Relative
Get the configured rotation axis (relative to camera's orientation) the mouse wheel's X axis controls.
Returns Nullable<Coordinate>
The configured axis or null if none.
Set which rotation axis (relative to camera's orientation) the mouse wheel's X axis controls.
Parameters
axis: Nullable<Coordinate>
The axis to be moved. Set null to clear.
Returns void
wheelYMove Relative
Get the configured movement axis (relative to camera's orientation) the mouse wheel's Y axis controls.
Returns Nullable<Coordinate>
The configured axis or null if none.
Set which movement axis (relative to camera's orientation) the mouse wheel's Y axis controls.
Parameters
axis: Nullable<Coordinate>
The axis to be moved. Set null to clear.
Returns void
wheelYMove Scene
Get the configured movement axis (relative to the scene) the mouse wheel's Y axis controls.
Returns Nullable<Coordinate>
The configured axis or null if none.
Set which movement axis (relative to the scene) the mouse wheel's Y axis controls.
Parameters
axis: Nullable<Coordinate>
The axis to be moved. Set null to clear.
Returns void
wheelYRotate Relative
Get the configured rotation axis (relative to camera's orientation) the mouse wheel's Y axis controls.
Returns Nullable<Coordinate>
The configured axis or null if none.
Set which rotation axis (relative to camera's orientation) the mouse wheel's Y axis controls.
Parameters
axis: Nullable<Coordinate>
The axis to be moved. Set null to clear.
Returns void
wheelZMove Relative
Get the configured movement axis (relative to camera's orientation) the mouse wheel's Z axis controls.
Returns Nullable<Coordinate>
The configured axis or null if none.
Set which movement axis (relative to camera's orientation) the mouse wheel's Z axis controls.
Parameters
axis: Nullable<Coordinate>
The axis to be moved. Set null to clear.
Returns void
wheelZMove Scene
Get the configured movement axis (relative to the scene) the mouse wheel's Z axis controls.
Returns Nullable<Coordinate>
The configured axis or null if none.
Set which movement axis (relative to the scene) the mouse wheel's Z axis controls.
Parameters
axis: Nullable<Coordinate>
The axis to be moved. Set null to clear.
Returns void
wheelZRotate Relative
Get the configured rotation axis (relative to camera's orientation) the mouse wheel's Z axis controls.
Returns Nullable<Coordinate>
The configured axis or null if none.
Set which rotation axis (relative to camera's orientation) the mouse wheel's Z axis controls.
Parameters
axis: Nullable<Coordinate>
The axis to be moved. Set null to clear.
Returns void
Methods
attach ControlSearch playground for attachControl
Attach the input controls to a specific dom element to get the input from.
Parameters
Optional noPreventDefault: boolean
Defines whether event caught by the controls should call preventdefault(). (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
Returns void
check InputsSearch playground for checkInputs
Called for each rendered frame.
Returns void
detach ControlSearch playground for detachControl
Detach the current controls from the specified dom element.
Returns void
get Class NameSearch playground for getClassName
Gets the class name of the current input.
Returns string
the class name
get Simple NameSearch playground for getSimpleName
Get the friendly name associated with the input class.
Returns string
the input friendly name
Manage the mouse wheel inputs to control a free camera.
https://doc.babylonjs.com/how_to/customizing_camera_inputs