Skip to content

Instances

Bases: Geometry, Instances

Source code in core/geometries.py 
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
class Instances(Geometry, generated.Instances):

    __slots__ = Geometry.__slots__ + ('insts',)

    insts : Instance

    """ > Instances Geometry

    !!! note
        The name of geometry class is plural : **Instances** when the name of the
        domain is singular : Instance. The named of the domain property is insts.

    The **Instances** class exposes all methods specific to instances.
    Since there is no ambiguity, the word **instances** is omitted in the name of
    the methods:

    ``` python
    realized = instances.realize() # Node 'Realize Instances'
    ```
    Nodes requiring a domain parameter, are implemented in the domain insts.

    Attributes
    ----------
    insts : Instance
        INSTANCES domain
    """

    def _reset(self):

        super()._reset()
        self.insts  = Instance(self)

_interface_socket property

Return the interface socket if exists

An interface socket exists when the socket a tree input or output socket or when it is the socket of a group

Returns:

Type Description
Interface Socket

_is_list property

bool property

Returns True if socket is a list

_name property

Return the name or the label

Returns:

Type Description
str

default is ""

_panel_name property

Return the name of the panel

Returns:

Type Description
str

default is ""

curve property

Node Separate Components

Fixed values

Kind Name Value
Socket Geometry self

Returns:

Type Description
curve

grease_pencil property

Node Separate Components

Fixed values

Kind Name Value
Socket Geometry self

Returns:

Type Description
grease_pencil

id property writable

Property get node

instances property

Node Separate Components

Fixed values

Kind Name Value
Socket Geometry self

Returns:

Type Description
instances

insts instance-attribute

Instances Geometry

Note

The name of geometry class is plural : Instances when the name of the domain is singular : Instance. The named of the domain property is insts.

The Instances class exposes all methods specific to instances. Since there is no ambiguity, the word instances is omitted in the name of the methods:

realized = instances.realize() # Node 'Realize Instances'
Nodes requiring a domain parameter, are implemented in the domain insts.

Attributes:

Name Type Description
insts Instance

INSTANCES domain

is_grid property

bool property

Returns True if socket is a grid (inferred_structure_type == 'GRID').

len property

Short cut for 'self.list_length()'

material property writable

Write only property for node

material_index property writable

Property get node

mesh property

Node Separate Components

Fixed values

Kind Name Value
Socket Geometry self

Returns:

Type Description
mesh

name property writable

Write only property for node

node_color property writable

Node color

Returns:

Type Description
SysColor

node_label property writable

Node Label

Returns:

Type Description
str

offset property writable

Write only property for node

point_cloud property

Node Separate Components

Fixed values

Kind Name Value
Socket Geometry self

Returns:

Type Description
point_cloud

position property writable

Property get node

volume property

Node Separate Components

Fixed values

Kind Name Value
Socket Geometry self

Returns:

Type Description
volume

Constant(value, user_label='') classmethod

Create an input socket from a constant Node.

Parameters:

Name Type Description Default
value Any

constant default value default=None.

 required
user_label str

socket name (used to rename nodes if not None) default="".

 ''
Source code in core/socket_class.py 
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
@classmethod
def Constant(cls, value: None, user_label: str = ""):
    """ Create an input socket from a constant Node.

    Parameters
    ----------
    value : Any, optional
        constant default value default=None.

    user_label : str, optional
        socket name (used to rename nodes if not None) default="".
    """

    # ---------------------------------------------------------------------------
    # Ensure array
    # ---------------------------------------------------------------------------

    def get_shaped(v, *shapes):
        r = np.ravel(v)
        shape = np.shape(r)
        if shape in shapes:
            return tuple(r)

        if shape == (1,):
            return tuple(np.resize(r, shapes[0]))

        raise NodeError(
            f"The value <{v}> can't be transformed in a valid initial value for {SocketType.from_type(cls.SOCKET_TYPE).class_name}."
        )

    # ---------------------------------------------------------------------------
    # Does the array contain sockets
    # ---------------------------------------------------------------------------

    def has_sockets(a):
        for v in a:
            if SocketType.get_bsocket(v) is not None:
                return True
        return False

    # ---------------------------------------------------------------------------
    # Default value
    # ---------------------------------------------------------------------------

    socket_type = SocketType.from_type(cls.SOCKET_TYPE)
    if cls.SOCKET_TYPE not in ['RGBA', 'VECTOR', 'ROTATION', 'MATRIX']:
        def_val = socket_type.get_default_from_value(value)

    # ---------------------------------------------------------------------------
    # Depending on the socket type
    # ---------------------------------------------------------------------------

    if cls.SOCKET_TYPE == 'BOOLEAN':
        return Node('Boolean', boolean=def_val)._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'BUNDLE':
        return Node("Combine Bundle")._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'CLOSURE':
        socket = ZoneNode.Closure().closure
        socket._use_layout = False
        return socket._ul(user_label)

    elif cls.SOCKET_TYPE == 'COLLECTION':
        return Node('Collection', collection=def_val)._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'RGBA':

        if value is None:
            a = (0, 0, 0, 1)
        elif isinstance(value, str):
            #a = colors.to_color(value)
            a = SysColor(value).rgba
        else:
            a = get_shaped(value, (4,), (3,))

        if has_sockets(a):
            if Tree.is_geonodes():
                node = Node('Combine Color', {0: a[0], 1: a[1], 2:a[2]})
                if len(a) == 4:
                    node.alpha = a[3]
                return node._out._ul(user_label)
            else:
                return Node('Combine Color', {0: a[0], 1: a[1], 2:a[2]})._out._ul(user_label)

        else:
            def_val = SocketType.from_type('COLOR').get_default_from_value(a)
            if Tree.is_geonodes():
                return Node('Color', value=def_val)._out._ul(user_label)

            else:
                socket = Node('Color')._out
                socket._bsocket.default_value = def_val
                return socket._ul(user_label)

    elif cls.SOCKET_TYPE == 'IMAGE':
        return Node('Image', image=def_val)._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'INT':
        return Node('Integer', integer=def_val)._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'MATERIAL':
        return Node('Material', material=def_val)._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'MATRIX':

        if value is None:
            a = (1, 0, 0, 0,   0, 1, 0, 0,   0, 0, 1, 0,   0, 0, 0, 1)
        else:
            a = get_shaped(value, (16,))

        return Node('Combine Matrix', named_sockets = {i: a[i] for i in range(16)})._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'MENU':
        if True: # V5.2
            from .generated.static_nd import ND
            return ND.menu(value)
            #return Node('Menu', value=value)._out._ul(user_label)
        else:
            return Node('Menu Switch')._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'OBJECT':
        return Node('Object', object=def_val)._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'FONT':
        if True: # V5.2
            return Node('Font', font=def_val)._out._ul(user_label)
        else:
            return cls.NewInput("Font", value)

    elif cls.SOCKET_TYPE == 'ROTATION':

        if value is None:
            a = (0, 0, 0)
        else:
            a = get_shaped(value, (3,))

        if has_sockets(a):
            return Node('Combine XYZ', x=a[0], y=a[1], z=a[2])._out.to_rotation()._ul(user_label)
        else:
            return Node('Rotation', rotation_euler=a)._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'STRING':
        return Node('String', string=def_val)._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'VALUE':
        node = Node('Value')
        node._bnode.outputs[0].default_value = def_val
        return node._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'VECTOR':

        if value is None:
            a = (0, 0, 0)
        else:
            a = get_shaped(value, (3,))

        if has_sockets(a):
            return Node('Combine XYZ', x=a[0], y=a[1], z=a[2])._out._ul(user_label)
        else:
            return Node('Vector', vector=a)._out._ul(user_label)

    elif cls.SOCKET_TYPE == 'GEOMETRY':
        raise NodeError(f"There is no node to create a Geometry. Use explicit constructors such as 'Mesh.Cube()', 'Curve.Spiral()' or 'Cloud.Points().")

    else:
        assert False, f"Shouldn't happen {socket_type}"

Empty(value=None) classmethod

Create an empty socket.

An empty socket is used temporarily as an input for nodes with dynamic sockets:

Parameters:

Name Type Description Default
value Any

default value default=None.

 None
Source code in core/socket_class.py 
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
@classmethod
def Empty(cls, value = None):
    """ Create an empty socket.

    An empty socket is used temporarily as an input for nodes with dynamic sockets:

    Parameters
    ----------
    value : Any, optional
        default value default=None.

    """
    socket = cls(constants.EMPTY_SOCKET)
    socket._bsocket = SocketType.from_type(cls.SOCKET_TYPE).get_default_from_value(value)
    return socket

FromGeometry(*geometry) classmethod

Node Geometry to Instance

Parameters:

Name Type Description Default
geometry Geometry

socket 'Geometry' (id: Geometry)

 ()

Returns:

Type Description
Instances
Source code in core/generated/instances.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
@classmethod
def FromGeometry(cls, *geometry: Geometry):
    """ > Node Geometry to Instance

    Parameters
    ----------
    geometry : Geometry, optional
        socket 'Geometry' (id: Geometry)


    Returns
    -------
    Instances
    """
    node = Node('Geometry to Instance', {'Geometry': list(geometry)})
    return cls(node._out)

ImportOBJ(path=None) classmethod

Node Import OBJ

Parameters:

Name Type Description Default
path String

socket 'Path' (id: Path)

 None

Returns:

Type Description
Instances
Source code in core/generated/instances.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
@classmethod
def ImportOBJ(cls, path: String = None):
    """ > Node Import OBJ

    Parameters
    ----------
    path : String, optional
        socket 'Path' (id: Path)


    Returns
    -------
    Instances
    """
    node = Node('Import OBJ', {'Path': path})
    return cls(node._out)

IndexSwitch(*values, index=None, default_index=0) classmethod

Node Index Switch

with GeoNodes("IndexSwitch demo"):

    # Create some geometries
    geo    = Geometry()
    cube   = Mesh.Cube()
    sphere = Mesh.IcoSphere()
    cone   = Mesh.Cone()

    # Pick in this list
    pick_geo = Geometry.IndexSwitch(geo, cube, sphere, cone, index=tree.new_input("Geometry index", default_value=2))

    # Plug the result to the output
    pick_geo.out()

Parameters:

Name Type Description Default
*values Any

List of Sockets to select into

 ()
index Integer

socket 'Index' (Index) default=None.

 None
default_index int

default idex default=0.

 0

Returns:

Type Description
Socket
Source code in core/socket_class.py 
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
@classmethod
def IndexSwitch(cls, *values, index = None, default_index: int = 0):
    """ > Node Index Switch

    ``` python
    with GeoNodes("IndexSwitch demo"):

        # Create some geometries
        geo    = Geometry()
        cube   = Mesh.Cube()
        sphere = Mesh.IcoSphere()
        cone   = Mesh.Cone()

        # Pick in this list
        pick_geo = Geometry.IndexSwitch(geo, cube, sphere, cone, index=tree.new_input("Geometry index", default_value=2))

        # Plug the result to the output
        pick_geo.out()
    ```

    Parameters
    ----------
    *values : Any
        List of Sockets to select into

    index : Integer, optional
        socket 'Index' (Index) default=None.

    default_index : int, optional
        default idex default=0.


    Returns
    -------
    Socket
    """
    node = Node('Index Switch', 
                    {str(i): value for i, value in enumerate(values)}, 
                    data_type=cls.SOCKET_TYPE, 
                    Index=index)
    return cls(node._out)

Input(name, panel='', halt=True) classmethod

Get an exist input socket from its name and panel.

Note

The "input" socket here is an "output" socket of the current input node

To create a input socket use NewInput.

If the 'name' argument is None, the first socket of the proper type is returned.

Raises:

Type Description
- NodeError if socket is not found and halt is requested

Parameters:

Name Type Description Default
name str | None

socket name

 required
panel str

panel name default="".

 ''
halt bool

raises an error if not found default=True.

 True

Returns:

Type Description
Socket
Source code in core/socket_class.py 
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
@classmethod
def Input(cls, name: str, panel: str = "", halt: bool = True):
    """ Get an exist input socket from its name and panel.

    !!! note
        The "input" socket here is an "output" socket of the current input node

    To create a input socket use NewInput.

    If the 'name' argument is None, the first socket of the proper type is returned.

    Raises
    ------
    - NodeError if socket is not found and halt is requested

    Parameters
    ----------
    name : str | None
        socket name

    panel : str, optional
        panel name default="".

    halt : bool, optional
        raises an error if not found default=True.


    Returns
    -------
    Socket
    """
    in_node = Tree.current_tree().get_input_node()

    include = None if name is None else [name]
    bsockets = in_node.get_sockets('OUTPUT', include=include, panel=panel)

    for _, bsock in bsockets:
        if SocketType(bsock).type == cls.SOCKET_TYPE: # and utils.snake_case(sock_name) == utils.snake_case(name):
            return cls(bsock._bsocket)._ul(name)

    if halt:
        sname = "" if name is None else f" named '{name}'"
        raise NodeError(
            f"There is no {SocketType.from_type(cls.SOCKET_TYPE).class_name} input socket{sname}.\n"
            f"Available sockets are : {[bsock[0] for bsock in in_node.get_sockets('OUTPUT')]}.")

    return None

Join(*geometry) classmethod

Node Join Geometry

Parameters:

Name Type Description Default
geometry Geometry

socket 'Geometry' (id: Geometry)

 ()

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
@classmethod
def Join(cls, *geometry: Geometry):
    """ > Node Join Geometry

    Parameters
    ----------
    geometry : Geometry, optional
        socket 'Geometry' (id: Geometry)


    Returns
    -------
    Geometry
    """
    node = Node('Join Geometry', {'Geometry': list(geometry)})
    return cls(node._out)

List(*items, name='') classmethod

Create a Blender List from items.

