geom::Torus radii docs improvement and radiusCentered method #2072
+8
−4
Conversation
This file contains hidden or 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
| //! Specifies the major and minor radius as a ratio (minor : major). Resulting torus will fit unit cube. | ||
| Torus& ratio( float ratio ) { ratio = math<float>::clamp( ratio ); mRadiusMajor = 1; mRadiusMinor = 1 - ratio; return *this; } | ||
| //! Specifies the major and minor radius separately. | ||
| Torus& ratio( float ratio ) { ratio = math<float>::clamp( ratio ); mRadiusMajor = 1; mRadiusMinor = ratio; return *this; } |
Collaborator
There was a problem hiding this comment.
The docs are a nice improvement IMO. though isn't it a breaking change? Though I'm not against it in this case, I don't think the ratio() method is used as much. @paulhoux what do you think?
Contributor
Author
There was a problem hiding this comment.
It is a breaking change indeed, but I think ratio() was not working according to its documentation. if ratio = minor / major and major = 1 then minor should be equal to ratio and not 1 - ratio.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Improving the docs on major, minor radius as discussed in #2057.
Fixed
ratiomethod.Adding
radiusCenteredmethod that follows a more usual naming for torus creation when a circle of radiusris rotated around an axis. I usedrandRfor minor and major radius in this method, to make it more clear that those variables are used for other distances by the class.