Options
All
  • Public
  • Public/Protected
  • All
Menu

Default Inputs manager for the FollowCamera. It groups all the default supported inputs for ease of use.

see

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

Hierarchy

Index

Constructors

Properties

Defines the list of inputs attached to the camera.

attachedToElement: boolean

Defines the dom element the camera is collecting inputs from. This is null if the controls have not been attached.

camera: FollowCamera

Defined the camera the input manager belongs to.

checkInputs: () => void

Type declaration

    • (): void
    • Update the current camera state depending on the inputs that have been used this frame. This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.

      Returns void

noPreventDefault: boolean

Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)

Methods

  • Add keyboard input support to the input manager.

    Returns FollowCameraInputsManager

    the current input manager

  • Add mouse wheel input support to the input manager.

    Returns FollowCameraInputsManager

    the current input manager

  • Add pointers input support to the input manager.

    Returns FollowCameraInputsManager

    the current input manager

  • Add orientation input support to the input manager.

    Returns FollowCameraInputsManager

    the current input manager

  • attachElement(noPreventDefault?: boolean): void
  • clear(): void
  • Remove all attached input methods from a camera

    Returns void

  • detachElement(disconnect?: boolean): void
  • Detach the current manager inputs controls from a specific dom element.

    Parameters

    • Optional disconnect: boolean

      Defines whether the input should be removed from the current list of attached inputs

    Returns void

  • parse(parsedCamera: any): void
  • Parses an input manager serialized JSON to restore the previous list of inputs and states associated to a camera.

    Parameters

    • parsedCamera: any

      Defines the JSON to parse

    Returns void

  • rebuildInputCheck(): void
  • Rebuild the dynamic inputCheck function from the current list of defined inputs in the manager.

    Returns void

  • Remove a specific input method from a camera example: camera.inputs.remove(camera.inputs.attached.mouse);

    Parameters

    Returns void

  • removeByType(inputType: string): void
  • Remove a specific input type from a camera example: camera.inputs.remove("ArcRotateCameraGamepadInput");

    Parameters

    • inputType: string

      the type of the input to remove

    Returns void

  • serialize(serializedCamera: any): void
  • Serialize the current input manager attached to a camera. This ensures than once parsed, the input associated to the camera will be identical to the current ones

    Parameters

    • serializedCamera: any

      Defines the camera serialization JSON the input serialization should write to

    Returns void

Legend

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

Settings

Theme