Class Controls<TEventMap>Abstract

constructor

• new Controls<TEventMap extends {}>(
      object: Object3D,
      domElement?: HTMLElement | SVGElement | null,
  ): Controls<TEventMap>

  Creates a new instance of Controls.

  Type Parameters

  • TEventMap extends {}

  Parameters

  • object: Object3D

    The object the controls should manage (usually the camera).

  • OptionaldomElement: HTMLElement | SVGElement | null

    The HTML element used for event listeners. (optional)

  Returns Controls<TEventMap>

domElement

enabled

object

connect

• connect(element: HTMLElement | SVGElement): void

  Connects the controls to the DOM. This method has so called "side effects" since it adds the module's event listeners to the DOM.

  Parameters

  • element: HTMLElement | SVGElement

  Returns void

disconnect

• disconnect(): void

  Disconnects the controls from the DOM.

  Returns void

dispose

• dispose(): void

  Call this method if you no longer want use to the controls. It frees all internal resources and removes all event listeners.

  Returns void

update

• update(delta: number): void

  Controls should implement this method if they have to update their internal state per simulation step.

  Parameters

  • delta: number

  Returns void