Class Geometry#

main - nodes - nodes menus

Geometry DataSocket

In Blender, there is only one type of geometry socket. Sub classes Mesh, Curve, Points, Instances and Volume are introduced by geonodes. Each sub class implement the nodes creation which are specific to them.

For instance, the node ‘Extrude Mesh’ is specific to meshes. This node is implemented by the method extrude of class Mesh:

top, side = mesh.extrude()

Some Geometry sub classes can have methods with the same name but are based on different nodes:

points_1 = mesh.to_points()  # Create a 'Mesh to Points' node
points_2 = curve.to_points() # Create a 'Curve to Points' node

Initialization#

There is no constructor returnig of geometry of type Geometry. Constructors are class methods of sub classes implementing their specific primitive nodes:

cube     = Mesh.Cube()      # node 'Cube'
circle_1 = Mesh.Circle()    # node 'Mesh Circle'
circle_2 = Curve.Circle()   # node 'Curve Circle'
volume   = Volume.Cube()    # node 'Volume Cube'

Geometry is the type of the input geometry which can be read from the property input_geometry of the Tree. If a modifier is dedicated to meshes, one must type cast the input geometry to the desired type:

with Tree("Geometry Nodes") as tree:
    geometry = tree.input_geometry # class Geometry
    mesh = Mesh(tree.ig)           # type cast to Mesh (ig is the short version of input_geometry)

Components#

The components of Geometry can be accessed via dedicated properties. This is an alternative to typecasting the input geometry.

geo = tree.ig
mesh = geo.mesh_component    # Socket 'Mesh' of node 'Separate Components'
vol  = geo.volume_component  # Socket 'Volume' of node 'Separated Components'

Joining#

Geometry supports the + operator acting as method join. In the following example, the tree returns the joining of a cube and a sphere:

cube = Mesh.Cube()
sphere = Mesh.IcoSphere()
tree.output_geometry = cube + sphere

Constructor#

Geometry(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

Inherited

Class and static methods

Inherited

Methods

Inherited

Properties#

ID#

Node: ID | Blender reference | api reference

Returns:#

socket ID

_{Go to top - main - nodes - nodes menus}

bounding_box#

Node: Bounding Box | Blender reference | api reference

Returns:#

socket bounding_box of class Mesh

_{Go to top - main - nodes - nodes menus}

bounding_box_min#

Node: Bounding Box | Blender reference | api reference

Returns:#

socket max

_{Go to top - main - nodes - nodes menus}

convex_hull#

Node: Convex Hull | Blender reference | api reference

Returns:#

socket convex_hull of class Mesh

_{Go to top - main - nodes - nodes menus}

curve_component#

Node: Separate Components | Blender reference | api reference

Returns:#

socket curve of class Curve

_{Go to top - main - nodes - nodes menus}

domain_size#

Node: Domain Size | Blender reference | api reference

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#

Node: Index | Blender reference | api reference

Returns:#

socket index

_{Go to top - main - nodes - nodes menus}

instances_component#

Node: Separate Components | Blender reference | api reference

Returns:#

socket instances of class Instances

_{Go to top - main - nodes - nodes menus}

is_viewport#

Node: Is Viewport | Blender reference | api reference

Returns:#

socket is_viewport

_{Go to top - main - nodes - nodes menus}

material_index#

Node: Material Index | Blender reference | api reference

Returns:#

socket material_index

_{Go to top - main - nodes - nodes menus}

mesh_component#

Node: Separate Components | Blender reference | api reference

Returns:#

socket mesh of class Mesh

_{Go to top - main - nodes - nodes menus}

normal#

Node: Normal | Blender reference | api reference

Returns:#

socket normal

_{Go to top - main - nodes - nodes menus}

points_component#

Node: Separate Components | Blender reference | api reference

Returns:#

socket point_cloud of class Points

_{Go to top - main - nodes - nodes menus}

position#

Node: Position | Blender reference | api reference

Returns:#

socket position

_{Go to top - main - nodes - nodes menus}

radius#

Node: Radius | Blender reference | api reference

Returns:#

socket radius

_{Go to top - main - nodes - nodes menus}

separate_components#

Node: Separate Components | Blender reference | api reference

Returns:#

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

_{Go to top - main - nodes - nodes menus}

volume_component#

Node: Separate Components | Blender reference | api reference

Returns:#

socket volume of class Volume

_{Go to top - main - nodes - nodes menus}

Class and static methods#

Collection#

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

Node: Collection Info | Blender reference | api reference

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}

capture_attribute_node#

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

Node: Capture Attribute | Blender reference | api reference

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)

Node: Random Value | Blender reference | api reference

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)

Node: Random Value | Blender reference | api reference

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)

Node: Random Value | Blender reference | api reference

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)

Node: Random Value | Blender reference | api reference

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')

Node: Attribute Statistic | Blender reference | api reference

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')

Node: Capture Attribute | Blender reference | api reference

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}

delete#

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

Node: Delete Geometry | Blender reference | api reference

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')

Node: Duplicate Elements | Blender reference | api reference

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')

Node: Field at Index | Blender reference | api reference

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}

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')

Node: Interpolate Domain | Blender reference | api reference

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)

Node: Join Geometry | Blender reference | api reference

Args:#

geometry: Geometry

Returns:#

socket geometry

_{Go to top - main - nodes - nodes menus}

material_selection#

def material_selection(self, material=None)

Node: Material Selection | Blender reference | api reference

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')

Node: Merge by Distance | Blender reference | api reference

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')

Node: Named Attribute | Blender reference | api reference

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)

Node: Named Attribute | Blender reference | api reference

Args:#

name: String

Returns:#

socket attribute

_{Go to top - main - nodes - nodes menus}

named_color#

def named_color(self, name=None)

Node: Named Attribute | Blender reference | api reference

Args:#

name: String

Returns:#

socket attribute

_{Go to top - main - nodes - nodes menus}

named_float#

def named_float(self, name=None)

Node: Named Attribute | Blender reference | api reference

Args:#

name: String

Returns:#

socket attribute

_{Go to top - main - nodes - nodes menus}

named_integer#

def named_integer(self, name=None)

Node: Named Attribute | Blender reference | api reference

Args:#

name: String

Returns:#

socket attribute

_{Go to top - main - nodes - nodes menus}

named_vector#

def named_vector(self, name=None)

Node: Named Attribute | Blender reference | api reference

Args:#

name: String

Returns:#

socket attribute

_{Go to top - main - nodes - nodes menus}

proximity#

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

Node: Geometry Proximity | Blender reference | api reference

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)

Node: Geometry Proximity | Blender reference | api reference

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)

Node: Geometry Proximity | Blender reference | api reference

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)

Node: Geometry Proximity | Blender reference | api reference

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')

Node: Raycast | Blender reference | api reference

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)

Node: Raycast | Blender reference | api reference

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)

Node: Raycast | Blender reference | api reference

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)

Node: Remove Named Attribute | Blender reference | api reference

Args:#

name: String

Returns:#

self

_{Go to top - main - nodes - nodes menus}

replace_material#

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

Node: Replace Material | Blender reference | api reference

Args:#

old: Material
new: Material

Returns:#

self

_{Go to top - main - nodes - nodes menus}

sample_index#

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

Node: Sample Index | Blender reference | api reference

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')

Node: Sample Nearest | Blender reference | api reference

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')

Node: Separate Geometry | Blender reference | api reference

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)

Node: Set ID | Blender reference | api reference

Args:#

selection: Boolean
ID: Integer

Returns:#

self

_{Go to top - main - nodes - nodes menus}

set_material#

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

Node: Set Material | Blender reference | api reference

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)

Node: Set Material Index | Blender reference | api reference

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)

Node: Set Position | Blender reference | api reference

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')

Node: Store Named Attribute | Blender reference | api reference

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')

Node: Store Named Attribute | Blender reference | api reference

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')

Node: Store Named Attribute | Blender reference | api reference

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')

Node: Store Named Attribute | Blender reference | api reference

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')

Node: Store Named Attribute | Blender reference | api reference

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')

Node: Store Named Attribute | Blender reference | api reference

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}

switch#

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

Node: Switch | Blender reference | api reference

Args:#

switch: Boolean
true: Geometry

Returns:#

socket output

_{Go to top - main - nodes - nodes menus}

to_instance#

def to_instance(*geometry)

Node: Geometry to Instance | Blender reference | api reference

Args:#

geometry: Geometry

Returns:#

socket instances of class Instances

_{Go to top - main - nodes - nodes menus}

transform#

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

Node: Transform | Blender reference | api reference

Args:#

translation: Vector
rotation: Vector
scale: Vector

Returns:#

self

_{Go to top - main - nodes - nodes menus}

view#

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

Node: Viewer | Blender reference | api reference

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')

Node: Viewer | Blender reference | api reference

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}