2022-11-15 18:36:08 +00:00
<!DOCTYPE HTML>
2023-10-08 14:58:48 +00:00
< html lang = "en" class = "coal" dir = "ltr" >
2022-11-15 18:36:08 +00:00
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Node Groups - 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" >
2023-10-08 14:58:48 +00:00
< meta name = "theme-color" content = "#ffffff" >
2022-11-15 18:36:08 +00:00
< 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 >
2023-10-08 14:58:48 +00:00
< body class = "sidebar-visible no-js" >
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');
2022-11-17 18:08:13 +00:00
html.classList.remove('coal')
2022-11-15 18:36:08 +00:00
html.classList.add(theme);
2023-10-08 14:58:48 +00:00
var body = document.querySelector('body');
body.classList.remove('no-js')
body.classList.add('js');
2022-11-15 18:36:08 +00:00
< / script >
2023-10-08 14:58:48 +00:00
< input type = "checkbox" id = "sidebar-toggle-anchor" class = "hidden" >
2022-11-15 18:36:08 +00:00
<!-- Hide / unhide sidebar before it is displayed -->
2022-11-28 22:32:45 +00:00
< script >
2023-10-08 14:58:48 +00:00
var body = document.querySelector('body');
2023-04-01 20:34:08 +00:00
var sidebar = null;
2023-10-08 14:58:48 +00:00
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
2022-11-15 18:36:08 +00:00
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
2023-04-01 20:34:08 +00:00
} else {
sidebar = 'hidden';
2022-11-15 18:36:08 +00:00
}
2023-10-08 14:58:48 +00:00
sidebar_toggle.checked = sidebar === 'visible';
body.classList.remove('sidebar-visible');
body.classList.add("sidebar-" + sidebar);
2022-11-15 18:36:08 +00:00
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2023-11-11 19:04:36 +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" > < 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" class = "active" > < 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 >
2022-11-15 18:36:08 +00:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
2023-10-08 14:58:48 +00:00
<!-- 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 >
2022-11-15 18:36:08 +00:00
< 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 >
2023-10-08 14:58:48 +00:00
< div id = "menu-bar" class = "menu-bar sticky" >
2022-11-15 18:36:08 +00:00
< div class = "left-buttons" >
2023-10-08 14:58:48 +00:00
< 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" >
2022-11-15 18:36:08 +00:00
< i class = "fa fa-bars" > < / i >
2023-10-08 14:58:48 +00:00
< / label >
2022-11-15 18:36:08 +00:00
< 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 = "node-groups" > < a class = "header" href = "#node-groups" > Node Groups< / a > < / h1 >
< p > A Geometry Script can have more than one tree function. Each tree function is a node group, and tree functions can be used in other tree functions to create < em > Node Group< / em > nodes.< / p >
< pre > < code class = "language-python" > @tree(" Instance Grid" )
def instance_grid(instance: Geometry):
" " " Instance the input geometry on a grid " " "
return grid().mesh_to_points().instance_on_points(instance=instance)
@tree(" Cube Grid" )
def cube_grid():
" " " Create a grid of cubes " " "
return instance_grid(instance=cube(size=0.2))
< / code > < / pre >
< p > The < em > Cube Grid< / em > tree uses the < em > Instance Grid< / em > node group by calling the < code > instance_grid< / code > function:< / p >
< p > < img src = "./cube_grid.png" alt = "" / > < / p >
< p > The < em > Instance Grid< / em > node group uses the passed in < code > instance< / code > argument to create a grid of instances:< / p >
< p > < img src = "./instance_grid.png" alt = "" / > < / p >
< p > This concept can scale to complex interconnected node trees, while keeping everything neatly organized in separate functions.< / p >
2022-11-20 23:09:31 +00:00
< h2 id = "functions-vs-node-groups" > < a class = "header" href = "#functions-vs-node-groups" > Functions vs Node Groups< / a > < / h2 >
< p > You do not have to mark a function with < code > @tree(...)< / code > . If you don't, function calls are treated as normal in Python. No checks are made against the arguments. Any nodes created in the callee will be placed in the caller's tree.< / p >
< pre > < code class = "language-python" > def instance_grid(instance: Geometry): # Not marked with `@tree(...)`
return grid().mesh_to_points().instance_on_points(instance=instance)
@tree(" Cube Grid" )
def cube_grid(): # Marked with `@tree(...)`
return instance_grid(instance=cube(size=0.2))
< / code > < / pre >
< p > The above example would place the < em > Grid< / em > , < em > Mesh to Points< / em > , and < em > Instance on Points< / em > nodes in the main " Cube Grid" tree. It could be rewritten as:< / p >
< pre > < code class = "language-python" > @tree(" Cube Grid" )
def cube_grid():
return grid().mesh_to_points().instance_on_points(instance=cube(size=0.2))
< / code > < / pre >
2022-11-15 18:36:08 +00:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "../../api/advanced-scripting.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
2023-10-08 14:58:48 +00:00
< a rel = "next prefetch" href = "../../api/advanced-scripting/generators.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2022-11-15 18:36:08 +00:00
< 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/advanced-scripting.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
2023-10-08 14:58:48 +00:00
< a rel = "next prefetch" href = "../../api/advanced-scripting/generators.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2022-11-15 18:36:08 +00:00
< 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 >
