fix(CircleROITool) Issue 1489 - CircleROITool fires unnecessary ANNOTATION_MODIFIED events when any part of the annotation is outside the image

[kom482]

Context

fix for #1489

Positioning a CircleROITool annotation partially or fully outside the image (i.e. in the black border area) in a StackViewport will cause extraneous ANNOTATION_MODIFIED events to be triggered. This can be observed by setting up an event listener that logs to console:

eventTarget.addEventListener(
    csToolsEnums.Events.ANNOTATION_MODIFIED,
    (event) => {
        console.log(`ANNOTATION_MODIFIED: ${event.detail.viewportId} ${event.detail.annotation.annotationUID} ${event.detail.changeType}`);
    }
);

Changes & Results

Before:

circle-before.mp4

After:

circle-fix.mp4

Testing

1. Open stackAnnotationTools example: yarn run example stackAnnotationTools
2. Subscribe annotations modified event

eventTarget.addEventListener(csToolsEnums.Events.ANNOTATION_MODIFIED,(event)=>{
  console.count(`${event.type}: ${event.detail.annotation.metadata.toolName}`)
})

3. Select the Circle tool from the toolbar.
4. Draw an circle annotation within the volume to confirm normal behavior.
5. Move the circle annotation outside the volume boundaries.

Checklist

PR

• My Pull Request title is descriptive, accurate and follows the
  semantic-release format and guidelines.

Code

• My code has been well-documented (function documentation, inline comments,
  etc.)

• I have run the yarn build:update-api to update the API documentation, and have
  committed the changes to this PR. (Read more here https://www.cornerstonejs.org/docs/contribute/update-api)

Public Documentation Updates

• The documentation page has been updated as necessary for any public API
  additions or removals.

Tested Environment

• "OS: Windows 11"
• "Node version: 16.20.2"
• "Browser: Chrome 125.0.6422.113"

[netlify]

✅ Deploy Preview for cornerstone-3d-docs ready!

Name	Link
🔨 Latest commit	735b040
🔍 Latest deploy log	https://app.netlify.com/sites/cornerstone-3d-docs/deploys/671e26011c95150008c45981
😎 Deploy Preview	https://deploy-preview-1518--cornerstone-3d-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.