Overhaul Transform2D documentation #94127
Merged
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
Mickeon
commented
Jul 9, 2024
| @@ -4,8 +4,10 @@ | |||
| A 2×3 matrix representing a 2D transformation. | |||
| </brief_description> | |||
| <description> | |||
| A 2×3 matrix (2 rows, 3 columns) used for 2D linear transformations. It can represent transformations such as translation, rotation, and scaling. It consists of three [Vector2] values: [member x], [member y], and the [member origin]. | |||
| The [Transform2D] built-in [Variant] type is a 2×3 [url=https://en.wikipedia.org/wiki/Matrix_(mathematics)]matrix[/url] representing a transformation in 2D space. It contains three [Vector2] values: [member x], [member y], and [member origin]. Together, they can represent translation, rotation, scale, and skew. | |||
| The [member x] and [member y] axes form a 2×2 matrix, known as the transform's [b]basis[/b]. The length of each axis ([method Vector2.length]) influences the transform's scale, while the direction of all axes influence the rotation. Usually, both axes are perpendicular to one another. However, when you rotate one axis individually, the transform becomes skewed. Applying a skewed transform to a 2D sprite will make the sprite appear distorted. | |||
There was a problem hiding this comment.
Alternative take which resembles Basis's equivalent description:
Suggested change
| The [member x] and [member y] axes form a 2×2 matrix, known as the transform's [b]basis[/b]. The length of each axis ([method Vector2.length]) influences the transform's scale, while the direction of all axes influence the rotation. Usually, both axes are perpendicular to one another. However, when you rotate one axis individually, the transform becomes skewed. Applying a skewed transform to a 2D sprite will make the sprite appear distorted. | |
| The [Transform2D]'s basis is composed by 2 axis vectors, each representing a column of the matrix: [member x] and [member y]. The length of each axis ([method Vector2.length]) influences the basis's scale, while the direction of all axes influence the rotation. Usually, these axes are perpendicular to one another. However, when you rotate any axis individually, the basis becomes skewed. Applying a skewed basis to a 2D sprite will make the sprite appear distorted. | |
mhilbrunner
reviewed
Jul 9, 2024
mhilbrunner
reviewed
Jul 9, 2024
mhilbrunner
reviewed
Jul 9, 2024
Mickeon
force-pushed
the
doc-peeves-transform2d
branch
from
add59fd to
891703e
Compare
|
Thanks! |
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.
Continuation of #87334 but on the 2D side.
This PR aims to overhaul the Transform2D type's documentation.
The reasoning and changelog are extremely similar to the "Overhaul Basis documentation" PR, so I'm not sure I should bother repeating them twice.
A lot of wording is ripped straight from Transform3D and Basis's descriptions, with a few exceptions:
basis_xform_invwas reworded quite a bit because it was very, very awkward.