Geometry nodes

geonodes classes wrapping Blender geometry nodes

Created on 2022-07-10

@author: Generated from generator module

Blender version: 3.2.0

class AccumulateField(value=None, group_index=None, data_type='FLOAT', domain='POINT', label=None, node_color=None)

Node Accumulate Field

Parameters

  • value (DataSocket) – data_type dependant

  • group_index (DataSocket) – Integer

  • data_type (str) – Node parameter, default = ‘FLOAT’ in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’)

  • domain (str) – Node parameter, default = ‘POINT’ in (‘POINT’, ‘EDGE’, ‘FACE’, ‘CORNER’, ‘CURVE’, ‘INSTANCE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • leading : data_type dependant

  • trailing : data_type dependant

  • total : data_type dependant

Shared sockets:

  • Driving parameter : data_type in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’)

  • Input sockets : [‘value’]

  • Output sockets : [‘leading’, ‘trailing’, ‘total’]

Blender reference : GeometryNodeAccumulateField, Node ‘Accumulate Field’

class AlignEulerToVector(rotation=None, factor=None, vector=None, axis='X', pivot_axis='AUTO', label=None, node_color=None)

Node Align Euler to Vector

Parameters

  • rotation (DataSocket) – Vector

  • factor (DataSocket) – Float

  • vector (DataSocket) – Vector

  • axis (str) – Node parameter, default = ‘X’ in (‘X’, ‘Y’, ‘Z’)

  • pivot_axis (str) – Node parameter, default = ‘AUTO’ in (‘AUTO’, ‘X’, ‘Y’, ‘Z’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • rotation : Vector

Blender reference : FunctionNodeAlignEulerToVector, Node ‘Align Euler to Vector’

class Arc(resolution=None, start=None, middle=None, end=None, radius=None, start_angle=None, sweep_angle=None, offset_angle=None, connect_center=None, invert_arc=None, mode='RADIUS', label=None, node_color=None)

Node Arc

Parameters

  • resolution (DataSocket) – Integer

  • start (DataSocket) – Vector

  • middle (DataSocket) – Vector

  • end (DataSocket) – Vector

  • radius (DataSocket) – Float

  • start_angle (DataSocket) – Float

  • sweep_angle (DataSocket) – Float

  • offset_angle (DataSocket) – Float

  • connect_center (DataSocket) – Boolean

  • invert_arc (DataSocket) – Boolean

  • mode (str) – Node parameter, default = ‘RADIUS’ in (‘POINTS’, ‘RADIUS’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

  • center : Vector

  • normal : Vector

  • radius : Float

Blender reference : GeometryNodeCurveArc, Node ‘Arc’

class AttributeStatistic(geometry=None, selection=None, attribute=None, data_type='FLOAT', domain='POINT', label=None, node_color=None)

Node Attribute Statistic

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • attribute (DataSocket) – data_type dependant

  • data_type (str) – Node parameter, default = ‘FLOAT’ in (‘FLOAT’, ‘FLOAT_VECTOR’)

  • domain (str) – Node parameter, default = ‘POINT’ in (‘POINT’, ‘EDGE’, ‘FACE’, ‘CORNER’, ‘CURVE’, ‘INSTANCE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mean : data_type dependant

  • median : data_type dependant

  • sum : data_type dependant

  • min : data_type dependant

  • max : data_type dependant

  • range : data_type dependant

  • standard_deviation : data_type dependant

  • variance : data_type dependant

Shared sockets:

  • Driving parameter : data_type in (‘FLOAT’, ‘FLOAT_VECTOR’)

  • Input sockets : [‘attribute’]

  • Output sockets : [‘mean’, ‘median’, ‘sum’, ‘min’, ‘max’, ‘range’, ‘standard_deviation’, ‘variance’]

Blender reference : GeometryNodeAttributeStatistic, Node ‘Attribute Statistic’

class BezierSegment(resolution=None, start=None, start_handle=None, end_handle=None, end=None, mode='POSITION', label=None, node_color=None)

Node Bezier Segment

Parameters

  • resolution (DataSocket) – Integer

  • start (DataSocket) – Vector

  • start_handle (DataSocket) – Vector

  • end_handle (DataSocket) – Vector

  • end (DataSocket) – Vector

  • mode (str) – Node parameter, default = ‘POSITION’ in (‘POSITION’, ‘OFFSET’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeCurvePrimitiveBezierSegment, Node ‘Bezier Segment’

class Boolean(boolean=False, label=None, node_color=None)

Node Boolean

Parameters

  • boolean (bool) – Node parameter, default = False

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • boolean : Boolean

Blender reference : FunctionNodeInputBool, Node ‘Boolean’

class BooleanMath(boolean0=None, boolean1=None, operation='AND', label=None, node_color=None)

Node Boolean Math

Parameters

  • boolean0 (DataSocket) – Boolean

  • boolean1 (DataSocket) – Boolean

  • operation (str) – Node parameter, default = ‘AND’ in (‘AND’, ‘OR’, ‘NOT’, ‘NAND’, ‘NOR’, ‘XNOR’, ‘XOR’, ‘IMPLY’, ‘NIMPLY’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • boolean : Boolean

Blender reference : FunctionNodeBooleanMath, Node ‘Boolean Math’

class BoundingBox(geometry=None, label=None, node_color=None)

Node Bounding Box

Parameters

  • geometry (DataSocket) – Geometry

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • bounding_box : Geometry

  • min : Vector

  • max : Vector

Blender reference : GeometryNodeBoundBox, Node ‘Bounding Box’

class BrickTexture(vector=None, color1=None, color2=None, mortar=None, scale=None, mortar_size=None, mortar_smooth=None, bias=None, brick_width=None, row_height=None, offset=0.5, offset_frequency=2, squash=1.0, squash_frequency=2, label=None, node_color=None)

Node Brick Texture

Parameters

  • vector (DataSocket) – Vector

  • color1 (DataSocket) – Color

  • color2 (DataSocket) – Color

  • mortar (DataSocket) – Color

  • scale (DataSocket) – Float

  • mortar_size (DataSocket) – Float

  • mortar_smooth (DataSocket) – Float

  • bias (DataSocket) – Float

  • brick_width (DataSocket) – Float

  • row_height (DataSocket) – Float

  • offset (float) – Node parameter, default = 0.5

  • offset_frequency (int) – Node parameter, default = 2

  • squash (float) – Node parameter, default = 1.0

  • squash_frequency (int) – Node parameter, default = 2

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • color : Color

  • fac : Float

Blender reference : ShaderNodeTexBrick, Node ‘Brick Texture’

class CaptureAttribute(geometry=None, value=None, data_type='FLOAT', domain='POINT', label=None, node_color=None)

Node Capture Attribute

Parameters

  • geometry (DataSocket) – Geometry

  • value (DataSocket) – data_type dependant

  • data_type (str) – Node parameter, default = ‘FLOAT’ in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘FLOAT_COLOR’, ‘BOOLEAN’)

  • domain (str) – Node parameter, default = ‘POINT’ in (‘POINT’, ‘EDGE’, ‘FACE’, ‘CORNER’, ‘CURVE’, ‘INSTANCE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

  • attribute : data_type dependant

Shared sockets:

  • Driving parameter : data_type in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘FLOAT_COLOR’, ‘BOOLEAN’)

  • Input sockets : [‘value’]

  • Output sockets : [‘attribute’]

Blender reference : GeometryNodeCaptureAttribute, Node ‘Capture Attribute’

class CheckerTexture(vector=None, color1=None, color2=None, scale=None, label=None, node_color=None)

Node Checker Texture

Parameters

  • vector (DataSocket) – Vector

  • color1 (DataSocket) – Color

  • color2 (DataSocket) – Color

  • scale (DataSocket) – Float

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • color : Color

  • fac : Float

Blender reference : ShaderNodeTexChecker, Node ‘Checker Texture’

class Clamp(value=None, min=None, max=None, clamp_type='MINMAX', label=None, node_color=None)

Node Clamp

Parameters

  • value (DataSocket) – Float

  • min (DataSocket) – Float

  • max (DataSocket) – Float

  • clamp_type (str) – Node parameter, default = ‘MINMAX’ in (‘MINMAX’, ‘RANGE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • result : Float

Blender reference : ShaderNodeClamp, Node ‘Clamp’

class CollectionInfo(collection=None, separate_children=None, reset_children=None, transform_space='ORIGINAL', label=None, node_color=None)

Node Collection Info

Parameters

  • collection (DataSocket) – Collection

  • separate_children (DataSocket) – Boolean

  • reset_children (DataSocket) – Boolean

  • transform_space (str) – Node parameter, default = ‘ORIGINAL’ in (‘ORIGINAL’, ‘RELATIVE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeCollectionInfo, Node ‘Collection Info’

class Color(label=None, node_color=None)

Node Color

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • color : Color

Blender reference : FunctionNodeInputColor, Node ‘Color’

class ColorRamp(fac=None, label=None, node_color=None)

Node ColorRamp

Parameters

  • fac (DataSocket) – Float

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • color : Color

  • alpha : Float

Blender reference : ShaderNodeValToRGB, Node ‘ColorRamp’

class CombineRgb(r=None, g=None, b=None, label=None, node_color=None)

Node Combine RGB

Parameters

  • r (DataSocket) – Float

  • g (DataSocket) – Float

  • b (DataSocket) – Float

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • image : Color

Blender reference : ShaderNodeCombineRGB, Node ‘Combine RGB’

class CombineXyz(x=None, y=None, z=None, label=None, node_color=None)

Node Combine XYZ

Parameters

  • x (DataSocket) – Float

  • y (DataSocket) – Float

  • z (DataSocket) – Float

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • vector : Vector

Blender reference : ShaderNodeCombineXYZ, Node ‘Combine XYZ’

class Compare(a=None, b=None, c=None, angle=None, epsilon=None, data_type='FLOAT', mode='ELEMENT', operation='GREATER_THAN', label=None, node_color=None)

Node Compare

Parameters

  • a (DataSocket) – data_type dependant

  • b (DataSocket) – data_type dependant

  • c (DataSocket) – Float

  • angle (DataSocket) – Float

  • epsilon (DataSocket) – Float

  • data_type (str) – Node parameter, default = ‘FLOAT’ in (‘FLOAT’, ‘INT’, ‘VECTOR’, ‘STRING’, ‘RGBA’)

  • mode (str) – Node parameter, default = ‘ELEMENT’ in (‘ELEMENT’, ‘LENGTH’, ‘AVERAGE’, ‘DOT_PRODUCT’, ‘DIRECTION’)

  • operation (str) – Node parameter, default = ‘GREATER_THAN’ in (‘LESS_THAN’, ‘LESS_EQUAL’, ‘GREATER_THAN’, ‘GREATER_EQUAL’, ‘EQUAL’, ‘NOT_EQUAL’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • result : Boolean

Shared sockets:

  • Driving parameter : data_type in (‘FLOAT’, ‘INT’, ‘VECTOR’, ‘STRING’, ‘RGBA’)

  • Input sockets : [‘a’, ‘b’]

  • Output sockets : []

Blender reference : FunctionNodeCompare, Node ‘Compare’

class Cone(vertices=None, side_segments=None, fill_segments=None, radius_top=None, radius_bottom=None, depth=None, fill_type='NGON', label=None, node_color=None)

Node Cone

Parameters

  • vertices (DataSocket) – Integer

  • side_segments (DataSocket) – Integer

  • fill_segments (DataSocket) – Integer

  • radius_top (DataSocket) – Float

  • radius_bottom (DataSocket) – Float

  • depth (DataSocket) – Float

  • fill_type (str) – Node parameter, default = ‘NGON’ in (‘NONE’, ‘NGON’, ‘TRIANGLE_FAN’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

  • top : Boolean

  • bottom : Boolean

  • side : Boolean

Blender reference : GeometryNodeMeshCone, Node ‘Cone’

class ConvexHull(geometry=None, label=None, node_color=None)

Node Convex Hull

Parameters

  • geometry (DataSocket) – Geometry

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • convex_hull : Geometry

Blender reference : GeometryNodeConvexHull, Node ‘Convex Hull’

class Cube(size=None, vertices_x=None, vertices_y=None, vertices_z=None, label=None, node_color=None)

Node Cube

Parameters

  • size (DataSocket) – Vector

  • vertices_x (DataSocket) – Integer

  • vertices_y (DataSocket) – Integer

  • vertices_z (DataSocket) – Integer

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeMeshCube, Node ‘Cube’

class CurveCircle(resolution=None, point_1=None, point_2=None, point_3=None, radius=None, mode='RADIUS', label=None, node_color=None)

Node Curve Circle

Parameters

  • resolution (DataSocket) – Integer

  • point_1 (DataSocket) – Vector

  • point_2 (DataSocket) – Vector

  • point_3 (DataSocket) – Vector

  • radius (DataSocket) – Float

  • mode (str) – Node parameter, default = ‘RADIUS’ in (‘POINTS’, ‘RADIUS’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

  • center : Vector

Blender reference : GeometryNodeCurvePrimitiveCircle, Node ‘Curve Circle’

class CurveHandlePositions(relative=None, label=None, node_color=None)

Node Curve Handle Positions

Parameters

  • relative (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • left : Vector

  • right : Vector

Blender reference : GeometryNodeInputCurveHandlePositions, Node ‘Curve Handle Positions’

class CurveLength(curve=None, label=None, node_color=None)

Node Curve Length

Parameters

  • curve (DataSocket) – Curve

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • length : Float

Blender reference : GeometryNodeCurveLength, Node ‘Curve Length’

class CurveLine(start=None, end=None, direction=None, length=None, mode='POINTS', label=None, node_color=None)

Node Curve Line

Parameters

  • start (DataSocket) – Vector

  • end (DataSocket) – Vector

  • direction (DataSocket) – Vector

  • length (DataSocket) – Float

  • mode (str) – Node parameter, default = ‘POINTS’ in (‘POINTS’, ‘DIRECTION’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeCurvePrimitiveLine, Node ‘Curve Line’

class CurveTangent(label=None, node_color=None)

Node Curve Tangent

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • tangent : Vector

Blender reference : GeometryNodeInputTangent, Node ‘Curve Tangent’

class CurveTilt(label=None, node_color=None)

Node Curve Tilt

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • tilt : Float

Blender reference : GeometryNodeInputCurveTilt, Node ‘Curve Tilt’

class CurveToMesh(curve=None, profile_curve=None, fill_caps=None, label=None, node_color=None)

Node Curve to Mesh

Parameters

  • curve (DataSocket) – Curve

  • profile_curve (DataSocket) – Geometry

  • fill_caps (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeCurveToMesh, Node ‘Curve to Mesh’

class CurveToPoints(curve=None, count=None, length=None, mode='COUNT', label=None, node_color=None)

Node Curve to Points

Parameters

  • curve (DataSocket) – Curve

  • count (DataSocket) – Integer

  • length (DataSocket) – Float

  • mode (str) – Node parameter, default = ‘COUNT’ in (‘EVALUATED’, ‘COUNT’, ‘LENGTH’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • points : Points

  • tangent : Vector

  • normal : Vector

  • rotation : Vector

Blender reference : GeometryNodeCurveToPoints, Node ‘Curve to Points’

class Cylinder(vertices=None, side_segments=None, fill_segments=None, radius=None, depth=None, fill_type='NGON', label=None, node_color=None)

Node Cylinder

Parameters

  • vertices (DataSocket) – Integer

  • side_segments (DataSocket) – Integer

  • fill_segments (DataSocket) – Integer

  • radius (DataSocket) – Float

  • depth (DataSocket) – Float

  • fill_type (str) – Node parameter, default = ‘NGON’ in (‘NONE’, ‘NGON’, ‘TRIANGLE_FAN’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

  • top : Boolean

  • side : Boolean

  • bottom : Boolean

Blender reference : GeometryNodeMeshCylinder, Node ‘Cylinder’

class DeleteGeometry(geometry=None, selection=None, domain='POINT', mode='ALL', label=None, node_color=None)

Node Delete Geometry

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • domain (str) – Node parameter, default = ‘POINT’ in (‘POINT’, ‘EDGE’, ‘FACE’, ‘CURVE’, ‘INSTANCE’)

  • mode (str) – Node parameter, default = ‘ALL’ in (‘ALL’, ‘EDGE_FACE’, ‘ONLY_FACE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeDeleteGeometry, Node ‘Delete Geometry’

class DistributePointsOnFaces(mesh=None, selection=None, distance_min=None, density_max=None, density=None, density_factor=None, seed=None, distribute_method='RANDOM', label=None, node_color=None)

Node Distribute Points on Faces

Parameters

  • mesh (DataSocket) – Mesh

  • selection (DataSocket) – Boolean

  • distance_min (DataSocket) – Float

  • density_max (DataSocket) – Float

  • density (DataSocket) – Float

  • density_factor (DataSocket) – Float

  • seed (DataSocket) – Integer

  • distribute_method (str) – Node parameter, default = ‘RANDOM’ in (‘RANDOM’, ‘POISSON’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • points : Points

  • normal : Vector

  • rotation : Vector

Blender reference : GeometryNodeDistributePointsOnFaces, Node ‘Distribute Points on Faces’

class DomainSize(geometry=None, component='MESH', label=None, node_color=None)

Node Domain Size

Parameters

  • geometry (DataSocket) – Geometry

  • component (str) – Node parameter, default = ‘MESH’ in (‘MESH’, ‘POINTCLOUD’, ‘CURVE’, ‘INSTANCES’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • point_count : Integer

  • edge_count : Integer

  • face_count : Integer

  • face_corner_count : Integer

  • spline_count : Integer

  • instance_count : Integer

Blender reference : GeometryNodeAttributeDomainSize, Node ‘Domain Size’

class DualMesh(mesh=None, keep_boundaries=None, label=None, node_color=None)

Node Dual Mesh

Parameters

  • mesh (DataSocket) – Mesh

  • keep_boundaries (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • dual_mesh : Geometry

Blender reference : GeometryNodeDualMesh, Node ‘Dual Mesh’

class DuplicateElements(geometry=None, selection=None, amount=None, domain='POINT', label=None, node_color=None)

Node Duplicate Elements

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • amount (DataSocket) – Integer

  • domain (str) – Node parameter, default = ‘POINT’ in (‘POINT’, ‘EDGE’, ‘FACE’, ‘SPLINE’, ‘INSTANCE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

  • duplicate_index : Integer

Blender reference : GeometryNodeDuplicateElements, Node ‘Duplicate Elements’

class EdgeAngle(label=None, node_color=None)

Node Edge Angle

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • unsigned_angle : Float

  • signed_angle : Float

Blender reference : GeometryNodeInputMeshEdgeAngle, Node ‘Edge Angle’

class EdgeNeighbors(label=None, node_color=None)

Node Edge Neighbors

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • face_count : Integer

Blender reference : GeometryNodeInputMeshEdgeNeighbors, Node ‘Edge Neighbors’

class EdgeVertices(label=None, node_color=None)

Node Edge Vertices

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • vertex_index_1 : Integer

  • vertex_index_2 : Integer

  • position_1 : Vector

  • position_2 : Vector

Blender reference : GeometryNodeInputMeshEdgeVertices, Node ‘Edge Vertices’

class EndpointSelection(start_size=None, end_size=None, label=None, node_color=None)

Node Endpoint Selection

Parameters

  • start_size (DataSocket) – Integer

  • end_size (DataSocket) – Integer

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • selection : Boolean

Blender reference : GeometryNodeCurveEndpointSelection, Node ‘Endpoint Selection’

class ExtrudeMesh(mesh=None, selection=None, offset=None, offset_scale=None, individual=None, mode='FACES', label=None, node_color=None)

Node Extrude Mesh

Parameters

  • mesh (DataSocket) – Mesh

  • selection (DataSocket) – Boolean

  • offset (DataSocket) – Vector

  • offset_scale (DataSocket) – Float

  • individual (DataSocket) – Boolean

  • mode (str) – Node parameter, default = ‘FACES’ in (‘VERTICES’, ‘EDGES’, ‘FACES’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

  • top : Boolean

  • side : Boolean

Blender reference : GeometryNodeExtrudeMesh, Node ‘Extrude Mesh’

class FaceArea(label=None, node_color=None)

Node Face Area

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • area : Float

Blender reference : GeometryNodeInputMeshFaceArea, Node ‘Face Area’

class FaceIsPlanar(threshold=None, label=None, node_color=None)

Node Face is Planar

Parameters

  • threshold (DataSocket) – Float

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • planar : Boolean

Blender reference : GeometryNodeInputMeshFaceIsPlanar, Node ‘Face is Planar’

class FaceNeighbors(label=None, node_color=None)

Node Face Neighbors

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • vertex_count : Integer

  • face_count : Integer

Blender reference : GeometryNodeInputMeshFaceNeighbors, Node ‘Face Neighbors’

class FieldAtIndex(index=None, value=None, data_type='FLOAT', domain='POINT', label=None, node_color=None)

Node Field at Index

Parameters

  • index (DataSocket) – Integer

  • value (DataSocket) – data_type dependant

  • data_type (str) – Node parameter, default = ‘FLOAT’ in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘FLOAT_COLOR’, ‘BOOLEAN’)

  • domain (str) – Node parameter, default = ‘POINT’ in (‘POINT’, ‘EDGE’, ‘FACE’, ‘CORNER’, ‘CURVE’, ‘INSTANCE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • value : data_type dependant

Shared sockets:

  • Driving parameter : data_type in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘FLOAT_COLOR’, ‘BOOLEAN’)

  • Input sockets : [‘value’]

  • Output sockets : [‘value’]

Blender reference : GeometryNodeFieldAtIndex, Node ‘Field at Index’

class FillCurve(curve=None, mode='TRIANGLES', label=None, node_color=None)

Node Fill Curve

Parameters

  • curve (DataSocket) – Curve

  • mode (str) – Node parameter, default = ‘TRIANGLES’ in (‘TRIANGLES’, ‘NGONS’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeFillCurve, Node ‘Fill Curve’

class FilletCurve(curve=None, count=None, radius=None, limit_radius=None, mode='BEZIER', label=None, node_color=None)

Node Fillet Curve

Parameters

  • curve (DataSocket) – Curve

  • count (DataSocket) – Integer

  • radius (DataSocket) – Float

  • limit_radius (DataSocket) – Boolean

  • mode (str) – Node parameter, default = ‘BEZIER’ in (‘BEZIER’, ‘POLY’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeFilletCurve, Node ‘Fillet Curve’

class FlipFaces(mesh=None, selection=None, label=None, node_color=None)

Node Flip Faces

Parameters

  • mesh (DataSocket) – Mesh

  • selection (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeFlipFaces, Node ‘Flip Faces’

class FloatCurve(factor=None, value=None, label=None, node_color=None)

Node Float Curve

Parameters

  • factor (DataSocket) – Float

  • value (DataSocket) – Float

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • value : Float

Blender reference : ShaderNodeFloatCurve, Node ‘Float Curve’

class FloatToInteger(float=None, rounding_mode='ROUND', label=None, node_color=None)

Node Float to Integer

Parameters

  • float (DataSocket) – Float

  • rounding_mode (str) – Node parameter, default = ‘ROUND’ in (‘ROUND’, ‘FLOOR’, ‘CEILING’, ‘TRUNCATE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • integer : Integer

Blender reference : FunctionNodeFloatToInt, Node ‘Float to Integer’

class GeometryProximity(target=None, source_position=None, target_element='FACES', label=None, node_color=None)

Node Geometry Proximity

Parameters

  • target (DataSocket) – Geometry

  • source_position (DataSocket) – Vector

  • target_element (str) – Node parameter, default = ‘FACES’ in (‘POINTS’, ‘EDGES’, ‘FACES’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • position : Vector

  • distance : Float

Blender reference : GeometryNodeProximity, Node ‘Geometry Proximity’

class GeometryToInstance(*geometry, label=None, node_color=None)

Node Geometry to Instance

Parameters

  • geometry (DataSocket) – <m> Geometry

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • instances : Instances

Blender reference : GeometryNodeGeometryToInstance, Node ‘Geometry to Instance’

class GradientTexture(vector=None, gradient_type='LINEAR', label=None, node_color=None)

Node Gradient Texture

Parameters

  • vector (DataSocket) – Vector

  • gradient_type (str) – Node parameter, default = ‘LINEAR’ in (‘LINEAR’, ‘QUADRATIC’, ‘EASING’, ‘DIAGONAL’, ‘SPHERICAL’, ‘QUADRATIC_SPHERE’, ‘RADIAL’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • color : Color

  • fac : Float

Blender reference : ShaderNodeTexGradient, Node ‘Gradient Texture’

class Grid(size_x=None, size_y=None, vertices_x=None, vertices_y=None, label=None, node_color=None)

Node Grid

Parameters

  • size_x (DataSocket) – Float

  • size_y (DataSocket) – Float

  • vertices_x (DataSocket) – Integer

  • vertices_y (DataSocket) – Integer

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeMeshGrid, Node ‘Grid’

class Group(label=None, node_color=None)

Node Group

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Blender reference : GeometryNodeGroup, Node ‘Group’

class HandleTypeSelection(handle_type='AUTO', mode={'LEFT', 'RIGHT'}, label=None, node_color=None)

Node Handle Type Selection

Parameters

  • handle_type (str) – Node parameter, default = ‘AUTO’ in (‘FREE’, ‘AUTO’, ‘VECTOR’, ‘ALIGN’)

  • mode (set) – Node parameter, default = {‘RIGHT’, ‘LEFT’}

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • selection : Boolean

Blender reference : GeometryNodeCurveHandleTypeSelection, Node ‘Handle Type Selection’

class ID(label=None, node_color=None)

Node ID

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • ID : Integer

Blender reference : GeometryNodeInputID, Node ‘ID’

class IcoSphere(radius=None, subdivisions=None, label=None, node_color=None)

Node Ico Sphere

Parameters

  • radius (DataSocket) – Float

  • subdivisions (DataSocket) – Integer

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeMeshIcoSphere, Node ‘Ico Sphere’

class ImageTexture(image=None, vector=None, frame=None, extension='REPEAT', interpolation='Linear', label=None, node_color=None)

Node Image Texture

Parameters

  • image (DataSocket) – Image

  • vector (DataSocket) – Vector

  • frame (DataSocket) – Integer

  • extension (str) – Node parameter, default = ‘REPEAT’ in (‘REPEAT’, ‘EXTEND’, ‘CLIP’)

  • interpolation (str) – Node parameter, default = ‘Linear’ in (‘Linear’, ‘Closest’, ‘Cubic’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • color : Color

  • alpha : Float

Blender reference : GeometryNodeImageTexture, Node ‘Image Texture’

class Index(label=None, node_color=None)

Node Index

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • index : Integer

Blender reference : GeometryNodeInputIndex, Node ‘Index’

class InstanceOnPoints(points=None, selection=None, instance=None, pick_instance=None, instance_index=None, rotation=None, scale=None, label=None, node_color=None)

Node Instance on Points

Parameters

  • points (DataSocket) – Points

  • selection (DataSocket) – Boolean

  • instance (DataSocket) – Geometry

  • pick_instance (DataSocket) – Boolean

  • instance_index (DataSocket) – Integer

  • rotation (DataSocket) – Vector

  • scale (DataSocket) – Vector

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • instances : Instances

Blender reference : GeometryNodeInstanceOnPoints, Node ‘Instance on Points’

class InstancesToPoints(instances=None, selection=None, position=None, radius=None, label=None, node_color=None)

Node Instances to Points

Parameters

  • instances (DataSocket) – Instances

  • selection (DataSocket) – Boolean

  • position (DataSocket) – Vector

  • radius (DataSocket) – Float

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • points : Points

Blender reference : GeometryNodeInstancesToPoints, Node ‘Instances to Points’

class Integer(integer=0, label=None, node_color=None)

Node Integer

Parameters

  • integer (int) – Node parameter, default = 0

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • integer : Integer

Blender reference : FunctionNodeInputInt, Node ‘Integer’

class IsShadeSmooth(label=None, node_color=None)

Node Is Shade Smooth

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • smooth : Boolean

Blender reference : GeometryNodeInputShadeSmooth, Node ‘Is Shade Smooth’

class IsSplineCyclic(label=None, node_color=None)

Node Is Spline Cyclic

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • cyclic : Boolean

Blender reference : GeometryNodeInputSplineCyclic, Node ‘Is Spline Cyclic’

class IsViewport(label=None, node_color=None)

Node Is Viewport

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • is_viewport : Boolean

Blender reference : GeometryNodeIsViewport, Node ‘Is Viewport’

class JoinGeometry(*geometry, label=None, node_color=None)

Node Join Geometry

Parameters

  • geometry (DataSocket) – <m> Geometry

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeJoinGeometry, Node ‘Join Geometry’

class JoinStrings(*strings, delimiter=None, label=None, node_color=None)

Node Join Strings

Parameters

  • delimiter (DataSocket) – String

  • strings (DataSocket) – <m> String

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • string : String

Blender reference : GeometryNodeStringJoin, Node ‘Join Strings’

class MagicTexture(vector=None, scale=None, distortion=None, turbulence_depth=2, label=None, node_color=None)

Node Magic Texture

Parameters

  • vector (DataSocket) – Vector

  • scale (DataSocket) – Float

  • distortion (DataSocket) – Float

  • turbulence_depth (int) – Node parameter, default = 2

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • color : Color

  • fac : Float

Blender reference : ShaderNodeTexMagic, Node ‘Magic Texture’

class MapRange(value=None, from_min=None, from_max=None, to_min=None, to_max=None, steps=None, vector=None, clamp=True, data_type='FLOAT', interpolation_type='LINEAR', label=None, node_color=None)

Node Map Range

Parameters

  • value (DataSocket) – Float

  • from_min (DataSocket) – data_type dependant

  • from_max (DataSocket) – data_type dependant

  • to_min (DataSocket) – data_type dependant

  • to_max (DataSocket) – data_type dependant

  • steps (DataSocket) – data_type dependant

  • vector (DataSocket) – Vector

  • clamp (bool) – Node parameter, default = True

  • data_type (str) – Node parameter, default = ‘FLOAT’ in (‘FLOAT’, ‘FLOAT_VECTOR’)

  • interpolation_type (str) – Node parameter, default = ‘LINEAR’ in (‘LINEAR’, ‘STEPPED’, ‘SMOOTHSTEP’, ‘SMOOTHERSTEP’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • result : Float

  • vector : Vector

Shared sockets:

  • Driving parameter : data_type in (‘FLOAT’, ‘FLOAT_VECTOR’)

  • Input sockets : [‘from_min’, ‘from_max’, ‘to_min’, ‘to_max’, ‘steps’]

  • Output sockets : []

Blender reference : ShaderNodeMapRange, Node ‘Map Range’

class Material(label=None, node_color=None)

Node Material

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • material : Material

Blender reference : GeometryNodeInputMaterial, Node ‘Material’

class MaterialIndex(label=None, node_color=None)

Node Material Index

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • material_index : Integer

Blender reference : GeometryNodeInputMaterialIndex, Node ‘Material Index’

class MaterialSelection(material=None, label=None, node_color=None)

Node Material Selection

Parameters

  • material (DataSocket) – Material

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • selection : Boolean

Blender reference : GeometryNodeMaterialSelection, Node ‘Material Selection’

class Math(value0=None, value1=None, value2=None, operation='ADD', label=None, node_color=None)

Node Math

Parameters

  • value0 (DataSocket) – Float

  • value1 (DataSocket) – Float

  • value2 (DataSocket) – Float

  • operation (str) – Node parameter, default = ‘ADD’ in (‘ADD’, ‘SUBTRACT’, ‘MULTIPLY’, ‘DIVIDE’, ‘MULTIPLY_ADD’, ‘POWER’, ‘LOGARITHM’, ‘SQRT’, ‘INVERSE_SQRT’, ‘ABSOLUTE’, ‘EXPONENT’, ‘MINIMUM’, ‘MAXIMUM’, ‘LESS_THAN’, ‘GREATER_THAN’, ‘SIGN’, ‘COMPARE’, ‘SMOOTH_MIN’, ‘SMOOTH_MAX’, ‘ROUND’, ‘FLOOR’, ‘CEIL’, ‘TRUNC’, ‘FRACT’, ‘MODULO’, ‘WRAP’, ‘SNAP’, ‘PINGPONG’, ‘SINE’, ‘COSINE’, ‘TANGENT’, ‘ARCSINE’, ‘ARCCOSINE’, ‘ARCTANGENT’, ‘ARCTAN2’, ‘SINH’, ‘COSH’, ‘TANH’, ‘RADIANS’, ‘DEGREES’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • value : Float

Blender reference : ShaderNodeMath, Node ‘Math’

class MergeByDistance(geometry=None, selection=None, distance=None, mode='ALL', label=None, node_color=None)

Node Merge by Distance

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • distance (DataSocket) – Float

  • mode (str) – Node parameter, default = ‘ALL’ in (‘ALL’, ‘CONNECTED’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeMergeByDistance, Node ‘Merge by Distance’

class MeshBoolean(*mesh_2, mesh_1=None, self_intersection=None, hole_tolerant=None, operation='DIFFERENCE', label=None, node_color=None)

Node Mesh Boolean

Parameters

  • mesh_1 (DataSocket) – Geometry

  • mesh_2 (DataSocket) – <m> Geometry

  • self_intersection (DataSocket) – Boolean

  • hole_tolerant (DataSocket) – Boolean

  • operation (str) – Node parameter, default = ‘DIFFERENCE’ in (‘INTERSECT’, ‘UNION’, ‘DIFFERENCE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeMeshBoolean, Node ‘Mesh Boolean’

class MeshCircle(vertices=None, radius=None, fill_type='NONE', label=None, node_color=None)

Node Mesh Circle

Parameters

  • vertices (DataSocket) – Integer

  • radius (DataSocket) – Float

  • fill_type (str) – Node parameter, default = ‘NONE’ in (‘NONE’, ‘NGON’, ‘TRIANGLE_FAN’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeMeshCircle, Node ‘Mesh Circle’

class MeshIsland(label=None, node_color=None)

Node Mesh Island

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • island_index : Integer

  • island_count : Integer

Blender reference : GeometryNodeInputMeshIsland, Node ‘Mesh Island’

class MeshLine(count=None, resolution=None, start_location=None, offset=None, count_mode='TOTAL', mode='OFFSET', label=None, node_color=None)

Node Mesh Line

Parameters

  • count (DataSocket) – Integer

  • resolution (DataSocket) – Float

  • start_location (DataSocket) – Vector

  • offset (DataSocket) – Vector

  • count_mode (str) – Node parameter, default = ‘TOTAL’ in (‘TOTAL’, ‘RESOLUTION’)

  • mode (str) – Node parameter, default = ‘OFFSET’ in (‘OFFSET’, ‘END_POINTS’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeMeshLine, Node ‘Mesh Line’

class MeshToCurve(mesh=None, selection=None, label=None, node_color=None)

Node Mesh to Curve

Parameters

  • mesh (DataSocket) – Mesh

  • selection (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeMeshToCurve, Node ‘Mesh to Curve’

class MeshToPoints(mesh=None, selection=None, position=None, radius=None, mode='VERTICES', label=None, node_color=None)

Node Mesh to Points

Parameters

  • mesh (DataSocket) – Mesh

  • selection (DataSocket) – Boolean

  • position (DataSocket) – Vector

  • radius (DataSocket) – Float

  • mode (str) – Node parameter, default = ‘VERTICES’ in (‘VERTICES’, ‘EDGES’, ‘FACES’, ‘CORNERS’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • points : Points

Blender reference : GeometryNodeMeshToPoints, Node ‘Mesh to Points’

class Mix(color1=None, color2=None, fac=None, blend_type='MIX', use_alpha=False, label=None, node_color=None)

Node Mix

Parameters

  • fac (DataSocket) – Float

  • color1 (DataSocket) – Color

  • color2 (DataSocket) – Color

  • blend_type (str) – Node parameter, default = ‘MIX’ in (‘MIX’, ‘DARKEN’, ‘MULTIPLY’, ‘BURN’, ‘LIGHTEN’, ‘SCREEN’, ‘DODGE’, ‘ADD’, ‘OVERLAY’, ‘SOFT_LIGHT’, ‘LINEAR_LIGHT’, ‘DIFFERENCE’, ‘SUBTRACT’, ‘DIVIDE’, ‘HUE’, ‘SATURATION’, ‘COLOR’, ‘VALUE’)

  • use_alpha (bool) – Node parameter, default = False

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • color : Color

Blender reference : ShaderNodeMixRGB, Node ‘Mix’

class MusgraveTexture(vector=None, w=None, scale=None, detail=None, dimension=None, lacunarity=None, offset=None, gain=None, musgrave_dimensions='3D', musgrave_type='FBM', label=None, node_color=None)

Node Musgrave Texture

Parameters

  • vector (DataSocket) – Vector

  • w (DataSocket) – Float

  • scale (DataSocket) – Float

  • detail (DataSocket) – Float

  • dimension (DataSocket) – Float

  • lacunarity (DataSocket) – Float

  • offset (DataSocket) – Float

  • gain (DataSocket) – Float

  • musgrave_dimensions (str) – Node parameter, default = ‘3D’ in (‘1D’, ‘2D’, ‘3D’, ‘4D’)

  • musgrave_type (str) – Node parameter, default = ‘FBM’ in (‘MULTIFRACTAL’, ‘RIDGED_MULTIFRACTAL’, ‘HYBRID_MULTIFRACTAL’, ‘FBM’, ‘HETERO_TERRAIN’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • fac : Float

Blender reference : ShaderNodeTexMusgrave, Node ‘Musgrave Texture’

class NamedAttribute(name=None, data_type='FLOAT', label=None, node_color=None)

Node Named Attribute

Parameters

  • name (DataSocket) – String

  • data_type (str) – Node parameter, default = ‘FLOAT’ in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘FLOAT_COLOR’, ‘BOOLEAN’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • attribute : data_type dependant

Shared sockets:

  • Driving parameter : data_type in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘FLOAT_COLOR’, ‘BOOLEAN’)

  • Input sockets : []

  • Output sockets : [‘attribute’]

Blender reference : GeometryNodeInputNamedAttribute, Node ‘Named Attribute’

class NoiseTexture(vector=None, w=None, scale=None, detail=None, roughness=None, distortion=None, noise_dimensions='3D', label=None, node_color=None)

Node Noise Texture

Parameters

  • vector (DataSocket) – Vector

  • w (DataSocket) – Float

  • scale (DataSocket) – Float

  • detail (DataSocket) – Float

  • roughness (DataSocket) – Float

  • distortion (DataSocket) – Float

  • noise_dimensions (str) – Node parameter, default = ‘3D’ in (‘1D’, ‘2D’, ‘3D’, ‘4D’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • fac : Float

  • color : Color

Blender reference : ShaderNodeTexNoise, Node ‘Noise Texture’

class Normal(label=None, node_color=None)

Node Normal

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • normal : Vector

Blender reference : GeometryNodeInputNormal, Node ‘Normal’

class ObjectInfo(object=None, as_instance=None, transform_space='ORIGINAL', label=None, node_color=None)

Node Object Info

Parameters

  • object (DataSocket) – Object

  • as_instance (DataSocket) – Boolean

  • transform_space (str) – Node parameter, default = ‘ORIGINAL’ in (‘ORIGINAL’, ‘RELATIVE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • location : Vector

  • rotation : Vector

  • scale : Vector

  • geometry : Geometry

Blender reference : GeometryNodeObjectInfo, Node ‘Object Info’

class PointsToVertices(points=None, selection=None, label=None, node_color=None)

Node Points to Vertices

Parameters

  • points (DataSocket) – Points

  • selection (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodePointsToVertices, Node ‘Points to Vertices’

class PointsToVolume(points=None, density=None, voxel_size=None, voxel_amount=None, radius=None, resolution_mode='VOXEL_AMOUNT', label=None, node_color=None)

Node Points to Volume

Parameters

  • points (DataSocket) – Points

  • density (DataSocket) – Float

  • voxel_size (DataSocket) – Float

  • voxel_amount (DataSocket) – Float

  • radius (DataSocket) – Float

  • resolution_mode (str) – Node parameter, default = ‘VOXEL_AMOUNT’ in (‘VOXEL_AMOUNT’, ‘VOXEL_SIZE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • volume : Volume

Blender reference : GeometryNodePointsToVolume, Node ‘Points to Volume’

class Position(label=None, node_color=None)

Node Position

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • position : Vector

Blender reference : GeometryNodeInputPosition, Node ‘Position’

class QuadraticBezier(resolution=None, start=None, middle=None, end=None, label=None, node_color=None)

Node Quadratic Bezier

Parameters

  • resolution (DataSocket) – Integer

  • start (DataSocket) – Vector

  • middle (DataSocket) – Vector

  • end (DataSocket) – Vector

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeCurveQuadraticBezier, Node ‘Quadratic Bezier’

class Quadrilateral(width=None, height=None, bottom_width=None, top_width=None, offset=None, bottom_height=None, top_height=None, point_1=None, point_2=None, point_3=None, point_4=None, mode='RECTANGLE', label=None, node_color=None)

Node Quadrilateral

Parameters

  • width (DataSocket) – Float

  • height (DataSocket) – Float

  • bottom_width (DataSocket) – Float

  • top_width (DataSocket) – Float

  • offset (DataSocket) – Float

  • bottom_height (DataSocket) – Float

  • top_height (DataSocket) – Float

  • point_1 (DataSocket) – Vector

  • point_2 (DataSocket) – Vector

  • point_3 (DataSocket) – Vector

  • point_4 (DataSocket) – Vector

  • mode (str) – Node parameter, default = ‘RECTANGLE’ in (‘RECTANGLE’, ‘PARALLELOGRAM’, ‘TRAPEZOID’, ‘KITE’, ‘POINTS’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeCurvePrimitiveQuadrilateral, Node ‘Quadrilateral’

class Radius(label=None, node_color=None)

Node Radius

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • radius : Float

Blender reference : GeometryNodeInputRadius, Node ‘Radius’

class RandomValue(min=None, max=None, probability=None, ID=None, seed=None, data_type='FLOAT', label=None, node_color=None)

Node Random Value

Parameters

  • min (DataSocket) – data_type dependant

  • max (DataSocket) – data_type dependant

  • probability (DataSocket) – Float

  • ID (DataSocket) – Integer

  • seed (DataSocket) – Integer

  • data_type (str) – Node parameter, default = ‘FLOAT’ in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘BOOLEAN’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • value : data_type dependant

Shared sockets:

  • Driving parameter : data_type in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘BOOLEAN’)

  • Input sockets : [‘min’, ‘max’]

  • Output sockets : [‘value’]

Blender reference : FunctionNodeRandomValue, Node ‘Random Value’

class Raycast(target_geometry=None, attribute=None, source_position=None, ray_direction=None, ray_length=None, data_type='FLOAT', mapping='INTERPOLATED', label=None, node_color=None)

Node Raycast

Parameters

  • target_geometry (DataSocket) – Geometry

  • attribute (DataSocket) – data_type dependant

  • source_position (DataSocket) – Vector

  • ray_direction (DataSocket) – Vector

  • ray_length (DataSocket) – Float

  • data_type (str) – Node parameter, default = ‘FLOAT’ in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘FLOAT_COLOR’, ‘BOOLEAN’)

  • mapping (str) – Node parameter, default = ‘INTERPOLATED’ in (‘INTERPOLATED’, ‘NEAREST’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • is_hit : Boolean

  • hit_position : Vector

  • hit_normal : Vector

  • hit_distance : Float

  • attribute : data_type dependant

Shared sockets:

  • Driving parameter : data_type in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘FLOAT_COLOR’, ‘BOOLEAN’)

  • Input sockets : [‘attribute’]

  • Output sockets : [‘attribute’]

Blender reference : GeometryNodeRaycast, Node ‘Raycast’

class RealizeInstances(geometry=None, legacy_behavior=False, label=None, node_color=None)

Node Realize Instances

Parameters

  • geometry (DataSocket) – Geometry

  • legacy_behavior (bool) – Node parameter, default = False

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeRealizeInstances, Node ‘Realize Instances’

class RemoveNamedAttribute(geometry=None, name=None, label=None, node_color=None)

Node Remove Named Attribute

Parameters

  • geometry (DataSocket) – Geometry

  • name (DataSocket) – String

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeRemoveAttribute, Node ‘Remove Named Attribute’

class ReplaceMaterial(geometry=None, old=None, new=None, label=None, node_color=None)

Node Replace Material

Parameters

  • geometry (DataSocket) – Geometry

  • old (DataSocket) – Material

  • new (DataSocket) – Material

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeReplaceMaterial, Node ‘Replace Material’

class ReplaceString(string=None, find=None, replace=None, label=None, node_color=None)

Node Replace String

Parameters

  • string (DataSocket) – String

  • find (DataSocket) – String

  • replace (DataSocket) – String

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • string : String

Blender reference : FunctionNodeReplaceString, Node ‘Replace String’

class ResampleCurve(curve=None, selection=None, count=None, length=None, mode='COUNT', label=None, node_color=None)

Node Resample Curve

Parameters

  • curve (DataSocket) – Curve

  • selection (DataSocket) – Boolean

  • count (DataSocket) – Integer

  • length (DataSocket) – Float

  • mode (str) – Node parameter, default = ‘COUNT’ in (‘EVALUATED’, ‘COUNT’, ‘LENGTH’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeResampleCurve, Node ‘Resample Curve’

class ReverseCurve(curve=None, selection=None, label=None, node_color=None)

Node Reverse Curve

Parameters

  • curve (DataSocket) – Curve

  • selection (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeReverseCurve, Node ‘Reverse Curve’

class RgbCurves(fac=None, color=None, label=None, node_color=None)

Node RGB Curves

Parameters

  • fac (DataSocket) – Float

  • color (DataSocket) – Color

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • color : Color

Blender reference : ShaderNodeRGBCurve, Node ‘RGB Curves’

class RotateEuler(rotation=None, rotate_by=None, axis=None, angle=None, space='OBJECT', type='EULER', label=None, node_color=None)

Node Rotate Euler

Parameters

  • rotation (DataSocket) – Vector

  • rotate_by (DataSocket) – Vector

  • axis (DataSocket) – Vector

  • angle (DataSocket) – Float

  • space (str) – Node parameter, default = ‘OBJECT’ in (‘OBJECT’, ‘LOCAL’)

  • type (str) – Node parameter, default = ‘EULER’ in (‘AXIS_ANGLE’, ‘EULER’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • rotation : Vector

Blender reference : FunctionNodeRotateEuler, Node ‘Rotate Euler’

class RotateInstances(instances=None, selection=None, rotation=None, pivot_point=None, local_space=None, label=None, node_color=None)

Node Rotate Instances

Parameters

  • instances (DataSocket) – Instances

  • selection (DataSocket) – Boolean

  • rotation (DataSocket) – Vector

  • pivot_point (DataSocket) – Vector

  • local_space (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • instances : Instances

Blender reference : GeometryNodeRotateInstances, Node ‘Rotate Instances’

class SampleCurve(curve=None, factor=None, length=None, mode='LENGTH', label=None, node_color=None)

Node Sample Curve

Parameters

  • curve (DataSocket) – Curve

  • factor (DataSocket) – Float

  • length (DataSocket) – Float

  • mode (str) – Node parameter, default = ‘LENGTH’ in (‘FACTOR’, ‘LENGTH’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • position : Vector

  • tangent : Vector

  • normal : Vector

Blender reference : GeometryNodeSampleCurve, Node ‘Sample Curve’

class ScaleElements(geometry=None, selection=None, scale=None, center=None, axis=None, domain='FACE', scale_mode='UNIFORM', label=None, node_color=None)

Node Scale Elements

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • scale (DataSocket) – Float

  • center (DataSocket) – Vector

  • axis (DataSocket) – Vector

  • domain (str) – Node parameter, default = ‘FACE’ in (‘FACE’, ‘EDGE’)

  • scale_mode (str) – Node parameter, default = ‘UNIFORM’ in (‘UNIFORM’, ‘SINGLE_AXIS’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeScaleElements, Node ‘Scale Elements’

class ScaleInstances(instances=None, selection=None, scale=None, center=None, local_space=None, label=None, node_color=None)

Node Scale Instances

Parameters

  • instances (DataSocket) – Instances

  • selection (DataSocket) – Boolean

  • scale (DataSocket) – Vector

  • center (DataSocket) – Vector

  • local_space (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • instances : Instances

Blender reference : GeometryNodeScaleInstances, Node ‘Scale Instances’

class SceneTime(label=None, node_color=None)

Node Scene Time

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • seconds : Float

  • frame : Float

Blender reference : GeometryNodeInputSceneTime, Node ‘Scene Time’

class SeparateComponents(geometry=None, label=None, node_color=None)

Node Separate Components

Parameters

  • geometry (DataSocket) – Geometry

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

  • point_cloud : Geometry

  • curve : Curve

  • volume : Volume

  • instances : Instances

Blender reference : GeometryNodeSeparateComponents, Node ‘Separate Components’

class SeparateGeometry(geometry=None, selection=None, domain='POINT', label=None, node_color=None)

Node Separate Geometry

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • domain (str) – Node parameter, default = ‘POINT’ in (‘POINT’, ‘EDGE’, ‘FACE’, ‘CURVE’, ‘INSTANCE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • selection : Geometry

  • inverted : Geometry

Blender reference : GeometryNodeSeparateGeometry, Node ‘Separate Geometry’

class SeparateRgb(image=None, label=None, node_color=None)

Node Separate RGB

Parameters

  • image (DataSocket) – Color

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • r : Float

  • g : Float

  • b : Float

Blender reference : ShaderNodeSeparateRGB, Node ‘Separate RGB’

class SeparateXyz(vector=None, label=None, node_color=None)

Node Separate XYZ

Parameters

  • vector (DataSocket) – Vector

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • x : Float

  • y : Float

  • z : Float

Blender reference : ShaderNodeSeparateXYZ, Node ‘Separate XYZ’

class SetCurveRadius(curve=None, selection=None, radius=None, label=None, node_color=None)

Node Set Curve Radius

Parameters

  • curve (DataSocket) – Curve

  • selection (DataSocket) – Boolean

  • radius (DataSocket) – Float

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeSetCurveRadius, Node ‘Set Curve Radius’

class SetCurveTilt(curve=None, selection=None, tilt=None, label=None, node_color=None)

Node Set Curve Tilt

Parameters

  • curve (DataSocket) – Curve

  • selection (DataSocket) – Boolean

  • tilt (DataSocket) – Float

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeSetCurveTilt, Node ‘Set Curve Tilt’

class SetHandlePositions(curve=None, selection=None, position=None, offset=None, mode='LEFT', label=None, node_color=None)

Node Set Handle Positions

Parameters

  • curve (DataSocket) – Curve

  • selection (DataSocket) – Boolean

  • position (DataSocket) – Vector

  • offset (DataSocket) – Vector

  • mode (str) – Node parameter, default = ‘LEFT’ in (‘LEFT’, ‘RIGHT’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeSetCurveHandlePositions, Node ‘Set Handle Positions’

class SetHandleType(curve=None, selection=None, handle_type='AUTO', mode={'LEFT', 'RIGHT'}, label=None, node_color=None)

Node Set Handle Type

Parameters

  • curve (DataSocket) – Curve

  • selection (DataSocket) – Boolean

  • handle_type (str) – Node parameter, default = ‘AUTO’ in (‘FREE’, ‘AUTO’, ‘VECTOR’, ‘ALIGN’)

  • mode (set) – Node parameter, default = {‘RIGHT’, ‘LEFT’}

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeCurveSetHandles, Node ‘Set Handle Type’

class SetID(geometry=None, selection=None, ID=None, label=None, node_color=None)

Node Set ID

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • ID (DataSocket) – Integer

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeSetID, Node ‘Set ID’

class SetMaterial(geometry=None, selection=None, material=None, label=None, node_color=None)

Node Set Material

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • material (DataSocket) – Material

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeSetMaterial, Node ‘Set Material’

class SetMaterialIndex(geometry=None, selection=None, material_index=None, label=None, node_color=None)

Node Set Material Index

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • material_index (DataSocket) – Integer

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeSetMaterialIndex, Node ‘Set Material Index’

class SetPointRadius(points=None, selection=None, radius=None, label=None, node_color=None)

Node Set Point Radius

Parameters

  • points (DataSocket) – Points

  • selection (DataSocket) – Boolean

  • radius (DataSocket) – Float

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • points : Points

Blender reference : GeometryNodeSetPointRadius, Node ‘Set Point Radius’

class SetPosition(geometry=None, selection=None, position=None, offset=None, label=None, node_color=None)

Node Set Position

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • position (DataSocket) – Vector

  • offset (DataSocket) – Vector

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeSetPosition, Node ‘Set Position’

class SetShadeSmooth(geometry=None, selection=None, shade_smooth=None, label=None, node_color=None)

Node Set Shade Smooth

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • shade_smooth (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeSetShadeSmooth, Node ‘Set Shade Smooth’

class SetSplineCyclic(geometry=None, selection=None, cyclic=None, label=None, node_color=None)

Node Set Spline Cyclic

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • cyclic (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeSetSplineCyclic, Node ‘Set Spline Cyclic’

class SetSplineResolution(geometry=None, selection=None, resolution=None, label=None, node_color=None)

Node Set Spline Resolution

Parameters

  • geometry (DataSocket) – Geometry

  • selection (DataSocket) – Boolean

  • resolution (DataSocket) – Integer

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeSetSplineResolution, Node ‘Set Spline Resolution’

class SetSplineType(curve=None, selection=None, spline_type='POLY', label=None, node_color=None)

Node Set Spline Type

Parameters

  • curve (DataSocket) – Curve

  • selection (DataSocket) – Boolean

  • spline_type (str) – Node parameter, default = ‘POLY’ in (‘BEZIER’, ‘NURBS’, ‘POLY’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeCurveSplineType, Node ‘Set Spline Type’

class SliceString(string=None, position=None, length=None, label=None, node_color=None)

Node Slice String

Parameters

  • string (DataSocket) – String

  • position (DataSocket) – Integer

  • length (DataSocket) – Integer

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • string : String

Blender reference : FunctionNodeSliceString, Node ‘Slice String’

class SpecialCharacters(label=None, node_color=None)

Node Special Characters

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • line_break : String

  • tab : String

Blender reference : FunctionNodeInputSpecialCharacters, Node ‘Special Characters’

class Spiral(resolution=None, rotations=None, start_radius=None, end_radius=None, height=None, reverse=None, label=None, node_color=None)

Node Spiral

Parameters

  • resolution (DataSocket) – Integer

  • rotations (DataSocket) – Float

  • start_radius (DataSocket) – Float

  • end_radius (DataSocket) – Float

  • height (DataSocket) – Float

  • reverse (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeCurveSpiral, Node ‘Spiral’

class SplineLength(label=None, node_color=None)

Node Spline Length

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • length : Float

  • point_count : Integer

Blender reference : GeometryNodeSplineLength, Node ‘Spline Length’

class SplineParameter(label=None, node_color=None)

Node Spline Parameter

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • factor : Float

  • length : Float

  • index : Integer

Blender reference : GeometryNodeSplineParameter, Node ‘Spline Parameter’

class SplineResolution(label=None, node_color=None)

Node Spline Resolution

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • resolution : Integer

Blender reference : GeometryNodeInputSplineResolution, Node ‘Spline Resolution’

class SplitEdges(mesh=None, selection=None, label=None, node_color=None)

Node Split Edges

Parameters

  • mesh (DataSocket) – Mesh

  • selection (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeSplitEdges, Node ‘Split Edges’

class Star(points=None, inner_radius=None, outer_radius=None, twist=None, label=None, node_color=None)

Node Star

Parameters

  • points (DataSocket) – Integer

  • inner_radius (DataSocket) – Float

  • outer_radius (DataSocket) – Float

  • twist (DataSocket) – Float

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

  • outer_points : Boolean

Blender reference : GeometryNodeCurveStar, Node ‘Star’

class StoreNamedAttribute(geometry=None, name=None, value=None, data_type='FLOAT', domain='POINT', label=None, node_color=None)

Node Store Named Attribute

Parameters

  • geometry (DataSocket) – Geometry

  • name (DataSocket) – String

  • value (DataSocket) – data_type dependant

  • data_type (str) – Node parameter, default = ‘FLOAT’ in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘FLOAT_COLOR’, ‘BYTE_COLOR’, ‘BOOLEAN’)

  • domain (str) – Node parameter, default = ‘POINT’ in (‘POINT’, ‘EDGE’, ‘FACE’, ‘CORNER’, ‘CURVE’, ‘INSTANCE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Shared sockets:

  • Driving parameter : data_type in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘FLOAT_COLOR’, ‘BYTE_COLOR’, ‘BOOLEAN’)

  • Input sockets : [‘value’]

  • Output sockets : []

Blender reference : GeometryNodeStoreNamedAttribute, Node ‘Store Named Attribute’

class String(string='', label=None, node_color=None)

Node String

Parameters

  • string (str) – Node parameter, default = ‘’

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • string : String

Blender reference : FunctionNodeInputString, Node ‘String’

class StringLength(string=None, label=None, node_color=None)

Node String Length

Parameters

  • string (DataSocket) – String

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • length : Integer

Blender reference : FunctionNodeStringLength, Node ‘String Length’

class StringToCurves(string=None, size=None, character_spacing=None, word_spacing=None, line_spacing=None, text_box_width=None, text_box_height=None, align_x='LEFT', align_y='TOP_BASELINE', overflow='OVERFLOW', pivot_mode='BOTTOM_LEFT', label=None, node_color=None)

Node String to Curves

Parameters

  • string (DataSocket) – String

  • size (DataSocket) – Float

  • character_spacing (DataSocket) – Float

  • word_spacing (DataSocket) – Float

  • line_spacing (DataSocket) – Float

  • text_box_width (DataSocket) – Float

  • text_box_height (DataSocket) – Float

  • align_x (str) – Node parameter, default = ‘LEFT’ in (‘LEFT’, ‘CENTER’, ‘RIGHT’, ‘JUSTIFY’, ‘FLUSH’)

  • align_y (str) – Node parameter, default = ‘TOP_BASELINE’ in (‘TOP_BASELINE’, ‘TOP’, ‘MIDDLE’, ‘BOTTOM_BASELINE’, ‘BOTTOM’)

  • overflow (str) – Node parameter, default = ‘OVERFLOW’ in (‘OVERFLOW’, ‘SCALE_TO_FIT’, ‘TRUNCATE’)

  • pivot_mode (str) – Node parameter, default = ‘BOTTOM_LEFT’ in (‘MIDPOINT’, ‘TOP_LEFT’, ‘TOP_CENTER’, ‘TOP_RIGHT’, ‘BOTTOM_LEFT’, ‘BOTTOM_CENTER’, ‘BOTTOM_RIGHT’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve_instances : Geometry

  • remainder : String

  • line : Integer

  • pivot_point : Vector

Blender reference : GeometryNodeStringToCurves, Node ‘String to Curves’

class SubdivideCurve(curve=None, cuts=None, label=None, node_color=None)

Node Subdivide Curve

Parameters

  • curve (DataSocket) – Curve

  • cuts (DataSocket) – Integer

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeSubdivideCurve, Node ‘Subdivide Curve’

class SubdivideMesh(mesh=None, level=None, label=None, node_color=None)

Node Subdivide Mesh

Parameters

  • mesh (DataSocket) – Mesh

  • level (DataSocket) – Integer

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeSubdivideMesh, Node ‘Subdivide Mesh’

class SubdivisionSurface(mesh=None, level=None, crease=None, boundary_smooth='ALL', uv_smooth='PRESERVE_BOUNDARIES', label=None, node_color=None)

Node Subdivision Surface

Parameters

  • mesh (DataSocket) – Mesh

  • level (DataSocket) – Integer

  • crease (DataSocket) – Float

  • boundary_smooth (str) – Node parameter, default = ‘ALL’ in (‘PRESERVE_CORNERS’, ‘ALL’)

  • uv_smooth (str) – Node parameter, default = ‘PRESERVE_BOUNDARIES’ in (‘NONE’, ‘PRESERVE_CORNERS’, ‘PRESERVE_CORNERS_AND_JUNCTIONS’, ‘PRESERVE_CORNERS_JUNCTIONS_AND_CONCAVE’, ‘PRESERVE_BOUNDARIES’, ‘SMOOTH_ALL’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeSubdivisionSurface, Node ‘Subdivision Surface’

class Switch(switch=None, false=None, true=None, input_type='GEOMETRY', label=None, node_color=None)

Node Switch

Parameters

  • switch (DataSocket) – input_type dependant

  • false (DataSocket) – input_type dependant

  • true (DataSocket) – input_type dependant

  • input_type (str) – Node parameter, default = ‘GEOMETRY’ in (‘FLOAT’, ‘INT’, ‘BOOLEAN’, ‘VECTOR’, ‘STRING’, ‘RGBA’, ‘OBJECT’, ‘IMAGE’, ‘GEOMETRY’, ‘COLLECTION’, ‘TEXTURE’, ‘MATERIAL’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • output : input_type dependant

Shared sockets:

  • Driving parameter : input_type in (‘FLOAT’, ‘INT’, ‘BOOLEAN’, ‘VECTOR’, ‘STRING’, ‘RGBA’, ‘OBJECT’, ‘IMAGE’, ‘GEOMETRY’, ‘COLLECTION’, ‘TEXTURE’, ‘MATERIAL’)

  • Input sockets : [‘switch’, ‘false’, ‘true’]

  • Output sockets : [‘output’]

Blender reference : GeometryNodeSwitch, Node ‘Switch’

class TransferAttribute(source=None, attribute=None, source_position=None, index=None, data_type='FLOAT', domain='POINT', mapping='NEAREST_FACE_INTERPOLATED', label=None, node_color=None)

Node Transfer Attribute

Parameters

  • source (DataSocket) – Geometry

  • attribute (DataSocket) – data_type dependant

  • source_position (DataSocket) – Vector

  • index (DataSocket) – Integer

  • data_type (str) – Node parameter, default = ‘FLOAT’ in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘FLOAT_COLOR’, ‘BOOLEAN’)

  • domain (str) – Node parameter, default = ‘POINT’ in (‘POINT’, ‘EDGE’, ‘FACE’, ‘CORNER’, ‘CURVE’, ‘INSTANCE’)

  • mapping (str) – Node parameter, default = ‘NEAREST_FACE_INTERPOLATED’ in (‘NEAREST_FACE_INTERPOLATED’, ‘NEAREST’, ‘INDEX’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • attribute : data_type dependant

Shared sockets:

  • Driving parameter : data_type in (‘FLOAT’, ‘INT’, ‘FLOAT_VECTOR’, ‘FLOAT_COLOR’, ‘BOOLEAN’)

  • Input sockets : [‘attribute’]

  • Output sockets : [‘attribute’]

Blender reference : GeometryNodeAttributeTransfer, Node ‘Transfer Attribute’

class Transform(geometry=None, translation=None, rotation=None, scale=None, label=None, node_color=None)

Node Transform

Parameters

  • geometry (DataSocket) – Geometry

  • translation (DataSocket) – Vector

  • rotation (DataSocket) – Vector

  • scale (DataSocket) – Vector

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • geometry : Geometry

Blender reference : GeometryNodeTransform, Node ‘Transform’

class TranslateInstances(instances=None, selection=None, translation=None, local_space=None, label=None, node_color=None)

Node Translate Instances

Parameters

  • instances (DataSocket) – Instances

  • selection (DataSocket) – Boolean

  • translation (DataSocket) – Vector

  • local_space (DataSocket) – Boolean

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • instances : Instances

Blender reference : GeometryNodeTranslateInstances, Node ‘Translate Instances’

class Triangulate(mesh=None, selection=None, minimum_vertices=None, ngon_method='BEAUTY', quad_method='SHORTEST_DIAGONAL', label=None, node_color=None)

Node Triangulate

Parameters

  • mesh (DataSocket) – Mesh

  • selection (DataSocket) – Boolean

  • minimum_vertices (DataSocket) – Integer

  • ngon_method (str) – Node parameter, default = ‘BEAUTY’ in (‘BEAUTY’, ‘CLIP’)

  • quad_method (str) – Node parameter, default = ‘SHORTEST_DIAGONAL’ in (‘BEAUTY’, ‘FIXED’, ‘FIXED_ALTERNATE’, ‘SHORTEST_DIAGONAL’, ‘LONGEST_DIAGONAL’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeTriangulate, Node ‘Triangulate’

class TrimCurve(curve=None, start0=None, start1=None, end0=None, end1=None, mode='FACTOR', label=None, node_color=None)

Node Trim Curve

Parameters

  • curve (DataSocket) – Curve

  • start0 (DataSocket) – Float

  • start1 (DataSocket) – Float

  • end0 (DataSocket) – Float

  • end1 (DataSocket) – Float

  • mode (str) – Node parameter, default = ‘FACTOR’ in (‘FACTOR’, ‘LENGTH’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • curve : Curve

Blender reference : GeometryNodeTrimCurve, Node ‘Trim Curve’

class UvSphere(segments=None, rings=None, radius=None, label=None, node_color=None)

Node UV Sphere

Parameters

  • segments (DataSocket) – Integer

  • rings (DataSocket) – Integer

  • radius (DataSocket) – Float

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeMeshUVSphere, Node ‘UV Sphere’

class Value(label=None, node_color=None)

Node Value

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • value : Float

Blender reference : ShaderNodeValue, Node ‘Value’

class ValueToString(value=None, decimals=None, label=None, node_color=None)

Node Value to String

Parameters

  • value (DataSocket) – Float

  • decimals (DataSocket) – Integer

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • string : String

Blender reference : FunctionNodeValueToString, Node ‘Value to String’

class Vector(vector=[0.0, 0.0, 0.0], label=None, node_color=None)

Node Vector

Parameters

  • vector (Vector) – Node parameter, default = [0.0, 0.0, 0.0]

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • vector : Vector

Blender reference : FunctionNodeInputVector, Node ‘Vector’

class VectorCurves(fac=None, vector=None, label=None, node_color=None)

Node Vector Curves

Parameters

  • fac (DataSocket) – Float

  • vector (DataSocket) – Vector

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • vector : Vector

Blender reference : ShaderNodeVectorCurve, Node ‘Vector Curves’

class VectorMath(vector0=None, vector1=None, vector2=None, scale=None, operation='ADD', label=None, node_color=None)

Node Vector Math

Parameters

  • vector0 (DataSocket) – Vector

  • vector1 (DataSocket) – Vector

  • vector2 (DataSocket) – Vector

  • scale (DataSocket) – Float

  • operation (str) – Node parameter, default = ‘ADD’ in (‘ADD’, ‘SUBTRACT’, ‘MULTIPLY’, ‘DIVIDE’, ‘MULTIPLY_ADD’, ‘CROSS_PRODUCT’, ‘PROJECT’, ‘REFLECT’, ‘REFRACT’, ‘FACEFORWARD’, ‘DOT_PRODUCT’, ‘DISTANCE’, ‘LENGTH’, ‘SCALE’, ‘NORMALIZE’, ‘ABSOLUTE’, ‘MINIMUM’, ‘MAXIMUM’, ‘FLOOR’, ‘CEIL’, ‘FRACTION’, ‘MODULO’, ‘WRAP’, ‘SNAP’, ‘SINE’, ‘COSINE’, ‘TANGENT’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • vector : Vector

  • value : Float

Blender reference : ShaderNodeVectorMath, Node ‘Vector Math’

class VectorRotate(vector=None, center=None, axis=None, angle=None, rotation=None, invert=False, rotation_type='AXIS_ANGLE', label=None, node_color=None)

Node Vector Rotate

Parameters

  • vector (DataSocket) – Vector

  • center (DataSocket) – Vector

  • axis (DataSocket) – Vector

  • angle (DataSocket) – Float

  • rotation (DataSocket) – Vector

  • invert (bool) – Node parameter, default = False

  • rotation_type (str) – Node parameter, default = ‘AXIS_ANGLE’ in (‘AXIS_ANGLE’, ‘X_AXIS’, ‘Y_AXIS’, ‘Z_AXIS’, ‘EULER_XYZ’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • vector : Vector

Blender reference : ShaderNodeVectorRotate, Node ‘Vector Rotate’

class VertexNeighbors(label=None, node_color=None)

Node Vertex Neighbors

Parameters

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • vertex_count : Integer

  • face_count : Integer

Blender reference : GeometryNodeInputMeshVertexNeighbors, Node ‘Vertex Neighbors’

class VolumeToMesh(volume=None, voxel_size=None, voxel_amount=None, threshold=None, adaptivity=None, resolution_mode='GRID', label=None, node_color=None)

Node Volume to Mesh

Parameters

  • volume (DataSocket) – Volume

  • voxel_size (DataSocket) – Float

  • voxel_amount (DataSocket) – Float

  • threshold (DataSocket) – Float

  • adaptivity (DataSocket) – Float

  • resolution_mode (str) – Node parameter, default = ‘GRID’ in (‘GRID’, ‘VOXEL_AMOUNT’, ‘VOXEL_SIZE’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • mesh : Mesh

Blender reference : GeometryNodeVolumeToMesh, Node ‘Volume to Mesh’

class VoronoiTexture(vector=None, w=None, scale=None, smoothness=None, exponent=None, randomness=None, distance='EUCLIDEAN', feature='F1', voronoi_dimensions='3D', label=None, node_color=None)

Node Voronoi Texture

Parameters

  • vector (DataSocket) – Vector

  • w (DataSocket) – Float

  • scale (DataSocket) – Float

  • smoothness (DataSocket) – Float

  • exponent (DataSocket) – Float

  • randomness (DataSocket) – Float

  • distance (str) – Node parameter, default = ‘EUCLIDEAN’ in (‘EUCLIDEAN’, ‘MANHATTAN’, ‘CHEBYCHEV’, ‘MINKOWSKI’)

  • feature (str) – Node parameter, default = ‘F1’ in (‘F1’, ‘F2’, ‘SMOOTH_F1’, ‘DISTANCE_TO_EDGE’, ‘N_SPHERE_RADIUS’)

  • voronoi_dimensions (str) – Node parameter, default = ‘3D’ in (‘1D’, ‘2D’, ‘3D’, ‘4D’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • distance : Float

  • color : Color

  • position : Vector

  • w : Float

  • radius : Float

Blender reference : ShaderNodeTexVoronoi, Node ‘Voronoi Texture’

class WaveTexture(vector=None, scale=None, distortion=None, detail=None, detail_scale=None, detail_roughness=None, phase_offset=None, bands_direction='X', rings_direction='X', wave_profile='SIN', wave_type='BANDS', label=None, node_color=None)

Node Wave Texture

Parameters

  • vector (DataSocket) – Vector

  • scale (DataSocket) – Float

  • distortion (DataSocket) – Float

  • detail (DataSocket) – Float

  • detail_scale (DataSocket) – Float

  • detail_roughness (DataSocket) – Float

  • phase_offset (DataSocket) – Float

  • bands_direction (str) – Node parameter, default = ‘X’ in (‘X’, ‘Y’, ‘Z’, ‘DIAGONAL’)

  • rings_direction (str) – Node parameter, default = ‘X’ in (‘X’, ‘Y’, ‘Z’, ‘SPHERICAL’)

  • wave_profile (str) – Node parameter, default = ‘SIN’ in (‘SIN’, ‘SAW’, ‘TRI’)

  • wave_type (str) – Node parameter, default = ‘BANDS’ in (‘BANDS’, ‘RINGS’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • color : Color

  • fac : Float

Blender reference : ShaderNodeTexWave, Node ‘Wave Texture’

class WhiteNoiseTexture(vector=None, w=None, noise_dimensions='3D', label=None, node_color=None)

Node White Noise Texture

Parameters

  • vector (DataSocket) – Vector

  • w (DataSocket) – Float

  • noise_dimensions (str) – Node parameter, default = ‘3D’ in (‘1D’, ‘2D’, ‘3D’, ‘4D’)

  • node_color (color) – Node color

  • node_label (str) – Node label

Output sockets:

  • value : Float

  • color : Color

Blender reference : ShaderNodeTexWhiteNoise, Node ‘White Noise Texture’