feat: Add common matrix functions to standard library #1538
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
keenancrane
changed the title
± Registry diff📊 PerformanceKeyNote that each bar component rounds up to the nearest 100ms, so each full bar is an overestimate by up to 400ms. If a row has only one bar instead of four, that means it's not a trio and the bar just shows the total time spent for that example, again rounded up to the nearest 100ms. Data |
Deploying with
|
| Latest commit: |
d671bde
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e35e5e41.penrose-72l.pages.dev |
| Branch Preview URL: | https://matrix-library.penrose-72l.pages.dev |
2 tasks
…nto matrix-library
add warning box around matrix indexing note
wodeni
requested changes
Aug 4, 2023
There was a problem hiding this comment.
Thanks for adding these functions and the great examples @keenancrane! Really appreciated the effort to document and test them. I'm sure they will enable many more diagrams soon!
I pushed one commit to tweak the documentation, and have some questions about vouter and error-handling. Hoping you can explain the former and @liangyiliang can possibly confirm the latter.
|
@wodeni I believe I've fixed your requested changes, and also updated the vim highlighting files with my local ones (the ones in the repo were long out of date…). Let me know if there's anything else! |
wodeni
approved these changes
Aug 4, 2023
2 tasks
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.
This PR adds common matrix functions, including 2D/3D transformations and camera matrices, to the library. It also adds corresponding documentation, tests and examples, and a language feature
thenfor left-to-right composition of transformations.New functions
New functions added to
Functions.tsare listed below. See the newVectors and Matricespage in the Documentation, as well as the generated Function Library documentation, for further details. (Design decisions for the naming conventions are also spelled out int his documentation.)fromHomogeneousfromHomogeneousListtoHomogeneoustoHomogeneousListtoHomogeneousMatrixrotatescaleskewsheartranslaterotate2dscale2dskew2dshear2drotate3dscale3dshear3drotate3dhscale3dhsheartranslate3dhlookAtperspectiveorthoprojectprojectDepthprojectListmatrixMultiplyListNew language features
This PR adds the
thenkeyword to the Style parser/compiler. This keyword is equivalent to the*operator, except that it reverses the order of the arguments, i.e.,A then Bis equilvalent toB * A. The main use case, as highlighted in the documentation, is to compose transformations in "natural language order", i.e., left to right. For instance, just as one can say "flip it over and put it in the oven" to mean "flip first, put in oven second," one can also writeTests and examples
The
triangle-mesh-3dexample has been updated to use the new 3D transformations and camera matrices.A new example,
dinoshade, has also been added, with an extensive README that serves as a "Style for OpenGL Programmers" guide.All the new matrix functions come with a suite of corresponding tests, in the
examples/matrix-library/. These examples use the "red/green" testing paradigm, as explained inexamples/matrix-library/README.md. The particular tests arecrossProductMatrix.trio.jsondiagonal2d.trio.jsondiagonal3d.trio.jsonidentity2d.trio.jsonidentity3d.trio.jsoninverse2d.trio.jsoninverse3d.trio.jsonmatrix2d.trio.jsonmatrix3d.trio.jsonouterProduct2d.trio.jsonouterProduct3d.trio.jsonrotate.trio.jsonrotate2d.trio.jsonrotate3d.trio.jsonrotate3dh.trio.jsonscale2d.trio.jsonscale3d.trio.jsonshear2d.trio.jsonshear3d.trio.jsonskew2d.trio.jsontranslate2d.trio.jsontranslate3dh.trio.jsonDocumentation
As noted above, extensive documentation for new functionality has been added in
Vectors and Matricespage of the documentation, which has also refactored documentation on vector/matrix types and operations from the Style Usage page, anddinoshadeexample, which provides a step-by-step tutorial on usage of 3d transformation and camera matrices.