Class FreeCameraMouseWheelInput

Manage the mouse wheel inputs to control a free camera.

See

https://doc.babylonjs.com/features/featuresDeepDive/cameras/customizingCameraInputs

Hierarchy (View Summary)

BaseCameraMouseWheelInput
- FreeCameraMouseWheelInput

Constructors

constructor

new FreeCameraMouseWheelInput(): FreeCameraMouseWheelInput

Returns FreeCameraMouseWheelInput

Inherited from BaseCameraMouseWheelInput.constructor

Properties

camera

camera: FreeCamera

Defines the camera the input is attached to.

onChangedObservable

onChangedObservable: Observable<
{ wheelDeltaX: number; wheelDeltaY: number; wheelDeltaZ: number },
> = ...

Observable for when a mouse wheel move event occurs.

wheelPrecisionX

wheelPrecisionX: number = 3.0

How fast is the camera moves in relation to X axis mouseWheel events. Use negative value to reverse direction.

wheelPrecisionY

wheelPrecisionY: number = 3.0

How fast is the camera moves in relation to Y axis mouseWheel events. Use negative value to reverse direction.

wheelPrecisionZ

wheelPrecisionZ: number = 3.0

How fast is the camera moves in relation to Z axis mouseWheel events. Use negative value to reverse direction.

Accessors

wheelXMoveRelative

get wheelXMoveRelative(): Nullable<Coordinate>
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.
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:54
set wheelXMoveRelative(axis: Nullable<Coordinate>): void
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
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:40

wheelXMoveScene

get wheelXMoveScene(): Nullable<Coordinate>
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.
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:216
set wheelXMoveScene(axis: Nullable<Coordinate>): void
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
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:202

wheelXRotateRelative

get wheelXRotateRelative(): Nullable<Coordinate>
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.
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:135
set wheelXRotateRelative(axis: Nullable<Coordinate>): void
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
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:121

wheelYMoveRelative

get wheelYMoveRelative(): Nullable<Coordinate>
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.
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:81
set wheelYMoveRelative(axis: Nullable<Coordinate>): void
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
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:67

wheelYMoveScene

get wheelYMoveScene(): Nullable<Coordinate>
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.
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:243
set wheelYMoveScene(axis: Nullable<Coordinate>): void
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
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:229

wheelYRotateRelative

get wheelYRotateRelative(): Nullable<Coordinate>
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.
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:162
set wheelYRotateRelative(axis: Nullable<Coordinate>): void
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
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:148

wheelZMoveRelative

get wheelZMoveRelative(): Nullable<Coordinate>
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.
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:108
set wheelZMoveRelative(axis: Nullable<Coordinate>): void
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
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:94

wheelZMoveScene

get wheelZMoveScene(): Nullable<Coordinate>
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.
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:270
set wheelZMoveScene(axis: Nullable<Coordinate>): void
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
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:256

wheelZRotateRelative

get wheelZRotateRelative(): Nullable<Coordinate>
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.
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:189
set wheelZRotateRelative(axis: Nullable<Coordinate>): void
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
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:175

Methods

attachControl

attachControl(noPreventDefault?: boolean): void
Attach the input controls to a specific dom element to get the input from.
Parameters
- OptionalnoPreventDefault: boolean
  Defines whether event caught by the controls should call preventdefault(). (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
Returns void
Inherited from BaseCameraMouseWheelInput.attachControl
- Defined in packages/dev/core/src/Cameras/Inputs/BaseCameraMouseWheelInput.ts:56

checkInputs

checkInputs(): void
Called for each rendered frame.

Returns void
Overrides BaseCameraMouseWheelInput.checkInputs
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:280

detachControl

detachControl(): void
Detach the current controls from the specified dom element.

Returns void
Inherited from BaseCameraMouseWheelInput.detachControl
- Defined in packages/dev/core/src/Cameras/Inputs/BaseCameraMouseWheelInput.ts:86

getClassName

getClassName(): string
Gets the class name of the current input.

Returns string
the class name
Overrides BaseCameraMouseWheelInput.getClassName
- Defined in packages/dev/core/src/Cameras/Inputs/freeCameraMouseWheelInput.ts:30

getSimpleName

getSimpleName(): string
Get the friendly name associated with the input class.

Returns string
the input friendly name
Inherited from BaseCameraMouseWheelInput.getSimpleName
- Defined in packages/dev/core/src/Cameras/Inputs/BaseCameraMouseWheelInput.ts:125

Class FreeCameraMouseWheelInput

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns FreeCameraMouseWheelInput

Properties

camera

onChangedObservable

wheelPrecisionX

wheelPrecisionY

wheelPrecisionZ

Accessors

wheelXMoveRelative

Returns Nullable<Coordinate>

Parameters

Returns void

wheelXMoveScene

Returns Nullable<Coordinate>

Parameters

Returns void

wheelXRotateRelative

Returns Nullable<Coordinate>

Parameters

Returns void

wheelYMoveRelative

Returns Nullable<Coordinate>

Parameters

Returns void

wheelYMoveScene

Returns Nullable<Coordinate>

Parameters

Returns void

wheelYRotateRelative

Returns Nullable<Coordinate>

Parameters

Returns void

wheelZMoveRelative

Returns Nullable<Coordinate>

Parameters

Returns void

wheelZMoveScene

Returns Nullable<Coordinate>

Parameters

Returns void

wheelZRotateRelative

Returns Nullable<Coordinate>

Parameters

Returns void

Methods

attachControl

Parameters

Returns void

checkInputs

Returns void

detachControl

Returns void

getClassName

Returns string

getSimpleName

Returns string