Skip to content

Integer

Bases: Integer

Source code in core/sock_integer.py 
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
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
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
180
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
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
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
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
369
370
371
372
373
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
class Integer(generated.Integer):

    SOCKET_TYPE = 'INT'

    def __init__(self,
        value = None,
        name    : str = None,
        min     : int = -2147483648,
        max     : int = 2147483647,
        tip     : str = '',
        panel   : str = "",
        **props):
        """ > Integer Input

        New Integer input with subtype 'NONE'.

        Parameters
        ----------
        value : object, default=0
            Default value

        name : str, default='Integer'
            Input socket name

        min : int, default=-2147483648
            Property min_value

        max : int, default=2147483647
            Property max_value

        tip : str, default=''
            Property description

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

        props : dic
            properties


        Returns
        -------
        Integer
        """
        super().__init__(value, name, min=min, max=max, tip=tip, panel=panel, **props)


    # ====================================================================================================
    # Default input constructors
    # ('VALUE', 'INDEX', 'ID_OR_INDEX')

    @classmethod
    def Index(cls, name="Index", tip=None, panel="", hide_in_modifier=True):
        """ > Index Integer group input

        New Integer input with Index as default value (default_input='INDEX')

        !!! note
            By default, 'hide_in_modifier' is set to True

        Returns
        -------
        Integer
        """
        return cls(value=None, name=name, tip=tip, panel=panel, default_input='INDEX', hide_in_modifier=hide_in_modifier)

    @classmethod
    def IdOrIndex(cls, name="ID or Index", tip=None, panel="", hide_in_modifier=True):
        """ > ID or Index Integer group input

        New Integer input with 'ID or Index' as default value (default_input='ID_OR_INDEX')

        !!! note
            By default, 'hide_in_modifier' is set to True

        Returns
        -------
        Integer
        """
        return cls(value=None, name=name, tip=tip, panel=panel, default_input='ID_OR_INDEX', hide_in_modifier=hide_in_modifier)

    # ====================================================================================================
    # Constructors

    @classmethod
    def FromFloat(cls, float=None, rounding_mode='ROUND'):
        from .sock_float import Float
        return Float(float).to_integer(rounding_mode)

    # ====================================================================================================
    # Methods

    # ----- Mix

    def mix(self, factor=None, other=None, clamp_factor=None):
        """ > Mix

        > Node Mix

        Parameters
        ----------
        factor : Float
            socket 'Factor' (Factor_Float)

        other : Socket
            socket 'B' (B_Float)

        clamp_factor : bool
            Node.clamp_factor

        Returns
        -------
        Socket
        """
        from .sock_float import Float
        return Float(Node('Mix', {'Factor': factor, 'A': self, 'B': other}, clamp_factor=clamp_factor, data_type='FLOAT')._out)

    # ====================================================================================================
    # Operations

    # ----- Neg

    def __neg__(self):
        return self.negate()

    # ----- Abs

    def __abs__(self):
        return self.abs()

    # ----- Addition

    def __add__(self, other):
        from .generated import gnmath
        if utils.is_vector_like(other):
            return gnmath.vadd(self, other)
        elif utils.is_int_like(other):
            return self.add( other)
        else:
            return gnmath.add(self, other)

    def __radd__(self, other):
        from .generated import gnmath
        if utils.is_vector_like(other):
            return gnmath.vadd(other, self)
        elif utils.is_int_like(other):
            return self.add(other)
        else:
            return gnmath.add(other, self)

    def __iadd__(self, other):
        return self._jump(self.add(other))

    # ----- Subtraction

    def __sub__(self, other):
        from .generated import gnmath
        if utils.is_vector_like(other):
            return gnmath.vsubtract(self, other)
        elif utils.is_int_like(other):
            return self.subtract(other)
        else:
            return gnmath.subtract(self, other)

    def __rsub__(self, other):
        from .generated import gnmath
        if utils.is_vector_like(other):
            return gnmath.vsubtract(other, self)
        elif utils.is_int_like(other):
            return gnmath.isubtract(other, self)
        else:
            return gnmath.subtract(other, self)

    def __isub__(self, other):
        return self._jump(self.subtract(other))

    # ----- Multiplication

    def __mul__(self, other):
        from .generated import gnmath
        if utils.is_vector_like(other):
            return gnmath.scale(other, self)
        elif utils.is_int_like(other):
            return self.multiply(other)
        else:
            return gnmath.multiply(self, other)

    def __rmul__(self, other):
        from .generated import gnmath
        if utils.is_vector_like(other):
            return gnmath.scale(other, self)
        elif utils.is_int_like(other):
            return gnmath.imultiply(other, self)
        else:
            return gnmath.multiply(other, self)

    def __imul__(self, other):
        return self._jump(self.multiply(other))

    # ----- Division

    def __floordiv__(self, other):
        return self.divide_floor(other)

    def __rfloordiv__(self, other):
        return Integer(other).divide_floor(self)

    def __ifloordiv__(self, other):
        return self._jump(self.divide_floor(other))

    # ----- Modulo

    def __mod__(self, other):
        return self.modulo(other)

    def __rmod__(self, other):
        return Integer(other).modulo(self)

    def __imod__(self, other):
        return self._jump(self.modulo(other))

    # ----- Power

    def __pow__(self, other):
        from .generated import gnmath
        if utils.is_int_like(other):
            return self.power(other)
        else:
            return gnmath.power(self, other)

    def __rpow__(self, other):
        from .generated import gnmath
        if utils.is_int_like(other):
            return Integer(other).power(self)
        else:
            return gnmath.power(other, self)

    def __ipow__(self, other):
        return self._jump(self.power(other))

    # ----- Division

    def __truediv__(self, other):
        from .sock_float import Float
        return Float(self)/other

    def __rtruediv__(self, other):
        from .sock_float import Float
        return other/Float(self)

    def __itruediv__(self, other):
        from .sock_float import Float
        return Integer(Float(self)/other)

    # =============================================================================================================================
    # Comparison
    # __eq__ __ne__ __lt__ __gt__ __le__ __ge__

    def __ge__(self, other):
        return self.greater_equal(other)

    def __gt__(self, other):
        return self.greater_than(other)

    def __le__(self, other):
        return self.less_equal(other)

    def __lt__(self, other):
        return self.less_than(other)

    def __eq__(self, other):
        return self.equal(other)

    def __ne__(self, other):
        return self.not_equal(other)

    # =============================================================================================================================
    # Bitwise
    # and, or, xor, not, shift, rotate
    # AND	&	__and__(self, other)	__iand__(self, other)
    # OR	|	__or__(self, other)	__ior__(self, other)
    # XOR	^	__xor__(self, other)	__ixor__(self, other)
    # NOT (bitwise)	~	__invert__(self)	(pas d'in-place)
    # Shift gauche	<<	__lshift__	__ilshift__
    # Shift droite	>>	__rshift__	__irshift__    

    def __invert__(self):
        return self.bw_not()


    def __and__(self, other):
        return self.bw_and(other)

    def __rand__(self, other):
        return Integer(other).bw_and(self)

    def __iand__(self, other):
        return self._jump(self.bw_and(other))


    def __or__(self, other):
        return self.bw_or(other)

    def __ror__(self, other):
        return Integer(other).bw_or(self)

    def __ior__(self, other):
        return self._jump(self.bw_or(other))


    def __xor__(self, other):
        return self.bw_xor(other)

    def __rxor__(self, other):
        return Integer(other).bw_xor(self)

    def __ixor__(self, other):
        return self._jump(self.bw_xor(other))


    def __lshift__(self, other):
        return self.bw_shift(other)

    def __ilshift__(self, other):
        return self._jump(self.bw_shift(other))

    def __rshift__(self, other):
        return self.bw_shift(-other)

    def __irshift__(self, other):
        return self._jump(self.bw_shift(-other))

    # ====================================================================================================
    # Class test    
    # ====================================================================================================

    @classmethod
    def _class_test(cls):

        from geonodes import GeoNodes, Mesh, Layout, Integer

        with GeoNodes("Integer Test"):

            with Layout("Base"):
                a = Integer(123)
                a += Integer(name="Your entry")
                a *= Integer(1, name="Mul (1 def)")

            with Layout("Named Attribute"):
                g = Mesh()
                g.points.An_Int = a

                b = Integer("An Int") - a
                g.faces.store("Another integer", b)

            with Layout("Grid Attribute"):
                vol = g.to_volume()
                vol.store_named_grid("Int A", a)

            vol.out()

