CrosshairsTool

CrosshairsTool is a tool that provides reference lines between different viewports of a toolGroup. Using crosshairs, you can jump to a specific location in one viewport and the rest of the viewports in the toolGroup will be aligned to that location. Crosshairs have grababble handles that can be used to rotate and translate the reference lines. They can also be used to set the slab thickness of the viewports by modifying the slab thickness handles.

Hierarchy

AnnotationTool
- CrosshairsTool

Index

Constructors

constructor

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

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

Properties

optional_getReferenceLineColor

_getReferenceLineColor?: (viewportId: string) => string

Type declaration

- (viewportId: string): string
- Parameters
  - viewportId: string
  Returns string

optional_getReferenceLineControllable

_getReferenceLineControllable?: (viewportId: string) => boolean

Type declaration

- (viewportId: string): boolean
- Parameters
  - viewportId: string
  Returns boolean

optional_getReferenceLineDraggableRotatable

_getReferenceLineDraggableRotatable?: (viewportId: string) => boolean

Type declaration

- (viewportId: string): boolean
- Parameters
  - viewportId: string
  Returns boolean

optional_getReferenceLineSlabThicknessControlsOn

_getReferenceLineSlabThicknessControlsOn?: (viewportId: string) => boolean

Type declaration

- (viewportId: string): boolean
- Parameters
  - viewportId: string
  Returns boolean

publicconfiguration

configuration: Record<string, any>

editData

editData: { annotation: any }

Type declaration

annotation: any

publicmode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

toolCenter

toolCenter: Point3 = ...

publictoolGroupId

toolGroupId: string

ToolGroup ID the tool instance belongs to

statictoolName

toolName: any

Methods

_activateModify

_activateModify(element: any): void

Parameters
- element: any
Returns void

_applyDeltaShiftToSelectedViewportCameras

_applyDeltaShiftToSelectedViewportCameras(renderingEngine: any, viewportsAnnotationsToUpdate: any, delta: any): void

Parameters
- renderingEngine: any
- viewportsAnnotationsToUpdate: any
- delta: any
Returns void

_applyDeltaShiftToViewportCamera

_applyDeltaShiftToViewportCamera(renderingEngine: default, annotation: any, delta: any): void

Parameters
- renderingEngine: default
- annotation: any
- delta: any
Returns void

_areViewportIdArraysEqual

_areViewportIdArraysEqual(viewportIdArrayOne: any, viewportIdArrayTwo: any): boolean

Parameters
- viewportIdArrayOne: any
- viewportIdArrayTwo: any
Returns boolean

_autoPanViewportIfNecessary

_autoPanViewportIfNecessary(viewportId: string, renderingEngine: default): void

Parameters
- viewportId: string
- renderingEngine: default
Returns void

_checkIfViewportsRenderingSameScene

_checkIfViewportsRenderingSameScene(viewport: any, otherViewport: any): boolean

Parameters
- viewport: any
- otherViewport: any
Returns boolean

_deactivateModify

_deactivateModify(element: any): void

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

_filterAnnotationsByUniqueViewportOrientations

_filterAnnotationsByUniqueViewportOrientations(enabledElement: any, annotations: any): any[]

Parameters
- enabledElement: any
- annotations: any
Returns any[]

_filterViewportWithSameOrientation

_filterViewportWithSameOrientation(enabledElement: any, referenceAnnotation: any, annotations: any): any

Parameters
- enabledElement: any
- referenceAnnotation: any
- annotations: any
Returns any

_getAnnotationsForViewportsWithDifferentCameras

_getAnnotationsForViewportsWithDifferentCameras(enabledElement: any, annotations: any): any

Parameters
- enabledElement: any
- annotations: any
Returns any

_getRotationHandleNearImagePoint

_getRotationHandleNearImagePoint(viewport: any, annotation: any, canvasCoords: any, proximity: any): any

Parameters
- viewport: any
- annotation: any
- canvasCoords: any
- proximity: any
Returns any

_getSlabThicknessHandleNearImagePoint

_getSlabThicknessHandleNearImagePoint(viewport: any, annotation: any, canvasCoords: any, proximity: any): any

Parameters
- viewport: any
- annotation: any
- canvasCoords: any
- proximity: any
Returns any

_getViewportsInfo

_getViewportsInfo(): default[]

Returns default[]

_isClockWise

_isClockWise(a: any, b: any, c: any): boolean

Parameters
- a: any
- b: any
- c: any
Returns boolean

_jump

_jump(enabledElement: any, jumpWorld: any): boolean

Parameters
- enabledElement: any
- jumpWorld: any
Returns boolean

_onNewVolume

_onNewVolume(e: any): void

Parameters
- e: any
Returns void

_pointNearReferenceLine

_pointNearReferenceLine(annotation: any, canvasCoords: any, proximity: any, lineViewport: any): boolean

Parameters
- annotation: any
- canvasCoords: any
- proximity: any
- lineViewport: any
Returns boolean

_pointNearTool

_pointNearTool(element: any, annotation: any, canvasCoords: any, proximity: any): boolean

Parameters
- element: any
- annotation: any
- canvasCoords: any
- proximity: any
Returns boolean

