W-CF Documentation - v11.0.0
    Preparing search index...

    Interface Tool

    interface Tool {
        eventStarted: ListenableEvent<void, Tool>;
        eventStopped: ListenableEvent<void, Tool>;
        getInteractionMode(): InteractionMode;
        handleKeyUp(pEvent: KeyboardEvent, pState: InputState): void;
        handlePointerCancel(pEvent: PointerEvent, pState: InputState): void;
        handlePointerDblClick(pEvent: PointerEvent, pState: InputState): void;
        handlePointerDown(pEvent: PointerEvent, pState: InputState): void;
        handlePointerMove(pEvent: PointerEvent, pState: InputState): void;
        handlePointerUp(pEvent: PointerEvent, pState: InputState): void;
        isAvailable(): boolean;
        isRunning(): boolean;
        start(pParameter: unknown): boolean;
        stop(): void;
    }

    Implemented by

    Index
    eventStarted: ListenableEvent<void, Tool>
    eventStopped: ListenableEvent<void, Tool>
    • Should return the current interaction mode. The interaction mode will be checked continuously while the tool is running.

      Returns InteractionMode

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Returns boolean

    • Should return true if the tool is running. False should be returned after a call to stop() or if the tool is finished with its operations.

      Returns boolean

    • Starts the tool. Returns false if the start was canceled/aborted.

      Parameters

      • pParameter: unknown

      Returns boolean

    • Returns void