Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding R3F code examples to docs #41

Open
austinpapritz opened this issue Jun 10, 2024 · 7 comments
Open

Adding R3F code examples to docs #41

austinpapritz opened this issue Jun 10, 2024 · 7 comments

Comments

@austinpapritz
Copy link

I'm planning on going through the R3F code examples for uses of maath and adding them to the docs here.

@austinpapritz
Copy link
Author

austinpapritz commented Jun 15, 2024

A lot of easing, but only a few other examples. Is there a way to search the dependent repos list down to which functions are used so that I can try to find other examples? Here's what I have so far.

Buffer

  • toVectorArray
  • swizzleBuffer
  • addAxis
  • lerpBuffers

Easing

Geometry

Matrix

  • determinant2
  • determinant3
  • determinant4
  • getMinor

Misc

  • clamp
  • repeat
  • deltaAngle
  • degToRad
  • radToDeg
  • vectorEquals
  • lexicographic
  • convexHull
  • remap

Random

@suggoooiii
Copy link

you have a pretty good list here, maybe we can stat by listing the functions that don't have examples

@austinpapritz
Copy link
Author

you have a pretty good list here, maybe we can stat by listing the functions that don't have examples

Thanks! Great suggestion, I updated the list with what is missing.

@suggoooiii
Copy link

suggoooiii commented Jul 5, 2024

let's try and make our own examples for everything that's missing, i think that would be amazing.
im down if you are 👀

@austinpapritz
Copy link
Author

austinpapritz commented Jul 6, 2024

let's try and make our own examples for everything that's missing, i think that would be amazing. im down if you are 👀

I think that something like that would be a great way to improve the docs. I might have time to help out. Like the easing function should probably be demonstrated by having the same motion used for each to really show the difference. Are you thinking of making a bunch of smaller barebones projects or making one big demonstration? Some of the stuff I don't even understand when you would use it, like many of the buffer functions. What did you have in mind?

@suggoooiii
Copy link

yeah i don't understand some of the stuff either but we'll figure it out at the end i'm pretty sure.
Yeah i was actually thinking of making smaller projects for each missing eample through codesandbox

@austinpapritz
Copy link
Author

Maybe easier than a whole project, creating a simple graphic like this for the easing functions might better show the differences.
https://www.youtube.com/shorts/I9E2H83FnGs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants