Class DrawingToolsApi

Hierarchy

DrawingToolsApi

Implements

IDrawingToolsApi

Index

Constructors

constructor

new DrawingToolsApi(viewport: IViewportApi, callbacks: Callbacks, settings: Settings, defaultTextures?: DefaultTextures, parentNode?: ITreeNode): DrawingToolsApi

Parameters
- viewport: IViewportApi
- callbacks: Callbacks
- settings: Settings
- Optional defaultTextures: DefaultTextures
- Optional parentNode: ITreeNode
Returns DrawingToolsApi

Accessors

closed

get closed(): boolean

Implementation of IDrawingToolsApi.closed

Check if the drawing tool is closed.

Returns boolean

paused

get paused(): boolean

Implementation of IDrawingToolsApi.paused

Check if the drawing tool is paused.

Returns boolean

pointsData

get pointsData(): PointsData

Implementation of IDrawingToolsApi.pointsData

The points data of the drawing tool.

Returns PointsData

restrictions

get restrictions(): {}

Implementation of IDrawingToolsApi.restrictions

The restrictions of the drawing tool.

Returns {}
- [key: string]: IRestrictionApi

showDistanceLabels

get showDistanceLabels(): boolean
set showDistanceLabels(value: boolean): void

Implementation of IDrawingToolsApi.showDistanceLabels

Show the distance labels of the drawing tool.

Returns boolean
Implementation of IDrawingToolsApi.showDistanceLabels

Show the distance labels of the drawing tool.

Parameters
- value: boolean
Returns void

showPointLabels

get showPointLabels(): boolean
set showPointLabels(value: boolean): void

Implementation of IDrawingToolsApi.showPointLabels

Show the point labels of the drawing tool.

Returns boolean
Implementation of IDrawingToolsApi.showPointLabels

Show the point labels of the drawing tool.

Parameters
- value: boolean
Returns void

uuid

get uuid(): string

Implementation of IDrawingToolsApi.uuid

The unique identifier of the drawing tool instance.

Returns string

Methods

addPoint

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

Implementation of IDrawingToolsApi.addPoint

Add a point to the drawing tool.

Parameters
- index: number
- Optional position: vec3
Returns void

addRestriction

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

Implementation of IDrawingToolsApi.addRestriction

Add a ray tracing intersection restriction to the drawing tool.

Parameters
- properties: RestrictionProperties
- Optional incomingToken: string
Returns undefined | IRestrictionApi
The api of the restriction.

canRedo

canRedo(): boolean

Implementation of IDrawingToolsApi.canRedo

Check if the drawing tool can redo the last action.

Returns boolean

canUndo

canUndo(): boolean

Implementation of IDrawingToolsApi.canUndo

Check if the drawing tool can undo the last action.

Returns boolean

cancel

cancel(): void

Implementation of IDrawingToolsApi.cancel

Cancel the drawing tool.

Returns void

cancelDrag

cancelDrag(): void

Implementation of IDrawingToolsApi.cancelDrag

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

Returns void

close

close(): void

Implementation of IDrawingToolsApi.close

Close the drawing tool.

Returns void

continue

continue(): void

Implementation of IDrawingToolsApi.continue

Resume the drawing tool after it has been paused.

Returns void

isInteractionActive

isInteractionActive(): boolean

Implementation of IDrawingToolsApi.isInteractionActive

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

Implementation of IDrawingToolsApi.movePoint

Move a point of the drawing tool.

Parameters
- index: number
- position: vec3
- Optional temporary: boolean
- Optional skipConstraints: boolean
Returns void

pause

pause(): void

Implementation of IDrawingToolsApi.pause

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

Returns void

redo

redo(): void

Implementation of IDrawingToolsApi.redo

Redo the last action of the drawing tool.

Returns void

removePoint

removePoint(index: number): void

Implementation of IDrawingToolsApi.removePoint

Remove a point from the drawing tool.

Parameters
- index: number
Returns void

removeRestriction

removeRestriction(token: string): void

Implementation of IDrawingToolsApi.removeRestriction

Remove a restriction from the drawing tool.

Parameters
- token: string
Returns void

undo

undo(): void

Implementation of IDrawingToolsApi.undo

Undo the last action of the drawing tool.

Returns void

update

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

Implementation of IDrawingToolsApi.update

Receive an update of the drawing tool.

Returns void | { metaData: (undefined | RayTraceResult)[]; pointsData: PointsData }
The points data of the drawing tool.