material-maker/doc/remote_nodes.html

288 lines
9.6 KiB
HTML
Raw Normal View History

<!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 nodes &mdash; 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="Subgraph nodes" href="subgraph_nodes.html" />
<link rel="prev" title="Texture nodes" href="texture_nodes.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 class="version">
0.7
</div>
<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">Nodes overview</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nodes_common.html">Common properties of nodes</a></li>
<li class="toctree-l2"><a class="reference internal" href="shader_nodes.html">Shader nodes</a></li>
<li class="toctree-l2"><a class="reference internal" href="texture_nodes.html">Texture nodes</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Remote nodes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#creating-a-remote-node">Creating a remote node</a></li>
<li class="toctree-l3"><a class="reference internal" href="#configuring-a-remote-node">Configuring a remote node</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#linked-widgets">Linked widgets</a></li>
<li class="toctree-l4"><a class="reference internal" href="#configuration-widgets">Configuration widgets</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="subgraph_nodes.html">Subgraph nodes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="base_library.html">Nodes library</a></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> &raquo;</li>
<li><a href="nodes.html">Nodes overview</a> &raquo;</li>
<li>Remote 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="remote-nodes">
<h1>Remote nodes<a class="headerlink" href="#remote-nodes" title="Permalink to this headline"></a></h1>
<p>Remote nodes have no input or output. They are only used to control (remotely) the
parameters of other nodes. They can be used to either gather important parameters
of a complex graph or define the parameters of a subgraph node.</p>
<div class="section" id="creating-a-remote-node">
<h2>Creating a remote node<a class="headerlink" href="#creating-a-remote-node" title="Permalink to this headline"></a></h2>
<p>Remote nodes can be created by dragging a Miscellaneous/Remote node from the library
pane to a graph pane.</p>
</div>
<div class="section" id="configuring-a-remote-node">
<h2>Configuring a remote node<a class="headerlink" href="#configuring-a-remote-node" title="Permalink to this headline"></a></h2>
<p>Remote nodes provide two kinds of controls:</p>
<ul class="simple">
<li><p>linked widgets, that are associated to parameters in the graph and whose values are copied
into the target parameters</p></li>
<li><p>configuration widgets, that can be used to define named configurations of the target
parameters</p></li>
</ul>
<div class="section" id="linked-widgets">
<h3>Linked widgets<a class="headerlink" href="#linked-widgets" title="Permalink to this headline"></a></h3>
<p>Linked widgets can be used to modify at the same time several parameters from several nodes.</p>
<p>When hovering a linked widget, the user interface will show which parameters it controls.</p>
<img alt="_images/remote_create_linked_widget.gif" class="align-center" src="_images/remote_create_linked_widget.gif" />
<p>To create a linked widget, click on the <img alt="create_linked_widget" src="_images/create_linked_widget.png" /> button and select a parameter
to be controlled in another node. This will create a new linked widget whose type is the
same as the selected parameter.</p>
<p>More parameters can be controlled by the same linked widget. To add one, click on the
<img alt="add_linked_widget" src="_images/add_linked_widget.png" /> button of the linked widget, and select the parameter. While
associating parameters to linked widgets, Material Maker will check compatibility.</p>
<p>To delete a linked widget, click on its <img alt="remove_linked_widget" src="_images/remove_linked_widget.png" /> button.</p>
</div>
<div class="section" id="configuration-widgets">
<h3>Configuration widgets<a class="headerlink" href="#configuration-widgets" title="Permalink to this headline"></a></h3>
<p>Configuration widgets are used to create named configurations for associated parameters
in the graph.</p>
<img alt="_images/remote_configuration_widget.gif" class="align-center" src="_images/remote_configuration_widget.gif" />
<p>To create a configuration widget, click on the <img alt="create_configuration_widget" src="_images/create_configuration_widget.png" /> button
and select a parameter to be controlled in another node. Then, link all other parameters
that should be controlled using the <img alt="add_linked_widget" src="_images/add_linked_widget.png" /> button.</p>
<p>When all parameters are linked, you can create your first configuration. Set the values
of all parameters for this first configuration, then select the <strong>add configuration</strong>
option in the configurations drop down button. you will be propted for a name for
the new configuration.</p>
<p>Repeat the same operation (set all parameters values, then <strong>add configuration</strong>) to
add all other configurations.</p>
<p>Selecting a configuration using the drop down button will recall the associated parameters
values.</p>
<p>It is also possible to rename, update or delete a configuration using the drop down button.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="subgraph_nodes.html" class="btn btn-neutral float-right" title="Subgraph nodes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="texture_nodes.html" class="btn btn-neutral" title="Texture nodes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; 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/language_data.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>