Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FreeCameraMouseInput

Manage the mouse inputs to control the movement of a free camera.

see

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

Hierarchy

  • FreeCameraMouseInput

Implements

Index

Constructors

constructor

Properties

angularSensibilitySearch playground for angularSensibility

angularSensibility: number

Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.

buttonsSearch playground for buttons

buttons: number[]

Defines the buttons associated with the input to handle camera move.

cameraSearch playground for camera

camera: FreeCamera

Defines the camera the input is attached to.

onPointerMovedObservableSearch playground for onPointerMovedObservable

onPointerMovedObservable: Observable<{ offsetX: number; offsetY: number }>

Observable for when a pointer move event occurs containing the move offset

touchEnabledSearch playground for touchEnabled

touchEnabled: boolean

Define if touch is enabled in the mouse input

Methods

attachControlSearch playground for attachControl

  • attachControl(noPreventDefault?: boolean): void

detachControlSearch playground for detachControl

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

    Returns void

getClassNameSearch playground for getClassName

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

    Returns string

    the class name

getSimpleNameSearch playground for getSimpleName

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

    Returns string

    the input friendly name

onContextMenuSearch playground for onContextMenu

  • onContextMenu(evt: PointerEvent): void
  • Called on JS contextmenu event. Override this method to provide functionality.

    Parameters

    • evt: PointerEvent

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method