Deploying to gh-pages from @ 91460f8 🚀

f3d-app · Jun 23, 2024 · 3943f86 · 3943f86
1 parent 373174c
commit 3943f86
Show file tree

Hide file tree

Showing 37 changed files with 94 additions and 42 deletions.
diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html
diff --git a/LICENSE.html b/LICENSE.html
diff --git a/_licenses.html b/_licenses.html
diff --git a/assets/js/search-data.json b/assets/js/search-data.json
diff --git a/doc/CHANGELOG.html b/doc/CHANGELOG.html
diff --git a/doc/GALLERY.html b/doc/GALLERY.html
diff --git a/doc/THIRD_PARTY_LICENSES.html b/doc/THIRD_PARTY_LICENSES.html
diff --git a/doc/dev/BUILD.html b/doc/dev/BUILD.html
diff --git a/doc/dev/BUILD_WASM.html b/doc/dev/BUILD_WASM.html
diff --git a/doc/dev/CODING_STYLE.html b/doc/dev/CODING_STYLE.html
diff --git a/doc/dev/GENERATE.html b/doc/dev/GENERATE.html
diff --git a/doc/dev/GETTING_STARTED.html b/doc/dev/GETTING_STARTED.html
diff --git a/doc/dev/GOVERNANCE.html b/doc/dev/GOVERNANCE.html
diff --git a/doc/dev/MAINTAINERS.html b/doc/dev/MAINTAINERS.html
diff --git a/doc/dev/README_DEV.html b/doc/dev/README_DEV.html
diff --git a/doc/dev/ROADMAPS_AND_RELEASES.html b/doc/dev/ROADMAPS_AND_RELEASES.html
diff --git a/doc/dev/TESTING.html b/doc/dev/TESTING.html
diff --git a/doc/libf3d/BINDINGS.html b/doc/libf3d/BINDINGS.html
diff --git a/doc/libf3d/CLASSES.html b/doc/libf3d/CLASSES.html
diff --git a/doc/libf3d/OPTIONS.html b/doc/libf3d/OPTIONS.html
diff --git a/doc/libf3d/OVERVIEW.html b/doc/libf3d/OVERVIEW.html
diff --git a/doc/libf3d/PLUGINS.html b/doc/libf3d/PLUGINS.html
diff --git a/doc/libf3d/README_LIBF3D.html b/doc/libf3d/README_LIBF3D.html
diff --git a/doc/user/ANIMATIONS.html b/doc/user/ANIMATIONS.html
diff --git a/doc/user/ANIMATIONS.md b/doc/user/ANIMATIONS.md
@@ -0,0 +1,43 @@
+# Animations
+
+F3D is able to play animations for any files which contain them.
+Play them either interactively or by selecting a specific time to display.
+For files containing multiple animations, F3D allows the user to either play each animation separately or play all animations at the same time.
+
+## Demonstration
+This specific example uses an animation file which can be downloaded [here](https://github.com/f3d-app/f3d/blob/606089959c9520085a9cbf70660fb0ffc68fb934/testing/data/InterpolationTest.glb).
+
+<img width="1024" alt="1" src="https://media.githubusercontent.com/media/f3d-app/f3d-media/main/media/animation_0.png">
+
+Load the example animation file shown above by executing within command line: `f3d InterpolationTest.glb`
+
+<img width="1024" alt="2" src="https://media.githubusercontent.com/media/f3d-app/f3d-media/main/media/animation_1.png">
+To view current animation name, press <kbd>H</kbd> to open up cheatsheet menu
+
+<img width="1024" alt="3" src="https://media.githubusercontent.com/media/f3d-app/f3d-media/main/media/animation_2.png">
+Press <kbd>W</kbd> to cycle through available animations
+
+<img width="1024" alt="4" src="https://media.githubusercontent.com/media/f3d-app/f3d-media/main/media/animation_3.png">
+Press <kbd>space</kbd> to play/pause current animation.
+Note: A red bar runs along the bottom of screen to indicate the current time interval of the animation sequence.
+
+<img width="1024" alt="5" src="https://media.githubusercontent.com/media/f3d-app/f3d-media/main/media/animation_4.png">
+"All Animations" will play all animations at the same time.
+
+## Command line options
+
+F3D animation behavior can be fully controlled from the command line using the following options.
+
+| Options                      | Default             | Description                                    |
+| ---------------------------- | ------------------- | ---------------------------------------------- |
+| \-\-animation\-index         |                     | Select the animation to play.                  |
+| \-\-animation\-index=-1      |                     | Play all animations at once (.gltf/.glb only). |
+| \-\-animation\-speed\-factor | Time Unit = Seconds | Adjust time unit.                              |
+| \-\-animation\-frame\-rate   | 60 FPS              | Adjust animation frame rate.                   |
+
+## Animation Interactions
+- Press <kbd>W</kbd> to cycle through animations
+- Press <kbd>Space</kbd> to play/pause animation
+
+## Time Units
+- When F3D plays an animation, it assumes the time unit is in seconds to show accurate speed of animation.
diff --git a/doc/user/COLOR_MAPS.html b/doc/user/COLOR_MAPS.html
diff --git a/doc/user/CONFIGURATION_FILE.html b/doc/user/CONFIGURATION_FILE.html
diff --git a/doc/user/DESKTOP_INTEGRATION.html b/doc/user/DESKTOP_INTEGRATION.html
diff --git a/doc/user/INSTALLATION.html b/doc/user/INSTALLATION.html
diff --git a/doc/user/INTERACTIONS.html b/doc/user/INTERACTIONS.html
diff --git a/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html b/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html
diff --git a/doc/user/OPTIONS.html b/doc/user/OPTIONS.html
diff --git a/doc/user/README_USER.html b/doc/user/README_USER.html
diff --git a/doc/user/README_USER.md b/doc/user/README_USER.md
@@ -4,6 +4,7 @@
 - [How to install F3D.](INSTALLATION.md)
 - [List of all F3D command line options.](OPTIONS.md)
 - [The different interactions in F3D.](INTERACTIONS.md)
+- [How to use animations in F3D.](ANIMATIONS.md)
 - [How to use colormaps in F3D.](COLOR_MAPS.md)
 - [How to configure F3D using a configuration file.](CONFIGURATION_FILE.md)
 - [How to integrate F3D in your desktop.](DESKTOP_INTEGRATION.md)

diff --git a/doc/user/USAGE.html b/doc/user/USAGE.html
diff --git a/index.html b/index.html
diff --git a/resources/colormaps/licenses.html b/resources/colormaps/licenses.html