ToolsAPI | Pointerra 3D Viewer JavaScript API

Hierarchy

ToolsAPI

Index

Constructors

constructor

Methods

Object literals

events

Constructors

constructor

new ToolsAPI(_api: ApiBase, _client: PointerraClient): ToolsAPI

- Defined in src/apis/tools_api.ts:20
Parameters
- _api: ApiBase
- _client: PointerraClient
Returns ToolsAPI

Methods

addToToolsPalette

addToToolsPalette(type: ToolType, icon: string, label: string): Promise<void>

- Defined in src/apis/tools_api.ts:71
Parameters
- type: ToolType
- icon: string
- label: string
Returns Promise<void>

clearSelection

clearSelection(): void

- Defined in src/apis/tools_api.ts:47
Returns void

deactivateTool

deactivateTool(): void

- Defined in src/apis/tools_api.ts:43
Returns void

getActiveToolType

getActiveToolType(): ToolType

- Defined in src/apis/tools_api.ts:59
Returns ToolType

getToolTypes

getToolTypes(): ToolType

- Defined in src/apis/tools_api.ts:55
Returns ToolType

registerTool

registerTool(tool: IPluginTool): ToolType

- Defined in src/apis/tools_api.ts:63
Parameters
- tool: IPluginTool
Returns ToolType

removeFromToolsPalette

removeFromToolsPalette(type: ToolType): Promise<void>

- Defined in src/apis/tools_api.ts:75
Parameters
- type: ToolType
Returns Promise<void>

setActiveTool

setActiveTool(toolType: ToolType): void

- Defined in src/apis/tools_api.ts:39
Parameters
- toolType: ToolType
Returns void

Object literals

events

events: object

featureQueryRequested

featureQueryRequested: EventEmitter = new EventEmitter()

toolActivated

toolActivated: EventEmitter = new EventEmitter()

toolDeactivated

toolDeactivated: EventEmitter = new EventEmitter()