Viewer - Drawing Tools
    Preparing search index...

    Class DrawingToolsApi

    Implements

    Index

    Constructors

    Accessors

    • get closed(): boolean

      Check if the drawing tool is closed.

      Returns boolean

    • get pauseWhileBusy(): boolean

      Pause the drawing tool while the viewport is busy (busy mode, e.g. a session computes), like pause; it continues when the busy mode ends (unless paused by pause). (default: false)

      Returns boolean

    • set pauseWhileBusy(value: boolean): void

      Pause the drawing tool while the viewport is busy (busy mode, e.g. a session computes), like pause; it continues when the busy mode ends (unless paused by pause). (default: false)

      Parameters

      • value: boolean

      Returns void

    • get uuid(): string

      The unique identifier of the drawing tool instance.

      Returns string

    Methods

    • Add a point to the drawing tool.

      Parameters

      • index: number

        The index of the point in the position array.

      • Optionalposition: vec3

        The position of the point.

      Returns void

    • Cancel any in-progress hover or drag interaction without closing the drawing tool.

      Returns void

    • Check if the drawing tool can redo the last action.

      Returns boolean

    • Check if the drawing tool can undo the last action.

      Returns boolean

    • Move a point of the drawing tool.

      Parameters

      • index: number

        The index of the point in the position array.

      • position: vec3

        The new position of the point.

      • Optionaltemporary: boolean

        If true, the move will not be applied immediately (default: false).

      • OptionalskipConstraints: boolean

      Returns void

    • Pause the drawing tool, suspending all user interactions while keeping the current state (a point drag in progress is cancelled). Call continue to resume. See also pauseWhileBusy.

      Returns void

    • Redo the last action of the drawing tool.

      Returns void

    • Remove a point from the drawing tool.

      Parameters

      • index: number

        The index of the point in the position array.

      Returns void

    • Remove a restriction from the drawing tool.

      Parameters

      • token: string

      Returns void

    • Undo the last action of the drawing tool.

      Returns void