fix: Add portal visualization to `TrackingVolume` #4029

paulgessinger · 2025-01-14T15:31:59Z

--- END COMMIT MESSAGE ---

Any further description goes here, @-mentions are ok here!

Use a conventional commits prefix: quick summary
- We mostly use feat, fix, refactor, docs, chore and build types.
A milestone will be assigned by one of the maintainers

Summary by CodeRabbit

New Features
- Enhanced 3D visualization capabilities for tracking volumes
- Added support for rendering portal surfaces in the visualization context

coderabbitai · 2025-01-14T15:32:10Z

Walkthrough

In the realm of geometric visualization, a subtle yet significant enhancement emerges within the TrackingVolume class. The visualize method now embraces portal surfaces, expanding its rendering capabilities by iterating through portals and invoking their individual visualization methods. This addition enriches the 3D representation, allowing a more comprehensive view of tracking volume geometries.

Changes

File	Change Summary
`Core/src/Geometry/TrackingVolume.cpp`	Added portal surface visualization loop in `visualize` method

Sequence Diagram

sequenceDiagram
    participant TrackingVolume
    participant Portal
    participant Visualization3D
    
    TrackingVolume->>TrackingVolume: Iterate portals
    TrackingVolume->>Portal: visualize()
    Portal-->>Visualization3D: Render portal surface

Poem

Portals dance in geometric light, 🌈
Surfaces emerge, a Jedi's delight! 🚀
Visualization's path now clear and bright,
Tracking volumes spread their spatial might,
Code flows like the Force, pure and right! 🌟

Finishing Touches

📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

Core/src/Geometry/TrackingVolume.cpp (1)
749-752: Hmmmm, good changes these are! Portal visualization, added well it has been.

Clean and focused implementation, I see. Consistent with existing visualization patterns, it is. Through all portals it loops, their surfaces it shows.

A suggestion for readability, I have:
  for (const auto& portal : portals()) {
-    portal.surface().visualize(helper, gctx, portalViewConfig);
+    const auto& surface = portal.surface();
+    surface.visualize(helper, gctx, portalViewConfig);
  }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b473181 and cad208a.

📒 Files selected for processing (1)

Core/src/Geometry/TrackingVolume.cpp (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (9)

GitHub Check: merge-sentinel
GitHub Check: unused_files
GitHub Check: missing_includes
GitHub Check: macos
GitHub Check: linux_ubuntu_extra (ubuntu2204_clang, 20)
GitHub Check: docs
GitHub Check: linux_ubuntu
GitHub Check: linux_ubuntu_extra (ubuntu2204, 20)
GitHub Check: build_debug

github-actions · 2025-01-14T16:28:18Z

📊: Physics performance monitoring for `c0af7ca`

Full contents

physmon summary

sonarqubecloud · 2025-01-15T16:57:35Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
64.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

acts-project-service · 2025-01-15T19:07:25Z

✅ Athena integration test results [`b67f914`]

✅ All tests successful

status	job	report
🟢	report_pull_request
🟢	run_workflow_tests_run4_mc
🟢	run_workflow_tests_run2_mc
🟢	run_workflow_tests_run2_data
🟢	run_workflow_tests_run3_mc
🟢	run_workflow_tests_run3_data
🟢	test_ActsDumpGeometryIdentifiers
🟢	test_ActsCheckObjectCountsWorkflowHgtd
🟢	test_ActsCheckObjectCountsCachedWorkflow
🟢	test_ActsCheckObjectCountsWorkflow
🟢	test_ActsEFTrackFit
🟢	test_ActsPersistifySeeds
🟢	test_ActsBenchmarkWithSpot
🟢	test_ActsAnalogueClustering
🟢	test_ActsWorkflowHeavyIons
🟢	test_ActsWorkflowFastTracking
🟢	test_ActsWorkflowCached
🟢	test_ActsWorkflow
🟢	test_ActsValidateAmbiguityResolution
🟢	test_ActsValidateResolvedTracks
🟢	test_ActsValidateTracks
🟢	test_ActsValidateActsCoreSpacePoints
🟢	test_ActsValidateActsSpacePoints
🟢	test_ActsValidateSeeds
🟢	test_ActsValidateOrthogonalSeeds
🟢	test_ActsValidateClusters
🟢	test_ActsPersistifyEDM
🟢	test_ActsGx2fRefitting
🟢	test_ActsGSFRefitting
🟢	test_ActsKfRefitting
🟢	test_ActsExtrapolationAlgTest
🟢	test_ActsITkTest

fix: Add portal visualization to TrackingVolume

cad208a

github-actions bot added the Component - Core Affects the Core module label Jan 14, 2025

github-actions bot added this to the next milestone Jan 14, 2025

coderabbitai bot reviewed Jan 14, 2025

View reviewed changes

asalzburger approved these changes Jan 15, 2025

View reviewed changes

asalzburger added the automerge label Jan 15, 2025

Merge branch 'main' into fix/tracking-volume-portal

c0af7ca

kodiakhq bot merged commit b67f914 into acts-project:main Jan 15, 2025
42 checks passed

github-actions bot removed the automerge label Jan 15, 2025

acts-project-service added the Fails Athena tests This PR causes a failure in the Athena tests label Jan 15, 2025

coderabbitai bot mentioned this pull request Jan 24, 2025

feat: Adding cuboid portal shell #4047

Open

paulgessinger modified the milestones: next, v39.0.0 Feb 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Add portal visualization to `TrackingVolume` #4029

fix: Add portal visualization to `TrackingVolume` #4029

paulgessinger commented Jan 14, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 14, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

github-actions bot commented Jan 14, 2025 •

edited

Loading

sonarqubecloud bot commented Jan 15, 2025

acts-project-service commented Jan 15, 2025 •

edited

Loading

fix: Add portal visualization to TrackingVolume #4029

fix: Add portal visualization to TrackingVolume #4029

Conversation

paulgessinger commented Jan 14, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Jan 14, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram

Poem

Finishing Touches

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 14, 2025 • edited Loading

📊: Physics performance monitoring for c0af7ca

physmon summary

sonarqubecloud bot commented Jan 15, 2025

Quality Gate passed

acts-project-service commented Jan 15, 2025 • edited Loading

✅ Athena integration test results [b67f914]

✅ All tests successful

fix: Add portal visualization to `TrackingVolume` #4029

fix: Add portal visualization to `TrackingVolume` #4029

paulgessinger commented Jan 14, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Jan 14, 2025 •

edited

Loading

📊: Physics performance monitoring for `c0af7ca`

acts-project-service commented Jan 15, 2025 •

edited

Loading

✅ Athena integration test results [`b67f914`]