Fix documentation of cross product; add convenience Vec2 methods #409
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
I managed to get this wrong when I was trying to nail down the sign conventions, and it's been bothering me since I noticed it. The PR adds a couple of simple convenience methods I find myself using quite a bit as I implement stroke expansion. Note that a lot of methods can become const when we bump the MSRV, but that should happen separately.
Two separate entries, one for the fix one for the added methods. Should it be two separate PRs?
tomcur
approved these changes
Jan 10, 2025
src/vec2.rs
Outdated
Comment on lines
336
to
341
| /// Combine two vectors interpreted as rotation and scaling. | ||
| /// | ||
| /// Interpret both vectors as a rotation and a scale, and combine | ||
| /// their effects. This operation is equivalent to multiplication | ||
| /// when the vectors are interpreted as complex numbers. It is | ||
| /// commutative. |
There was a problem hiding this comment.
It might be worth it to state explicitly that the angles are added, and the magnitudes are multiplied.
Maybe:
Suggested change
| /// Combine two vectors interpreted as rotation and scaling. | |
| /// | |
| /// Interpret both vectors as a rotation and a scale, and combine | |
| /// their effects. This operation is equivalent to multiplication | |
| /// when the vectors are interpreted as complex numbers. It is | |
| /// commutative. | |
| /// Combine two vectors interpreted as rotation and scaling. | |
| /// | |
| /// Interpret both vectors as a rotation and a scale, and combine | |
| /// their effects by adding the angles and multiplying the magnitudes. | |
| /// This operation is equivalent to multiplication when the vectors | |
| /// are interpreted as complex numbers. It is commutative. |
| @@ -20,12 +20,17 @@ This release has an [MSRV][] of 1.65. | |||
| - `Stroke` is now `PartialEq`, `StrokeOpts` is now `Clone`, `Copy`, `Debug`, `Eq`, `PartialEq`. ([#379][] by [@waywardmonkeys][]) | |||
| - Implement `Sum` for `Vec2`. ([#399][] by [@Philipp-M][]) | |||
| - Add triangle shape. ([#350][] by [@juliapaci][]) | |||
| - Add `Vec2::turn_90` and `Vec2::rotate_scale` methods ([#409] by [@raphlinus][]) | |||
There was a problem hiding this comment.
The link to #409 is missing at the bottom of the file.
raphlinus
changed the title
Thanks @tomcur for suggesting the improvement.
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.
I managed to get this wrong when I was trying to nail down the sign conventions, and it's been bothering me since I noticed it.
The PR adds a couple of simple convenience methods I find myself using quite a bit as I implement stroke expansion.
Note that a lot of methods can become const when we bump the MSRV, but that should happen separately.