nodes.geometry.geometry
geometry
Classes
| Name | Description |
|---|---|
| Arc | Generate a poly spline arc |
| Bake | Cache the incoming data so that it can be used without recomputation |
| BezierSegment | Generate a 2D Bézier spline from the given control points and handles |
| BoundingBox | Calculate the limits of a geometry’s positions and generate a box mesh with those dimensions |
| Cone | Generate a cone mesh |
| ConstructCurves | Construct curves from raw topology data |
| ConvexHull | Create a mesh that encloses all points in the input geometry with the smallest number of points |
| Cube | Generate a cuboid mesh with variable side lengths and subdivisions |
| CurveCircle | Generate a poly spline circle |
| CurveLength | Retrieve the length of all splines added together |
| CurveLine | Generate a poly spline line with two points |
| CurveToMesh | Convert curves into a mesh, optionally with a custom profile shape defined by curves |
| CurveToPoints | Generate a point cloud by sampling positions along curves |
| CurvesToGreasePencil | Convert the curves in each top-level instance into Grease Pencil layer |
| Cylinder | Generate a cylinder mesh |
| DeformCurvesOnSurface | Translate and rotate curves based on changes between the object’s original and evaluated surface mesh |
| DeleteGeometry | Remove selected elements of a geometry |
| DistributePointsOnFaces | Generate points spread out on the surface of a mesh |
| DualMesh | Convert Faces into vertices and vertices into faces |
| DuplicateElements | Generate an arbitrary number copies of each selected input element |
| EdgePathsToCurves | Output curves following paths across mesh edges |
| ExtrudeMesh | Generate new vertices, edges, or faces from selected elements and move them based on an offset while keeping them connected by their boundary |
| FillCurve | Generate a mesh on the XY plane with faces on the inside of input curves |
| FilletCurve | Round corners by generating circular arcs on each control point |
| FlipFaces | Reverse the order of the vertices and edges of selected faces, flipping their normal direction |
| GeometryMaterials | Get a list of the materials used by a geometry component |
| GeometryProximity | Compute the closest location on the target geometry |
| GetGeometryBundle | Get the bundle of a geometry |
| GetGeometryComponent | Get a single component of a geometry |
| GreasePencilToCurves | Convert Grease Pencil layers into curve instances |
| Grid | Generate a planar mesh on the XY plane |
| IcoSphere | Generate a spherical mesh that consists of equally sized triangles |
| InstanceOnPoints | Generate a reference to geometry at each of the input points, without duplicating its underlying data |
| InstancesToPoints | Generate points at the origins of instances. |
| InterpolateCurves | Generate new curves on points by interpolating between existing curves |
| MaterialSelection | Provide a selection of faces that use the specified material |
| MergeByDistance | Merge vertices or points within a given distance |
| MergeLayers | Join groups of Grease Pencil layers into one |
| MergePoints | Merge points of a point cloud or mesh based on group ID and selection. |
| MeshBevel | Bevel selected edges or vertices |
| MeshCircle | Generate a circular ring of edges |
| MeshLine | Generate vertices in a line and connect them with edges |
| MeshToCurve | Generate a curve from a mesh |
| MeshToPoints | Generate a point cloud from a mesh’s vertices |
| Points | Generate a point cloud with positions and radii defined by fields |
| PointsToCurves | Split all points to curve by its group ID and reorder by weight |
| PointsToVertices | Generate a mesh vertex for each point cloud point |
| QuadraticBezier | Generate a poly spline in a parabola shape with control points positions |
| Quadrilateral | Generate a polygon with four points |
| RasterizePoints | Create volume grids from points with a weighted sum |
| Raycast | Cast rays from the context geometry onto a target geometry, and retrieve information from each hit point |
| RealizeInstances | Convert instances into real geometry data |
| RenameAttribute | Change the name of an attribute |
| ReplaceMaterial | Swap one material with another |
| ResampleCurve | Generate a poly spline for each input spline |
| ReverseCurve | Change the direction of curves by swapping their start and end data |
| RotateInstances | Rotate geometry instances in local or global space |
| SampleNearest | Find the element of a geometry closest to a position. Similar to the “Index of Nearest” node |
| SampleNearestSurface | Calculate the interpolated value of a mesh attribute on the closest point of its surface |
| SampleUVSurface | Calculate the interpolated values of a mesh attribute at a UV coordinate |
| ScaleElements | Scale groups of connected edges and faces |
| ScaleInstances | Scale geometry instances in local or global space |
| SeparateComponents | Split a geometry into a separate output for each type of data in the geometry |
| SeparateGeometry | Split a geometry into two geometry outputs based on a selection |
| SetCurveNormal | Set the evaluation mode for curve normals |
| SetCurveRadius | Set the radius of the curve at each control point |
| SetCurveTilt | Set the tilt angle at each curve control point |
| SetFaceSet | Set sculpt face set values for faces |
| SetGeometryBundle | Set the bundle of a geometry |
| SetGeometryName | Set the name of a geometry for easier debugging |
| SetGreasePencilColor | Set color and opacity attributes on Grease Pencil geometry |
| SetGreasePencilDepth | Set the Grease Pencil depth order to use |
| SetGreasePencilSoftness | Set softness attribute on Grease Pencil geometry |
| SetHandlePositions | Set the positions for the handles of Bézier curves |
| SetHandleType | Set the handle type for the control points of a Bézier curve |
| SetID | Set the id attribute on the input geometry, mainly used internally for randomizing |
| SetInstanceTransform | Set the transformation matrix of every instance |
| SetMaterial | Assign a material to geometry elements |
| SetMaterialIndex | Set the material index for each selected geometry element |
| SetMeshNormal | Store a normal vector for each mesh element |
| SetNURBSOrder | Control how many curve control points influence each evaluated point by changing the “nurbs_order” attribute |
| SetNURBSWeight | Control the influence of each NURBS control point on the curve by changing the “nurbs_weight” attribute |
| SetPointCloudType | Change the type of point cloud |
| SetPointRadius | Set the display size of point cloud points |
| SetPosition | Set the location of each point |
| SetSelection | Set selection of the edited geometry, for tool execution |
| SetShadeSmooth | Control the smoothness of mesh normals around each face by changing the “shade smooth” attribute |
| SetSplineCyclic | Control whether each spline loops back on itself by changing the “cyclic” attribute |
| SetSplineResolution | Control how many evaluated points should be generated on every curve segment |
| SetSplineType | Change the type of curves |
| SortElements | Rearrange geometry elements, changing their indices |
| Spiral | Generate a poly spline in a spiral shape |
| SplitEdges | Duplicate mesh edges and break connections with the surrounding faces |
| SplitToInstances | Create separate geometries containing the elements from the same group |
| Star | Generate a poly spline in a star pattern by connecting alternating points of two circles |
| StringToCurves | Generate a paragraph of text with a specific font, using a curve instance to store each character |
| SubdivideCurve | Dividing each curve segment into a specified number of pieces |
| SubdivideMesh | Divide mesh faces into smaller ones without changing the shape or volume, using linear interpolation to place the new vertices |
| SubdivisionSurface | Divide mesh faces to form a smooth surface, using the Catmull-Clark subdivision method |
| TransferAttributes | Copy attributes from one geometry to another |
| TransformGeometry | Translate, rotate or scale the geometry |
| TranslateInstances | Move top-level geometry instances in local or global space |
| Triangulate | Convert all faces in a mesh to triangular faces |
| TrimCurve | Shorten curves by removing portions at the start or end |
| UVSphere | Generate a spherical mesh with quads, except for triangles at the top and bottom |
| XPBDSolver | Simulate physics using the XPBD framework |
Arc
Arc(
resolution=16,
start=(-1.0, 0.0, 0.0),
middle=(0.0, 2.0, 0.0),
end=(1.0, 0.0, 0.0),
radius=1.0,
start_angle=0.0,
sweep_angle=7 * math.pi / 4,
offset_angle=0.0,
connect_center=False,
invert_arc=False,
*,
mode='RADIUS',
)Generate a poly spline arc
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| resolution | InputInteger | Resolution | 16 |
| start | InputVector | Start | (-1.0, 0.0, 0.0) |
| middle | InputVector | Middle | (0.0, 2.0, 0.0) |
| end | InputVector | End | (1.0, 0.0, 0.0) |
| radius | InputFloat | Radius | 1.0 |
| start_angle | InputFloat | Start Angle | 0.0 |
| sweep_angle | InputFloat | Sweep Angle | 7 * math.pi / 4 |
| offset_angle | InputFloat | Offset Angle | 0.0 |
| connect_center | InputBoolean | Connect Center | False |
| invert_arc | InputBoolean | Invert Arc | False |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| points | Create Arc with operation ‘Points’. Define arc by 3 points on circle. Arc is calculated between start and end points |
| props | Set the properties every node has and return the node, so it can |
| radius | Create Arc with operation ‘Radius’. Define radius with a float |
points
points(
resolution=16,
start=(-1.0, 0.0, 0.0),
middle=(0.0, 2.0, 0.0),
end=(1.0, 0.0, 0.0),
offset_angle=0.0,
connect_center=False,
invert_arc=False,
)Create Arc with operation ‘Points’. Define arc by 3 points on circle. Arc is calculated between start and end points
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.
radius
radius(
resolution=16,
radius=1.0,
start_angle=0.0,
sweep_angle=7 * math.pi / 4,
connect_center=False,
invert_arc=False,
)Create Arc with operation ‘Radius’. Define radius with a float
Inputs
| Attribute | Type | Description |
|---|---|---|
i.resolution |
IntegerSocket |
Resolution |
i.start |
VectorSocket |
Start |
i.middle |
VectorSocket |
Middle |
i.end |
VectorSocket |
End |
i.radius |
FloatSocket |
Radius |
i.start_angle |
FloatSocket |
Start Angle |
i.sweep_angle |
FloatSocket |
Sweep Angle |
i.offset_angle |
FloatSocket |
Offset Angle |
i.connect_center |
BooleanSocket |
Connect Center |
i.invert_arc |
BooleanSocket |
Invert Arc |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
o.center |
VectorSocket |
Center |
o.normal |
VectorSocket |
Normal |
o.radius |
FloatSocket |
Radius |
Bake
Bake(*args, items=None, **kwargs)Cache the incoming data so that it can be used without recomputation
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| *args | InputLinkable | str | Values to bake, each as an item named after the socket it comes from; a socket-type string declares an unlinked item. | () |
| items | dict[str, InputLinkable | str] | None | Items by name: a value to bake, or a socket-type string. | None |
| **kwargs | InputLinkable | str | More items by name. | {} |
Attributes
| Name | Description |
|---|---|
i |
|
items |
The bake items. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
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.
BezierSegment
BezierSegment(
resolution=16,
start=(-1.0, 0.0, 0.0),
start_handle=(-0.5, 0.5, 0.0),
end_handle=(0.0, 0.0, 0.0),
end=(1.0, 0.0, 0.0),
*,
mode='POSITION',
)Generate a 2D Bézier spline from the given control points and handles
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| resolution | InputInteger | Resolution | 16 |
| start | InputVector | Start | (-1.0, 0.0, 0.0) |
| start_handle | InputVector | Start Handle | (-0.5, 0.5, 0.0) |
| end_handle | InputVector | End Handle | (0.0, 0.0, 0.0) |
| end | InputVector | End | (1.0, 0.0, 0.0) |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| offset | Create Bézier Segment with operation ‘Offset’. The start and end handles are offsets from the spline’s control points |
| position | Create Bézier Segment with operation ‘Position’. The start and end handles are fixed positions |
| props | Set the properties every node has and return the node, so it can |
offset
offset(
resolution=16,
start=(-1.0, 0.0, 0.0),
start_handle=(-0.5, 0.5, 0.0),
end_handle=(0.0, 0.0, 0.0),
end=(1.0, 0.0, 0.0),
)Create Bézier Segment with operation ‘Offset’. The start and end handles are offsets from the spline’s control points
position
position(
resolution=16,
start=(-1.0, 0.0, 0.0),
start_handle=(-0.5, 0.5, 0.0),
end_handle=(0.0, 0.0, 0.0),
end=(1.0, 0.0, 0.0),
)Create Bézier Segment with operation ‘Position’. The start and end handles are fixed positions
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.resolution |
IntegerSocket |
Resolution |
i.start |
VectorSocket |
Start |
i.start_handle |
VectorSocket |
Start Handle |
i.end_handle |
VectorSocket |
End Handle |
i.end |
VectorSocket |
End |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
BoundingBox
BoundingBox(geometry=None, use_radius=True)Calculate the limits of a geometry’s positions and generate a box mesh with those dimensions
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| use_radius | InputBoolean | Use Radius | True |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.use_radius |
BooleanSocket |
Use Radius |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bounding_box |
GeometrySocket |
Bounding Box |
o.min |
VectorSocket |
Min |
o.max |
VectorSocket |
Max |
Cone
Cone(
vertices=32,
side_segments=1,
fill_segments=1,
radius_top=0.0,
radius_bottom=1.0,
depth=2.0,
*,
fill_type='NGON',
)Generate a cone mesh
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| vertices | InputInteger | Vertices | 32 |
| side_segments | InputInteger | Side Segments | 1 |
| fill_segments | InputInteger | Fill Segments | 1 |
| radius_top | InputFloat | Radius Top | 0.0 |
| radius_bottom | InputFloat | Radius Bottom | 1.0 |
| depth | InputFloat | Depth | 2.0 |
Attributes
| Name | Description |
|---|---|
fill_type |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| n_gon | Create Cone with operation ‘N-Gon’. |
| none | Create Cone with operation ‘None’. |
| props | Set the properties every node has and return the node, so it can |
| triangles | Create Cone with operation ‘Triangles’. |
n_gon
n_gon(
vertices=32,
side_segments=1,
fill_segments=1,
radius_top=0.0,
radius_bottom=1.0,
depth=2.0,
)Create Cone with operation ‘N-Gon’.
none
none(vertices=32, side_segments=1, radius_top=0.0, radius_bottom=1.0, depth=2.0)Create Cone with operation ‘None’.
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.
triangles
triangles(
vertices=32,
side_segments=1,
fill_segments=1,
radius_top=0.0,
radius_bottom=1.0,
depth=2.0,
)Create Cone with operation ‘Triangles’.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.vertices |
IntegerSocket |
Vertices |
i.side_segments |
IntegerSocket |
Side Segments |
i.fill_segments |
IntegerSocket |
Fill Segments |
i.radius_top |
FloatSocket |
Radius Top |
i.radius_bottom |
FloatSocket |
Radius Bottom |
i.depth |
FloatSocket |
Depth |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
o.top |
BooleanSocket |
Top |
o.bottom |
BooleanSocket |
Bottom |
o.side |
BooleanSocket |
Side |
o.uv_map |
VectorSocket |
UV Map |
ConstructCurves
ConstructCurves(positions=None, curve_offsets=None)Construct curves from raw topology data
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| positions | InputVectorList | Positions | None |
| curve_offsets | InputIntegerList | Curve Offsets | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.positions |
VectorSocketList |
Positions |
i.curve_offsets |
IntegerSocketList |
Curve Offsets |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curves |
GeometrySocket |
Curves |
ConvexHull
ConvexHull(geometry=None)Create a mesh that encloses all points in the input geometry with the smallest number of points
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.convex_hull |
GeometrySocket |
Convex Hull |
Cube
Cube(size=(1.0, 1.0, 1.0), vertices_x=2, vertices_y=2, vertices_z=2)Generate a cuboid mesh with variable side lengths and subdivisions
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| size | InputVector | Size | (1.0, 1.0, 1.0) |
| vertices_x | InputInteger | Vertices X | 2 |
| vertices_y | InputInteger | Vertices Y | 2 |
| vertices_z | InputInteger | Vertices Z | 2 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.size |
VectorSocket |
Size |
i.vertices_x |
IntegerSocket |
Vertices X |
i.vertices_y |
IntegerSocket |
Vertices Y |
i.vertices_z |
IntegerSocket |
Vertices Z |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
o.uv_map |
VectorSocket |
UV Map |
CurveCircle
CurveCircle(
resolution=32,
point_1=(-1.0, 0.0, 0.0),
point_2=(0.0, 1.0, 0.0),
point_3=(1.0, 0.0, 0.0),
radius=1.0,
*,
mode='RADIUS',
)Generate a poly spline circle
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| resolution | InputInteger | Resolution | 32 |
| point_1 | InputVector | Point 1 | (-1.0, 0.0, 0.0) |
| point_2 | InputVector | Point 2 | (0.0, 1.0, 0.0) |
| point_3 | InputVector | Point 3 | (1.0, 0.0, 0.0) |
| radius | InputFloat | Radius | 1.0 |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| points | Create Curve Circle with operation ‘Points’. Define the radius and location with three points |
| props | Set the properties every node has and return the node, so it can |
| radius | Create Curve Circle with operation ‘Radius’. Define the radius with a float |
points
points(
resolution=32,
point_1=(-1.0, 0.0, 0.0),
point_2=(0.0, 1.0, 0.0),
point_3=(1.0, 0.0, 0.0),
)Create Curve Circle with operation ‘Points’. Define the radius and location with three points
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.
radius
radius(resolution=32, radius=1.0)Create Curve Circle with operation ‘Radius’. Define the radius with a float
Inputs
| Attribute | Type | Description |
|---|---|---|
i.resolution |
IntegerSocket |
Resolution |
i.point_1 |
VectorSocket |
Point 1 |
i.point_2 |
VectorSocket |
Point 2 |
i.point_3 |
VectorSocket |
Point 3 |
i.radius |
FloatSocket |
Radius |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
o.center |
VectorSocket |
Center |
CurveLength
CurveLength(curve=None)Retrieve the length of all splines added together
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.length |
FloatSocket |
Length |
CurveLine
CurveLine(
start=(0.0, 0.0, 0.0),
end=(0.0, 0.0, 1.0),
direction=(0.0, 0.0, 1.0),
length=1.0,
*,
mode='POINTS',
)Generate a poly spline line with two points
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| start | InputVector | Start | (0.0, 0.0, 0.0) |
| end | InputVector | End | (0.0, 0.0, 1.0) |
| direction | InputVector | Direction | (0.0, 0.0, 1.0) |
| length | InputFloat | Length | 1.0 |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| direction | Create Curve Line with operation ‘Direction’. Define a line with a start point, direction and length |
| points | Create Curve Line with operation ‘Points’. Define the start and end points of the line |
| props | Set the properties every node has and return the node, so it can |
direction
direction(start=(0.0, 0.0, 0.0), direction=(0.0, 0.0, 1.0), length=1.0)Create Curve Line with operation ‘Direction’. Define a line with a start point, direction and length
points
points(start=(0.0, 0.0, 0.0), end=(0.0, 0.0, 1.0))Create Curve Line with operation ‘Points’. Define the start and end points of the line
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.start |
VectorSocket |
Start |
i.end |
VectorSocket |
End |
i.direction |
VectorSocket |
Direction |
i.length |
FloatSocket |
Length |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
CurveToMesh
CurveToMesh(
curve=None,
profile_curve=None,
scale=1.0,
fill_caps=False,
miter_scale=False,
miter_scale_limit=3 * math.pi / 4,
)Convert curves into a mesh, optionally with a custom profile shape defined by curves
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| profile_curve | InputGeometry | Profile Curve | None |
| scale | InputFloat | Scale | 1.0 |
| fill_caps | InputBoolean | Fill Caps | False |
| miter_scale | InputBoolean | Miter Scale | False |
| miter_scale_limit | InputFloat | Miter Scale Limit | 3 * math.pi / 4 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.profile_curve |
GeometrySocket |
Profile Curve |
i.scale |
FloatSocket |
Scale |
i.fill_caps |
BooleanSocket |
Fill Caps |
i.miter_scale |
BooleanSocket |
Miter Scale |
i.miter_scale_limit |
FloatSocket |
Miter Scale Limit |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
CurveToPoints
CurveToPoints(curve=None, count=10, length=0.1, *, mode='COUNT')Generate a point cloud by sampling positions along curves
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| count | InputInteger | Count | 10 |
| length | InputFloat | Length | 0.1 |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| count | Create Curve to Points with operation ‘Count’. Sample each spline by evenly distributing the specified number of points |
| evaluated | Create Curve to Points with operation ‘Evaluated’. Create points from the curve’s evaluated points, based on the resolution attribute for NURBS and Bézier splines |
| length | Create Curve to Points with operation ‘Length’. Sample each spline by splitting it into segments with the specified length |
| props | Set the properties every node has and return the node, so it can |
count
count(curve=None, count=10)Create Curve to Points with operation ‘Count’. Sample each spline by evenly distributing the specified number of points
evaluated
evaluated(curve=None)Create Curve to Points with operation ‘Evaluated’. Create points from the curve’s evaluated points, based on the resolution attribute for NURBS and Bézier splines
length
length(curve=None, length=0.1)Create Curve to Points with operation ‘Length’. Sample each spline by splitting it into segments with the specified length
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.count |
IntegerSocket |
Count |
i.length |
FloatSocket |
Length |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.points |
GeometrySocket |
Points |
o.tangent |
VectorSocket |
Tangent |
o.normal |
VectorSocket |
Normal |
o.rotation |
RotationSocket |
Rotation |
CurvesToGreasePencil
CurvesToGreasePencil(curves=None, selection=None, instances_as_layers=True)Convert the curves in each top-level instance into Grease Pencil layer
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curves | InputGeometry | Curves | None |
| selection | InputBoolean | Selection | None |
| instances_as_layers | InputBoolean | Instances as Layers | True |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curves |
GeometrySocket |
Curves |
i.selection |
BooleanSocket |
Selection |
i.instances_as_layers |
BooleanSocket |
Instances as Layers |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.grease_pencil |
GeometrySocket |
Grease Pencil |
Cylinder
Cylinder(
vertices=32,
side_segments=1,
fill_segments=1,
radius=1.0,
depth=2.0,
*,
fill_type='NGON',
)Generate a cylinder mesh
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| vertices | InputInteger | Vertices | 32 |
| side_segments | InputInteger | Side Segments | 1 |
| fill_segments | InputInteger | Fill Segments | 1 |
| radius | InputFloat | Radius | 1.0 |
| depth | InputFloat | Depth | 2.0 |
Attributes
| Name | Description |
|---|---|
fill_type |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| n_gon | Create Cylinder with operation ‘N-Gon’. |
| none | Create Cylinder with operation ‘None’. |
| props | Set the properties every node has and return the node, so it can |
| triangles | Create Cylinder with operation ‘Triangles’. |
n_gon
n_gon(vertices=32, side_segments=1, fill_segments=1, radius=1.0, depth=2.0)Create Cylinder with operation ‘N-Gon’.
none
none(vertices=32, side_segments=1, radius=1.0, depth=2.0)Create Cylinder with operation ‘None’.
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.
triangles
triangles(vertices=32, side_segments=1, fill_segments=1, radius=1.0, depth=2.0)Create Cylinder with operation ‘Triangles’.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.vertices |
IntegerSocket |
Vertices |
i.side_segments |
IntegerSocket |
Side Segments |
i.fill_segments |
IntegerSocket |
Fill Segments |
i.radius |
FloatSocket |
Radius |
i.depth |
FloatSocket |
Depth |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
o.top |
BooleanSocket |
Top |
o.side |
BooleanSocket |
Side |
o.bottom |
BooleanSocket |
Bottom |
o.uv_map |
VectorSocket |
UV Map |
DeformCurvesOnSurface
DeformCurvesOnSurface(curves=None)Translate and rotate curves based on changes between the object’s original and evaluated surface mesh
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curves | InputGeometry | Curves | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curves |
GeometrySocket |
Curves |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curves |
GeometrySocket |
Curves |
DeleteGeometry
DeleteGeometry(geometry=None, selection=None, *, mode='ALL', domain='POINT')Remove selected elements of a geometry
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
Attributes
| Name | Description |
|---|---|
domain |
|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| all | Create Delete Geometry with operation ‘All’. |
| edge | Create Delete Geometry with operation ‘Edge’. Mesh edge |
| face | Create Delete Geometry with operation ‘Face’. Mesh face |
| instance | Create Delete Geometry with operation ‘Instance’. |
| layer | Create Delete Geometry with operation ‘Layer’. Grease Pencil layer |
| only_edges_faces | Create Delete Geometry with operation ‘Only Edges & Faces’. |
| only_faces | Create Delete Geometry with operation ‘Only Faces’. |
| point | Create Delete Geometry with operation ‘Point’. Vertex or point |
| props | Set the properties every node has and return the node, so it can |
| spline | Create Delete Geometry with operation ‘Spline’. |
all
all(geometry=None, selection=None, *, domain='POINT')Create Delete Geometry with operation ‘All’.
edge
edge(geometry=None, selection=None, *, mode='ALL')Create Delete Geometry with operation ‘Edge’. Mesh edge
face
face(geometry=None, selection=None, *, mode='ALL')Create Delete Geometry with operation ‘Face’. Mesh face
instance
instance(geometry=None, selection=None)Create Delete Geometry with operation ‘Instance’.
layer
layer(geometry=None, selection=None)Create Delete Geometry with operation ‘Layer’. Grease Pencil layer
only_edges_faces
only_edges_faces(geometry=None, selection=None, *, domain='POINT')Create Delete Geometry with operation ‘Only Edges & Faces’.
only_faces
only_faces(geometry=None, selection=None, *, domain='POINT')Create Delete Geometry with operation ‘Only Faces’.
point
point(geometry=None, selection=None, *, mode='ALL')Create Delete Geometry with operation ‘Point’. Vertex or point
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.
spline
spline(geometry=None, selection=None)Create Delete Geometry with operation ‘Spline’.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
DistributePointsOnFaces
DistributePointsOnFaces(
mesh=None,
selection=None,
distance_min=0.0,
density_max=10.0,
density=10.0,
density_factor=1.0,
seed=0,
*,
distribute_method='RANDOM',
use_legacy_normal=False,
)Generate points spread out on the surface of a mesh
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| selection | InputBoolean | Selection | None |
| distance_min | InputFloat | Distance Min | 0.0 |
| density_max | InputFloat | Density Max | 10.0 |
| density | InputFloat | Density | 10.0 |
| density_factor | InputFloat | Density Factor | 1.0 |
| seed | InputInteger | Seed | 0 |
Attributes
| Name | Description |
|---|---|
distribute_method |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
use_legacy_normal |
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.selection |
BooleanSocket |
Selection |
i.distance_min |
FloatSocket |
Distance Min |
i.density_max |
FloatSocket |
Density Max |
i.density |
FloatSocket |
Density |
i.density_factor |
FloatSocket |
Density Factor |
i.seed |
IntegerSocket |
Seed |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.points |
GeometrySocket |
Points |
o.normal |
VectorSocket |
Normal |
o.rotation |
RotationSocket |
Rotation |
DualMesh
DualMesh(mesh=None, keep_boundaries=False)Convert Faces into vertices and vertices into faces
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| keep_boundaries | InputBoolean | Keep Boundaries | False |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.keep_boundaries |
BooleanSocket |
Keep Boundaries |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.dual_mesh |
GeometrySocket |
Dual Mesh |
DuplicateElements
DuplicateElements(geometry=None, selection=None, amount=1, *, domain='POINT')Generate an arbitrary number copies of each selected input element
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
| amount | InputInteger | Amount | 1 |
Attributes
| Name | Description |
|---|---|
domain |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| edge | Create Duplicate Elements with operation ‘Edge’. |
| face | Create Duplicate Elements with operation ‘Face’. |
| instance | Create Duplicate Elements with operation ‘Instance’. |
| layer | Create Duplicate Elements with operation ‘Layer’. |
| point | Create Duplicate Elements with operation ‘Point’. |
| props | Set the properties every node has and return the node, so it can |
| spline | Create Duplicate Elements with operation ‘Spline’. |
edge
edge(geometry=None, selection=None, amount=1)Create Duplicate Elements with operation ‘Edge’.
face
face(geometry=None, selection=None, amount=1)Create Duplicate Elements with operation ‘Face’.
instance
instance(geometry=None, selection=None, amount=1)Create Duplicate Elements with operation ‘Instance’.
layer
layer(geometry=None, selection=None, amount=1)Create Duplicate Elements with operation ‘Layer’.
point
point(geometry=None, selection=None, amount=1)Create Duplicate Elements with operation ‘Point’.
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.
spline
spline(geometry=None, selection=None, amount=1)Create Duplicate Elements with operation ‘Spline’.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
i.amount |
IntegerSocket |
Amount |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
o.duplicate_index |
IntegerSocket |
Duplicate Index |
EdgePathsToCurves
EdgePathsToCurves(mesh=None, start_vertices=None, next_vertex_index=None)Output curves following paths across mesh edges
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| start_vertices | InputBoolean | Start Vertices | None |
| next_vertex_index | InputInteger | Next Vertex Index | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.start_vertices |
BooleanSocket |
Start Vertices |
i.next_vertex_index |
IntegerSocket |
Next Vertex Index |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curves |
GeometrySocket |
Curves |
ExtrudeMesh
ExtrudeMesh(
mesh=None,
selection=None,
offset=None,
offset_scale=1.0,
individual=True,
*,
mode='FACES',
)Generate new vertices, edges, or faces from selected elements and move them based on an offset while keeping them connected by their boundary
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| selection | InputBoolean | Selection | None |
| offset | InputVector | Offset | None |
| offset_scale | InputFloat | Offset Scale | 1.0 |
| individual | InputBoolean | Individual | True |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| edges | Create Extrude Mesh with operation ‘Edges’. |
| faces | Create Extrude Mesh with operation ‘Faces’. |
| props | Set the properties every node has and return the node, so it can |
| vertices | Create Extrude Mesh with operation ‘Vertices’. |
edges
edges(mesh=None, selection=None, offset=None, offset_scale=1.0)Create Extrude Mesh with operation ‘Edges’.
faces
faces(mesh=None, selection=None, offset=None, offset_scale=1.0, individual=True)Create Extrude Mesh with operation ‘Faces’.
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.
vertices
vertices(mesh=None, selection=None, offset=None, offset_scale=1.0)Create Extrude Mesh with operation ‘Vertices’.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.selection |
BooleanSocket |
Selection |
i.offset |
VectorSocket |
Offset |
i.offset_scale |
FloatSocket |
Offset Scale |
i.individual |
BooleanSocket |
Individual |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
o.top |
BooleanSocket |
Top |
o.side |
BooleanSocket |
Side |
FillCurve
FillCurve(curve=None, group_id=None, mode='Triangles', fill_rule='Even-Odd')Generate a mesh on the XY plane with faces on the inside of input curves
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| group_id | InputInteger | Group ID | None |
| mode | InputMenu | Literal['Triangles', 'N-gons'] | Mode | 'Triangles' |
| fill_rule | InputMenu | Literal['Even-Odd', 'Non-Zero'] | Fill Rule | 'Even-Odd' |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.group_id |
IntegerSocket |
Group ID |
i.mode |
MenuSocket |
Mode |
i.fill_rule |
MenuSocket |
Fill Rule |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
FilletCurve
FilletCurve(curve=None, radius=0.25, limit_radius=False, mode='Bézier', count=1)Round corners by generating circular arcs on each control point
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| radius | InputFloat | Radius | 0.25 |
| limit_radius | InputBoolean | Limit Radius | False |
| mode | InputMenu | Literal['Bézier', 'Poly'] | Mode | 'Bézier' |
| count | InputInteger | Count | 1 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.radius |
FloatSocket |
Radius |
i.limit_radius |
BooleanSocket |
Limit Radius |
i.mode |
MenuSocket |
Mode |
i.count |
IntegerSocket |
Count |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
FlipFaces
FlipFaces(mesh=None, selection=None)Reverse the order of the vertices and edges of selected faces, flipping their normal direction
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| selection | InputBoolean | Selection | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.selection |
BooleanSocket |
Selection |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
GeometryMaterials
GeometryMaterials(geometry=None, component_type='Mesh')Get a list of the materials used by a geometry component
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| component_type | InputMenu | Literal['Mesh', 'Point Cloud', 'Curve', 'Grease Pencil'] | Component Type | 'Mesh' |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.component_type |
MenuSocket |
Component Type |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.materials |
MaterialSocketList |
Materials |
GeometryProximity
GeometryProximity(
geometry=None,
group_id=None,
sample_position=None,
sample_group_id=None,
*,
target_element='FACES',
)Compute the closest location on the target geometry
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry. Renamed from Target; i.target still resolves to it. |
None |
| group_id | InputInteger | Group ID | None |
| sample_position | InputVector | Sample Position. Renamed from Source Position; i.source_position still resolves to it. |
None |
| sample_group_id | InputInteger | Sample Group ID | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
target_element |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry. Renamed from Target; i.target still resolves to it. |
i.group_id |
IntegerSocket |
Group ID |
i.sample_position |
VectorSocket |
Sample Position. Renamed from Source Position; i.source_position still resolves to it. |
i.sample_group_id |
IntegerSocket |
Sample Group ID |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.position |
VectorSocket |
Position |
o.distance |
FloatSocket |
Distance |
o.is_valid |
BooleanSocket |
Is Valid |
GetGeometryBundle
GetGeometryBundle(geometry=None, remove=False)Get the bundle of a geometry
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| remove | InputBoolean | Remove | False |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.remove |
BooleanSocket |
Remove |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
o.bundle |
BundleSocket |
Bundle |
GetGeometryComponent
GetGeometryComponent(geometry=None, type='Mesh', remove=True)Get a single component of a geometry
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| type | InputMenu | Literal['Mesh', 'Point Cloud', 'Curve', 'Instances', 'Grease Pencil', 'Volume'] | Type | 'Mesh' |
| remove | InputBoolean | Remove | True |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| curve | Create Get Geometry Component node with type ‘Curve’. |
| grease_pencil | Create Get Geometry Component node with type ‘Grease Pencil’. |
| instances | Create Get Geometry Component node with type ‘Instances’. |
| mesh | Create Get Geometry Component node with type ‘Mesh’. |
| point_cloud | Create Get Geometry Component node with type ‘Point Cloud’. |
| props | Set the properties every node has and return the node, so it can |
| volume | Create Get Geometry Component node with type ‘Volume’. |
curve
curve(geometry=None, remove=True)Create Get Geometry Component node with type ‘Curve’.
grease_pencil
grease_pencil(geometry=None, remove=True)Create Get Geometry Component node with type ‘Grease Pencil’.
instances
instances(geometry=None, remove=True)Create Get Geometry Component node with type ‘Instances’.
mesh
mesh(geometry=None, remove=True)Create Get Geometry Component node with type ‘Mesh’.
point_cloud
point_cloud(geometry=None, remove=True)Create Get Geometry Component node with type ‘Point Cloud’.
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.
volume
volume(geometry=None, remove=True)Create Get Geometry Component node with type ‘Volume’.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.type |
MenuSocket |
Type |
i.remove |
BooleanSocket |
Remove |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
o.component |
GeometrySocket |
Component |
o.exists |
BooleanSocket |
Exists |
GreasePencilToCurves
GreasePencilToCurves(
grease_pencil=None,
selection=None,
layers_as_instances=True,
)Convert Grease Pencil layers into curve instances
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| grease_pencil | InputGeometry | Grease Pencil | None |
| selection | InputBoolean | Selection | None |
| layers_as_instances | InputBoolean | Layers as Instances | True |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.grease_pencil |
GeometrySocket |
Grease Pencil |
i.selection |
BooleanSocket |
Selection |
i.layers_as_instances |
BooleanSocket |
Layers as Instances |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curves |
GeometrySocket |
Curves |
Grid
Grid(size_x=1.0, size_y=1.0, vertices_x=3, vertices_y=3)Generate a planar mesh on the XY plane
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| size_x | InputFloat | Size X | 1.0 |
| size_y | InputFloat | Size Y | 1.0 |
| vertices_x | InputInteger | Vertices X | 3 |
| vertices_y | InputInteger | Vertices Y | 3 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.size_x |
FloatSocket |
Size X |
i.size_y |
FloatSocket |
Size Y |
i.vertices_x |
IntegerSocket |
Vertices X |
i.vertices_y |
IntegerSocket |
Vertices Y |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
o.uv_map |
VectorSocket |
UV Map |
IcoSphere
IcoSphere(radius=1.0, subdivisions=1)Generate a spherical mesh that consists of equally sized triangles
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| radius | InputFloat | Radius | 1.0 |
| subdivisions | InputInteger | Subdivisions | 1 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.radius |
FloatSocket |
Radius |
i.subdivisions |
IntegerSocket |
Subdivisions |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
o.uv_map |
VectorSocket |
UV Map |
InstanceOnPoints
InstanceOnPoints(
points=None,
selection=None,
instance=None,
pick_instance=False,
instance_index=None,
rotation=(0.0, 0.0, 0.0),
scale=(1.0, 1.0, 1.0),
)Generate a reference to geometry at each of the input points, without duplicating its underlying data
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| points | InputGeometry | Points | None |
| selection | InputBoolean | Selection | None |
| instance | InputGeometry | Instance | None |
| pick_instance | InputBoolean | Pick Instance | False |
| instance_index | InputInteger | Instance Index | None |
| rotation | InputRotation | Rotation | (0.0, 0.0, 0.0) |
| scale | InputVector | Scale | (1.0, 1.0, 1.0) |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.points |
GeometrySocket |
Points |
i.selection |
BooleanSocket |
Selection |
i.instance |
GeometrySocket |
Instance |
i.pick_instance |
BooleanSocket |
Pick Instance |
i.instance_index |
IntegerSocket |
Instance Index |
i.rotation |
RotationSocket |
Rotation |
i.scale |
VectorSocket |
Scale |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.instances |
GeometrySocket |
Instances |
InstancesToPoints
InstancesToPoints(instances=None, selection=None, position=None, radius=0.05)Generate points at the origins of instances.
Note: Nested instances are not affected by this node
Parameters
instances : InputGeometry
Instances
selection : InputBoolean
Selection
position : InputVector
Position
radius : InputFloat
Radius
Inputs
i.instances : GeometrySocket
Instances
i.selection : BooleanSocket
Selection
i.position : VectorSocket
Position
i.radius : FloatSocket
Radius
Outputs
o.points : GeometrySocket
Points
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
InterpolateCurves
InterpolateCurves(
guide_curves=None,
guide_up=None,
guide_group_id=None,
points=None,
point_up=None,
point_group_id=None,
max_neighbors=4,
)Generate new curves on points by interpolating between existing curves
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| guide_curves | InputGeometry | Guide Curves | None |
| guide_up | InputVector | Guide Up | None |
| guide_group_id | InputInteger | Guide Group ID | None |
| points | InputGeometry | Points | None |
| point_up | InputVector | Point Up | None |
| point_group_id | InputInteger | Point Group ID | None |
| max_neighbors | InputInteger | Max Neighbors | 4 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.guide_curves |
GeometrySocket |
Guide Curves |
i.guide_up |
VectorSocket |
Guide Up |
i.guide_group_id |
IntegerSocket |
Guide Group ID |
i.points |
GeometrySocket |
Points |
i.point_up |
VectorSocket |
Point Up |
i.point_group_id |
IntegerSocket |
Point Group ID |
i.max_neighbors |
IntegerSocket |
Max Neighbors |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curves |
GeometrySocket |
Curves |
o.closest_index |
IntegerSocket |
Closest Index |
o.closest_weight |
FloatSocket |
Closest Weight |
MaterialSelection
MaterialSelection(material=None)Provide a selection of faces that use the specified material
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| material | InputMaterial | Material | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.material |
MaterialSocket |
Material |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.selection |
BooleanSocket |
Selection |
MergeByDistance
MergeByDistance(geometry=None, selection=None, mode='All', distance=0.001)Merge vertices or points within a given distance
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
| mode | InputMenu | Literal['All', 'Connected'] | Mode | 'All' |
| distance | InputFloat | Distance | 0.001 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
i.mode |
MenuSocket |
Mode |
i.distance |
FloatSocket |
Distance |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
MergeLayers
MergeLayers(grease_pencil=None, selection=None, mode='By Name', group_id=None)Join groups of Grease Pencil layers into one
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| grease_pencil | InputGeometry | Grease Pencil | None |
| selection | InputBoolean | Selection | None |
| mode | InputMenu | Literal['By Name', 'By Group ID'] | Mode | 'By Name' |
| group_id | InputInteger | Group ID | None |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
Deprecated: use i.mode. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| by_group_id | Deprecated: use MergeLayers(..., mode='By Group ID'). |
| by_name | Deprecated: use MergeLayers(..., mode='By Name'). |
| props | Set the properties every node has and return the node, so it can |
by_group_id
by_group_id(grease_pencil=None, selection=None, group_id=None)Deprecated: use MergeLayers(..., mode='By Group ID').
by_name
by_name(grease_pencil=None, selection=None)Deprecated: use MergeLayers(..., mode='By Name').
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.grease_pencil |
GeometrySocket |
Grease Pencil |
i.selection |
BooleanSocket |
Selection |
i.mode |
MenuSocket |
Mode |
i.group_id |
IntegerSocket |
Group ID |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.grease_pencil |
GeometrySocket |
Grease Pencil |
MergePoints
MergePoints(geometry=None, selection=None, merge_id=None)Merge points of a point cloud or mesh based on group ID and selection.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
| merge_id | InputInteger | Merge ID | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
i.merge_id |
IntegerSocket |
Merge ID |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
MeshBevel
MeshBevel(
mesh=None,
selection=None,
affect_kind='Edges',
start_left_offset=0.1,
start_right_offset=0.1,
end_left_offset=0.1,
end_right_offset=0.1,
offset=0.1,
miter=False,
spread=0.1,
segments=1,
shape=0.5,
profile=None,
)Bevel selected edges or vertices
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| selection | InputBoolean | Selection | None |
| affect_kind | InputMenu | Literal['Vertices', 'Edges'] | Affect Kind | 'Edges' |
| start_left_offset | InputFloat | Start Left Offset | 0.1 |
| start_right_offset | InputFloat | Start Right Offset | 0.1 |
| end_left_offset | InputFloat | End Left Offset | 0.1 |
| end_right_offset | InputFloat | End Right Offset | 0.1 |
| offset | InputFloat | Offset | 0.1 |
| miter | InputBoolean | Miter | False |
| spread | InputFloat | Spread | 0.1 |
| segments | InputInteger | Segments | 1 |
| shape | InputFloat | Shape | 0.5 |
| profile | InputGeometry | Profile | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.selection |
BooleanSocket |
Selection |
i.affect_kind |
MenuSocket |
Affect Kind |
i.start_left_offset |
FloatSocket |
Start Left Offset |
i.start_right_offset |
FloatSocket |
Start Right Offset |
i.end_left_offset |
FloatSocket |
End Left Offset |
i.end_right_offset |
FloatSocket |
End Right Offset |
i.offset |
FloatSocket |
Offset |
i.miter |
BooleanSocket |
Miter |
i.spread |
FloatSocket |
Spread |
i.segments |
IntegerSocket |
Segments |
i.shape |
FloatSocket |
Shape |
i.profile |
GeometrySocket |
Profile |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
o.vertex_face |
BooleanSocket |
Vertex Face |
o.edge_face |
BooleanSocket |
Edge Face |
o.outer_edge |
BooleanSocket |
Outer Edge |
o.mid_edge |
BooleanSocket |
Mid Edge |
MeshCircle
MeshCircle(vertices=32, radius=1.0, *, fill_type='NONE')Generate a circular ring of edges
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| vertices | InputInteger | Vertices | 32 |
| radius | InputFloat | Radius | 1.0 |
Attributes
| Name | Description |
|---|---|
fill_type |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| n_gon | Create Mesh Circle with operation ‘N-Gon’. |
| none | Create Mesh Circle with operation ‘None’. |
| props | Set the properties every node has and return the node, so it can |
| triangles | Create Mesh Circle with operation ‘Triangles’. |
n_gon
n_gon(vertices=32, radius=1.0)Create Mesh Circle with operation ‘N-Gon’.
none
none(vertices=32, radius=1.0)Create Mesh Circle with operation ‘None’.
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.
triangles
triangles(vertices=32, radius=1.0)Create Mesh Circle with operation ‘Triangles’.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.vertices |
IntegerSocket |
Vertices |
i.radius |
FloatSocket |
Radius |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
MeshLine
MeshLine(
count=10,
resolution=1.0,
start_location=(0.0, 0.0, 0.0),
offset=(0.0, 0.0, 1.0),
*,
mode='OFFSET',
count_mode='TOTAL',
)Generate vertices in a line and connect them with edges
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| count | InputInteger | Count | 10 |
| resolution | InputFloat | Resolution | 1.0 |
| start_location | InputVector | Start Location | (0.0, 0.0, 0.0) |
| offset | InputVector | Offset | (0.0, 0.0, 1.0) |
Attributes
| Name | Description |
|---|---|
count_mode |
|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| end_points | Create Mesh Line with operation ‘End Points’. Specify the line’s start and end points |
| offset | Create Mesh Line with operation ‘Offset’. Specify the offset from one vertex to the next |
| props | Set the properties every node has and return the node, so it can |
end_points
end_points(
count=10,
start_location=(0.0, 0.0, 0.0),
offset=(0.0, 0.0, 1.0),
*,
count_mode='TOTAL',
)Create Mesh Line with operation ‘End Points’. Specify the line’s start and end points
offset
offset(count=10, start_location=(0.0, 0.0, 0.0), offset=(0.0, 0.0, 1.0))Create Mesh Line with operation ‘Offset’. Specify the offset from one vertex to the next
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.count |
IntegerSocket |
Count |
i.resolution |
FloatSocket |
Resolution |
i.start_location |
VectorSocket |
Start Location |
i.offset |
VectorSocket |
Offset |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
MeshToCurve
MeshToCurve(mesh=None, selection=None, *, mode='EDGES')Generate a curve from a mesh
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| selection | InputBoolean | Selection | None |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| edges | Create Mesh to Curve with operation ‘Edges’. Convert mesh edges to curve segments. Attributes are propagated to curve points. |
| faces | Create Mesh to Curve with operation ‘Faces’. Convert each mesh face to a cyclic curve. Face attributes are propagated to curves. |
| props | Set the properties every node has and return the node, so it can |
edges
edges(mesh=None, selection=None)Create Mesh to Curve with operation ‘Edges’. Convert mesh edges to curve segments. Attributes are propagated to curve points.
faces
faces(mesh=None, selection=None)Create Mesh to Curve with operation ‘Faces’. Convert each mesh face to a cyclic curve. Face attributes are propagated to curves.
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.selection |
BooleanSocket |
Selection |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
MeshToPoints
MeshToPoints(
mesh=None,
selection=None,
position=None,
radius=0.05,
*,
mode='VERTICES',
)Generate a point cloud from a mesh’s vertices
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| selection | InputBoolean | Selection | None |
| position | InputVector | Position | None |
| radius | InputFloat | Radius | 0.05 |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| corners | Create Mesh to Points with operation ‘Corners’. Create a point in the point cloud for each selected face corner |
| edges | Create Mesh to Points with operation ‘Edges’. Create a point in the point cloud for each selected edge |
| faces | Create Mesh to Points with operation ‘Faces’. Create a point in the point cloud for each selected face |
| props | Set the properties every node has and return the node, so it can |
| vertices | Create Mesh to Points with operation ‘Vertices’. Create a point in the point cloud for each selected vertex |
corners
corners(mesh=None, selection=None, position=None, radius=0.05)Create Mesh to Points with operation ‘Corners’. Create a point in the point cloud for each selected face corner
edges
edges(mesh=None, selection=None, position=None, radius=0.05)Create Mesh to Points with operation ‘Edges’. Create a point in the point cloud for each selected edge
faces
faces(mesh=None, selection=None, position=None, radius=0.05)Create Mesh to Points with operation ‘Faces’. Create a point in the point cloud for each selected face
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.
vertices
vertices(mesh=None, selection=None, position=None, radius=0.05)Create Mesh to Points with operation ‘Vertices’. Create a point in the point cloud for each selected vertex
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.selection |
BooleanSocket |
Selection |
i.position |
VectorSocket |
Position |
i.radius |
FloatSocket |
Radius |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.points |
GeometrySocket |
Points |
Points
Points(count=1, position=(0.0, 0.0, 0.0), radius=0.1)Generate a point cloud with positions and radii defined by fields
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| count | InputInteger | Count | 1 |
| position | InputVector | Position | (0.0, 0.0, 0.0) |
| radius | InputFloat | Radius | 0.1 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.count |
IntegerSocket |
Count |
i.position |
VectorSocket |
Position |
i.radius |
FloatSocket |
Radius |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.points |
GeometrySocket |
Points. Renamed from Geometry; o.geometry still resolves to it. |
PointsToCurves
PointsToCurves(points=None, curve_group_id=None, weight=None)Split all points to curve by its group ID and reorder by weight
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| points | InputGeometry | Points | None |
| curve_group_id | InputInteger | Curve Group ID | None |
| weight | InputFloat | Weight | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.points |
GeometrySocket |
Points |
i.curve_group_id |
IntegerSocket |
Curve Group ID |
i.weight |
FloatSocket |
Weight |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curves |
GeometrySocket |
Curves |
PointsToVertices
PointsToVertices(points=None, selection=None)Generate a mesh vertex for each point cloud point
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| points | InputGeometry | Points | None |
| selection | InputBoolean | Selection | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.points |
GeometrySocket |
Points |
i.selection |
BooleanSocket |
Selection |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
QuadraticBezier
QuadraticBezier(
resolution=16,
start=(-1.0, 0.0, 0.0),
middle=(0.0, 2.0, 0.0),
end=(1.0, 0.0, 0.0),
)Generate a poly spline in a parabola shape with control points positions
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| resolution | InputInteger | Resolution | 16 |
| start | InputVector | Start | (-1.0, 0.0, 0.0) |
| middle | InputVector | Middle | (0.0, 2.0, 0.0) |
| end | InputVector | End | (1.0, 0.0, 0.0) |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.resolution |
IntegerSocket |
Resolution |
i.start |
VectorSocket |
Start |
i.middle |
VectorSocket |
Middle |
i.end |
VectorSocket |
End |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
Quadrilateral
Quadrilateral(
width=2.0,
height=2.0,
bottom_width=4.0,
top_width=2.0,
offset=1.0,
bottom_height=3.0,
top_height=1.0,
point_1=(-1.0, -1.0, 0.0),
point_2=(1.0, -1.0, 0.0),
point_3=(1.0, 1.0, 0.0),
point_4=(-1.0, 1.0, 0.0),
*,
mode='RECTANGLE',
)Generate a polygon with four points
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| width | InputFloat | Width | 2.0 |
| height | InputFloat | Height | 2.0 |
| bottom_width | InputFloat | Bottom Width | 4.0 |
| top_width | InputFloat | Top Width | 2.0 |
| offset | InputFloat | Offset | 1.0 |
| bottom_height | InputFloat | Bottom Height | 3.0 |
| top_height | InputFloat | Top Height | 1.0 |
| point_1 | InputVector | Point 1 | (-1.0, -1.0, 0.0) |
| point_2 | InputVector | Point 2 | (1.0, -1.0, 0.0) |
| point_3 | InputVector | Point 3 | (1.0, 1.0, 0.0) |
| point_4 | InputVector | Point 4 | (-1.0, 1.0, 0.0) |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| kite | Create Quadrilateral with operation ‘Kite’. Create a Kite / Dart |
| parallelogram | Create Quadrilateral with operation ‘Parallelogram’. Create a parallelogram |
| points | Create Quadrilateral with operation ‘Points’. Create a quadrilateral from four points |
| props | Set the properties every node has and return the node, so it can |
| rectangle | Create Quadrilateral with operation ‘Rectangle’. Create a rectangle |
| trapezoid | Create Quadrilateral with operation ‘Trapezoid’. Create a trapezoid |
kite
kite(width=2.0, bottom_height=3.0, top_height=1.0)Create Quadrilateral with operation ‘Kite’. Create a Kite / Dart
parallelogram
parallelogram(width=2.0, height=2.0, offset=1.0)Create Quadrilateral with operation ‘Parallelogram’. Create a parallelogram
points
points(
point_1=(-1.0, -1.0, 0.0),
point_2=(1.0, -1.0, 0.0),
point_3=(1.0, 1.0, 0.0),
point_4=(-1.0, 1.0, 0.0),
)Create Quadrilateral with operation ‘Points’. Create a quadrilateral from four points
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.
rectangle
rectangle(width=2.0, height=2.0)Create Quadrilateral with operation ‘Rectangle’. Create a rectangle
trapezoid
trapezoid(height=2.0, bottom_width=4.0, top_width=2.0, offset=1.0)Create Quadrilateral with operation ‘Trapezoid’. Create a trapezoid
Inputs
| Attribute | Type | Description |
|---|---|---|
i.width |
FloatSocket |
Width |
i.height |
FloatSocket |
Height |
i.bottom_width |
FloatSocket |
Bottom Width |
i.top_width |
FloatSocket |
Top Width |
i.offset |
FloatSocket |
Offset |
i.bottom_height |
FloatSocket |
Bottom Height |
i.top_height |
FloatSocket |
Top Height |
i.point_1 |
VectorSocket |
Point 1 |
i.point_2 |
VectorSocket |
Point 2 |
i.point_3 |
VectorSocket |
Point 3 |
i.point_4 |
VectorSocket |
Point 4 |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
RasterizePoints
RasterizePoints(
points=None,
grid_transform_mode='Voxel Size',
voxel_size=0.3,
matrix=None,
kernel_type='Linear',
position=None,
)Create volume grids from points with a weighted sum
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| points | InputGeometry | Points | None |
| grid_transform_mode | InputMenu | Literal['Voxel Size', 'Matrix'] | Grid Transform Mode | 'Voxel Size' |
| voxel_size | InputFloat | Voxel Size | 0.3 |
| matrix | InputMatrix | Matrix | None |
| kernel_type | InputMenu | Literal['Constant', 'Linear', 'Quadratic B-Spline', 'Cubic B-Spline'] | Kernel Type | 'Linear' |
| position | InputVector | Position | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.points |
GeometrySocket |
Points |
i.grid_transform_mode |
MenuSocket |
Grid Transform Mode |
i.voxel_size |
FloatSocket |
Voxel Size |
i.matrix |
MatrixSocket |
Matrix |
i.kernel_type |
MenuSocket |
Kernel Type |
i.position |
VectorSocket |
Position |
Raycast
Raycast(
target_geometry=None,
attribute=None,
interpolation='Interpolated',
source_position=None,
ray_direction=(0.0, 0.0, -1.0),
ray_length=100.0,
*,
data_type='FLOAT',
)Cast rays from the context geometry onto a target geometry, and retrieve information from each hit point
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| target_geometry | InputGeometry | Target Geometry | None |
| attribute | InputFloat | Attribute | None |
| interpolation | InputMenu | Literal['Interpolated', 'Nearest'] | Interpolation | 'Interpolated' |
| source_position | InputVector | Source Position | None |
| ray_direction | InputVector | Ray Direction | (0.0, 0.0, -1.0) |
| ray_length | InputFloat | Ray Length | 100.0 |
Attributes
| Name | Description |
|---|---|
data_type |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| boolean | Create Raycast with operation ‘Boolean’. True or false |
| color | Create Raycast with operation ‘Color’. RGBA color with 32-bit floating-point values |
| float | Create Raycast with operation ‘Float’. Floating-point value |
| integer | Create Raycast with operation ‘Integer’. 32-bit integer |
| matrix | Create Raycast with operation ‘4x4 Matrix’. Floating point matrix |
| props | Set the properties every node has and return the node, so it can |
| quaternion | Create Raycast with operation ‘Quaternion’. Floating point quaternion rotation |
| vector | Create Raycast with operation ‘Vector’. 3D vector with floating-point values |
boolean
boolean(
target_geometry=None,
attribute=None,
interpolation='Interpolated',
source_position=None,
ray_direction=(0.0, 0.0, -1.0),
ray_length=100.0,
)Create Raycast with operation ‘Boolean’. True or false
color
color(
target_geometry=None,
attribute=None,
interpolation='Interpolated',
source_position=None,
ray_direction=(0.0, 0.0, -1.0),
ray_length=100.0,
)Create Raycast with operation ‘Color’. RGBA color with 32-bit floating-point values
float
float(
target_geometry=None,
attribute=None,
interpolation='Interpolated',
source_position=None,
ray_direction=(0.0, 0.0, -1.0),
ray_length=100.0,
)Create Raycast with operation ‘Float’. Floating-point value
integer
integer(
target_geometry=None,
attribute=None,
interpolation='Interpolated',
source_position=None,
ray_direction=(0.0, 0.0, -1.0),
ray_length=100.0,
)Create Raycast with operation ‘Integer’. 32-bit integer
matrix
matrix(
target_geometry=None,
attribute=None,
interpolation='Interpolated',
source_position=None,
ray_direction=(0.0, 0.0, -1.0),
ray_length=100.0,
)Create Raycast with operation ‘4x4 Matrix’. Floating point matrix
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.
quaternion
quaternion(
target_geometry=None,
attribute=None,
interpolation='Interpolated',
source_position=None,
ray_direction=(0.0, 0.0, -1.0),
ray_length=100.0,
)Create Raycast with operation ‘Quaternion’. Floating point quaternion rotation
vector
vector(
target_geometry=None,
attribute=None,
interpolation='Interpolated',
source_position=None,
ray_direction=(0.0, 0.0, -1.0),
ray_length=100.0,
)Create Raycast with operation ‘Vector’. 3D vector with floating-point values
Inputs
| Attribute | Type | Description |
|---|---|---|
i.target_geometry |
GeometrySocket |
Target Geometry |
i.attribute |
FloatSocket |
Attribute |
i.interpolation |
MenuSocket |
Interpolation |
i.source_position |
VectorSocket |
Source Position |
i.ray_direction |
VectorSocket |
Ray Direction |
i.ray_length |
FloatSocket |
Ray Length |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.is_hit |
BooleanSocket |
Is Hit |
o.hit_position |
VectorSocket |
Hit Position |
o.hit_normal |
VectorSocket |
Hit Normal |
o.hit_distance |
FloatSocket |
Hit Distance |
o.attribute |
FloatSocket |
Attribute |
RealizeInstances
RealizeInstances(
geometry=None,
selection=None,
realize_all=True,
depth=0,
preserve_normals=False,
*,
realize_to_point_domain=False,
)Convert instances into real geometry data
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
| realize_all | InputBoolean | Realize All | True |
| depth | InputInteger | Depth | 0 |
| preserve_normals | InputBoolean | Preserve Normals | False |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
realize_to_point_domain |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
i.realize_all |
BooleanSocket |
Realize All |
i.depth |
IntegerSocket |
Depth |
i.preserve_normals |
BooleanSocket |
Preserve Normals |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
RenameAttribute
RenameAttribute(geometry=None, mode='Single', old='', new='', overwrite=False)Change the name of an attribute
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| mode | InputMenu | Literal['Single', 'Prefix'] | Mode | 'Single' |
| old | InputString | Old | '' |
| new | InputString | New | '' |
| overwrite | InputBoolean | Overwrite | False |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.mode |
MenuSocket |
Mode |
i.old |
StringSocket |
Old |
i.new |
StringSocket |
New |
i.overwrite |
BooleanSocket |
Overwrite |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
ReplaceMaterial
ReplaceMaterial(geometry=None, old=None, new=None)Swap one material with another
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| old | InputMaterial | Old | None |
| new | InputMaterial | New | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.old |
MaterialSocket |
Old |
i.new |
MaterialSocket |
New |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
ResampleCurve
ResampleCurve(
curve=None,
selection=None,
mode='Count',
count=10,
length=0.1,
*,
keep_last_segment=True,
)Generate a poly spline for each input spline
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| selection | InputBoolean | Selection | None |
| mode | InputMenu | Literal['Evaluated', 'Count', 'Length'] | Mode | 'Count' |
| count | InputInteger | Count | 10 |
| length | InputFloat | Length | 0.1 |
Attributes
| Name | Description |
|---|---|
i |
|
keep_last_segment |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.selection |
BooleanSocket |
Selection |
i.mode |
MenuSocket |
Mode |
i.count |
IntegerSocket |
Count |
i.length |
FloatSocket |
Length |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
ReverseCurve
ReverseCurve(curve=None, selection=None)Change the direction of curves by swapping their start and end data
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| selection | InputBoolean | Selection | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.selection |
BooleanSocket |
Selection |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
RotateInstances
RotateInstances(
instances=None,
selection=None,
rotation=(0.0, 0.0, 0.0),
pivot_point=(0.0, 0.0, 0.0),
local_space=True,
)Rotate geometry instances in local or global space
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| instances | InputGeometry | Instances | None |
| selection | InputBoolean | Selection | None |
| rotation | InputRotation | Rotation | (0.0, 0.0, 0.0) |
| pivot_point | InputVector | Pivot Point | (0.0, 0.0, 0.0) |
| local_space | InputBoolean | Local Space | True |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.instances |
GeometrySocket |
Instances |
i.selection |
BooleanSocket |
Selection |
i.rotation |
RotationSocket |
Rotation |
i.pivot_point |
VectorSocket |
Pivot Point |
i.local_space |
BooleanSocket |
Local Space |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.instances |
GeometrySocket |
Instances |
SampleNearest
SampleNearest(geometry=None, sample_position=None, *, domain='POINT')Find the element of a geometry closest to a position. Similar to the “Index of Nearest” node
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| sample_position | InputVector | Sample Position | None |
Attributes
| Name | Description |
|---|---|
domain |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| edge | Create Sample Nearest with operation ‘Edge’. Mesh edge |
| face | Create Sample Nearest with operation ‘Face’. Mesh face |
| face_corner | Create Sample Nearest with operation ‘Face Corner’. Mesh face corner |
| point | Create Sample Nearest with operation ‘Point’. Vertex or point |
| props | Set the properties every node has and return the node, so it can |
edge
edge(geometry=None, sample_position=None)Create Sample Nearest with operation ‘Edge’. Mesh edge
face
face(geometry=None, sample_position=None)Create Sample Nearest with operation ‘Face’. Mesh face
face_corner
face_corner(geometry=None, sample_position=None)Create Sample Nearest with operation ‘Face Corner’. Mesh face corner
point
point(geometry=None, sample_position=None)Create Sample Nearest with operation ‘Point’. Vertex or point
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.sample_position |
VectorSocket |
Sample Position |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.index |
IntegerSocket |
Index |
SampleNearestSurface
SampleNearestSurface(
mesh=None,
value=None,
group_id=None,
sample_position=None,
sample_group_id=None,
*,
data_type='FLOAT',
)Calculate the interpolated value of a mesh attribute on the closest point of its surface
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| value | InputFloat | Value | None |
| group_id | InputInteger | Group ID | None |
| sample_position | InputVector | Sample Position | None |
| sample_group_id | InputInteger | Sample Group ID | None |
Attributes
| Name | Description |
|---|---|
data_type |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| boolean | Create Sample Nearest Surface with operation ‘Boolean’. True or false |
| color | Create Sample Nearest Surface with operation ‘Color’. RGBA color with 32-bit floating-point values |
| float | Create Sample Nearest Surface with operation ‘Float’. Floating-point value |
| integer | Create Sample Nearest Surface with operation ‘Integer’. 32-bit integer |
| matrix | Create Sample Nearest Surface with operation ‘4x4 Matrix’. Floating point matrix |
| props | Set the properties every node has and return the node, so it can |
| quaternion | Create Sample Nearest Surface with operation ‘Quaternion’. Floating point quaternion rotation |
| vector | Create Sample Nearest Surface with operation ‘Vector’. 3D vector with floating-point values |
boolean
boolean(
mesh=None,
value=None,
group_id=None,
sample_position=None,
sample_group_id=None,
)Create Sample Nearest Surface with operation ‘Boolean’. True or false
color
color(
mesh=None,
value=None,
group_id=None,
sample_position=None,
sample_group_id=None,
)Create Sample Nearest Surface with operation ‘Color’. RGBA color with 32-bit floating-point values
float
float(
mesh=None,
value=None,
group_id=None,
sample_position=None,
sample_group_id=None,
)Create Sample Nearest Surface with operation ‘Float’. Floating-point value
integer
integer(
mesh=None,
value=None,
group_id=None,
sample_position=None,
sample_group_id=None,
)Create Sample Nearest Surface with operation ‘Integer’. 32-bit integer
matrix
matrix(
mesh=None,
value=None,
group_id=None,
sample_position=None,
sample_group_id=None,
)Create Sample Nearest Surface with operation ‘4x4 Matrix’. Floating point matrix
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.
quaternion
quaternion(
mesh=None,
value=None,
group_id=None,
sample_position=None,
sample_group_id=None,
)Create Sample Nearest Surface with operation ‘Quaternion’. Floating point quaternion rotation
vector
vector(
mesh=None,
value=None,
group_id=None,
sample_position=None,
sample_group_id=None,
)Create Sample Nearest Surface with operation ‘Vector’. 3D vector with floating-point values
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.value |
FloatSocket |
Value |
i.group_id |
IntegerSocket |
Group ID |
i.sample_position |
VectorSocket |
Sample Position |
i.sample_group_id |
IntegerSocket |
Sample Group ID |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.value |
FloatSocket |
Value |
o.is_valid |
BooleanSocket |
Is Valid |
SampleUVSurface
SampleUVSurface(
mesh=None,
value=None,
uv_map=None,
sample_uv=(0.0, 0.0, 0.0),
*,
data_type='FLOAT',
)Calculate the interpolated values of a mesh attribute at a UV coordinate
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| value | InputFloat | Value | None |
| uv_map | InputVector | UV Map. Renamed from Source UV Map; i.source_uv_map still resolves to it. |
None |
| sample_uv | InputVector | Sample UV | (0.0, 0.0, 0.0) |
Attributes
| Name | Description |
|---|---|
data_type |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| boolean | Create Sample UV Surface with operation ‘Boolean’. True or false |
| color | Create Sample UV Surface with operation ‘Color’. RGBA color with 32-bit floating-point values |
| float | Create Sample UV Surface with operation ‘Float’. Floating-point value |
| integer | Create Sample UV Surface with operation ‘Integer’. 32-bit integer |
| matrix | Create Sample UV Surface with operation ‘4x4 Matrix’. Floating point matrix |
| props | Set the properties every node has and return the node, so it can |
| quaternion | Create Sample UV Surface with operation ‘Quaternion’. Floating point quaternion rotation |
| vector | Create Sample UV Surface with operation ‘Vector’. 3D vector with floating-point values |
boolean
boolean(mesh=None, value=None, uv_map=None, sample_uv=(0.0, 0.0, 0.0))Create Sample UV Surface with operation ‘Boolean’. True or false
color
color(mesh=None, value=None, uv_map=None, sample_uv=(0.0, 0.0, 0.0))Create Sample UV Surface with operation ‘Color’. RGBA color with 32-bit floating-point values
float
float(mesh=None, value=None, uv_map=None, sample_uv=(0.0, 0.0, 0.0))Create Sample UV Surface with operation ‘Float’. Floating-point value
integer
integer(mesh=None, value=None, uv_map=None, sample_uv=(0.0, 0.0, 0.0))Create Sample UV Surface with operation ‘Integer’. 32-bit integer
matrix
matrix(mesh=None, value=None, uv_map=None, sample_uv=(0.0, 0.0, 0.0))Create Sample UV Surface with operation ‘4x4 Matrix’. Floating point matrix
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.
quaternion
quaternion(mesh=None, value=None, uv_map=None, sample_uv=(0.0, 0.0, 0.0))Create Sample UV Surface with operation ‘Quaternion’. Floating point quaternion rotation
vector
vector(mesh=None, value=None, uv_map=None, sample_uv=(0.0, 0.0, 0.0))Create Sample UV Surface with operation ‘Vector’. 3D vector with floating-point values
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.value |
FloatSocket |
Value |
i.uv_map |
VectorSocket |
UV Map. Renamed from Source UV Map; i.source_uv_map still resolves to it. |
i.sample_uv |
VectorSocket |
Sample UV |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.value |
FloatSocket |
Value |
o.is_valid |
BooleanSocket |
Is Valid |
ScaleElements
ScaleElements(
geometry=None,
selection=None,
scale=1.0,
center=None,
scale_mode='Uniform',
axis=(1.0, 0.0, 0.0),
*,
domain='FACE',
)Scale groups of connected edges and faces
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
| scale | InputFloat | Scale | 1.0 |
| center | InputVector | Center | None |
| scale_mode | InputMenu | Literal['Uniform', 'Single Axis'] | Scale Mode | 'Uniform' |
| axis | InputVector | Axis | (1.0, 0.0, 0.0) |
Attributes
| Name | Description |
|---|---|
domain |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| edge | Create Scale Elements with operation ‘Edge’. Scale individual edges or neighboring edge islands |
| face | Create Scale Elements with operation ‘Face’. Scale individual faces or neighboring face islands |
| props | Set the properties every node has and return the node, so it can |
edge
edge(
geometry=None,
selection=None,
scale=1.0,
center=None,
scale_mode='Uniform',
)Create Scale Elements with operation ‘Edge’. Scale individual edges or neighboring edge islands
face
face(
geometry=None,
selection=None,
scale=1.0,
center=None,
scale_mode='Uniform',
)Create Scale Elements with operation ‘Face’. Scale individual faces or neighboring face islands
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
i.scale |
FloatSocket |
Scale |
i.center |
VectorSocket |
Center |
i.scale_mode |
MenuSocket |
Scale Mode |
i.axis |
VectorSocket |
Axis |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
ScaleInstances
ScaleInstances(
instances=None,
selection=None,
scale=(1.0, 1.0, 1.0),
center=(0.0, 0.0, 0.0),
local_space=True,
)Scale geometry instances in local or global space
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| instances | InputGeometry | Instances | None |
| selection | InputBoolean | Selection | None |
| scale | InputVector | Scale | (1.0, 1.0, 1.0) |
| center | InputVector | Center | (0.0, 0.0, 0.0) |
| local_space | InputBoolean | Local Space | True |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.instances |
GeometrySocket |
Instances |
i.selection |
BooleanSocket |
Selection |
i.scale |
VectorSocket |
Scale |
i.center |
VectorSocket |
Center |
i.local_space |
BooleanSocket |
Local Space |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.instances |
GeometrySocket |
Instances |
SeparateComponents
SeparateComponents(geometry=None)Split a geometry into a separate output for each type of data in the geometry
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
o.curve |
GeometrySocket |
Curve |
o.grease_pencil |
GeometrySocket |
Grease Pencil |
o.point_cloud |
GeometrySocket |
Point Cloud |
o.volume |
GeometrySocket |
Volume |
o.instances |
GeometrySocket |
Instances |
SeparateGeometry
SeparateGeometry(geometry=None, selection=None, *, domain='POINT')Split a geometry into two geometry outputs based on a selection
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
Attributes
| Name | Description |
|---|---|
domain |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| edge | Create Separate Geometry with operation ‘Edge’. Mesh edge |
| face | Create Separate Geometry with operation ‘Face’. Mesh face |
| instance | Create Separate Geometry with operation ‘Instance’. |
| layer | Create Separate Geometry with operation ‘Layer’. Grease Pencil layer |
| point | Create Separate Geometry with operation ‘Point’. Vertex or point |
| props | Set the properties every node has and return the node, so it can |
| spline | Create Separate Geometry with operation ‘Spline’. |
edge
edge(geometry=None, selection=None)Create Separate Geometry with operation ‘Edge’. Mesh edge
face
face(geometry=None, selection=None)Create Separate Geometry with operation ‘Face’. Mesh face
instance
instance(geometry=None, selection=None)Create Separate Geometry with operation ‘Instance’.
layer
layer(geometry=None, selection=None)Create Separate Geometry with operation ‘Layer’. Grease Pencil layer
point
point(geometry=None, selection=None)Create Separate Geometry with operation ‘Point’. Vertex or point
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.
spline
spline(geometry=None, selection=None)Create Separate Geometry with operation ‘Spline’.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.selection |
GeometrySocket |
Selection |
o.inverted |
GeometrySocket |
Inverted |
SetCurveNormal
SetCurveNormal(
curve=None,
selection=None,
mode='Minimum Twist',
normal=(0.0, 0.0, 1.0),
)Set the evaluation mode for curve normals
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| selection | InputBoolean | Selection | None |
| mode | InputMenu | Literal['Minimum Twist', 'Z Up', 'Free'] | Mode | 'Minimum Twist' |
| normal | InputVector | Normal | (0.0, 0.0, 1.0) |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.selection |
BooleanSocket |
Selection |
i.mode |
MenuSocket |
Mode |
i.normal |
VectorSocket |
Normal |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
SetCurveRadius
SetCurveRadius(curve=None, selection=None, radius=0.005)Set the radius of the curve at each control point
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| selection | InputBoolean | Selection | None |
| radius | InputFloat | Radius | 0.005 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.selection |
BooleanSocket |
Selection |
i.radius |
FloatSocket |
Radius |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
SetCurveTilt
SetCurveTilt(curve=None, selection=None, tilt=0.0)Set the tilt angle at each curve control point
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| selection | InputBoolean | Selection | None |
| tilt | InputFloat | Tilt | 0.0 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.selection |
BooleanSocket |
Selection |
i.tilt |
FloatSocket |
Tilt |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
SetFaceSet
SetFaceSet(mesh=None, selection=None, face_set=None)Set sculpt face set values for faces
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| selection | InputBoolean | Selection | None |
| face_set | InputInteger | Face Set | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.selection |
BooleanSocket |
Selection |
i.face_set |
IntegerSocket |
Face Set |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
SetGeometryBundle
SetGeometryBundle(geometry=None, bundle=None)Set the bundle of a geometry
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| bundle | InputBundle | Bundle | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.bundle |
BundleSocket |
Bundle |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
SetGeometryName
SetGeometryName(geometry=None, name='')Set the name of a geometry for easier debugging
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| name | InputString | Name | '' |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.name |
StringSocket |
Name |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
SetGreasePencilColor
SetGreasePencilColor(
grease_pencil=None,
selection=None,
mode='Stroke',
color=(1.0, 1.0, 1.0, 1.0),
opacity=1.0,
)Set color and opacity attributes on Grease Pencil geometry
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| grease_pencil | InputGeometry | Grease Pencil | None |
| selection | InputBoolean | Selection | None |
| mode | InputMenu | Literal['Stroke', 'Fill', 'Both'] | Mode | 'Stroke' |
| color | InputColor | Color | (1.0, 1.0, 1.0, 1.0) |
| opacity | InputFloat | Opacity | 1.0 |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
Deprecated: use i.mode. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| fill | Deprecated: use SetGreasePencilColor(..., mode='Fill'). |
| props | Set the properties every node has and return the node, so it can |
| stroke | Deprecated: use SetGreasePencilColor(..., mode='Stroke'). |
fill
fill(
grease_pencil=None,
selection=None,
color=(1.0, 1.0, 1.0, 1.0),
opacity=1.0,
)Deprecated: use SetGreasePencilColor(..., mode='Fill').
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.
stroke
stroke(
grease_pencil=None,
selection=None,
color=(1.0, 1.0, 1.0, 1.0),
opacity=1.0,
)Deprecated: use SetGreasePencilColor(..., mode='Stroke').
Inputs
| Attribute | Type | Description |
|---|---|---|
i.grease_pencil |
GeometrySocket |
Grease Pencil |
i.selection |
BooleanSocket |
Selection |
i.mode |
MenuSocket |
Mode |
i.color |
ColorSocket |
Color |
i.opacity |
FloatSocket |
Opacity |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.grease_pencil |
GeometrySocket |
Grease Pencil |
SetGreasePencilDepth
SetGreasePencilDepth(grease_pencil=None, depth_order='2D Layers')Set the Grease Pencil depth order to use
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| grease_pencil | InputGeometry | Grease Pencil | None |
| depth_order | InputMenu | Literal['2D Layers', '3D Location'] | Depth Order | '2D Layers' |
Attributes
| Name | Description |
|---|---|
depth_order |
Deprecated: use i.depth_order. |
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.grease_pencil |
GeometrySocket |
Grease Pencil |
i.depth_order |
MenuSocket |
Depth Order |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.grease_pencil |
GeometrySocket |
Grease Pencil |
SetGreasePencilSoftness
SetGreasePencilSoftness(grease_pencil=None, selection=None, softness=0.0)Set softness attribute on Grease Pencil geometry
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| grease_pencil | InputGeometry | Grease Pencil | None |
| selection | InputBoolean | Selection | None |
| softness | InputFloat | Softness | 0.0 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.grease_pencil |
GeometrySocket |
Grease Pencil |
i.selection |
BooleanSocket |
Selection |
i.softness |
FloatSocket |
Softness |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.grease_pencil |
GeometrySocket |
Grease Pencil |
SetHandlePositions
SetHandlePositions(
curve=None,
selection=None,
position=None,
offset=(0.0, 0.0, 0.0),
*,
mode='LEFT',
)Set the positions for the handles of Bézier curves
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| selection | InputBoolean | Selection | None |
| position | InputVector | Position | None |
| offset | InputVector | Offset | (0.0, 0.0, 0.0) |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| left | Create Set Handle Positions with operation ‘Left’. Use the left handles |
| props | Set the properties every node has and return the node, so it can |
| right | Create Set Handle Positions with operation ‘Right’. Use the right handles |
left
left(curve=None, selection=None, position=None, offset=(0.0, 0.0, 0.0))Create Set Handle Positions with operation ‘Left’. Use the left handles
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.
right
right(curve=None, selection=None, position=None, offset=(0.0, 0.0, 0.0))Create Set Handle Positions with operation ‘Right’. Use the right handles
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.selection |
BooleanSocket |
Selection |
i.position |
VectorSocket |
Position |
i.offset |
VectorSocket |
Offset |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
SetHandleType
SetHandleType(
curve=None,
selection=True,
*,
left=True,
right=True,
handle_type='AUTO',
)Set the handle type for the control points of a Bézier curve
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| selection | InputBoolean | Selection | True |
Attributes
| Name | Description |
|---|---|
handle_type |
|
i |
|
left |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
right |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| align | Create Set Handle Type with operation ‘Align’. The location is constrained to point in the opposite direction as the other handle |
| auto | Create Set Handle Type with operation ‘Auto’. The location is automatically calculated to be smooth |
| free | Create Set Handle Type with operation ‘Free’. The handle can be moved anywhere, and does not influence the point’s other handle |
| props | Set the properties every node has and return the node, so it can |
| vector | Create Set Handle Type with operation ‘Vector’. The location is calculated to point to the next/previous control point |
align
align(curve=None, selection=None)Create Set Handle Type with operation ‘Align’. The location is constrained to point in the opposite direction as the other handle
auto
auto(curve=None, selection=None)Create Set Handle Type with operation ‘Auto’. The location is automatically calculated to be smooth
free
free(curve=None, selection=None)Create Set Handle Type with operation ‘Free’. The handle can be moved anywhere, and does not influence the point’s other handle
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.
vector
vector(curve=None, selection=None)Create Set Handle Type with operation ‘Vector’. The location is calculated to point to the next/previous control point
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.selection |
BooleanSocket |
Selection |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
SetID
SetID(geometry=None, selection=None, id=None)Set the id attribute on the input geometry, mainly used internally for randomizing
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
| id | InputInteger | ID | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
i.id |
IntegerSocket |
ID |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
SetInstanceTransform
SetInstanceTransform(instances=None, selection=None, transform=None)Set the transformation matrix of every instance
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| instances | InputGeometry | Instances | None |
| selection | InputBoolean | Selection | None |
| transform | InputMatrix | Transform | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.instances |
GeometrySocket |
Instances |
i.selection |
BooleanSocket |
Selection |
i.transform |
MatrixSocket |
Transform |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.instances |
GeometrySocket |
Instances |
SetMaterial
SetMaterial(geometry=None, selection=None, material=None)Assign a material to geometry elements
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
| material | InputMaterial | Material | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
i.material |
MaterialSocket |
Material |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
SetMaterialIndex
SetMaterialIndex(geometry=None, selection=None, material_index=0)Set the material index for each selected geometry element
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
| material_index | InputInteger | Material Index | 0 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
i.material_index |
IntegerSocket |
Material Index |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
SetMeshNormal
SetMeshNormal(
mesh=None,
remove_custom=True,
edge_sharpness=False,
face_sharpness=False,
custom_normal=None,
*,
mode='SHARPNESS',
domain='POINT',
)Store a normal vector for each mesh element
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| remove_custom | InputBoolean | Remove Custom | True |
| edge_sharpness | InputBoolean | Edge Sharpness | False |
| face_sharpness | InputBoolean | Face Sharpness | False |
| custom_normal | InputVector | Custom Normal | None |
Attributes
| Name | Description |
|---|---|
domain |
|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| face | Create Set Mesh Normal with operation ‘Face’. Mesh face |
| face_corner | Create Set Mesh Normal with operation ‘Face Corner’. Mesh face corner |
| free | Create Set Mesh Normal with operation ‘Free’. Store custom normals as simple vectors in the local space of the mesh. Values are not necessarily updated automatically later on as the mesh is deformed. |
| point | Create Set Mesh Normal with operation ‘Point’. Vertex or point |
| props | Set the properties every node has and return the node, so it can |
| sharpness | Create Set Mesh Normal with operation ‘Sharpness’. Store the sharpness of each face or edge. Similar to the “Shade Smooth” and “Shade Flat” operators. |
| tangent_space | Create Set Mesh Normal with operation ‘Tangent Space’. Store normals in a deformation dependent custom transformation space. This method is slower, but can be better when subsequent operations change the mesh without handling normals specifically. |
face
face(
mesh=None,
remove_custom=True,
edge_sharpness=False,
face_sharpness=False,
*,
mode='SHARPNESS',
)Create Set Mesh Normal with operation ‘Face’. Mesh face
face_corner
face_corner(
mesh=None,
remove_custom=True,
edge_sharpness=False,
face_sharpness=False,
*,
mode='SHARPNESS',
)Create Set Mesh Normal with operation ‘Face Corner’. Mesh face corner
free
free(mesh=None, custom_normal=None, *, domain='POINT')Create Set Mesh Normal with operation ‘Free’. Store custom normals as simple vectors in the local space of the mesh. Values are not necessarily updated automatically later on as the mesh is deformed.
point
point(
mesh=None,
remove_custom=True,
edge_sharpness=False,
face_sharpness=False,
*,
mode='SHARPNESS',
)Create Set Mesh Normal with operation ‘Point’. Vertex or point
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.
sharpness
sharpness(
mesh=None,
remove_custom=True,
edge_sharpness=False,
face_sharpness=False,
)Create Set Mesh Normal with operation ‘Sharpness’. Store the sharpness of each face or edge. Similar to the “Shade Smooth” and “Shade Flat” operators.
tangent_space
tangent_space(mesh=None, custom_normal=None)Create Set Mesh Normal with operation ‘Tangent Space’. Store normals in a deformation dependent custom transformation space. This method is slower, but can be better when subsequent operations change the mesh without handling normals specifically.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.remove_custom |
BooleanSocket |
Remove Custom |
i.edge_sharpness |
BooleanSocket |
Edge Sharpness |
i.face_sharpness |
BooleanSocket |
Face Sharpness |
i.custom_normal |
VectorSocket |
Custom Normal |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
SetNURBSOrder
SetNURBSOrder(curves=None, selection=None, order=4)Control how many curve control points influence each evaluated point by changing the “nurbs_order” attribute
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curves | InputGeometry | Curves | None |
| selection | InputBoolean | Selection | None |
| order | InputInteger | Order | 4 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curves |
GeometrySocket |
Curves |
i.selection |
BooleanSocket |
Selection |
i.order |
IntegerSocket |
Order |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curves |
GeometrySocket |
Curves |
SetNURBSWeight
SetNURBSWeight(curves=None, selection=None, weight=1.0)Control the influence of each NURBS control point on the curve by changing the “nurbs_weight” attribute
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curves | InputGeometry | Curves | None |
| selection | InputBoolean | Selection | None |
| weight | InputFloat | Weight | 1.0 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curves |
GeometrySocket |
Curves |
i.selection |
BooleanSocket |
Selection |
i.weight |
FloatSocket |
Weight |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curves |
GeometrySocket |
Curves |
SetPointCloudType
SetPointCloudType(points=None, type='Points')Change the type of point cloud
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| points | InputGeometry | Points | None |
| type | InputMenu | Literal['Points', '3D Gaussian Splat'] | Type | 'Points' |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| points | Create Set Point Cloud Type node with type ‘Points’. |
| props | Set the properties every node has and return the node, so it can |
| type_3d_gaussian_splat | Create Set Point Cloud Type node with type ‘3D Gaussian Splat’. |
points
points(points=None)Create Set Point Cloud Type node with type ‘Points’.
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.
type_3d_gaussian_splat
type_3d_gaussian_splat(points=None)Create Set Point Cloud Type node with type ‘3D Gaussian Splat’.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.points |
GeometrySocket |
Points |
i.type |
MenuSocket |
Type |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.points |
GeometrySocket |
Points |
SetPointRadius
SetPointRadius(points=None, selection=None, radius=0.05)Set the display size of point cloud points
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| points | InputGeometry | Points | None |
| selection | InputBoolean | Selection | None |
| radius | InputFloat | Radius | 0.05 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.points |
GeometrySocket |
Points |
i.selection |
BooleanSocket |
Selection |
i.radius |
FloatSocket |
Radius |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.points |
GeometrySocket |
Points |
SetPosition
SetPosition(
geometry=None,
selection=None,
position=None,
offset=(0.0, 0.0, 0.0),
)Set the location of each point
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
| position | InputVector | Position | None |
| offset | InputVector | Offset | (0.0, 0.0, 0.0) |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
i.position |
VectorSocket |
Position |
i.offset |
VectorSocket |
Offset |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
SetSelection
SetSelection(
geometry=None,
selection=True,
*,
domain='POINT',
selection_type='BOOLEAN',
)Set selection of the edited geometry, for tool execution
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | True |
Attributes
| Name | Description |
|---|---|
domain |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
selection_type |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| boolean | Create Set Selection with operation ‘Boolean’. Store true or false selection values in edit mode |
| edge | Create Set Selection with operation ‘Edge’. Mesh edge |
| face | Create Set Selection with operation ‘Face’. Mesh face |
| float | Create Set Selection with operation ‘Float’. Store floating point selection values. For mesh geometry, stored inverted as the sculpt mode mask |
| point | Create Set Selection with operation ‘Point’. Vertex or point |
| props | Set the properties every node has and return the node, so it can |
| spline | Create Set Selection with operation ‘Spline’. |
boolean
boolean(geometry=None, selection=True, *, domain='POINT')Create Set Selection with operation ‘Boolean’. Store true or false selection values in edit mode
edge
edge(geometry=None, selection=True, *, selection_type='BOOLEAN')Create Set Selection with operation ‘Edge’. Mesh edge
face
face(geometry=None, selection=True, *, selection_type='BOOLEAN')Create Set Selection with operation ‘Face’. Mesh face
float
float(geometry=None, selection=1.0, *, domain='POINT')Create Set Selection with operation ‘Float’. Store floating point selection values. For mesh geometry, stored inverted as the sculpt mode mask
point
point(geometry=None, selection=True, *, selection_type='BOOLEAN')Create Set Selection with operation ‘Point’. Vertex or point
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.
spline
spline(geometry=None, selection=True, *, selection_type='BOOLEAN')Create Set Selection with operation ‘Spline’.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
SetShadeSmooth
SetShadeSmooth(mesh=None, selection=None, shade_smooth=True, *, domain='FACE')Control the smoothness of mesh normals around each face by changing the “shade smooth” attribute
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh. Renamed from Geometry; i.geometry still resolves to it. |
None |
| selection | InputBoolean | Selection | None |
| shade_smooth | InputBoolean | Shade Smooth | True |
Attributes
| Name | Description |
|---|---|
domain |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| edge | Create Set Shade Smooth with operation ‘Edge’. Mesh edge |
| face | Create Set Shade Smooth with operation ‘Face’. Mesh face |
| props | Set the properties every node has and return the node, so it can |
edge
edge(mesh=None, selection=None, shade_smooth=True)Create Set Shade Smooth with operation ‘Edge’. Mesh edge
face
face(mesh=None, selection=None, shade_smooth=True)Create Set Shade Smooth with operation ‘Face’. Mesh face
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh. Renamed from Geometry; i.geometry still resolves to it. |
i.selection |
BooleanSocket |
Selection |
i.shade_smooth |
BooleanSocket |
Shade Smooth |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh. Renamed from Geometry; o.geometry still resolves to it. |
SetSplineCyclic
SetSplineCyclic(curve=None, selection=None, cyclic=False)Control whether each spline loops back on itself by changing the “cyclic” attribute
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve. Renamed from Geometry; i.geometry still resolves to it. |
None |
| selection | InputBoolean | Selection | None |
| cyclic | InputBoolean | Cyclic | False |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve. Renamed from Geometry; i.geometry still resolves to it. |
i.selection |
BooleanSocket |
Selection |
i.cyclic |
BooleanSocket |
Cyclic |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve. Renamed from Geometry; o.geometry still resolves to it. |
SetSplineResolution
SetSplineResolution(curve=None, selection=None, resolution=12)Control how many evaluated points should be generated on every curve segment
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve. Renamed from Geometry; i.geometry still resolves to it. |
None |
| selection | InputBoolean | Selection | None |
| resolution | InputInteger | Resolution | 12 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve. Renamed from Geometry; i.geometry still resolves to it. |
i.selection |
BooleanSocket |
Selection |
i.resolution |
IntegerSocket |
Resolution |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve. Renamed from Geometry; o.geometry still resolves to it. |
SetSplineType
SetSplineType(curve=None, selection=None, *, spline_type='POLY')Change the type of curves
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| selection | InputBoolean | Selection | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
spline_type |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| bezier | Create Set Spline Type with operation ‘Bézier’. |
| catmull_rom | Create Set Spline Type with operation ‘Catmull Rom’. |
| nurbs | Create Set Spline Type with operation ‘NURBS’. |
| poly | Create Set Spline Type with operation ‘Poly’. |
| props | Set the properties every node has and return the node, so it can |
bezier
bezier(curve=None, selection=None)Create Set Spline Type with operation ‘Bézier’.
catmull_rom
catmull_rom(curve=None, selection=None)Create Set Spline Type with operation ‘Catmull Rom’.
nurbs
nurbs(curve=None, selection=None)Create Set Spline Type with operation ‘NURBS’.
poly
poly(curve=None, selection=None)Create Set Spline Type with operation ‘Poly’.
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.selection |
BooleanSocket |
Selection |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
SortElements
SortElements(
geometry=None,
selection=None,
group_id=None,
sort_weight=None,
*,
domain='POINT',
)Rearrange geometry elements, changing their indices
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
| group_id | InputInteger | Group ID | None |
| sort_weight | InputFloat | Sort Weight | None |
Attributes
| Name | Description |
|---|---|
domain |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| edge | Create Sort Elements with operation ‘Edge’. Mesh edge |
| face | Create Sort Elements with operation ‘Face’. Mesh face |
| instance | Create Sort Elements with operation ‘Instance’. |
| point | Create Sort Elements with operation ‘Point’. Vertex or point |
| props | Set the properties every node has and return the node, so it can |
| spline | Create Sort Elements with operation ‘Spline’. |
edge
edge(geometry=None, selection=None, group_id=None, sort_weight=None)Create Sort Elements with operation ‘Edge’. Mesh edge
face
face(geometry=None, selection=None, group_id=None, sort_weight=None)Create Sort Elements with operation ‘Face’. Mesh face
instance
instance(geometry=None, selection=None, group_id=None, sort_weight=None)Create Sort Elements with operation ‘Instance’.
point
point(geometry=None, selection=None, group_id=None, sort_weight=None)Create Sort Elements with operation ‘Point’. Vertex or point
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.
spline
spline(geometry=None, selection=None, group_id=None, sort_weight=None)Create Sort Elements with operation ‘Spline’.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
i.group_id |
IntegerSocket |
Group ID |
i.sort_weight |
FloatSocket |
Sort Weight |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
Spiral
Spiral(
resolution=32,
rotations=2.0,
start_radius=1.0,
end_radius=2.0,
height=2.0,
reverse=False,
)Generate a poly spline in a spiral shape
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| resolution | InputInteger | Resolution | 32 |
| rotations | InputFloat | Rotations | 2.0 |
| start_radius | InputFloat | Start Radius | 1.0 |
| end_radius | InputFloat | End Radius | 2.0 |
| height | InputFloat | Height | 2.0 |
| reverse | InputBoolean | Reverse | False |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.resolution |
IntegerSocket |
Resolution |
i.rotations |
FloatSocket |
Rotations |
i.start_radius |
FloatSocket |
Start Radius |
i.end_radius |
FloatSocket |
End Radius |
i.height |
FloatSocket |
Height |
i.reverse |
BooleanSocket |
Reverse |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
SplitEdges
SplitEdges(mesh=None, selection=None)Duplicate mesh edges and break connections with the surrounding faces
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| selection | InputBoolean | Selection | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.selection |
BooleanSocket |
Selection |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
SplitToInstances
SplitToInstances(
geometry=None,
selection=None,
group_id=None,
*,
domain='POINT',
)Create separate geometries containing the elements from the same group
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| selection | InputBoolean | Selection | None |
| group_id | InputInteger | Group ID | None |
Attributes
| Name | Description |
|---|---|
domain |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| edge | Create Split to Instances with operation ‘Edge’. Mesh edge |
| face | Create Split to Instances with operation ‘Face’. Mesh face |
| instance | Create Split to Instances with operation ‘Instance’. |
| layer | Create Split to Instances with operation ‘Layer’. Grease Pencil layer |
| point | Create Split to Instances with operation ‘Point’. Vertex or point |
| props | Set the properties every node has and return the node, so it can |
| spline | Create Split to Instances with operation ‘Spline’. |
edge
edge(geometry=None, selection=None, group_id=None)Create Split to Instances with operation ‘Edge’. Mesh edge
face
face(geometry=None, selection=None, group_id=None)Create Split to Instances with operation ‘Face’. Mesh face
instance
instance(geometry=None, selection=None, group_id=None)Create Split to Instances with operation ‘Instance’.
layer
layer(geometry=None, selection=None, group_id=None)Create Split to Instances with operation ‘Layer’. Grease Pencil layer
point
point(geometry=None, selection=None, group_id=None)Create Split to Instances with operation ‘Point’. Vertex or point
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.
spline
spline(geometry=None, selection=None, group_id=None)Create Split to Instances with operation ‘Spline’.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.selection |
BooleanSocket |
Selection |
i.group_id |
IntegerSocket |
Group ID |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.instances |
GeometrySocket |
Instances |
o.group_id |
IntegerSocket |
Group ID |
Star
Star(points=8, inner_radius=1.0, outer_radius=2.0, twist=0.0)Generate a poly spline in a star pattern by connecting alternating points of two circles
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| points | InputInteger | Points | 8 |
| inner_radius | InputFloat | Inner Radius | 1.0 |
| outer_radius | InputFloat | Outer Radius | 2.0 |
| twist | InputFloat | Twist | 0.0 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.points |
IntegerSocket |
Points |
i.inner_radius |
FloatSocket |
Inner Radius |
i.outer_radius |
FloatSocket |
Outer Radius |
i.twist |
FloatSocket |
Twist |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
o.outer_points |
BooleanSocket |
Outer Points |
StringToCurves
StringToCurves(
string='',
size=1.0,
font=None,
align_x='Left',
align_y='Top Baseline',
pivot_point='Midpoint',
character_spacing=1.0,
word_spacing=1.0,
line_spacing=1.0,
overflow='Overflow',
text_box_width=0.0,
text_box_height=0.0,
)Generate a paragraph of text with a specific font, using a curve instance to store each character
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| string | InputString | String | '' |
| size | InputFloat | Size | 1.0 |
| font | InputFont | Font | None |
| align_x | InputMenu | Literal['Left', 'Center', 'Right', 'Justify', 'Flush'] | Align X | 'Left' |
| align_y | InputMenu | Literal['Top', 'Top Baseline', 'Middle', 'Bottom Baseline', 'Bottom'] | Align Y | 'Top Baseline' |
| pivot_point | InputMenu | Literal['Midpoint', 'Top Left', 'Top Center', 'Top Right', 'Bottom Left', 'Bottom Center', 'Bottom Right'] | Pivot Point | 'Midpoint' |
| character_spacing | InputFloat | Character Spacing | 1.0 |
| word_spacing | InputFloat | Word Spacing | 1.0 |
| line_spacing | InputFloat | Line Spacing | 1.0 |
| overflow | InputMenu | Literal['Overflow', 'Scale To Fit', 'Truncate'] | Overflow | 'Overflow' |
| text_box_width | InputFloat | Text Box Width | 0.0 |
| text_box_height | InputFloat | Text Box Height | 0.0 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.string |
StringSocket |
String |
i.size |
FloatSocket |
Size |
i.font |
FontSocket |
Font |
i.align_x |
MenuSocket |
Align X |
i.align_y |
MenuSocket |
Align Y |
i.pivot_point |
MenuSocket |
Pivot Point |
i.character_spacing |
FloatSocket |
Character Spacing |
i.word_spacing |
FloatSocket |
Word Spacing |
i.line_spacing |
FloatSocket |
Line Spacing |
i.overflow |
MenuSocket |
Overflow |
i.text_box_width |
FloatSocket |
Text Box Width |
i.text_box_height |
FloatSocket |
Text Box Height |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve_instances |
GeometrySocket |
Curve Instances |
o.remainder |
StringSocket |
Remainder |
o.line |
IntegerSocket |
Line |
o.word |
IntegerSocket |
Word |
o.pivot_point |
VectorSocket |
Pivot Point |
SubdivideCurve
SubdivideCurve(curve=None, cuts=1)Dividing each curve segment into a specified number of pieces
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| cuts | InputInteger | Cuts | 1 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.cuts |
IntegerSocket |
Cuts |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
SubdivideMesh
SubdivideMesh(mesh=None, level=1)Divide mesh faces into smaller ones without changing the shape or volume, using linear interpolation to place the new vertices
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| level | InputInteger | Level | 1 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.level |
IntegerSocket |
Level |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
SubdivisionSurface
SubdivisionSurface(
mesh=None,
level=1,
edge_crease=0.0,
vertex_crease=0.0,
limit_surface=True,
quality=3,
uv_smooth='Keep Boundaries',
boundary_smooth='All',
)Divide mesh faces to form a smooth surface, using the Catmull-Clark subdivision method
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| level | InputInteger | Level | 1 |
| edge_crease | InputFloat | Edge Crease | 0.0 |
| vertex_crease | InputFloat | Vertex Crease | 0.0 |
| limit_surface | InputBoolean | Limit Surface | True |
| quality | InputInteger | Quality | 3 |
| uv_smooth | InputMenu | Literal['None', 'Keep Corners', 'Keep Corners, Junctions', 'Keep Corners, Junctions, Concave', 'Keep Boundaries', 'All'] | UV Smooth | 'Keep Boundaries' |
| boundary_smooth | InputMenu | Literal['Keep Corners', 'All'] | Boundary Smooth | 'All' |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.level |
IntegerSocket |
Level |
i.edge_crease |
FloatSocket |
Edge Crease |
i.vertex_crease |
FloatSocket |
Vertex Crease |
i.limit_surface |
BooleanSocket |
Limit Surface |
i.quality |
IntegerSocket |
Quality |
i.uv_smooth |
MenuSocket |
UV Smooth |
i.boundary_smooth |
MenuSocket |
Boundary Smooth |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
TransferAttributes
TransferAttributes(
target=None,
target_point_id=None,
target_edge_id=None,
target_face_id=None,
target_corner_id=None,
target_curve_id=None,
target_instance_id=None,
source=None,
source_point_id=None,
source_edge_id=None,
source_face_id=None,
source_corner_id=None,
source_curve_id=None,
source_instance_id=None,
pattern_mode='Wildcard',
attribute_names=None,
exclude_names=False,
)Copy attributes from one geometry to another
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| target | InputGeometry | Target | None |
| target_point_id | InputInteger | Target Point ID | None |
| target_edge_id | InputInteger | Target Edge ID | None |
| target_face_id | InputInteger | Target Face ID | None |
| target_corner_id | InputInteger | Target Corner ID | None |
| target_curve_id | InputInteger | Target Curve ID | None |
| target_instance_id | InputInteger | Target Instance ID | None |
| source | InputGeometry | Source | None |
| source_point_id | InputInteger | Source Point ID | None |
| source_edge_id | InputInteger | Source Edge ID | None |
| source_face_id | InputInteger | Source Face ID | None |
| source_corner_id | InputInteger | Source Corner ID | None |
| source_curve_id | InputInteger | Source Curve ID | None |
| source_instance_id | InputInteger | Source Instance ID | None |
| pattern_mode | InputMenu | Literal['Exact', 'Wildcard'] | Pattern Mode | 'Wildcard' |
| attribute_names | InputStringList | Attribute Names | None |
| exclude_names | InputBoolean | Exclude Names | False |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.target |
GeometrySocket |
Target |
i.target_point_id |
IntegerSocket |
Target Point ID |
i.target_edge_id |
IntegerSocket |
Target Edge ID |
i.target_face_id |
IntegerSocket |
Target Face ID |
i.target_corner_id |
IntegerSocket |
Target Corner ID |
i.target_curve_id |
IntegerSocket |
Target Curve ID |
i.target_instance_id |
IntegerSocket |
Target Instance ID |
i.source |
GeometrySocket |
Source |
i.source_point_id |
IntegerSocket |
Source Point ID |
i.source_edge_id |
IntegerSocket |
Source Edge ID |
i.source_face_id |
IntegerSocket |
Source Face ID |
i.source_corner_id |
IntegerSocket |
Source Corner ID |
i.source_curve_id |
IntegerSocket |
Source Curve ID |
i.source_instance_id |
IntegerSocket |
Source Instance ID |
i.pattern_mode |
MenuSocket |
Pattern Mode |
i.attribute_names |
StringSocketList |
Attribute Names |
i.exclude_names |
BooleanSocket |
Exclude Names |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.target |
GeometrySocket |
Target |
o.transferred_names |
StringSocketList |
Transferred Names |
TransformGeometry
TransformGeometry(
geometry=None,
mode='Components',
translation=(0.0, 0.0, 0.0),
rotation=(0.0, 0.0, 0.0),
scale=(1.0, 1.0, 1.0),
transform=None,
)Translate, rotate or scale the geometry
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| geometry | InputGeometry | Geometry | None |
| mode | InputMenu | Literal['Components', 'Matrix'] | Mode | 'Components' |
| translation | InputVector | Translation | (0.0, 0.0, 0.0) |
| rotation | InputRotation | Rotation | (0.0, 0.0, 0.0) |
| scale | InputVector | Scale | (1.0, 1.0, 1.0) |
| transform | InputMatrix | Transform | None |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.geometry |
GeometrySocket |
Geometry |
i.mode |
MenuSocket |
Mode |
i.translation |
VectorSocket |
Translation |
i.rotation |
RotationSocket |
Rotation |
i.scale |
VectorSocket |
Scale |
i.transform |
MatrixSocket |
Transform |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.geometry |
GeometrySocket |
Geometry |
TranslateInstances
TranslateInstances(
instances=None,
selection=None,
translation=(0.0, 0.0, 0.0),
local_space=True,
)Move top-level geometry instances in local or global space
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| instances | InputGeometry | Instances | None |
| selection | InputBoolean | Selection | None |
| translation | InputVector | Translation | (0.0, 0.0, 0.0) |
| local_space | InputBoolean | Local Space | True |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.instances |
GeometrySocket |
Instances |
i.selection |
BooleanSocket |
Selection |
i.translation |
VectorSocket |
Translation |
i.local_space |
BooleanSocket |
Local Space |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.instances |
GeometrySocket |
Instances |
Triangulate
Triangulate(
mesh=None,
selection=None,
quad_method='Shortest Diagonal',
n_gon_method='Beauty',
)Convert all faces in a mesh to triangular faces
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| mesh | InputGeometry | Mesh | None |
| selection | InputBoolean | Selection | None |
| quad_method | InputMenu | Literal['Beauty', 'Fixed', 'Fixed Alternate', 'Shortest Diagonal', 'Longest Diagonal'] | Quad Method | 'Shortest Diagonal' |
| n_gon_method | InputMenu | Literal['Beauty', 'Clip'] | N-gon Method | 'Beauty' |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.mesh |
GeometrySocket |
Mesh |
i.selection |
BooleanSocket |
Selection |
i.quad_method |
MenuSocket |
Quad Method |
i.n_gon_method |
MenuSocket |
N-gon Method |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
TrimCurve
TrimCurve(
curve=None,
selection=None,
start=0.0,
end=1.0,
start_001=0.0,
end_001=1.0,
*,
mode='FACTOR',
)Shorten curves by removing portions at the start or end
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| curve | InputGeometry | Curve | None |
| selection | InputBoolean | Selection | None |
| start | InputFloat | Start | 0.0 |
| end | InputFloat | End | 1.0 |
| start_001 | InputFloat | Start | 0.0 |
| end_001 | InputFloat | End | 1.0 |
Attributes
| Name | Description |
|---|---|
i |
|
mode |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| factor | Create Trim Curve with operation ‘Factor’. Find the endpoint positions using a factor of each spline’s length |
| length | Create Trim Curve with operation ‘Length’. Find the endpoint positions using a length from the start of each spline |
| props | Set the properties every node has and return the node, so it can |
factor
factor(curve=None, selection=None, start=0.0, end=1.0)Create Trim Curve with operation ‘Factor’. Find the endpoint positions using a factor of each spline’s length
length
length(curve=None, selection=None, start=0.0, end=1.0)Create Trim Curve with operation ‘Length’. Find the endpoint positions using a length from the start of each spline
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.curve |
GeometrySocket |
Curve |
i.selection |
BooleanSocket |
Selection |
i.start |
FloatSocket |
Start |
i.end |
FloatSocket |
End |
i.start_001 |
FloatSocket |
Start |
i.end_001 |
FloatSocket |
End |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.curve |
GeometrySocket |
Curve |
UVSphere
UVSphere(segments=32, rings=16, radius=1.0)Generate a spherical mesh with quads, except for triangles at the top and bottom
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| segments | InputInteger | Segments | 32 |
| rings | InputInteger | Rings | 16 |
| radius | InputFloat | Radius | 1.0 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.segments |
IntegerSocket |
Segments |
i.rings |
IntegerSocket |
Rings |
i.radius |
FloatSocket |
Radius |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.mesh |
GeometrySocket |
Mesh |
o.uv_map |
VectorSocket |
UV Map |
XPBDSolver
XPBDSolver(
world=None,
delta_time=0.04,
filter='',
simulation_to_world=None,
substeps=10,
constraint_iterations=1,
solver_path='',
begin=0.0,
end=1.0,
)Simulate physics using the XPBD framework
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| world | InputBundle | World | None |
| delta_time | InputFloat | Delta Time | 0.04 |
| filter | InputString | Filter | '' |
| simulation_to_world | InputMatrix | Simulation to World | None |
| substeps | InputInteger | Substeps | 10 |
| constraint_iterations | InputInteger | Constraint Iterations | 1 |
| solver_path | InputString | Solver Path | '' |
| begin | InputFloat | Begin | 0.0 |
| end | InputFloat | End | 1.0 |
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.world |
BundleSocket |
World |
i.delta_time |
FloatSocket |
Delta Time |
i.filter |
StringSocket |
Filter |
i.simulation_to_world |
MatrixSocket |
Simulation to World |
i.substeps |
IntegerSocket |
Substeps |
i.constraint_iterations |
IntegerSocket |
Constraint Iterations |
i.solver_path |
StringSocket |
Solver Path |
i.begin |
FloatSocket |
Begin |
i.end |
FloatSocket |
End |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.world |
BundleSocket |
World |