rename: toolGroup tools property to toolOptions

cornerstonejs · Mar 22, 2022 · c59bd03 · c59bd03
1 parent cc0cc79
commit c59bd03
Show file tree

Hide file tree

Showing 13 changed files with 39 additions and 37 deletions.
diff --git a/packages/cornerstone-tools/src/eventDispatchers/keyboardEventHandlers/keyDown.ts b/packages/cornerstone-tools/src/eventDispatchers/keyboardEventHandlers/keyDown.ts
@@ -18,7 +18,7 @@ export default function keyDown(evt) {
   )
 
   toolGroups.forEach((toolGroup) => {
-    if (Object.keys(toolGroup.tools).includes(activeTool.name)) {
+    if (Object.keys(toolGroup.toolOptions).includes(activeTool.name)) {
       toolGroup.resetViewportsCursor({ name: activeTool.name })
     }
   })

diff --git a/packages/cornerstone-tools/src/eventDispatchers/keyboardEventHandlers/keyUp.ts b/packages/cornerstone-tools/src/eventDispatchers/keyboardEventHandlers/keyUp.ts
@@ -18,7 +18,7 @@ export default function keyUp(evt) {
   resetModifierKey()
 
   toolGroups.forEach((toolGroup) => {
-    if (Object.keys(toolGroup.tools).includes(activeTool.name)) {
+    if (Object.keys(toolGroup.toolOptions).includes(activeTool.name)) {
       toolGroup.resetViewportsCursor({ name: activeTool.name })
     }
   })

diff --git a/packages/cornerstone-tools/src/eventDispatchers/shared/customCallbackHandler.ts b/packages/cornerstone-tools/src/eventDispatchers/shared/customCallbackHandler.ts
@@ -44,11 +44,11 @@ export default function customCallbackHandler(
   let activeTool
   for (let i = 0; i < toolGroups.length; i++) {
     const toolGroup = toolGroups[i]
-    const toolGroupToolNames = Object.keys(toolGroup.tools)
+    const toolGroupToolNames = Object.keys(toolGroup.toolOptions)
 
     for (let j = 0; j < toolGroupToolNames.length; j++) {
       const toolName = toolGroupToolNames[j]
-      const tool = toolGroup.tools[toolName]
+      const tool = toolGroup.toolOptions[toolName]
       // TODO: Should be getter
       const toolInstance = toolGroup._toolInstances[toolName]
 

diff --git a/packages/cornerstone-tools/src/eventDispatchers/shared/getActiveToolForMouseEvent.ts b/packages/cornerstone-tools/src/eventDispatchers/shared/getActiveToolForMouseEvent.ts
@@ -25,11 +25,11 @@ export default function getActiveToolForMouseEvent(evt) {
 
   for (let i = 0; i < toolGroups.length; i++) {
     const toolGroup = toolGroups[i]
-    const toolGroupToolNames = Object.keys(toolGroup.tools)
+    const toolGroupToolNames = Object.keys(toolGroup.toolOptions)
 
     for (let j = 0; j < toolGroupToolNames.length; j++) {
       const toolName = toolGroupToolNames[j]
-      const tool = toolGroup.tools[toolName]
+      const tool = toolGroup.toolOptions[toolName]
 
       // tool has binding that matches the mouse button, if mouseEvent is undefined
       // it uses the primary button

diff --git a/packages/cornerstone-tools/src/eventDispatchers/shared/getToolsWithModesForMouseEvent.ts b/packages/cornerstone-tools/src/eventDispatchers/shared/getToolsWithModesForMouseEvent.ts
@@ -28,11 +28,11 @@ export default function getToolsWithModesForMouseEvent(
 
   for (let i = 0; i < toolGroups.length; i++) {
     const toolGroup = toolGroups[i]
-    const toolGroupToolNames = Object.keys(toolGroup.tools)
+    const toolGroupToolNames = Object.keys(toolGroup.toolOptions)
 
     for (let j = 0; j < toolGroupToolNames.length; j++) {
       const toolName = toolGroupToolNames[j]
-      const tool = toolGroup.tools[toolName]
+      const tool = toolGroup.toolOptions[toolName]
 
       // tool has binding that matches the mouse button
       const correctBinding =

diff --git a/packages/cornerstone-tools/src/store/ToolGroupManager/IToolGroup.ts b/packages/cornerstone-tools/src/store/ToolGroupManager/IToolGroup.ts
@@ -7,7 +7,7 @@ export default interface IToolGroup {
   _toolInstances: Record<string, any>
   id: string
   viewports: Array<Types.IViewportUID>
-  tools: Record<string, any>
+  toolOptions: Record<string, any>
   //
   getToolInstance: { (toolName: string): any }
   addTool: { (toolName: string, toolConfiguration?: any): void }

diff --git a/packages/cornerstone-tools/src/store/ToolGroupManager/createToolGroup.ts b/packages/cornerstone-tools/src/store/ToolGroupManager/createToolGroup.ts
@@ -26,7 +26,7 @@ function createToolGroup(toolGroupId: string): IToolGroup | undefined {
     _toolInstances: {}, // tool instances
     id: toolGroupId,
     viewports: [],
-    tools: {}, // tools modes etc.
+    toolOptions: {}, // tools modes etc.
     //
     getToolInstance: function (toolName) {
       const toolInstance = this._toolInstances[toolName]
@@ -39,7 +39,7 @@ function createToolGroup(toolGroupId: string): IToolGroup | undefined {
     addTool: function (toolName, toolConfiguration = {}) {
       const toolDefinition = state.tools[toolName]
       const hasToolName = typeof toolName !== 'undefined' && toolName !== ''
-      const localToolInstance = this.tools[toolName]
+      const localToolInstance = this.toolOptions[toolName]
 
       if (!hasToolName) {
         console.warn(
@@ -136,7 +136,7 @@ function createToolGroup(toolGroupId: string): IToolGroup | undefined {
       }
 
       // Would only need this for sanity check if not instantiating/hydrating
-      // const tool = this.tools[toolName];
+      // const tool = this.toolOptions[toolName];
       const toolModeOptionsWithMode = Object.assign(
         {
           bindings: [],
@@ -147,7 +147,7 @@ function createToolGroup(toolGroupId: string): IToolGroup | undefined {
         }
       )
 
-      this.tools[toolName] = toolModeOptionsWithMode
+      this.toolOptions[toolName] = toolModeOptionsWithMode
       this._toolInstances[toolName].mode = Active
 
       // reset the mouse cursor if tool has left click binding
@@ -169,7 +169,7 @@ function createToolGroup(toolGroupId: string): IToolGroup | undefined {
       }
 
       // Would only need this for sanity check if not instantiating/hydrating
-      // const tool = this.tools[toolName];
+      // const tool = this.toolOptions[toolName];
       const toolModeOptionsWithMode = Object.assign(
         {
           bindings: [],
@@ -180,7 +180,7 @@ function createToolGroup(toolGroupId: string): IToolGroup | undefined {
         }
       )
 
-      this.tools[toolName] = toolModeOptionsWithMode
+      this.toolOptions[toolName] = toolModeOptionsWithMode
       this._toolInstances[toolName].mode = Passive
       this.refreshViewports()
     },
@@ -197,7 +197,7 @@ function createToolGroup(toolGroupId: string): IToolGroup | undefined {
       }
 
       // Would only need this for sanity check if not instantiating/hydrating
-      // const tool = this.tools[toolName];
+      // const tool = this.toolOptions[toolName];
       const toolModeOptionsWithMode = Object.assign(
         {
           bindings: [],
@@ -208,7 +208,7 @@ function createToolGroup(toolGroupId: string): IToolGroup | undefined {
         }
       )
 
-      this.tools[toolName] = toolModeOptionsWithMode
+      this.toolOptions[toolName] = toolModeOptionsWithMode
       this._toolInstances[toolName].mode = Enabled
       this.refreshViewports()
     },
@@ -224,7 +224,7 @@ function createToolGroup(toolGroupId: string): IToolGroup | undefined {
       }
 
       // Would only need this for sanity check if not instantiating/hydrating
-      // const tool = this.tools[toolName];
+      // const tool = this.toolOptions[toolName];
       const toolModeOptionsWithMode = Object.assign(
         {
           bindings: [],
@@ -234,13 +234,13 @@ function createToolGroup(toolGroupId: string): IToolGroup | undefined {
           mode: Disabled,
         }
       )
-      this.tools[toolName] = toolModeOptionsWithMode
+      this.toolOptions[toolName] = toolModeOptionsWithMode
       this._toolInstances[toolName].mode = Disabled
       this.refreshViewports()
     },
     getActivePrimaryButtonTools() {
-      return Object.keys(this.tools).find((toolName) => {
-        const toolModeOptions = this.tools[toolName]
+      return Object.keys(this.toolOptions).find((toolName) => {
+        const toolModeOptions = this.toolOptions[toolName]
         return (
           toolModeOptions.mode === Active &&
           this.isPrimaryButtonBinding(toolModeOptions)

diff --git a/packages/cornerstone-tools/src/tools/CrosshairsTool.ts b/packages/cornerstone-tools/src/tools/CrosshairsTool.ts
@@ -178,7 +178,7 @@ export default class CrosshairsTool extends BaseAnnotationTool {
       sceneUID,
       viewportUID
     )
-    const groupTools = toolGroups[0]?.tools
+    const groupTools = toolGroups[0]?.toolOptions
     const mode = groupTools[this.name]?.mode
 
     // We don't want this annotation tool to render or be interactive unless its
@@ -258,7 +258,7 @@ export default class CrosshairsTool extends BaseAnnotationTool {
       sceneUID,
       viewportUID
     )
-    const groupTools = toolGroups[0]?.tools
+    const groupTools = toolGroups[0]?.toolOptions
     const mode = groupTools[this.name]?.mode
 
     // We don't want this annotation tool to render or be interactive unless its
@@ -272,7 +272,7 @@ export default class CrosshairsTool extends BaseAnnotationTool {
     let isCrosshairsActive = false
     for (let i = 0; i < toolGroups.length; ++i) {
       const toolGroup = toolGroups[i]
-      const tool = toolGroup.tools['Crosshairs']
+      const tool = toolGroup.toolOptions['Crosshairs']
 
       if (tool.mode === 'Active') {
         isCrosshairsActive = true
@@ -348,7 +348,7 @@ export default class CrosshairsTool extends BaseAnnotationTool {
     let isCrosshairsActive = false
     for (let i = 0; i < toolGroups.length; ++i) {
       const toolGroup = toolGroups[i]
-      const tool = toolGroup.tools['Crosshairs']
+      const tool = toolGroup.toolOptions['Crosshairs']
 
       if (tool.mode === 'Active') {
         isCrosshairsActive = true

diff --git a/packages/cornerstone-tools/src/tools/segmentation/RectangleRoiThreshold.ts b/packages/cornerstone-tools/src/tools/segmentation/RectangleRoiThreshold.ts
@@ -68,8 +68,6 @@ export default class RectangleRoiThresholdTool extends RectangleRoiTool {
         shadow: true,
         preventHandleOutsideImage: false,
       },
-      strategies: {},
-      defaultStrategy: '',
     })
   }
 

diff --git a/packages/cornerstone-tools/src/tools/segmentation/strategies/eraseRectangle.ts b/packages/cornerstone-tools/src/tools/segmentation/strategies/eraseRectangle.ts
@@ -3,7 +3,8 @@ import {
   getBoundingBoxAroundShape,
 } from '../../../util/segmentation'
 import { Point3 } from '../../../types'
-import { ImageVolume, Types } from '@ohif/cornerstone-render'
+import { ImageVolume } from '@ohif/cornerstone-render'
+import { IEnabledElement } from '@ohif/cornerstone-render/src/types'
 
 type EraseOperationData = {
   points: [Point3, Point3, Point3, Point3]
@@ -13,7 +14,7 @@ type EraseOperationData = {
 }
 
 type FillRectangleEvent = {
-  enabledElement: Types.IEnabledElement
+  enabledElement: IEnabledElement
 }
 
 /**
@@ -78,7 +79,7 @@ function eraseRectangle(
  */
 export function eraseInsideRectangle(
   evt: FillRectangleEvent,
-  operationData: OperationData
+  operationData: EraseOperationData
 ): void {
   eraseRectangle(evt, operationData, true)
 }
@@ -92,7 +93,7 @@ export function eraseInsideRectangle(
  */
 export function eraseOutsideRectangle(
   evt: FillRectangleEvent,
-  operationData: OperationData
+  operationData: EraseOperationData
 ): void {
   eraseRectangle(evt, operationData, false)
 }
diff --git a/packages/cornerstone-tools/src/tools/segmentation/strategies/fillRectangle.ts b/packages/cornerstone-tools/src/tools/segmentation/strategies/fillRectangle.ts
@@ -1,9 +1,12 @@
+import {
+  IEnabledElement,
+} from '@ohif/cornerstone-render/src/types'
 import {
   fillInsideShape,
   getBoundingBoxAroundShape,
 } from '../../../util/segmentation'
 import { Point3 } from '../../../types'
-import { ImageVolume, Types } from '@ohif/cornerstone-render'
+import { ImageVolume } from '@ohif/cornerstone-render'
 
 type OperationData = {
   points: [Point3, Point3, Point3, Point3]
@@ -14,7 +17,7 @@ type OperationData = {
 }
 
 type FillRectangleEvent = {
-  enabledElement: Types.IEnabledElement
+  enabledElement: IEnabledElement
 }
 
 /**

diff --git a/packages/cornerstone-tools/src/util/getToolsWithModesForElement.ts b/packages/cornerstone-tools/src/util/getToolsWithModesForElement.ts
@@ -30,11 +30,11 @@ export default function getToolsWithModesForElement(
 
   for (let i = 0; i < toolGroups.length; i++) {
     const toolGroup = toolGroups[i]
-    const toolGroupToolNames = Object.keys(toolGroup.tools)
+    const toolGroupToolNames = Object.keys(toolGroup.toolOptions)
 
     for (let j = 0; j < toolGroupToolNames.length; j++) {
       const toolName = toolGroupToolNames[j]
-      const tool = toolGroup.tools[toolName]
+      const tool = toolGroup.toolOptions[toolName]
 
       if (modesFilter.includes(tool.mode)) {
         const toolInstance = toolGroup._toolInstances[toolName]

diff --git a/packages/cornerstone-tools/src/util/viewportFilters/filterViewportsWithToolEnabled.ts b/packages/cornerstone-tools/src/util/viewportFilters/filterViewportsWithToolEnabled.ts
@@ -49,8 +49,8 @@ export default function filterViewportsWithToolEnabled(viewports, toolName) {
  * @returns {boolean} True if the tool is enabled, passive or active in the `toolGroup`.
  */
 function _toolGroupHasActiveEnabledOrPassiveTool(toolGroup, toolName) {
-  const { tools } = toolGroup
-  const tool = tools[toolName]
+  const { toolOptions } = toolGroup
+  const tool = toolOptions[toolName]
 
   if (!tool) {
     return false