Class AbstractKeyboardControls

Abstract class for all keyboard controls implementations.

Hierarchy

EventDispatcher
- AbstractKeyboardControls

Implements

KeyboardControls

Index

Constructors

Properties

domElement enabled keyStates object onKeyDownEvent onKeyUpEvent

Methods

activate addEventListener deactivate dispatchEvent hasEventListener onKeyDown onKeyUp removeEventListener update

Constructors

constructor

new AbstractKeyboardControls(object, domElement): AbstractKeyboardControls
Parameters
- object: Object3D<Object3DEventMap>
- domElement: HTMLCanvasElement
Returns AbstractKeyboardControls
Overrides THREE.EventDispatcher.constructor
- Defined in src/controls/AbstractKeyboardControls.ts:30

Properties

domElement

domElement: HTMLCanvasElement

enabled

enabled: boolean

keyStates

keyStates: Record<string, boolean>

E.g. KeyW = true

object

object: Object3D<Object3DEventMap>

onKeyDownEvent

onKeyDownEvent: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: KeyboardEvent
  Returns void

onKeyUpEvent

onKeyUpEvent: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: KeyboardEvent
  Returns void

Methods

activate

activate(): void
Returns void
Implementation of KeyboardControls.activate
- Defined in src/controls/AbstractKeyboardControls.ts:78

addEventListener

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

deactivate

deactivate(): void
Returns void
Implementation of KeyboardControls.deactivate
- Defined in src/controls/AbstractKeyboardControls.ts:85

dispatchEvent

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

hasEventListener

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

onKeyDown

onKeyDown(_event): void
Write your own onKeyDown function in your implementation.
Parameters
- _event: KeyboardEvent
Returns void
- Defined in src/controls/AbstractKeyboardControls.ts:68

onKeyUp

onKeyUp(_event): void
Write your own onKeyUp function in your implementation.
Parameters
- _event: KeyboardEvent
Returns void
- Defined in src/controls/AbstractKeyboardControls.ts:74

removeEventListener

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

update

update(_delta): void
Parameters
- _delta: number
Returns void
Implementation of KeyboardControls.update
- Defined in src/controls/AbstractKeyboardControls.ts:76

Generated using TypeDoc