FreeCameraMouseWheelInput

Manage the mouse wheel inputs to control a free camera.

see

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

Hierarchy

Implements

Index

Properties

camera

Find examples in Playground
camera: FreeCamera

Defines the camera the input is attached to.

onChangedObservable

Find examples in Playground
onChangedObservable: Observable<object>

Observable for when a mouse wheel move event occurs.

wheelPrecisionX

Find examples in Playground
wheelPrecisionX: number

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

wheelPrecisionY

Find examples in Playground
wheelPrecisionY: number

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

wheelPrecisionZ

Find examples in Playground
wheelPrecisionZ: number

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

Accessors

wheelXMoveRelative

Find examples in Playground
  • 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

    Returns any

    The configured axis or null if none.

wheelXMoveScene

Find examples in Playground
  • 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

    Returns any

    The configured axis or null if none.

wheelXRotateRelative

Find examples in Playground
  • 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

    Returns any

    The configured axis or null if none.

wheelYMoveRelative

Find examples in Playground
  • 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

    Returns any

    The configured axis or null if none.

wheelYMoveScene

Find examples in Playground
  • 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

    Returns any

    The configured axis or null if none.

wheelYRotateRelative

Find examples in Playground
  • 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

    Returns any

    The configured axis or null if none.

wheelZMoveRelative

Find examples in Playground
  • 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

    Returns any

    The configured axis or null if none.

wheelZMoveScene

Find examples in Playground
  • 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

    Returns any

    The configured axis or null if none.

wheelZRotateRelative

Find examples in Playground
  • 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

    Returns any

    The configured axis or null if none.

Methods

attachControl

Find examples in Playground
  • attachControl(noPreventDefault?: boolean): void

checkInputs

Find examples in Playground
  • checkInputs(): void

detachControl

Find examples in Playground
  • detachControl(): void

getClassName

Find examples in Playground
  • getClassName(): string

getSimpleName

Find examples in Playground
  • getSimpleName(): string

Generated using TypeDoc