abstractBaseTool

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

Hierarchy

• BaseTool
  • AnnotationDisplayTool
  • PanTool
  • TrackballRotateTool
  • WindowLevelTool
  • ZoomTool
  • StackScrollTool
  • PlanarRotateTool
  • StackScrollMouseWheelTool
  • VolumeRotateMouseWheelTool
  • MIPJumpToClickTool
  • MagnifyTool
  • SculptorTool
  • EraserTool
  • SegmentationDisplayTool
  • RectangleScissorsTool
  • CircleScissorsTool
  • SphereScissorsTool
  • BrushTool
  • OrientationMarkerTool
  • SegmentSelectTool
  • PaintFillTool

Implements

• IBaseTool

Index

Constructors

• constructor

Properties

• configuration
• mode
• supportedInteractionTypes
• toolGroupId
• toolName

Methods

• applyActiveStrategy
• applyActiveStrategyCallback
• getToolName
• setActiveStrategy
• setConfiguration

Constructors

constructor

• new BaseTool(toolProps: PublicToolProps, defaultToolProps: SharedToolProp): BaseTool

• Parameters

  • toolProps: PublicToolProps

  • defaultToolProps: SharedToolProp

  Returns BaseTool

Properties

publicconfiguration

configuration: Record<string, any>

Implementation of IBaseTool.configuration

publicmode

mode: ToolModes

Implementation of IBaseTool.mode

Tool Mode - Active/Passive/Enabled/Disabled/

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Implementation of IBaseTool.supportedInteractionTypes

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

Implementation of IBaseTool.toolGroupId

ToolGroup ID the tool instance belongs to

statictoolName

toolName: any

Methods

publicapplyActiveStrategy

• applyActiveStrategy(enabledElement: IEnabledElement, operationData: unknown): 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.

publicapplyActiveStrategyCallback

• applyActiveStrategyCallback(enabledElement: IEnabledElement, operationData: unknown, callbackType: string): 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.

publicgetToolName

• getToolName(): string

• Returns the name of the tool

  ---

  Returns string

  The name of the tool.

publicsetActiveStrategy

• setActiveStrategy(strategyName: string): 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

publicsetConfiguration

• setConfiguration(newConfiguration: Record<string, any>): void

• merges the new configuration with the tool configuration

  ---

  Parameters

  • newConfiguration: Record<string, any>

  Returns void