Class Controls<TEventMap>`Abstract`

Abstract base class for controls.

Type Parameters

TEventMap extends {}

Hierarchy (view full)

EventDispatcher<TEventMap>
- Controls

Index

Constructors

constructor

new Controls<TEventMap>(object, domElement?): Controls<TEventMap>
Creates a new instance of Controls.
Type Parameters
- TEventMap extends {}
Parameters
- object: Object3D<Object3DEventMap>
  The object the controls should manage (usually the camera).
- OptionaldomElement: null | HTMLElement
  The HTML element used for event listeners. (optional)
Returns Controls<TEventMap>
Overrides EventDispatcher.constructor
- Defined in ../node_modules/@types/three/src/extras/Controls.d.ts:29

Properties

domElement

domElement: null | HTMLElement

The HTML element used for event listeners. If not provided via the constructor, .connect must be called after domElement has been set.

enabled

enabled: boolean

When set to false, the controls will not respond to user input. Default is true.

object

object: Object3D<Object3DEventMap>

The 3D object that is managed by the controls.

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<TEventMap[T], T, Controls<TEventMap>>
  The function that gets called when the event is fired.
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52

connect

connect(): 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.

Returns void
- Defined in ../node_modules/@types/three/src/extras/Controls.d.ts:35

disconnect

disconnect(): void
Disconnects the controls from the DOM.

Returns void
- Defined in ../node_modules/@types/three/src/extras/Controls.d.ts:40

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends string
Parameters
- event: BaseEvent<T> & TEventMap[T]
  The event that gets fired.
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:81

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
- Defined in ../node_modules/@types/three/src/extras/Controls.d.ts:46

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<TEventMap[T], T, Controls<TEventMap>>
  The function that gets called when the event is fired.
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:62

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<TEventMap[T], T, Controls<TEventMap>>
  The listener function that gets removed.
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:72

update

update(delta): void
Controls should implement this method if they have to update their internal state per simulation step.
Parameters
- delta: number
Returns void
- Defined in ../node_modules/@types/three/src/extras/Controls.d.ts:51

Class Controls<TEventMap>Abstract

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Controls<TEventMap>

Properties

domElement

enabled

object

Methods

addEventListener

Type Parameters

Parameters

Returns void

connect

Returns void

disconnect

Returns void

dispatchEvent

Type Parameters

Parameters

Returns void

dispose

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

removeEventListener

Type Parameters

Parameters

Returns void

update

Parameters

Returns void

Settings

On This Page

Class Controls<TEventMap>`Abstract`