Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AKeyboardInteraction

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _eventListeners

_eventListeners: AInteractionEventListener[]

_keyDownEventListener

_keyDownEventListener: undefined | AInteractionEventListener

_keyUpEventListener

_keyUpEventListener: undefined | AInteractionEventListener

active

active: boolean

element

element: AReceivesInteractionsInterface

element is typically the thing being interacted with. For example, if you are adding a click interaction to a THREE.Mesh, then the element would be the THREE.Mesh.

eventListenerOptions

eventListenerOptions: {} = {}

including once and capture https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener

Type declaration

  • [name: string]: any

handle

handle: string

interactionState

interactionState: {} = {}

Type declaration

  • [name: string]: any

keyDownCallback

keyDownCallback: AKeyboardInteractionCallback

keyUpCallback

keyUpCallback: AKeyboardInteractionCallback

keysDownState

keysDownState: {} = {}

Type declaration

  • [name: string]: boolean

onlyOnFirstIntersection

onlyOnFirstIntersection: boolean = true

owner

owner: AControllerInterface<any>

owner is whatever holds the interactions.

Accessors

eventListeners

Methods

_deactivateEventListeners

  • _deactivateEventListeners(): void

_processKeyDownEvent

_processKeyUpEvent

_removeKeyListeners

  • _removeKeyListeners(): void

_shouldIgnoreEvent

activate

  • activate(): void

addDOMEventListener

  • addDOMEventListener(eventType: string, callback: (...args: any[]) => any, options?: boolean | AddEventListenerOptions): { addListener: () => void; eventType: string; removeListener: () => void }

  • Parameters

    • eventType: string
    • callback: (...args: any[]) => any
        • (...args: any[]): any

        • Parameters

          • Rest ...args: any[]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns { addListener: () => void; eventType: string; removeListener: () => void }

    • addListener: () => void
        • (): void

        • Returns void

    • eventType: string
    • removeListener: () => void
        • (): void

        • Returns void

addEventListener

  • addEventListener(eventType: string, callback: (...args: any[]) => any): { addListener: () => void; eventType: string; removeListener: () => void }

  • Parameters

    • eventType: string
    • callback: (...args: any[]) => any
        • (...args: any[]): any

        • Parameters

          • Rest ...args: any[]

          Returns any

    Returns { addListener: () => void; eventType: string; removeListener: () => void }

    • addListener: () => void
        • (): void

        • Returns void

    • eventType: string
    • removeListener: () => void
        • (): void

        • Returns void

addSceneEventListener

  • addSceneEventListener(eventType: string, callback: (...args: any[]) => any, options?: boolean | AddEventListenerOptions): { addListener: () => void; eventType: string; removeListener: () => void }

  • Parameters

    • eventType: string
    • callback: (...args: any[]) => any
        • (...args: any[]): any

        • Parameters

          • Rest ...args: any[]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns { addListener: () => void; eventType: string; removeListener: () => void }

    • addListener: () => void
        • (): void

        • Returns void

    • eventType: string
    • removeListener: () => void
        • (): void

        • Returns void

bindMethods

  • bindMethods(): void

clearEventListeners

  • clearEventListeners(): void

clearInteractionState

  • clearInteractionState(): void

clearKeyState

  • clearKeyState(): void

deactivate

  • deactivate(): void

dispose

  • dispose(): void

getInteractionState

  • getInteractionState(name: string): any

getSceneElement

  • getSceneElement(): Scene

getWindowElement

  • getWindowElement(): Window & typeof globalThis

setEventListenerOptions

  • setEventListenerOptions(options?: {}): void

setInteractionState

  • setInteractionState(name: string, value: any): void

setKeyDownCallback

setKeyUpCallback

updateListeners

  • updateListeners(): void

Static Create

Generated using TypeDoc