Parameters:

Name Type Description Default
items Any

Items to put in the list.

 ()
name str

socket name default="".

 ''

Returns:

Type Description
- Socket List
Source code in core/socket_class.py 
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
@classmethod
def List(cls, *items, name: str = ""):
    """ Create a Blender List from items.

    Parameters
    ----------
    items : Any, optional
        Items to put in the list.

    name : str, optional
        socket name  default="".

    Returns
    -------
    - Socket List
    """

    from .sock_closure import Closure
    from .sock_integer import Integer

    with Closure() as cl:

        idx = Integer(0, "Index")

        if True:
            value = cls.IndexSwitch(*items, index=idx)
        else:
            with cls.IndexSwitch(index=idx) as value:
                for item in items:
                    cls(item).out()

        if name == "":
            name = cls.__name__
        value.out(name)

    return cls(cl.to_list(count=len(items)))

MenuSwitch(named_sockets={}, default_menu=None, **sockets) classmethod

Node Menu Switch

The items of the Menu Switch node are provided in the 'items' dict.

Parameters:

Name Type Description Default
named_sockets dict

sockets to create default={}.

 {}
default_menu str

default menu value default=None.

 None
sockets dict

items

 {}

Returns:

Type Description
Socket
Source code in core/socket_class.py 
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
@classmethod
def MenuSwitch(cls, 
               named_sockets    : dict = {},
               default_menu     : str = None,
               **sockets):
    """ > Node Menu Switch

    The items of the Menu Switch node are provided in the 'items' dict.

    Parameters
    ----------
    named_sockets : dict, optional
        sockets to create default={}.

    default_menu : str, optional
        default menu value default=None.

    sockets : dict
        items


    Returns
    -------
    Socket
    """
    node = Node('Menu Switch',
            named_sockets = named_sockets,
            data_type = SocketType.from_type(cls.SOCKET_TYPE).type,
            #default_menu = default_menu,
            **sockets)
    node._default_menu = default_menu

    return cls(node._out)

Named(name) classmethod

Node Named Attribute

Information
  • Parameter 'data_type' : 'BOOLEAN'

Parameters:

Name Type Description Default
name String

socket 'Name' (id: Name)

 required

Returns:

Type Description
Boolean
Source code in core/socket_class.py 
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
@classmethod
def Named(cls, name):
    """ > Node Named Attribute

    Information
    -----------
    - Parameter 'data_type' : 'BOOLEAN'

    Parameters
    ----------
    name : String
        socket 'Name' (id: Name)


    Returns
    -------
    Boolean
    """
    if SocketType.from_type(cls.SOCKET_TYPE).class_name not in constants.ATTRIBUTE_CLASSES:
        raise NodeError(
            f"The class {SocketType.from_type(cls.SOCKET_TYPE).class_name} is not an attribute.\n"
            f"Attribute classes are: {constants.ATTRIBUTE_CLASSES}")

    node = Node('Named Attribute', name=name)
    data_type = SocketType.from_type(cls.SOCKET_TYPE).get_node_data_type(
        tree_type = node._tree._btree.bl_idname,
        bl_idname = node._bnode.bl_idname,
        halt = True)

    node.set_parameter('data_type', data_type)

    return node._out._ul(name)

NewInput(name, value=None, tip='', panel='', **props) classmethod

Create an new input socket

Note

The "input" socket here is an "output" socket of the current input node

To get an existing input socket use Input.

Raises:

Type Description
- NodeError if socket is not found

Parameters:

Name Type Description Default
name str

socket name

 required
value Any

default_value default=None.

 None
tip str

description default="".

 ''
panel str: None

panel name

 ''

Returns:

Type Description
Socket
Source code in core/socket_class.py 
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
@classmethod
def NewInput(cls,
        name: str, 
        value       = None, 
        tip: str    = "", 
        panel: str  = "", 
        **props):
    """ Create an new input socket

    !!! note
        The "input" socket here is an "output" socket of the current input node

    To get an existing input socket use Input.

    Raises
    ------
    - NodeError if socket is not found

    Parameters
    ----------
    name : str
        socket name

    value : Any, optional
        default_value default=None.

    tip : str, optional
        description default="".

    panel : str: None
        panel name


    Returns
    -------
    Socket
    """
    if value is None:
        defval = None
    else:
        defval = SocketType.from_type(cls.SOCKET_TYPE).get_default_from_value(value)
        new_props = {**props}

        if 'default' in new_props:
            new_props['default'] = defval

        elif 'default_value' in new_props:
            new_props['default_value'] = defval

        else:
            if 'default' not in constants.SOCKETS[cls.SOCKET_TYPE]['props']:
                raise NodeError(f"The {SocketType.from_type(cls.SOCKET_TYPE).class_name} socket doesn't accept a default value. Value argument <{value}> is invalid.")

            new_props['default_value'] = defval

        props = new_props

    return cls(Tree.current_tree().create_input_socket(
        SocketType.from_type(cls.SOCKET_TYPE).socket_id,
        name         = name,
        tip          = tip,
        panel        = panel,
        **props))

Out(value, name=None, panel='', **props) classmethod

Send a value to the current group or zone output.

Constants are assigned directly to the output node's input, without creating a constant node. Socket.Out infers the type; subclasses such as Float.Out explicitly select the output type.

Socket.Out(3.14, "Pi")
Float.Out(1, "Factor")
Socket.Out(value, "Result")

Parameters:

Name Type Description Default
value Any

Constant or socket to output.

 required
name str

Output socket name.

 None
panel str

Output panel.

 ''
**props

Properties used when creating the output socket.

 {}

Returns:

Type Description
None
Source code in core/socket_class.py 
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
@classmethod
def Out(cls, value, name: str = None, panel: str = "", **props):
    """Send a value to the current group or zone output.

    Constants are assigned directly to the output node's input, without
    creating a constant node. Socket.Out infers the type; subclasses such
    as Float.Out explicitly select the output type.

    ``` python
    Socket.Out(3.14, "Pi")
    Float.Out(1, "Factor")
    Socket.Out(value, "Result")
    ```

    Parameters
    ----------
    value : Any
        Constant or socket to output.
    name : str, optional
        Output socket name.
    panel : str, optional
        Output panel.
    **props
        Properties used when creating the output socket.

    Returns
    -------
    None
    """
    tree = Tree.current_tree()
    if tree is None:
        raise NodeError("Socket.Out requires an active tree.")

    if isinstance(value, Socket):
        value._is_empty(f"Impossible to link an empty socket (name: '{name}').")

    out_node = tree.get_output_node()
    if cls.SOCKET_TYPE is None:
        if name is None and utils.get_bsocket(value) is None:
            name = SocketType(value).class_name
        out_node.set_input_socket(name=name, value=value, create=True, panel=panel, **props)
        return

    socket_type = SocketType.from_type(cls.SOCKET_TYPE)
    full_name = None if name is None else (ItemPath(panel) + name).path
    socket = out_node.get_socket('INPUT', full_name, socket_type,
                                 free_only=True, halt=False)
    if socket is None:
        if name is None:
            name = socket_type.class_name
        socket = out_node.create_socket('INPUT', socket_type, name=name, panel=panel, **props)
    out_node.set_input_socket_value(socket, value)

Switch(condition=None, false=None, true=None) classmethod

Node Switch

with GeoNodes("Switch demo"):

    # Two possible geometries
    cube   = Mesh.Cube()
    sphere = Mesh.IcoSphere()

    # Select
    geo = Geometry.Switch(Boolean(True, "Use Sphere"), cube, sphere)

    # To group output
    geo.out()

Parameters:

Name Type Description Default
condition Boolean

socket 'Switch' (Switch)

 None
false

socket 'False' (False)

 None
true

socket 'True' (True)

 None

Returns:

Type Description
Socket

Socket wrapped in the calling class (for example, Mesh.Switch returns Mesh).
Source code in core/socket_class.py 
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
@classmethod
def Switch(cls, condition=None, false=None, true=None):
    """ > Node Switch

    ``` python
    with GeoNodes("Switch demo"):

        # Two possible geometries
        cube   = Mesh.Cube()
        sphere = Mesh.IcoSphere()

        # Select
        geo = Geometry.Switch(Boolean(True, "Use Sphere"), cube, sphere)

        # To group output
        geo.out()
    ```

    Parameters
    ----------
    condition : Boolean
        socket 'Switch' (Switch)

    false
        socket 'False' (False)

    true
        socket 'True' (True)


    Returns
    -------
    Socket
        Socket wrapped in the calling class (for example, Mesh.Switch returns Mesh).
    """
    input_type = SocketType.from_type(cls.SOCKET_TYPE).items_type
    node = Node('Switch', {'Switch': condition, 'False': false, 'True': true}, input_type=input_type)
    return cls(node._out)

__init__(value=None, name=None, tip='', panel='', **props)

Socket of type 'GEOMETRY'.

If value is None, a Group Input socket of type Geometry is created. When a Group Input socket is created, default name 'Geometry' is used if name argument is None.

geometry = Geometry() # Default group input geometry
geometry = Geometry(name="Mesh") # Input group geometry

Parameters:

Name Type Description Default
value Socket

initial value default=None.

 None
name str

Create an Group Input socket with the provided str default=None.

 None
tip str

Property description

 ''
panel str

Panel name default="".

 ''
props dict

input properties

 {}
Source code in core/geometry_class.py 
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def __init__(self,
    value               : Socket = None, 
    name                : str = None,
    tip                 : str = '',
    panel               : str = "",
    **props,
):
    """ Socket of type 'GEOMETRY'.

    If value is None, a Group Input socket of type Geometry is created.
    When a Group Input socket is created, default name 'Geometry' is used if name argument is None.

    ``` python
    geometry = Geometry() # Default group input geometry
    geometry = Geometry(name="Mesh") # Input group geometry
    ```

    Parameters
    ----------
    value : Socket, optional
        initial value default=None.

    name : str, optional
        Create an Group Input socket with the provided str default=None.

    tip : str, default=''
        Property description

    panel : str, optional
        Panel name default="".

    props : dict
        input properties

    """
    # ---------------------------------------------------------------------------
    # Geom interface
    # ---------------------------------------------------------------------------

    self._geo       = self
    self._selection = None

    super().__init__(value, name=name, tip=tip, panel=panel, **props)

_create_input_socket(name='Geometry', tip='', panel='', optional_label=False, hide_value=False, hide_in_modifier=False) classmethod

Geometry Input

New Geometry input with subtype 'NONE'.

Parameters:

Name Type Description Default
name str

Input socket name

 `Geometry`
tip str

Property description

 `''`
panel str

Panel name

 ``
optional_label bool

Property optional_label

 `False`
hide_value bool

Property hide_value

 `False`
hide_in_modifier bool

Property hide_in_modifier

 `False`

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
@classmethod
def _create_input_socket(cls,
    name: str = 'Geometry',
    tip: str = '',
    panel: str = "",
    optional_label: bool = False,
    hide_value: bool = False,
    hide_in_modifier: bool = False,
     ):
    """ > Geometry Input

    New Geometry input with subtype 'NONE'.

    Parameters
    ----------
    name : str, default=`Geometry`
        Input socket name

    tip : str, default=`''`
        Property description

    panel : str, default=``
        Panel name

    optional_label : bool, default=`False`
        Property optional_label

    hide_value : bool, default=`False`
        Property hide_value

    hide_in_modifier : bool, default=`False`
        Property hide_in_modifier


    Returns
    -------
    Geometry
    """
    from ..treeclass import Tree

    return Tree.current_tree().create_input_socket('NodeSocketGeometry', name=name, tip=tip,
        panel=panel, optional_label=optional_label, hide_value=hide_value,
        hide_in_modifier=hide_in_modifier)

_get_bsocket_from_input(name=None)

Get the availble input socket if any.

The socket is get a an OUTPUT socket of the current input.

Parameters:

Name Type Description Default
name str

name filter default=None.

 None

Returns:

Type Description
Socket

or None if not found
Source code in core/socket_class.py 
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
def _get_bsocket_from_input(self, name: str = None) -> bpy.types.NodeSocket:
    """ Get the availble input socket if any.

    The socket is get a an OUTPUT socket of the current input.

    Parameters
    ----------
    name : str, optional
        name filter default=None.


    Returns
    -------
    Socket
        or None if not found

    """
    in_node = self._tree.get_input_node()

    include = None if name is None else [name]

    bsockets = in_node.get_sockets('OUTPUT', include=include)
    for _, bsock in bsockets:
        if SocketType(bsock).type == self.SOCKET_TYPE:
            return bsock._bsocket
    else:
        return None

_jump(socket, reset=True)

Change the wrapped output socket

When changing the socket, the description is copied to the new socket. The node color, if any, is also propagated.

Parameters:

Name Type Description Default
socket NodeSocket

the new output socket to jump to

 required
reset bool

reset the cache default=True.

 True

Returns:

Type Description
self
Source code in core/socket_class.py 
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
def _jump(self, socket: bpy.types.NodeSocket, reset: bool = True):
    """ Change the wrapped output socket

    When changing the socket, the description is copied to the new socket.
    The node color, if any, is also propagated.

    Parameters
    ----------
    socket : bpy.types.NodeSocket
        the new output socket to jump to

    reset : bool, optional
        reset the cache default=True.


    Returns
    -------
    self
    """

    # Keep user label stored in socket description
    user_label = self.user_label

    bsocket = utils.get_bsocket(socket)
    if bsocket is None:
        raise NodeError(f"Socket error: Impossible to jump to socket {socket}")

    self._bsocket = bsocket
    if reset:
        self._reset()

    # Restore user label
    self.user_label = user_label

    return self

_lc(label=None, color=None)

Set node label and color.

This method returns self to be chained to as socket:

