builder.node
node
Classes
| Name | Description |
|---|---|
| BaseNode | Base class for all node wrappers. |
| CustomCompositorGroup | Node group in a Compositor node tree. |
| CustomGeometryGroup | Node group in a Geometry Nodes tree. |
| CustomShaderGroup | Node group in a Shader (Material) node tree. |
| DynamicInputsMixin | |
| NodeGroupBuilder | Base class for custom node groups. |
BaseNode
BaseNode(node=None)Base class for all node wrappers.
Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
name |
The name of the node being wrapped by this instance. |
node |
The Blender node this instance wraps. |
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| props | Set the properties every node has and return the node, so it can |
props
props(
label=None,
color=None,
width=None,
height=None,
hide=None,
show_options=None,
hide_inputs=(),
hide_outputs=(),
mute=None,
warning_propagation=None,
pin_gizmo=None,
pin_gizmo_inputs=(),
)Set the properties every node has and return the node, so it can go at the end of a chain::
g.SetPosition(geometry=geo, offset=offset).props(
label="Lift", color="#FFAA00", width=200
)
Properties left as None are unchanged.
Args: label: The node’s header label. color: A custom header colour, as a hex string ("#FFAA00") or an (r, g, b) tuple; turns on use_custom_color. width: The node’s width. height: The node’s height; only frames use it. hide: Collapse the node. show_options: Show the node’s options (dropdowns and toggles). hide_inputs: Input sockets to hide, by name; "Value#1" names the second visible Value. hide_outputs: Output sockets to hide, by name. mute: Mute (bypass) the node. warning_propagation: Which of the node’s warnings show on the group node it sits in. pin_gizmo: Keep the node’s gizmo visible when it isn’t selected: a gizmo node’s, or a value node’s (Value, Vector, …). pin_gizmo_inputs: Inputs whose gizmos stay visible when the node isn’t selected, by name; for group nodes passing a gizmo through.
CustomCompositorGroup
CustomCompositorGroup(**kwargs)Node group in a Compositor node tree.
Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
name |
The name of the node being wrapped by this instance. |
node |
|
node_tree |
|
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| create_group | Build this group’s node tree and return it, reusing an existing tree |
| props | Set the properties every node has and return the node, so it can |
create_group
create_group()Build this group’s node tree and return it, reusing an existing tree of the same name.
Unlike instantiating the class, this needs no active TreeBuilder context — it opens its own — so a group can be pre-built and reused directly (e.g. assigned to a node’s node_tree) instead of being created by constructing the class inside a tree.
props
props(
label=None,
color=None,
width=None,
height=None,
hide=None,
show_options=None,
hide_inputs=(),
hide_outputs=(),
mute=None,
warning_propagation=None,
pin_gizmo=None,
pin_gizmo_inputs=(),
)Set the properties every node has and return the node, so it can go at the end of a chain::
g.SetPosition(geometry=geo, offset=offset).props(
label="Lift", color="#FFAA00", width=200
)
Properties left as None are unchanged.
Args: label: The node’s header label. color: A custom header colour, as a hex string ("#FFAA00") or an (r, g, b) tuple; turns on use_custom_color. width: The node’s width. height: The node’s height; only frames use it. hide: Collapse the node. show_options: Show the node’s options (dropdowns and toggles). hide_inputs: Input sockets to hide, by name; "Value#1" names the second visible Value. hide_outputs: Output sockets to hide, by name. mute: Mute (bypass) the node. warning_propagation: Which of the node’s warnings show on the group node it sits in. pin_gizmo: Keep the node’s gizmo visible when it isn’t selected: a gizmo node’s, or a value node’s (Value, Vector, …). pin_gizmo_inputs: Inputs whose gizmos stay visible when the node isn’t selected, by name; for group nodes passing a gizmo through.
CustomGeometryGroup
CustomGeometryGroup(**kwargs)Node group in a Geometry Nodes tree.
Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
name |
The name of the node being wrapped by this instance. |
node |
|
node_tree |
|
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| create_group | Build this group’s node tree and return it, reusing an existing tree |
| props | Set the properties every node has and return the node, so it can |
create_group
create_group()Build this group’s node tree and return it, reusing an existing tree of the same name.
Unlike instantiating the class, this needs no active TreeBuilder context — it opens its own — so a group can be pre-built and reused directly (e.g. assigned to a node’s node_tree) instead of being created by constructing the class inside a tree.
props
props(
label=None,
color=None,
width=None,
height=None,
hide=None,
show_options=None,
hide_inputs=(),
hide_outputs=(),
mute=None,
warning_propagation=None,
pin_gizmo=None,
pin_gizmo_inputs=(),
)Set the properties every node has and return the node, so it can go at the end of a chain::
g.SetPosition(geometry=geo, offset=offset).props(
label="Lift", color="#FFAA00", width=200
)
Properties left as None are unchanged.
Args: label: The node’s header label. color: A custom header colour, as a hex string ("#FFAA00") or an (r, g, b) tuple; turns on use_custom_color. width: The node’s width. height: The node’s height; only frames use it. hide: Collapse the node. show_options: Show the node’s options (dropdowns and toggles). hide_inputs: Input sockets to hide, by name; "Value#1" names the second visible Value. hide_outputs: Output sockets to hide, by name. mute: Mute (bypass) the node. warning_propagation: Which of the node’s warnings show on the group node it sits in. pin_gizmo: Keep the node’s gizmo visible when it isn’t selected: a gizmo node’s, or a value node’s (Value, Vector, …). pin_gizmo_inputs: Inputs whose gizmos stay visible when the node isn’t selected, by name; for group nodes passing a gizmo through.
CustomShaderGroup
CustomShaderGroup(**kwargs)Node group in a Shader (Material) node tree.
Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
name |
The name of the node being wrapped by this instance. |
node |
|
node_tree |
|
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| create_group | Build this group’s node tree and return it, reusing an existing tree |
| props | Set the properties every node has and return the node, so it can |
create_group
create_group()Build this group’s node tree and return it, reusing an existing tree of the same name.
Unlike instantiating the class, this needs no active TreeBuilder context — it opens its own — so a group can be pre-built and reused directly (e.g. assigned to a node’s node_tree) instead of being created by constructing the class inside a tree.
props
props(
label=None,
color=None,
width=None,
height=None,
hide=None,
show_options=None,
hide_inputs=(),
hide_outputs=(),
mute=None,
warning_propagation=None,
pin_gizmo=None,
pin_gizmo_inputs=(),
)Set the properties every node has and return the node, so it can go at the end of a chain::
g.SetPosition(geometry=geo, offset=offset).props(
label="Lift", color="#FFAA00", width=200
)
Properties left as None are unchanged.
Args: label: The node’s header label. color: A custom header colour, as a hex string ("#FFAA00") or an (r, g, b) tuple; turns on use_custom_color. width: The node’s width. height: The node’s height; only frames use it. hide: Collapse the node. show_options: Show the node’s options (dropdowns and toggles). hide_inputs: Input sockets to hide, by name; "Value#1" names the second visible Value. hide_outputs: Output sockets to hide, by name. mute: Mute (bypass) the node. warning_propagation: Which of the node’s warnings show on the group node it sits in. pin_gizmo: Keep the node’s gizmo visible when it isn’t selected: a gizmo node’s, or a value node’s (Value, Vector, …). pin_gizmo_inputs: Inputs whose gizmos stay visible when the node isn’t selected, by name; for group nodes passing a gizmo through.
DynamicInputsMixin
DynamicInputsMixin()NodeGroupBuilder
NodeGroupBuilder(**kwargs)Base class for custom node groups.
Subclasses implement :meth:_build_group with the node-graph logic. Subclass one of the editor-specific variants: :class:GeometryNodeGroup, :class:ShaderNodeGroup, or :class:CompositorNodeGroup.
Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
name |
The name of the node being wrapped by this instance. |
node |
The Blender node this instance wraps. |
node_tree |
The internal node tree for this group node. |
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| create_group | Build this group’s node tree and return it, reusing an existing tree |
| props | Set the properties every node has and return the node, so it can |
create_group
create_group()Build this group’s node tree and return it, reusing an existing tree of the same name.
Unlike instantiating the class, this needs no active TreeBuilder context — it opens its own — so a group can be pre-built and reused directly (e.g. assigned to a node’s node_tree) instead of being created by constructing the class inside a tree.
props
props(
label=None,
color=None,
width=None,
height=None,
hide=None,
show_options=None,
hide_inputs=(),
hide_outputs=(),
mute=None,
warning_propagation=None,
pin_gizmo=None,
pin_gizmo_inputs=(),
)Set the properties every node has and return the node, so it can go at the end of a chain::
g.SetPosition(geometry=geo, offset=offset).props(
label="Lift", color="#FFAA00", width=200
)
Properties left as None are unchanged.
Args: label: The node’s header label. color: A custom header colour, as a hex string ("#FFAA00") or an (r, g, b) tuple; turns on use_custom_color. width: The node’s width. height: The node’s height; only frames use it. hide: Collapse the node. show_options: Show the node’s options (dropdowns and toggles). hide_inputs: Input sockets to hide, by name; "Value#1" names the second visible Value. hide_outputs: Output sockets to hide, by name. mute: Mute (bypass) the node. warning_propagation: Which of the node’s warnings show on the group node it sits in. pin_gizmo: Keep the node’s gizmo visible when it isn’t selected: a gizmo node’s, or a value node’s (Value, Vector, …). pin_gizmo_inputs: Inputs whose gizmos stay visible when the node isn’t selected, by name; for group nodes passing a gizmo through.