Skip to main content

ReferenceCursors

ReferenceCursors is a tool that will show your cursors position in all other elements in the toolGroup if they have a matching FrameOfReference relative to its position in world space. Also when positionSync is enabled, it will try to sync viewports so that the cursor can be displayed in the correct position in all viewports.

Configuration:

  • positionSync: boolean, if true, it will try to sync viewports so that the cursor can be displayed in the correct position in all viewports.
  • disableCursor: boolean, if true, it will hide the cursor in all viewports. You need to disable and reactivate the tool for this to apply.
  • displayThreshold: number, if the distance of the cursor in a viewport is bigger than this threshold the cursor will not be displayed.

Only uses Active and Disabled state

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_currentCanvasPosition

_currentCanvasPosition: Point2 = null

_currentCursorWorldPosition

_currentCursorWorldPosition: Point3 = null

_disableCursorEnabled

_disableCursorEnabled: boolean = false

_elementWithCursor

_elementWithCursor: HTMLDivElement = null

_throttledCalculateCachedStats

_throttledCalculateCachedStats: any

publicconfiguration

configuration: Record<string, any>

isDrawing

isDrawing: boolean = false

isHandleOutsideImage

isHandleOutsideImage: boolean = false

publicmode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

mouseDragCallback

mouseDragCallback: any

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

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.

createInitialAnnotation

  • createInitialAnnotation(worldPos: Point3, element: HTMLDivElement): void

  • Parameters

    • worldPos: Point3
    • element: HTMLDivElement

    Returns void

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

getActiveAnnotation

  • getActiveAnnotation(element: HTMLDivElement): Annotation

  • Parameters

    • element: HTMLDivElement

    Returns Annotation

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.

mouseMoveCallback

  • mouseMoveCallback(evt: InteractionEventType): boolean

  • Overwritten mouseMoveCallback since we want to keep track of the current mouse position and redraw on mouseMove Event handler for Cornerstone MOUSE_MOVE event.

    Parameters

    • evt: InteractionEventType

      The normalized mouse event

    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

  • 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

renderAnnotation

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

  • Draws the cursor representation on the enabledElement Checks if a stack change has happened and updates annotation in that case

    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

updateAnnotationPosition

  • updateAnnotationPosition(element: HTMLDivElement, annotation: Annotation): void

  • updates the position of the annotation to match the currently set world position

    Parameters

    Returns void

updateViewportImage

  • updateViewportImage(viewport: default | default): void

  • Parameters

    • viewport: default | default

    Returns void