with GeoNodes("Node label and color"):
    Geometry().out()

    a = Float(10)._lc("Var a")
    b = Float(10)._lc("Var b")
    c = (a + b)._lc("a + b", (1, 0, 0))

Parameters:

Name Type Description Default
label str

node label default=None.

 None
color SysColor

node color default=None.

 None

Returns:

Type Description
self
Source code in core/socket_class.py 
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
def _lc(self, label: str = None, color: SysColor = None):
    """ Set node label and color.

    This method returns self to be chained to as socket:

    ``` python
    with GeoNodes("Node label and color"):
        Geometry().out()

        a = Float(10)._lc("Var a")
        b = Float(10)._lc("Var b")
        c = (a + b)._lc("a + b", (1, 0, 0))
    ```

    Parameters
    ----------
    label : str, optional
        node label default=None.

    color : SysColor, optional
        node color default=None.


    Returns
    -------
    self
    """

    if self.node._bnode.bl_idname == 'NodeGroupInput':
        return self

    self.node_label = label
    self.node_color = color
    self.user_label = label

    return self

_ul(label)

Set the user label

Parameters:

Name Type Description Default
label str

the label to append

 required

Returns:

Type Description
self
Source code in core/socket_class.py 
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
def _ul(self, label : str):
    """ Set the user label

    Parameters
    ----------
    label : str
        the label to append


    Returns
    -------
    self
    """
    self.user_label = label
    return self

add_method(name=None, jump=False, ret_class=None, **fixed)

Add the current tree as a method of the Socket class.

Important

The socket instance must be an input socket of the Tree. This input plays the role of self argument.

