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 > Tree Functions - 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" class = "active" > < 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" > < 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 = "tree-functions" > < a class = "header" href = "#tree-functions" > Tree Functions< / a > < / h1 >
< p > Node trees are created by decorating a function with < code > @tree< / code > . Let's try creating a simple tree function.< / p >
< blockquote >
< p > The code samples for the rest of the book assume you are importing all names with < code > from geometry_script import *< / code > . However, if you are using a namespaced import, simply prefix the functions and types with < code > geometry_script< / code > or your custom name.< / p >
< / blockquote >
< pre > < code class = "language-python" > @tree
def cube_tree():
...
< / code > < / pre >
< p > By default, the name of your function will be used as the name of the generated node tree. However, you can specify a custom name by passing a string to < code > @tree< / code > :< / p >
< pre > < code class = "language-python" > @tree(" Cube Tree" )
def cube_tree():
...
< / code > < / pre >
< h2 id = "group-output" > < a class = "header" href = "#group-output" > Group Output< / a > < / h2 >
< p > Every node tree is < strong > required< / strong > to return < code > Geometry< / code > as the first output. Let's try returning a simple cube.< / p >
< pre > < code class = "language-python" > @tree(" Cube Tree" )
def cube_tree():
return cube()
< / code > < / pre >
< p > Here we call the < code > cube(...)< / code > function, which creates a < em > Cube< / em > node and connects it to the < em > Group Output< / em > .< / p >
< p > < img src = "./cube_tree.png" alt = "" / > < / p >
< p > You can also return multiple values. However, < code > Geometry< / code > must always be returned first for a tree to be valid.< / p >
< pre > < code class = "language-python" > @tree(" Cube Tree" )
def cube_tree():
return cube(), 5
< / code > < / pre >
< p > < img src = "./cube_tree_int.png" alt = "" / > < / p >
2023-02-12 16:45:37 +00:00
< p > By default, each output is named 'Result'. To customize the name, return a dictionary.< / p >
< pre > < code class = "language-python" > @tree(" Cube Tree" )
def cube_tree():
return {
" My Cube" : cube(),
" Scale Constant" : 5
}
< / code > < / pre >
< p > < img src = "./cube_tree_named_outputs.png" alt = "" / > < / p >
2022-11-15 18:36:08 +00:00
< h2 id = "group-input" > < a class = "header" href = "#group-input" > Group Input< / a > < / h2 >
< p > All arguments in a tree function must be annotated with a valid socket type. These types are provided by Geometry Script, and are not equivalent to Python's built-in types. Let's add a size argument to our Cube Tree.< / p >
< pre > < code class = "language-python" > @tree(" Cube Tree" )
def cube_tree(size: Vector):
return cube(size=size)
< / code > < / pre >
< p > This creates a < em > Size< / em > socket on the < em > Group Input< / em > node and connects it to our cube.< / p >
< p > < img src = "./cube_tree_size.png" alt = "" / > < / p >
< p > The option is available on the Geometry Nodes modifier.< / p >
< p > < img src = "./cube_tree_modifier.png" alt = "" / > < / p >
< p > The available socket types match those in the UI. Here are some common ones:< / p >
< ul >
< li > < code > Geometry< / code > < / li >
< li > < code > Float< / code > < / li >
< li > < code > Int< / code > < / li >
< li > < code > Vector< / code > < / li >
< / ul >
< blockquote >
< p > You < em > cannot< / em > use Python's built-in types in place of these socket types.< / p >
< / blockquote >
< p > In the next chapter, we'll take a closer look at how socket types work, and what you can and cannot do with them.< / p >
< h3 id = "default-values" > < a class = "header" href = "#default-values" > Default Values< / a > < / h3 >
< p > You can specify a default for any argument, and it will be set on the modifier when added:< / p >
< pre > < code class = "language-python" > @tree(" Cube Tree" )
def cube_tree(size: Vector = (1, 1, 1)):
return cube(size=size)
< / code > < / pre >
< p > < img src = "./cube_tree_size_input.png" alt = "" / > < / p >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "../../api/basics/modules.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/basics/sockets.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/modules.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/basics/sockets.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 >
