Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ControlsManager

The ControlsManager provides helper functions to create Controls instances and link them up with a Raycaster instance (reused across multiple Controls instances).

Hierarchy

  • Object3D
    • ControlsManager

Index

Constructors

constructor

  • new ControlsManager(camera: Camera, domElement: HTMLElement): ControlsManager
  • Parameters

    • camera: Camera

      the THREE.Camera instance used in the scene

    • domElement: HTMLElement

      the dom element on which THREE.js renderer is attached, generally available as renderer.domElement

    Returns ControlsManager

Methods

anchor

destroy

  • destroy(): void

detach

  • detach(object: Object3D, controls: Controls): void
  • Detaches the Controls instance from the provided THREE.js object

    Parameters

    • object: Object3D

      the object provided by the user

    • controls: Controls

      the controls instance anchored on the object

    Returns void

listen

  • Adds an event listener. Note that there is another method addEventListener on THREE.Object3D from which this class extends but that is specific to the internals of THREE.js, but not this library

    Parameters

    • event: EVENTS
    • callback: (object: Object3D | null, handleName: DEFAULT_HANDLE_GROUP_NAME | string) => void

      by default the second argument is the default group name for the Handle involved; for a custom handle, it is the name property set on the handle

    Returns void

removeListen

Generated using TypeDoc