2022-11-15 18:36:08 +00:00
<!DOCTYPE HTML>
2022-11-17 18:08:13 +00:00
< html lang = "en" class = "sidebar-visible no-js coal" >
2022-11-15 18:36:08 +00:00
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Using Nodes - Geometry Script< / title >
2023-02-12 16:45:37 +00:00
2022-11-15 18:36:08 +00:00
<!-- Custom HTML head -->
2023-02-12 16:45:37 +00:00
2022-11-15 18:36:08 +00:00
< 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" >
2023-02-12 16:45:37 +00:00
2022-11-15 18:36:08 +00:00
<!-- Fonts -->
< link rel = "stylesheet" href = "../../FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "../../fonts/fonts.css" >
2023-02-12 16:45:37 +00:00
2022-11-15 18:36:08 +00:00
<!-- 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 -->
2022-11-17 18:08:13 +00:00
< link rel = "stylesheet" href = "../../style.css" >
2023-02-12 16:45:37 +00:00
2022-11-15 18:36:08 +00:00
< / head >
< body >
2023-02-12 16:45:37 +00:00
< div id = "body-container" >
2022-11-15 18:36:08 +00:00
<!-- Provide site root to javascript -->
2022-11-28 22:32:45 +00:00
< script >
2022-11-15 18:36:08 +00:00
var path_to_root = "../../";
2022-11-17 18:08:13 +00:00
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "coal" : "coal";
2022-11-15 18:36:08 +00:00
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
2022-11-28 22:32:45 +00:00
< script >
2022-11-15 18:36:08 +00:00
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 -->
2022-11-28 22:32:45 +00:00
< script >
2022-11-15 18:36:08 +00:00
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('no-js')
2022-11-17 18:08:13 +00:00
html.classList.remove('coal')
2022-11-15 18:36:08 +00:00
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
2022-11-28 22:32:45 +00:00
< script >
2022-11-15 18:36:08 +00:00
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2022-12-01 14:07:32 +00:00
< 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/drivers.html" > < strong aria-hidden = "true" > 5.6.< / strong > Drivers< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../api/advanced-scripting/simulation.html" > < strong aria-hidden = "true" > 5.7.< / 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 >
2022-11-15 18:36:08 +00:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
2023-02-12 16:45:37 +00:00
< div id = "menu-bar-hover-placeholder" > < / div >
2022-11-15 18:36:08 +00:00
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< 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" >
2022-11-17 18:08:13 +00:00
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light< / button > < / li >
2022-11-15 18:36:08 +00:00
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
2022-11-28 22:32:45 +00:00
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
2022-11-15 18:36:08 +00:00
< 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 >
2023-02-12 16:45:37 +00:00
2022-11-15 18:36:08 +00:00
< / 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 >
2023-02-12 16:45:37 +00:00
2022-11-15 18:36:08 +00:00
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
2022-11-28 22:32:45 +00:00
< script >
2022-11-15 18:36:08 +00:00
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 >
2022-11-17 18:08:13 +00:00
< 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
2022-11-17 18:18:27 +00:00
math(operation=Math.Operation.ADD)
math(operation=Math.Operation.SUBTRACT)
2022-11-17 18:08:13 +00:00
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):
2022-11-17 18:18:27 +00:00
ADD = 'ADD'
SUBTRACT = 'SUBTRACT'
MULTIPLY = 'MULTIPLY'
2022-11-17 18:08:13 +00:00
...
...
< / 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 >
2022-11-17 18:18:27 +00:00
< 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
2022-11-17 18:08:13 +00:00
< / 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 >
2022-11-15 18:36:08 +00:00
< 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 >
2022-11-17 18:08:13 +00:00
< li > < code > data_type: CaptureAttribute.DataType< / code > < / li >
< li > < code > domain: CaptureAttribute.Domain< / code > < / li >
2022-11-15 18:36:08 +00:00
< / 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 >
2022-11-17 18:18:27 +00:00
< pre > < code class = "language-python" > result = capture_attribute(data_type=CaptureAttribute.DataType.BOOLEAN, geometry=cube_geo) # Specify a property and an input
2022-11-15 18:36:08 +00:00
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(
2022-11-17 18:08:13 +00:00
data_type: CaptureAttribute.DataType,
domain: CaptureAttribute.Domain,
2022-11-15 18:36:08 +00:00
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 >
2023-02-12 16:45:37 +00:00
2022-11-15 18:36:08 +00:00
< a rel = "next" 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 >
2023-02-12 16:45:37 +00:00
2022-11-15 18:36:08 +00:00
< 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 >
2023-02-12 16:45:37 +00:00
2022-11-15 18:36:08 +00:00
< a rel = "next" 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 >
2023-02-12 16:45:37 +00:00
2022-11-28 22:32:45 +00:00
< script >
2022-11-15 18:36:08 +00:00
window.playground_copyable = true;
< / script >
2023-02-12 16:45:37 +00:00
2022-11-28 22:32:45 +00:00
< script src = "../../elasticlunr.min.js" > < / script >
< script src = "../../mark.min.js" > < / script >
< script src = "../../searcher.js" > < / script >
2023-02-12 16:45:37 +00:00
2022-11-28 22:32:45 +00:00
< script src = "../../clipboard.min.js" > < / script >
< script src = "../../highlight.js" > < / script >
< script src = "../../book.js" > < / script >
2022-11-15 18:36:08 +00:00
<!-- Custom JS scripts -->
2023-02-12 16:45:37 +00:00
< / div >
2022-11-15 18:36:08 +00:00
< / body >
< / html >
