Viewer - Drawing Tools
    Preparing search index...

    Class DrawingToolsApi

    Implements

    Index

    Constructors

    • Parameters

      • viewport: IViewportApi
      • callbacks: Callbacks
      • settings: Settings
      • OptionaldefaultTextures: DefaultTextures
      • OptionalparentNode: ITreeNode

      Returns DrawingToolsApi

    Accessors

    • get closed(): boolean

      Check if the drawing tool is closed.

      Returns boolean

    • get paused(): boolean

      Check if the drawing tool is paused.

      Returns boolean

    • 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

    • Resume the drawing tool after it has been paused.

      Returns void

    • 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. Call continue to resume.

      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