[go: nahoru, domu]

Skip to content

Commit

Permalink
Update: docs
Browse files Browse the repository at this point in the history
Custom Materials
  • Loading branch information
markelekdotcom committed Nov 28, 2022
1 parent 19fcc15 commit 508f117
Show file tree
Hide file tree
Showing 20 changed files with 379 additions and 3 deletions.
Binary file modified docs/_build/doctrees/contents.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/custom_material.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/custom_materials.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
1 change: 1 addition & 0 deletions docs/_build/html/_sources/contents.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@

quickstart
settings
custom_materials
changelog
contact
19 changes: 19 additions & 0 deletions docs/_build/html/_sources/custom_material.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#################
Custom Materials
#################

When creating your custom material:
- Materials that include drivers require care (e.g. Base Instance and Extra Instance materials)
- Copy an existing one and build upon it
- or check out how it controls the color of the instances and copy that part to your material
- For a material to show up in the "Project Settings" panel include one or more keywords at the end of it's name:

------------------
Keywords
------------------
- "_BI" (as in Base Instance)
- "_EI" (as in Extra Instance)
- "_EG" (as in Extra Glass)
- "_EP" (as in Extra Plane)
- "_FR" (as in Frame)
- "_FL" (as in Floor)
38 changes: 38 additions & 0 deletions docs/_build/html/_sources/custom_materials.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
#################
Custom Materials
#################


.. warning:: Materials that include drivers require care (e.g. Base Instance and Extra Instance materials)

------------------
Make sure
------------------

- To copy an existing material and build upon it
- **or** copy the nodes with drivers to your material


---------------------
Visibility Filtering
---------------------

For a material to show up in the "Project Settings" panel:

- Include one or more :ref:`custom_materials:Keywords` at the end of it's name

------------------
Keywords
------------------

:ref:`settings:The Anatomy of the Scene`


- "**_BI**" (as in **Base Instance**)
- "**_EI**" (as in **Extra Instance**)
- "**_EG**" (as in **Extra Glass**)
- "**_EP**" (as in **Extra Plane**)
- "**_FR**" (as in **Frame**)
- "**_FL**" (as in **Floor**)


2 changes: 2 additions & 0 deletions docs/_build/html/contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_materials.html">Custom Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li>
</ul>
Expand Down Expand Up @@ -77,6 +78,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_materials.html">Custom Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li>
</ul>
Expand Down
123 changes: 123 additions & 0 deletions docs/_build/html/custom_material.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Custom Materials &mdash; 3DPixels 1.0.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</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"> 3DPixels
<img src="_static/3dpixels_RTD_logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
1.0.0
</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="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">3DPixels</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Custom Materials</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/custom_material.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="custom-materials">
<h1>Custom Materials<a class="headerlink" href="#custom-materials" title="Permalink to this heading"></a></h1>
<p>When creating your custom material:
- Materials that include drivers require care (e.g. Base Instance and Extra Instance materials)
- Copy an existing one and build upon it
- or check out how it controls the color of the instances and copy that part to your material
- For a material to show up in the “Project Settings” panel include one or more keywords at the end of it’s name:</p>
<section id="keywords">
<h2>Keywords<a class="headerlink" href="#keywords" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>“_BI” (as in Base Instance)</p></li>
<li><p>“_EI” (as in Extra Instance)</p></li>
<li><p>“_EG” (as in Extra Glass)</p></li>
<li><p>“_EP” (as in Extra Plane)</p></li>
<li><p>“_FR” (as in Frame)</p></li>
<li><p>“_FL” (as in Floor)</p></li>
</ul>
</section>
</section>


</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2022, Mark Elek, David Elek.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
148 changes: 148 additions & 0 deletions docs/_build/html/custom_materials.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Custom Materials &mdash; 3DPixels 1.0.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Changelog" href="changelog.html" />
<link rel="prev" title="Settings" href="settings.html" />
</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"> 3DPixels
<img src="_static/3dpixels_RTD_logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
1.0.0
</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="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Custom Materials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#make-sure">Make sure</a></li>
<li class="toctree-l2"><a class="reference internal" href="#visibility-filtering">Visibility Filtering</a></li>
<li class="toctree-l2"><a class="reference internal" href="#keywords">Keywords</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">3DPixels</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Custom Materials</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/custom_materials.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="custom-materials">
<h1>Custom Materials<a class="headerlink" href="#custom-materials" title="Permalink to this heading"></a></h1>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Materials that include drivers require care (e.g. Base Instance and Extra Instance materials)</p>
</div>
<section id="make-sure">
<h2>Make sure<a class="headerlink" href="#make-sure" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>To copy an existing material and build upon it</p></li>
<li><p><strong>or</strong> copy the nodes with drivers to your material</p></li>
</ul>
</section>
<section id="visibility-filtering">
<h2>Visibility Filtering<a class="headerlink" href="#visibility-filtering" title="Permalink to this heading"></a></h2>
<p>For a material to show up in the “Project Settings” panel:</p>
<ul class="simple">
<li><p>Include one or more <a class="reference internal" href="#keywords"><span class="std std-ref">Keywords</span></a> at the end of it’s name</p></li>
</ul>
</section>
<section id="keywords">
<h2>Keywords<a class="headerlink" href="#keywords" title="Permalink to this heading"></a></h2>
<p><a class="reference internal" href="settings.html#the-anatomy-of-the-scene"><span class="std std-ref">The Anatomy of the Scene</span></a></p>
<ul class="simple">
<li><p><strong>_BI</strong>” (as in <strong>Base Instance</strong>)</p></li>
<li><p><strong>_EI</strong>” (as in <strong>Extra Instance</strong>)</p></li>
<li><p><strong>_EG</strong>” (as in <strong>Extra Glass</strong>)</p></li>
<li><p><strong>_EP</strong>” (as in <strong>Extra Plane</strong>)</p></li>
<li><p><strong>_FR</strong>” (as in <strong>Frame</strong>)</p></li>
<li><p><strong>_FL</strong>” (as in <strong>Floor</strong>)</p></li>
</ul>
</section>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="settings.html" class="btn btn-neutral float-left" title="Settings" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2022, Mark Elek, David Elek.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
1 change: 1 addition & 0 deletions docs/_build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_materials.html">Custom Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li>
</ul>
Expand Down
2 changes: 2 additions & 0 deletions docs/_build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_materials.html">Custom Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li>
</ul>
Expand Down Expand Up @@ -83,6 +84,7 @@ <h1>What is 3DPixels?<a class="headerlink" href="#what-is-3dpixels" title="Perma
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_materials.html">Custom Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li>
</ul>
Expand Down
Binary file modified docs/_build/html/objects.inv
Binary file not shown.
1 change: 1 addition & 0 deletions docs/_build/html/quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_materials.html">Custom Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li>
</ul>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_materials.html">Custom Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li>
</ul>
Expand Down
Loading

0 comments on commit 508f117

Please sign in to comment.