_subscribeToViewportNewVolumeSet

_subscribeToViewportNewVolumeSet(viewports: any): void

Parameters
- viewports: any
Returns void

_unsubscribeToViewportNewVolumeSet

_unsubscribeToViewportNewVolumeSet(viewportsInfo: any): void

Parameters
- viewportsInfo: any
Returns void

addNewAnnotation

addNewAnnotation(evt: InteractionEventType): CrosshairsAnnotation

Overrides AnnotationTool.addNewAnnotation
addNewAnnotation acts as jump for the crosshairs tool. It is called when the user clicks on the image. It does not store the annotation in the stateManager though.
Parameters
- evt: InteractionEventType
  The mouse event
Returns CrosshairsAnnotation
Crosshairs annotation

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
Returns void

computeToolCenter

computeToolCenter(viewportsInfo: any): void

When activated, it initializes the crosshairs. It begins by computing the intersection of viewports associated with the crosshairs instance. When all three views are accessible, the intersection (e.g., crosshairs tool centre) will be an exact point in space; however, with two viewports, because the intersection of two planes is a line, it assumes the last view is between the centre of the two rendering viewports.
Parameters
- viewportsInfo: any
  Array of viewportInputs which each item containing {viewportId, renderingEngineId}
Returns void

filterInteractableAnnotationsForElement

filterInteractableAnnotationsForElement(element: any, annotations: any): any

Overrides 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: any
  The HTML element
- annotations: any
  The annotations to filter (array of annotation)
Returns any
The filtered annotations

getHandleNearImagePoint

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

Overrides AnnotationTool.getHandleNearImagePoint
It checks if the mouse click is near crosshairs handles, if yes it returns the handle location. 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(evt: InteractionEventType, annotation: Annotation): void

Overrides AnnotationTool.handleSelectedCallback
handleSelectedCallback Custom callback for when a handle is selected.
Parameters
- evt: InteractionEventType
  The normalized mouse event
- annotation: Annotation
  The annotation selected.
Returns void

initializeViewport

initializeViewport(viewportInfo: default): { normal: Point3; point: Point3 }

Gets the camera from the viewport, and adds crosshairs annotation for the viewport to the annotationManager. If any annotation is found in the annotationManager, it overwrites it.
Parameters
- viewportInfo: default
  The viewportInfo for the viewport to add the crosshairs
Returns { normal: Point3; point: Point3 }
viewPlaneNormal and center of viewport canvas in world space
- normal: Point3
- point: Point3

isPointNearTool

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

Overrides AnnotationTool.isPointNearTool
It returns if the canvas point is near the provided crosshairs 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: CrosshairsAnnotation
  Annotation
- canvasCoords: Point2
  Canvas coordinates
- proximity: number
  Proximity to tool to consider
Returns boolean
Boolean, whether the canvas point is near tool

mouseMoveCallback

mouseMoveCallback(evt: MouseMoveEventType, filteredToolAnnotations: Annotations): boolean

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

onCameraModified

onCameraModified(evt: any): void

Parameters
- evt: any
Returns void

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

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
renders the crosshairs lines and handles in the requestAnimationFrame callback
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

setSlabThickness

setSlabThickness(viewport: any, slabThickness: any): void

Parameters
- viewport: any
- slabThickness: any
Returns void

toolSelectedCallback

toolSelectedCallback(evt: InteractionEventType, annotation: Annotation, interactionType: InteractionTypes): void

Overrides AnnotationTool.toolSelectedCallback
Custom callback for when an annotation is selected
Parameters
- evt: InteractionEventType
  The normalized mouse event
- annotation: Annotation
  The Annotation to check.
- interactionType: InteractionTypes
  The interaction type used to select the tool.
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

toolProps: PublicToolProps = {}

defaultToolProps: SharedToolProp = ...

Returns CrosshairsTool

Properties

optional_getReferenceLineColor

Type declaration

Parameters

viewportId: string

Returns string

optional_getReferenceLineControllable

Type declaration

Parameters

viewportId: string

Returns boolean

optional_getReferenceLineDraggableRotatable

Type declaration

Parameters

viewportId: string

Returns boolean

optional_getReferenceLineSlabThicknessControlsOn

Type declaration

Parameters

viewportId: string

Returns boolean

publicconfiguration

editData

Type declaration

annotation: any

publicmode

publicsupportedInteractionTypes

toolCenter

publictoolGroupId

statictoolName

Methods

_activateModify

Parameters

element: any

Returns void

_applyDeltaShiftToSelectedViewportCameras

Parameters

renderingEngine: any

viewportsAnnotationsToUpdate: any

delta: any

Returns void

_applyDeltaShiftToViewportCamera

Parameters

renderingEngine: default

annotation: any

delta: any

Returns void

_areViewportIdArraysEqual

Parameters

viewportIdArrayOne: any

viewportIdArrayTwo: any

Returns boolean

_autoPanViewportIfNecessary

Parameters

viewportId: string

renderingEngine: default

Returns void

_checkIfViewportsRenderingSameScene

Parameters

viewport: any

otherViewport: any

Returns boolean

_deactivateModify

Parameters

element: any

Returns void

_dragCallback

Parameters

evt: InteractionEventType