with GeoNodes("Translate"):
    geo = Geometry()
    v = Vector(0, "Translation)
    geo.transform(translation=v)

    geo.add_method(jump=True)

Once the modifier completed, it can be called as a method of geometry geo.translate(translation=(1, 2, 3))

Parameters:

Name Type Description Default
name str

replace the default name which is the snake case version of the group name default=None.

 None
ret_class type

transtype the default node output default=None.

 None
jump bool

the calling socket jumps to the node outpus after the call default=False.

 False
ret_class type

transtype the result with this class if not None default=None.

 None
Source code in core/socket_class.py 
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
def add_method(self, name: str = None, jump: bool = False, ret_class: type = None, **fixed):
    """ Add the current tree as a method of the Socket class.

    !!! important

        The socket instance must be an input socket of the Tree. This input plays the role of
        self argument.

    ``` python
    with GeoNodes("Translate"):
        geo = Geometry()
        v = Vector(0, "Translation)
        geo.transform(translation=v)

        geo.add_method(jump=True)
    ```

    Once the modifier completed, it can be called as a method of geometry ```geo.translate(translation=(1, 2, 3))```

    Parameters
    ----------
    name : str, optional
        replace the default name which is the snake case version of the group name default=None.

    ret_class : type, optional
        transtype the default node output default=None.

    jump : bool, optional
        the calling socket jumps to the node outpus after the call default=False.

    ret_class : type, optional
        transtype the result with this class if not None default=None.

    """

    if self.node._bnode.bl_idname != 'NodeGroupInput':
        raise NodeError(
            f"'add_method' can be called only from a 'Group Input' socket. "
            "This socket is used a 'self' argument when calling the method of {type(self).__name__}.")

    tree = Tree.current_tree()

    # ---------------------------------------------------------------------------
    # Method Body
    # ---------------------------------------------------------------------------

    socket_rank = self.node._outputs.get_socket_rank(self)
    socket_name = utils.snake_case(self._bsocket.name)


    def call(self_, *args, **kwargs):
        node = Group(tree._btree.name)
        if socket_rank >= len(args):
            new_args = args
            new_kwargs = {socket_name: self_, **kwargs}
        else:
            new_args = args[:socket_rank] + (self_,) + args[socket_rank:]
            new_kwargs = kwargs

        res = node.method_call(*new_args, ret_class=ret_class, **new_kwargs, **fixed)

        if jump:
            return self_._jump(res)
        else:
            return res

    # ---------------------------------------------------------------------------
    # Add the method to the class
    # ---------------------------------------------------------------------------

    if name is None:
        name = tree._btree.name[len(tree._prefix):].strip()
        name = utils.snake_case(name)

    class_ = type(self)
    if name in dir(class_):
        print(f"CAUTION: the method '{name}' (implementing group '{tree._btree.name}') already exists in class {class_}.")

    setattr(class_, name, call)

bake(**kwargs)

Node Bake

[&JUMP]

Returns:

Type Description
Geometry

self
Source code in core/geometry_class.py 
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
def bake(self, **kwargs):
    """ Node Bake

    [&JUMP]

    Returns
    -------
    Geometry
        self

    """

    node = Node('Bake', {'Geometry': self})

    items = node._bnode.bake_items
    for name, value in kwargs.items():
        items.new(utils.get_value_socket_type(value), name)

    return self._jump(node._out)

bounding_box(use_radius=None)

Node Bounding Box

Fixed values

Kind Name Value
Socket Geometry self

Parameters:

Name Type Description Default
use_radius Boolean

socket 'Use Radius' (id: Use Radius)

 None

Returns:

Type Description
Mesh

peer sockets: min_ (Vector), max_ (Vector)
Source code in core/generated/geometry.py 
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
def bounding_box(self, use_radius: Boolean = None):
    """ > Node Bounding Box

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |

    Parameters
    ----------
    use_radius : Boolean, optional
        socket 'Use Radius' (id: Use Radius)


    Returns
    -------
    Mesh
        peer sockets: min_ (Vector), max_ (Vector)

    """
    node = Node('Bounding Box', {'Geometry': self, 'Use Radius': use_radius})
    return node._out

cluster_by_connected(selection=None, position=None, distance=None) classmethod

Node Cluster by Connected

Parameters:

Name Type Description Default
selection Boolean

socket 'Selection' (id: Selection)

 None
position Vector

socket 'Position' (id: Position)

 None
distance Float

socket 'Distance' (id: Distance)

 None

Returns:

Type Description
Integer
Source code in core/generated/geometry.py 
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
@classmethod
def cluster_by_connected(cls,
                selection: Boolean = None,
                position: Vector = None,
                distance: Float = None):
    """ > Node Cluster by Connected

    Parameters
    ----------
    selection : Boolean, optional
        socket 'Selection' (id: Selection)

    position : Vector, optional
        socket 'Position' (id: Position)

    distance : Float, optional
        socket 'Distance' (id: Distance)


    Returns
    -------
    Integer
    """
    node = Node('Cluster by Connected', {'Selection': selection, 'Position': position, 'Distance': distance})
    return node._out

cluster_by_distance(selection=None, group_id=None, position=None, distance=None) classmethod

Node Cluster by Distance

Parameters:

Name Type Description Default
selection Boolean

socket 'Selection' (id: Selection)

 None
group_id Integer

socket 'Group ID' (id: Group ID)

 None
position Vector

socket 'Position' (id: Position)

 None
distance Float

socket 'Distance' (id: Distance)

 None

Returns:

Type Description
Integer
Source code in core/generated/geometry.py 
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
@classmethod
def cluster_by_distance(cls,
                selection: Boolean = None,
                group_id: Integer = None,
                position: Vector = None,
                distance: Float = None):
    """ > Node Cluster by Distance

    Parameters
    ----------
    selection : Boolean, optional
        socket 'Selection' (id: Selection)

    group_id : Integer, optional
        socket 'Group ID' (id: Group ID)

    position : Vector, optional
        socket 'Position' (id: Position)

    distance : Float, optional
        socket 'Distance' (id: Distance)


    Returns
    -------
    Integer
    """
    node = Node('Cluster by Distance', {'Selection': selection, 'Group ID': group_id, 'Position': position, 'Distance': distance})
    return node._out

convex_hull()

Node Convex Hull

Fixed values

Kind Name Value
Socket Geometry self

Returns:

Type Description
Mesh
Source code in core/generated/geometry.py 
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
def convex_hull(self):
    """ > Node Convex Hull

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |

    Returns
    -------
    Mesh
    """
    node = Node('Convex Hull', {'Geometry': self})
    return node._out

domain_size()

Node Domain Size

Fixed values

Kind Name Value
Socket Geometry self
Parameter component 'INSTANCES'

Returns:

Type Description
Integer
Source code in core/generated/instances.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def domain_size(self):
    """ > Node Domain Size

    **Fixed values**

    | Kind      | Name        | Value         |
    | --------- | ----------- | ------------- |
    | Socket    | Geometry    | `self`        |
    | Parameter | `component` | `'INSTANCES'` |

    Returns
    -------
    Integer
    """
    node = self._cache('Domain Size', {'Geometry': self}, component='INSTANCES')
    return node._out

enable_output(enable=None)

Node Enable Output

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Value self
Parameter data_type 'GEOMETRY'

Parameters:

Name Type Description Default
enable Boolean

socket 'Enable' (id: Enable)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
def enable_output(self, enable: Boolean = None):
    """ > Node Enable Output

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind      | Name        | Value        |
    | --------- | ----------- | ------------ |
    | Socket    | Value       | `self`       |
    | Parameter | `data_type` | `'GEOMETRY'` |

    Parameters
    ----------
    enable : Boolean, optional
        socket 'Enable' (id: Enable)


    Returns
    -------
    Geometry
    """
    node = Node('Enable Output', {'Enable': enable, 'Value': self}, data_type='GEOMETRY')
    self._jump(node._out)
    return self._domain_to_geometry

field_to_list(count, **values)

Node Field to List

Create a list from this field and named lists from additional fields.

Parameters:

Name Type Description Default
count Integer

Number of items in each generated list.

 required
values dict

Named fields to evaluate. Each field creates an output socket with the same name.

 {}

Returns:

Type Description
Socket

First list output. The other outputs are available from its node or as peer sockets.
Source code in core/socket_class.py 
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
def field_to_list(self, count, **values):
    """ > Node Field to List

    Create a list from this field and named lists from additional fields.

    Parameters
    ----------
    count : Integer
        Number of items in each generated list.

    values : dict
        Named fields to evaluate. Each field creates an output socket with
        the same name.

    Returns
    -------
    Socket
        First list output. The other outputs are available from its node
        or as peer sockets.
    """
    return Node(
        'Field to List',
        named_sockets={self._name: self},
        count=count,
        **values,
    )._out

filter_list()

Node Filter List

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket List self
Socket Selection self[selection]
Parameter socket_type 'GEOMETRY'

Returns:

Type Description
Geometry

peer sockets: inverted_ (Geometry)
Source code in core/generated/geometry.py 
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
def filter_list(self):
    """ > Node Filter List

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind      | Name          | Value             |
    | --------- | ------------- | ----------------- |
    | Socket    | List          | `self`            |
    | Socket    | Selection     | `self[selection]` |
    | Parameter | `socket_type` | `'GEOMETRY'`      |

    Returns
    -------
    Geometry
        peer sockets: inverted_ (Geometry)

    """
    node = Node('Filter List', {'List': self, 'Selection': self.get_selection()}, socket_type='GEOMETRY')
    self._jump(node._out)
    return self._domain_to_geometry

flatten_list()

Flatten one level of a rectangular nested list.

Every nested list must have the same length. This is notably the case for lists created by :meth:reshape_list. Items keep their original linear order.

values = Float.List(*range(16))
values.reshape_list((4, 4))
values.flatten_list()

Returns:

Type Description
Socket

This socket, updated to point to the flattened list.

Raises:

Type Description
NodeError

If this socket does not contain a list.
Source code in core/socket_class.py 
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
def flatten_list(self):
    """Flatten one level of a rectangular nested list.

    Every nested list must have the same length. This is notably the case
    for lists created by :meth:`reshape_list`. Items keep their original
    linear order.

    ``` python
    values = Float.List(*range(16))
    values.reshape_list((4, 4))
    values.flatten_list()
    ```

    Returns
    -------
    Socket
        This socket, updated to point to the flattened list.

    Raises
    ------
    NodeError
        If this socket does not contain a list.
    """

    if not self._is_list:
        raise NodeError(f"Socket.flatten_list error: {self} is not a list.")

    from .sock_closure import Closure
    from .sock_integer import Integer

    with Layout("Socket.flatten_list"):

        source = self
        outer_length = source.list_length()
        inner_length = source[0].list_length()

        with Closure() as cl:
            index = Integer(0, "Index")

            outer_index = index // inner_length
            inner_index = index % inner_length

            source[outer_index][inner_index].out(self._name)

        self._jump(cl.to_list(outer_length * inner_length))
        return self

get(name, data_type=None, domain=None)

Return a helper for a named attribute on this geometry.

Node Named Attribute

The returned Attribute stores the geometry, attribute name, data type and domain. No node is created until the attribute is read or written. Reading the attribute creates the node.

mesh = Mesh()
weight = mesh.get("Weight", Float, domain="Point")
field = weight.value

Parameters:

Name Type Description Default
name str

Name of the attribute.

 required
data_type type | str | value

Attribute socket type, for example Float, Integer or Vector. The default is Float.

 None
domain str | Domain

Domain on which the attribute is stored. The default is Point.

 None

Returns:

Type Description
Attribute

Named-attribute helper attached to this geometry.
Source code in core/geometry_class.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
def get(self, name, data_type=None, domain=None):
    """Return a helper for a named attribute on this geometry.

    > Node Named Attribute

    The returned Attribute stores the geometry, attribute name, data
    type and domain. No node is created until the attribute is read or
    written. Reading the attribute creates the node.

    ``` python
    mesh = Mesh()
    weight = mesh.get("Weight", Float, domain="Point")
    field = weight.value
    ```

    Parameters
    ----------
    name : str
        Name of the attribute.
    data_type : type | str | value, optional
        Attribute socket type, for example ``Float``, ``Integer`` or
        ``Vector``. The default is ``Float``.
    domain : str | Domain, optional
        Domain on which the attribute is stored. The default is ``Point``.

    Returns
    -------
    Attribute
        Named-attribute helper attached to this geometry.
    """
    from .attributes import Attribute

    attr = Attribute(name, data_type=data_type, domain=domain)
    attr.geometry = self
    return attr

get_attribute_names(data_type=None, domain=None)

Return the names of attributes available on this geometry.

Node Get Attribute Names

Supplying data_type or domain enables the corresponding filter on the node. Leaving an argument unset disables that filter.

mesh = Mesh()

names = mesh.get_attribute_names()
vector_names = mesh.get_attribute_names(Vector)
face_vectors = mesh.get_attribute_names(Vector, domain="Face")

Parameters:

Name Type Description Default
data_type type | str | value

Restrict the result to this attribute data type.

 None
domain str | Domain

Restrict the result to this geometry domain.

 None

Returns:

Type Description
String

String socket containing the matching attribute names.
Source code in core/geometry_class.py 
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
def get_attribute_names(self, data_type=None, domain=None):
    """Return the names of attributes available on this geometry.

    > Node Get Attribute Names

    Supplying ``data_type`` or ``domain`` enables the corresponding filter
    on the node. Leaving an argument unset disables that filter.

    ``` python
    mesh = Mesh()

    names = mesh.get_attribute_names()
    vector_names = mesh.get_attribute_names(Vector)
    face_vectors = mesh.get_attribute_names(Vector, domain="Face")
    ```

    Parameters
    ----------
    data_type : type | str | value, optional
        Restrict the result to this attribute data type.
    domain : str | Domain, optional
        Restrict the result to this geometry domain.

    Returns
    -------
    String
        String socket containing the matching attribute names.
    """
    from .attributes import Attribute

    _, dn = Attribute._get_geo_domain(domain)
    dt = Attribute._get_data_type(data_type)

    ok_dt = dt is not None
    ok_dn = dn is not None

    return Node("Get Attribute Names", {
        "Geometry": self,
        "Filter Data Type" : ok_dt,
        "Data Type" : dt,
        "Filter Domain" : ok_dn,
        "Domain" : dn
        })._out

get_bundle(remove=None)

Node Get Geometry Bundle

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self

Parameters:

Name Type Description Default
remove Boolean

socket 'Remove' (id: Remove)

 None

Returns:

Type Description
bundle
Source code in core/generated/geometry.py 
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
def get_bundle(self, remove: Boolean = None):
    """ > Node Get Geometry Bundle

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |

    Parameters
    ----------
    remove : Boolean, optional
        socket 'Remove' (id: Remove)


    Returns
    -------
    bundle
    """
    node = Node('Get Geometry Bundle', {'Geometry': self, 'Remove': remove})
    self._jump(node._out)
    return node.bundle

get_cloud(remove=None)

Node Get Geometry Component

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Type 'Point Cloud'

Parameters:

Name Type Description Default
remove Boolean

socket 'Remove' (id: Remove)

 None

Returns:

Type Description
Component
Source code in core/generated/geometry.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
def get_cloud(self, remove: Boolean = None):
    """ > Node Get Geometry Component

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value         |
    | ------ | -------- | ------------- |
    | Socket | Geometry | `self`        |
    | Socket | Type     | 'Point Cloud' |

    Parameters
    ----------
    remove : Boolean, optional
        socket 'Remove' (id: Remove)


    Returns
    -------
    Component
    """
    node = Node('Get Geometry Component', {'Geometry': self, 'Type': 'Point Cloud', 'Remove': remove})
    self._jump(node._out)
    return node.Component._convert_to_class('Cloud')

get_component(type=None, remove=None)

Node Get Geometry Component

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self

Parameters:

Name Type Description Default
type menu='Mesh'

('Mesh', 'Point Cloud', 'Curve', 'Instances', 'Grease Pencil', 'Volume')

 None
remove Boolean

socket 'Remove' (id: Remove)

 None

Returns:

Type Description
Geometry

peer sockets: component_ (Geometry), exists_ (Boolean)
Source code in core/generated/geometry.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def get_component(self,
                type: Literal['Mesh', 'Point Cloud', 'Curve', 'Instances', 'Grease Pencil', 'Volume'] = None,
                remove: Boolean = None):
    """ > Node Get Geometry Component

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |

    Parameters
    ----------
    type : menu='Mesh', optional
        ('Mesh', 'Point Cloud', 'Curve', 'Instances', 'Grease Pencil', 'Volume')

    remove : Boolean, optional
        socket 'Remove' (id: Remove)


    Returns
    -------
    Geometry
        peer sockets: component_ (Geometry), exists_ (Boolean)

    """
    node = Node('Get Geometry Component', {'Geometry': self, 'Type': type, 'Remove': remove})
    self._jump(node._out)
    return self._domain_to_geometry

get_curve(remove=None)

Node Get Geometry Component

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Type 'Curve'

Parameters:

Name Type Description Default
remove Boolean

socket 'Remove' (id: Remove)

 None

Returns:

Type Description
Component
Source code in core/generated/geometry.py 
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
def get_curve(self, remove: Boolean = None):
    """ > Node Get Geometry Component

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value   |
    | ------ | -------- | ------- |
    | Socket | Geometry | `self`  |
    | Socket | Type     | 'Curve' |

    Parameters
    ----------
    remove : Boolean, optional
        socket 'Remove' (id: Remove)


    Returns
    -------
    Component
    """
    node = Node('Get Geometry Component', {'Geometry': self, 'Type': 'Curve', 'Remove': remove})
    self._jump(node._out)
    return node.Component._convert_to_class('Curve')

get_grease_pencil(remove=None)

Node Get Geometry Component

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Type 'Grease Pencil'

Parameters:

Name Type Description Default
remove Boolean

socket 'Remove' (id: Remove)

 None

Returns:

Type Description
Component
Source code in core/generated/geometry.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
def get_grease_pencil(self, remove: Boolean = None):
    """ > Node Get Geometry Component

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value           |
    | ------ | -------- | --------------- |
    | Socket | Geometry | `self`          |
    | Socket | Type     | 'Grease Pencil' |

    Parameters
    ----------
    remove : Boolean, optional
        socket 'Remove' (id: Remove)


    Returns
    -------
    Component
    """
    node = Node('Get Geometry Component', {'Geometry': self, 'Type': 'Grease Pencil', 'Remove': remove})
    self._jump(node._out)
    return node.Component._convert_to_class('GreasePencil')

get_instances(remove=None)

Node Get Geometry Component

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Type 'Instances'

Parameters:

Name Type Description Default
remove Boolean

socket 'Remove' (id: Remove)

 None

Returns:

Type Description
Component
Source code in core/generated/geometry.py 
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
def get_instances(self, remove: Boolean = None):
    """ > Node Get Geometry Component

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value       |
    | ------ | -------- | ----------- |
    | Socket | Geometry | `self`      |
    | Socket | Type     | 'Instances' |

    Parameters
    ----------
    remove : Boolean, optional
        socket 'Remove' (id: Remove)


    Returns
    -------
    Component
    """
    node = Node('Get Geometry Component', {'Geometry': self, 'Type': 'Instances', 'Remove': remove})
    self._jump(node._out)
    return node.Component._convert_to_class('Instances')

get_list_item(index=None, structure_type='AUTO')

Node Get List Item

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket List self
Parameter socket_type 'GEOMETRY'

Parameters:

Name Type Description Default
index Integer

socket 'Index' (id: Index)

 None
structure_type Literal['Auto', 'Dynamic', 'Field', 'Grid', 'List', 'Single']

parameter structure_type

 'AUTO'

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
def get_list_item(self,
                index: Integer = None,
                structure_type: Literal['AUTO', 'DYNAMIC', 'FIELD', 'GRID', 'LIST', 'SINGLE'] = 'AUTO'):
    """ > Node Get List Item

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind      | Name          | Value        |
    | --------- | ------------- | ------------ |
    | Socket    | List          | `self`       |
    | Parameter | `socket_type` | `'GEOMETRY'` |

    Parameters
    ----------
    index : Integer, optional
        socket 'Index' (id: Index)

    structure_type : Literal['Auto', 'Dynamic', 'Field', 'Grid', 'List', 'Single']
        parameter `structure_type`


    Returns
    -------
    Geometry
    """
    utils.check_enum_arg('Get List Item', 'structure_type', structure_type, 'get_list_item', ('AUTO', 'DYNAMIC', 'FIELD', 'GRID', 'LIST', 'SINGLE'))
    node = Node('Get List Item', {'List': self, 'Index': index}, socket_type='GEOMETRY', structure_type=structure_type)
    self._jump(node._out)
    return self._domain_to_geometry

get_mesh(remove=None)

Node Get Geometry Component

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Type 'Mesh'

Parameters:

Name Type Description Default
remove Boolean

socket 'Remove' (id: Remove)

 None

Returns:

Type Description
Component
Source code in core/generated/geometry.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def get_mesh(self, remove: Boolean = None):
    """ > Node Get Geometry Component

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |
    | Socket | Type     | 'Mesh' |

    Parameters
    ----------
    remove : Boolean, optional
        socket 'Remove' (id: Remove)


    Returns
    -------
    Component
    """
    node = Node('Get Geometry Component', {'Geometry': self, 'Type': 'Mesh', 'Remove': remove})
    self._jump(node._out)
    return node.Component._convert_to_class('Mesh')

get_point_cloud(remove=None)

Node Get Geometry Component

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Type 'Point Cloud'

Parameters:

Name Type Description Default
remove Boolean

socket 'Remove' (id: Remove)

 None

Returns:

Type Description
Component
Source code in core/generated/geometry.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
def get_point_cloud(self, remove: Boolean = None):
    """ > Node Get Geometry Component

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value         |
    | ------ | -------- | ------------- |
    | Socket | Geometry | `self`        |
    | Socket | Type     | 'Point Cloud' |

    Parameters
    ----------
    remove : Boolean, optional
        socket 'Remove' (id: Remove)


    Returns
    -------
    Component
    """
    node = Node('Get Geometry Component', {'Geometry': self, 'Type': 'Point Cloud', 'Remove': remove})
    self._jump(node._out)
    return node.Component._convert_to_class('Cloud')

get_volume(remove=None)

Node Get Geometry Component

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Type 'Volume'

Parameters:

Name Type Description Default
remove Boolean

socket 'Remove' (id: Remove)

 None

Returns:

Type Description
Component
Source code in core/generated/geometry.py 
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
def get_volume(self, remove: Boolean = None):
    """ > Node Get Geometry Component

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value    |
    | ------ | -------- | -------- |
    | Socket | Geometry | `self`   |
    | Socket | Type     | 'Volume' |

    Parameters
    ----------
    remove : Boolean, optional
        socket 'Remove' (id: Remove)


    Returns
    -------
    Component
    """
    node = Node('Get Geometry Component', {'Geometry': self, 'Type': 'Volume', 'Remove': remove})
    self._jump(node._out)
    return node.Component._convert_to_class('Volume')

implicit_conversion(socket_idname='NodeSocketColor')

Node Implicit Conversion

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Value self
Parameter data_type 'GEOMETRY'

Parameters:

Name Type Description Default
socket_idname str

parameter socket_idname

 'NodeSocketColor'

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
def implicit_conversion(self, socket_idname = 'NodeSocketColor'):
    """ > Node Implicit Conversion

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind      | Name        | Value        |
    | --------- | ----------- | ------------ |
    | Socket    | Value       | `self`       |
    | Parameter | `data_type` | `'GEOMETRY'` |

    Parameters
    ----------
    socket_idname : str
        parameter `socket_idname`


    Returns
    -------
    Geometry
    """
    node = Node('Implicit Conversion', {'Value': self}, data_type='GEOMETRY', socket_idname=socket_idname)
    self._jump(node._out)
    return self._domain_to_geometry

index()

Node Index

Returns:

Type Description
Integer
Source code in core/generated/geometry.py 
328
329
330
331
332
333
334
335
336
337
@utils.classproperty
def index(cls):
    """ > Node Index

    Returns
    -------
    Integer
    """
    node = Node('Index', )
    return node._out

index_of_nearest(position=None, group_id=None) classmethod

Node Index of Nearest

Parameters:

Name Type Description Default
position Vector

socket 'Position' (id: Position)

 None
group_id Integer

socket 'Group ID' (id: Group ID)

 None

Returns:

Type Description
Integer

peer sockets: has_neighbor_ (Boolean)
Source code in core/generated/geometry.py 
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
@classmethod
def index_of_nearest(cls, position: Vector = None, group_id: Integer = None):
    """ > Node Index of Nearest

    Parameters
    ----------
    position : Vector, optional
        socket 'Position' (id: Position)

    group_id : Integer, optional
        socket 'Group ID' (id: Group ID)


    Returns
    -------
    Integer
        peer sockets: has_neighbor_ (Boolean)

    """
    node = Node('Index of Nearest', {'Position': position, 'Group ID': group_id})
    return node._out

index_switch(*values, index=None, default_index=0)

Node Index Switch

with GeoNodes("index_switch demo") as tree:

    # Create some geometries
    geo    = Geometry()
    cube   = Mesh.Cube()
    sphere = Mesh.IcoSphere()
    cone   = Mesh.Cone()

    # Pick in this list
    pick_geo = geo.index_switch(cube, sphere, cone, index=tree.new_input("Geometry index", default_value=2))

    # Plug the result to the output
    pick_geo.out()

Parameters:

Name Type Description Default
*values Any

List of Sockets to select into

 ()
index Integer

socket 'Index' (Index)

 None
default_index int

default idex

 0

Returns:

Type Description
Socket
Source code in core/socket_class.py 
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
def index_switch(self, *values, index = None, default_index: int = 0):
    """ > Node Index Switch

    ``` python
    with GeoNodes("index_switch demo") as tree:

        # Create some geometries
        geo    = Geometry()
        cube   = Mesh.Cube()
        sphere = Mesh.IcoSphere()
        cone   = Mesh.Cone()

        # Pick in this list
        pick_geo = geo.index_switch(cube, sphere, cone, index=tree.new_input("Geometry index", default_value=2))

        # Plug the result to the output
        pick_geo.out()
    ```

    Parameters
    ----------
    *values : Any
        List of Sockets to select into

    index : Integer, optional
        socket 'Index' (Index)

    default_index : int, default=0
        default idex

    Returns
    -------
    Socket
    """
    return self.IndexSwitch(self, *values, index=index, default_index=default_index)

instance_on_points(instance=None, pick_instance=None, instance_index=None, rotation=None, scale=None)

Node Instance on Points

Fixed values

Kind Name Value
Socket Points self
Socket Selection self[selection]

Parameters:

Name Type Description Default
instance Instances

socket 'Instance' (id: Instance)

 None
pick_instance Boolean

socket 'Pick Instance' (id: Pick Instance)

 None
instance_index Integer

socket 'Instance Index' (id: Instance Index)

 None
rotation Rotation

socket 'Rotation' (id: Rotation)

 None
scale Vector

socket 'Scale' (id: Scale)

 None

Returns:

Type Description
Instances
Source code in core/generated/geometry.py 
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
def instance_on_points(self,
                instance: Instances = None,
                pick_instance: Boolean = None,
                instance_index: Integer = None,
                rotation: Rotation = None,
                scale: Vector = None):
    """ > Node Instance on Points

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Points    | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    instance : Instances, optional
        socket 'Instance' (id: Instance)

    pick_instance : Boolean, optional
        socket 'Pick Instance' (id: Pick Instance)

    instance_index : Integer, optional
        socket 'Instance Index' (id: Instance Index)

    rotation : Rotation, optional
        socket 'Rotation' (id: Rotation)

    scale : Vector, optional
        socket 'Scale' (id: Scale)


    Returns
    -------
    Instances
    """
    node = Node('Instance on Points', {'Points': self, 'Selection': self.get_selection(), 'Instance': instance, 'Pick Instance': pick_instance, 'Instance Index': instance_index, 'Rotation': rotation, 'Scale': scale})
    return node._out

instance_scale()

Node Instance Scale

Returns:

Type Description
Vector
Source code in core/generated/instances.py 
109
110
111
112
113
114
115
116
117
118
@utils.classproperty
def instance_scale(cls):
    """ > Node Instance Scale

    Returns
    -------
    Vector
    """
    node = Node('Instance Scale', )
    return node._out

join(*geometry)

Node Join Geometry

Jump : Socket refers to node output socket after the call

Parameters:

Name Type Description Default
geometry Geometry

socket 'Geometry' (id: Geometry)

 ()

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
def join(self, *geometry: Geometry):
    """ > Node Join Geometry

    > ***Jump*** : Socket refers to node output socket after the call

    Parameters
    ----------
    geometry : Geometry, optional
        socket 'Geometry' (id: Geometry)


    Returns
    -------
    Geometry
    """
    node = Node('Join Geometry', {'Geometry': [self] + list(geometry)})
    self._jump(node._out)
    return self._domain_to_geometry

Link input sockets of the node

Allow to chain input sockets linking.

Source code in core/socket_class.py 
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
def link_inputs(self,
    from_node   : Node = None,
    from_panel  : str = "",
    *,
    include     : list =  None,
    exclude     : list  = [],
    panel       : str = "",
    ):
    """ Link input sockets of the node

    Allow to chain input sockets linking.
    """
    self.node.link_inputs(from_node, from_panel=from_panel, include=include, exclude=exclude, panel=panel)
    return self

Link panel input sockets of the node

Allow to chain input sockets linking.

Source code in core/socket_class.py 
1421
1422
1423
1424
1425
1426
1427
def link_panel(self, panel: str, from_node : Node = None):
    """ Link panel input sockets of the node

    Allow to chain input sockets linking.
    """
    self.node.link_panel(panel, from_node=from_node)
    return self

list_append(value)

Append a value or another list to this list.

If value is a list socket, all its items are appended. Otherwise, value is converted to the socket type and appended as one item. The socket is updated in place to point to the resulting list.

values = Float.List(1, 2, 3)
values.list_append(4)

other = Float.List(5, 6)
values.list_append(other)

Parameters:

Name Type Description Default
value Any | Socket

Single value or list socket to append.

 required

Returns:

Type Description
Socket

This socket, updated to point to the concatenated list.

Raises:

Type Description
NodeError

If this socket does not contain a list.
Source code in core/socket_class.py 
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
def list_append(self, value):
    """Append a value or another list to this list.

    If ``value`` is a list socket, all its items are appended. Otherwise,
    ``value`` is converted to the socket type and appended as one item.
    The socket is updated in place to point to the resulting list.

    ``` python
    values = Float.List(1, 2, 3)
    values.list_append(4)

    other = Float.List(5, 6)
    values.list_append(other)
    ```

    Parameters
    ----------
    value : Any | Socket
        Single value or list socket to append.

    Returns
    -------
    Socket
        This socket, updated to point to the concatenated list.

    Raises
    ------
    NodeError
        If this socket does not contain a list.
    """

    from .sock_closure import Closure
    from .sock_integer import Integer

    if not self._is_list:
        raise NodeError(f"Socket.list_append error: {self} is not a list.")

    with Layout("Socket.list_append"):

        # Turn the appended value into a closure indexed from zero.
        in_cl = None
        if isinstance(value, Socket) and value._is_list:
            n = value.list_length()
            with Closure() as cl:
                index = Integer(0, "Index")
                value[index].out("Value")
            in_cl = cl
        else:
            n = 1
            with Closure() as cl:
                index = Integer(0, "Index")
                type(self)(value).out("Value")
                index.out() # To avoid warning
            in_cl = cl

        cur_length = self.list_length()

        # Keep the current items first, then evaluate the appended value.
        with Closure() as cl:
            index = Integer(0, "Index")

            v = type(self).Switch(index.less_than(cur_length), 
                    in_cl.evaluate(index=index-cur_length).value,
                    self[index]
                    )
            v.out(self._name)

        # Replace the wrapped socket while preserving its Python identity.
        return self._jump(cl.to_list(cur_length + n))

list_length()

Node List Length

Fixed values

Kind Name Value
Socket List self
Parameter data_type 'GEOMETRY'

Returns:

Type Description
Integer
Source code in core/generated/geometry.py 
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
def list_length(self):
    """ > Node List Length

    **Fixed values**

    | Kind      | Name        | Value        |
    | --------- | ----------- | ------------ |
    | Socket    | List        | `self`       |
    | Parameter | `data_type` | `'GEOMETRY'` |

    Returns
    -------
    Integer
    """
    node = Node('List Length', {'List': self}, data_type='GEOMETRY')
    return node._out

menu_switch(self_name='Self', named_sockets={}, default_menu=None, **sockets)

Node Menu Switch

[&NO_JUMP]

Self is connected to the first menu item with the name provided as argument.

The items of the Menu Switch node are provided in the 'items' dict. An group input socket named after the 'name' argument is linked to menu selector.

Parameters:

Name Type Description Default
named_sockets dict

sockets to create default={}.

 {}
default_menu str

default menu value default=None.

 None
sockets dict

items

 {}

Returns:

Type Description
Socket
Source code in core/socket_class.py 
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
def menu_switch(self,
            self_name       : str = 'Self', 
            named_sockets   : dict = {},
            default_menu    : str = None,
            **sockets):
    """ > Node Menu Switch

    [&NO_JUMP]

    Self is connected to the first menu item with the name provided as argument.

    The items of the Menu Switch node are provided in the 'items' dict.
    An group input socket named after the 'name' argument is linked to menu selector.

    Parameters
    ----------
    named_sockets : dict, optional
        sockets to create default={}.

    default_menu : str, optional
        default menu value default=None.

    sockets : dict
        items


    Returns
    -------
    Socket
    """        
    return self.MenuSwitch(named_sockets = {self_name: self, **named_sockets}, default_menu=default_menu, **sockets)

merge(mode=None, distance=None)

Node Merge by Distance

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]

