Class FreeCameraMouseWheelInput

Manage the mouse wheel inputs to control a free camera.

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

Hierarchy

BaseCameraMouseWheelInput
- FreeCameraMouseWheelInput

Constructors

constructor

new FreeCameraMouseWheelInput(): FreeCameraMouseWheelInput

Inherited from BaseCameraMouseWheelInput.constructor
Returns FreeCameraMouseWheelInput

Properties

camera Search playground for camera

camera: FreeCamera

Defines the camera the input is attached to.

onChangedObservable Search playground for onChangedObservable

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

Observable for when a mouse wheel move event occurs.

wheelPrecisionX Search playground for wheelPrecisionX

wheelPrecisionX: number

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

wheelPrecisionY Search playground for wheelPrecisionY

wheelPrecisionY: number

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

wheelPrecisionZ Search 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>): void

- Defined in .temp/docdirectory/doc.d.ts:11913
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:11907
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

wheelXMoveScene

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

- Defined in .temp/docdirectory/doc.d.ts:11985
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:11979
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

wheelXRotateRelative

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

- Defined in .temp/docdirectory/doc.d.ts:11949
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:11943
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

wheelYMoveRelative

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

- Defined in .temp/docdirectory/doc.d.ts:11925
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:11919
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

wheelYMoveScene

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

- Defined in .temp/docdirectory/doc.d.ts:11997
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:11991
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

wheelYRotateRelative

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

- Defined in .temp/docdirectory/doc.d.ts:11961
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:11955
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

wheelZMoveRelative

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

- Defined in .temp/docdirectory/doc.d.ts:11937
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:11931
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

wheelZMoveScene

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

- Defined in .temp/docdirectory/doc.d.ts:12009
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:12003
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

wheelZRotateRelative

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

- Defined in .temp/docdirectory/doc.d.ts:11973
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:11967
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

attachControl Search playground for attachControl

attachControl(noPreventDefault?: boolean): void

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

checkInputs Search playground for checkInputs

checkInputs(): void

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

Returns void

detachControl Search playground for detachControl

detachControl(): void

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

Returns void

getClassName Search playground for getClassName

getClassName(): string

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

Returns string
the class name

getSimpleName Search playground for getSimpleName

getSimpleName(): string

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

Returns string
the input friendly name

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns FreeCameraMouseWheelInput

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 void

wheelXMoveScene

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns void

wheelXRotateRelative

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns void

wheelYMoveRelative

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns void

wheelYMoveScene

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns void

wheelYRotateRelative

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns void

wheelZMoveRelative

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns void

wheelZMoveScene

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns void

wheelZRotateRelative

Returns Nullable<Coordinate>

Parameters

axis: Nullable<Coordinate>

Returns void

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

camera Search playground for camera

onChangedObservable Search playground for onChangedObservable

wheelPrecisionX Search playground for wheelPrecisionX

wheelPrecisionY Search playground for wheelPrecisionY

wheelPrecisionZ Search playground for wheelPrecisionZ

attachControl Search playground for attachControl

checkInputs Search playground for checkInputs

detachControl Search playground for detachControl

getClassName Search playground for getClassName

getSimpleName Search playground for getSimpleName