mirror of
https://github.com/Relintai/material-maker.git
synced 2025-01-25 18:59:18 +01:00
321 lines
11 KiB
HTML
321 lines
11 KiB
HTML
|
||
|
||
<!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>User interface — 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="Available nodes" href="nodes.html" />
|
||
<link rel="prev" title="Introduction" href="intro.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 current"><a class="current reference internal" href="#">User interface</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#overview">Overview</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#first-steps-with-the-user-interface">First steps with the user interface</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#main-menu">Main menu</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#file-menu">File menu</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#edit-menu">Edit menu</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#tools-menu">Tools menu</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#help-menu">Help menu</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="nodes.html">Available nodes</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> »</li>
|
||
|
||
<li>User interface</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="user-interface">
|
||
<h1>User interface<a class="headerlink" href="#user-interface" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="overview">
|
||
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
|
||
<p>Material Maker mainly consists of 3 panes:</p>
|
||
<ul class="simple">
|
||
<li>The top left pane is the library, that contains all available nodes that can be used
|
||
to create materials. Library items are shown in a tree view</li>
|
||
<li>The bottom left pane is the preview, that shows at the same time the currecnt material
|
||
applied to a sample mesh in a sample environment, and the texture generated by the
|
||
currently selected node</li>
|
||
<li>The right pane contains the graph editors where materials are described for current
|
||
projects</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="first-steps-with-the-user-interface">
|
||
<h2>First steps with the user interface<a class="headerlink" href="#first-steps-with-the-user-interface" title="Permalink to this headline">¶</a></h2>
|
||
<p>When opening Material Maker, a new empty project is created and shown in the right pane.
|
||
An empty project simply consists of a material node where textures for all elements of
|
||
the material should be connected.</p>
|
||
<p>To create a new node, simply choose one (for example “bricks”) from the library (the
|
||
top left pane) and drag it into the graph editor. Depending on the selected library
|
||
item, a preview or a simple description will be displayed while dragging.</p>
|
||
<img alt="_images/create_node.gif" src="_images/create_node.gif" />
|
||
<p>Selecting this new node (by clicking on it) shows it in the preview pane. The very small
|
||
2d preview of the preview pane can be maximized by double cliking on it. This will hide
|
||
the 3d preview but is useful when working on the different textures of the material.</p>
|
||
<p>To connect a node output to an input of another node, simply drag one to the other.
|
||
For example we can drag the first output of the Bricks node to the albedo input of
|
||
the Materials node. This will automatically assign the simple Bricks texture to the
|
||
albedo element of the material, and the 3d preview will immediately be updated (if
|
||
you maximized the 2d preview it can be minimized by double-clicking on it again).</p>
|
||
<img alt="_images/connect_nodes.gif" src="_images/connect_nodes.gif" />
|
||
<p>Nodes can easily be configured by modifying their parameters, and previews are updated
|
||
automatically.</p>
|
||
<p>Since each input can be connected to a single output, reconnecting an input will
|
||
automatically remove the previous connection.</p>
|
||
</div>
|
||
<div class="section" id="main-menu">
|
||
<h2>Main menu<a class="headerlink" href="#main-menu" title="Permalink to this headline">¶</a></h2>
|
||
<p>The main menu is organized in 4 sections:</p>
|
||
<ul class="simple">
|
||
<li>the <em>File</em> menu contains actions to create, load, save and export materials</li>
|
||
<li>the <em>Edit</em> menu has common edit actions cut, copy and paste</li>
|
||
<li>the <em>Tools</em> menu has actions to add items to the user library</li>
|
||
<li>the <em>Help</em> menu can be used to find more information and submit feedback about the software</li>
|
||
</ul>
|
||
<div class="section" id="file-menu">
|
||
<h3>File menu<a class="headerlink" href="#file-menu" title="Permalink to this headline">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><em>New material</em> creates a new material and opens a tab in the right pane to edit it</li>
|
||
<li><em>Load material</em> opens a file dialog to select a procedural material (.ptex) file. If
|
||
a material file is selected, it will be open in a new tab in the right pane. If the current
|
||
tab contains an empty material (about material that only consists of a Material node), the
|
||
material will be loaded into this tab.</li>
|
||
<li><em>Save material</em> saves the current material. If it was not previously saved, a file dialog
|
||
will be displayed to select a location and file name.</li>
|
||
<li><em>Save material as</em> prompts for a location and file name and saves the current material.</li>
|
||
<li><em>Save all materials</em> saves all currently open materials. Materials that were not already
|
||
saved ae ignored.</li>
|
||
<li><em>Export material</em> generates PNG image files for all elements of the material. File names are
|
||
defined using the path of the material and their role (albedo, metallic…) in the material.</li>
|
||
<li><em>Close material</em> closes the current material.</li>
|
||
<li><em>Quit</em> closes the software.</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="edit-menu">
|
||
<h3>Edit menu<a class="headerlink" href="#edit-menu" title="Permalink to this headline">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><em>Cut</em> Copies the selected nodes to the clipboard and removes them from the current material.</li>
|
||
<li><em>Copy</em> Copies the selected nodes to the clipboard</li>
|
||
<li><em>Paste</em> Copies the clipboard into the current material. Note that the nodes will be added to
|
||
the center of the view, so it is advised to scroll to the correct location before pasting.
|
||
Pasting also unselects all previously selected nodes and selects all newly created nodes,
|
||
so they can easily be moved around.</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="tools-menu">
|
||
<h3>Tools menu<a class="headerlink" href="#tools-menu" title="Permalink to this headline">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><em>Add selected node to user library</em> first prompts for an item name. If a name is entered and
|
||
confirmed, the selected nodes in the current material will be added to the user library under
|
||
that name. Don’t forget to use the <em>Save user library</em> item, otherwise the newly created library
|
||
not be available anymore when the software is restarted.</li>
|
||
<li><em>Save user library</em> saves the user library.</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="help-menu">
|
||
<h3>Help menu<a class="headerlink" href="#help-menu" title="Permalink to this headline">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><em>Report a bug</em> opens a web browser on the Issues page of Material Maker’s GitHub project. Please
|
||
do not hesitate to use it to suggest improvements for Material Maker.</li>
|
||
<li><em>About</em> Shows the about dialog.</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="nodes.html" class="btn btn-neutral float-right" title="Available nodes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="intro.html" class="btn btn-neutral" title="Introduction" 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> |