Viewer - Interaction
    Preparing search index...

    Interface IInteractionEngine

    interface IInteractionEngine {
        closed: boolean;
        intersectionOpacity: number;
        managers: { [key: string]: IInteractionManager };
        addInteractionManager(manager: IInteractionManager): string;
        close(): void;
        onKeyDown(event: KeyboardEvent, pointerInCanvas: boolean): void;
        onKeyUp(event: KeyboardEvent, pointerInCanvas: boolean): void;
        onMouseWheel(event: WheelEvent): void;
        onPointerDown(event: PointerEvent): void;
        onPointerEnd(event: PointerEvent): void;
        onPointerMove(event: PointerEvent): void;
        onPointerOut(event: PointerEvent): void;
        onPointerUp(event: PointerEvent): void;
        removeInteractionManager(token: string): boolean;
    }

    Hierarchy

    • IDomEventListener
      • IInteractionEngine

    Implemented by

    Index

    Properties

    closed intersectionOpacity managers

    Methods

    addInteractionManager close onKeyDown onKeyUp onMouseWheel onPointerDown onPointerEnd onPointerMove onPointerOut onPointerUp removeInteractionManager

    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: { [key: string]: IInteractionManager }

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

    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

    • Closes the interaction engine and removes all managers that where registered.

      Returns void

    • Parameters

      • event: KeyboardEvent
      • pointerInCanvas: boolean

      Returns void

    • Parameters

      • event: KeyboardEvent
      • pointerInCanvas: boolean

      Returns void

    • Parameters

      • event: WheelEvent

      Returns void

    • Parameters

      • event: PointerEvent

      Returns void

    • Parameters

      • event: PointerEvent

      Returns void

    • Parameters

      • event: PointerEvent

      Returns void

    • Parameters

      • event: PointerEvent

      Returns void

    • Parameters

      • event: PointerEvent

      Returns void

    • Remove an interaction manager with the token returned when adding it.

      Parameters

      • token: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods