Class Curve#

Curve sub class of Geometry

A Curve has two domains:

Constructors#

Constructors come from the Blender menu Curve primitives:

Constructor#

Curve(self, socket, node=None, label=None)

rom geonodes.nodes import domains

elf.points = Vertex(self) # Initialized before super().init which can override points

Content#

Properties

ID | bounding_box | bounding_box_min | convex_hull | curve_component | domain_size | index | instances_component | is_viewport | length | material_index | mesh_component | normal | point_count | points_component | position | radius | separate_components | spline_count | volume_component

Inherited

bl_idname | bnode | is_multi_input | is_output | is_plugged | links | name | node_chain_label | socket_index

Class and static methods

Arc | ArcFromPoints | BezierSegment | Circle | CircleFromPoints | Collection | FromCollection | Input | Line | LineDirection | QuadraticBezier | Quadrilateral | Spiral | Star | capture_attribute_node | random_boolean | random_float | random_integer | random_vector

Inherited

get_bl_idname | get_class_name | gives_bsocket | is_socket | is_vector | python_type_to_socket | value_data_type

Methods

attribute_statistic | capture_attribute | curve_of_point | deform_on_surface | delete | duplicate | field_at_index | fill | fill_ngons | fill_triangles | fillet | fillet_bezier | fillet_poly | instance_on_points | instantiate | interpolate_domain | join | material_selection | merge_by_distance | named_attribute | named_boolean | named_color | named_float | named_integer | named_vector | offset_point | points_of_curve | proximity | proximity_edges | proximity_faces | proximity_points | raycast | raycast_interpolated | raycast_nearest | remove_named_attribute | replace_material | resample | resample_count | resample_evaluated | resample_length | reverse | sample | sample_index | sample_nearest | separate | set_ID | set_material | set_material_index | set_position | show_handles | store_named_attribute | store_named_boolean | store_named_color | store_named_float | store_named_integer | store_named_vector | subdivide | switch | to_instance | to_mesh | to_points | to_points_count | to_points_evaluated | to_points_length | transform | trim | trim_factor | trim_length | view | viewer

Inherited

connected_sockets | get_blender_socket | init_domains | init_socket | plug | reroute | reset_properties | stack | to_output

Properties#

ID#

Returns:#

  • socket ID

Go to top - main - nodes - nodes menus

bounding_box#

Returns:#

  • socket bounding_box of class Mesh

Go to top - main - nodes - nodes menus

bounding_box_min#

Returns:#

  • socket max

Go to top - main - nodes - nodes menus

convex_hull#

Returns:#

  • socket convex_hull of class Mesh

Go to top - main - nodes - nodes menus

curve_component#

Returns:#

  • socket curve of class Curve

Go to top - main - nodes - nodes menus

domain_size#

Returns:#

  • node with sockets [‘point_count’, ‘edge_count’, ‘face_count’, ‘face_corner_count’, ‘spline_count’, ‘instance_count’]

Go to top - main - nodes - nodes menus

index#

Returns:#

  • socket index

Go to top - main - nodes - nodes menus

instances_component#

Returns:#

  • socket instances of class Instances

Go to top - main - nodes - nodes menus

is_viewport#

Returns:#

  • socket is_viewport

Go to top - main - nodes - nodes menus

length#

Returns:#

  • socket length

Go to top - main - nodes - nodes menus

material_index#

Returns:#

  • socket material_index

Go to top - main - nodes - nodes menus

mesh_component#

Returns:#

  • socket mesh of class Mesh

Go to top - main - nodes - nodes menus

normal#

Returns:#

  • socket normal

Go to top - main - nodes - nodes menus

point_count#

Returns:#

  • socket point_count

Go to top - main - nodes - nodes menus

points_component#

Returns:#

  • socket point_cloud of class Points

Go to top - main - nodes - nodes menus

position#

Returns:#

  • socket position

Go to top - main - nodes - nodes menus

radius#

Returns:#

  • socket radius

