feat: Add labels to the toolData for annotation tools

cornerstonejs · Mar 22, 2022 · fe7570d · fe7570d
1 parent 4b670cd
commit fe7570d
Show file tree

Hide file tree

Showing 10 changed files with 31 additions and 2 deletions.
diff --git a/packages/cornerstone-tools/src/index.ts b/packages/cornerstone-tools/src/index.ts
@@ -14,6 +14,7 @@ import {
   removeToolStateByToolDataUID,
   getDefaultToolStateManager,
   getViewportSpecificStateManager,
+  getToolDataByToolDataUID,
 } from './stateManagement'
 
 import { init, destroy } from './init'
@@ -139,4 +140,5 @@ export {
   Cursors,
   getDefaultToolStateManager,
   getViewportSpecificStateManager,
+  getToolDataByToolDataUID,
 }
diff --git a/packages/cornerstone-tools/src/stateManagement/index.js b/packages/cornerstone-tools/src/stateManagement/index.js
@@ -15,6 +15,7 @@ import {
   removeToolStateByToolDataUID,
   getDefaultToolStateManager,
   getViewportSpecificStateManager,
+  getToolDataByToolDataUID,
 } from './toolState'
 
 export {
@@ -33,4 +34,5 @@ export {
   removeToolStateByToolDataUID,
   getDefaultToolStateManager,
   getViewportSpecificStateManager,
+  getToolDataByToolDataUID,
 }
diff --git a/packages/cornerstone-tools/src/stateManagement/toolState.ts b/packages/cornerstone-tools/src/stateManagement/toolState.ts
@@ -17,7 +17,7 @@ function getDefaultToolStateManager() {
 }
 
 function getViewportSpecificStateManager(
-  element: Types.IEnabledElement | HTMLElement
+  element?: Types.IEnabledElement | HTMLElement
 ) {
   // TODO:
   // We may want multiple FrameOfReferenceSpecificStateManagers.
@@ -145,9 +145,20 @@ function removeToolStateByToolDataUID(
   triggerEvent(eventTarget, eventType, eventDetail)
 }
 
+function getToolDataByToolDataUID(
+  toolDataUID: string,
+  element?: HTMLElement
+): ToolSpecificToolData {
+  const toolStateManager = getViewportSpecificStateManager(element)
+  const toolData = toolStateManager.getToolStateByToolDataUID(toolDataUID)
+
+  return toolData
+}
+
 export {
   getToolState,
   addToolState,
+  getToolDataByToolDataUID,
   removeToolState,
   removeToolStateByToolDataUID,
   getViewportSpecificStateManager,

diff --git a/packages/cornerstone-tools/src/tools/annotation/BidirectionalTool.ts b/packages/cornerstone-tools/src/tools/annotation/BidirectionalTool.ts
@@ -132,6 +132,7 @@ export default class BidirectionalTool extends BaseAnnotationTool {
         viewUp: <Point3>[...viewUp],
         FrameOfReferenceUID: viewport.getFrameOfReferenceUID(),
         toolName: this.name,
+        label: '',
         referencedImageId,
       },
       data: {

diff --git a/packages/cornerstone-tools/src/tools/annotation/EllipticalRoiTool.ts b/packages/cornerstone-tools/src/tools/annotation/EllipticalRoiTool.ts
@@ -149,6 +149,7 @@ export default class EllipticalRoiTool extends BaseAnnotationTool {
         viewUp: <Point3>[...viewUp],
         FrameOfReferenceUID: viewport.getFrameOfReferenceUID(),
         referencedImageId,
+        label: '',
         toolName: this.name,
       },
       data: {

diff --git a/packages/cornerstone-tools/src/tools/annotation/LengthTool.ts b/packages/cornerstone-tools/src/tools/annotation/LengthTool.ts
@@ -148,6 +148,7 @@ class LengthTool extends BaseAnnotationTool {
         viewUp: <Point3>[...viewUp],
         FrameOfReferenceUID: viewport.getFrameOfReferenceUID(),
         referencedImageId,
+        label: '',
         toolName: this.name,
       },
       data: {

diff --git a/packages/cornerstone-tools/src/tools/annotation/PET/SUVPeakTool.ts b/packages/cornerstone-tools/src/tools/annotation/PET/SUVPeakTool.ts
@@ -163,6 +163,7 @@ export default class SUVPeakTool extends EllipticalRoiTool {
         viewUp: <Point3>[...viewUp],
         FrameOfReferenceUID: viewport.getFrameOfReferenceUID(),
         referencedImageId,
+        label: '',
         toolName: this.name,
       },
       data: {

diff --git a/packages/cornerstone-tools/src/tools/annotation/ProbeTool.ts b/packages/cornerstone-tools/src/tools/annotation/ProbeTool.ts
@@ -122,6 +122,7 @@ export default class ProbeTool extends BaseAnnotationTool {
         viewUp: <Point3>[...viewUp],
         FrameOfReferenceUID: viewport.getFrameOfReferenceUID(),
         referencedImageId,
+        label: '',
         toolName: this.name,
       },
       data: {

diff --git a/packages/cornerstone-tools/src/tools/annotation/RectangleRoiTool.ts b/packages/cornerstone-tools/src/tools/annotation/RectangleRoiTool.ts
@@ -136,6 +136,7 @@ export default class RectangleRoiTool extends BaseAnnotationTool {
         viewUp: <Point3>[...viewUp],
         FrameOfReferenceUID: viewport.getFrameOfReferenceUID(),
         referencedImageId,
+        label: '',
         toolName: this.name,
       },
       data: {

diff --git a/packages/cornerstone-tools/src/types/toolStateTypes.ts b/packages/cornerstone-tools/src/types/toolStateTypes.ts
@@ -31,6 +31,10 @@ type ToolSpecificToolData = {
      * The FrameOfReferenceUID
      */
     FrameOfReferenceUID: string
+    /**
+     * The registered name of the tool
+     */
+    toolName: string
     /**
      * An optional property used when annotating on a slice in a StackViewport,
      * or when annotating in a VolumeViewport on a viewPlane that corresponds to
@@ -40,7 +44,11 @@ type ToolSpecificToolData = {
     /**
      * The registered name of the tool
      */
-    toolName: string
+    label?: string
+    /**
+     * The registered name of the tool
+     */
+    text?: string
     /**
      * VolumeUID of the volume that the tool was configured to work on.
      */