Skip to main content

Class: abstract BaseTool

Abstract base class from which all tools derive. Deals with cleanly merging custom and default configuration, and strategy application.

Extended by​

Constructors​

new BaseTool()​

new BaseTool(toolProps, defaultToolProps): BaseTool

Parameters​

• toolProps: PublicToolProps

• defaultToolProps: SharedToolProp

Returns​

BaseTool

Defined in​

tools/src/tools/base/BaseTool.ts:23

Properties​

configuration​

configuration: Record<string, any>

Defined in​

tools/src/tools/base/BaseTool.ts:17

mode​

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

Defined in​

tools/src/tools/base/BaseTool.ts:21

supportedInteractionTypes​

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

Defined in​

tools/src/tools/base/BaseTool.ts:15

toolGroupId​

toolGroupId: string

ToolGroup ID the tool instance belongs to

Defined in​

tools/src/tools/base/BaseTool.ts:19

toolName​

static toolName: any

Defined in​

tools/src/tools/base/BaseTool.ts:13

Methods​

applyActiveStrategy()​

applyActiveStrategy(enabledElement, operationData): any

Applies the active strategy function to the enabled element with the specified operation data.

Parameters​

• enabledElement: IEnabledElement

The element that is being operated on.

• operationData: unknown

The data that needs to be passed to the strategy.

Returns​

any

The result of the strategy.

Defined in​

tools/src/tools/base/BaseTool.ts:62

applyActiveStrategyCallback()​

applyActiveStrategyCallback(enabledElement, operationData, callbackType): any

Applies the active strategy, with a given event type being applied. The event type function is found by indexing it on the active strategy function.

Parameters​

• enabledElement: IEnabledElement

The element that is being operated on.

• operationData: unknown

The data that needs to be passed to the strategy.

• callbackType: string

the type of the callback

Returns​

any

The result of the strategy.

Defined in​

tools/src/tools/base/BaseTool.ts:86

getTargetId()​

protected getTargetId(viewport): string

Get the target Id for the viewport which will be used to store the cached statistics scoped to that target in the annotations. For StackViewport, targetId is the viewportId, but for the volume viewport, the targetId will be grabbed from the volumeId if particularly specified in the tool configuration, or if not, the first actorUID in the viewport.

Parameters​

• viewport: Viewport

viewport to get the targetId for

Returns​

string

targetId

Defined in​

tools/src/tools/base/BaseTool.ts:197

getTargetImageData()​

protected getTargetImageData(targetId): IImageData | CPUIImageData

Get the image that is displayed for the targetId in the cachedStats which can be

  • imageId:<imageId>
  • volumeId:<volumeId>
  • videoId:<basePathForVideo>/frames/<frameSpecifier>

Parameters​

• targetId: string

annotation targetId stored in the cached stats

Returns​

IImageData | CPUIImageData

The image data for the target.

Defined in​

tools/src/tools/base/BaseTool.ts:140

getToolName()​

getToolName(): string

Returns the name of the tool

Returns​

string

The name of the tool.

Defined in​

tools/src/tools/base/BaseTool.ts:50

setActiveStrategy()​

setActiveStrategy(strategyName): void

Sets the active strategy for a tool. Strategies are multiple implementations of tool behavior that can be switched by tool configuration.

Parameters​

• strategyName: string

name of the strategy to be set as active

Returns​

void

Defined in​

tools/src/tools/base/BaseTool.ts:126

setConfiguration()​

setConfiguration(newConfiguration): void

merges the new configuration with the tool configuration

Parameters​

• newConfiguration: Record<string, any>

Returns​

void

Defined in​

tools/src/tools/base/BaseTool.ts:112