Go to top - main - nodes - nodes menus

separate_components#

Returns:#

  • node with sockets [‘mesh’, ‘point_cloud’, ‘curve’, ‘volume’, ‘instances’]

Go to top - main - nodes - nodes menus

spline_count#

Returns:#

  • socket spline_count

Go to top - main - nodes - nodes menus

volume_component#

Returns:#

  • socket volume of class Volume

Go to top - main - nodes - nodes menus

Class and static methods#

Arc#

@classmethod
def Arc(cls, resolution=None, radius=None, start_angle=None, sweep_angle=None, connect_center=None, invert_arc=None)

Args:#

  • resolution: Integer

  • radius: Float

  • start_angle: Float

  • sweep_angle: Float

  • connect_center: Boolean

  • invert_arc: Boolean

Returns:#

  • socket curve

Go to top - main - nodes - nodes menus

ArcFromPoints#

@classmethod
def ArcFromPoints(cls, resolution=None, start=None, middle=None, end=None, offset_angle=None, connect_center=None, invert_arc=None)

Args:#

  • resolution: Integer

  • start: Vector

  • middle: Vector

  • end: Vector

  • offset_angle: Float

  • connect_center: Boolean

  • invert_arc: Boolean

Returns:#

  • node with sockets [‘curve’, ‘center’, ‘normal’, ‘radius’]

Go to top - main - nodes - nodes menus

BezierSegment#

@classmethod
def BezierSegment(cls, resolution=None, start=None, start_handle=None, end_handle=None, end=None, mode='POSITION')

Args:#

  • resolution: Integer

  • start: Vector

  • start_handle: Vector

  • end_handle: Vector

  • end: Vector

  • mode (str): ‘POSITION’ in [POSITION, OFFSET]

Returns:#

  • socket curve

Go to top - main - nodes - nodes menus

Circle#

@classmethod
def Circle(cls, resolution=None, radius=None)

Args:#

  • resolution: Integer

  • radius: Float

Returns:#

  • socket curve

Go to top - main - nodes - nodes menus

CircleFromPoints#

@staticmethod
def CircleFromPoints(resolution=None, point_1=None, point_2=None, point_3=None)

Args:#

  • resolution: Integer

  • point_1: Vector

  • point_2: Vector

  • point_3: Vector

Node Image

Returns:#

  • tuple (’curve’, ‘center’)

Go to top - main - nodes - nodes menus

Collection#

@classmethod
def Collection(cls, collection=None, separate_children=None, reset_children=None, transform_space='ORIGINAL')

Args:#

  • collection: Collection

  • separate_children: Boolean

  • reset_children: Boolean

  • transform_space (str): ‘ORIGINAL’ in [ORIGINAL, RELATIVE]

Returns:#

  • socket geometry

Go to top - main - nodes - nodes menus

FromCollection#

@classmethod
def FromCollection(cls, collection=None, separate_children

Get the geometry from a collection

Go to top - main - nodes - nodes menus

Input#

@classmethod
def Input(cls, name = None, description = "")

Create a Geometry input socket in the Group Input Node

Args:#

  • name: The socket name

  • description: User tip

Returns:#

  • Geometry: The Geometry data socket

Note: This method create a new input socket in the Group Input node. To get the default input geometry, use Tree.input_geometry property.

Go to top - main - nodes - nodes menus

Line#

@classmethod
def Line(cls, start=None, end=None)

Args:#

  • start: Vector

  • end: Vector

Returns:#

  • socket curve

Go to top - main - nodes - nodes menus

LineDirection#

@classmethod
def LineDirection(cls, start=None, direction=None, length=None)

Args:#

  • start: Vector

  • direction: Vector

  • length: Float

Returns:#

  • socket curve

Go to top - main - nodes - nodes menus

QuadraticBezier#

@classmethod
def QuadraticBezier(cls, resolution=None, start=None, middle=None, end=None)

Args:#

  • resolution: Integer

  • start: Vector

  • middle: Vector

  • end: Vector

Returns:#

  • socket curve

Go to top - main - nodes - nodes menus

Quadrilateral#

@classmethod
def Quadrilateral(cls, 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')

Args:#

  • width: Float

  • height: Float

  • bottom_width: Float

  • top_width: Float

  • offset: Float

  • bottom_height: Float

  • top_height: Float

  • point_1: Vector

  • point_2: Vector

  • point_3: Vector

  • point_4: Vector

  • mode (str): ‘RECTANGLE’ in [RECTANGLE, PARALLELOGRAM, TRAPEZOID, KITE, POINTS]

Returns:#

  • socket curve

Go to top - main - nodes - nodes menus

Spiral#

@classmethod
def Spiral(cls, resolution=None, rotations=None, start_radius=None, end_radius=None, height=None, reverse=None)

Args:#

  • resolution: Integer

  • rotations: Float

  • start_radius: Float

  • end_radius: Float

  • height: Float

  • reverse: Boolean

Returns:#

  • socket curve

Go to top - main - nodes - nodes menus

Star#

@classmethod
def Star(cls, points=None, inner_radius=None, outer_radius=None, twist=None)

Args:#

  • points: Integer

  • inner_radius: Float

  • outer_radius: Float

  • twist: Float

Returns:#

  • node with sockets [‘curve’, ‘outer_points’]

Go to top - main - nodes - nodes menus

capture_attribute_node#

@staticmethod
def capture_attribute_node(geometry=None, value=None, data_type='FLOAT', domain='POINT')

Args:#

  • geometry: Geometry

  • value: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

  • data_type (str): ‘FLOAT’ in [FLOAT, INT, FLOAT_VECTOR, FLOAT_COLOR, BOOLEAN]

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • node with sockets [‘geometry’, ‘attribute’]

Go to top - main - nodes - nodes menus

random_boolean#

@staticmethod
def random_boolean(probability=None, ID=None, seed=None)

Args:#

  • probability: Float

  • ID: Integer

  • seed: Integer

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

random_float#

@staticmethod
def random_float(min=None, max=None, ID=None, seed=None)

Args:#

  • min: [‘Vector’, ‘Float’, ‘Integer’]

  • max: [‘Vector’, ‘Float’, ‘Integer’]

  • ID: Integer

  • seed: Integer

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

random_integer#

@staticmethod
def random_integer(min=None, max=None, ID=None, seed=None)

Args:#

  • min: [‘Vector’, ‘Float’, ‘Integer’]

  • max: [‘Vector’, ‘Float’, ‘Integer’]

  • ID: Integer

  • seed: Integer

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

random_vector#

@staticmethod
def random_vector(min=None, max=None, ID=None, seed=None)

Args:#

  • min: [‘Vector’, ‘Float’, ‘Integer’]

  • max: [‘Vector’, ‘Float’, ‘Integer’]

  • ID: Integer

  • seed: Integer

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

Methods#

attribute_statistic#

def attribute_statistic(self, selection=None, attribute=None, domain='POINT')

Args:#

  • selection: Boolean

  • attribute: [‘Float’, ‘Vector’]

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • node with sockets [‘mean’, ‘median’, ‘sum’, ‘min’, ‘max’, ‘range’, ‘standard_deviation’, ‘variance’]

Go to top - main - nodes - nodes menus

capture_attribute#

def capture_attribute(self, value=None, domain='POINT')

Args:#

  • value: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • socket attribute

Go to top - main - nodes - nodes menus

curve_of_point#

def curve_of_point(self, point_index=None)

Args:#

  • point_index: Integer

Node Image

Returns:#

  • tuple (’curve_index’, ‘index_in_curve’)

Go to top - main - nodes - nodes menus

deform_on_surface#

def deform_on_surface(self)

Returns:#

  • self

Go to top - main - nodes - nodes menus

delete#

def delete(self, selection=None, domain='POINT', mode='ALL')

Args:#

  • selection: Boolean

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CURVE, INSTANCE]

  • mode (str): ‘ALL’ in [ALL, EDGE_FACE, ONLY_FACE]

Returns:#

  • self

Go to top - main - nodes - nodes menus

duplicate#

def duplicate(self, selection=None, amount=None, domain='POINT')

Args:#

  • selection: Boolean

  • amount: Integer

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, SPLINE, INSTANCE]

Returns:#

  • socket duplicate_index

Go to top - main - nodes - nodes menus

field_at_index#

def field_at_index(self, index=None, value=None, domain='POINT')

Args:#

  • index: Integer

  • value: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘Boolean’]

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

fill#

def fill(self, mode='TRIANGLES')

Args:#

  • mode (str): ‘TRIANGLES’ in [TRIANGLES, NGONS]

Returns:#

  • socket mesh of class Mesh

Go to top - main - nodes - nodes menus

fill_ngons#

def fill_ngons(self)

Returns:#

  • socket mesh of class Mesh

Go to top - main - nodes - nodes menus

fill_triangles#

def fill_triangles(self)

Returns:#

  • socket mesh of class Mesh

Go to top - main - nodes - nodes menus

fillet#

def fillet(self, count=None, radius=None, limit_radius=None, mode='BEZIER')

Args:#

  • count: Integer

  • radius: Float

  • limit_radius: Boolean

  • mode (str): ‘BEZIER’ in [BEZIER, POLY]

Returns:#

  • self

Go to top - main - nodes - nodes menus

fillet_bezier#

def fillet_bezier(self, radius=None, limit_radius=None)

Args:#

  • radius: Float

  • limit_radius: Boolean

Returns:#

  • self

Go to top - main - nodes - nodes menus

fillet_poly#

def fillet_poly(self, count=None, radius=None, limit_radius=None)

Args:#

  • count: Integer

  • radius: Float

  • limit_radius: Boolean

Returns:#

  • self

Go to top - main - nodes - nodes menus

instance_on_points#

def instance_on_points(self, selection=None, instance=None, pick_instance=None, instance_index=None, rotation=None, scale=None)

Args:#

  • selection: Boolean

  • instance: Geometry

  • pick_instance: Boolean

  • instance_index: Integer

  • rotation: Vector

  • scale: Vector

Returns:#

  • socket instances

Go to top - main - nodes - nodes menus

instantiate#

def instantiate(self, count = 1, realize = False)

Instantiate the geometry

Args:#

  • count: Number of instances to create

  • realize: True to realize the instances

Returns:#

  • Instances or Geometry

The duplication is performed by instantiating the geometry along the vertices of a Mesh Line initialized with count points.

The operator * can be used to operate this method with realize = False:

    
curves = curve * 10

# is equivalent to

curves = curve.duplicate(10, realize=False)

Go to top - main - nodes - nodes menus

interpolate_domain#

def interpolate_domain(self, value=None, domain='POINT')

Args:#

  • value: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘Boolean’]

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

join#

def join(*geometry)

Args:#

  • geometry: Geometry

Returns:#

  • socket geometry

Go to top - main - nodes - nodes menus

material_selection#

def material_selection(self, material=None)

Args:#

  • material: Material

Returns:#

  • socket selection

Go to top - main - nodes - nodes menus

merge_by_distance#

def merge_by_distance(self, selection=None, distance=None, mode='ALL')

Args:#

  • selection: Boolean

  • distance: Float

  • mode (str): ‘ALL’ in [ALL, CONNECTED]

Returns:#

  • self

Go to top - main - nodes - nodes menus

named_attribute#

def named_attribute(self, name=None, data_type='FLOAT')

Args:#

  • name: String

  • data_type (str): ‘FLOAT’ in [FLOAT, INT, FLOAT_VECTOR, FLOAT_COLOR, BOOLEAN]

Returns:#

  • socket attribute

Go to top - main - nodes - nodes menus

named_boolean#

def named_boolean(self, name=None)

Args:#

  • name: String

Returns:#

  • socket attribute

Go to top - main - nodes - nodes menus

named_color#

def named_color(self, name=None)

Args:#

  • name: String

Returns:#

  • socket attribute

Go to top - main - nodes - nodes menus

named_float#

def named_float(self, name=None)

Args:#

  • name: String

Returns:#

  • socket attribute

Go to top - main - nodes - nodes menus

named_integer#

def named_integer(self, name=None)

Args:#

  • name: String

Returns:#

  • socket attribute

Go to top - main - nodes - nodes menus

named_vector#

def named_vector(self, name=None)

Args:#

  • name: String

Returns:#

  • socket attribute

Go to top - main - nodes - nodes menus

offset_point#

def offset_point(self, point_index=None, offset=None)

Args:#

  • point_index: Integer

  • offset: Integer

Node Image

Returns:#

  • tuple (’is_valid_offset’, ‘point_index’)

Go to top - main - nodes - nodes menus

points_of_curve#

def points_of_curve(self, curve_index=None, weights=None, sort_index=None)

Args:#

  • curve_index: Integer

  • weights: Float

  • sort_index: Integer

Node Image

Returns:#

  • tuple (’point_index’, ‘total’)

Go to top - main - nodes - nodes menus

proximity#

def proximity(self, target=None, source_position=None, target_element='FACES')

Args:#

  • target: Geometry

  • source_position: Vector

  • target_element (str): ‘FACES’ in [POINTS, EDGES, FACES]

Returns:#

  • socket distance

Go to top - main - nodes - nodes menus

proximity_edges#

def proximity_edges(self, target=None, source_position=None)

Args:#

  • target: Geometry

  • source_position: Vector

Returns:#

  • socket distance

Go to top - main - nodes - nodes menus

proximity_faces#

def proximity_faces(self, target=None, source_position=None)

Args:#

  • target: Geometry

  • source_position: Vector

Returns:#

  • socket distance

Go to top - main - nodes - nodes menus

proximity_points#

def proximity_points(self, target=None, source_position=None)

Args:#

  • target: Geometry

  • source_position: Vector

Returns:#

  • socket distance

Go to top - main - nodes - nodes menus

raycast#

def raycast(self, target_geometry=None, attribute=None, source_position=None, ray_direction=None, ray_length=None, mapping='INTERPOLATED')

Args:#

  • target_geometry: Geometry

  • attribute: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

  • source_position: Vector

  • ray_direction: Vector

  • ray_length: Float

  • mapping (str): ‘INTERPOLATED’ in [INTERPOLATED, NEAREST]

Returns:#

  • node with sockets [‘is_hit’, ‘hit_position’, ‘hit_normal’, ‘hit_distance’, ‘attribute’]

Go to top - main - nodes - nodes menus

raycast_interpolated#

def raycast_interpolated(self, target_geometry=None, attribute=None, source_position=None, ray_direction=None, ray_length=None)

Args:#

  • target_geometry: Geometry

  • attribute: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

  • source_position: Vector

  • ray_direction: Vector

  • ray_length: Float

Returns:#

  • node with sockets [‘is_hit’, ‘hit_position’, ‘hit_normal’, ‘hit_distance’, ‘attribute’]

Go to top - main - nodes - nodes menus

raycast_nearest#

def raycast_nearest(self, target_geometry=None, attribute=None, source_position=None, ray_direction=None, ray_length=None)

Args:#

  • target_geometry: Geometry

  • attribute: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

  • source_position: Vector

  • ray_direction: Vector

  • ray_length: Float

Returns:#

  • node with sockets [‘is_hit’, ‘hit_position’, ‘hit_normal’, ‘hit_distance’, ‘attribute’]

Go to top - main - nodes - nodes menus

remove_named_attribute#

def remove_named_attribute(self, name=None)

Args:#

  • name: String

Returns:#

  • self

Go to top - main - nodes - nodes menus

replace_material#

def replace_material(self, old=None, new=None)

Args:#

  • old: Material

  • new: Material

Returns:#

  • self

Go to top - main - nodes - nodes menus

resample#

def resample(self, selection=None, count=None, length=None, mode='COUNT')

Args:#

  • selection: Boolean

  • count: Integer

  • length: Float

  • mode (str): ‘COUNT’ in [EVALUATED, COUNT, LENGTH]

Returns:#

  • self

Go to top - main - nodes - nodes menus

resample_count#

def resample_count(self, selection=None, count=None)

Args:#

  • selection: Boolean

  • count: Integer

Returns:#

  • self

Go to top - main - nodes - nodes menus

resample_evaluated#

def resample_evaluated(self, selection=None)

Args:#

  • selection: Boolean

Returns:#

  • self

Go to top - main - nodes - nodes menus

resample_length#

def resample_length(self, selection=None, length=None)

Args:#

  • selection: Boolean

  • length: Float

Returns:#

  • self

Go to top - main - nodes - nodes menus

reverse#

def reverse(self, selection=None)

Args:#

  • selection: Boolean

Returns:#

  • self

Go to top - main - nodes - nodes menus

sample#

def sample(self, value=None, factor=None, length=None, curve_index=None, data_type='FLOAT', mode='FACTOR', use_all_curves=False)

Args:#

  • value: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘Boolean’]

  • factor: Float

  • length: Float

  • curve_index: Integer

  • data_type (str): ‘FLOAT’ in [FLOAT, INT, FLOAT_VECTOR, FLOAT_COLOR, BOOLEAN]

  • mode (str): ‘FACTOR’ in [FACTOR, LENGTH]

  • use_all_curves (bool): False

Returns:#

  • self

Go to top - main - nodes - nodes menus

sample_index#

def sample_index(self, value=None, index=None, clamp=False, domain='POINT')

Args:#

  • value: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘Boolean’]

  • index: Integer

  • clamp (bool): False

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

sample_nearest#

def sample_nearest(self, sample_position=None, domain='POINT')

Args:#

  • sample_position: Vector

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER]

Returns:#

  • socket index

Go to top - main - nodes - nodes menus

separate#

def separate(self, selection=None, domain='POINT')

Args:#

  • selection: Boolean

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CURVE, INSTANCE]

Node Image

Returns:#

  • tuple (’selection’, ‘inverted’)

Go to top - main - nodes - nodes menus

set_ID#

def set_ID(self, selection=None, ID=None)

Args:#

  • selection: Boolean

  • ID: Integer

Returns:#

  • self

Go to top - main - nodes - nodes menus

set_material#

def set_material(self, selection=None, material=None)

Args:#

  • selection: Boolean

  • material: Material

Returns:#

  • self

Go to top - main - nodes - nodes menus

set_material_index#

def set_material_index(self, selection=None, material_index=None)

Args:#

  • selection: Boolean

  • material_index: Integer

Returns:#

  • self

Go to top - main - nodes - nodes menus

set_position#

def set_position(self, selection=None, position=None, offset=None)

Args:#

  • selection: Boolean

  • position: Vector

  • offset: Vector

Returns:#

  • self

Go to top - main - nodes - nodes menus

show_handles#

def show_handles(self)

Generate a mesh and cloud points to visualize the control points and handles

Returns:#

  • Geometry: The geometry can be joined to the output

Example:

curve = ... # Curve initialization

visu = curve.show_handles()

tree.output_geometry = curve + visu

Go to top - main - nodes - nodes menus

store_named_attribute#

def store_named_attribute(self, name=None, value=None, domain='POINT')

Args:#

  • name: String

  • value: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • self

Go to top - main - nodes - nodes menus

store_named_boolean#

def store_named_boolean(self, name=None, value=None, domain='POINT')

Args:#

  • name: String

  • value: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • self

Go to top - main - nodes - nodes menus

store_named_color#

def store_named_color(self, name=None, value=None, domain='POINT')

Args:#

  • name: String

  • value: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • self

Go to top - main - nodes - nodes menus

