Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IInteractionEngine

Hierarchy

  • IDomEventListener
    • IInteractionEngine

Implemented by

Index

Properties

closed: boolean

The current state of the interaction engine.

intersectionOpacity: number

The opacity threshold that used to for intersection. (Default: 0) If the object is equal or below the threshold, it is not intersected anymore.

Example: If the value is set to 0.25, all objects that have an opacity of 0.25 or lower and not intersectable.

managers: {}

All currently registered interaction managers with their token as a key.

Type declaration

Methods

  • Add a new interaction manager to the selection of interaction managers. This manager will be fed with all onDown, onMove and onEnd events by the InteractionEngine. The token that is return can be used to remove this interaction manager.

    Parameters

    Returns string

  • close(): void
  • Closes the interaction engine and removes all managers that where registered.

    Returns void

  • onKeyDown(event: KeyboardEvent): void
  • Parameters

    • event: KeyboardEvent

    Returns void

  • onKeyUp(event: KeyboardEvent): void
  • Parameters

    • event: KeyboardEvent

    Returns void

  • onMouseWheel(event: WheelEvent): void
  • Parameters

    • event: WheelEvent

    Returns void

  • onPointerDown(event: PointerEvent): void
  • Parameters

    • event: PointerEvent

    Returns void

  • onPointerEnd(event: PointerEvent): void
  • Parameters

    • event: PointerEvent

    Returns void

  • onPointerMove(event: PointerEvent): void
  • Parameters

    • event: PointerEvent

    Returns void

  • onPointerOut(event: PointerEvent): void
  • Parameters

    • event: PointerEvent

    Returns void

  • onPointerUp(event: PointerEvent): void
  • Parameters

    • event: PointerEvent

    Returns void

  • removeInteractionManager(token: string): boolean
  • Remove an interaction manager with the token returned when adding it.

    Parameters

    • token: string

    Returns boolean