Layout

Source code in core/treeclass.py

class Layout:
    def __init__(self, title: str = "", color: str = 'RANDOM', node = None):
        """ Node Frame

        All nodes created when a Layout is open are placed in this layout.
        If the 'color' argument is None, a random color is used

        If the node argument is None, the layout parent is the current layout, otherwise,
        the layout becomes the parent of the node and the previous parent of the node
        becomes the layout parent.

        ``` python
        with GeoNodes("Layout Demo"):

            with Layout("Some maths"):
                a = Integer(1) + 1

            geo = Mesh()
            geo.points.offset = (0, 0, a)

            geo.out()
        ```

        Parameters
        ----------
        title : str, optional
            Layout title default="".

        color : blender color, optional
            Layout color (randomly generated if None) default=None.

        node : Node, optional
            the layout is inserted as direct parent of the node default=None.

        """

        self.tree  = Tree.current_tree()
        self.bnode = self.tree._btree.nodes.new('NodeFrame')
        self.bnode.select = False
        self.transparent = title is None
        if not self.transparent:
            self.title = title

        self.color = self.tree._get_color(color)

        # Parent from the stack
        if len(self.tree._layouts):
            self.bnode.parent = self.tree._layouts[-1].bnode

        # There is a node to become the parent of
        if node is not None:

            # The node parent can override the current parent
            if node._bnode.parent is not None:
                self.bnode.parent = node._bnode.parent

            # Include the node
            self.include_node(node)

    def __str__(self):
        nodes = [n for n in self.tree._nodes.values() if n._bnode.parent == self.bnode]
        return f"<Layout '{self.title}', {len(nodes)} nodes>"

    # ====================================================================================================
    # Include a node
    # ====================================================================================================

    def include_node(self, node):
        if node._bnode.bl_idname not in ('NodeGroupOutput',):
            if self.transparent:
                node._bnode.parent = self.bnode.parent
            else:
                node._bnode.parent = self.bnode

    # ====================================================================================================
    # Title / color
    # ====================================================================================================

    @property
    def title(self):
        return self.bnode.label

    @title.setter
    def title(self, value):
        if value is not None:
            self.bnode.label = value

    @property
    def color(self):
        return self.bnode.color

    @color.setter
    def color(self, value):
        color = Tree._get_color(value)
        if color.is_none:
            self.bnode.use_custom_color = False
        else:
            self.bnode.use_custom_color = True
            self.bnode.color = color.bcolor

    # ====================================================================================================
    # Context
    # ====================================================================================================

    def push(self):
        self.tree._layouts.append(self)

    def pop(self):
        assert self.tree._layouts.pop() == self, f"Shouldn't happen with Layout '{self.title}'"

    def __enter__(self):
        self.push()
        return self

    def __exit__(self, type, exc_value, traceback):
        self.pop()

        if isinstance(exc_value, Break):
            return True

__init__(title='', color='RANDOM', node=None)

Node Frame

All nodes created when a Layout is open are placed in this layout. If the 'color' argument is None, a random color is used

If the node argument is None, the layout parent is the current layout, otherwise, the layout becomes the parent of the node and the previous parent of the node becomes the layout parent.

with GeoNodes("Layout Demo"):

    with Layout("Some maths"):
        a = Integer(1) + 1

    geo = Mesh()
    geo.points.offset = (0, 0, a)

    geo.out()

Parameters:

Name	Type	Description	Default
title	str	Layout title default="".	''
color	blender color	Layout color (randomly generated if None) default=None.	'RANDOM'
node	Node	the layout is inserted as direct parent of the node default=None.	None

Source code in core/treeclass.py

def __init__(self, title: str = "", color: str = 'RANDOM', node = None):
    """ Node Frame

    All nodes created when a Layout is open are placed in this layout.
    If the 'color' argument is None, a random color is used

    If the node argument is None, the layout parent is the current layout, otherwise,
    the layout becomes the parent of the node and the previous parent of the node
    becomes the layout parent.

    ``` python
    with GeoNodes("Layout Demo"):

        with Layout("Some maths"):
            a = Integer(1) + 1

        geo = Mesh()
        geo.points.offset = (0, 0, a)

        geo.out()
    ```

    Parameters
    ----------
    title : str, optional
        Layout title default="".

    color : blender color, optional
        Layout color (randomly generated if None) default=None.

    node : Node, optional
        the layout is inserted as direct parent of the node default=None.

    """

    self.tree  = Tree.current_tree()
    self.bnode = self.tree._btree.nodes.new('NodeFrame')
    self.bnode.select = False
    self.transparent = title is None
    if not self.transparent:
        self.title = title

    self.color = self.tree._get_color(color)

    # Parent from the stack
    if len(self.tree._layouts):
        self.bnode.parent = self.tree._layouts[-1].bnode

    # There is a node to become the parent of
    if node is not None:

        # The node parent can override the current parent
        if node._bnode.parent is not None:
            self.bnode.parent = node._bnode.parent

        # Include the node
        self.include_node(node)