ArcRotateCameraInputsManager

Default Inputs manager for the ArcRotateCamera. It groups all the default supported inputs for ease of use. Interface representing an arc rotate camera inputs manager

see

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

Hierarchy

Index

Constructors

constructor

Properties

attached

Defines the list of inputs attahed to the camera.

attachedElement

attachedElement: Nullable<HTMLElement>

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

camera

Defined the camera the input manager belongs to.

checkInputs

checkInputs: function

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.

Type declaration

    • (): void
    • Returns void

noPreventDefault

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

addKeyboard

  • Add keyboard input support to the input manager.

    Returns ArcRotateCameraInputsManager

    the current input manager

addMouseWheel

  • Add mouse wheel input support to the input manager.

    Returns ArcRotateCameraInputsManager

    the current input manager

addPointers

  • Add pointers input support to the input manager.

    Returns ArcRotateCameraInputsManager

    the current input manager

addVRDeviceOrientation

  • Add orientation input support to the input manager.

    Returns ArcRotateCameraInputsManager

    the current input manager

attachElement

  • attachElement(element: HTMLElement, noPreventDefault?: boolean): void

attachInput

clear

  • clear(): void
  • Remove all attached input methods from a camera

    Returns void

detachElement

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

    Parameters

    • element: HTMLElement

      Defines the dom element to collect the events from

    • Optional disconnect: boolean

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

    Returns void

parse

  • 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

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

    Returns void

remove

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

    Parameters

    Returns void

removeByType

  • 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

  • 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

Static addGamepad

  • Adds gamepad input support to the ArcRotateCamera InputManager.

    Returns ArcRotateCameraInputsManager

    the camera inputs manager

Generated using TypeDoc