From e7dc1b04d1c515b01b78e0b4334ff58bc5b3cd17 Mon Sep 17 00:00:00 2001
From: Hui Wang <wanghehv@sjtu.edu.cn>
Date: Sun, 20 Feb 2022 20:59:54 +0800
Subject: [PATCH] update doc
---
docs/building.md | 2 +-
docs/git.md | 2 +-
docs/guide/animate.md | 10 +++-------
docs/guide/guide.md | 12 ++++--------
docs/guide/model.md | 8 ++------
docs/guide/render.md | 8 ++------
docs/guide/rig.md | 12 ++++--------
docs/guide/simulate.md | 8 ++------
docs/index.md | 2 +-
docs/meshedit/bevel.md | 2 +-
docs/meshedit/catmull.md | 2 +-
docs/meshedit/edge_flip.md | 2 +-
docs/meshedit/global.md | 2 +-
docs/meshedit/halfedge.md | 4 +---
docs/meshedit/linear.md | 2 +-
docs/meshedit/local.md | 2 +-
docs/meshedit/loop.md | 2 +-
docs/meshedit/overview.md | 2 +-
docs/meshedit/remesh.md | 2 +-
docs/meshedit/simplify.md | 2 +-
docs/meshedit/triangulate.md | 2 +-
21 files changed, 32 insertions(+), 58 deletions(-)
diff --git a/docs/building.md b/docs/building.md
index 78938c2..c08c4fe 100644
--- a/docs/building.md
+++ b/docs/building.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/git.md b/docs/git.md
index d5f45cf..5ea27d6 100644
--- a/docs/git.md
+++ b/docs/git.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/guide/animate.md b/docs/guide/animate.md
index 80b46f1..787f9a5 100644
--- a/docs/guide/animate.md
+++ b/docs/guide/animate.md
@@ -1,10 +1,6 @@
----
-layout: default
-title: "Animate"
-permalink: /guide/animate_mode/
-parent: User Guide
----
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+---
# Animate
When you select the Animate tab, a timeline window will show up at the bottom of your screen.
@@ -32,7 +28,7 @@ Check `Draw Splines` to visualize the spline along which objects are animated.
`Add Frames` inserts 90 empty frames into the timeline. `Crop End` deletes frames from the selected location to the end of the timeline.
### Posing
-Once you have [rigged](./rig) an object with a skeleton, it can now be posed by selecting a joint and changing its pose i.e., rotating the joint. This is called Forward Kinematics.
+Once you have [rigged](/docs/guide/rig.md) an object with a skeleton, it can now be posed by selecting a joint and changing its pose i.e., rotating the joint. This is called Forward Kinematics.
Joint poses can also be indirectly changed by using the IK (Inverse Kinematics) handles to provide target positions.
Note that IK handles need to be explicitly enabled using the checkbox.
diff --git a/docs/guide/guide.md b/docs/guide/guide.md
index 3e016ef..ca0efba 100644
--- a/docs/guide/guide.md
+++ b/docs/guide/guide.md
@@ -1,12 +1,6 @@
----
-layout: default
-title: User Guide
-permalink: /guide/
-nav_order: 4
-has_children: true
-has_toc: false
----
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+---
# User Guide
## Modes and Actions
@@ -21,6 +15,8 @@ listed below for each mode. Note that the input scheme may change depending on
the mode. For instance, key commands in `Model` mode may result in
different actions in `Render` mode.
+For the detailed documentation, see the guides of each mode: [Layout Mode](/docs/guide/layout.md), [Model Mode](/docs/guide/model.md), [Render Mode](/docs/guide/render.md), [Rigging Mode](/docs/guide/rig.md), [Animate Mode](/docs/guide/animate.md), [Simulate Mode](/docs/guide/simulate.md).
+
The current mode is displayed as the "pressed" button in the menu bar, and available actions
are are detailed in the left sidebar. Note that some actions are only available when a model/element/etc. is selected.
diff --git a/docs/guide/model.md b/docs/guide/model.md
index 1627aa6..ce2e1bd 100644
--- a/docs/guide/model.md
+++ b/docs/guide/model.md
@@ -1,10 +1,6 @@
----
-layout: default
-title: "Model"
-permalink: /guide/model_mode/
-parent: User Guide
----
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+---
# Model
When in `Model` mode, Scotty3D provides a polygon-based 3D modeler with basic
diff --git a/docs/guide/render.md b/docs/guide/render.md
index b499a8a..f738370 100644
--- a/docs/guide/render.md
+++ b/docs/guide/render.md
@@ -1,10 +1,6 @@
----
-layout: default
-title: "Render"
-permalink: /guide/render_mode/
-parent: User Guide
----
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+---
# Render
Welcome! This is Scotty3D's realistic, globally illuminated renderer, capable of creating images of complex scenes using path tracing.
diff --git a/docs/guide/rig.md b/docs/guide/rig.md
index cfbf96f..ca3e680 100644
--- a/docs/guide/rig.md
+++ b/docs/guide/rig.md
@@ -1,10 +1,6 @@
----
-layout: default
-title: "Rig"
-permalink: /guide/rigging_mode/
-parent: User Guide
----
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+---
# Rig
### Rigging Setup
@@ -29,14 +25,14 @@ Each joint has an associated `Radius` which controls the part of the mesh influ
<video src="rigging_mode/guide-rigging-2.mov" controls preload muted loop style="max-width: 100%; margin: 0 auto;"></video>
-Note that rigging only uses extents of the bone for skeleton setup, joint pose does not influence the skeleton. Once rigging is done, the object can be posed by changing joint rotations in the [animate](./animate) mode.
+Note that rigging only uses extents of the bone for skeleton setup, joint pose does not influence the skeleton. Once rigging is done, the object can be posed by changing joint rotations in the [animate](/docs/guide/animate.md) mode.
## Inverse Kinematics
Instead of computing the positions of the bones from the joint poses (forward kinematics), in inverse kinematics, joint positions are computed from target positions.
To associate a target position with a joint, select `Add IK` and edit the target position. Multiple target positions can be associated with the same joint but targets need to be explicitly enabled using the checkbox.
-In the [animate](./animate) mode, once inverse kinematics is implemented, joint rotation(pose) is updated based on the enabled IK handles.
+In the [animate](/docs/guide/animate.md) mode, once inverse kinematics is implemented, joint rotation(pose) is updated based on the enabled IK handles.
<video src="rigging_mode/guide-ik.mp4" controls preload muted loop style="max-width: 100%; margin: 0 auto;"></video>
diff --git a/docs/guide/simulate.md b/docs/guide/simulate.md
index ee13f13..abc8323 100644
--- a/docs/guide/simulate.md
+++ b/docs/guide/simulate.md
@@ -1,10 +1,6 @@
----
-layout: default
-title: "Simulate"
-permalink: /guide/simulate_mode/
-parent: User Guide
----
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+---
# Simulate
The simulation view provides a way to create and manage particle emitters.
diff --git a/docs/index.md b/docs/index.md
index 2b826c6..10d4bc4 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/meshedit/bevel.md b/docs/meshedit/bevel.md
index ae850a2..7779a0d 100644
--- a/docs/meshedit/bevel.md
+++ b/docs/meshedit/bevel.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/meshedit/catmull.md b/docs/meshedit/catmull.md
index c2a6798..a3984fd 100644
--- a/docs/meshedit/catmull.md
+++ b/docs/meshedit/catmull.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/meshedit/edge_flip.md b/docs/meshedit/edge_flip.md
index 1865648..22ea24f 100644
--- a/docs/meshedit/edge_flip.md
+++ b/docs/meshedit/edge_flip.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/meshedit/global.md b/docs/meshedit/global.md
index fb074a9..6983273 100644
--- a/docs/meshedit/global.md
+++ b/docs/meshedit/global.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/meshedit/halfedge.md b/docs/meshedit/halfedge.md
index 616d7d3..9afaa36 100644
--- a/docs/meshedit/halfedge.md
+++ b/docs/meshedit/halfedge.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
@@ -94,8 +94,6 @@ Finally, the **boundary** of the surface (e.g., the ankles and waist of a pair o
Face::is_boundary()
Halfedge::is_boundary()
-TODO: explicitly save a boundary vertices list??? https://stanford-cs248.github.io/Cardinal3D/meshedit/halfedge
-
These methods return true if and only if the element is associated with a boundary face. Boundary faces are stored in the usual face list, i.e., they will show up when iterating over faces. You can disambiguate faces and boundaries using the above tests.
The figure below should help to further explain the behavior of `Halfedge_Mesh` for surfaces with boundary:
diff --git a/docs/meshedit/linear.md b/docs/meshedit/linear.md
index cc0258c..686d0bb 100644
--- a/docs/meshedit/linear.md
+++ b/docs/meshedit/linear.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/meshedit/local.md b/docs/meshedit/local.md
index 6f84671..31ce7bd 100644
--- a/docs/meshedit/local.md
+++ b/docs/meshedit/local.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/meshedit/loop.md b/docs/meshedit/loop.md
index bdea414..c674128 100644
--- a/docs/meshedit/loop.md
+++ b/docs/meshedit/loop.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/meshedit/overview.md b/docs/meshedit/overview.md
index 271bbcd..ecad003 100644
--- a/docs/meshedit/overview.md
+++ b/docs/meshedit/overview.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/meshedit/remesh.md b/docs/meshedit/remesh.md
index bd5f340..8155f7a 100644
--- a/docs/meshedit/remesh.md
+++ b/docs/meshedit/remesh.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/meshedit/simplify.md b/docs/meshedit/simplify.md
index 7416599..155621b 100644
--- a/docs/meshedit/simplify.md
+++ b/docs/meshedit/simplify.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
diff --git a/docs/meshedit/triangulate.md b/docs/meshedit/triangulate.md
index 99342fb..24bdbb7 100644
--- a/docs/meshedit/triangulate.md
+++ b/docs/meshedit/triangulate.md
@@ -1,4 +1,4 @@
-[[Home]](/docs/index.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
+[[Home]](/docs/index.md) [[User Guide]](/docs/guide/guide.md) [[Mesh Edit]](/docs/meshedit/overview.md) [[Path Tracer]](/docs/pathtracer/overview.md) [[Animation]](/docs/animation/overview.md)
---
--
GitLab