Parameters:

Name Type Description Default
mode menu='All'

('All', 'Connected')

 None
distance Float

socket 'Distance' (id: Distance)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
def merge(self, mode: Literal['All', 'Connected'] = None, distance: Float = None):
    """ > Node Merge by Distance

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Geometry  | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    mode : menu='All', optional
        ('All', 'Connected')

    distance : Float, optional
        socket 'Distance' (id: Distance)


    Returns
    -------
    Geometry
    """
    node = Node('Merge by Distance', {'Geometry': self, 'Selection': self.get_selection(), 'Mode': mode, 'Distance': distance})
    self._jump(node._out)
    return self._domain_to_geometry

merge_by_distance(mode=None, distance=None)

Node Merge by Distance

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]

Parameters:

Name Type Description Default
mode menu='All'

('All', 'Connected')

 None
distance Float

socket 'Distance' (id: Distance)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
def merge_by_distance(self, mode: Literal['All', 'Connected'] = None, distance: Float = None):
    """ > Node Merge by Distance

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Geometry  | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    mode : menu='All', optional
        ('All', 'Connected')

    distance : Float, optional
        socket 'Distance' (id: Distance)


    Returns
    -------
    Geometry
    """
    node = Node('Merge by Distance', {'Geometry': self, 'Selection': self.get_selection(), 'Mode': mode, 'Distance': distance})
    self._jump(node._out)
    return self._domain_to_geometry

merge_points(merge_id=None)

Node Merge Points

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]

Parameters:

Name Type Description Default
merge_id Integer

socket 'Merge ID' (id: Merge ID)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
def merge_points(self, merge_id: Integer = None):
    """ > Node Merge Points

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Geometry  | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    merge_id : Integer, optional
        socket 'Merge ID' (id: Merge ID)


    Returns
    -------
    Geometry
    """
    node = Node('Merge Points', {'Geometry': self, 'Selection': self.get_selection(), 'Merge ID': merge_id})
    self._jump(node._out)
    return self._domain_to_geometry

out(name=None, panel='', **props)

Plug the value to the Group Output Node.

with GeoNodes("Plug to group output"):
    # Create a cube
    geo = Mesh.Cube()
    # To Group Output geometry as socket named "Cube"
    geo.out("Cube")

The "Do nothing" modifier is simply Geometry().out()

Parameters:

Name Type Description Default
name str

socket name default=None.

 None

Returns:

Type Description
None
Source code in core/socket_class.py 
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
def out(self, name: str = None, panel: str = "", **props):
    """ Plug the value to the Group Output Node.

    ``` python
    with GeoNodes("Plug to group output"):
        # Create a cube
        geo = Mesh.Cube()
        # To Group Output geometry as socket named "Cube"
        geo.out("Cube")
    ```

    The "Do nothing" modifier is simply ``` Geometry().out() ```

    Parameters
    ----------
    name : str, optional
        socket name default=None.


    Returns
    -------
    None
    """
    self._is_empty(f"Impossible to link an empty socket (name: '{name}').")

    out_node = self._tree.get_output_node()
    out_node.set_input_socket(name=name, value=self, create=True, panel=panel, **props)

proximity(group_id=None, sample_position=None, sample_group_id=None, target_element='FACES')

Node Geometry Proximity

Fixed values

Kind Name Value
Socket Geometry self

Parameters:

Name Type Description Default
group_id Integer

socket 'Group ID' (id: Group ID)

 None
sample_position Vector

socket 'Sample Position' (id: Source Position)

 None
sample_group_id Integer

socket 'Sample Group ID' (id: Sample Group ID)

 None
target_element Literal['Points', 'Edges', 'Faces']

parameter target_element

 'FACES'

Returns:

Type Description
Vector

peer sockets: distance_ (Float), is_valid_ (Boolean)
Source code in core/generated/geometry.py 
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
def proximity(self,
                group_id: Integer = None,
                sample_position: Vector = None,
                sample_group_id: Integer = None,
                target_element: Literal['POINTS', 'EDGES', 'FACES'] = 'FACES'):
    """ > Node Geometry Proximity

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |

    Parameters
    ----------
    group_id : Integer, optional
        socket 'Group ID' (id: Group ID)

    sample_position : Vector, optional
        socket 'Sample Position' (id: Source Position)

    sample_group_id : Integer, optional
        socket 'Sample Group ID' (id: Sample Group ID)

    target_element : Literal['Points', 'Edges', 'Faces']
        parameter `target_element`


    Returns
    -------
    Vector
        peer sockets: distance_ (Float), is_valid_ (Boolean)

    """
    utils.check_enum_arg('Geometry Proximity', 'target_element', target_element, 'proximity', ('POINTS', 'EDGES', 'FACES'))
    node = Node('Geometry Proximity', {'Target': self, 'Group ID': group_id, 'Source Position': sample_position, 'Sample Group ID': sample_group_id}, target_element=target_element)
    return node._out

proximity_edges(group_id=None, sample_position=None, sample_group_id=None)

Node Geometry Proximity

Fixed values

Kind Name Value
Socket Geometry self
Parameter target_element 'EDGES'

Parameters:

Name Type Description Default
group_id Integer

socket 'Group ID' (id: Group ID)

 None
sample_position Vector

socket 'Sample Position' (id: Source Position)

 None
sample_group_id Integer

socket 'Sample Group ID' (id: Sample Group ID)

 None

Returns:

Type Description
Vector

