Updated doc to 0.5
BIN
doc/_images/node_comment.png
Normal file
After Width: | Height: | Size: 4.0 KiB |
BIN
doc/_images/node_export.png
Normal file
After Width: | Height: | Size: 4.4 KiB |
BIN
doc/_images/node_material.png
Normal file
After Width: | Height: | Size: 12 KiB |
BIN
doc/_images/node_remote.png
Normal file
After Width: | Height: | Size: 11 KiB |
BIN
doc/_images/node_switch.png
Normal file
After Width: | Height: | Size: 4.5 KiB |
Before Width: | Height: | Size: 325 KiB After Width: | Height: | Size: 323 KiB |
8
doc/_sources/node_comment.rst.txt
Normal file
@ -0,0 +1,8 @@
|
||||
Comment node
|
||||
~~~~~~~~~~~~
|
||||
|
||||
The Comment node has no effect on the material and can be used to document
|
||||
it. Simply double-click on the contents to edit it.
|
||||
|
||||
.. image:: images/node_comment.png
|
||||
|
24
doc/_sources/node_export.rst.txt
Normal file
@ -0,0 +1,24 @@
|
||||
Export node
|
||||
~~~~~~~~~~~
|
||||
|
||||
The Export node defines a a texture that will be saved together with the
|
||||
material textures when exporting the project.
|
||||
|
||||
.. image:: images/node_export.png
|
||||
|
||||
Inputs
|
||||
++++++
|
||||
|
||||
The Export node has an input that will be saved when exporting the project.
|
||||
|
||||
Outputs
|
||||
+++++++
|
||||
|
||||
The Export node does not have any output.
|
||||
|
||||
Parameters
|
||||
++++++++++
|
||||
|
||||
The Export node has a single parameter that defines the suffix PNG file
|
||||
that will be created.
|
||||
|
52
doc/_sources/node_material.rst.txt
Normal file
@ -0,0 +1,52 @@
|
||||
Material node
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
The Material node defines a material using its inputs.
|
||||
|
||||
There is one and only one Material node for each Material Maker project,
|
||||
it is created for each new project and cannot be deleted or duplicated.
|
||||
When copied and pasted together with other nodes, the Material node will
|
||||
not be pasted, but connections will be copied if possible.
|
||||
|
||||
When exporting a project to PNG files, all inputs are generated as PNG
|
||||
files whose name is generated using the project name and the name of the
|
||||
corresponding property in the material.
|
||||
|
||||
When using Material Maker as a Godot addon, the metallic, roughness and
|
||||
ambient occlusion are automatically combined into a single texture, and
|
||||
a SpatialMaterial is generated automatically.
|
||||
|
||||
.. image:: images/node_material.png
|
||||
|
||||
Inputs
|
||||
++++++
|
||||
|
||||
The Material node has an input for each supported property (albedo, metallic,
|
||||
roughness, emissive, normal, ambient occlusion and depth maps) of the material.
|
||||
|
||||
Outputs
|
||||
+++++++
|
||||
|
||||
The Material node does not have any output.
|
||||
|
||||
Parameters
|
||||
++++++++++
|
||||
|
||||
The Material node has parameters:
|
||||
|
||||
* The size of the texture files to be generated.
|
||||
|
||||
* A color associated to the albedo property. The texture used for the albedo input is multiplied by this color.
|
||||
|
||||
* The value of the metallic property of the material. The texture used for the metallic input is multiplied by this value.
|
||||
|
||||
* The value of the roughness property of the material. The texture used for the roughness input is multiplied by this value.
|
||||
|
||||
* The energy of the emissive property of the material.
|
||||
|
||||
* The value of the normal map property of the material. It is used to strengthen or lighten the effect of the normal map.
|
||||
|
||||
* The value of the ambient occlusion property of the material. The texture used for the ambient occlusion input is multiplied by this value.
|
||||
|
||||
* The value of the depth property of the material. The input depth map is multiplied by this value.
|
||||
|
52
doc/_sources/node_remote.rst.txt
Normal file
@ -0,0 +1,52 @@
|
||||
Remote node
|
||||
~~~~~~~~~~~
|
||||
|
||||
The Remote node has no direct effect on the material and can be used to control
|
||||
key parameters of the material to configure it easily.
|
||||
|
||||
.. image:: images/node_remote.png
|
||||
|
||||
When started, the Remote node only shows 2 buttons.
|
||||
|
||||
The left button can be used to create a linked control, that can be used to
|
||||
mirror one or several similar parameters.
|
||||
The right button can be used to create a configuration control, that can be
|
||||
associated to several parameters and store several named configurations for
|
||||
those parameters.
|
||||
|
||||
Linked control
|
||||
++++++++++++++
|
||||
|
||||
When creating a Linked control (using the "Create linked control" button),
|
||||
it is necessary to first pick a parameter in the material graph. The newly
|
||||
created control will be a copy of the selected parameter control, and when
|
||||
changing the value of the Linked control, the associated control will be
|
||||
updated accordingly.
|
||||
|
||||
A Linked control can also be associated to other parameters, provided they
|
||||
are of the same kind.
|
||||
|
||||
When hovering on the Linked control, Material Maker will show the parameters
|
||||
it controls.
|
||||
|
||||
Configuration control
|
||||
+++++++++++++++++++++
|
||||
|
||||
When creating a Configuration control (using the "Create configuration control"
|
||||
button), it is necessary to first pick a parameter in the material graph.
|
||||
The newly created control will hold a list of configurations of the associated
|
||||
parameters.
|
||||
|
||||
A Linked control can be associated to other parameters, and it is recommended to
|
||||
associate all relevant parameters before adding configurations.
|
||||
|
||||
When hovering on the Linked control, Material Maker will show the parameters
|
||||
it controls.
|
||||
|
||||
To create a configuration, set all associated parameters to the desired values,
|
||||
and select the "<add configuration>" entry in the drop-down list. Then enter a
|
||||
name for this configuration, and it will be added to the list.
|
||||
|
||||
The drop-down list can be used to select a configuration, create new ones and
|
||||
update or delete the current configuration.
|
||||
|
26
doc/_sources/node_switch.rst.txt
Normal file
@ -0,0 +1,26 @@
|
||||
Switch node
|
||||
~~~~~~~~~~~
|
||||
|
||||
The Switch node can be used to select sources for 2 output textures
|
||||
A and B from a choice of 2 pairs (A1, B1) and (A2, B2). It is useful
|
||||
to create variations of a material and easily switch between them.
|
||||
|
||||
.. image:: images/node_switch.png
|
||||
|
||||
Inputs
|
||||
++++++
|
||||
|
||||
The Switch node has 4 color inputs A1, B1, A2 and B2.
|
||||
|
||||
Outputs
|
||||
+++++++
|
||||
|
||||
The Switch node has 2 outputs A and B.
|
||||
|
||||
Parameters
|
||||
++++++++++
|
||||
|
||||
The Switch node has a single parameter whose value can be 1 or 2.
|
||||
When the parameter is set to 1, A forwards A1 and B forwards B1.
|
||||
When the parameter is set to 2, A forwards A2 and B forwards B2.
|
||||
|
@ -7,3 +7,4 @@ This section describes all nodes that can be used in a procedural material.
|
||||
|
||||
nodes_generators
|
||||
nodes_filters
|
||||
nodes_misc
|
||||
|
10
doc/_sources/nodes_misc.rst.txt
Normal file
@ -0,0 +1,10 @@
|
||||
Miscellaneous nodes
|
||||
-------------------
|
||||
|
||||
.. toctree::
|
||||
|
||||
node_material
|
||||
node_export
|
||||
node_switch
|
||||
node_comment
|
||||
node_remote
|
@ -157,6 +157,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="nodes.html">Available nodes</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_generators.html">Generator nodes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_filters.html">Filter nodes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_misc.html">Miscellaneous nodes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
235
doc/node_comment.html
Normal file
@ -0,0 +1,235 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Comment node — Material Maker documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Remote node" href="node_remote.html" />
|
||||
<link rel="prev" title="Switch node" href="node_switch.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Material Maker
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="user_interface.html">User interface</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="nodes.html">Available nodes</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_generators.html">Generator nodes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_filters.html">Filter nodes</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="nodes_misc.html">Miscellaneous nodes</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_material.html">Material node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_export.html">Export node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_switch.html">Switch node</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Comment node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_remote.html">Remote node</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Material Maker</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><a href="nodes.html">Available nodes</a> »</li>
|
||||
|
||||
<li><a href="nodes_misc.html">Miscellaneous nodes</a> »</li>
|
||||
|
||||
<li>Comment node</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="comment-node">
|
||||
<h1>Comment node<a class="headerlink" href="#comment-node" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The Comment node has no effect on the material and can be used to document
|
||||
it. Simply double-click on the contents to edit it.</p>
|
||||
<img alt="_images/node_comment.png" src="_images/node_comment.png" />
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="node_remote.html" class="btn btn-neutral float-right" title="Remote node" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="node_switch.html" class="btn btn-neutral" title="Switch node" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, Rodz Labs.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'',
|
||||
LANGUAGE:'None',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
253
doc/node_export.html
Normal file
@ -0,0 +1,253 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Export node — Material Maker documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Switch node" href="node_switch.html" />
|
||||
<link rel="prev" title="Material node" href="node_material.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Material Maker
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="user_interface.html">User interface</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="nodes.html">Available nodes</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_generators.html">Generator nodes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_filters.html">Filter nodes</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="nodes_misc.html">Miscellaneous nodes</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_material.html">Material node</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Export node</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#inputs">Inputs</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#outputs">Outputs</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#parameters">Parameters</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_switch.html">Switch node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_comment.html">Comment node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_remote.html">Remote node</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Material Maker</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><a href="nodes.html">Available nodes</a> »</li>
|
||||
|
||||
<li><a href="nodes_misc.html">Miscellaneous nodes</a> »</li>
|
||||
|
||||
<li>Export node</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="export-node">
|
||||
<h1>Export node<a class="headerlink" href="#export-node" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The Export node defines a a texture that will be saved together with the
|
||||
material textures when exporting the project.</p>
|
||||
<img alt="_images/node_export.png" src="_images/node_export.png" />
|
||||
<div class="section" id="inputs">
|
||||
<h2>Inputs<a class="headerlink" href="#inputs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Export node has an input that will be saved when exporting the project.</p>
|
||||
</div>
|
||||
<div class="section" id="outputs">
|
||||
<h2>Outputs<a class="headerlink" href="#outputs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Export node does not have any output.</p>
|
||||
</div>
|
||||
<div class="section" id="parameters">
|
||||
<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Export node has a single parameter that defines the suffix PNG file
|
||||
that will be created.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="node_switch.html" class="btn btn-neutral float-right" title="Switch node" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="node_material.html" class="btn btn-neutral" title="Material node" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, Rodz Labs.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'',
|
||||
LANGUAGE:'None',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
272
doc/node_material.html
Normal file
@ -0,0 +1,272 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Material node — Material Maker documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Export node" href="node_export.html" />
|
||||
<link rel="prev" title="Miscellaneous nodes" href="nodes_misc.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Material Maker
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="user_interface.html">User interface</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="nodes.html">Available nodes</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_generators.html">Generator nodes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_filters.html">Filter nodes</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="nodes_misc.html">Miscellaneous nodes</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Material node</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#inputs">Inputs</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#outputs">Outputs</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#parameters">Parameters</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_export.html">Export node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_switch.html">Switch node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_comment.html">Comment node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_remote.html">Remote node</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Material Maker</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><a href="nodes.html">Available nodes</a> »</li>
|
||||
|
||||
<li><a href="nodes_misc.html">Miscellaneous nodes</a> »</li>
|
||||
|
||||
<li>Material node</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="material-node">
|
||||
<h1>Material node<a class="headerlink" href="#material-node" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The Material node defines a material using its inputs.</p>
|
||||
<p>There is one and only one Material node for each Material Maker project,
|
||||
it is created for each new project and cannot be deleted or duplicated.
|
||||
When copied and pasted together with other nodes, the Material node will
|
||||
not be pasted, but connections will be copied if possible.</p>
|
||||
<p>When exporting a project to PNG files, all inputs are generated as PNG
|
||||
files whose name is generated using the project name and the name of the
|
||||
corresponding property in the material.</p>
|
||||
<p>When using Material Maker as a Godot addon, the metallic, roughness and
|
||||
ambient occlusion are automatically combined into a single texture, and
|
||||
a SpatialMaterial is generated automatically.</p>
|
||||
<img alt="_images/node_material.png" src="_images/node_material.png" />
|
||||
<div class="section" id="inputs">
|
||||
<h2>Inputs<a class="headerlink" href="#inputs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Material node has an input for each supported property (albedo, metallic,
|
||||
roughness, emissive, normal, ambient occlusion and depth maps) of the material.</p>
|
||||
</div>
|
||||
<div class="section" id="outputs">
|
||||
<h2>Outputs<a class="headerlink" href="#outputs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Material node does not have any output.</p>
|
||||
</div>
|
||||
<div class="section" id="parameters">
|
||||
<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Material node has parameters:</p>
|
||||
<ul class="simple">
|
||||
<li>The size of the texture files to be generated.</li>
|
||||
<li>A color associated to the albedo property. The texture used for the albedo input is multiplied by this color.</li>
|
||||
<li>The value of the metallic property of the material. The texture used for the metallic input is multiplied by this value.</li>
|
||||
<li>The value of the roughness property of the material. The texture used for the roughness input is multiplied by this value.</li>
|
||||
<li>The energy of the emissive property of the material.</li>
|
||||
<li>The value of the normal map property of the material. It is used to strengthen or lighten the effect of the normal map.</li>
|
||||
<li>The value of the ambient occlusion property of the material. The texture used for the ambient occlusion input is multiplied by this value.</li>
|
||||
<li>The value of the depth property of the material. The input depth map is multiplied by this value.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="node_export.html" class="btn btn-neutral float-right" title="Export node" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="nodes_misc.html" class="btn btn-neutral" title="Miscellaneous nodes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, Rodz Labs.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'',
|
||||
LANGUAGE:'None',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
270
doc/node_remote.html
Normal file
@ -0,0 +1,270 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Remote node — Material Maker documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="prev" title="Comment node" href="node_comment.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Material Maker
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="user_interface.html">User interface</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="nodes.html">Available nodes</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_generators.html">Generator nodes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_filters.html">Filter nodes</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="nodes_misc.html">Miscellaneous nodes</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_material.html">Material node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_export.html">Export node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_switch.html">Switch node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_comment.html">Comment node</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Remote node</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#linked-control">Linked control</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#configuration-control">Configuration control</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Material Maker</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><a href="nodes.html">Available nodes</a> »</li>
|
||||
|
||||
<li><a href="nodes_misc.html">Miscellaneous nodes</a> »</li>
|
||||
|
||||
<li>Remote node</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="remote-node">
|
||||
<h1>Remote node<a class="headerlink" href="#remote-node" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The Remote node has no direct effect on the material and can be used to control
|
||||
key parameters of the material to configure it easily.</p>
|
||||
<img alt="_images/node_remote.png" src="_images/node_remote.png" />
|
||||
<p>When started, the Remote node only shows 2 buttons.</p>
|
||||
<p>The left button can be used to create a linked control, that can be used to
|
||||
mirror one or several similar parameters.
|
||||
The right button can be used to create a configuration control, that can be
|
||||
associated to several parameters and store several named configurations for
|
||||
those parameters.</p>
|
||||
<div class="section" id="linked-control">
|
||||
<h2>Linked control<a class="headerlink" href="#linked-control" title="Permalink to this headline">¶</a></h2>
|
||||
<p>When creating a Linked control (using the “Create linked control” button),
|
||||
it is necessary to first pick a parameter in the material graph. The newly
|
||||
created control will be a copy of the selected parameter control, and when
|
||||
changing the value of the Linked control, the associated control will be
|
||||
updated accordingly.</p>
|
||||
<p>A Linked control can also be associated to other parameters, provided they
|
||||
are of the same kind.</p>
|
||||
<p>When hovering on the Linked control, Material Maker will show the parameters
|
||||
it controls.</p>
|
||||
</div>
|
||||
<div class="section" id="configuration-control">
|
||||
<h2>Configuration control<a class="headerlink" href="#configuration-control" title="Permalink to this headline">¶</a></h2>
|
||||
<p>When creating a Configuration control (using the “Create configuration control”
|
||||
button), it is necessary to first pick a parameter in the material graph.
|
||||
The newly created control will hold a list of configurations of the associated
|
||||
parameters.</p>
|
||||
<p>A Linked control can be associated to other parameters, and it is recommended to
|
||||
associate all relevant parameters before adding configurations.</p>
|
||||
<p>When hovering on the Linked control, Material Maker will show the parameters
|
||||
it controls.</p>
|
||||
<p>To create a configuration, set all associated parameters to the desired values,
|
||||
and select the “<add configuration>” entry in the drop-down list. Then enter a
|
||||
name for this configuration, and it will be added to the list.</p>
|
||||
<p>The drop-down list can be used to select a configuration, create new ones and
|
||||
update or delete the current configuration.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
|
||||
<a href="node_comment.html" class="btn btn-neutral" title="Comment node" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, Rodz Labs.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'',
|
||||
LANGUAGE:'None',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
255
doc/node_switch.html
Normal file
@ -0,0 +1,255 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Switch node — Material Maker documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Comment node" href="node_comment.html" />
|
||||
<link rel="prev" title="Export node" href="node_export.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Material Maker
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="user_interface.html">User interface</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="nodes.html">Available nodes</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_generators.html">Generator nodes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_filters.html">Filter nodes</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="nodes_misc.html">Miscellaneous nodes</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_material.html">Material node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_export.html">Export node</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Switch node</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#inputs">Inputs</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#outputs">Outputs</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#parameters">Parameters</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_comment.html">Comment node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_remote.html">Remote node</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Material Maker</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><a href="nodes.html">Available nodes</a> »</li>
|
||||
|
||||
<li><a href="nodes_misc.html">Miscellaneous nodes</a> »</li>
|
||||
|
||||
<li>Switch node</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="switch-node">
|
||||
<h1>Switch node<a class="headerlink" href="#switch-node" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The Switch node can be used to select sources for 2 output textures
|
||||
A and B from a choice of 2 pairs (A1, B1) and (A2, B2). It is useful
|
||||
to create variations of a material and easily switch between them.</p>
|
||||
<img alt="_images/node_switch.png" src="_images/node_switch.png" />
|
||||
<div class="section" id="inputs">
|
||||
<h2>Inputs<a class="headerlink" href="#inputs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Switch node has 4 color inputs A1, B1, A2 and B2.</p>
|
||||
</div>
|
||||
<div class="section" id="outputs">
|
||||
<h2>Outputs<a class="headerlink" href="#outputs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Switch node has 2 outputs A and B.</p>
|
||||
</div>
|
||||
<div class="section" id="parameters">
|
||||
<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Switch node has a single parameter whose value can be 1 or 2.
|
||||
When the parameter is set to 1, A forwards A1 and B forwards B1.
|
||||
When the parameter is set to 2, A forwards A2 and B forwards B2.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="node_comment.html" class="btn btn-neutral float-right" title="Comment node" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="node_export.html" class="btn btn-neutral" title="Export node" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, Rodz Labs.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'',
|
||||
LANGUAGE:'None',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
@ -84,6 +84,7 @@
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Available nodes</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_generators.html">Generator nodes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_filters.html">Filter nodes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_misc.html">Miscellaneous nodes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -268,6 +269,33 @@
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="nodes_misc.html">Miscellaneous nodes</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_material.html">Material node</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_material.html#inputs">Inputs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_material.html#outputs">Outputs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_material.html#parameters">Parameters</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_export.html">Export node</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_export.html#inputs">Inputs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_export.html#outputs">Outputs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_export.html#parameters">Parameters</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_switch.html">Switch node</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_switch.html#inputs">Inputs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_switch.html#outputs">Outputs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_switch.html#parameters">Parameters</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_comment.html">Comment node</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_remote.html">Remote node</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_remote.html#linked-control">Linked control</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_remote.html#configuration-control">Configuration control</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
258
doc/nodes_misc.html
Normal file
@ -0,0 +1,258 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Miscellaneous nodes — Material Maker documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Material node" href="node_material.html" />
|
||||
<link rel="prev" title="Warp node" href="node_warp.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Material Maker
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="user_interface.html">User interface</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="nodes.html">Available nodes</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_generators.html">Generator nodes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="nodes_filters.html">Filter nodes</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Miscellaneous nodes</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_material.html">Material node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_export.html">Export node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_switch.html">Switch node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_comment.html">Comment node</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="node_remote.html">Remote node</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Material Maker</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><a href="nodes.html">Available nodes</a> »</li>
|
||||
|
||||
<li>Miscellaneous nodes</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="miscellaneous-nodes">
|
||||
<h1>Miscellaneous nodes<a class="headerlink" href="#miscellaneous-nodes" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="node_material.html">Material node</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_material.html#inputs">Inputs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_material.html#outputs">Outputs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_material.html#parameters">Parameters</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="node_export.html">Export node</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_export.html#inputs">Inputs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_export.html#outputs">Outputs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_export.html#parameters">Parameters</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="node_switch.html">Switch node</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_switch.html#inputs">Inputs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_switch.html#outputs">Outputs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_switch.html#parameters">Parameters</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="node_comment.html">Comment node</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="node_remote.html">Remote node</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_remote.html#linked-control">Linked control</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="node_remote.html#configuration-control">Configuration control</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="node_material.html" class="btn btn-neutral float-right" title="Material node" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="node_warp.html" class="btn btn-neutral" title="Warp node" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, Rodz Labs.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'',
|
||||
LANGUAGE:'None',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|