Skip to main content

publicBrushTool

Hierarchy

AnnotationTool
- BrushTool

Constructors

constructor

new BrushTool(toolProps?: PublicToolProps, defaultToolProps?: SharedToolProp): BrushTool

Overrides AnnotationTool.constructor
Parameters
- toolProps: PublicToolProps = {}
- defaultToolProps: SharedToolProp = ...
Returns BrushTool

Properties

publicconfiguration

configuration: Record<string, any>

publicmode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

ToolGroup ID the tool instance belongs to

statictoolName

toolName: any

Methods

addNewAnnotation

addNewAnnotation(evt: MouseDownActivateEventType): BrushCursor

Overrides AnnotationTool.addNewAnnotation
@abstract
addNewAnnotation Creates a new annotation based on the clicked mouse position
Parameters
- evt: MouseDownActivateEventType
  The normalized mouse event
Returns BrushCursor

publicapplyActiveStrategy

applyActiveStrategy(enabledElement: IEnabledElement, operationData: unknown): any

Inherited from AnnotationTool.applyActiveStrategy
It applies the active strategy to the enabled element.
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.

cancel

cancel(): void

Overrides AnnotationTool.cancel
@abstract
cancel Used to cancel the ongoing tool drawing and manipulation
Returns void

filterInteractableAnnotationsForElement

filterInteractableAnnotationsForElement(element: HTMLDivElement, annotations: Annotations): Annotations

Inherited from AnnotationTool.filterInteractableAnnotationsForElement
Given the element and annotations which is an array of annotation, it filters the annotations array to only include the annotation based on the viewportType. If the viewport is StackViewport, it filters based on the current imageId of the viewport, if the viewport is volumeViewport, it only returns those that are within the same slice as the current rendered slice in the volume viewport. imageId as the enabledElement.
Parameters
- element: HTMLDivElement
  The HTML element
- annotations: Annotations
  The annotations to filter (array of annotation)
Returns Annotations
The filtered annotations

getHandleNearImagePoint

getHandleNearImagePoint(element: HTMLDivElement, annotation: Annotation, canvasCoords: Point2, proximity: number): ToolHandle

Inherited from AnnotationTool.getHandleNearImagePoint
It checks if the mouse click is near TextBoxHandle or AnnotationHandle itself, and return either it. It prioritize TextBoxHandle over AnnotationHandle. If the mouse click is not near any of the handles, it does not return anything.
Parameters
- element: HTMLDivElement
  The element that the tool is attached to.
- annotation: Annotation
  The annotation object associated with the annotation
- canvasCoords: Point2
  The coordinates of the mouse click on canvas
- proximity: number
  The distance from the mouse cursor to the point that is considered “near”.
Returns ToolHandle
The handle that is closest to the cursor, or null if the cursor is not near any of the handles.

publicgetLinkedTextBoxStyle

getLinkedTextBoxStyle(specifications: StyleSpecifier, annotation?: Annotation): Record<string, unknown>

Inherited from AnnotationTool.getLinkedTextBoxStyle
It returns the style for the text box
Parameters
- specifications: StyleSpecifier
- optionalannotation: Annotation
  The annotation for the tool that is currently active.
Returns Record<string, unknown>
An object of the style settings for the text box.

publicgetStyle

getStyle(property: string, specifications: StyleSpecifier, annotation?: Annotation): unknown

Inherited from AnnotationTool.getStyle
It takes the property (color, lineDash, etc.) and based on the state of the annotation (selected, highlighted etc.) it returns the appropriate value based on the central toolStyle settings for each level of specification.
Parameters
- property: string
  The name of the style property to get.
- specifications: StyleSpecifier
- optionalannotation: Annotation
  The annotation for the tool that is currently active.
Returns unknown
The value of the property.

publicgetToolName

getToolName(): string

Inherited from AnnotationTool.getToolName
Returns the name of the tool
Returns string
The name of the tool.

handleSelectedCallback

handleSelectedCallback(): void

Overrides AnnotationTool.handleSelectedCallback
handleSelectedCallback Custom callback for when a handle is selected.
Returns void

publicinvalidateBrushCursor

invalidateBrushCursor(): void

Returns void

publicisPointNearTool

isPointNearTool(): boolean

Overrides AnnotationTool.isPointNearTool
Returns true if the provided canvas coordinate tool is near the annotation
Returns boolean
boolean if the point is near.

isSuvScaled

isSuvScaled(viewport: default | default, targetId: string, imageId?: string): boolean

Inherited from AnnotationTool.isSuvScaled
Returns true if the viewport is scaled to SUV units
Parameters
- viewport: default | default
  The viewport
- targetId: string
  The annotation targetId
- optionalimageId: string
  The annotation imageId
Returns boolean

mouseMoveCallback

mouseMoveCallback(evt: MouseMoveEventType): boolean

Overrides AnnotationTool.mouseMoveCallback
Event handler for Cornerstone MOUSE_MOVE event.
Parameters
- evt: MouseMoveEventType
  The normalized mouse event
Returns boolean
True if the annotation needs to be re-drawn by the annotationRenderingEngine.

publiconImageSpacingCalibrated

onImageSpacingCalibrated(evt: ImageSpacingCalibratedEvent): void

Inherited from AnnotationTool.onImageSpacingCalibrated
On Image Calibration, take all the annotation from the AnnotationState manager, and invalidate them to force them to be re-rendered and their stats to be recalculated. Then use the old and new imageData (non-calibrated and calibrated) to calculate the new position for the annotations in the space of the new imageData.
Parameters
- evt: ImageSpacingCalibratedEvent
  The calibration event
Returns void

onSetConfiguration

onSetConfiguration(): void

Returns void

onSetToolActive

onSetToolActive(): void

Returns void

onSetToolDisabled

onSetToolDisabled(): void

Returns void

onSetToolEnabled

onSetToolEnabled(): void

Returns void

onSetToolPassive

onSetToolPassive(): void

Returns void

renderAnnotation

renderAnnotation(enabledElement: IEnabledElement, svgDrawingHelper: SVGDrawingHelper): boolean

Overrides AnnotationTool.renderAnnotation
@abstract
renderAnnotation it used to draw the tool’s annotation in each request animation frame
Parameters
- enabledElement: IEnabledElement
  The Cornerstone’s enabledElement.
- svgDrawingHelper: SVGDrawingHelper
  The svgDrawingHelper providing the context for drawing.
Returns boolean

publicsetActiveStrategy

setActiveStrategy(strategyName: string): void

Inherited from AnnotationTool.setActiveStrategy
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

Inherited from AnnotationTool.setConfiguration
merges the new configuration with the tool configuration
Parameters
- newConfiguration: Record<string, any>
Returns void

toolSelectedCallback

toolSelectedCallback(): void

Overrides AnnotationTool.toolSelectedCallback
Custom callback for when an annotation is selected
Returns void