peer sockets: distance_ (Float), is_valid_ (Boolean)
Source code in core/generated/geometry.py 
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
def proximity_edges(self,
                group_id: Integer = None,
                sample_position: Vector = None,
                sample_group_id: Integer = None):
    """ > Node Geometry Proximity

    **Fixed values**

    | Kind      | Name             | Value     |
    | --------- | ---------------- | --------- |
    | Socket    | Geometry         | `self`    |
    | Parameter | `target_element` | `'EDGES'` |

    Parameters
    ----------
    group_id : Integer, optional
        socket 'Group ID' (id: Group ID)

    sample_position : Vector, optional
        socket 'Sample Position' (id: Source Position)

    sample_group_id : Integer, optional
        socket 'Sample Group ID' (id: Sample Group ID)


    Returns
    -------
    Vector
        peer sockets: distance_ (Float), is_valid_ (Boolean)

    """
    node = Node('Geometry Proximity', {'Target': self, 'Group ID': group_id, 'Source Position': sample_position, 'Sample Group ID': sample_group_id}, target_element='EDGES')
    return node._out

proximity_faces(group_id=None, sample_position=None, sample_group_id=None)

Node Geometry Proximity

Fixed values

Kind Name Value
Socket Geometry self
Parameter target_element 'FACES'

Parameters:

Name Type Description Default
group_id Integer

socket 'Group ID' (id: Group ID)

 None
sample_position Vector

socket 'Sample Position' (id: Source Position)

 None
sample_group_id Integer

socket 'Sample Group ID' (id: Sample Group ID)

 None

Returns:

Type Description
Vector

peer sockets: distance_ (Float), is_valid_ (Boolean)
Source code in core/generated/geometry.py 
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
def proximity_faces(self,
                group_id: Integer = None,
                sample_position: Vector = None,
                sample_group_id: Integer = None):
    """ > Node Geometry Proximity

    **Fixed values**

    | Kind      | Name             | Value     |
    | --------- | ---------------- | --------- |
    | Socket    | Geometry         | `self`    |
    | Parameter | `target_element` | `'FACES'` |

    Parameters
    ----------
    group_id : Integer, optional
        socket 'Group ID' (id: Group ID)

    sample_position : Vector, optional
        socket 'Sample Position' (id: Source Position)

    sample_group_id : Integer, optional
        socket 'Sample Group ID' (id: Sample Group ID)


    Returns
    -------
    Vector
        peer sockets: distance_ (Float), is_valid_ (Boolean)

    """
    node = Node('Geometry Proximity', {'Target': self, 'Group ID': group_id, 'Source Position': sample_position, 'Sample Group ID': sample_group_id}, target_element='FACES')
    return node._out

proximity_points(group_id=None, sample_position=None, sample_group_id=None)

Node Geometry Proximity

Fixed values

Kind Name Value
Socket Geometry self
Parameter target_element 'POINTS'

Parameters:

Name Type Description Default
group_id Integer

socket 'Group ID' (id: Group ID)

 None
sample_position Vector

socket 'Sample Position' (id: Source Position)

 None
sample_group_id Integer

socket 'Sample Group ID' (id: Sample Group ID)

 None

Returns:

Type Description
Vector

peer sockets: distance_ (Float), is_valid_ (Boolean)
Source code in core/generated/geometry.py 
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
def proximity_points(self,
                group_id: Integer = None,
                sample_position: Vector = None,
                sample_group_id: Integer = None):
    """ > Node Geometry Proximity

    **Fixed values**

    | Kind      | Name             | Value      |
    | --------- | ---------------- | ---------- |
    | Socket    | Geometry         | `self`     |
    | Parameter | `target_element` | `'POINTS'` |

    Parameters
    ----------
    group_id : Integer, optional
        socket 'Group ID' (id: Group ID)

    sample_position : Vector, optional
        socket 'Sample Position' (id: Source Position)

    sample_group_id : Integer, optional
        socket 'Sample Group ID' (id: Sample Group ID)


    Returns
    -------
    Vector
        peer sockets: distance_ (Float), is_valid_ (Boolean)

    """
    node = Node('Geometry Proximity', {'Target': self, 'Group ID': group_id, 'Source Position': sample_position, 'Sample Group ID': sample_group_id}, target_element='POINTS')
    return node._out

raycast(attribute=None, interpolation=None, source_position=None, ray_direction=None, ray_length=None)

Node Raycast

Fixed values

Kind Name Value
Socket Target Geometry self
Parameter data_type from attribute type

Parameters:

Name Type Description Default
attribute Float | Integer | Boolean | Vector | Color | Rotation | Matrix

socket 'Attribute' (id: Attribute)

 None
interpolation menu='Interpolated'

('Interpolated', 'Nearest')

 None
source_position Vector

socket 'Source Position' (id: Source Position)

 None
ray_direction Vector

socket 'Ray Direction' (id: Ray Direction)

 None
ray_length Float

socket 'Ray Length' (id: Ray Length)

 None

Returns:

Type Description
Boolean

peer sockets: hit_position_ (Vector), hit_normal_ (Vector), hit_distance_ (Float), attribute_ (Float)
Source code in core/generated/geometry.py 
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
def raycast(self,
                attribute: Float | Integer | Boolean | Vector | Color | Rotation | Matrix = None,
                interpolation: Literal['Interpolated', 'Nearest'] = None,
                source_position: Vector = None,
                ray_direction: Vector = None,
                ray_length: Float = None):
    """ > Node Raycast

    **Fixed values**

    | Kind      | Name            | Value                 |
    | --------- | --------------- | --------------------- |
    | Socket    | Target Geometry | `self`                |
    | Parameter | `data_type`     | from `attribute` type |

    Parameters
    ----------
    attribute : Float | Integer | Boolean | Vector | Color | Rotation | Matrix, optional
        socket 'Attribute' (id: Attribute)

    interpolation : menu='Interpolated', optional
        ('Interpolated', 'Nearest')

    source_position : Vector, optional
        socket 'Source Position' (id: Source Position)

    ray_direction : Vector, optional
        socket 'Ray Direction' (id: Ray Direction)

    ray_length : Float, optional
        socket 'Ray Length' (id: Ray Length)


    Returns
    -------
    Boolean
        peer sockets: hit_position_ (Vector), hit_normal_ (Vector), hit_distance_ (Float), attribute_ (Float)

    """
    data_type = SocketType.get_data_type_for_node(attribute, 'GeometryNodeRaycast')
    node = Node('Raycast', {'Target Geometry': self, 'Attribute': attribute, 'Interpolation': interpolation, 'Source Position': source_position, 'Ray Direction': ray_direction, 'Ray Length': ray_length}, data_type=data_type)
    return node._out

realize(realize_all=None, depth=None, realize_to_point_domain=False)

Node Realize Instances

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]

Parameters:

Name Type Description Default
realize_all Boolean

socket 'Realize All' (id: Realize All)

 None
depth Integer

socket 'Depth' (id: Depth)

 None
realize_to_point_domain bool

parameter realize_to_point_domain

 False

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
def realize(self,
                realize_all: Boolean = None,
                depth: Integer = None,
                realize_to_point_domain = False):
    """ > Node Realize Instances

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Geometry  | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    realize_all : Boolean, optional
        socket 'Realize All' (id: Realize All)

    depth : Integer, optional
        socket 'Depth' (id: Depth)

    realize_to_point_domain : bool
        parameter `realize_to_point_domain`


    Returns
    -------
    Geometry
    """
    node = Node('Realize Instances', {'Geometry': self, 'Selection': self.get_selection(), 'Realize All': realize_all, 'Depth': depth}, realize_to_point_domain=realize_to_point_domain)
    return node._out

reference()

Node Instance Reference

Returns:

Type Description
Integer
Source code in core/generated/instances.py 
87
88
89
90
91
92
93
94
95
96
@utils.classproperty
def reference(cls):
    """ > Node Instance Reference

    Returns
    -------
    Integer
    """
    node = Node('Instance Reference', )
    return node._out

remove_named_attribute(pattern_mode=None, name=None)

Node Remove Named Attribute

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self

Parameters:

Name Type Description Default
pattern_mode menu='Exact'

('Exact', 'Wildcard')

 None
name String

socket 'Name' (id: Name)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
def remove_named_attribute(self, pattern_mode: Literal['Exact', 'Wildcard'] = None, name: String = None):
    """ > Node Remove Named Attribute

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |

    Parameters
    ----------
    pattern_mode : menu='Exact', optional
        ('Exact', 'Wildcard')

    name : String, optional
        socket 'Name' (id: Name)


    Returns
    -------
    Geometry
    """
    node = Node('Remove Named Attribute', {'Geometry': self, 'Pattern Mode': pattern_mode, 'Name': name})
    self._jump(node._out)
    return self._domain_to_geometry

rename_attribute(mode=None, old=None, new=None, overwrite=None)

Node Rename Attribute

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self

Parameters:

Name Type Description Default
mode menu='Single'

('Single', 'Prefix')

 None
old String

socket 'Old' (id: Old)

 None
new String

socket 'New' (id: New)

 None
overwrite Boolean

socket 'Overwrite' (id: Overwrite)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
def rename_attribute(self,
                mode: Literal['Single', 'Prefix'] = None,
                old: String = None,
                new: String = None,
                overwrite: Boolean = None):
    """ > Node Rename Attribute

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |

    Parameters
    ----------
    mode : menu='Single', optional
        ('Single', 'Prefix')

    old : String, optional
        socket 'Old' (id: Old)

    new : String, optional
        socket 'New' (id: New)

    overwrite : Boolean, optional
        socket 'Overwrite' (id: Overwrite)


    Returns
    -------
    Geometry
    """
    node = Node('Rename Attribute', {'Geometry': self, 'Mode': mode, 'Old': old, 'New': new, 'Overwrite': overwrite})
    self._jump(node._out)
    return self._domain_to_geometry

repeat(iterations=1, named_sockets={}, **sockets)

Repeat zone

Parameters:

Name Type Description Default
iterations Integer

iteration socket

 1
named_sockets dict

named sockets

 {}
sockets dict

other sockets

 {}

Returns:

Type Description
ZoneIterator
Source code in core/socket_class.py 
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
def repeat(self, iterations=1, named_sockets: dict={}, **sockets):
    """ Repeat zone

    Parameters
    ----------
    iterations : Integer, default=1
        iteration socket

    named_sockets : dict, default={}
        named sockets

    sockets : dict, optional
        other sockets


    Returns
    -------
    ZoneIterator
    """
    class_name = type(self).__name__
    node = ZoneNode("Repeat", named_sockets={class_name: self, **named_sockets}, Iterations=iterations, **sockets)
    return ZoneIterator(self, node)

replace_material(old=None, new=None)

Node Replace Material

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self

Parameters:

Name Type Description Default
old Material

socket 'Old' (id: Old)

 None
new Material

socket 'New' (id: New)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
def replace_material(self, old: Material = None, new: Material = None):
    """ > Node Replace Material

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |

    Parameters
    ----------
    old : Material, optional
        socket 'Old' (id: Old)

    new : Material, optional
        socket 'New' (id: New)


    Returns
    -------
    Geometry
    """
    node = Node('Replace Material', {'Geometry': self, 'Old': old, 'New': new})
    self._jump(node._out)
    return self._domain_to_geometry

reshape_list(shape)

Reshape a flat list into nested lists.

shape defines the length of each list level. Items keep their original linear order.

values = Float.List(*range(16))
matrix = values.reshape_list((4, 4))

first  = matrix[0][0]
last   = matrix[3][3]

Shapes with more than two dimensions are supported:

values = Float.List(*range(24))
blocks = values.reshape_list((2, 3, 4))

Dimensions can also be Integer sockets:

rows = Integer(name="Rows")
table = values.reshape_list((rows, 4))

A single dimension does not require a tuple:

values.reshape_list(16)
# Equivalent to values.reshape_list((16,))

A one-dimensional shape flattens one existing level of nested lists. A warning is emitted when the resulting length differs from the requested dimension.

Parameters:

Name Type Description Default
shape int | Integer | tuple[int | Integer]

Length of every dimension. A single integer is interpreted as a one-dimensional shape. Dimensions must be strictly positive.

 required

Returns:

Type Description
Socket

This socket, updated to point to the reshaped list.
Source code in core/socket_class.py 
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
def reshape_list(self, shape):
    """Reshape a flat list into nested lists.

    ``shape`` defines the length of each list level. Items keep their
    original linear order.

    ``` python
    values = Float.List(*range(16))
    matrix = values.reshape_list((4, 4))

    first  = matrix[0][0]
    last   = matrix[3][3]
    ```

    Shapes with more than two dimensions are supported:

    ``` python
    values = Float.List(*range(24))
    blocks = values.reshape_list((2, 3, 4))
    ```

    Dimensions can also be Integer sockets:

    ``` python
    rows = Integer(name="Rows")
    table = values.reshape_list((rows, 4))
    ```

    A single dimension does not require a tuple:

    ``` python
    values.reshape_list(16)
    # Equivalent to values.reshape_list((16,))
    ```

    A one-dimensional shape flattens one existing level of nested lists.
    A warning is emitted when the resulting length differs from the
    requested dimension.

    Parameters
    ----------
    shape : int | Integer | tuple[int | Integer]
        Length of every dimension. A single integer is interpreted as a
        one-dimensional shape. Dimensions must be strictly positive.

    Returns
    -------
    Socket
        This socket, updated to point to the reshaped list.

    """

    if not hasattr(shape, '__len__'):
        shape = (shape,)

    shape = tuple(shape)

    ok_shape = True
    for d in shape:
        if isinstance(d, Socket):
            oK_shape = False

    shape_str = f"({shape})" if ok_shape else ""

    from .sock_closure import Closure
    from .sock_integer import Integer
    from .sock_string import String

    with Layout(f"Socket.reshape_list{shape_str}"):

        if len(shape) == 1:

            self.flatten_list()

            res_length = self.list_length()

            message = String.Join(
                f"{self._name}.reshape_list(" + Integer(shape[0]).to_string() + ")",
                "the resulting list length is",
                res_length.to_string(),
                delimiter = " ",
            )

            self.list_length().not_equal(shape[0]).warning(message)
            return self

        dimensions = [Integer(size) for size in shape]

        # ----- Build nested lists

        def build(level, linear_index=None):
            with Closure() as closure:
                index = Integer(0, "Index")

                if linear_index is None:
                    next_index = index
                else:
                    next_index = linear_index * dimensions[level] + index

                if level == len(dimensions) - 1:
                    value = self[next_index]
                else:
                    value = build(level + 1, next_index)

                value.out("Value")

            return closure.to_list(count=dimensions[level])

        self._jump(build(0))
        return self

