Deploying to gh-pages from @ ab6a691 🚀

README.md

@@ -38,7 +38,7 @@ f3d /path/to/file.ext
 
 Optionally, append `--output=/path/to/img.png` to save the rendering into an image file.
 
-See the [Quickstart Guide](QUICKSTART.md) for more information about getting started with F3D.
+See the [Quickstart Guide](doc/user/QUICKSTART.md) for more information about getting started with F3D.
 
 # Documentation
 

doc/user/PLUGINS.md

@@ -48,4 +48,4 @@ Here is how the plugins are searched (in preceding order):
 
 You can also try plugins maintained by the community. If you have created a plugin and would like it to be listed here, please submit a pull request.
 
-- **Abaqus**: ODB support by @YangShen398 ([repository](https://github.com/YangShen398/F3D-ODB-Reader-Plugin))
+- **Abaqus**: ODB support by @YangShen398 ([repository](https://github.com/YangShen398/F3D-ODB-Reader-Plugin))

doc/user/QUICKSTART.html

@@ -2,4 +2,4 @@
 </code></pre></div></div> <p>Optionally, you can also save the rendering into an image file:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>f3d /path/to/file.ext --output=/path/to/img.png
 </code></pre></div></div> <p>If you need help, specify the <code class="language-plaintext highlighter-rouge">--help</code> <a href="/doc/user/OPTIONS.html">option</a>:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>f3d --help
 man f3d # Linux only
-</code></pre></div></div> <p>Once you’ve opened your file in F3D, you’re all set to start visualizing! Press <kbd>H</kbd> to open a list of shortcuts to help you interact with your scene.</p> <p>See the <a href="/doc/user/SUPPORTED_FORMATS.html">supported file formats</a> page for the full list of file types that F3D can open.</p> <h2 id="constructing-scenes"> <a href="#constructing-scenes" class="anchor-heading" aria-labelledby="constructing-scenes"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Constructing scenes </h2> <p>For most file formats, F3D constructs <strong>a default scene</strong>, loading only the <em>geometry</em> from the file.</p> <p>However, formats supporting <strong>full scenes</strong> will automatically load additional scene properties including <em>lights</em>, <em>cameras</em>, <em>actors</em> and <em>texture</em>.</p> <p>If you’d like to disable these properties, you can specify the <code class="language-plaintext highlighter-rouge">--geometry-only</code> <a href="/doc/user/OPTIONS.html">option</a> from the command line to construct a default scene instead.</p> <p>See the table of <a href="/doc/user/SUPPORTED_FORMATS.html">supported file formats</a> if you’re unsure about what kind of scene your file supports.</p> <h2 id="interacting-with-your-scene"> <a href="#interacting-with-your-scene" class="anchor-heading" aria-labelledby="interacting-with-your-scene"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Interacting with your scene </h2> <p>Once you’ve loaded your scene in F3D, you can interact with it by using your mouse and certain hotkeys.</p> <h3 id="moving-the-camera"> <a href="#moving-the-camera" class="anchor-heading" aria-labelledby="moving-the-camera"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Moving the camera </h3> <ul> <li><em>Click and drag</em> with the <em>left</em> mouse button to <strong>rotate</strong> around the focal point of the camera.</li> <li><em>Click and drag</em> vertically with the <em>right</em> mouse button <u>OR</u> <em>move the mouse wheel</em> to <strong>zoom in/out</strong>.</li> <li><em>Click and drag</em> with the <em>middle</em> mouse button to <strong>translate</strong> the camera.</li> </ul> <h3 id="other-shortcuts"> <a href="#other-shortcuts" class="anchor-heading" aria-labelledby="other-shortcuts"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Other shortcuts </h3> <ul> <li>Press <kbd>Enter</kbd> to reset the camera.</li> <li>Press <kbd>Space</kbd> to play animation, if any.</li> <li>Press <kbd>G</kbd> to toggle the horizontal grid.</li> <li>Press <kbd>H</kbd> to display a cheatsheet of hotkey interactions.</li> </ul> <p>For more information, see the <a href="/doc/user/INTERACTIONS.html">Interactions</a> page.</p> <h2 id="playing-animations"> <a href="#playing-animations" class="anchor-heading" aria-labelledby="playing-animations"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Playing animations </h2> <p>F3D can play <a href="/doc/user/ANIMATIONS.html">animations</a> for any <a href="/doc/user/SUPPORTED_FORMATS.html">supported files</a> that contain them.</p> <p>With your file loaded into F3D, press the <kbd>W</kbd> hotkey to cycle through available animations. Then, press <kbd>Space</kbd> to play your selected animation.</p> <p>Alternatively, you can use the command line to play animations. Use the <code class="language-plaintext highlighter-rouge">--animation-index</code> <a href="/doc/user/OPTIONS.html">option</a> to specify which animation you want to play. To play all animations at once, use <code class="language-plaintext highlighter-rouge">--animation-index=-1</code> (<code class="language-plaintext highlighter-rouge">.gltf</code>/<code class="language-plaintext highlighter-rouge">.glb</code> only).</p> <p>For more information, see the <a href="/doc/user/ANIMATIONS.html">Animations</a> page.</p> <h2 id="further-reading"> <a href="#further-reading" class="anchor-heading" aria-labelledby="further-reading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Further Reading </h2> <ul> <li><a href="/doc/user/OPTIONS.html">A list of all F3D command-line options.</a></li> <li><a href="INTERACTIONS.MD">How to interact with scenes in F3D.</a></li> <li><a href="/doc/user/ANIMATIONS.html">How to play animations in F3D.</a></li> <li><a href="/doc/user/COLOR_MAPS.html">How to specify colormaps in F3D.</a></li> <li><a href="/doc/user/PLUGINS.html">How to configure plugins in F3D.</a></li> <li><a href="/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html">Limitations and how to troubleshoot F3D.</a></li> </ul> </main> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
+</code></pre></div></div> <p>Once you’ve opened your file in F3D, you’re all set to start visualizing! Press <kbd>H</kbd> to open a list of shortcuts to help you interact with your scene.</p> <p>See the <a href="/doc/user/SUPPORTED_FORMATS.html">supported file formats</a> page for the full list of file types that F3D can open.</p> <h2 id="constructing-scenes"> <a href="#constructing-scenes" class="anchor-heading" aria-labelledby="constructing-scenes"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Constructing scenes </h2> <p>Certain <a href="/doc/user/SUPPORTED_FORMATS.html">formats</a> are listed as <strong>full scene</strong> formats (.gltf/.glb, .3ds, .wrl, .obj, .fbx, .dae, .off, .x, .3mf, .usd) which means these files contain not only <em>geometry</em> but also some scene information like <em>lights</em>, <em>cameras</em>, <em>actors</em> in the scene, as well as <em>texture</em> properties. By default, all this information will be loaded from the file and displayed. For file formats that are not <strong>full scene</strong>, <strong>a default scene</strong> is created.</p> <p>For <strong>default scene</strong> formats, certain default values are set automatically:</p> <ul> <li>texture-*: “”</li> <li>line-width: 1.0</li> <li>point-size: 10.0</li> <li>opacity: 1.0</li> <li>color: 1.0, 1.0, 1.0</li> <li>emissive-factor: 1.0, 1.0, 1.0</li> <li>normal-scale: 1.0</li> <li>metallic: 0.0</li> <li>roughness: 0.3</li> </ul> <p>They will be overridden when using corresponding <a href="/doc/user/OPTIONS.html">options</a>.</p> <h2 id="interacting-with-your-scene"> <a href="#interacting-with-your-scene" class="anchor-heading" aria-labelledby="interacting-with-your-scene"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Interacting with your scene </h2> <p>Once you’ve loaded your scene in F3D, you can interact with it by using your mouse and certain hotkeys.</p> <h3 id="moving-the-camera"> <a href="#moving-the-camera" class="anchor-heading" aria-labelledby="moving-the-camera"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Moving the camera </h3> <ul> <li><em>Click and drag</em> with the <em>left</em> mouse button to <strong>rotate</strong> around the focal point of the camera.</li> <li><em>Click and drag</em> vertically with the <em>right</em> mouse button <u>OR</u> <em>move the mouse wheel</em> to <strong>zoom in/out</strong>.</li> <li><em>Click and drag</em> with the <em>middle</em> mouse button to <strong>translate</strong> the camera.</li> </ul> <h3 id="other-shortcuts"> <a href="#other-shortcuts" class="anchor-heading" aria-labelledby="other-shortcuts"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Other shortcuts </h3> <ul> <li>Press <kbd>Enter</kbd> to reset the camera.</li> <li>Press <kbd>Space</kbd> to play animation, if any.</li> <li>Press <kbd>G</kbd> to toggle the horizontal grid.</li> <li>Press <kbd>H</kbd> to display a cheatsheet of hotkey interactions.</li> </ul> <p>For more information, see the <a href="/doc/user/INTERACTIONS.html">Interactions</a> page.</p> <h2 id="playing-animations"> <a href="#playing-animations" class="anchor-heading" aria-labelledby="playing-animations"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Playing animations </h2> <p>F3D can play <a href="/doc/user/ANIMATIONS.html">animations</a> for any <a href="/doc/user/SUPPORTED_FORMATS.html">supported files</a> that contain them.</p> <p>With your file loaded into F3D, press the <kbd>W</kbd> hotkey to cycle through available animations. Then, press <kbd>Space</kbd> to play your selected animation.</p> <p>Alternatively, you can use the command line to play animations. Use the <code class="language-plaintext highlighter-rouge">--animation-index</code> <a href="/doc/user/OPTIONS.html">option</a> to specify which animation you want to play. To play all animations at once, use <code class="language-plaintext highlighter-rouge">--animation-index=-1</code> (<code class="language-plaintext highlighter-rouge">.gltf</code>/<code class="language-plaintext highlighter-rouge">.glb</code> only).</p> <p>For more information, see the <a href="/doc/user/ANIMATIONS.html">Animations</a> page.</p> <h2 id="further-reading"> <a href="#further-reading" class="anchor-heading" aria-labelledby="further-reading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Further Reading </h2> <ul> <li><a href="/doc/user/OPTIONS.html">A list of all F3D command-line options.</a></li> <li><a href="INTERACTIONS.MD">How to interact with scenes in F3D.</a></li> <li><a href="/doc/user/ANIMATIONS.html">How to play animations in F3D.</a></li> <li><a href="/doc/user/COLOR_MAPS.html">How to specify colormaps in F3D.</a></li> <li><a href="/doc/user/PLUGINS.html">How to configure plugins in F3D.</a></li> <li><a href="/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html">Limitations and how to troubleshoot F3D.</a></li> </ul> </main> </div> </div> <div class="search-overlay"></div> </div> </body> </html>

doc/user/QUICKSTART.md

@@ -35,23 +35,33 @@ f3d --help
 man f3d # Linux only
 ```
 
-Once you've opened your file in F3D, you're all set to start visualizing! Press <kbd>H</kbd> to open a list of shortcuts to help you interact with your scene. 
+Once you've opened your file in F3D, you're all set to start visualizing! Press <kbd>H</kbd> to open a list of shortcuts to help you interact with your scene.
 
 See the [supported file formats](SUPPORTED_FORMATS.md) page for the full list of file types that F3D can open.
 
 ## Constructing scenes
 
-For most file formats, F3D constructs **a default scene**, loading only the *geometry* from the file.
+Certain [formats](SUPPORTED_FORMATS.md) are listed as **full scene** formats (.gltf/.glb, .3ds, .wrl, .obj, .fbx, .dae, .off, .x, .3mf, .usd)
+which means these files contain not only *geometry* but also some scene information like *lights*, *cameras*, *actors* in the scene,
+as well as *texture* properties. By default, all this information will be loaded from the file and displayed.
+For file formats that are not **full scene**, **a default scene** is created.
 
-However, formats supporting **full scenes** will automatically load additional scene properties including *lights*, *cameras*, *actors* and *texture*.
+For **default scene** formats, certain default values are set automatically:
+ - texture-*: ""
+ - line-width: 1.0
+ - point-size: 10.0
+ - opacity: 1.0
+ - color: 1.0, 1.0, 1.0
+ - emissive-factor: 1.0, 1.0, 1.0
+ - normal-scale: 1.0
+ - metallic: 0.0
+ - roughness: 0.3
 
-If you'd like to disable these properties, you can specify the `--geometry-only` [option](OPTIONS.md) from the command line to construct a default scene instead.
-
-See the table of [supported file formats](SUPPORTED_FORMATS.md) if you're unsure about what kind of scene your file supports.
+They will be overridden when using corresponding [options](OPTIONS.md).
 
 ## Interacting with your scene
 
-Once you've loaded your scene in F3D, you can interact with it by using your mouse and certain hotkeys. 
+Once you've loaded your scene in F3D, you can interact with it by using your mouse and certain hotkeys.
 
 ### Moving the camera
 
@@ -63,17 +73,17 @@ Once you've loaded your scene in F3D, you can interact with it by using your mou
 * Press <kbd>Enter</kbd> to reset the camera.
 * Press <kbd>Space</kbd> to play animation, if any.
 * Press <kbd>G</kbd> to toggle the horizontal grid.
-* Press <kbd>H</kbd> to display a cheatsheet of hotkey interactions. 
+* Press <kbd>H</kbd> to display a cheatsheet of hotkey interactions.
 
 For more information, see the [Interactions](INTERACTIONS.md) page.
 
 ## Playing animations
 
 F3D can play [animations](ANIMATIONS.md) for any [supported files](SUPPORTED_FORMATS.md) that contain them.
 
-With your file loaded into F3D, press the <kbd>W</kbd> hotkey to cycle through available animations. Then, press <kbd>Space</kbd> to play your selected animation. 
+With your file loaded into F3D, press the <kbd>W</kbd> hotkey to cycle through available animations. Then, press <kbd>Space</kbd> to play your selected animation.
 
-Alternatively, you can use the command line to play animations. Use the `--animation-index` [option](OPTIONS.md) to specify which animation you want to play. To play all animations at once, use `--animation-index=-1` (`.gltf`/`.glb` only). 
+Alternatively, you can use the command line to play animations. Use the `--animation-index` [option](OPTIONS.md) to specify which animation you want to play. To play all animations at once, use `--animation-index=-1` (`.gltf`/`.glb` only).
 
 For more information, see the [Animations](ANIMATIONS.md) page.
 

doc/user/SUPPORTED_FORMATS.md

@@ -29,7 +29,7 @@ F3D supports the following file formats:
 | Drawing Exchange Format | `.dxf` | Full | | `assimp` |
 | DirectX | `.x` | Full | Yes | `assimp` |
 | 3D Manufacturing Format | `.3mf` | Full | | `assimp` |
-| Universal Scene Description | `.usd` | Full | Yes | `usd` |
+| Universal Scene Description | `.usd`, `.usda`, `.usdc`, `.usdz` | Full | Yes | `usd` |
 | VDB | `.vdb` | Default | | `vdb` |
 
-\***Note:** As of version 2.5.0, F3D support for VDB is still experimental.
+\***Note:** As of version 2.5.0, F3D support for VDB is still experimental.