[apriltag] AprilTagFieldLayout: Improve API shape for loading builtin JSONs #4949
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tter document how to use custom JSONs
|
Add a comment pointing to the correct method for loading official included fields |
|
Would it make sense to make m_resourceFile in AprilTagFields private since users shouldn't be using it directly now? I can't think of a usecase where m_resourceFile is going to be used outside of that one method. |
|
No reason to not have it public. |
Starlight220
approved these changes
Jan 16, 2023
PeterJohnson
changed the title
Starlight220
pushed a commit
to Starlight220/allwpilib
that referenced
this pull request
Mar 2, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
C++ had a method dedicated to loading a inbuilt field from the enum, Java however was missing this. The unclear documentation on the AprilTagFieldLayout loadFromResource method led to users (read: me and my team) attempting to use it with non-internal fields. This would NPE in a non-expected way.
This PR: