Warnings and docs for exponential denormalization in rotate functions (alternative to #17604) #17646
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
Novakasa
force-pushed
the
warn-rotate-axis-denormalization
branch
from
531cc80 to
2411c78
Compare
mockersf
approved these changes
Feb 2, 2025
alice-i-cecile
added
C-Docs
alice-i-cecile
approved these changes
Feb 2, 2025
alice-i-cecile
added
the
S-Ready-For-Final-Review
Bleachfuel
approved these changes
Feb 3, 2025
Novakasa
force-pushed
the
warn-rotate-axis-denormalization
branch
from
2411c78 to
ddc65e0
Compare
mrchantey
pushed a commit
to mrchantey/bevy
that referenced
this pull request
Feb 4, 2025
… (alternative to bevyengine#17604) (bevyengine#17646) # Objective - When obtaining an axis from the transform and putting that into `Transform::rotate_axis` or `Transform::rotate_axis_local`, floating point errors could accumulate exponentially, resulting in denormalized rotation. - This is an alternative to and closes bevyengine#17604, due to lack of consent around this in the [discord discussion](https://discord.com/channels/691052431525675048/1203087353850364004/1334232710658392227) - Closes bevyengine#16480 ## Solution - Add a warning of this issue and a recommendation to normalize to the API docs. - Add a runtime warning that checks for denormalized axis in debug mode, with a reference to the API docs.
joshua-holmes
pushed a commit
to joshua-holmes/bevy
that referenced
this pull request
Feb 5, 2025
… (alternative to bevyengine#17604) (bevyengine#17646) # Objective - When obtaining an axis from the transform and putting that into `Transform::rotate_axis` or `Transform::rotate_axis_local`, floating point errors could accumulate exponentially, resulting in denormalized rotation. - This is an alternative to and closes bevyengine#17604, due to lack of consent around this in the [discord discussion](https://discord.com/channels/691052431525675048/1203087353850364004/1334232710658392227) - Closes bevyengine#16480 ## Solution - Add a warning of this issue and a recommendation to normalize to the API docs. - Add a runtime warning that checks for denormalized axis in debug mode, with a reference to the API docs.
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.
Objective
Transform::rotate_axisorTransform::rotate_axis_local, floating point errors could accumulate exponentially, resulting in denormalized rotation.Transform::rotate_axis#17604, due to lack of consent around this in the discord discussionSolution