Skip to main content

BidirectionalTool

BidirectionalTool let you draw annotations that measures the length and width at the same time in mm unit. It is consisted of two perpendicular lines and a text box. You can use the BidirectionalTool in all planes even in oblique reconstructed planes. Note: annotation tools in cornerstone3DTools exists in the exact location in the physical 3d space, as a result, by default, all annotations that are drawing in the same frameOfReference will get shared between viewports that are in the same frameOfReference.

The resulting annotation’s data (statistics) and metadata (the state of the viewport while drawing was happening) will get added to the ToolState manager and can be accessed from the ToolState by calling getAnnotations or similar methods.

cornerstoneTools.addTool(BidirectionalTool)

const toolGroup = ToolGroupManager.createToolGroup('toolGroupId')

toolGroup.addTool(BidirectionalTool.toolName)

toolGroup.addViewport('viewportId', 'renderingEngineId')

toolGroup.setToolActive(BidirectionalTool.toolName, {
  bindings: [
   {
      mouseButton: MouseBindings.Primary, // Left Click
    },
  ],
})

Read more in the Docs section of the website.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_throttledCalculateCachedStats

_throttledCalculateCachedStats: any

publicconfiguration

configuration: Record<string, any>

editData

editData: { annotation: any; handleIndex?: number; hasMoved?: boolean; movingTextBox: boolean; newAnnotation?: boolean; viewportIdsToRender: string[] }

Type declaration

  • annotation: any
  • optionalhandleIndex?: number
  • optionalhasMoved?: boolean
  • movingTextBox: boolean
  • optionalnewAnnotation?: boolean
  • viewportIdsToRender: string[]

isDrawing

isDrawing: boolean

isHandleOutsideImage

isHandleOutsideImage: boolean

publicmode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

mouseDragCallback

mouseDragCallback: any

preventHandleOutsideImage

preventHandleOutsideImage: boolean

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

ToolGroup ID the tool instance belongs to

touchDragCallback

touchDragCallback: any

statictoolName

toolName: any

Methods

_activateDraw

  • _activateDraw(element: any): void

  • Parameters

    • element: any

    Returns void

_activateModify

  • _activateModify(element: any): void

  • Parameters

    • element: any

    Returns void

_calculateCachedStats

  • _calculateCachedStats(annotation: any, renderingEngine: any, enabledElement: any): any

  • Parameters

    • annotation: any
    • renderingEngine: any
    • enabledElement: any

    Returns any

_calculateLength

  • _calculateLength(pos1: any, pos2: any): number

  • Parameters

    • pos1: any
    • pos2: any

    Returns number

_deactivateDraw

  • _deactivateDraw(element: any): void

  • Parameters

    • element: any

    Returns void

_deactivateModify

  • _deactivateModify(element: any): void

  • Parameters

    • element: any

    Returns void

_dragDrawCallback

  • _dragDrawCallback(evt: InteractionEventType): void

  • Parameters

    • evt: InteractionEventType

      mouse move event type or mouse drag

    Returns void

_dragModifyCallback

  • _dragModifyCallback(evt: InteractionEventType): void

  • Mouse drag to edit annotation callback

    Parameters

    • evt: InteractionEventType

      mouse drag event

    Returns void

_dragModifyHandle

  • _dragModifyHandle(evt: InteractionEventType): void

  • Mouse dragging a handle callback

    Parameters

    • evt: InteractionEventType

      mouse drag event

    Returns void

_endCallback

  • _endCallback(evt: InteractionEventType): void

  • Handles the mouse up action for the bidirectional tool. It can be at the end of the annotation drawing (MouseUpEventType) or when the user clicks and release the mouse button instantly which let to the annotation to draw without holding the mouse button (MouseClickEventType).

    Parameters

    • evt: InteractionEventType

      mouse up or mouse click event types

    Returns void

_getSignedAngle

  • _getSignedAngle(vector1: any, vector2: any): number

  • Parameters

    • vector1: any
    • vector2: any

    Returns number

_isInsideVolume

  • _isInsideVolume(index1: any, index2: any, index3: any, index4: any, dimensions: any): boolean

  • Parameters

    • index1: any
    • index2: any
    • index3: any
    • index4: any
    • dimensions: any

    Returns boolean

_movingLongAxisWouldPutItThroughShortAxis

  • _movingLongAxisWouldPutItThroughShortAxis(firstLineSegment: any, secondLineSegment: any): boolean

  • Parameters

    • firstLineSegment: any
    • secondLineSegment: any

    Returns boolean

