CircleScissorsTool

Tool for manipulating segmentation data by drawing a circle. It acts on the active Segmentation on the viewport (enabled element) and requires an active segmentation to be already present. By default it will use the activeSegmentIndex for the segmentation to modify. You can use SegmentationModule to set the active segmentation and segmentIndex.

Hierarchy

• BaseTool
  • CircleScissorsTool

Index

Constructors

• constructor

Properties

• configuration
• editData
• isDrawing
• isHandleOutsideImage
• mode
• supportedInteractionTypes
• toolGroupId
• toolName

Methods

• _activateDraw
• _deactivateDraw
• _dragCallback
• _endCallback
• applyActiveStrategy
• applyActiveStrategyCallback
• getToolName
• preMouseDownCallback
• renderAnnotation
• setActiveStrategy
• setConfiguration

Constructors

constructor

• new CircleScissorsTool(toolProps?: PublicToolProps, defaultToolProps?: SharedToolProp): CircleScissorsTool

• Overrides BaseTool.constructor

  Parameters

  • toolProps: PublicToolProps = {}

  • defaultToolProps: SharedToolProp = ...

  Returns CircleScissorsTool

Properties

publicconfiguration

configuration: Record<string, any>

Inherited from BaseTool.configuration

editData

editData: { annotation: any; centerCanvas?: number[]; handleIndex?: number; hasMoved?: boolean; imageIdReferenceMap: Map<string, string>; movingTextBox: boolean; newAnnotation?: boolean; referencedVolumeId: string; segmentColor: [number, number, number, number]; segmentIndex: number; segmentationRepresentationUID?: string; segmentsLocked: number[]; viewportIdsToRender: string[]; volumeId: string }

Type declaration

• annotation: any

• optionalcenterCanvas?: number[]

• optionalhandleIndex?: number

• optionalhasMoved?: boolean

• imageIdReferenceMap: Map<string, string>

• movingTextBox: boolean

• optionalnewAnnotation?: boolean

• referencedVolumeId: string

• segmentColor: [number, number, number, number]

• segmentIndex: number

• optionalsegmentationRepresentationUID?: string

• segmentsLocked: number[]

• viewportIdsToRender: string[]

• volumeId: string

isDrawing

isDrawing: boolean

isHandleOutsideImage

isHandleOutsideImage: boolean

publicmode

mode: ToolModes

Inherited from BaseTool.mode

Tool Mode - Active/Passive/Enabled/Disabled/

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Inherited from BaseTool.supportedInteractionTypes

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

Inherited from BaseTool.toolGroupId

ToolGroup ID the tool instance belongs to

statictoolName

toolName: any

Overrides BaseTool.toolName

Methods

_activateDraw

• _activateDraw(element: any): void

• Add event handlers for the modify event loop, and prevent default event propagation.

  ---

  Parameters

  • element: any

  Returns void

_deactivateDraw

• _deactivateDraw(element: any): void

• Add event handlers for the modify event loop, and prevent default event prapogation.

  ---

  Parameters

  • element: any

  Returns void

_dragCallback

• _dragCallback(evt: InteractionEventType): void

• Parameters

  • evt: InteractionEventType

  Returns void

_endCallback

• _endCallback(evt: InteractionEventType): void

• Parameters

  • evt: InteractionEventType

  Returns void

publicapplyActiveStrategy

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

• Inherited from BaseTool.applyActiveStrategy

  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

• Inherited from BaseTool.applyActiveStrategyCallback

  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

• Inherited from BaseTool.getToolName

  Returns the name of the tool

  ---

  Returns string

  The name of the tool.

preMouseDownCallback

• preMouseDownCallback(evt: InteractionEventType): boolean

• 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.

renderAnnotation

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

• it is used to draw the circleScissor annotation in each request animation frame. Note that the annotation are disappeared after the segmentation modification.

  ---

  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 BaseTool.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 BaseTool.setConfiguration

  merges the new configuration with the tool configuration

  ---

  Parameters

  • newConfiguration: Record<string, any>

  Returns void