Class FreeCameraMouseWheelInput

Manage the mouse wheel inputs to control a free camera.

see: https://doc.babylonjs.com/how_to/customizing_camera_inputs

Hierarchy

BaseCameraMouseWheelInput
- FreeCameraMouseWheelInput

Implements

ICameraInput<Camera>

Index

Properties

Accessors

Methods

Properties

cameraSearch playground for camera

camera: FreeCamera

Defines the camera the input is attached to.

onChangedObservableSearch playground for onChangedObservable

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

Observable for when a mouse wheel move event occurs.

wheelPrecisionXSearch playground for wheelPrecisionX

wheelPrecisionX: number

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

wheelPrecisionYSearch playground for wheelPrecisionY

wheelPrecisionY: number

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

wheelPrecisionZSearch playground for wheelPrecisionZ

wheelPrecisionZ: number

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>
set wheelXMoveRelative(axis: Nullable<Coordinate>): any

- Defined in .temp/docdirectory/doc.d.ts:11422
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 .temp/docdirectory/doc.d.ts:11416
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 any

The configured axis or null if none.

wheelXMoveScene

get wheelXMoveScene(): Nullable<Coordinate>
set wheelXMoveScene(axis: Nullable<Coordinate>): any

- Defined in .temp/docdirectory/doc.d.ts:11494
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 .temp/docdirectory/doc.d.ts:11488
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 any

The configured axis or null if none.

wheelXRotateRelative

get wheelXRotateRelative(): Nullable<Coordinate>
set wheelXRotateRelative(axis: Nullable<Coordinate>): any

- Defined in .temp/docdirectory/doc.d.ts:11458
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 .temp/docdirectory/doc.d.ts:11452
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 any

The configured axis or null if none.

wheelYMoveRelative

get wheelYMoveRelative(): Nullable<Coordinate>
set wheelYMoveRelative(axis: Nullable<Coordinate>): any

- Defined in .temp/docdirectory/doc.d.ts:11434
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 .temp/docdirectory/doc.d.ts:11428
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 any

The configured axis or null if none.

wheelYMoveScene

get wheelYMoveScene(): Nullable<Coordinate>
set wheelYMoveScene(axis: Nullable<Coordinate>): any

- Defined in .temp/docdirectory/doc.d.ts:11506
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 .temp/docdirectory/doc.d.ts:11500
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 any

The configured axis or null if none.

wheelYRotateRelative

get wheelYRotateRelative(): Nullable<Coordinate>
set wheelYRotateRelative(axis: Nullable<Coordinate>): any

- Defined in .temp/docdirectory/doc.d.ts:11470
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 .temp/docdirectory/doc.d.ts:11464
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 any

The configured axis or null if none.

wheelZMoveRelative

get wheelZMoveRelative(): Nullable<Coordinate>
set wheelZMoveRelative(axis: Nullable<Coordinate>): any

- Defined in .temp/docdirectory/doc.d.ts:11446
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 .temp/docdirectory/doc.d.ts:11440
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 any

The configured axis or null if none.

wheelZMoveScene

get wheelZMoveScene(): Nullable<Coordinate>
set wheelZMoveScene(axis: Nullable<Coordinate>): any

- Defined in .temp/docdirectory/doc.d.ts:11518
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 .temp/docdirectory/doc.d.ts:11512
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 any

The configured axis or null if none.

wheelZRotateRelative

get wheelZRotateRelative(): Nullable<Coordinate>
set wheelZRotateRelative(axis: Nullable<Coordinate>): any

- Defined in .temp/docdirectory/doc.d.ts:11482
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 .temp/docdirectory/doc.d.ts:11476
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 any

The configured axis or null if none.

Methods

attachControlSearch playground for attachControl

attachControl(noPreventDefault?: boolean): void

Implementation of ICameraInput.attachControl

Inherited from BaseCameraMouseWheelInput.attachControl
- Defined in .temp/docdirectory/doc.d.ts:10524
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

checkInputsSearch playground for checkInputs

checkInputs(): void

Overrides BaseCameraMouseWheelInput.checkInputs
- Defined in .temp/docdirectory/doc.d.ts:11522
Called for each rendered frame.

Returns void

detachControlSearch playground for detachControl

detachControl(): void

Implementation of ICameraInput.detachControl

Inherited from BaseCameraMouseWheelInput.detachControl
- Defined in .temp/docdirectory/doc.d.ts:10528
Detach the current controls from the specified dom element.

Returns void

getClassNameSearch playground for getClassName

getClassName(): string

Implementation of ICameraInput.getClassName

Overrides BaseCameraMouseWheelInput.getClassName
- Defined in .temp/docdirectory/doc.d.ts:11410
Gets the class name of the current input.

Returns string

the class name

getSimpleNameSearch playground for getSimpleName

getSimpleName(): string

Implementation of ICameraInput.getSimpleName

Inherited from BaseCameraMouseWheelInput.getSimpleName
- Defined in .temp/docdirectory/doc.d.ts:10542
Get the friendly name associated with the input class.

Returns string

the input friendly name

Hierarchy

Implements

Index

Properties

Accessors

Methods

Properties

cameraSearch playground for camera

onChangedObservableSearch playground for onChangedObservable

wheelPrecisionXSearch playground for wheelPrecisionX

wheelPrecisionYSearch playground for wheelPrecisionY

wheelPrecisionZSearch playground for wheelPrecisionZ

Accessors

wheelXMoveRelative

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns any

wheelXMoveScene

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns any

wheelXRotateRelative

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns any

wheelYMoveRelative

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns any

wheelYMoveScene

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns any

wheelYRotateRelative

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns any

wheelZMoveRelative

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns any

wheelZMoveScene

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns any

wheelZRotateRelative

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns any

Methods

attachControlSearch playground for attachControl

Parameters

Optional noPreventDefault: boolean

Returns void

checkInputsSearch playground for checkInputs

Returns void

detachControlSearch playground for detachControl

Returns void

getClassNameSearch playground for getClassName

Returns string

getSimpleNameSearch playground for getSimpleName

Returns string