Add interface overview docs

docs/for_developers.rst

@@ -0,0 +1,9 @@
+For Developers
+==================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   :glob:
+
+   builds

docs/get_started.rst

@@ -0,0 +1,10 @@
+Getting Started
+==================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   :glob:
+
+   interface/*
+   shortcuts

docs/index.rst

@@ -3,15 +3,16 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to dust3d's documentation!
+Dust3D Reference Guide
 ==================================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
+   :glob:
    
-   builds
-   shortcuts
+   get_started
+   for_developers
 
 Indices and tables
 ==================

docs/interface/interface.rst

@@ -0,0 +1,37 @@
+Dust3D Interface Overview
+-------------------------
+
+.. image:: https://raw.githubusercontent.com/huxingyi/dust3d/master/docs/interface/interface.png
+
+1. Tool Box
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The Tool Box contains tools that you use to undo steps, switch the document edit mode, and toggle the XYZ-axis lock.
+
+2. Document Title
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can have multiple windows, the document title shows what version of Dust3D you are using and the full path of the openned Dust3D document, if the document have unsaved changes, there will be a star(*) right after the path.
+
+3. Parts List
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Part is a very important edit unit of Dust3D. A part consists of connected nodes in the canvas. If you cut the edge of two nodes, the one part would be divided to two seperate parts.
+Parts List shows all the parts's rendered thumbnail, and current edit states. You can click the mini buttons around the parts thumbnail to toggle the settings.
+
+4. Rendered Model
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Rendered Model shows current generated mesh. Anytime, if there is a change would affect the mesh generation, the mesh would be generated automatically in realtime, and get rendered to Rendered Model after generated.
+You can use mouse Middle Button plus Shift key to rotate and move the Rendered Model. It's floating above the canvas.
+
+5. Main Profile
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Every time you add a new node to canvas, there will be two items shows, the first one is the item you places, the second one is the automatically generated item for the same node but with different profile.
+If you add a seperate node, which means it dosen't connect with other nodes, the node is in main profile, otherwise it depends on the profile of the node you add from.
+
+6. Side Profile
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+See Main Profile for explaining.

docs/interface/menubar.rst

@@ -0,0 +1,132 @@
+Menu Bar
+-------------
+
+File
+========
+
+New Window
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Each window is a seperate Dust3D Document. You can create a new window from here.
+
+New
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Delete all content in the current window and get ready for your new Dust3D Document in the same window.
+
+Open...
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Open a Dust3D Document, especially a file with extension(.ds3)
+
+Save
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Save current Dust3D Document.
+
+Save As...
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Same as Save except ask you provider a new save path.
+
+Save All
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Save all openned window.
+
+Export...
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Export current generated model mesh as Wavefront file format(.obj)
+
+Change Turnaround...
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Change the canvas background image, usually should be a turnaround reference sheet which has at least two profile showed.
+
+Edit
+================
+
+Add...
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Swith to edit mode, get ready to add node.
+
+Undo
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Recover the last Document Snapshot from Undo Stack.
+
+Redo
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Reverse of Undo.
+
+Delete
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Delete selected nodes from canvas.
+
+Break
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Break selected edges, insert a new node in the middle of the edge.
+
+Connect
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Connect selected two nodes.
+
+Cut
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Copy then Delete selected nodes.
+
+Copy
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Copy selected nodes.
+
+Paste
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Paste nodes from Clipboard.
+
+H Flip
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Flip selected nodes horizontally.
+
+V Flip
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Flip selected nodes vertically.
+
+Align to Center
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Align selected nodes vertically with center anchor. Normally, the center anchor(a Triangle) is not show up, you can turn on the Part Mirror to make it visible, then turn Part Mirror off, the centor anchor would not gone once showed.
+
+Select All
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Select all nodes. Each node have two profile items, only main profile get selected.
+
+Select Part
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Select all nodes which sit in the same part with the hovered or checked node.
+
+Unselect All
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Unselect all nodes.
+
+View
+=====
+
+Show Model
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Usually, you will no need to use this, because the Rendered Model always show. But if you can not find the Rendered Model and you are sure the generation is done, then maybe it goes to some wierd position, you can use this menu item to reset it's position.
+
+Toggle Wireframe
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Rendered Model can be showed in two types, one with wireframe, one without.
+
+Show Debug Dialog
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This is for debug perpose only. It prints some useful information when debug.
+
+Help
+=====
+
+About
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+You can check the version info of Dust3D from here.
+
+Fork me on GitHub
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Dust3D is a totally free and opensourced project, this bring you to the project website.
+
+Report Issues
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+If you encounter any problem, or have any suggestion, thoughts, on Dust3D please drop it here, thanks.
+
+

docs/shortcuts.rst

@@ -44,6 +44,22 @@ Keyboard
 +---------------------+--------------------------------------------------------------------------+
 | CTRL + X            | Cut                                                                      |
 +---------------------+--------------------------------------------------------------------------+
+| X                   | Toggle X-axis Edit Lock                                                  |
++---------------------+--------------------------------------------------------------------------+
+| Y                   | Toggle Y-axis Edit Lock                                                  |
++---------------------+--------------------------------------------------------------------------+
+| Z                   | Toggle Z-axis Edit Lock                                                  |
++---------------------+--------------------------------------------------------------------------+
+| H                   | Toggle Part Visible/(H)idden                                             |
++---------------------+--------------------------------------------------------------------------+
+| J                   | Toggle Part (J)oin/Not Join(to Final Mesh)                               |
++---------------------+--------------------------------------------------------------------------+
+| L                   | Toggle Part Edit Lock                                                    |
++---------------------+--------------------------------------------------------------------------+
+| B                   | Toggle Part Face Generating Type: (B)ox/Subdivisioned Box                |
++---------------------+--------------------------------------------------------------------------+
+| M                   | Toggle Part X-axis-Mirror                                                |
++---------------------+--------------------------------------------------------------------------+
 
 Mouse
 ======