f3d icon indicating copy to clipboard operation
f3d copied to clipboard

Add dedicated animation documentation

Open kathleenhang opened this issue 1 year ago • 6 comments

Closes #1258

I wrote a draft for the improved animation documentation which consists of:

  • demonstration example
  • command line options
  • hotkey interactions
  • supported file types
  • time units

I used InterpolationTest.glb for the example since it was personally the most helpful animation file for me to better understand how animations work in F3D. Being new to 3D graphics, the idea of multiple animation sequences attached to one model was quite confusing for me at first.

This file is currently only available for F3D developers to download. I wonder if F3D can have an official download link for regular F3D users? That way, they can load up a good example of an animation-supported file and play around with it to better understand animation capability within F3D.

Currently, it seems most of the available example model files do not clearly demonstrate much of the animation aspect.

Feedback appreciated!

kathleenhang avatar May 08 '24 01:05 kathleenhang

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.57%. Comparing base (9992753) to head (cd4741d). Report is 4 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1423      +/-   ##
==========================================
+ Coverage   96.55%   96.57%   +0.01%     
==========================================
  Files         103      103              
  Lines        7555     7679     +124     
==========================================
+ Hits         7295     7416     +121     
- Misses        260      263       +3     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar May 15 '24 23:05 codecov[bot]

Okay fixed! How about the demonstration images? Are those good? I was planning to redo it with consistent image dimensions. The current one is a quick draft.

kathleenhang avatar May 15 '24 23:05 kathleenhang

Okay fixed! How about the demonstration images? Are those good? I was planning to redo it with consistent image dimensions. The current one is a quick draft.

I did not check yes, could you add clickable links in the description :)

mwestphal avatar May 16 '24 07:05 mwestphal

Okay fixed! How about the demonstration images? Are those good? I was planning to redo it with consistent image dimensions. The current one is a quick draft.

I did not check yes, could you add clickable links in the description :)

Here is the link to the images: https://github.com/f3d-app/f3d/blob/47b4d0629adc853e34071e469a95dd7cb0737a61/doc/user/ANIMATIONS.md

Are you able to see this? I am not sure if it is private. Here is another link that may work too: https://raw.githubusercontent.com/f3d-app/f3d/47b4d0629adc853e34071e469a95dd7cb0737a61/doc/user/ANIMATIONS.md

kathleenhang avatar May 16 '24 22:05 kathleenhang

Are you able to see this?

Indeed, it works!

And indeed, we should generate cleaner screenshots :)

mwestphal avatar May 17 '24 12:05 mwestphal

Thanks for the feedback! I just updated the screenshots and the introduction.

kathleenhang avatar May 17 '24 21:05 kathleenhang

could you share these new screenshots ?

mwestphal avatar May 25 '24 07:05 mwestphal

https://github.com/f3d-app/f3d/blob/cd4741db840f1c26b6be56566ade45e00c0bd438/doc/user/ANIMATIONS.md looks great!

mwestphal avatar May 25 '24 07:05 mwestphal

superseeded by https://github.com/f3d-app/f3d/pull/1481

mwestphal avatar Jun 22 '24 16:06 mwestphal