Add Direction3dA and move direction types out of primitives
#12018
Conversation
Jondolf
added
C-Feature
alice-i-cecile
added
the
M-Needs-Migration-Guide
|
It looks like your PR is a breaking change, but you didn't provide a migration guide. Could you add some context on what users should update when this change get released in a new version of Bevy? |
Co-authored-by: Alice Cecile <[email protected]>
|
Done 👍 |
|
|
||
| // Make sure the result is normalized. | ||
| // This can fail for non-unit quaternions. | ||
| debug_assert!(rotated.is_normalized()); |
There was a problem hiding this comment.
Maybe it would be good to provide an assertion message?
Probably not a blocker, I think it's already pretty clear.
There was a problem hiding this comment.
Yeah, it'd be good to have a message since I've seen this confuse some people already. Probably in a follow-up though; I didn't want to make any changes to the direction types in this PR since that's not the focus here
| } | ||
| } | ||
|
|
||
| impl std::ops::Neg for Direction2d { |
There was a problem hiding this comment.
Direction2d should also implement Mul<f32> -> Vec2.
Although we can do that in another PR (I think we should do a PR that adds Add<DirectionNd> -> VecN as well, but that's beyond this PR.)
There was a problem hiding this comment.
I don't think that add implementation makes much sense honestly.
There was a problem hiding this comment.
I think it does as an escape hatch from APIs that return a Direction even when the user wants to do vector arithmetic (like Transforms). The current solution is usually a bunch of Derefs, but I've heard feedback that they make the syntax uglier. (But I understand the controversy on this API.)
alice-i-cecile
added
the
S-Ready-For-Final-Review
…engine#12018) # Objective Split up from bevyengine#12017, add an aligned version of `Direction3d` for SIMD, and move direction types out of `primitives`. ## Solution Add `Direction3dA` and move direction types into a new `direction` module. --- ## Migration Guide The `Direction2d`, `Direction3d`, and `InvalidDirectionError` types have been moved out of `bevy::math::primitives`. Before: ```rust use bevy::math::primitives::Direction3d; ``` After: ```rust use bevy::math::Direction3d; ``` --------- Co-authored-by: Alice Cecile <[email protected]>
…engine#12018) # Objective Split up from bevyengine#12017, add an aligned version of `Direction3d` for SIMD, and move direction types out of `primitives`. ## Solution Add `Direction3dA` and move direction types into a new `direction` module. --- ## Migration Guide The `Direction2d`, `Direction3d`, and `InvalidDirectionError` types have been moved out of `bevy::math::primitives`. Before: ```rust use bevy::math::primitives::Direction3d; ``` After: ```rust use bevy::math::Direction3d; ``` --------- Co-authored-by: Alice Cecile <[email protected]>
Objective
Split up from #12017, add an aligned version of
Direction3dfor SIMD, and move direction types out ofprimitives.Solution
Add
Direction3dAand move direction types into a newdirectionmodule.Migration Guide
The
Direction2d,Direction3d, andInvalidDirectionErrortypes have been moved out ofbevy::math::primitives.Before:
After: