nodes.geometry.geometry

geometry

Classes

Name	Description
Arc	Generate a poly spline arc
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
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
GeometryProximity	Compute the closest location on the target 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
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
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
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
SampleCurve	Retrieve data from a point on a curve at a certain distance from its start
SampleIndex	Retrieve values from specific geometry elements
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
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
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
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
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

Arc

Arc(
    resolution=16,
    start=None,
    middle=None,
    end=None,
    radius=1.0,
    start_angle=0.0,
    sweep_angle=5.4978,
    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	`None`
middle	InputVector	Middle	`None`
end	InputVector	End	`None`
radius	InputFloat	Radius	`1.0`
start_angle	InputFloat	Start Angle	`0.0`
sweep_angle	InputFloat	Sweep Angle	`5.4978`
offset_angle	InputFloat	Offset Angle	`0.0`
connect_center	InputBoolean	Connect Center	`False`
invert_arc	InputBoolean	Invert Arc	`False`

Attributes

Name	Description
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
points	Create Arc with operation ‘Points’. Define arc by 3 points on circle. Arc is calculated between start and end points
radius	Create Arc with operation ‘Radius’. Define radius with a float

points

points(
    resolution=16,
    start=None,
    middle=None,
    end=None,
    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

radius

radius(
    resolution=16,
    radius=1.0,
    start_angle=0.0,
    sweep_angle=5.4978,
    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

BezierSegment

BezierSegment(
    resolution=16,
    start=None,
    start_handle=None,
    end_handle=None,
    end=None,
    *,
    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	`None`
start_handle	InputVector	Start Handle	`None`
end_handle	InputVector	End Handle	`None`
end	InputVector	End	`None`

Attributes

Name	Description
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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

offset

offset(resolution=16, start=None, start_handle=None, end_handle=None, end=None)

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=None,
    start_handle=None,
    end_handle=None,
    end=None,
)

Create Bézier Segment with operation ‘Position’. The start and end handles are fixed positions

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
n_gon	Create Cone with operation ‘N-Gon’.
none	Create Cone with operation ‘None’.
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’.

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

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.geometry`	`GeometrySocket`	Geometry

Outputs

Attribute	Type	Description
`o.convex_hull`	`GeometrySocket`	Convex Hull

Cube

Cube(size=None, 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	`None`
vertices_x	InputInteger	Vertices X	`2`
vertices_y	InputInteger	Vertices Y	`2`
vertices_z	InputInteger	Vertices Z	`2`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=None,
    point_2=None,
    point_3=None,
    radius=1.0,
    *,
    mode='RADIUS',
)

Generate a poly spline circle

Parameters

Name	Type	Description	Default
resolution	InputInteger	Resolution	`32`
point_1	InputVector	Point 1	`None`
point_2	InputVector	Point 2	`None`
point_3	InputVector	Point 3	`None`
radius	InputFloat	Radius	`1.0`

Attributes

Name	Description
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
points	Create Curve Circle with operation ‘Points’. Define the radius and location with three points
radius	Create Curve Circle with operation ‘Radius’. Define the radius with a float

points

points(resolution=32, point_1=None, point_2=None, point_3=None)

Create Curve Circle with operation ‘Points’. Define the radius and location with three points

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.curve`	`GeometrySocket`	Curve

Outputs

Attribute	Type	Description
`o.length`	`FloatSocket`	Length

CurveLine

CurveLine(start=None, end=None, direction=None, length=1.0, *, mode='POINTS')

Generate a poly spline line with two points

Parameters

Name	Type	Description	Default
start	InputVector	Start	`None`
end	InputVector	End	`None`
direction	InputVector	Direction	`None`
length	InputFloat	Length	`1.0`

Attributes

Name	Description
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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

direction

direction(start=None, direction=None, length=1.0)

Create Curve Line with operation ‘Direction’. Define a line with a start point, direction and length

points

points(start=None, end=None)

Create Curve Line with operation ‘Points’. Define the start and end points of the line

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)

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`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.curve`	`GeometrySocket`	Curve
`i.profile_curve`	`GeometrySocket`	Profile Curve
`i.scale`	`FloatSocket`	Scale
`i.fill_caps`	`BooleanSocket`	Fill Caps

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`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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

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

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=True, 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	`True`
instances_as_layers	InputBoolean	Instances as Layers	`True`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
n_gon	Create Cylinder with operation ‘N-Gon’.
none	Create Cylinder with operation ‘None’.
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’.

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.curves`	`GeometrySocket`	Curves

Outputs

Attribute	Type	Description
`o.curves`	`GeometrySocket`	Curves

DeleteGeometry

DeleteGeometry(geometry=None, selection=True, *, mode='ALL', domain='POINT')

Remove selected elements of a geometry

Parameters

Name	Type	Description	Default
geometry	InputGeometry	Geometry	`None`
selection	InputBoolean	Selection	`True`

Attributes

Name	Description
`domain`
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
all	Create Delete Geometry with operation ‘All’.
edge	Create Delete Geometry with operation ‘Edge’. Attribute on mesh edge
face	Create Delete Geometry with operation ‘Face’. Attribute on mesh faces
instance	Create Delete Geometry with operation ‘Instance’. Attribute on instance
layer	Create Delete Geometry with operation ‘Layer’. Attribute on 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’. Attribute on point
spline	Create Delete Geometry with operation ‘Spline’. Attribute on spline

all

all(geometry=None, selection=True)

Create Delete Geometry with operation ‘All’.

edge

edge(geometry=None, selection=True)

Create Delete Geometry with operation ‘Edge’. Attribute on mesh edge

face

face(geometry=None, selection=True)

Create Delete Geometry with operation ‘Face’. Attribute on mesh faces

instance

instance(geometry=None, selection=True)

Create Delete Geometry with operation ‘Instance’. Attribute on instance

layer

layer(geometry=None, selection=True)

Create Delete Geometry with operation ‘Layer’. Attribute on Grease Pencil layer

only_edges_faces

only_edges_faces(geometry=None, selection=True)

Create Delete Geometry with operation ‘Only Edges & Faces’.

only_faces

only_faces(geometry=None, selection=True)

Create Delete Geometry with operation ‘Only Faces’.

point

point(geometry=None, selection=True)

Create Delete Geometry with operation ‘Point’. Attribute on point

spline

spline(geometry=None, selection=True)

Create Delete Geometry with operation ‘Spline’. Attribute on 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=True,
    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	`True`
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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`
`use_legacy_normal`

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True, 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	`True`
amount	InputInteger	Amount	`1`

Attributes

Name	Description
`domain`
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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’.
spline	Create Duplicate Elements with operation ‘Spline’.

edge

edge(geometry=None, selection=True, amount=1)

Create Duplicate Elements with operation ‘Edge’.

face

face(geometry=None, selection=True, amount=1)

Create Duplicate Elements with operation ‘Face’.

instance

instance(geometry=None, selection=True, amount=1)

Create Duplicate Elements with operation ‘Instance’.

layer

layer(geometry=None, selection=True, amount=1)

Create Duplicate Elements with operation ‘Layer’.

point

point(geometry=None, selection=True, amount=1)

Create Duplicate Elements with operation ‘Point’.

spline

spline(geometry=None, selection=True, 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=True, next_vertex_index=-1)

Output curves following paths across mesh edges

Parameters

Name	Type	Description	Default
mesh	InputGeometry	Mesh	`None`
start_vertices	InputBoolean	Start Vertices	`True`
next_vertex_index	InputInteger	Next Vertex Index	`-1`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True,
    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	`True`
offset	InputVector	Offset	`None`
offset_scale	InputFloat	Offset Scale	`1.0`
individual	InputBoolean	Individual	`True`

Attributes

Name	Description
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
edges	Create Extrude Mesh with operation ‘Edges’.
faces	Create Extrude Mesh with operation ‘Faces’.
vertices	Create Extrude Mesh with operation ‘Vertices’.

edges

edges(mesh=None, selection=True, offset=None, offset_scale=1.0)

Create Extrude Mesh with operation ‘Edges’.

faces

faces(mesh=None, selection=True, offset=None, offset_scale=1.0, individual=True)

Create Extrude Mesh with operation ‘Faces’.

vertices

vertices(mesh=None, selection=True, 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=0, mode='Triangles')

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	`0`
mode	InputMenu \| Literal['Triangles', 'N-gons']	Mode	`'Triangles'`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.curve`	`GeometrySocket`	Curve
`i.group_id`	`IntegerSocket`	Group ID
`i.mode`	`MenuSocket`	Mode

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True)

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	`True`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.mesh`	`GeometrySocket`	Mesh
`i.selection`	`BooleanSocket`	Selection

Outputs

Attribute	Type	Description
`o.mesh`	`GeometrySocket`	Mesh

GeometryProximity

GeometryProximity(
    target=None,
    group_id=0,
    source_position=None,
    sample_group_id=0,
    *,
    target_element='FACES',
)

Compute the closest location on the target geometry

Parameters

Name	Type	Description	Default
target	InputGeometry	Geometry	`None`
group_id	InputInteger	Group ID	`0`
source_position	InputVector	Sample Position	`None`
sample_group_id	InputInteger	Sample Group ID	`0`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`target_element`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.target`	`GeometrySocket`	Geometry
`i.group_id`	`IntegerSocket`	Group ID
`i.source_position`	`VectorSocket`	Sample Position
`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

GreasePencilToCurves

GreasePencilToCurves(
    grease_pencil=None,
    selection=True,
    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	`True`
layers_as_instances	InputBoolean	Layers as Instances	`True`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True,
    instance=None,
    pick_instance=False,
    instance_index=0,
    rotation=None,
    scale=None,
)

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	`True`
instance	InputGeometry	Instance	`None`
pick_instance	InputBoolean	Pick Instance	`False`
instance_index	InputInteger	Instance Index	`0`
rotation	InputRotation	Rotation	`None`
scale	InputVector	Scale	`None`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True, 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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

InterpolateCurves

InterpolateCurves(
    guide_curves=None,
    guide_up=None,
    guide_group_id=0,
    points=None,
    point_up=None,
    point_group_id=0,
    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	`0`
points	InputGeometry	Points	`None`
point_up	InputVector	Point Up	`None`
point_group_id	InputInteger	Point Group ID	`0`
max_neighbors	InputInteger	Max Neighbors	`4`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.material`	`MaterialSocket`	Material

Outputs

Attribute	Type	Description
`o.selection`	`BooleanSocket`	Selection

MergeByDistance

MergeByDistance(geometry=None, selection=True, 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	`True`
mode	InputMenu \| Literal['All', 'Connected']	Mode	`'All'`
distance	InputFloat	Distance	`0.001`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True,
    group_id=0,
    *,
    mode='MERGE_BY_NAME',
)

Join groups of Grease Pencil layers into one

Parameters

Name	Type	Description	Default
grease_pencil	InputGeometry	Grease Pencil	`None`
selection	InputBoolean	Selection	`True`
group_id	InputInteger	Group ID	`0`

Attributes

Name	Description
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
by_group_id	Create Merge Layers with operation ‘By Group ID’. Provide a custom group ID for each layer and all layers with the same ID will be merged into one
by_name	Create Merge Layers with operation ‘By Name’. Combine all layers which have the same name

by_group_id

by_group_id(grease_pencil=None, selection=True, group_id=0)

Create Merge Layers with operation ‘By Group ID’. Provide a custom group ID for each layer and all layers with the same ID will be merged into one

by_name

by_name(grease_pencil=None, selection=True)

Create Merge Layers with operation ‘By Name’. Combine all layers which have the same name

Inputs

Attribute	Type	Description
`i.grease_pencil`	`GeometrySocket`	Grease Pencil
`i.selection`	`BooleanSocket`	Selection
`i.group_id`	`IntegerSocket`	Group ID

Outputs

Attribute	Type	Description
`o.grease_pencil`	`GeometrySocket`	Grease Pencil

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
n_gon	Create Mesh Circle with operation ‘N-Gon’.
none	Create Mesh Circle with operation ‘None’.
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’.

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=None,
    offset=None,
    *,
    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	`None`
offset	InputVector	Offset	`None`

Attributes

Name	Description
`count_mode`
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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

end_points

end_points(count=10, start_location=None, offset=None)

Create Mesh Line with operation ‘End Points’. Specify the line’s start and end points

offset

offset(count=10, start_location=None, offset=None)

Create Mesh Line with operation ‘Offset’. Specify the offset from one vertex to the next

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=True, *, mode='EDGES')

Generate a curve from a mesh

Parameters

Name	Type	Description	Default
mesh	InputGeometry	Mesh	`None`
selection	InputBoolean	Selection	`True`

Attributes

Name	Description
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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.

edges

edges(mesh=None, selection=True)

Create Mesh to Curve with operation ‘Edges’. Convert mesh edges to curve segments. Attributes are propagated to curve points.

faces

faces(mesh=None, selection=True)

Create Mesh to Curve with operation ‘Faces’. Convert each mesh face to a cyclic curve. Face attributes are propagated to curves.

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=True,
    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	`True`
position	InputVector	Position	`None`
radius	InputFloat	Radius	`0.05`

Attributes

Name	Description
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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
vertices	Create Mesh to Points with operation ‘Vertices’. Create a point in the point cloud for each selected vertex

corners

corners(mesh=None, selection=True, 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=True, 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=True, position=None, radius=0.05)

Create Mesh to Points with operation ‘Faces’. Create a point in the point cloud for each selected face

vertices

vertices(mesh=None, selection=True, 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=None, 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	`None`
radius	InputFloat	Radius	`0.1`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.count`	`IntegerSocket`	Count
`i.position`	`VectorSocket`	Position
`i.radius`	`FloatSocket`	Radius

Outputs

Attribute	Type	Description
`o.geometry`	`GeometrySocket`	Points

PointsToCurves

PointsToCurves(points=None, curve_group_id=0, weight=0.0)

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	`0`
weight	InputFloat	Weight	`0.0`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True)

Generate a mesh vertex for each point cloud point

Parameters

Name	Type	Description	Default
points	InputGeometry	Points	`None`
selection	InputBoolean	Selection	`True`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=None, middle=None, end=None)

Generate a poly spline in a parabola shape with control points positions

Parameters

Name	Type	Description	Default
resolution	InputInteger	Resolution	`16`
start	InputVector	Start	`None`
middle	InputVector	Middle	`None`
end	InputVector	End	`None`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=None,
    point_2=None,
    point_3=None,
    point_4=None,
    *,
    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	`None`
point_2	InputVector	Point 2	`None`
point_3	InputVector	Point 3	`None`
point_4	InputVector	Point 4	`None`

Attributes

Name	Description
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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
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=None, point_2=None, point_3=None, point_4=None)

Create Quadrilateral with operation ‘Points’. Create a quadrilateral from four points

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

Raycast

Raycast(
    target_geometry=None,
    attribute=0.0,
    interpolation='Interpolated',
    source_position=None,
    ray_direction=None,
    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	`0.0`
interpolation	InputMenu \| Literal['Interpolated', 'Nearest']	Interpolation	`'Interpolated'`
source_position	InputVector	Source Position	`None`
ray_direction	InputVector	Ray Direction	`None`
ray_length	InputFloat	Ray Length	`100.0`

Attributes

Name	Description
`data_type`
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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
input_4x4_matrix	Create Raycast with operation ‘4x4 Matrix’. Floating point matrix
integer	Create Raycast with operation ‘Integer’. 32-bit integer
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=False,
    interpolation='Interpolated',
    source_position=None,
    ray_direction=None,
    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=None,
    ray_length=100.0,
)

Create Raycast with operation ‘Color’. RGBA color with 32-bit floating-point values

float

float(
    target_geometry=None,
    attribute=0.0,
    interpolation='Interpolated',
    source_position=None,
    ray_direction=None,
    ray_length=100.0,
)

Create Raycast with operation ‘Float’. Floating-point value

input_4x4_matrix

input_4x4_matrix(
    target_geometry=None,
    attribute=None,
    interpolation='Interpolated',
    source_position=None,
    ray_direction=None,
    ray_length=100.0,
)

Create Raycast with operation ‘4x4 Matrix’. Floating point matrix

integer

integer(
    target_geometry=None,
    attribute=0,
    interpolation='Interpolated',
    source_position=None,
    ray_direction=None,
    ray_length=100.0,
)

Create Raycast with operation ‘Integer’. 32-bit integer

quaternion

quaternion(
    target_geometry=None,
    attribute=None,
    interpolation='Interpolated',
    source_position=None,
    ray_direction=None,
    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=None,
    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=True, realize_all=True, depth=0)

Convert instances into real geometry data

Parameters

Name	Type	Description	Default
geometry	InputGeometry	Geometry	`None`
selection	InputBoolean	Selection	`True`
realize_all	InputBoolean	Realize All	`True`
depth	InputInteger	Depth	`0`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.geometry`	`GeometrySocket`	Geometry
`i.selection`	`BooleanSocket`	Selection
`i.realize_all`	`BooleanSocket`	Realize All
`i.depth`	`IntegerSocket`	Depth

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True,
    mode='Count',
    count=10,
    length=0.1,
    *,
    keep_last_segment=False,
)

Generate a poly spline for each input spline

Parameters

Name	Type	Description	Default
curve	InputGeometry	Curve	`None`
selection	InputBoolean	Selection	`True`
mode	InputMenu \| Literal['Evaluated', 'Count', 'Length']	Mode	`'Count'`
count	InputInteger	Count	`10`
length	InputFloat	Length	`0.1`

Attributes

Name	Description
`i`
`inputs`
`keep_last_segment`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True)

Change the direction of curves by swapping their start and end data

Parameters

Name	Type	Description	Default
curve	InputGeometry	Curve	`None`
selection	InputBoolean	Selection	`True`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True,
    rotation=None,
    pivot_point=None,
    local_space=True,
)

Rotate geometry instances in local or global space

Parameters

Name	Type	Description	Default
instances	InputGeometry	Instances	`None`
selection	InputBoolean	Selection	`True`
rotation	InputRotation	Rotation	`None`
pivot_point	InputVector	Pivot Point	`None`
local_space	InputBoolean	Local Space	`True`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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

SampleCurve

SampleCurve(
    curves=None,
    value=0.0,
    factor=0.0,
    length=0.0,
    curve_index=0,
    *,
    mode='FACTOR',
    use_all_curves=False,
    data_type='FLOAT',
)

Retrieve data from a point on a curve at a certain distance from its start

Parameters

Name	Type	Description	Default
curves	InputGeometry	Curves	`None`
value	InputFloat	Value	`0.0`
factor	InputFloat	Factor	`0.0`
length	InputFloat	Length	`0.0`
curve_index	InputInteger	Curve Index	`0`

Attributes

Name	Description
`data_type`
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`
`use_all_curves`

Methods

Name	Description
boolean	Create Sample Curve with operation ‘Boolean’. True or false
color	Create Sample Curve with operation ‘Color’. RGBA color with 32-bit floating-point values
factor	Create Sample Curve with operation ‘Factor’. Find sample positions on the curve using a factor of its total length
float	Create Sample Curve with operation ‘Float’. Floating-point value
input_4x4_matrix	Create Sample Curve with operation ‘4x4 Matrix’. Floating point matrix
integer	Create Sample Curve with operation ‘Integer’. 32-bit integer
length	Create Sample Curve with operation ‘Length’. Find sample positions on the curve using a distance from its beginning
quaternion	Create Sample Curve with operation ‘Quaternion’. Floating point quaternion rotation
vector	Create Sample Curve with operation ‘Vector’. 3D vector with floating-point values

boolean

boolean(curves=None, value=False, factor=0.0, curve_index=0)

Create Sample Curve with operation ‘Boolean’. True or false

color

color(curves=None, value=None, factor=0.0, curve_index=0)

Create Sample Curve with operation ‘Color’. RGBA color with 32-bit floating-point values

factor

factor(curves=None, value=0.0, factor=0.0, curve_index=0)

Create Sample Curve with operation ‘Factor’. Find sample positions on the curve using a factor of its total length

float

float(curves=None, value=0.0, factor=0.0, curve_index=0)

Create Sample Curve with operation ‘Float’. Floating-point value

input_4x4_matrix

input_4x4_matrix(curves=None, value=None, factor=0.0, curve_index=0)

Create Sample Curve with operation ‘4x4 Matrix’. Floating point matrix

integer

integer(curves=None, value=0, factor=0.0, curve_index=0)

Create Sample Curve with operation ‘Integer’. 32-bit integer

length

length(curves=None, value=0.0, length=0.0, curve_index=0)

Create Sample Curve with operation ‘Length’. Find sample positions on the curve using a distance from its beginning

quaternion

quaternion(curves=None, value=None, factor=0.0, curve_index=0)

Create Sample Curve with operation ‘Quaternion’. Floating point quaternion rotation

vector

vector(curves=None, value=None, factor=0.0, curve_index=0)

Create Sample Curve with operation ‘Vector’. 3D vector with floating-point values

Inputs

Attribute	Type	Description
`i.curves`	`GeometrySocket`	Curves
`i.value`	`FloatSocket`	Value
`i.factor`	`FloatSocket`	Factor
`i.length`	`FloatSocket`	Length
`i.curve_index`	`IntegerSocket`	Curve Index

Outputs

Attribute	Type	Description
`o.value`	`FloatSocket`	Value
`o.position`	`VectorSocket`	Position
`o.tangent`	`VectorSocket`	Tangent
`o.normal`	`VectorSocket`	Normal

SampleIndex

SampleIndex(
    geometry=None,
    value=0.0,
    index=0,
    *,
    data_type='FLOAT',
    domain='POINT',
    clamp=False,
)

Retrieve values from specific geometry elements

Parameters

Name	Type	Description	Default
geometry	InputGeometry	Geometry	`None`
value	InputFloat	Value	`0.0`
index	InputInteger	Index	`0`

Attributes

Name	Description
`clamp`
`data_type`
`domain`
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
boolean	Create Sample Index with operation ‘Boolean’. True or false
color	Create Sample Index with operation ‘Color’. RGBA color with 32-bit floating-point values
edge	Create Sample Index with operation ‘Edge’. Attribute on mesh edge
face	Create Sample Index with operation ‘Face’. Attribute on mesh faces
face_corner	Create Sample Index with operation ‘Face Corner’. Attribute on mesh face corner
float	Create Sample Index with operation ‘Float’. Floating-point value
input_4x4_matrix	Create Sample Index with operation ‘4x4 Matrix’. Floating point matrix
instance	Create Sample Index with operation ‘Instance’. Attribute on instance
integer	Create Sample Index with operation ‘Integer’. 32-bit integer
layer	Create Sample Index with operation ‘Layer’. Attribute on Grease Pencil layer
point	Create Sample Index with operation ‘Point’. Attribute on point
quaternion	Create Sample Index with operation ‘Quaternion’. Floating point quaternion rotation
spline	Create Sample Index with operation ‘Spline’. Attribute on spline
vector	Create Sample Index with operation ‘Vector’. 3D vector with floating-point values

boolean

boolean(geometry=None, value=False, index=0)

Create Sample Index with operation ‘Boolean’. True or false

color

color(geometry=None, value=None, index=0)

Create Sample Index with operation ‘Color’. RGBA color with 32-bit floating-point values

edge

edge(geometry=None, value=0.0, index=0)

Create Sample Index with operation ‘Edge’. Attribute on mesh edge

face

face(geometry=None, value=0.0, index=0)

Create Sample Index with operation ‘Face’. Attribute on mesh faces

face_corner

face_corner(geometry=None, value=0.0, index=0)

Create Sample Index with operation ‘Face Corner’. Attribute on mesh face corner

float

float(geometry=None, value=0.0, index=0)

Create Sample Index with operation ‘Float’. Floating-point value

input_4x4_matrix

input_4x4_matrix(geometry=None, value=None, index=0)

Create Sample Index with operation ‘4x4 Matrix’. Floating point matrix

instance

instance(geometry=None, value=0.0, index=0)

Create Sample Index with operation ‘Instance’. Attribute on instance

integer

integer(geometry=None, value=0, index=0)

Create Sample Index with operation ‘Integer’. 32-bit integer

layer

layer(geometry=None, value=0.0, index=0)

Create Sample Index with operation ‘Layer’. Attribute on Grease Pencil layer

point

point(geometry=None, value=0.0, index=0)

Create Sample Index with operation ‘Point’. Attribute on point

quaternion

quaternion(geometry=None, value=None, index=0)

Create Sample Index with operation ‘Quaternion’. Floating point quaternion rotation

spline

spline(geometry=None, value=0.0, index=0)

Create Sample Index with operation ‘Spline’. Attribute on spline

vector

vector(geometry=None, value=None, index=0)

Create Sample Index with operation ‘Vector’. 3D vector with floating-point values

Inputs

Attribute	Type	Description
`i.geometry`	`GeometrySocket`	Geometry
`i.value`	`FloatSocket`	Value
`i.index`	`IntegerSocket`	Index

Outputs

Attribute	Type	Description
`o.value`	`FloatSocket`	Value

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
edge	Create Sample Nearest with operation ‘Edge’. Attribute on mesh edge
face	Create Sample Nearest with operation ‘Face’. Attribute on mesh faces
face_corner	Create Sample Nearest with operation ‘Face Corner’. Attribute on mesh face corner
point	Create Sample Nearest with operation ‘Point’. Attribute on point

edge

edge(geometry=None, sample_position=None)

Create Sample Nearest with operation ‘Edge’. Attribute on mesh edge

face

face(geometry=None, sample_position=None)

Create Sample Nearest with operation ‘Face’. Attribute on mesh faces

face_corner

face_corner(geometry=None, sample_position=None)

Create Sample Nearest with operation ‘Face Corner’. Attribute on mesh face corner

point

point(geometry=None, sample_position=None)

Create Sample Nearest with operation ‘Point’. Attribute on point

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=0.0,
    group_id=0,
    sample_position=None,
    sample_group_id=0,
    *,
    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	`0.0`
group_id	InputInteger	Group ID	`0`
sample_position	InputVector	Sample Position	`None`
sample_group_id	InputInteger	Sample Group ID	`0`

Attributes

Name	Description
`data_type`
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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
input_4x4_matrix	Create Sample Nearest Surface with operation ‘4x4 Matrix’. Floating point matrix
integer	Create Sample Nearest Surface with operation ‘Integer’. 32-bit integer
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=False,
    group_id=0,
    sample_position=None,
    sample_group_id=0,
)

Create Sample Nearest Surface with operation ‘Boolean’. True or false

color

color(
    mesh=None,
    value=None,
    group_id=0,
    sample_position=None,
    sample_group_id=0,
)

Create Sample Nearest Surface with operation ‘Color’. RGBA color with 32-bit floating-point values

float

float(mesh=None, value=0.0, group_id=0, sample_position=None, sample_group_id=0)

Create Sample Nearest Surface with operation ‘Float’. Floating-point value

input_4x4_matrix

input_4x4_matrix(
    mesh=None,
    value=None,
    group_id=0,
    sample_position=None,
    sample_group_id=0,
)

Create Sample Nearest Surface with operation ‘4x4 Matrix’. Floating point matrix

integer

integer(mesh=None, value=0, group_id=0, sample_position=None, sample_group_id=0)

Create Sample Nearest Surface with operation ‘Integer’. 32-bit integer

quaternion

quaternion(
    mesh=None,
    value=None,
    group_id=0,
    sample_position=None,
    sample_group_id=0,
)

Create Sample Nearest Surface with operation ‘Quaternion’. Floating point quaternion rotation

vector

vector(
    mesh=None,
    value=None,
    group_id=0,
    sample_position=None,
    sample_group_id=0,
)

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=0.0,
    source_uv_map=None,
    sample_uv=None,
    *,
    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	`0.0`
source_uv_map	InputVector	UV Map	`None`
sample_uv	InputVector	Sample UV	`None`

Attributes

Name	Description
`data_type`
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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
input_4x4_matrix	Create Sample UV Surface with operation ‘4x4 Matrix’. Floating point matrix
integer	Create Sample UV Surface with operation ‘Integer’. 32-bit integer
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=False, source_uv_map=None, sample_uv=None)

Create Sample UV Surface with operation ‘Boolean’. True or false

color

color(mesh=None, value=None, source_uv_map=None, sample_uv=None)

Create Sample UV Surface with operation ‘Color’. RGBA color with 32-bit floating-point values

float

float(mesh=None, value=0.0, source_uv_map=None, sample_uv=None)

Create Sample UV Surface with operation ‘Float’. Floating-point value

input_4x4_matrix

input_4x4_matrix(mesh=None, value=None, source_uv_map=None, sample_uv=None)

Create Sample UV Surface with operation ‘4x4 Matrix’. Floating point matrix

integer

integer(mesh=None, value=0, source_uv_map=None, sample_uv=None)

Create Sample UV Surface with operation ‘Integer’. 32-bit integer

quaternion

quaternion(mesh=None, value=None, source_uv_map=None, sample_uv=None)

Create Sample UV Surface with operation ‘Quaternion’. Floating point quaternion rotation

vector

vector(mesh=None, value=None, source_uv_map=None, sample_uv=None)

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.source_uv_map`	`VectorSocket`	UV Map
`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=True,
    scale=1.0,
    center=None,
    scale_mode='Uniform',
    axis=None,
    *,
    domain='FACE',
)

Scale groups of connected edges and faces

Parameters

Name	Type	Description	Default
geometry	InputGeometry	Geometry	`None`
selection	InputBoolean	Selection	`True`
scale	InputFloat	Scale	`1.0`
center	InputVector	Center	`None`
scale_mode	InputMenu \| Literal['Uniform', 'Single Axis']	Scale Mode	`'Uniform'`
axis	InputVector	Axis	`None`

Attributes

Name	Description
`domain`
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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

edge

edge(
    geometry=None,
    selection=True,
    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=True,
    scale=1.0,
    center=None,
    scale_mode='Uniform',
)

Create Scale Elements with operation ‘Face’. Scale individual faces or neighboring face islands

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=True,
    scale=None,
    center=None,
    local_space=True,
)

Scale geometry instances in local or global space

Parameters

Name	Type	Description	Default
instances	InputGeometry	Instances	`None`
selection	InputBoolean	Selection	`True`
scale	InputVector	Scale	`None`
center	InputVector	Center	`None`
local_space	InputBoolean	Local Space	`True`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True, *, 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	`True`

Attributes

Name	Description
`domain`
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
edge	Create Separate Geometry with operation ‘Edge’. Attribute on mesh edge
face	Create Separate Geometry with operation ‘Face’. Attribute on mesh faces
instance	Create Separate Geometry with operation ‘Instance’. Attribute on instance
layer	Create Separate Geometry with operation ‘Layer’. Attribute on Grease Pencil layer
point	Create Separate Geometry with operation ‘Point’. Attribute on point
spline	Create Separate Geometry with operation ‘Spline’. Attribute on spline

edge

edge(geometry=None, selection=True)

Create Separate Geometry with operation ‘Edge’. Attribute on mesh edge

face

face(geometry=None, selection=True)

Create Separate Geometry with operation ‘Face’. Attribute on mesh faces

instance

instance(geometry=None, selection=True)

Create Separate Geometry with operation ‘Instance’. Attribute on instance

layer

layer(geometry=None, selection=True)

Create Separate Geometry with operation ‘Layer’. Attribute on Grease Pencil layer

point

point(geometry=None, selection=True)

Create Separate Geometry with operation ‘Point’. Attribute on point

spline

spline(geometry=None, selection=True)

Create Separate Geometry with operation ‘Spline’. Attribute on 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=True, mode='Minimum Twist', normal=None)

Set the evaluation mode for curve normals

Parameters

Name	Type	Description	Default
curve	InputGeometry	Curve	`None`
selection	InputBoolean	Selection	`True`
mode	InputMenu \| Literal['Minimum Twist', 'Z Up', 'Free']	Mode	`'Minimum Twist'`
normal	InputVector	Normal	`None`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True, 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	`True`
radius	InputFloat	Radius	`0.005`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True, tilt=0.0)

Set the tilt angle at each curve control point

Parameters

Name	Type	Description	Default
curve	InputGeometry	Curve	`None`
selection	InputBoolean	Selection	`True`
tilt	InputFloat	Tilt	`0.0`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True, face_set=0)

Set sculpt face set values for faces

Parameters

Name	Type	Description	Default
mesh	InputGeometry	Mesh	`None`
selection	InputBoolean	Selection	`True`
face_set	InputInteger	Face Set	`0`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True,
    color=None,
    opacity=1.0,
    *,
    mode='STROKE',
)

Set color and opacity attributes on Grease Pencil geometry

Parameters

Name	Type	Description	Default
grease_pencil	InputGeometry	Grease Pencil	`None`
selection	InputBoolean	Selection	`True`
color	InputColor	Color	`None`
opacity	InputFloat	Opacity	`1.0`

Attributes

Name	Description
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
fill	Create Set Grease Pencil Color with operation ‘Fill’. Set the color and opacity for the stroke fills
stroke	Create Set Grease Pencil Color with operation ‘Stroke’. Set the color and opacity for the points of the stroke

fill

fill(grease_pencil=None, selection=True, color=None, opacity=1.0)

Create Set Grease Pencil Color with operation ‘Fill’. Set the color and opacity for the stroke fills

stroke

stroke(grease_pencil=None, selection=True, color=None, opacity=1.0)

Create Set Grease Pencil Color with operation ‘Stroke’. Set the color and opacity for the points of the stroke

Inputs

Attribute	Type	Description
`i.grease_pencil`	`GeometrySocket`	Grease Pencil
`i.selection`	`BooleanSocket`	Selection
`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')

Set the Grease Pencil depth order to use

Parameters

Name	Type	Description	Default
grease_pencil	InputGeometry	Grease Pencil	`None`

Attributes

Name	Description
`depth_order`
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.grease_pencil`	`GeometrySocket`	Grease Pencil

Outputs

Attribute	Type	Description
`o.grease_pencil`	`GeometrySocket`	Grease Pencil

SetGreasePencilSoftness

SetGreasePencilSoftness(grease_pencil=None, selection=True, softness=0.0)

Set softness attribute on Grease Pencil geometry

Parameters

Name	Type	Description	Default
grease_pencil	InputGeometry	Grease Pencil	`None`
selection	InputBoolean	Selection	`True`
softness	InputFloat	Softness	`0.0`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True,
    position=None,
    offset=None,
    *,
    mode='LEFT',
)

Set the positions for the handles of Bézier curves

Parameters

Name	Type	Description	Default
curve	InputGeometry	Curve	`None`
selection	InputBoolean	Selection	`True`
position	InputVector	Position	`None`
offset	InputVector	Offset	`None`

Attributes

Name	Description
`i`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
left	Create Set Handle Positions with operation ‘Left’. Use the left handles
right	Create Set Handle Positions with operation ‘Right’. Use the right handles

left

left(curve=None, selection=True, position=None, offset=None)

Create Set Handle Positions with operation ‘Left’. Use the left handles

right

right(curve=None, selection=True, position=None, offset=None)

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

SetID

SetID(geometry=None, selection=True, id=0)

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	`True`
id	InputInteger	ID	`0`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True, transform=None)

Set the transformation matrix of every instance

Parameters

Name	Type	Description	Default
instances	InputGeometry	Instances	`None`
selection	InputBoolean	Selection	`True`
transform	InputMatrix	Transform	`None`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True, material=None)

Assign a material to geometry elements

Parameters

Name	Type	Description	Default
geometry	InputGeometry	Geometry	`None`
selection	InputBoolean	Selection	`True`
material	InputMaterial	Material	`None`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True, material_index=0)

Set the material index for each selected geometry element

Parameters

Name	Type	Description	Default
geometry	InputGeometry	Geometry	`None`
selection	InputBoolean	Selection	`True`
material_index	InputInteger	Material Index	`0`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
face	Create Set Mesh Normal with operation ‘Face’. Attribute on mesh faces
face_corner	Create Set Mesh Normal with operation ‘Face Corner’. Attribute on 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’. Attribute on point
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)

Create Set Mesh Normal with operation ‘Face’. Attribute on mesh faces

face_corner

face_corner(
    mesh=None,
    remove_custom=True,
    edge_sharpness=False,
    face_sharpness=False,
)

Create Set Mesh Normal with operation ‘Face Corner’. Attribute on mesh face corner

free

free(mesh=None, custom_normal=None)

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)

Create Set Mesh Normal with operation ‘Point’. Attribute on point

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

SetPointRadius

SetPointRadius(points=None, selection=True, radius=0.05)

Set the display size of point cloud points

Parameters

Name	Type	Description	Default
points	InputGeometry	Points	`None`
selection	InputBoolean	Selection	`True`
radius	InputFloat	Radius	`0.05`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True, position=None, offset=None)

Set the location of each point

Parameters

Name	Type	Description	Default
geometry	InputGeometry	Geometry	`None`
selection	InputBoolean	Selection	`True`
position	InputVector	Position	`None`
offset	InputVector	Offset	`None`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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`
`inputs`
`name`
`node`
`o`
`outputs`
`selection_type`
`tree`
`type`

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’. Attribute on mesh edge
face	Create Set Selection with operation ‘Face’. Attribute on mesh faces
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’. Attribute on point
spline	Create Set Selection with operation ‘Spline’. Attribute on spline

boolean

boolean(geometry=None, selection=True)

Create Set Selection with operation ‘Boolean’. Store true or false selection values in edit mode

edge

edge(geometry=None, selection=True)

Create Set Selection with operation ‘Edge’. Attribute on mesh edge

face

face(geometry=None, selection=True)

Create Set Selection with operation ‘Face’. Attribute on mesh faces

float

float(geometry=None, selection=1.0)

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)

Create Set Selection with operation ‘Point’. Attribute on point

spline

spline(geometry=None, selection=True)

Create Set Selection with operation ‘Spline’. Attribute on spline

Inputs

Attribute	Type	Description
`i.geometry`	`GeometrySocket`	Geometry
`i.selection`	`BooleanSocket`	Selection

Outputs

Attribute	Type	Description
`o.geometry`	`GeometrySocket`	Geometry

SetShadeSmooth

SetShadeSmooth(
    geometry=None,
    selection=True,
    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
geometry	InputGeometry	Mesh	`None`
selection	InputBoolean	Selection	`True`
shade_smooth	InputBoolean	Shade Smooth	`True`

Attributes

Name	Description
`domain`
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
edge	Create Set Shade Smooth with operation ‘Edge’. Attribute on mesh edge
face	Create Set Shade Smooth with operation ‘Face’. Attribute on mesh faces

edge

edge(geometry=None, selection=True, shade_smooth=True)

Create Set Shade Smooth with operation ‘Edge’. Attribute on mesh edge

face

face(geometry=None, selection=True, shade_smooth=True)

Create Set Shade Smooth with operation ‘Face’. Attribute on mesh faces

Inputs

Attribute	Type	Description
`i.geometry`	`GeometrySocket`	Mesh
`i.selection`	`BooleanSocket`	Selection
`i.shade_smooth`	`BooleanSocket`	Shade Smooth

Outputs

Attribute	Type	Description
`o.geometry`	`GeometrySocket`	Mesh

SetSplineCyclic

SetSplineCyclic(geometry=None, selection=True, cyclic=False)

Control whether each spline loops back on itself by changing the “cyclic” attribute

Parameters

Name	Type	Description	Default
geometry	InputGeometry	Curve	`None`
selection	InputBoolean	Selection	`True`
cyclic	InputBoolean	Cyclic	`False`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.geometry`	`GeometrySocket`	Curve
`i.selection`	`BooleanSocket`	Selection
`i.cyclic`	`BooleanSocket`	Cyclic

Outputs

Attribute	Type	Description
`o.geometry`	`GeometrySocket`	Curve

SetSplineResolution

SetSplineResolution(geometry=None, selection=True, resolution=12)

Control how many evaluated points should be generated on every curve segment

Parameters

Name	Type	Description	Default
geometry	InputGeometry	Curve	`None`
selection	InputBoolean	Selection	`True`
resolution	InputInteger	Resolution	`12`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.geometry`	`GeometrySocket`	Curve
`i.selection`	`BooleanSocket`	Selection
`i.resolution`	`IntegerSocket`	Resolution

Outputs

Attribute	Type	Description
`o.geometry`	`GeometrySocket`	Curve

SetSplineType

SetSplineType(curve=None, selection=True, *, spline_type='POLY')

Change the type of curves

Parameters

Name	Type	Description	Default
curve	InputGeometry	Curve	`None`
selection	InputBoolean	Selection	`True`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`spline_type`
`tree`
`type`

Methods

Name	Description
bézier	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’.

bézier

bézier(curve=None, selection=True)

Create Set Spline Type with operation ‘Bézier’.

catmull_rom

catmull_rom(curve=None, selection=True)

Create Set Spline Type with operation ‘Catmull Rom’.

nurbs

nurbs(curve=None, selection=True)

Create Set Spline Type with operation ‘NURBS’.

poly

poly(curve=None, selection=True)

Create Set Spline Type with operation ‘Poly’.

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=True,
    group_id=0,
    sort_weight=0.0,
    *,
    domain='POINT',
)

Rearrange geometry elements, changing their indices

Parameters

Name	Type	Description	Default
geometry	InputGeometry	Geometry	`None`
selection	InputBoolean	Selection	`True`
group_id	InputInteger	Group ID	`0`
sort_weight	InputFloat	Sort Weight	`0.0`

Attributes

Name	Description
`domain`
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
edge	Create Sort Elements with operation ‘Edge’. Attribute on mesh edge
face	Create Sort Elements with operation ‘Face’. Attribute on mesh faces
instance	Create Sort Elements with operation ‘Instance’. Attribute on instance
point	Create Sort Elements with operation ‘Point’. Attribute on point
spline	Create Sort Elements with operation ‘Spline’. Attribute on spline

edge

edge(geometry=None, selection=True, group_id=0, sort_weight=0.0)

Create Sort Elements with operation ‘Edge’. Attribute on mesh edge

face

face(geometry=None, selection=True, group_id=0, sort_weight=0.0)

Create Sort Elements with operation ‘Face’. Attribute on mesh faces

instance

instance(geometry=None, selection=True, group_id=0, sort_weight=0.0)

Create Sort Elements with operation ‘Instance’. Attribute on instance

point

point(geometry=None, selection=True, group_id=0, sort_weight=0.0)

Create Sort Elements with operation ‘Point’. Attribute on point

