Keeping measurements inside displayedArea when options' flags are set

[brunoalvesdefaria]

• Wait merge: Expose getDisplayedArea util cornerstone#561

• What kind of change does this PR introduce?
  Fixes Keep annotations inside displayedArea #1277

• What is the current behavior?
  Keep annotations inside displayedArea #1277

• What is the new behavior?
  New deleteIfHandleOutsideDisplayedArea and preventHandleOutsideDisplayedArea flags were created in order to prevent handles outside image's displayed area.

• Does this PR introduce a breaking change?
  No, it will only add a new feature to control measurements outside the displayed area of the image.

• Other information:
  This PR will fix the problem mentioned in this issue: "Crop" image #745

[codecov]

Codecov Report

Merging #1278 (e96d8ee) into master (95c3b7c) will decrease coverage by 0.00%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##           master    #1278      +/-   ##
==========================================
- Coverage   20.16%   20.16%   -0.01%     
==========================================
  Files         287      291       +4     
  Lines       10102    10103       +1     
  Branches     2060     2041      -19     
==========================================
  Hits         2037     2037              
- Misses       6852     6860       +8     
+ Partials     1213     1206       -7     

Impacted Files	Coverage Δ
...ispatchers/touchEventHandlers/addNewMeasurement.js	3.70% <0.00%> (+0.57%)	⬆️
src/lib.js	100.00% <ø> (ø)
src/manipulators/anyHandlesOutsideDisplayedArea.js	0.00% <0.00%> (ø)
src/manipulators/clipHandle.js	0.00% <0.00%> (ø)
src/manipulators/deleteIfHandleOutsideLimits.js	0.00% <0.00%> (ø)
src/manipulators/getHandleMovingOptions.js	0.00% <0.00%> (ø)
src/manipulators/moveAllHandles.js	6.06% <0.00%> (+0.72%)	⬆️
src/manipulators/moveHandle.js	5.88% <0.00%> (+0.50%)	⬆️
src/manipulators/moveNewHandle.js	5.12% <0.00%> (+0.42%)	⬆️
src/store/index.js	50.00% <ø> (ø)
... and 7 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 95c3b7c...e96d8ee. Read the comment docs.

[ladeirarodolfo]

During some manual tests found the following details:

1. Displayed area is image area or actually viewport? Saying that because, having flag deleteIfHandleOutsideDisplayedArea: true, I`m able to set a measurement tool if its placed inner image area but even out of viewport (what it is really displayed). Is this expected? To easily reproduce it: use pan to move image, then add a measurement starting from a visible region up to a region out of viewport but inner image area.

2. Bugs I believe: FreehandRoi tool.
   2.1 For deleteIfHandleOutsideDisplayedArea: true

• Enable freehandRoi tool
• Start drawing from invalid area(outside image)
• Drawing color must change to red
• At this point you can not even cancel drawing (maybe this is another potential and not related bug)
• Force cancel drawing by changing to another selected to
  Expected: FreehandRoi draw must be delete
  Actual: FreehandRoi is persisted and also with a different drawing line

2.2 For preventHandleOutsideDisplayedArea: true

• Enable freehandRoi tool
• Start drawing from a valid area(inner image boundaries)
• Draw over valid area
• Drawing color must change to red
  Expected: FreehandRoi drawing must be blocked to go outside
  Actual: Drawing is kind of blocked, but limits looks like are different from other tools. Also after finishing a handle outside area drawing might change on an unexpectedly way

[ladeirarodolfo]

Is it possible to create a new variable instead of options. I know this come from old implementation, but doing this we avoid potential js reference issues.

[igoroctaviano]

@sedghi can you review + test this pull request please? for more details, check out the ticket in the issue description.

[sedghi]

I'm not able to replicate the behaviour that is intended here.

• run demo with cornerstoneTools.store.state.preventHandleOutsideDisplayedArea = true

• do

  const viewport = cornerstone.getViewport($0);
  Object.assign(viewport.displayedArea.tlhc, { x: 128, y: 128 });
  cornerstone.setViewport($0, viewport);
  
  

• Image is transformed

• use length

• it does not allow drawing inside, it always snaps

[igoroctaviano]

I'm not able to replicate the behaviour that is intended here.

• run demo with cornerstoneTools.store.state.preventHandleOutsideDisplayedArea = true
• do

  const viewport = cornerstone.getViewport($0);
  Object.assign(viewport.displayedArea.tlhc, { x: 128, y: 128 });
  cornerstone.setViewport($0, viewport);
  

• Image is transformed
• use length
• it does not allow drawing inside, it always snaps

This should work since we used it in another project. @brunoalvesdefaria the usage is correct?