store_named_float#

def store_named_float(self, name=None, value=None, domain='POINT')

Args:#

  • name: String

  • value: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • self

Go to top - main - nodes - nodes menus

store_named_integer#

def store_named_integer(self, name=None, value=None, domain='POINT')

Args:#

  • name: String

  • value: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • self

Go to top - main - nodes - nodes menus

store_named_vector#

def store_named_vector(self, name=None, value=None, domain='POINT')

Args:#

  • name: String

  • value: [‘Vector’, ‘Float’, ‘Color’, ‘Boolean’, ‘Integer’]

  • domain (str): ‘POINT’ in [POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • self

Go to top - main - nodes - nodes menus

subdivide#

def subdivide(self, cuts=None)

Args:#

  • cuts: Integer

Returns:#

  • self

Go to top - main - nodes - nodes menus

switch#

def switch(self, switch=None, true=None)

Args:#

  • switch: Boolean

  • true: Geometry

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

to_instance#

def to_instance(*geometry)

Args:#

  • geometry: Geometry

Returns:#

  • socket instances of class Instances

Go to top - main - nodes - nodes menus

to_mesh#

def to_mesh(self, profile_curve=None, fill_caps=None)

Args:#

  • profile_curve: Geometry

  • fill_caps: Boolean

Returns:#

  • socket mesh of class Mesh

Go to top - main - nodes - nodes menus

to_points#

def to_points(self, count=None, length=None, mode='COUNT')

Args:#

  • count: Integer

  • length: Float

  • mode (str): ‘COUNT’ in [EVALUATED, COUNT, LENGTH]

Node Image

Returns:#

  • tuple (’points’, ‘tangent’, ‘normal’, ‘rotation’)

Go to top - main - nodes - nodes menus

to_points_count#

def to_points_count(self, count=None)

Args:#

  • count: Integer

Node Image

Returns:#

  • tuple (’points’, ‘tangent’, ‘normal’, ‘rotation’)

Go to top - main - nodes - nodes menus

to_points_evaluated#

def to_points_evaluated(self)

Node Image

Returns:#

  • tuple (’points’, ‘tangent’, ‘normal’, ‘rotation’)

Go to top - main - nodes - nodes menus

to_points_length#

def to_points_length(self, length=None)

Args:#

  • length: Float

Node Image

Returns:#

  • tuple (’points’, ‘tangent’, ‘normal’, ‘rotation’)

Go to top - main - nodes - nodes menus

transform#

def transform(self, translation=None, rotation=None, scale=None)

Args:#

  • translation: Vector

  • rotation: Vector

  • scale: Vector

Returns:#

  • self

Go to top - main - nodes - nodes menus

trim#

def trim(self, start=None, end=None, mode='FACTOR')

Args:#

  • mode (str): ‘FACTOR’ in [FACTOR, LENGTH]

Returns:#

  • self

Go to top - main - nodes - nodes menus

trim_factor#

def trim_factor(self, start=None, end=None)

Args:#

  • start: Float

  • end: Float

Returns:#

  • self

Go to top - main - nodes - nodes menus

trim_length#

def trim_length(self, start=None, end=None)

Args:#

  • start: Float

  • end: Float

Returns:#

  • self

Go to top - main - nodes - nodes menus

view#

def view(self, value=None, domain='AUTO')

Args:#

  • value: [‘Float’, ‘Vector’, ‘Color’, ‘Integer’, ‘Boolean’]

  • domain (str): ‘AUTO’ in [AUTO, POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • node with sockets []

Go to top - main - nodes - nodes menus

viewer#

def viewer(self, value=None, domain='AUTO')

Args:#

  • value: [‘Float’, ‘Vector’, ‘Color’, ‘Integer’, ‘Boolean’]

  • domain (str): ‘AUTO’ in [AUTO, POINT, EDGE, FACE, CORNER, CURVE, INSTANCE]

Returns:#

  • node with sockets []

Go to top - main - nodes - nodes menus