addNewAnnotation

  • addNewAnnotation(evt: InteractionEventType): BidirectionalAnnotation

  • Based on the current position of the mouse and the current imageId to create a Bidirectional Annotation and stores it in the annotationManager

    Parameters

    • evt: InteractionEventType

      EventTypes.NormalizedMouseEventType

    Returns BidirectionalAnnotation

    The annotation object.

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.

cancel

  • cancel(element: HTMLDivElement): any

  • Cancels an ongoing drawing of a bidirectional annotation

    Parameters

    • element: HTMLDivElement

      HTML Element

    Returns any

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

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

  • 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

  • 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

  • Returns the name of the tool

    Returns string

    The name of the tool.

handleSelectedCallback

  • handleSelectedCallback(evt: InteractionEventType, annotation: BidirectionalAnnotation, handle: ToolHandle): void

  • Executes the callback for when mouse has selected a handle (anchor point) of the bidirectional tool or when the text box has been selected.

    Parameters

    • evt: InteractionEventType

      EventTypes.MouseDownEventType

    • annotation: BidirectionalAnnotation

      Bidirectional annotation

    • handle: ToolHandle

      Handle index or selected textBox information

    Returns void

isPointNearTool

  • isPointNearTool(element: HTMLDivElement, annotation: BidirectionalAnnotation, canvasCoords: Point2, proximity: number): boolean

  • It returns if the canvas point is near the provided annotation in the provided element or not. A proximity is passed to the function to determine the proximity of the point to the annotation in number of pixels.

    Parameters

    • element: HTMLDivElement

      HTML Element

    • annotation: BidirectionalAnnotation

      Annotation

    • canvasCoords: Point2

      Canvas coordinates

    • proximity: number

      Proximity to tool to consider

    Returns boolean

    Boolean, whether the canvas point is near tool

isSuvScaled

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

  • 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

publicmouseMoveCallback

  • mouseMoveCallback(evt: MouseMoveEventType, filteredAnnotations?: Annotations): boolean

  • Event handler for Cornerstone MOUSE_MOVE event.

    Parameters

    • evt: MouseMoveEventType

      The normalized mouse event

    • optionalfilteredAnnotations: Annotations

      The annotations to check for hover interactions

    Returns boolean

    True if the annotation needs to be re-drawn by the annotationRenderingEngine.

publiconImageSpacingCalibrated

  • onImageSpacingCalibrated(evt: ImageSpacingCalibratedEvent): void

  • 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

renderAnnotation

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

  • it is used to draw the bidirectional annotation in each request animation frame. It calculates the updated cached statistics if data is invalidated and cache it.

    Parameters

    • enabledElement: IEnabledElement

      The Cornerstone’s enabledElement.

    • svgDrawingHelper: SVGDrawingHelper

      The svgDrawingHelper providing the context for drawing.

    Returns boolean

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

toolSelectedCallback

  • toolSelectedCallback(evt: InteractionEventType, annotation: BidirectionalAnnotation): void

  • Handles the toolSelected callback for bidirectional tool

    Parameters

    • evt: InteractionEventType

      EventTypes.MouseDownEventType

    • annotation: BidirectionalAnnotation

      Bidirectional annotation

    Returns void

publicstaticcreateAndAddAnnotation

  • createAndAddAnnotation(viewport: any, ...annotationBaseData: any[]): void

  • Creates and adds an annotation of the given type, firing the annotation modified event on the new annotation. This implicitly uses the static class when you call it on the correct base class. For example, you can call the KeyImageTool.createAnnotation method on KeyImageTool.toolName by calling KeyImageTool.createAndAddAnnotation

    Parameters

    • viewport: any
    • rest...annotationBaseData: any[]

    Returns void

publicstaticcreateAnnotation

  • createAnnotation(...annotationBaseData: any[]): Annotation

  • Creates a base annotation object, adding in any annotation base data provided

    Parameters

    • rest...annotationBaseData: any[]

    Returns Annotation

publicstaticcreateAnnotationForViewport

  • createAnnotationForViewport(viewport: any, ...annotationBaseData: any[]): Annotation

  • Creates a new annotation for the given viewport. This just adds the viewport reference data to the metadata, and otherwise returns the static class createAnnotation data.

    Parameters

    • viewport: any
    • rest...annotationBaseData: any[]

    Returns Annotation