spline

spline(geometry=None, selection=True, group_id=0, sort_weight=0.0)

Create Sort Elements with operation ‘Spline’. Attribute on 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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True)

Duplicate mesh edges and break connections with the surrounding faces

Parameters

Name	Type	Description	Default
mesh	InputGeometry	Mesh	`None`
selection	InputBoolean	Selection	`True`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True, group_id=0, *, domain='POINT')

Create separate geometries containing the elements from the same group

Parameters

Name	Type	Description	Default
geometry	InputGeometry	Geometry	`None`
selection	InputBoolean	Selection	`True`
group_id	InputInteger	Group ID	`0`

Attributes

Name	Description
`domain`
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

Methods

Name	Description
edge	Create Split to Instances with operation ‘Edge’. Attribute on mesh edge
face	Create Split to Instances with operation ‘Face’. Attribute on mesh faces
instance	Create Split to Instances with operation ‘Instance’. Attribute on instance
layer	Create Split to Instances with operation ‘Layer’. Attribute on Grease Pencil layer
point	Create Split to Instances with operation ‘Point’. Attribute on point
spline	Create Split to Instances with operation ‘Spline’. Attribute on spline

edge

edge(geometry=None, selection=True, group_id=0)

Create Split to Instances with operation ‘Edge’. Attribute on mesh edge

face

face(geometry=None, selection=True, group_id=0)

Create Split to Instances with operation ‘Face’. Attribute on mesh faces

instance

instance(geometry=None, selection=True, group_id=0)

Create Split to Instances with operation ‘Instance’. Attribute on instance

layer

layer(geometry=None, selection=True, group_id=0)

Create Split to Instances with operation ‘Layer’. Attribute on Grease Pencil layer

point

point(geometry=None, selection=True, group_id=0)

Create Split to Instances with operation ‘Point’. Attribute on point

spline

spline(geometry=None, selection=True, group_id=0)

Create Split to Instances with operation ‘Spline’. Attribute on 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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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,
    character_spacing=1.0,
    word_spacing=1.0,
    line_spacing=1.0,
    text_box_width=0.0,
    text_box_height=0.0,
    *,
    overflow='OVERFLOW',
    align_x='LEFT',
    align_y='TOP_BASELINE',
    pivot_mode='BOTTOM_LEFT',
)

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`
character_spacing	InputFloat	Character Spacing	`1.0`
word_spacing	InputFloat	Word Spacing	`1.0`
line_spacing	InputFloat	Line Spacing	`1.0`
text_box_width	InputFloat	Text Box Width	`0.0`
text_box_height	InputFloat	Text Box Height	`0.0`

Attributes

Name	Description
`align_x`
`align_y`
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`overflow`
`pivot_mode`
`tree`
`type`

Inputs

Attribute	Type	Description
`i.string`	`StringSocket`	String
`i.size`	`FloatSocket`	Size
`i.character_spacing`	`FloatSocket`	Character Spacing
`i.word_spacing`	`FloatSocket`	Word Spacing
`i.line_spacing`	`FloatSocket`	Line Spacing
`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.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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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,
    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`
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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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.uv_smooth`	`MenuSocket`	UV Smooth
`i.boundary_smooth`	`MenuSocket`	Boundary Smooth

Outputs

Attribute	Type	Description
`o.mesh`	`GeometrySocket`	Mesh

TransformGeometry

TransformGeometry(
    geometry=None,
    mode='Components',
    translation=None,
    rotation=None,
    scale=None,
    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	`None`
rotation	InputRotation	Rotation	`None`
scale	InputVector	Scale	`None`
transform	InputMatrix	Transform	`None`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True,
    translation=None,
    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	`True`
translation	InputVector	Translation	`None`
local_space	InputBoolean	Local Space	`True`

Attributes

Name	Description
`i`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True,
    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	`True`
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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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=True,
    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	`True`
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`
`inputs`
`mode`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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

factor

factor(curve=None, selection=True, 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=True, start_001=0.0, end_001=1.0)

Create Trim Curve with operation ‘Length’. Find the endpoint positions using a length from the start of each spline

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`
`inputs`
`name`
`node`
`o`
`outputs`
`tree`
`type`

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