_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

_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 ""

is_grid property

bool property

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

node_color property writable

Node color

Returns:

Type Description
SysColor

node_label property writable

Node Label

Returns:

Type Description
str

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 
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
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
@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(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(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('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':
        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':
        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 
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
@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(cls.SOCKET_TYPE).get_default_from_value(value)
    return socket

Factor(value=0, name='Factor', min=-2147483648, max=2147483647, tip='', panel='', optional_label=False, hide_value=False, hide_in_modifier=False, default_attribute='', default_input='VALUE', shape='AUTO') classmethod

Factor Input

New Integer input with subtype 'FACTOR'.

Parameters:

Name Type Description Default
value object

Default value

 `0`
name str

Input socket name

 `Factor`
min int

Property min_value

 `-2147483648`
max int

Property max_value

 `2147483647`
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`
default_attribute str

Property default_attribute_name

 `''`
default_input str

Property default_input in ('VALUE', 'INDEX', 'ID_OR_INDEX')

 `'VALUE'`
shape str

Property structure_type in ('AUTO', 'SINGLE')

 `'AUTO'`

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
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
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
@classmethod
def Factor(cls,
    value: object = 0,
    name: str = 'Factor',
    min: int = -2147483648,
    max: int = 2147483647,
    tip: str = '',
    panel: str = "",
    optional_label: bool = False,
    hide_value: bool = False,
    hide_in_modifier: bool = False,
    default_attribute: str = '',
    default_input: Literal['VALUE', 'INDEX', 'ID_OR_INDEX'] = 'VALUE',
    shape: Literal['AUTO', 'SINGLE'] = 'AUTO',
     ):
    """ > Factor Input

    New Integer input with subtype 'FACTOR'.

    Parameters
    ----------
    value : object, default=`0`
        Default value

    name : str, default=`Factor`
        Input socket name

    min : int, default=`-2147483648`
        Property min_value

    max : int, default=`2147483647`
        Property max_value

    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

    default_attribute : str, default=`''`
        Property default_attribute_name

    default_input : str, default=`'VALUE'`
        Property default_input in ('VALUE', 'INDEX', 'ID_OR_INDEX')

    shape : str, default=`'AUTO'`
        Property structure_type in ('AUTO', 'SINGLE')


    Returns
    -------
    Integer
    """
    return cls(value=value, name=name, min=min, max=max, tip=tip, panel=panel,
        optional_label=optional_label, hide_value=hide_value, hide_in_modifier=hide_in_modifier,
        default_attribute=default_attribute, default_input=default_input, shape=shape, subtype='FACTOR')

IdOrIndex(name='ID or Index', tip=None, panel='', hide_in_modifier=True) classmethod

ID or Index Integer group input

New Integer input with 'ID or Index' as default value (default_input='ID_OR_INDEX')

Note

By default, 'hide_in_modifier' is set to True

Returns:

Type Description
Integer
Source code in core/sock_integer.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
@classmethod
def IdOrIndex(cls, name="ID or Index", tip=None, panel="", hide_in_modifier=True):
    """ > ID or Index Integer group input

    New Integer input with 'ID or Index' as default value (default_input='ID_OR_INDEX')

    !!! note
        By default, 'hide_in_modifier' is set to True

    Returns
    -------
    Integer
    """
    return cls(value=None, name=name, tip=tip, panel=panel, default_input='ID_OR_INDEX', hide_in_modifier=hide_in_modifier)

Index(name='Index', tip=None, panel='', hide_in_modifier=True) classmethod

Index Integer group input

New Integer input with Index as default value (default_input='INDEX')

Note

By default, 'hide_in_modifier' is set to True

Returns:

Type Description
Integer
Source code in core/sock_integer.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
@classmethod
def Index(cls, name="Index", tip=None, panel="", hide_in_modifier=True):
    """ > Index Integer group input

    New Integer input with Index as default value (default_input='INDEX')

    !!! note
        By default, 'hide_in_modifier' is set to True

    Returns
    -------
    Integer
    """
    return cls(value=None, name=name, tip=tip, panel=panel, default_input='INDEX', hide_in_modifier=hide_in_modifier)

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 
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
@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
    """
    #return IndexSwitchNode(*values, index=index, data_type=cls.input_type())._out
    return MenuNode('Index Switch', 
                    {str(i): value for i, value in enumerate(values)}, 
                    data_type=cls.SOCKET_TYPE, 
                    Index=index,
                    default_menu = default_index)._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 
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
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
@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(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

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 
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
@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 = MenuNode('Menu Switch',
            named_sockets = named_sockets,
            data_type = SocketType(cls.SOCKET_TYPE).type,
            default_menu = default_menu,
            **sockets)

    return cls(node._out)

Named(name=None) classmethod

Node Named Attribute

Fixed values

Kind Name Value
Parameter data_type 'INT'

Parameters:

Name Type Description Default
name String

socket 'Name' (id: Name)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
@classmethod
def Named(cls, name: String = None):
    """ > Node Named Attribute

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Parameter | `data_type` | `'INT'` |

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


    Returns
    -------
    Integer
    """
    node = Node('Named Attribute', {'Name': name}, data_type='INT')
    return cls(node._out)

NamedAttribute(name=None) classmethod

Node Named Attribute

Fixed values

Kind Name Value
Parameter data_type 'INT'

Parameters:

Name Type Description Default
name String

socket 'Name' (id: Name)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
@classmethod
def NamedAttribute(cls, name: String = None):
    """ > Node Named Attribute

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Parameter | `data_type` | `'INT'` |

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


    Returns
    -------
    Integer
    """
    node = Node('Named Attribute', {'Name': name}, data_type='INT')
    return cls(node._out)

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 
410
411
412
413
414
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
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
@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(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(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(cls.SOCKET_TYPE).socket_id,
        name         = name,
        tip          = tip,
        panel        = panel,
        **props))

Percentage(value=0, name='Percentage', min=-2147483648, max=2147483647, tip='', panel='', optional_label=False, hide_value=False, hide_in_modifier=False, default_attribute='', default_input='VALUE', shape='AUTO') classmethod

Percentage Input

New Integer input with subtype 'PERCENTAGE'.

Parameters:

Name Type Description Default
value object

Default value

 `0`
name str

Input socket name

 `Percentage`
min int

Property min_value

 `-2147483648`
max int

Property max_value

 `2147483647`
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`
default_attribute str

Property default_attribute_name

 `''`
default_input str

Property default_input in ('VALUE', 'INDEX', 'ID_OR_INDEX')

 `'VALUE'`
shape str

Property structure_type in ('AUTO', 'SINGLE')

 `'AUTO'`

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
1356
1357
1358
1359
1360
1361
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
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
@classmethod
def Percentage(cls,
    value: object = 0,
    name: str = 'Percentage',
    min: int = -2147483648,
    max: int = 2147483647,
    tip: str = '',
    panel: str = "",
    optional_label: bool = False,
    hide_value: bool = False,
    hide_in_modifier: bool = False,
    default_attribute: str = '',
    default_input: Literal['VALUE', 'INDEX', 'ID_OR_INDEX'] = 'VALUE',
    shape: Literal['AUTO', 'SINGLE'] = 'AUTO',
     ):
    """ > Percentage Input

    New Integer input with subtype 'PERCENTAGE'.

    Parameters
    ----------
    value : object, default=`0`
        Default value

    name : str, default=`Percentage`
        Input socket name

    min : int, default=`-2147483648`
        Property min_value

    max : int, default=`2147483647`
        Property max_value

    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

    default_attribute : str, default=`''`
        Property default_attribute_name

    default_input : str, default=`'VALUE'`
        Property default_input in ('VALUE', 'INDEX', 'ID_OR_INDEX')

    shape : str, default=`'AUTO'`
        Property structure_type in ('AUTO', 'SINGLE')


    Returns
    -------
    Integer
    """
    return cls(value=value, name=name, min=min, max=max, tip=tip, panel=panel,
        optional_label=optional_label, hide_value=hide_value, hide_in_modifier=hide_in_modifier,
        default_attribute=default_attribute, default_input=default_input, shape=shape, subtype='PERCENTAGE')

Random(min=None, max=None, id=None, seed=None) classmethod

Node Random Value

Fixed values

Kind Name Value
Parameter data_type 'INT'

Parameters:

Name Type Description Default
min Integer

socket 'Min' (id: Min_002)

 None
max Integer

socket 'Max' (id: Max_002)

 None
id Integer

socket 'ID' (id: ID)

 None
seed Integer

socket 'Seed' (id: Seed)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
740
741
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
@classmethod
def Random(cls,
                min: Integer = None,
                max: Integer = None,
                id: Integer = None,
                seed: Integer = None):
    """ > Node Random Value

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Parameter | `data_type` | `'INT'` |

    Parameters
    ----------
    min : Integer, optional
        socket 'Min' (id: Min_002)

    max : Integer, optional
        socket 'Max' (id: Max_002)

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

    seed : Integer, optional
        socket 'Seed' (id: Seed)


    Returns
    -------
    Integer
    """
    node = Node('Random Value', {'Min_002': min, 'Max_002': max, 'ID': id, 'Seed': seed}, data_type='INT')
    return cls(node._out)

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
Source code in core/socket_class.py 
1416
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
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
@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
    """
    input_type = SocketType(cls.SOCKET_TYPE).items_type
    return Node('Switch', {'Switch': condition, 'False': false, 'True': true}, input_type=input_type)._out

__init__(value=None, name=None, min=-2147483648, max=2147483647, tip='', panel='', **props)

Integer Input

New Integer input with subtype 'NONE'.

Parameters:

Name Type Description Default
value object

Default value

 0
name str

Input socket name

 'Integer'
min int

Property min_value

 -2147483648
max int

Property max_value

 2147483647
tip str

Property description

 ''
panel str

Panel name default="".

 ''
props dic

properties

 {}

Returns:

Type Description
Integer
Source code in core/sock_integer.py 
52
53
54
55
56
57
58
59
60
61
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
def __init__(self,
    value = None,
    name    : str = None,
    min     : int = -2147483648,
    max     : int = 2147483647,
    tip     : str = '',
    panel   : str = "",
    **props):
    """ > Integer Input

    New Integer input with subtype 'NONE'.

    Parameters
    ----------
    value : object, default=0
        Default value

    name : str, default='Integer'
        Input socket name

    min : int, default=-2147483648
        Property min_value

    max : int, default=2147483647
        Property max_value

    tip : str, default=''
        Property description

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

    props : dic
        properties


    Returns
    -------
    Integer
    """
    super().__init__(value, name, min=min, max=max, tip=tip, panel=panel, **props)

_create_input_socket(value=0, name='Integer', min=-2147483648, max=2147483647, tip='', panel='', optional_label=False, hide_value=False, hide_in_modifier=False, default_attribute='', default_input='VALUE', shape='AUTO', subtype='NONE') classmethod

Integer Input

New Integer input with subtype 'NONE'.

Parameters:

Name Type Description Default
value object

Default value

 `0`
name str

Input socket name

 `Integer`
min int

Property min_value

 `-2147483648`
max int

Property max_value

 `2147483647`
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`
default_attribute str

Property default_attribute_name

 `''`
default_input str

Property default_input in ('VALUE', 'INDEX', 'ID_OR_INDEX')

 `'VALUE'`
shape str

Property structure_type in ('AUTO', 'SINGLE')

 `'AUTO'`
subtype str

Socket sub type in ('NONE', 'PERCENTAGE', 'FACTOR')

 `NONE`

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
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
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
@classmethod
def _create_input_socket(cls,
    value: object = 0,
    name: str = 'Integer',
    min: int = -2147483648,
    max: int = 2147483647,
    tip: str = '',
    panel: str = "",
    optional_label: bool = False,
    hide_value: bool = False,
    hide_in_modifier: bool = False,
    default_attribute: str = '',
    default_input: Literal['VALUE', 'INDEX', 'ID_OR_INDEX'] = 'VALUE',
    shape: Literal['AUTO', 'SINGLE'] = 'AUTO',
    subtype: str = 'NONE',
     ):
    """ > Integer Input

    New Integer input with subtype 'NONE'.

    Parameters
    ----------
    value : object, default=`0`
        Default value

    name : str, default=`Integer`
        Input socket name

    min : int, default=`-2147483648`
        Property min_value

    max : int, default=`2147483647`
        Property max_value

    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

    default_attribute : str, default=`''`
        Property default_attribute_name

    default_input : str, default=`'VALUE'`
        Property default_input in ('VALUE', 'INDEX', 'ID_OR_INDEX')

    shape : str, default=`'AUTO'`
        Property structure_type in ('AUTO', 'SINGLE')

    subtype : str, default=`NONE`
        Socket sub type in ('NONE', 'PERCENTAGE', 'FACTOR')


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

    defval = utils.python_value_for_socket(value, cls.SOCKET_TYPE)

    return Tree.current_tree().create_input_socket('NodeSocketInt', default_value = defval, name=name,
        min=min, max=max, tip=tip, panel=panel, optional_label=optional_label, hide_value=hide_value,
        hide_in_modifier=hide_in_modifier, default_attribute=default_attribute, default_input=default_input,
        shape=shape, subtype=subtype)

_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 
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
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 
680
681
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
713
714
715
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 
962
963
964
965
966
967
968
969
970
971
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 _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 
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
def _ul(self, label : str):
    """ Set the user label

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


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

abs()

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'ABSOLUTE'

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
def abs(self):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value        |
    | --------- | ----------- | ------------ |
    | Socket    | Value       | `self`       |
    | Parameter | `operation` | `'ABSOLUTE'` |

    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self}, operation='ABSOLUTE')
    return node._out

add(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'ADD'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
def add(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Value       | `self`  |
    | Parameter | `operation` | `'ADD'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='ADD')
    return node._out

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 
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
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
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)

advect_grid(velocity=None, time_step=None, integration_scheme=None, limiter=None)

Node Advect Grid

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
velocity Vector

socket 'Velocity' (id: Velocity)

 None
time_step Float

socket 'Time Step' (id: Time Step)

 None
integration_scheme menu='Runge-Kutta 3'

('Semi-Lagrangian', 'Midpoint', 'Runge-Kutta 3', 'Runge-Kutta 4', 'MacCormack', 'BFECC')

 None
limiter menu='Clamp'

('None', 'Clamp', 'Revert')

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
947
948
949
950
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
976
977
978
979
980
981
def advect_grid(self,
                velocity: Vector = None,
                time_step: Float = None,
                integration_scheme: Literal['Semi-Lagrangian', 'Midpoint', 'Runge-Kutta 3', 'Runge-Kutta 4', 'MacCormack', 'BFECC'] = None,
                limiter: Literal['None', 'Clamp', 'Revert'] = None):
    """ > Node Advect Grid

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

    Parameters
    ----------
    velocity : Vector, optional
        socket 'Velocity' (id: Velocity)

    time_step : Float, optional
        socket 'Time Step' (id: Time Step)

    integration_scheme : menu='Runge-Kutta 3', optional
        ('Semi-Lagrangian', 'Midpoint', 'Runge-Kutta 3', 'Runge-Kutta 4', 'MacCormack', 'BFECC')

    limiter : menu='Clamp', optional
        ('None', 'Clamp', 'Revert')


    Returns
    -------
    Integer
    """
    node = Node('Advect Grid', {'Grid': self, 'Velocity': velocity, 'Time Step': time_step, 'Integration Scheme': integration_scheme, 'Limiter': limiter}, data_type='INT')
    return node._out

blur(iterations=None, weight=None)

Node Blur Attribute

Fixed values

Kind Name Value
Socket Value self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
iterations Integer

socket 'Iterations' (id: Iterations)

 None
weight Float

socket 'Weight' (id: Weight)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
def blur(self, iterations: Integer = None, weight: Float = None):
    """ > Node Blur Attribute

    **Fixed values**

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

    Parameters
    ----------
    iterations : Integer, optional
        socket 'Iterations' (id: Iterations)

    weight : Float, optional
        socket 'Weight' (id: Weight)


    Returns
    -------
    Integer
    """
    node = Node('Blur Attribute', {'Value': self, 'Iterations': iterations, 'Weight': weight}, data_type='INT')
    return node._out

bw_and(b=None)

Node Bit Math

Fixed values

Kind Name Value
Socket A self
Parameter operation 'AND'

Parameters:

Name Type Description Default
b Integer

socket 'B' (id: B)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def bw_and(self, b: Integer = None):
    """ > Node Bit Math

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | A           | `self`  |
    | Parameter | `operation` | `'AND'` |

    Parameters
    ----------
    b : Integer, optional
        socket 'B' (id: B)


    Returns
    -------
    Integer
    """
    node = Node('Bit Math', {'A': self, 'B': b}, operation='AND')
    return node._out

bw_not()

Node Bit Math

Fixed values

Kind Name Value
Socket A self
Parameter operation 'NOT'

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def bw_not(self):
    """ > Node Bit Math

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | A           | `self`  |
    | Parameter | `operation` | `'NOT'` |

    Returns
    -------
    Integer
    """
    node = Node('Bit Math', {'A': self}, operation='NOT')
    return node._out

bw_or(b=None)

Node Bit Math

Fixed values

Kind Name Value
Socket A self
Parameter operation 'OR'

Parameters:

Name Type Description Default
b Integer

socket 'B' (id: B)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def bw_or(self, b: Integer = None):
    """ > Node Bit Math

    **Fixed values**

    | Kind      | Name        | Value  |
    | --------- | ----------- | ------ |
    | Socket    | A           | `self` |
    | Parameter | `operation` | `'OR'` |

    Parameters
    ----------
    b : Integer, optional
        socket 'B' (id: B)


    Returns
    -------
    Integer
    """
    node = Node('Bit Math', {'A': self, 'B': b}, operation='OR')
    return node._out

bw_rotate(shift=None)

Node Bit Math

Fixed values

Kind Name Value
Socket A self
Parameter operation 'ROTATE'

Parameters:

Name Type Description Default
shift Integer

socket 'Shift' (id: Shift)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
def bw_rotate(self, shift: Integer = None):
    """ > Node Bit Math

    **Fixed values**

    | Kind      | Name        | Value      |
    | --------- | ----------- | ---------- |
    | Socket    | A           | `self`     |
    | Parameter | `operation` | `'ROTATE'` |

    Parameters
    ----------
    shift : Integer, optional
        socket 'Shift' (id: Shift)


    Returns
    -------
    Integer
    """
    node = Node('Bit Math', {'A': self, 'Shift': shift}, operation='ROTATE')
    return node._out

bw_shift(shift=None)

Node Bit Math

Fixed values

Kind Name Value
Socket A self
Parameter operation 'SHIFT'

Parameters:

Name Type Description Default
shift Integer

socket 'Shift' (id: Shift)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
def bw_shift(self, shift: Integer = None):
    """ > Node Bit Math

    **Fixed values**

    | Kind      | Name        | Value     |
    | --------- | ----------- | --------- |
    | Socket    | A           | `self`    |
    | Parameter | `operation` | `'SHIFT'` |

    Parameters
    ----------
    shift : Integer, optional
        socket 'Shift' (id: Shift)


    Returns
    -------
    Integer
    """
    node = Node('Bit Math', {'A': self, 'Shift': shift}, operation='SHIFT')
    return node._out

bw_xor(b=None)

Node Bit Math

Fixed values

Kind Name Value
Socket A self
Parameter operation 'XOR'

Parameters:

Name Type Description Default
b Integer

socket 'B' (id: B)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def bw_xor(self, b: Integer = None):
    """ > Node Bit Math

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | A           | `self`  |
    | Parameter | `operation` | `'XOR'` |

    Parameters
    ----------
    b : Integer, optional
        socket 'B' (id: B)


    Returns
    -------
    Integer
    """
    node = Node('Bit Math', {'A': self, 'B': b}, operation='XOR')
    return node._out

clip_grid(min_x=None, min_y=None, min_z=None, max_x=None, max_y=None, max_z=None)

Node Clip Grid

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
min_x Integer

socket 'Min X' (id: Min X)

 None
min_y Integer

socket 'Min Y' (id: Min Y)

 None
min_z Integer

socket 'Min Z' (id: Min Z)

 None
max_x Integer

socket 'Max X' (id: Max X)

 None
max_y Integer

socket 'Max Y' (id: Max Y)

 None
max_z Integer

socket 'Max Z' (id: Max Z)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
1134
1135
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
def clip_grid(self,
                min_x: Integer = None,
                min_y: Integer = None,
                min_z: Integer = None,
                max_x: Integer = None,
                max_y: Integer = None,
                max_z: Integer = None):
    """ > Node Clip Grid

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

    Parameters
    ----------
    min_x : Integer, optional
        socket 'Min X' (id: Min X)

    min_y : Integer, optional
        socket 'Min Y' (id: Min Y)

    min_z : Integer, optional
        socket 'Min Z' (id: Min Z)

    max_x : Integer, optional
        socket 'Max X' (id: Max X)

    max_y : Integer, optional
        socket 'Max Y' (id: Max Y)

    max_z : Integer, optional
        socket 'Max Z' (id: Max Z)


    Returns
    -------
    Integer
    """
    node = Node('Clip Grid', {'Grid': self, 'Min X': min_x, 'Min Y': min_y, 'Min Z': min_z, 'Max X': max_x, 'Max Y': max_y, 'Max Z': max_z}, data_type='INT')
    return node._out

divide(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'DIVIDE'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
def divide(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value      |
    | --------- | ----------- | ---------- |
    | Socket    | Value       | `self`     |
    | Parameter | `operation` | `'DIVIDE'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='DIVIDE')
    return node._out

divide_ceil(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'DIVIDE_CEIL'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
def divide_ceil(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value           |
    | --------- | ----------- | --------------- |
    | Socket    | Value       | `self`          |
    | Parameter | `operation` | `'DIVIDE_CEIL'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='DIVIDE_CEIL')
    return node._out

divide_floor(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'DIVIDE_FLOOR'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
def divide_floor(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value            |
    | --------- | ----------- | ---------------- |
    | Socket    | Value       | `self`           |
    | Parameter | `operation` | `'DIVIDE_FLOOR'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='DIVIDE_FLOOR')
    return node._out

divide_round(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'DIVIDE_ROUND'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
def divide_round(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value            |
    | --------- | ----------- | ---------------- |
    | Socket    | Value       | `self`           |
    | Parameter | `operation` | `'DIVIDE_ROUND'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='DIVIDE_ROUND')
    return node._out

enable_output(enable=None)

Node Enable Output

Fixed values

Kind Name Value
Socket Value self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
enable Boolean

socket 'Enable' (id: Enable)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
def enable_output(self, enable: Boolean = None):
    """ > Node Enable Output

    **Fixed values**

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

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


    Returns
    -------
    Integer
    """
    node = Node('Enable Output', {'Enable': enable, 'Value': self}, data_type='INT')
    return node._out

equal(b=None)

Node Compare

Fixed values

Kind Name Value
Socket A self
Parameter data_type 'INT'
Parameter mode 'ELEMENT'
Parameter operation 'EQUAL'

Parameters:

Name Type Description Default
b Integer

socket 'B' (id: B_INT)

 None

Returns:

Type Description
Boolean
Source code in core/generated/integer.py 
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
def equal(self, b: Integer = None):
    """ > Node Compare

    **Fixed values**

    | Kind      | Name        | Value       |
    | --------- | ----------- | ----------- |
    | Socket    | A           | `self`      |
    | Parameter | `data_type` | `'INT'`     |
    | Parameter | `mode`      | `'ELEMENT'` |
    | Parameter | `operation` | `'EQUAL'`   |

    Parameters
    ----------
    b : Integer, optional
        socket 'B' (id: B_INT)


    Returns
    -------
    Boolean
    """
    node = Node('Compare', {'A_INT': self, 'B_INT': b}, data_type='INT', mode='ELEMENT', operation='EQUAL')
    return node._out

field_to_grid(named_sockets={}, **sockets)

Node Field to Grid

Fixed values

Kind Name Value
Socket Topology self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
named_sockets dict

Sockets created with string names

 {}
sockets dict

Socket created with python name attributes

 {}

Returns:

Type Description
None
Source code in core/generated/integer.py 
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
def field_to_grid(self, named_sockets: dict = {}, **sockets):
    """ > Node Field to Grid

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Topology    | `self`  |
    | Parameter | `data_type` | `'INT'` |

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

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

    Returns
    -------
    None
    """
    node = Node('Field to Grid', {'Topology': self, **named_sockets}, data_type='INT', **sockets)
    return node._out

floored_modulo(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'FLOORED_MODULO'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
def floored_modulo(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value              |
    | --------- | ----------- | ------------------ |
    | Socket    | Value       | `self`             |
    | Parameter | `operation` | `'FLOORED_MODULO'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='FLOORED_MODULO')
    return node._out

gcd(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'GCD'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
def gcd(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Value       | `self`  |
    | Parameter | `operation` | `'GCD'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='GCD')
    return node._out

greater_equal(b=None)

Node Compare

Fixed values

Kind Name Value
Socket A self
Parameter data_type 'INT'
Parameter mode 'ELEMENT'
Parameter operation 'GREATER_EQUAL'

Parameters:

Name Type Description Default
b Integer

socket 'B' (id: B_INT)

 None

Returns:

Type Description
Boolean
Source code in core/generated/integer.py 
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 greater_equal(self, b: Integer = None):
    """ > Node Compare

    **Fixed values**

    | Kind      | Name        | Value             |
    | --------- | ----------- | ----------------- |
    | Socket    | A           | `self`            |
    | Parameter | `data_type` | `'INT'`           |
    | Parameter | `mode`      | `'ELEMENT'`       |
    | Parameter | `operation` | `'GREATER_EQUAL'` |

    Parameters
    ----------
    b : Integer, optional
        socket 'B' (id: B_INT)


    Returns
    -------
    Boolean
    """
    node = Node('Compare', {'A_INT': self, 'B_INT': b}, data_type='INT', mode='ELEMENT', operation='GREATER_EQUAL')
    return node._out

greater_than(b=None)

Node Compare

Fixed values

Kind Name Value
Socket A self
Parameter data_type 'INT'
Parameter mode 'ELEMENT'
Parameter operation 'GREATER_THAN'

Parameters:

Name Type Description Default
b Integer

socket 'B' (id: B_INT)

 None

Returns:

Type Description
Boolean
Source code in core/generated/integer.py 
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 greater_than(self, b: Integer = None):
    """ > Node Compare

    **Fixed values**

    | Kind      | Name        | Value            |
    | --------- | ----------- | ---------------- |
    | Socket    | A           | `self`           |
    | Parameter | `data_type` | `'INT'`          |
    | Parameter | `mode`      | `'ELEMENT'`      |
    | Parameter | `operation` | `'GREATER_THAN'` |

    Parameters
    ----------
    b : Integer, optional
        socket 'B' (id: B_INT)


    Returns
    -------
    Boolean
    """
    node = Node('Compare', {'A_INT': self, 'B_INT': b}, data_type='INT', mode='ELEMENT', operation='GREATER_THAN')
    return node._out

grid_dilate_erode(connectivity=None, tiles=None, steps=None)

Node Grid Dilate & Erode

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
connectivity menu='Face'

('Face', 'Edge', 'Vertex')

 None
tiles menu='Preserve'

('Ignore', 'Expand', 'Preserve')

 None
steps Integer

socket 'Steps' (id: Steps)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
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
def grid_dilate_erode(self,
                connectivity: Literal['Face', 'Edge', 'Vertex'] = None,
                tiles: Literal['Ignore', 'Expand', 'Preserve'] = None,
                steps: Integer = None):
    """ > Node Grid Dilate & Erode

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

    Parameters
    ----------
    connectivity : menu='Face', optional
        ('Face', 'Edge', 'Vertex')

    tiles : menu='Preserve', optional
        ('Ignore', 'Expand', 'Preserve')

    steps : Integer, optional
        socket 'Steps' (id: Steps)


    Returns
    -------
    Integer
    """
    node = Node('Grid Dilate & Erode', {'Grid': self, 'Connectivity': connectivity, 'Tiles': tiles, 'Steps': steps}, data_type='INT')
    return node._out

grid_info()

Node Grid Info

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Returns:

Type Description
Matrix

peer sockets: background_value_ (Integer)
Source code in core/generated/integer.py 
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
def grid_info(self):
    """ > Node Grid Info

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

    Returns
    -------
    Matrix
        peer sockets: background_value_ (Integer)

    """
    node = Node('Grid Info', {'Grid': self}, data_type='INT')
    return node._out

grid_mean(width=None, iterations=None)

Node Grid Mean

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
width Integer

socket 'Width' (id: Width)

 None
iterations Integer

socket 'Iterations' (id: Iterations)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
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
def grid_mean(self, width: Integer = None, iterations: Integer = None):
    """ > Node Grid Mean

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

    Parameters
    ----------
    width : Integer, optional
        socket 'Width' (id: Width)

    iterations : Integer, optional
        socket 'Iterations' (id: Iterations)


    Returns
    -------
    Integer
    """
    node = Node('Grid Mean', {'Grid': self, 'Width': width, 'Iterations': iterations}, data_type='INT')
    return node._out

grid_median(width=None, iterations=None)

Node Grid Median

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
width Integer

socket 'Width' (id: Width)

 None
iterations Integer

socket 'Iterations' (id: Iterations)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
def grid_median(self, width: Integer = None, iterations: Integer = None):
    """ > Node Grid Median

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

    Parameters
    ----------
    width : Integer, optional
        socket 'Width' (id: Width)

    iterations : Integer, optional
        socket 'Iterations' (id: Iterations)


    Returns
    -------
    Integer
    """
    node = Node('Grid Median', {'Grid': self, 'Width': width, 'Iterations': iterations}, data_type='INT')
    return node._out

grid_to_points()

Node Grid to Points

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Returns:

Type Description
Cloud

peer sockets: value_ (Integer), x_ (Integer), y_ (Integer), z_ (Integer), is_tile_ (Boolean), extent_ (Integer)
Source code in core/generated/integer.py 
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
def grid_to_points(self):
    """ > Node Grid to Points

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

    Returns
    -------
    Cloud
        peer sockets: value_ (Integer), x_ (Integer), y_ (Integer), z_ (Integer), is_tile_ (Boolean), extent_ (Integer)

    """
    node = Node('Grid to Points', {'Grid': self}, data_type='INT')
    return node._out

hash_value(seed=None)

Node Hash Value

Fixed values

Kind Name Value
Socket Value self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
seed Integer

socket 'Seed' (id: Seed)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
def hash_value(self, seed: Integer = None):
    """ > Node Hash Value

    **Fixed values**

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

    Parameters
    ----------
    seed : Integer, optional
        socket 'Seed' (id: Seed)


    Returns
    -------
    Integer
    """
    node = Node('Hash Value', {'Value': self, 'Seed': seed}, data_type='INT')
    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 
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
1398
1399
1400
1401
1402
1403
1404
1405
1406
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)

lcm(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'LCM'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
def lcm(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Value       | `self`  |
    | Parameter | `operation` | `'LCM'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='LCM')
    return node._out

less_equal(b=None)

Node Compare

Fixed values

Kind Name Value
Socket A self
Parameter data_type 'INT'
Parameter mode 'ELEMENT'
Parameter operation 'LESS_EQUAL'

Parameters:

Name Type Description Default
b Integer

socket 'B' (id: B_INT)

 None

Returns:

Type Description
Boolean
Source code in core/generated/integer.py 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
def less_equal(self, b: Integer = None):
    """ > Node Compare

    **Fixed values**

    | Kind      | Name        | Value          |
    | --------- | ----------- | -------------- |
    | Socket    | A           | `self`         |
    | Parameter | `data_type` | `'INT'`        |
    | Parameter | `mode`      | `'ELEMENT'`    |
    | Parameter | `operation` | `'LESS_EQUAL'` |

    Parameters
    ----------
    b : Integer, optional
        socket 'B' (id: B_INT)


    Returns
    -------
    Boolean
    """
    node = Node('Compare', {'A_INT': self, 'B_INT': b}, data_type='INT', mode='ELEMENT', operation='LESS_EQUAL')
    return node._out

less_than(b=None)

Node Compare

Fixed values

Kind Name Value
Socket A self
Parameter data_type 'INT'
Parameter mode 'ELEMENT'
Parameter operation 'LESS_THAN'

Parameters:

Name Type Description Default
b Integer

socket 'B' (id: B_INT)

 None

Returns:

Type Description
Boolean
Source code in core/generated/integer.py 
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
def less_than(self, b: Integer = None):
    """ > Node Compare

    **Fixed values**

    | Kind      | Name        | Value         |
    | --------- | ----------- | ------------- |
    | Socket    | A           | `self`        |
    | Parameter | `data_type` | `'INT'`       |
    | Parameter | `mode`      | `'ELEMENT'`   |
    | Parameter | `operation` | `'LESS_THAN'` |

    Parameters
    ----------
    b : Integer, optional
        socket 'B' (id: B_INT)


    Returns
    -------
    Boolean
    """
    node = Node('Compare', {'A_INT': self, 'B_INT': b}, data_type='INT', mode='ELEMENT', operation='LESS_THAN')
    return node._out

Link input sockets of the node

Allow to chain input sockets linking.

Source code in core/socket_class.py 
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
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 
1021
1022
1023
1024
1025
1026
1027
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

max(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'MAXIMUM'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
def max(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value       |
    | --------- | ----------- | ----------- |
    | Socket    | Value       | `self`      |
    | Parameter | `operation` | `'MAXIMUM'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='MAXIMUM')
    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 
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
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)

min(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'MINIMUM'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
def min(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value       |
    | --------- | ----------- | ----------- |
    | Socket    | Value       | `self`      |
    | Parameter | `operation` | `'MINIMUM'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='MINIMUM')
    return node._out

mix(factor=None, other=None, clamp_factor=None)

Mix

Node Mix

Parameters:

Name Type Description Default
factor Float

socket 'Factor' (Factor_Float)

 None
other Socket

socket 'B' (B_Float)

 None
clamp_factor bool

Node.clamp_factor

 None

Returns:

Type Description
Socket
Source code in core/sock_integer.py 
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
def mix(self, factor=None, other=None, clamp_factor=None):
    """ > Mix

    > Node Mix

    Parameters
    ----------
    factor : Float
        socket 'Factor' (Factor_Float)

    other : Socket
        socket 'B' (B_Float)

    clamp_factor : bool
        Node.clamp_factor

    Returns
    -------
    Socket
    """
    from .sock_float import Float
    return Float(Node('Mix', {'Factor': factor, 'A': self, 'B': other}, clamp_factor=clamp_factor, data_type='FLOAT')._out)

modulo(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'MODULO'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
def modulo(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value      |
    | --------- | ----------- | ---------- |
    | Socket    | Value       | `self`     |
    | Parameter | `operation` | `'MODULO'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='MODULO')
    return node._out

multiply(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'MULTIPLY'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
def multiply(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value        |
    | --------- | ----------- | ------------ |
    | Socket    | Value       | `self`       |
    | Parameter | `operation` | `'MULTIPLY'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='MULTIPLY')
    return node._out

multiply_add(multiplier=None, addend=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'MULTIPLY_ADD'

Parameters:

Name Type Description Default
multiplier Integer

socket 'Multiplier' (id: Value_001)

 None
addend Integer

socket 'Addend' (id: Value_002)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
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
def multiply_add(self, multiplier: Integer = None, addend: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value            |
    | --------- | ----------- | ---------------- |
    | Socket    | Value       | `self`           |
    | Parameter | `operation` | `'MULTIPLY_ADD'` |

    Parameters
    ----------
    multiplier : Integer, optional
        socket 'Multiplier' (id: Value_001)

    addend : Integer, optional
        socket 'Addend' (id: Value_002)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': multiplier, 'Value_002': addend}, operation='MULTIPLY_ADD')
    return node._out

negate()

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'NEGATE'

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
def negate(self):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value      |
    | --------- | ----------- | ---------- |
    | Socket    | Value       | `self`     |
    | Parameter | `operation` | `'NEGATE'` |

    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self}, operation='NEGATE')
    return node._out

not_equal(b=None)

Node Compare

Fixed values

Kind Name Value
Socket A self
Parameter data_type 'INT'
Parameter mode 'ELEMENT'
Parameter operation 'NOT_EQUAL'

Parameters:

Name Type Description Default
b Integer

socket 'B' (id: B_INT)

 None

Returns:

Type Description
Boolean
Source code in core/generated/integer.py 
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
def not_equal(self, b: Integer = None):
    """ > Node Compare

    **Fixed values**

    | Kind      | Name        | Value         |
    | --------- | ----------- | ------------- |
    | Socket    | A           | `self`        |
    | Parameter | `data_type` | `'INT'`       |
    | Parameter | `mode`      | `'ELEMENT'`   |
    | Parameter | `operation` | `'NOT_EQUAL'` |

    Parameters
    ----------
    b : Integer, optional
        socket 'B' (id: B_INT)


    Returns
    -------
    Boolean
    """
    node = Node('Compare', {'A_INT': self, 'B_INT': b}, data_type='INT', mode='ELEMENT', operation='NOT_EQUAL')
    return node._out

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

power(exponent=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Base self
Parameter operation 'POWER'

Parameters:

Name Type Description Default
exponent Integer

socket 'Exponent' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
def power(self, exponent: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value     |
    | --------- | ----------- | --------- |
    | Socket    | Base        | `self`    |
    | Parameter | `operation` | `'POWER'` |

    Parameters
    ----------
    exponent : Integer, optional
        socket 'Exponent' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': exponent}, operation='POWER')
    return node._out

prune_grid(mode=None, threshold=None)

Node Prune Grid

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
mode menu='Threshold'

('Inactive', 'Threshold', 'SDF')

 None
threshold Integer

socket 'Threshold' (id: Threshold)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
def prune_grid(self,
                mode: Literal['Inactive', 'Threshold', 'SDF'] = None,
                threshold: Integer = None):
    """ > Node Prune Grid

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

    Parameters
    ----------
    mode : menu='Threshold', optional
        ('Inactive', 'Threshold', 'SDF')

    threshold : Integer, optional
        socket 'Threshold' (id: Threshold)


    Returns
    -------
    Integer
    """
    node = Node('Prune Grid', {'Grid': self, 'Mode': mode, 'Threshold': threshold}, data_type='INT')
    return node._out

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 
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
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)

sample_grid(position=None, interpolation=None)

Node Sample Grid

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
position Vector

socket 'Position' (id: Position)

 None
interpolation menu='Trilinear'

('Nearest Neighbor', 'Trilinear', 'Triquadratic')

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
def sample_grid(self,
                position: Vector = None,
                interpolation: Literal['Nearest Neighbor', 'Trilinear', 'Triquadratic'] = None):
    """ > Node Sample Grid

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

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

    interpolation : menu='Trilinear', optional
        ('Nearest Neighbor', 'Trilinear', 'Triquadratic')


    Returns
    -------
    Integer
    """
    node = Node('Sample Grid', {'Grid': self, 'Position': position, 'Interpolation': interpolation}, data_type='INT')
    return node._out

sample_grid_index(x=None, y=None, z=None)

Node Sample Grid Index

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
x Integer

socket 'X' (id: X)

 None
y Integer

socket 'Y' (id: Y)

 None
z Integer

socket 'Z' (id: Z)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
def sample_grid_index(self, x: Integer = None, y: Integer = None, z: Integer = None):
    """ > Node Sample Grid Index

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

    Parameters
    ----------
    x : Integer, optional
        socket 'X' (id: X)

    y : Integer, optional
        socket 'Y' (id: Y)

    z : Integer, optional
        socket 'Z' (id: Z)


    Returns
    -------
    Integer
    """
    node = Node('Sample Grid Index', {'Grid': self, 'X': x, 'Y': y, 'Z': z}, data_type='INT')
    return node._out

set_grid_background(background=None, update_inactive=None)

Node Set Grid Background

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
background Integer

socket 'Background' (id: Background)

 None
update_inactive Boolean

socket 'Update Inactive' (id: Update Inactive)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
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
def set_grid_background(self, background: Integer = None, update_inactive: Boolean = None):
    """ > Node Set Grid Background

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

    Parameters
    ----------
    background : Integer, optional
        socket 'Background' (id: Background)

    update_inactive : Boolean, optional
        socket 'Update Inactive' (id: Update Inactive)


    Returns
    -------
    Integer
    """
    node = Node('Set Grid Background', {'Grid': self, 'Background': background, 'Update Inactive': update_inactive}, data_type='INT')
    return node._out

set_grid_transform(transform=None)

Node Set Grid Transform

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Parameters:

Name Type Description Default
transform Matrix

socket 'Transform' (id: Transform)

 None

Returns:

Type Description
Boolean

peer sockets: grid_ (Integer)
Source code in core/generated/integer.py 
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
def set_grid_transform(self, transform: Matrix = None):
    """ > Node Set Grid Transform

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

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


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

    """
    node = Node('Set Grid Transform', {'Grid': self, 'Transform': transform}, data_type='INT')
    return node._out

sign()

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'SIGN'

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
def sign(self):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value    |
    | --------- | ----------- | -------- |
    | Socket    | Value       | `self`   |
    | Parameter | `operation` | `'SIGN'` |

    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self}, operation='SIGN')
    return node._out

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 
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
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)

subtract(value=None)

Node Integer Math

Fixed values

Kind Name Value
Socket Value self
Parameter operation 'SUBTRACT'

Parameters:

Name Type Description Default
value Integer

socket 'Value' (id: Value_001)

 None

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
def subtract(self, value: Integer = None):
    """ > Node Integer Math

    **Fixed values**

    | Kind      | Name        | Value        |
    | --------- | ----------- | ------------ |
    | Socket    | Value       | `self`       |
    | Parameter | `operation` | `'SUBTRACT'` |

    Parameters
    ----------
    value : Integer, optional
        socket 'Value' (id: Value_001)


    Returns
    -------
    Integer
    """
    node = Node('Integer Math', {'Value': self, 'Value_001': value}, operation='SUBTRACT')
    return node._out

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.core import 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 
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
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.core import 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 
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
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_string()

Node Value to String

Fixed values

Kind Name Value
Socket Value self
Parameter data_type 'INT'

Returns:

Type Description
String
Source code in core/generated/integer.py 
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
def to_string(self):
    """ > Node Value to String

    **Fixed values**

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

    Returns
    -------
    String
    """
    node = Node('Value to String', {'Value': self}, data_type='INT')
    return node._out

voxel_index() classmethod

Node Voxel Index

Returns:

Type Description
Integer

peer sockets: y_ (Integer), z_ (Integer), is_tile_ (Boolean), extent_x_ (Integer), extent_y_ (Integer), extent_z_ (Integer)
Source code in core/generated/integer.py 
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
@classmethod
def voxel_index(cls):
    """ > Node Voxel Index

    Returns
    -------
    Integer
        peer sockets: y_ (Integer), z_ (Integer), is_tile_ (Boolean), extent_x_ (Integer), extent_y_ (Integer), extent_z_ (Integer)

    """
    node = Node('Voxel Index', )
    return node._out

voxelize_grid()

Node Voxelize Grid

Fixed values

Kind Name Value
Socket Grid self
Parameter data_type 'INT'

Returns:

Type Description
Integer
Source code in core/generated/integer.py 
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
def voxelize_grid(self):
    """ > Node Voxelize Grid

    **Fixed values**

    | Kind      | Name        | Value   |
    | --------- | ----------- | ------- |
    | Socket    | Grid        | `self`  |
    | Parameter | `data_type` | `'INT'` |

    Returns
    -------
    Integer
    """
    node = Node('Voxelize Grid', {'Grid': self}, data_type='INT')
    return node._out