Add script panel docs

master
Jeremy Hu 2019-07-27 16:17:30 +09:30
parent 9396df8a2c
commit ef35361c59
5 changed files with 24 additions and 1 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 267 KiB

After

Width:  |  Height:  |  Size: 257 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 802 KiB

After

Width:  |  Height:  |  Size: 864 KiB

Binary file not shown.

View File

@ -16,9 +16,10 @@ You can have multiple windows, the document title shows what version of Dust3D y
3. Dock Panel
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Dock panel contains multiple tabs, including `Parts Tree`_, Material List, Rig Weight View, Pose List, Motion List, and Script Editor.
Dock panel contains multiple tabs, including `Parts Tree`_, Material List, Rig Weight View, Pose List, Motion List, and `Script Panel`_.
.. _Parts Tree: http://docs.dust3d.org/en/latest/interface/parts_panel.html
.. _Script Panel: http://docs.dust3d.org/en/latest/interface/script_panel.html
4. Rendered Model
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -0,0 +1,22 @@
Script Panel
------------------------
.. image:: https://raw.githubusercontent.com/huxingyi/dust3d/master/docs/images/dust3d-ui-script.png
Dust3D supports JavaScript language to generate the source document, which then been fed into the mesh generator to construct the final model.
1. Rendered Model
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Result model generated from the script.
2. Script Editor
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Paste your JavaScript code here, or type in the code directly. The script runner will be invoked automatically once there is any change detected from the script editor.
If there is an error or console output from the script, the output will show under the editor.
3. Variables Panel
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can create input control from script and receive the user input variable which can be used to adjust the settings for the procedural generation.