Skip to content

Updated SolvePnPMethod enum. - #1899

Merged
shimat merged 2 commits into
shimat:mainfrom
kasper-vv:fix/solvepnpmethod
Jun 19, 2026
Merged

shimat merged 2 commits into
shimat:mainfrom
kasper-vv:fix/solvepnpmethod

Conversation

@kasper-vv

@kasper-vv kasper-vv commented Jun 19, 2026 •

Copy link
Copy Markdown

The SolvePnPMethod enum was missing the last 4 values. I have added these values and updated the descriptions/summaries.
SolvePnp with SolvePnPMethod.SQPNP was successfully tested on a real world scenario.

Summary by CodeRabbit

  • Documentation
    • Improved XML documentation for the SolvePnPMethod solver method flags, including clearer descriptions for iterative (Levenberg–Marquardt), notes on DLS/UPNP limitations, and updated guidance on point ordering for IPPE_SQUARE.

@coderabbitai

coderabbitai Bot commented Jun 19, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 789c7aed-fe00-4d0f-b040-6cef34fd4c3a

📥 Commits

Reviewing files that changed from the base of the PR and between 57fe0e2 and 6c32c1a.

📒 Files selected for processing (1)
  • src/OpenCvSharp/Modules/calib3d/Enum/SolvePnPFlags.cs
✅ Files skipped from review due to trivial changes (1)
  • src/OpenCvSharp/Modules/calib3d/Enum/SolvePnPFlags.cs

📝 Walkthrough

Walkthrough

XML documentation comments in the SolvePnPMethod enum (SolvePnPFlags.cs) are rewritten. The Iterative entry's description is updated, and the comments for P3P, DLS, UPNP, AP3P, IPPE, IPPE_SQUARE, and SQPNP are replaced or expanded with revised bibliographic references, "broken implementation" warnings for DLS/UPNP, and detailed point-order requirements for IPPE_SQUARE. No enum values or runtime behavior are modified.

Changes

SolvePnPMethod XML Documentation

Layer / File(s) Summary
SolvePnPMethod enum XML documentation
src/OpenCvSharp/Modules/calib3d/Enum/SolvePnPFlags.cs
Rewrites the Iterative doc comment and replaces/expands documentation for all remaining enum members (P3P through SQPNP), including broken-implementation notes for DLS and UPNP and point-order requirements for IPPE_SQUARE.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • shimat/opencvsharp#1898: Both PRs modify SolvePnPMethod documentation in the same file, with #1898 adding the enum values and this PR updating their XML doc comments.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating documentation for the SolvePnPMethod enum with refined descriptions and new docstrings.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@kasper-vv

Copy link
Copy Markdown
Author

Sorry, I didn't see that you had also made the changes yourself in #1898

@shimat

shimat commented Jun 19, 2026

Copy link
Copy Markdown
Owner

Thank you!

@shimat
shimat merged commit 5d7b6e3 into shimat:main Jun 19, 2026
1 check passed
Lukaa0 pushed a commit to Lukaa0/opencvsharp that referenced this pull request Jun 22, 2026
Follow-up to shimat#1899. Tidies the SolvePnPMethod documentation without
changing behavior:

- Fix CS1570 warning: escape "&" as "&" in the P3P reference
- Remove a redundant duplicated sentence in the SQPNP summary
- Fix spacing/punctuation in the SQPNP reference ("M. Lourakis. It requires")
- Trim trailing whitespace and add a missing period in several summaries

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@shimat shimat added the enhancement New feature or improvement to OpenCvSharp label Jul 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or improvement to OpenCvSharp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants