Viewer - Transformation Tools
    Preparing search index...

    Interface IGumballTransform

    interface IGumballTransform {
        closed: boolean;
        id: string;
        paused: boolean;
        pauseWhileBusy: boolean;
        show: boolean;
        close(): void;
        continue(): 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;
        pause(): void;
    }

    Hierarchy

    • ITransformationToolsManager
      • IGumballTransform

    Implemented by

    Index

    Properties

    closed: boolean

    Check if the Transformations Tools are currently active.

    id: string

    The id of the transformation tools instance. This can be used to identify the transformation tools instance and is useful when working with multiple transformation tools instances.

    paused: boolean

    Whether the Transformation Tools are paused: by pause, or while the viewport is busy if pauseWhileBusy is set. A change of the busy mode (and the setting at creation) is applied asynchronously, right after the current call stack.

    pauseWhileBusy: boolean

    Pause the Transformation Tools while the viewport is busy (busy mode, e.g. a session computes), like pause; they continue when the busy mode ends (unless paused by pause). (default: false, see also the setting of the same name)

    show: boolean

    Show or hide the Transformation Tools.

    Methods

    • Close the transformation tools and remove it from the viewport.

      Returns void

    • Resume the Transformation Tools after pause (they stay paused while the viewport is busy if pauseWhileBusy is set).

      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

    • Pause the Transformation Tools, e.g. while a computation runs: they stay visible, but ignore all user interactions until continue is called. A transformation in progress is cancelled: the nodes return to their placement before it, without a matrix change being reported. The camera is not affected. See also pauseWhileBusy.

      Returns void