Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename: Remaining toolGroupById and synchronizerById references #22

Closed
wants to merge 5 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
change getToolGroup to getToolGroupForViewport
  • Loading branch information
sedghi committed Mar 28, 2022
commit fbd6767b98999f4cfc5cf4b575a660f7a7ddc30f
4 changes: 2 additions & 2 deletions common/reviews/api/tools.api.md
Original file line number Diff line number Diff line change
@@ -1308,7 +1308,7 @@ function getSynchronizers(renderingEngineId: string, viewportId: string): Array<
function getTextBoxCoordsCanvas(annotationCanvasPoints: Array<Types_2.Point2>): Types_2.Point2;

// @public (undocumented)
function getToolGroup(viewportId: string, renderingEngineId: string): IToolGroup | undefined;
function getToolGroupForViewport(viewportId: string, renderingEngineId: string): IToolGroup | undefined;

// @public (undocumented)
function getToolGroupById(toolGroupId: string): IToolGroup | undefined;
@@ -3113,7 +3113,7 @@ declare namespace ToolGroupManager {
destroy_3 as destroy,
destroyToolGroupById,
getToolGroupById,
getToolGroup,
getToolGroupForViewport,
getAllToolGroups
}
}
Original file line number Diff line number Diff line change
@@ -17,7 +17,10 @@ export default function keyDown(evt: KeyDownEventType): void {

const { renderingEngineId, viewportId } = evt.detail

const toolGroup = ToolGroupManager.getToolGroup(viewportId, renderingEngineId)
const toolGroup = ToolGroupManager.getToolGroupForViewport(
viewportId,
renderingEngineId
)

const toolName = activeTool.getToolName()
if (Object.keys(toolGroup.toolOptions).includes(toolName)) {
Original file line number Diff line number Diff line change
@@ -18,7 +18,10 @@ export default function keyUp(evt: KeyDownEventType): void {

const { renderingEngineId, viewportId } = evt.detail

const toolGroup = ToolGroupManager.getToolGroup(viewportId, renderingEngineId)
const toolGroup = ToolGroupManager.getToolGroupForViewport(
viewportId,
renderingEngineId
)

// Reset the modifier key
resetModifierKey()
Original file line number Diff line number Diff line change
@@ -28,7 +28,10 @@ export default function customCallbackHandler(
}

const { renderingEngineId, viewportId } = evt.detail
const toolGroup = ToolGroupManager.getToolGroup(viewportId, renderingEngineId)
const toolGroup = ToolGroupManager.getToolGroupForViewport(
viewportId,
renderingEngineId
)

if (!toolGroup) {
return false
Original file line number Diff line number Diff line change
@@ -26,7 +26,10 @@ export default function getActiveToolForKeyboardEvent(
// If any keyboard modifier key is also pressed
const modifierKey = keyEventListener.getModifierKey()

const toolGroup = ToolGroupManager.getToolGroup(viewportId, renderingEngineId)
const toolGroup = ToolGroupManager.getToolGroupForViewport(
viewportId,
renderingEngineId
)

if (!toolGroup) {
return null
Original file line number Diff line number Diff line change
@@ -24,7 +24,10 @@ export default function getActiveToolForMouseEvent(
// If any keyboard modifier key is also pressed
const modifierKey = keyEventListener.getModifierKey()

const toolGroup = ToolGroupManager.getToolGroup(viewportId, renderingEngineId)
const toolGroup = ToolGroupManager.getToolGroupForViewport(
viewportId,
renderingEngineId
)

if (!toolGroup) {
return null
Original file line number Diff line number Diff line change
@@ -17,7 +17,10 @@ export default function getToolsWithModesForMouseEvent(
evtButton?: any
) {
const { renderingEngineId, viewportId } = evt.detail
const toolGroup = ToolGroupManager.getToolGroup(viewportId, renderingEngineId)
const toolGroup = ToolGroupManager.getToolGroupForViewport(
viewportId,
renderingEngineId
)

if (!toolGroup) {
return []
Original file line number Diff line number Diff line change
@@ -15,7 +15,7 @@ import { IToolGroup } from '../../types'
* tool group is associated with.
* @returns A tool group.
*/
function getToolGroup(
function getToolGroupForViewport(
viewportId: string,
renderingEngineId: string
): IToolGroup | undefined {
@@ -41,4 +41,4 @@ function getToolGroup(
return toolGroupFilteredByIds[0]
}

export default getToolGroup
export default getToolGroupForViewport
4 changes: 2 additions & 2 deletions packages/tools/src/store/ToolGroupManager/index.ts
Original file line number Diff line number Diff line change
@@ -2,14 +2,14 @@ import createToolGroup from './createToolGroup'
import destroyToolGroupById from './destroyToolGroupById'
import destroy from './destroy'
import getToolGroupById from './getToolGroupById'
import getToolGroup from './getToolGroup'
import getToolGroupForViewport from './getToolGroupForViewport'
import getAllToolGroups from './getAllToolGroups'

export {
createToolGroup,
destroy,
destroyToolGroupById,
getToolGroupById,
getToolGroup,
getToolGroupForViewport,
getAllToolGroups,
}
4 changes: 2 additions & 2 deletions packages/tools/src/store/removeEnabledElement.ts
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ import getToolsWithModesForElement from '../utilities/getToolsWithModesForElemen
import { ToolModes } from '../enums'
import { removeAnnotation } from '../stateManagement'
import getSynchronizers from './SynchronizerManager/getSynchronizers'
import getToolGroup from './ToolGroupManager/getToolGroup'
import getToolGroupForViewport from './ToolGroupManager/getToolGroupForViewport'
import { annotationRenderingEngine } from '../utilities/triggerAnnotationRender'

const VIEWPORT_ELEMENT = 'viewport-element'
@@ -84,7 +84,7 @@ const _removeViewportFromSynchronizers = (element: HTMLElement) => {
const _removeViewportFromToolGroup = (element: HTMLElement) => {
const { renderingEngineId, viewportId } = getEnabledElement(element)

const toolGroup = getToolGroup(viewportId, renderingEngineId)
const toolGroup = getToolGroupForViewport(viewportId, renderingEngineId)

if (toolGroup) {
toolGroup.removeViewports(renderingEngineId, viewportId)
5 changes: 4 additions & 1 deletion packages/tools/src/utilities/getAnnotationNearPoint.ts
Original file line number Diff line number Diff line change
@@ -52,7 +52,10 @@ function getAnnotationNearPointOnEnabledElement(
// Todo: this function should return closest annotation, BUT, we are not using
// the function anywhere.
const { renderingEngineId, viewportId } = enabledElement
const toolGroup = ToolGroupManager.getToolGroup(viewportId, renderingEngineId)
const toolGroup = ToolGroupManager.getToolGroupForViewport(
viewportId,
renderingEngineId
)

if (!toolGroup) {
return null
5 changes: 4 additions & 1 deletion packages/tools/src/utilities/getToolsWithModesForElement.ts
Original file line number Diff line number Diff line change
@@ -20,7 +20,10 @@ export default function getToolsWithModesForElement(
const enabledElement = getEnabledElement(element)
const { renderingEngineId, viewportId } = enabledElement

const toolGroup = ToolGroupManager.getToolGroup(viewportId, renderingEngineId)
const toolGroup = ToolGroupManager.getToolGroupForViewport(
viewportId,
renderingEngineId
)

if (!toolGroup) {
return []
7 changes: 5 additions & 2 deletions packages/tools/src/utilities/triggerSegmentationRender.ts
Original file line number Diff line number Diff line change
@@ -6,7 +6,10 @@ import {
Types,
} from '@cornerstonejs/core'
import { Events as csToolsEvents } from '../enums'
import { getToolGroupById, getToolGroup } from '../store/ToolGroupManager'
import {
getToolGroupById,
getToolGroupForViewport,
} from '../store/ToolGroupManager'

import SegmentationDisplayTool from '../tools/displayTools/SegmentationDisplayTool'
import { SegmentationRenderedEventDetail } from '../types/EventTypes'
@@ -127,7 +130,7 @@ class SegmentationRenderingEngine {
onSegmentationRender
)

const toolGroup = getToolGroup(viewportId, renderingEngineId)
const toolGroup = getToolGroupForViewport(viewportId, renderingEngineId)

const eventDetail: SegmentationRenderedEventDetail = {
toolGroupId: toolGroup.id,
Original file line number Diff line number Diff line change
@@ -24,7 +24,7 @@ export default function filterViewportsWithToolEnabled(
for (let vp = 0; vp < numViewports; vp++) {
const viewport = viewports[vp]

const toolGroup = ToolGroupManager.getToolGroup(
const toolGroup = ToolGroupManager.getToolGroupForViewport(
viewport.id,
viewport.renderingEngineId
)
5 changes: 4 additions & 1 deletion packages/tools/test/ToolGroupManager_test.js
Original file line number Diff line number Diff line change
@@ -191,7 +191,10 @@ describe('ToolGroup Manager: ', () => {
const tg = ToolGroupManager.getToolGroupById('volume1')
expect(tg).toBeDefined()

const tg2 = ToolGroupManager.getToolGroup(viewportId1, renderingEngineId)
const tg2 = ToolGroupManager.getToolGroupForViewport(
viewportId1,
renderingEngineId
)
expect(tg2).toBeDefined()
expect(tg).toBe(tg2)