dust3d/docs/interface/menubar.rst

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...
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you want mesh only result, export as Wavefront (.obj) format.
Choose GL Transmission Format (.gltf) to export all results in one gltf file, the results including autogenerated Meshes, Skeleton, and Materials.
Because .gltf is a very new format, not every 3D software officially supports it, and there are some plugins for blender to support gltf export and import, but mostly are buggy at current stage.
You can use Don McCurdy's online website, glTF Viewer https://gltf-viewer.donmccurdy.com/ to check your exported result.

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 weird position, you can use this menu item to reset it's position.

Toggle Bones
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The skeleton would also been autogenerated after meshes got generated.
Toggle this item to show or hide the Rendered Skeleton from canvas.

Show Parts List
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Parts List Panel is a tool window, if you closed it by accident, you can show it back here.

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.
Add interface overview docs 2018-04-18 07:57:48 +00:00			`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...`
			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
Add auto-generated skeleton(skinned mesh) and glTF exporter. And added a CONTRIBUTORS file to list the users who have done great work to help Dust3D become better, thank you! @Alistair401 @hdu @shadowndacorner @Skullfurious @RSDuck @xtvjxk123456 @Zireael07 @glasyalabolas @dlpatri PS. please feel free to make a pull request or email me to change the ID or contact info listed in the CONTRIBUTORS file, and if you are mistakenly been missed in the file, please MUST edit this file and make a PR or email me. 2018-04-30 11:31:09 +00:00			`If you want mesh only result, export as Wavefront (.obj) format.`
			`Choose GL Transmission Format (.gltf) to export all results in one gltf file, the results including autogenerated Meshes, Skeleton, and Materials.`
			`Because .gltf is a very new format, not every 3D software officially supports it, and there are some plugins for blender to support gltf export and import, but mostly are buggy at current stage.`
			`You can use Don McCurdy's online website, glTF Viewer https://gltf-viewer.donmccurdy.com/ to check your exported result.`
Add interface overview docs 2018-04-18 07:57:48 +00:00
			`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`
			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
Add auto-generated skeleton(skinned mesh) and glTF exporter. And added a CONTRIBUTORS file to list the users who have done great work to help Dust3D become better, thank you! @Alistair401 @hdu @shadowndacorner @Skullfurious @RSDuck @xtvjxk123456 @Zireael07 @glasyalabolas @dlpatri PS. please feel free to make a pull request or email me to change the ID or contact info listed in the CONTRIBUTORS file, and if you are mistakenly been missed in the file, please MUST edit this file and make a PR or email me. 2018-04-30 11:31:09 +00:00			`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 weird position, you can use this menu item to reset it's position.`

			`Toggle Bones`
			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
			`The skeleton would also been autogenerated after meshes got generated.`
			`Toggle this item to show or hide the Rendered Skeleton from canvas.`
Add interface overview docs 2018-04-18 07:57:48 +00:00
Add alt key to enable rendered model rotate and move. ALT + LEFT BUTTON: Rotate rendered model ALT + SHIFT + LEFT BUTTON: Move rendered model Thanks @Zireael07 and @glasyalabolas for proposing this feature. Closes #4 2018-04-23 02:14:32 +00:00			`Show Parts List`
			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
			`The Parts List Panel is a tool window, if you closed it by accident, you can show it back here.`

Add interface overview docs 2018-04-18 07:57:48 +00:00			`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.`