rotate(rotation=None, pivot_point=None, local_space=None)

Node Rotate Instances

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Instances self
Socket Selection self[selection]

Parameters:

Name Type Description Default
rotation Rotation

socket 'Rotation' (id: Rotation)

 None
pivot_point Vector

socket 'Pivot Point' (id: Pivot Point)

 None
local_space Boolean

socket 'Local Space' (id: Local Space)

 None

Returns:

Type Description
Instances
Source code in core/generated/instances.py 
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
def rotate(self,
                rotation: Rotation = None,
                pivot_point: Vector = None,
                local_space: Boolean = None):
    """ > Node Rotate Instances

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Instances | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    rotation : Rotation, optional
        socket 'Rotation' (id: Rotation)

    pivot_point : Vector, optional
        socket 'Pivot Point' (id: Pivot Point)

    local_space : Boolean, optional
        socket 'Local Space' (id: Local Space)


    Returns
    -------
    Instances
    """
    node = Node('Rotate Instances', {'Instances': self, 'Selection': self.get_selection(), 'Rotation': rotation, 'Pivot Point': pivot_point, 'Local Space': local_space})
    self._jump(node._out)
    return self._domain_to_geometry

rotation()

Node Instance Rotation

Returns:

Type Description
Rotation
Source code in core/generated/instances.py 
 98
 99
100
101
102
103
104
105
106
107
@utils.classproperty
def rotation(cls):
    """ > Node Instance Rotation

    Returns
    -------
    Rotation
    """
    node = Node('Instance Rotation', )
    return node._out

scale(scale=None, center=None, local_space=None)

Node Scale Instances

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Instances self
Socket Selection self[selection]

Parameters:

Name Type Description Default
scale Vector

socket 'Scale' (id: Scale)

 None
center Vector

socket 'Center' (id: Center)

 None
local_space Boolean

socket 'Local Space' (id: Local Space)

 None

Returns:

Type Description
Instances
Source code in core/generated/instances.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
def scale(self, scale: Vector = None, center: Vector = None, local_space: Boolean = None):
    """ > Node Scale Instances

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Instances | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    scale : Vector, optional
        socket 'Scale' (id: Scale)

    center : Vector, optional
        socket 'Center' (id: Center)

    local_space : Boolean, optional
        socket 'Local Space' (id: Local Space)


    Returns
    -------
    Instances
    """
    node = Node('Scale Instances', {'Instances': self, 'Selection': self.get_selection(), 'Scale': scale, 'Center': center, 'Local Space': local_space})
    self._jump(node._out)
    return self._domain_to_geometry

separate_components()

Node Separate Components

Fixed values

Kind Name Value
Socket Geometry self

Returns:

Type Description
node[mesh(Mesh), curve(Curve), grease_pencil(GreasePencil), point_cloud(Cloud), volume(Volume), instances(Instances)]
Source code in core/generated/geometry.py 
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
def separate_components(self):
    """ > Node Separate Components

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |

    Returns
    -------
    node [mesh (Mesh), curve (Curve), grease_pencil (GreasePencil), point_cloud (Cloud), volume (Volume), instances (Instances)]
    """
    node = self._cache('Separate Components', {'Geometry': self})
    return node

set(name, value, domain=None)

Store a named attribute on this geometry.

Node Store Named Attribute

This is the direct counterpart of get() when a helper does not need to be kept. The value determines the attribute data type.

mesh = Mesh()
attr = mesh.set("Weight", 1.0, domain="Point")
mesh.set("Direction", (0, 0, 1), domain="Face")

Parameters:

Name Type Description Default
name str

Name of the attribute to create or update.

 required
value value | Socket

Constant or field stored in the attribute.

 required
domain str | Domain

Domain on which to store the attribute. The default is Point.

 None

Returns:

Type Description
Attribute

Helper representing the stored attribute.
Source code in core/geometry_class.py 
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
def set(self, name, value, domain=None):
    """Store a named attribute on this geometry.

    > Node Store Named Attribute

    This is the direct counterpart of ``get()`` when a helper does not
    need to be kept. The value determines the attribute data type.

    ``` python
    mesh = Mesh()
    attr = mesh.set("Weight", 1.0, domain="Point")
    mesh.set("Direction", (0, 0, 1), domain="Face")
    ```

    Parameters
    ----------
    name : str
        Name of the attribute to create or update.
    value : value | Socket
        Constant or field stored in the attribute.
    domain : str | Domain, optional
        Domain on which to store the attribute. The default is ``Point``.

    Returns
    -------
    Attribute
        Helper representing the stored attribute.
    """
    from .attributes import Attribute

    if isinstance(name, Attribute):
        if name.data_type is None:
            attr = Attribute(name.name, value, domain=domain)
        else:
            attr = Attribute(name.name, name.data_type, domain=domain)

    else:
        attr = self.get(name, value, domain=domain)

    attr.set(value)
    return attr

set_bundle(bundle=None)

Node Set Geometry Bundle

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self

Parameters:

Name Type Description Default
bundle Bundle

socket 'Bundle' (id: Bundle)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
def set_bundle(self, bundle: Bundle = None):
    """ > Node Set Geometry Bundle

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |

    Parameters
    ----------
    bundle : Bundle, optional
        socket 'Bundle' (id: Bundle)


    Returns
    -------
    Geometry
    """
    node = Node('Set Geometry Bundle', {'Geometry': self, 'Bundle': bundle})
    self._jump(node._out)
    return self._domain_to_geometry

set_id(id=None)

Node Set ID

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]

Parameters:

Name Type Description Default
id Integer

socket 'ID' (id: ID)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
def set_id(self, id: Integer = None):
    """ > Node Set ID

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Geometry  | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    id : Integer, optional
        socket 'ID' (id: ID)


    Returns
    -------
    Geometry
    """
    node = Node('Set ID', {'Geometry': self, 'Selection': self.get_selection(), 'ID': id})
    self._jump(node._out)
    return self._domain_to_geometry

set_material(material=None)

Node Set Material

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]

Parameters:

Name Type Description Default
material Material

socket 'Material' (id: Material)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
def set_material(self, material: Material = None):
    """ > Node Set Material

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Geometry  | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    material : Material, optional
        socket 'Material' (id: Material)


    Returns
    -------
    Geometry
    """
    node = Node('Set Material', {'Geometry': self, 'Selection': self.get_selection(), 'Material': material})
    self._jump(node._out)
    return self._domain_to_geometry

set_material_index(material_index=None)

Node Set Material Index

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]

Parameters:

Name Type Description Default
material_index Integer

socket 'Material Index' (id: Material Index)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
def set_material_index(self, material_index: Integer = None):
    """ > Node Set Material Index

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Geometry  | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    material_index : Integer, optional
        socket 'Material Index' (id: Material Index)


    Returns
    -------
    Geometry
    """
    node = Node('Set Material Index', {'Geometry': self, 'Selection': self.get_selection(), 'Material Index': material_index})
    self._jump(node._out)
    return self._domain_to_geometry

set_name(name=None)

Node Set Geometry Name

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self

Parameters:

Name Type Description Default
name String

socket 'Name' (id: Name)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
def set_name(self, name: String = None):
    """ > Node Set Geometry Name

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |

    Parameters
    ----------
    name : String, optional
        socket 'Name' (id: Name)


    Returns
    -------
    Geometry
    """
    node = Node('Set Geometry Name', {'Geometry': self, 'Name': name})
    self._jump(node._out)
    return self._domain_to_geometry

set_position(position=None, offset=None)

Node Set Position

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]

Parameters:

Name Type Description Default
position Vector

socket 'Position' (id: Position)

 None
offset Vector

socket 'Offset' (id: Offset)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
def set_position(self, position: Vector = None, offset: Vector = None):
    """ > Node Set Position

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Geometry  | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    position : Vector, optional
        socket 'Position' (id: Position)

    offset : Vector, optional
        socket 'Offset' (id: Offset)


    Returns
    -------
    Geometry
    """
    node = Node('Set Position', {'Geometry': self, 'Selection': self.get_selection(), 'Position': position, 'Offset': offset})
    self._jump(node._out)
    return self._domain_to_geometry

set_transform(transform=None)

Node Set Instance Transform

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Instances self
Socket Selection self[selection]

Parameters:

Name Type Description Default
transform Matrix

socket 'Transform' (id: Transform)

 None

Returns:

Type Description
Instances
Source code in core/generated/instances.py 
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
def set_transform(self, transform: Matrix = None):
    """ > Node Set Instance Transform

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Instances | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    transform : Matrix, optional
        socket 'Transform' (id: Transform)


    Returns
    -------
    Instances
    """
    node = Node('Set Instance Transform', {'Instances': self, 'Selection': self.get_selection(), 'Transform': transform})
    self._jump(node._out)
    return self._domain_to_geometry

simulation(named_sockets={}, **sockets)

Simulation zone

Parameters:

Name Type Description Default
named_sockets dict

named sockets

 {}
sockets dict

other sockets

 {}

Returns:

Type Description
ZoneIterator
Source code in core/socket_class.py 
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
def simulation(self, named_sockets: dict={}, **sockets):
    """ Simulation zone

    Parameters
    ----------
    named_sockets : dict, default={}
        named sockets

    sockets : dict, optional
        other sockets

    Returns
    -------
    ZoneIterator
    """
    class_name = type(self).__name__
    node = ZoneNode("Simulation", named_sockets={class_name: self, **named_sockets}, **sockets)
    return ZoneIterator(self, node)

sort_list(group_id=None, sort_weight=None)

Node Sort List

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket List self
Socket Selection self[selection]
Parameter socket_type 'GEOMETRY'

Parameters:

Name Type Description Default
group_id Integer

socket 'Group ID' (id: Group ID)

 None
sort_weight Float

socket 'Sort Weight' (id: Sort Weight)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
def sort_list(self, group_id: Integer = None, sort_weight: Float = None):
    """ > Node Sort List

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind      | Name          | Value             |
    | --------- | ------------- | ----------------- |
    | Socket    | List          | `self`            |
    | Socket    | Selection     | `self[selection]` |
    | Parameter | `socket_type` | `'GEOMETRY'`      |

    Parameters
    ----------
    group_id : Integer, optional
        socket 'Group ID' (id: Group ID)

    sort_weight : Float, optional
        socket 'Sort Weight' (id: Sort Weight)


    Returns
    -------
    Geometry
    """
    node = Node('Sort List', {'List': self, 'Selection': self.get_selection(), 'Group ID': group_id, 'Sort Weight': sort_weight}, socket_type='GEOMETRY')
    self._jump(node._out)
    return self._domain_to_geometry

switch(condition=None, true=None)

Node Switch

Self is connected to 'false' socket.

Note

switch returns self if global constant SWITCH_JUMP = True (default) set SWITCH_JUMP = False for legacy behavior

with GeoNodes("Switch demo"):

    from geonodes import core_module
    constants = core_module.constants
    # Legacy behavior (default is True)
    constants.SWITCH_JUMP = False

    choice = Boolean(True, "Use Sphere")

    # Two possible geometries
    cube   = Mesh.Cube()
    sphere = Mesh.IcoSphere()

    # Select
    # Legacy behavior: cube is unchanged otherwise cube
    geo = cube.switch(choice, sphere)

    # To group output
    geo.out()
Information
  • Socket 'False' : self

Parameters:

Name Type Description Default
condition Boolean

socket 'Switch' (Switch)

 None
true

socket 'True' (True)

 None

Returns:

Type Description
Socket(self)
Source code in core/socket_class.py 
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
def switch(self, condition=None, true=None):
    """ > Node Switch

    Self is connected to 'false' socket.

    !!! note
        switch returns self if global constant SWITCH_JUMP = True (default)
        set SWITCH_JUMP = False for legacy behavior

    ``` python
    with GeoNodes("Switch demo"):

        from geonodes import core_module
        constants = core_module.constants
        # Legacy behavior (default is True)
        constants.SWITCH_JUMP = False

        choice = Boolean(True, "Use Sphere")

        # Two possible geometries
        cube   = Mesh.Cube()
        sphere = Mesh.IcoSphere()

        # Select
        # Legacy behavior: cube is unchanged otherwise cube
        geo = cube.switch(choice, sphere)

        # To group output
        geo.out()
    ```

    Information
    -----------
    - Socket 'False' : self

    Parameters
    ----------
    condition : Boolean
        socket 'Switch' (Switch)

    true
        socket 'True' (True)


    Returns
    -------
    Socket (self)
    """
    res = self.Switch(condition=condition, false=self, true=true)
    if constants.SWITCH_JUMP:
        return self._jump(res)
    else:
        return res

switch_false(condition=None, false=None)

Node Switch

[&JUMP]

Self is connected to 'true' socket.

Important

This methods behaves the inverse of switch : self is connected to "True" socket and the argument to "False", socket

Note

This method is mainly provided to cover the case when 'False' socket is None

with GeoNodes("Switch demo"):

    geo = Geometry()

    show_geometry = Boolean(False, "Merge with Cube")

    cube = Mesh.Cube()

    geo += cube.switch_false(show_geometry)

    # Is equivalent to
    geo += Geometry.Switch(show_geometry, None, cube)

    # To group output
    geo.out()

Note

This method let self socket unchanged. To set self socket to the result

Information
  • Socket 'True' : self

Parameters:

Name Type Description Default
condition Boolean

socket 'Switch' (Switch)

 None
false

socket 'False' (False)

 None

Returns:

Type Description
Socket
Source code in core/socket_class.py 
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
def switch_false(self, condition=None, false=None):
    """ > Node Switch

    [&JUMP]

    Self is connected to 'true' socket.

    !!! important
        This methods behaves the inverse of switch : self is connected to "True" socket and  the argument to "False", socket

    !!! note
        This method is mainly provided to cover the case when 'False' socket is None

    ``` python
    with GeoNodes("Switch demo"):

        geo = Geometry()

        show_geometry = Boolean(False, "Merge with Cube")

        cube = Mesh.Cube()

        geo += cube.switch_false(show_geometry)

        # Is equivalent to
        geo += Geometry.Switch(show_geometry, None, cube)

        # To group output
        geo.out()
    ```

    !!! note
        This method let self socket unchanged. To set self socket to the result

    Information
    -----------
    - Socket 'True' : self

    Parameters
    ----------
    condition : Boolean
        socket 'Switch' (Switch)

    false
        socket 'False' (False)


    Returns
    -------
    Socket
    """
    res = self.Switch(condition=condition, false=false, true=self)
    if constants.SWITCH_JUMP:
        return self._jump(res)
    else:
        return res

to_instance(*geometry)

Node Geometry to Instance

Parameters:

Name Type Description Default
geometry Geometry

socket 'Geometry' (id: Geometry)

 ()

Returns:

Type Description
Instances
Source code in core/generated/geometry.py 
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
def to_instance(self, *geometry: Geometry):
    """ > Node Geometry to Instance

    Parameters
    ----------
    geometry : Geometry, optional
        socket 'Geometry' (id: Geometry)


    Returns
    -------
    Instances
    """
    node = Node('Geometry to Instance', {'Geometry': [self] + list(geometry)})
    return node._out

to_list(count=None)

Node Field to List

Shortcut for self.field_to_list(count) when only this field has to be converted to a list.

Parameters:

Name Type Description Default
count Integer

Number of items in the generated list.

 None

Returns:

Type Description
Socket

List containing the values obtained by evaluating this field.
Source code in core/socket_class.py 
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
def to_list(self, count=None):
    """ > Node Field to List

    Shortcut for ``self.field_to_list(count)`` when only this field has
    to be converted to a list.

    Parameters
    ----------
    count : Integer, optional
        Number of items in the generated list.

    Returns
    -------
    Socket
        List containing the values obtained by evaluating this field.
    """
    return Node('Field to List', named_sockets={self._name: self}, count=count)._out

to_node_inputs(node, *names)

Connect successive list items to a node's inputs.

This is the natural socket-oriented shortcut for node._list_to_inputs(*names, socket_list=self).

When names is empty, all node inputs matching the type of the list items are fed, in their order on the node. Otherwise, only the named inputs are used.

separate = Node('Separate XYZ', vector=vector)
components = separate._outputs_to_list()

combine = Node('Combine XYZ')
components.to_node_inputs(combine)

Parameters:

Name Type Description Default
node Node

Node whose inputs are to be connected.

 required
names str

Optional names of the inputs to feed.

 ()

Returns:

Type Description
Node

The target node.
Source code in core/socket_class.py 
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
def to_node_inputs(self, node, *names):
    """Connect successive list items to a node's inputs.

    This is the natural socket-oriented shortcut for
    ``node._list_to_inputs(*names, socket_list=self)``.

    When ``names`` is empty, all node inputs matching the type of the list
    items are fed, in their order on the node. Otherwise, only the named
    inputs are used.

    ``` python
    separate = Node('Separate XYZ', vector=vector)
    components = separate._outputs_to_list()

    combine = Node('Combine XYZ')
    components.to_node_inputs(combine)
    ```

    Parameters
    ----------
    node : Node
        Node whose inputs are to be connected.

    names : str
        Optional names of the inputs to feed.

    Returns
    -------
    Node
        The target node.
    """
    return node._list_to_inputs(*names, socket_list=self)

to_points(position=None, radius=None)

Node Instances to Points

Fixed values

Kind Name Value
Socket Instances self
Socket Selection self[selection]

Parameters:

Name Type Description Default
position Vector

socket 'Position' (id: Position)

 None
radius Float

socket 'Radius' (id: Radius)

 None

Returns:

Type Description
Cloud
Source code in core/generated/instances.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
def to_points(self, position: Vector = None, radius: Float = None):
    """ > Node Instances to Points

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Instances | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    position : Vector, optional
        socket 'Position' (id: Position)

    radius : Float, optional
        socket 'Radius' (id: Radius)


    Returns
    -------
    Cloud
    """
    node = Node('Instances to Points', {'Instances': self, 'Selection': self.get_selection(), 'Position': position, 'Radius': radius})
    return node._out

transfer_attributes(target_point_id=None, target_edge_id=None, target_face_id=None, target_corner_id=None, target_curve_id=None, target_instance_id=None, source=None, source_point_id=None, source_edge_id=None, source_face_id=None, source_corner_id=None, source_curve_id=None, source_instance_id=None, pattern_mode=None, attribute_names=None, exclude_names=None)

Node Transfer Attributes

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Target self

Parameters:

Name Type Description Default
target_point_id Integer

socket 'Target Point ID' (id: Target Point ID)

 None
target_edge_id Integer

socket 'Target Edge ID' (id: Target Edge ID)

 None
target_face_id Integer

socket 'Target Face ID' (id: Target Face ID)

 None
target_corner_id Integer

socket 'Target Corner ID' (id: Target Corner ID)

 None
target_curve_id Integer

socket 'Target Curve ID' (id: Target Curve ID)

 None
target_instance_id Integer

socket 'Target Instance ID' (id: Target Instance ID)

 None
source Geometry

socket 'Source' (id: Source)

 None
source_point_id Integer

socket 'Source Point ID' (id: Source Point ID)

 None
source_edge_id Integer

socket 'Source Edge ID' (id: Source Edge ID)

 None
source_face_id Integer

socket 'Source Face ID' (id: Source Face ID)

 None
source_corner_id Integer

socket 'Source Corner ID' (id: Source Corner ID)

 None
source_curve_id Integer

socket 'Source Curve ID' (id: Source Curve ID)

 None
source_instance_id Integer

socket 'Source Instance ID' (id: Source Instance ID)

 None
pattern_mode menu='Wildcard'

('Exact', 'Wildcard')

 None
attribute_names String

socket 'Attribute Names' (id: Attribute Names)

 None
exclude_names Boolean

socket 'Exclude Names' (id: Exclude Names)

 None

Returns:

Type Description
Geometry

peer sockets: transferred_names_ (String)
Source code in core/generated/geometry.py 
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
def transfer_attributes(self,
                target_point_id: Integer = None,
                target_edge_id: Integer = None,
                target_face_id: Integer = None,
                target_corner_id: Integer = None,
                target_curve_id: Integer = None,
                target_instance_id: Integer = None,
                source: Geometry = None,
                source_point_id: Integer = None,
                source_edge_id: Integer = None,
                source_face_id: Integer = None,
                source_corner_id: Integer = None,
                source_curve_id: Integer = None,
                source_instance_id: Integer = None,
                pattern_mode: Literal['Exact', 'Wildcard'] = None,
                attribute_names: String = None,
                exclude_names: Boolean = None):
    """ > Node Transfer Attributes

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name   | Value  |
    | ------ | ------ | ------ |
    | Socket | Target | `self` |

    Parameters
    ----------
    target_point_id : Integer, optional
        socket 'Target Point ID' (id: Target Point ID)

    target_edge_id : Integer, optional
        socket 'Target Edge ID' (id: Target Edge ID)

    target_face_id : Integer, optional
        socket 'Target Face ID' (id: Target Face ID)

    target_corner_id : Integer, optional
        socket 'Target Corner ID' (id: Target Corner ID)

    target_curve_id : Integer, optional
        socket 'Target Curve ID' (id: Target Curve ID)

    target_instance_id : Integer, optional
        socket 'Target Instance ID' (id: Target Instance ID)

    source : Geometry, optional
        socket 'Source' (id: Source)

    source_point_id : Integer, optional
        socket 'Source Point ID' (id: Source Point ID)

    source_edge_id : Integer, optional
        socket 'Source Edge ID' (id: Source Edge ID)

    source_face_id : Integer, optional
        socket 'Source Face ID' (id: Source Face ID)

    source_corner_id : Integer, optional
        socket 'Source Corner ID' (id: Source Corner ID)

    source_curve_id : Integer, optional
        socket 'Source Curve ID' (id: Source Curve ID)

    source_instance_id : Integer, optional
        socket 'Source Instance ID' (id: Source Instance ID)

    pattern_mode : menu='Wildcard', optional
        ('Exact', 'Wildcard')

    attribute_names : String, optional
        socket 'Attribute Names' (id: Attribute Names)

    exclude_names : Boolean, optional
        socket 'Exclude Names' (id: Exclude Names)


    Returns
    -------
    Geometry
        peer sockets: transferred_names_ (String)

    """
    node = Node('Transfer Attributes', {'Target': self, 'Target Point ID': target_point_id, 'Target Edge ID': target_edge_id, 'Target Face ID': target_face_id, 'Target Corner ID': target_corner_id, 'Target Curve ID': target_curve_id, 'Target Instance ID': target_instance_id, 'Source': source, 'Source Point ID': source_point_id, 'Source Edge ID': source_edge_id, 'Source Face ID': source_face_id, 'Source Corner ID': source_corner_id, 'Source Curve ID': source_curve_id, 'Source Instance ID': source_instance_id, 'Pattern Mode': pattern_mode, 'Attribute Names': attribute_names, 'Exclude Names': exclude_names})
    self._jump(node._out)
    return self._domain_to_geometry

transform(mode=None, translation=None, rotation=None, scale=None, transform=None)

Node Transform Geometry

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self

Parameters:

Name Type Description Default
mode menu='Components'

('Components', 'Matrix')

 None
translation Vector

socket 'Translation' (id: Translation)

 None
rotation Rotation

socket 'Rotation' (id: Rotation)

 None
scale Vector

socket 'Scale' (id: Scale)

 None
transform Matrix

socket 'Transform' (id: Transform)

 None

Returns:

Type Description
Geometry
Source code in core/generated/geometry.py 
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
def transform(self,
                mode: Literal['Components', 'Matrix'] = None,
                translation: Vector = None,
                rotation: Rotation = None,
                scale: Vector = None,
                transform: Matrix = None):
    """ > Node Transform Geometry

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name     | Value  |
    | ------ | -------- | ------ |
    | Socket | Geometry | `self` |

    Parameters
    ----------
    mode : menu='Components', optional
        ('Components', 'Matrix')

    translation : Vector, optional
        socket 'Translation' (id: Translation)

    rotation : Rotation, optional
        socket 'Rotation' (id: Rotation)

    scale : Vector, optional
        socket 'Scale' (id: Scale)

    transform : Matrix, optional
        socket 'Transform' (id: Transform)


    Returns
    -------
    Geometry
    """
    node = Node('Transform Geometry', {'Geometry': self, 'Mode': mode, 'Translation': translation, 'Rotation': rotation, 'Scale': scale, 'Transform': transform})
    self._jump(node._out)
    return self._domain_to_geometry

translate(translation=None, local_space=None)

Node Translate Instances

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Instances self
Socket Selection self[selection]

Parameters:

Name Type Description Default
translation Vector

socket 'Translation' (id: Translation)

 None
local_space Boolean

socket 'Local Space' (id: Local Space)

 None

Returns:

Type Description
Instances
Source code in core/generated/instances.py 
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
def translate(self, translation: Vector = None, local_space: Boolean = None):
    """ > Node Translate Instances

    > ***Jump*** : Socket refers to node output socket after the call

    **Fixed values**

    | Kind   | Name      | Value             |
    | ------ | --------- | ----------------- |
    | Socket | Instances | `self`            |
    | Socket | Selection | `self[selection]` |

    Parameters
    ----------
    translation : Vector, optional
        socket 'Translation' (id: Translation)

    local_space : Boolean, optional
        socket 'Local Space' (id: Local Space)


    Returns
    -------
    Instances
    """
    node = Node('Translate Instances', {'Instances': self, 'Selection': self.get_selection(), 'Translation': translation, 'Local Space': local_space})
    self._jump(node._out)
    return self._domain_to_geometry

viewer(named_sockets={}, ui_shortcut=0, **sockets) classmethod

Node Viewer

Fixed values

Kind Name Value
Parameter domain 'AUTO'

Parameters:

Name Type Description Default
named_sockets dict

Sockets created with string names

 {}
ui_shortcut int

parameter ui_shortcut

 0
sockets dict

Socket created with python name attributes

 {}
Source code in core/generated/geometry.py 
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
@classmethod
def viewer(cls, named_sockets: dict = {}, ui_shortcut = 0, **sockets):
    """ > Node Viewer

    **Fixed values**

    | Kind      | Name     | Value    |
    | --------- | -------- | -------- |
    | Parameter | `domain` | `'AUTO'` |

    Parameters
    ----------
    named_sockets : dict, default={}
        Sockets created with string names

    ui_shortcut : int
        parameter `ui_shortcut`

    sockets : dict, default={}
        Socket created with python name attributes

    """
    node = Node('Viewer', named_sockets, domain='AUTO', ui_shortcut=ui_shortcut, **sockets)
    return