PaintFillTool
Hierarchy
- BaseTool
- PaintFillTool
Index
Constructors
constructor
Parameters
toolProps: PublicToolProps = {}
defaultToolProps: SharedToolProp = ...
Returns PaintFillTool
Properties
publicconfiguration
publicmode
Tool Mode - Active/Passive/Enabled/Disabled/
publicsupportedInteractionTypes
Supported Interaction Types - currently only Mouse
publictoolGroupId
ToolGroup ID the tool instance belongs to
statictoolName
Methods
publicapplyActiveStrategy
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
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
Returns the name of the tool
Returns string
The name of the tool.
preMouseDownCallback
Based on the current position of the mouse and the enabledElement, it finds the active segmentation info and use it for the current tool.
Parameters
evt: InteractionEventType
EventTypes.NormalizedMouseEventType
Returns boolean
The annotation object.
publicsetActiveStrategy
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
merges the new configuration with the tool configuration
Parameters
newConfiguration: Record<string, any>
Returns void
Tool for manipulating segmentation data by filling in regions. It acts on the active Segmentation on the viewport (enabled element) and requires an active segmentation to be already present. By default it will fill a given labelled or empty region with the the activeSegmentIndex label. You can use the SegmentationModule to set the active segmentation and segmentIndex.