kopia lustrzana https://github.com/carson-katri/geometry-script
349 wiersze
20 KiB
HTML
349 wiersze
20 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="coal" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Using Nodes - Geometry Script</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="icon" href="../../favicon.svg">
|
|
<link rel="shortcut icon" href="../../favicon.png">
|
|
<link rel="stylesheet" href="../../css/variables.css">
|
|
<link rel="stylesheet" href="../../css/general.css">
|
|
<link rel="stylesheet" href="../../css/chrome.css">
|
|
<link rel="stylesheet" href="../../css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="../../FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="../../fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" href="../../highlight.css">
|
|
<link rel="stylesheet" href="../../tomorrow-night.css">
|
|
<link rel="stylesheet" href="../../ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
<link rel="stylesheet" href="../../style.css">
|
|
|
|
</head>
|
|
<body class="sidebar-visible no-js">
|
|
<div id="body-container">
|
|
<!-- Provide site root to javascript -->
|
|
<script>
|
|
var path_to_root = "../../";
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "coal" : "coal";
|
|
</script>
|
|
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
var theme = localStorage.getItem('mdbook-theme');
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
var theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
var html = document.querySelector('html');
|
|
html.classList.remove('coal')
|
|
html.classList.add(theme);
|
|
var body = document.querySelector('body');
|
|
body.classList.remove('no-js')
|
|
body.classList.add('js');
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
var body = document.querySelector('body');
|
|
var sidebar = null;
|
|
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
body.classList.remove('sidebar-visible');
|
|
body.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<div class="sidebar-scrollbox">
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><a href="../../introduction.html">Introduction</a></li><li class="chapter-item expanded affix "><li class="part-title">Setup</li><li class="chapter-item expanded "><a href="../../setup/installation.html"><strong aria-hidden="true">1.</strong> Installation</a></li><li class="chapter-item expanded "><a href="../../setup/internal-editing-basics.html"><strong aria-hidden="true">2.</strong> Internal Editing Basics</a></li><li class="chapter-item expanded "><a href="../../setup/external-editing.html"><strong aria-hidden="true">3.</strong> External Editing</a></li><li class="chapter-item expanded affix "><li class="part-title">API</li><li class="chapter-item expanded "><a href="../../api/basics.html"><strong aria-hidden="true">4.</strong> Basics</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../../api/basics/modules.html"><strong aria-hidden="true">4.1.</strong> Modules</a></li><li class="chapter-item expanded "><a href="../../api/basics/tree-functions.html"><strong aria-hidden="true">4.2.</strong> Tree Functions</a></li><li class="chapter-item expanded "><a href="../../api/basics/sockets.html"><strong aria-hidden="true">4.3.</strong> Sockets</a></li><li class="chapter-item expanded "><a href="../../api/basics/using-nodes.html" class="active"><strong aria-hidden="true">4.4.</strong> Using Nodes</a></li></ol></li><li class="chapter-item expanded "><a href="../../api/advanced-scripting.html"><strong aria-hidden="true">5.</strong> Advanced Scripting</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../../api/advanced-scripting/node-groups.html"><strong aria-hidden="true">5.1.</strong> Node Groups</a></li><li class="chapter-item expanded "><a href="../../api/advanced-scripting/generators.html"><strong aria-hidden="true">5.2.</strong> Generators</a></li><li class="chapter-item expanded "><a href="../../api/advanced-scripting/input-groups.html"><strong aria-hidden="true">5.3.</strong> Input Groups</a></li><li class="chapter-item expanded "><a href="../../api/advanced-scripting/attributes.html"><strong aria-hidden="true">5.4.</strong> Attributes</a></li><li class="chapter-item expanded "><a href="../../api/advanced-scripting/boolean-math.html"><strong aria-hidden="true">5.5.</strong> Boolean Math</a></li><li class="chapter-item expanded "><a href="../../api/advanced-scripting/curves.html"><strong aria-hidden="true">5.6.</strong> Curves</a></li><li class="chapter-item expanded "><a href="../../api/advanced-scripting/drivers.html"><strong aria-hidden="true">5.7.</strong> Drivers</a></li><li class="chapter-item expanded "><a href="../../api/advanced-scripting/simulation.html"><strong aria-hidden="true">5.8.</strong> Simulation</a></li></ol></li><li class="chapter-item expanded "><li class="part-title">Tutorials</li><li class="chapter-item expanded "><a href="../../tutorials/voxelize.html"><strong aria-hidden="true">6.</strong> Voxelize</a></li><li class="chapter-item expanded "><a href="../../tutorials/city-builder.html"><strong aria-hidden="true">7.</strong> City Builder</a></li></ol>
|
|
</div>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
|
</nav>
|
|
|
|
<!-- Track and set sidebar scroll position -->
|
|
<script>
|
|
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
|
|
sidebarScrollbox.addEventListener('click', function(e) {
|
|
if (e.target.tagName === 'A') {
|
|
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
|
|
}
|
|
}, { passive: true });
|
|
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
|
|
sessionStorage.removeItem('sidebar-scroll');
|
|
if (sidebarScrollTop) {
|
|
// preserve sidebar scroll position when navigating via links within sidebar
|
|
sidebarScrollbox.scrollTop = sidebarScrollTop;
|
|
} else {
|
|
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
|
|
var activeSection = document.querySelector('#sidebar .active');
|
|
if (activeSection) {
|
|
activeSection.scrollIntoView({ block: 'center' });
|
|
}
|
|
}
|
|
</script>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">Geometry Script</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="../../print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="using-nodes"><a class="header" href="#using-nodes">Using Nodes</a></h1>
|
|
<p>Node functions are automatically generated for the Blender version you are using. This means every node will be available from geometry script.</p>
|
|
<p>This means that when future versions of Blender add new nodes, they will all be available in Geometry Script without updating the add-on.</p>
|
|
<p>To see all of the node functions available in your Blender version, open the <em>Geometry Script</em> menu in the <em>Text Editor</em> and click <em>Open Documentation</em>.</p>
|
|
<p><img src="./open_documentation.png" alt="" /></p>
|
|
<p>This will open the automatically generated docs page with a list of every available node and it's inputs and outputs.</p>
|
|
<h2 id="how-nodes-are-mapped"><a class="header" href="#how-nodes-are-mapped">How nodes are mapped</a></h2>
|
|
<p>All nodes are mapped to functions in the same way, so even without the documentation you can decifer what a node will equate to. Using an <a href="../../setup/external-editing.html">IDE with code completion</a> makes this even easier.</p>
|
|
<p>The general process is:</p>
|
|
<ol>
|
|
<li>Convert the node name to snake case.</li>
|
|
<li>Add a keyword argument (in snake case) for each property and input.</li>
|
|
<li>If the node has a single output, return the socket type, otherwise return an object with properties for each output name.</li>
|
|
</ol>
|
|
<blockquote>
|
|
<p>Properties and inputs are different types of argument. A property is a value that cannot be connected to a socket. These are typically enums (displayed in the UI as a dropdown), with specific string values expected. Check the documentation for a node to see what the possible values are for a property.</p>
|
|
</blockquote>
|
|
<h2 id="enum-properties"><a class="header" href="#enum-properties">Enum Properties</a></h2>
|
|
<p>Many nodes have enum properties. For example, the math node lets you choose which operation to perform. You can pass a string to specify the enum case to use. But a safer way to set these values is with the autogenerated enum types. The enums are namespaced to the name of the node in PascalCase:</p>
|
|
<pre><code class="language-python"># Access it by Node.Enum Name.Case
|
|
math(operation=Math.Operation.ADD)
|
|
math(operation=Math.Operation.SUBTRACT)
|
|
math(operation='MULTIPLY') # Or manually pass a string
|
|
</code></pre>
|
|
<p>Internally, this type is generated as:</p>
|
|
<pre><code class="language-python">import enum
|
|
class Math:
|
|
class Operation(enum.Enum):
|
|
ADD = 'ADD'
|
|
SUBTRACT = 'SUBTRACT'
|
|
MULTIPLY = 'MULTIPLY'
|
|
...
|
|
...
|
|
</code></pre>
|
|
<p>The cases will appear in code completion if you setup an <a href="../../setup/external-editing.html">external editor</a>.</p>
|
|
<h2 id="duplicate-names"><a class="header" href="#duplicate-names">Duplicate Names</a></h2>
|
|
<p>Some nodes use the same input name multiple times. For example, the <em>Math</em> node has three inputs named <code>value</code>. To specify each value, pass a tuple for the input:</p>
|
|
<pre><code class="language-python">math(operation=Math.Operation.WRAP, value=(0.5, 1, 0)) # Pass all 3
|
|
math(operation=Math.Operation.WRAP, value=(0.5, 1)) # Only pass 2/3
|
|
math(operation=Math.Operation.WRAP, value=0.5) # Only pass 1/3
|
|
</code></pre>
|
|
<p><img src="./math_wrap.png" alt="" /></p>
|
|
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
|
|
<p>Here are two examples to show how a node maps to a function.</p>
|
|
<h3 id="cube"><a class="header" href="#cube">Cube</a></h3>
|
|
<p><img src="./cube_node.png" alt="" /></p>
|
|
<ol>
|
|
<li>Name: <code>Cube</code> -> <code>cube</code></li>
|
|
<li>Keyword Arguments
|
|
<ul>
|
|
<li><code>size: Vector</code></li>
|
|
<li><code>vertices_x: Int</code></li>
|
|
<li><code>vertices_y: Int</code></li>
|
|
<li><code>vertices_z: Int</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>Return <code>Geometry</code></li>
|
|
</ol>
|
|
<p>The node can now be used as a function:</p>
|
|
<pre><code class="language-python">cube() # All arguments are optional
|
|
cube(size=(1, 1, 1), vertices_x=3) # Optionally specify keyword arguments
|
|
cube_geo: Geometry = cube() # Returns a Geometry socket type
|
|
</code></pre>
|
|
<p>The generated documentation will show the signature, result type, and <a href="./sockets.html#chained-calls">chain syntax</a>.</p>
|
|
<h4 id="signature"><a class="header" href="#signature">Signature</a></h4>
|
|
<pre><code class="language-python">cube(
|
|
size: VectorTranslation,
|
|
vertices_x: Int,
|
|
vertices_y: Int,
|
|
vertices_z: Int
|
|
)
|
|
</code></pre>
|
|
<h4 id="result"><a class="header" href="#result">Result</a></h4>
|
|
<pre><code class="language-python">mesh: Geometry
|
|
</code></pre>
|
|
<h4 id="chain-syntax"><a class="header" href="#chain-syntax">Chain Syntax</a></h4>
|
|
<pre><code class="language-python">size: VectorTranslation = ...
|
|
size.cube(...)
|
|
</code></pre>
|
|
<h3 id="capture-attribute"><a class="header" href="#capture-attribute">Capture Attribute</a></h3>
|
|
<p><img src="./capture_attribute_node.png" alt="" /></p>
|
|
<ol>
|
|
<li>Name <code>Capture Attribute</code> -> <code>capture_attribute</code></li>
|
|
<li>Keyword Arguments
|
|
<ul>
|
|
<li>Properties
|
|
<ul>
|
|
<li><code>data_type: CaptureAttribute.DataType</code></li>
|
|
<li><code>domain: CaptureAttribute.Domain</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>Inputs
|
|
<ul>
|
|
<li><code>geometry: Geometry</code></li>
|
|
<li><code>value: Vector | Float | Color | Bool | Int</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>Return <code>{ geometry: Geometry, attribute: Int }</code></li>
|
|
</ol>
|
|
<p>The node can now be used as a function:</p>
|
|
<pre><code class="language-python">result = capture_attribute(data_type=CaptureAttribute.DataType.BOOLEAN, geometry=cube_geo) # Specify a property and an input
|
|
result.geometry # Access the geometry
|
|
result.attribute # Access the attribute
|
|
</code></pre>
|
|
<p>The generated documentation will show the signature, result type, and <a href="./sockets.html#chained-calls">chain syntax</a>.</p>
|
|
<h4 id="signature-1"><a class="header" href="#signature-1">Signature</a></h4>
|
|
<pre><code class="language-python">capture_attribute(
|
|
data_type: CaptureAttribute.DataType,
|
|
domain: CaptureAttribute.Domain,
|
|
geometry: Geometry,
|
|
value: Vector | Float | Color | Bool | Int
|
|
)
|
|
</code></pre>
|
|
<h4 id="result-1"><a class="header" href="#result-1">Result</a></h4>
|
|
<pre><code class="language-python">{ geometry: Geometry, attribute: Int }
|
|
</code></pre>
|
|
<h4 id="chain-syntax-1"><a class="header" href="#chain-syntax-1">Chain Syntax</a></h4>
|
|
<pre><code class="language-python">geometry: Geometry = ...
|
|
geometry.capture_attribute(...)
|
|
</code></pre>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../../api/basics/sockets.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../../api/advanced-scripting.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="../../api/basics/sockets.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../../api/advanced-scripting.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="../../elasticlunr.min.js"></script>
|
|
<script src="../../mark.min.js"></script>
|
|
<script src="../../searcher.js"></script>
|
|
|
|
<script src="../../clipboard.min.js"></script>
|
|
<script src="../../highlight.js"></script>
|
|
<script src="../../book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|