Interface IDrawingToolsApi

Readonlyclosed

Readonlypaused

ReadonlypointsData

Readonlyrestrictions

showDistanceLabels

showPointLabels

Readonlyuuid

addPoint

• addPoint(index: number, position?: vec3): void

  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

addRestriction

• addRestriction(
      properties: RestrictionProperties,
      token?: string,
  ): IRestrictionApi | undefined

  Add a ray tracing intersection restriction to the drawing tool.

  Parameters

  • properties: RestrictionProperties

    The properties of the restriction.

  • Optionaltoken: string

  Returns IRestrictionApi | undefined

  The api of the restriction.

cancel

• cancel(): void

  Cancel the drawing tool.

  Returns void

cancelDrag

• cancelDrag(): void

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

  Returns void

canRedo

• canRedo(): boolean

  Check if the drawing tool can redo the last action.

  Returns boolean

canUndo

• canUndo(): boolean

  Check if the drawing tool can undo the last action.

  Returns boolean

close

• close(): void

  Close the drawing tool.

  Returns void

continue

• continue(): void

  Resume the drawing tool after it has been paused.

  Returns void

isInteractionActive

• isInteractionActive(): boolean

  Returns true if a point or control is currently hovered or being dragged.

  Returns boolean

movePoint

• movePoint(
      index: number,
      position: vec3,
      temporary?: boolean,
      skipConstraints?: boolean,
  ): 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

• pause(): void

  Pause the drawing tool, suspending all user interactions while keeping the current state. Call continue to resume.

  Returns void

redo

• redo(): void

  Redo the last action of the drawing tool.

  Returns void

removePoint

• removePoint(index: number): void

  Remove a point from the drawing tool.

  Parameters

  • index: number

    The index of the point in the position array.

  Returns void

removeRestriction

• removeRestriction(id: string): void

  Remove a restriction from the drawing tool.

  Parameters

  • id: string

  Returns void

undo

• undo(): void

  Undo the last action of the drawing tool.

  Returns void

update

• update(): | void
  | { metaData: (RayTraceResult | undefined)[]; pointsData: PointsData }

  Receive an update of the drawing tool.

  Returns void | { metaData: (RayTraceResult | undefined)[]; pointsData: PointsData }

  The points data of the drawing tool.