Skip to content

Layer

Bases: Domain, Layer

Layer domain of GreasePencil

Source code in core/domains.py 
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
class Layer(Domain, generated.Layer):
    """ > Layer domain of GreasePencil

    """

    DOMAIN_NAME = 'LAYER'

    @property
    def count(self):
        """ > Socket 'Instance Count' of node Domain Size

        Returns
        -------
        Integer
        """
        return self._geo.domain_size().layer_count

count property

Socket 'Instance Count' of node Domain Size

Returns:

Type Description
Integer

__init__(geometry)

Base class for geometry domains

A domain stores the default value to be set in node needing a domain parameter such as 'Store Named Attibute.

All nodes requiring a domain parameter are implemented as domain method

cube = Mesh.Cube()
cube.faces.store_named_attribute() # doamin = 'FACE'

When a node as a Selection socket, the value can be set using the get item syntax:

    # Plug the value of 'my_selection` into Selection socket
    Mesh().points[my_selection].store_named_attribute("Name", value)

Important

Domains are never instantiated directly but created by geometries.

The domain specific to geometries are the followings: - Mesh: - points (class Vertex) - faces (class Face) - edges (class Edge) - corners (clas Corner) - Curve: - points (class SplinePoint) - splines (class Spline) - GreasePencil: - layers (class Layer) - Instances - insts (class Instance) - Cloud - points (class CloudPoint) - Volume

All the domain classes are a subclass of Domain. Vertex, SplinePoint and SplinePoint classes are subclasses of Point.

See: Vertex, Face, Edge, Corner, SplinePoint, Spline, CloudPoint, Instance

Properties

_geo : Geometry the geometry the domain belongs to

Source code in core/domain_class.py 
 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
def __init__(self, geometry: Geometry):
    """ > Base class for geometry domains

    A domain stores the default value to be set in node needing a **domain** parameter
    such as 'Store Named Attibute.

    All nodes requiring a domain parameter are implemented as domain method

    ``` python
    cube = Mesh.Cube()
    cube.faces.store_named_attribute() # doamin = 'FACE'
    ```

    When a node as a ***Selection*** socket, the value can be set using the get item syntax:

    ``` python
        # Plug the value of 'my_selection` into Selection socket
        Mesh().points[my_selection].store_named_attribute("Name", value)
    ```

    !!! important
        Domains are never instantiated directly but created by geometries.

    The domain specific to geometries are the followings:
        - Mesh:
            - points (class Vertex)
            - faces (class Face)
            - edges (class Edge)
            - corners (clas Corner)
        - Curve:
            - points (class SplinePoint)
            - splines (class Spline)
        - GreasePencil:
            - layers (class Layer)
        - Instances
            - insts (class Instance)
        - Cloud
            - points (class CloudPoint)
        - Volume

    All the domain classes are a subclass of Domain.
    Vertex, SplinePoint and SplinePoint classes are subclasses of Point.

    > See: Vertex, Face, Edge, Corner, SplinePoint, Spline, CloudPoint, Instance

    Properties
    ----------
    _geo : Geometry
        the geometry the domain belongs to
    """

    # ---------------------------------------------------------------------------
    # Geom interface initialization
    # ---------------------------------------------------------------------------

    self._geo = geometry
    self._selection = None

    # ---------------------------------------------------------------------------
    # Node cache interface initialization
    # ---------------------------------------------------------------------------

    self._cache_reset()

accumulate_field(value=None, group_id=None) classmethod

Node Accumulate Field

Fixed values

Kind Name Value
Parameter data_type from value type
Parameter domain 'LAYER'

Parameters:

Name Type Description Default
value Float | Integer | Vector | Matrix

socket 'Value' (id: Value)

 None
group_id Integer

socket 'Group ID' (id: Group Index)

 None

Returns:

Type Description
Float

peer sockets: trailing_ (Float), total_ (Float)
Source code in core/generated/dom_layer.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
@classmethod
def accumulate_field(cls, value: Float | Integer | Vector | Matrix = None, group_id: Integer = None):
    """ > Node Accumulate Field

    **Fixed values**

    | Kind      | Name        | Value             |
    | --------- | ----------- | ----------------- |
    | Parameter | `data_type` | from `value` type |
    | Parameter | `domain`    | `'LAYER'`         |

    Parameters
    ----------
    value : Float | Integer | Vector | Matrix, optional
        socket 'Value' (id: Value)

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


    Returns
    -------
    Float
        peer sockets: trailing_ (Float), total_ (Float)

    """
    data_type = SocketType.get_data_type_for_node(value, 'GeometryNodeAccumulateField')
    node = Node('Accumulate Field', {'Value': value, 'Group Index': group_id}, data_type=data_type, domain='LAYER')
    return node._out

active_element() classmethod

Node Active Element

Fixed values

Kind Name Value
Parameter domain 'LAYER'

Returns:

Type Description
Integer

peer sockets: exists_ (Boolean)
Source code in core/generated/dom_layer.py 
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
@classmethod
def active_element(cls):
    """ > Node Active Element

    **Fixed values**

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

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

    """
    node = Node('Active Element', domain='LAYER')
    return node._out

attribute_statistic(attribute=None)

Node Attribute Statistic

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter data_type from attribute type
Parameter domain 'LAYER'

Parameters:

Name Type Description Default
attribute Float | Vector

socket 'Attribute' (id: Attribute)

 None

Returns:

Type Description
Float

peer sockets: median_ (Float), sum_ (Float), min_ (Float), max_ (Float), range_ (Float), standard_deviation_ (Float), variance_ (Float)
Source code in core/generated/dom_layer.py 
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
def attribute_statistic(self, attribute: Float | Vector = None):
    """ > Node Attribute Statistic

    **Fixed values**

    | Kind      | Name        | Value                 |
    | --------- | ----------- | --------------------- |
    | Socket    | Geometry    | `self`                |
    | Socket    | Selection   | `self[selection]`     |
    | Parameter | `data_type` | from `attribute` type |
    | Parameter | `domain`    | `'LAYER'`             |

    Parameters
    ----------
    attribute : Float | Vector, optional
        socket 'Attribute' (id: Attribute)


    Returns
    -------
    Float
        peer sockets: median_ (Float), sum_ (Float), min_ (Float), max_ (Float), range_ (Float), standard_deviation_ (Float), variance_ (Float)

    """
    data_type = SocketType.get_data_type_for_node(attribute, 'GeometryNodeAttributeStatistic')
    node = Node('Attribute Statistic', {'Geometry': self, 'Selection': self.get_selection(), 'Attribute': attribute}, data_type=data_type, domain='LAYER')
    return node._out

capture(attribute=None, **attributes)

Node Capture Attribute

[&JUMP]

Short name for capture_attribute

Parameters:

Name Type Description Default
attribute Socket

first attribute to capture

 None
**attributes dict

named attributes to capture

 {}

Returns:

Type Description
Node or Socket
Source code in core/domain_class.py 
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
def capture(self, attribute=None, **attributes):
    """ > Node Capture Attribute

    [&JUMP]

    > Short name for capture_attribute

    Parameters
    ----------
    attribute : Socket
        first attribute to capture

    **attributes : dict, default={}
        named attributes to capture

    Returns
    -------
    Node or Socket
    """
    return self.capture_attribute(attribute=attribute, **attributes)

capture_attribute(attribute=None, **attributes)

Node Capture Attribute

[&JUMP]

Caution

When there is only one attribute, the function returns the captured attribute, otherwise returns the node.

with GeoNodes("Capture Attribute"):
    # Capture several attributes
    node = mesh.points.capture_attribute(attr1 = attr1, attr2=attr2)
    captured_attr1 = node.attr1
    captured_attr2 = node.attr2

    # Capture one single attribute
    captured_attr = mesh.points.capture_attribute(my_attr=attr1)

    # Capture one attribute without key
    captured_attr3 = mesh.points.capture_attribute(attr3)

Parameters:

Name Type Description Default
attribute Socket

first attribute to capture

 None
**attributes dict(Sockets): named attributes to capture
{}

Returns:

Type Description
Node or Socket
Source code in core/domain_class.py 
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
def capture_attribute(self, attribute=None, **attributes):
    """ > Node Capture Attribute

    [&JUMP]

    !!! caution

        When there is only one attribute, the function returns the captured attribute,
        otherwise returns the node.

    ``` python
    with GeoNodes("Capture Attribute"):
        # Capture several attributes
        node = mesh.points.capture_attribute(attr1 = attr1, attr2=attr2)
        captured_attr1 = node.attr1
        captured_attr2 = node.attr2

        # Capture one single attribute
        captured_attr = mesh.points.capture_attribute(my_attr=attr1)

        # Capture one attribute without key
        captured_attr3 = mesh.points.capture_attribute(attr3)
    ```

    Parameters
    ----------
    attribute : Socket
        first attribute to capture

    **attributes : dict(Sockets): named attributes to capture

    Returns
    -------
    Node or Socket
    """
    if len(attributes) == 0:
        attrs = {'attribute': attribute}
    else:
        if attribute is None:
            attrs = attributes
        else:
            attrs = {'attribute': attribute, **attributes}

    node = Node('Capture Attribute', {'Geometry': self._geo, **attrs})

    #node._set_items('capture_items', **attrs)
    self._jump(node._out)
    return node.socket_by_index('OUTPUT', 1)

delete(mode='ALL')

Node Delete Geometry

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter domain 'LAYER'

Parameters:

Name Type Description Default
mode Literal['All', 'Only Edges & Faces', 'Only Faces']

parameter mode

 'ALL'

Returns:

Type Description
Geometry
Source code in core/generated/dom_layer.py 
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
def delete(self, mode: Literal['ALL', 'EDGE_FACE', 'ONLY_FACE'] = 'ALL'):
    """ > Node Delete Geometry

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

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Geometry  | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `domain`  | `'LAYER'`         |

    Parameters
    ----------
    mode : Literal['All', 'Only Edges & Faces', 'Only Faces']
        parameter `mode`


    Returns
    -------
    Geometry
    """
    utils.check_enum_arg('Delete Geometry', 'mode', mode, 'delete', ('ALL', 'EDGE_FACE', 'ONLY_FACE'))
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='LAYER', mode=mode)
    self._jump(node._out)
    return self._domain_to_geometry

delete_all()

Node Delete Geometry

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter domain 'LAYER'
Parameter mode 'ALL'

Returns:

Type Description
Geometry
Source code in core/generated/dom_layer.py 
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
def delete_all(self):
    """ > Node Delete Geometry

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

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Geometry  | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `domain`  | `'LAYER'`         |
    | Parameter | `mode`    | `'ALL'`           |

    Returns
    -------
    Geometry
    """
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='LAYER', mode='ALL')
    self._jump(node._out)
    return self._domain_to_geometry

delete_edge_face()

Node Delete Geometry

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter domain 'LAYER'
Parameter mode 'EDGE_FACE'

Returns:

Type Description
Geometry
Source code in core/generated/dom_layer.py 
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
def delete_edge_face(self):
    """ > Node Delete Geometry

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

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Geometry  | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `domain`  | `'LAYER'`         |
    | Parameter | `mode`    | `'EDGE_FACE'`     |

    Returns
    -------
    Geometry
    """
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='LAYER', mode='EDGE_FACE')
    self._jump(node._out)
    return self._domain_to_geometry

delete_geometry(mode='ALL')

Node Delete Geometry

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter domain 'LAYER'

Parameters:

Name Type Description Default
mode Literal['All', 'Only Edges & Faces', 'Only Faces']

parameter mode

 'ALL'

Returns:

Type Description
Geometry
Source code in core/generated/dom_layer.py 
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
def delete_geometry(self, mode: Literal['ALL', 'EDGE_FACE', 'ONLY_FACE'] = 'ALL'):
    """ > Node Delete Geometry

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

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Geometry  | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `domain`  | `'LAYER'`         |

    Parameters
    ----------
    mode : Literal['All', 'Only Edges & Faces', 'Only Faces']
        parameter `mode`


    Returns
    -------
    Geometry
    """
    utils.check_enum_arg('Delete Geometry', 'mode', mode, 'delete_geometry', ('ALL', 'EDGE_FACE', 'ONLY_FACE'))
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='LAYER', mode=mode)
    self._jump(node._out)
    return self._domain_to_geometry

delete_geometry_all()

Node Delete Geometry

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter domain 'LAYER'
Parameter mode 'ALL'

Returns:

Type Description
Geometry
Source code in core/generated/dom_layer.py 
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
def delete_geometry_all(self):
    """ > Node Delete Geometry

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

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Geometry  | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `domain`  | `'LAYER'`         |
    | Parameter | `mode`    | `'ALL'`           |

    Returns
    -------
    Geometry
    """
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='LAYER', mode='ALL')
    self._jump(node._out)
    return self._domain_to_geometry

delete_geometry_edge_face()

Node Delete Geometry

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter domain 'LAYER'
Parameter mode 'EDGE_FACE'

Returns:

Type Description
Geometry
Source code in core/generated/dom_layer.py 
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
def delete_geometry_edge_face(self):
    """ > Node Delete Geometry

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

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Geometry  | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `domain`  | `'LAYER'`         |
    | Parameter | `mode`    | `'EDGE_FACE'`     |

    Returns
    -------
    Geometry
    """
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='LAYER', mode='EDGE_FACE')
    self._jump(node._out)
    return self._domain_to_geometry

delete_geometry_only_face()

Node Delete Geometry

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter domain 'LAYER'
Parameter mode 'ONLY_FACE'

Returns:

Type Description
Geometry
Source code in core/generated/dom_layer.py 
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
def delete_geometry_only_face(self):
    """ > Node Delete Geometry

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

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Geometry  | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `domain`  | `'LAYER'`         |
    | Parameter | `mode`    | `'ONLY_FACE'`     |

    Returns
    -------
    Geometry
    """
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='LAYER', mode='ONLY_FACE')
    self._jump(node._out)
    return self._domain_to_geometry

delete_only_face()

Node Delete Geometry

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter domain 'LAYER'
Parameter mode 'ONLY_FACE'

Returns:

Type Description
Geometry
Source code in core/generated/dom_layer.py 
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
def delete_only_face(self):
    """ > Node Delete Geometry

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

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Geometry  | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `domain`  | `'LAYER'`         |
    | Parameter | `mode`    | `'ONLY_FACE'`     |

    Returns
    -------
    Geometry
    """
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='LAYER', mode='ONLY_FACE')
    self._jump(node._out)
    return self._domain_to_geometry

duplicate(amount=None)

Node Duplicate Elements

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter domain 'LAYER'

Parameters:

Name Type Description Default
amount Integer

socket 'Amount' (id: Amount)

 None

Returns:

Type Description
Geometry

peer sockets: duplicate_index_ (Integer)
Source code in core/generated/dom_layer.py 
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
def duplicate(self, amount: Integer = None):
    """ > Node Duplicate Elements

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

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Geometry  | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `domain`  | `'LAYER'`         |

    Parameters
    ----------
    amount : Integer, optional
        socket 'Amount' (id: Amount)


    Returns
    -------
    Geometry
        peer sockets: duplicate_index_ (Integer)

    """
    node = Node('Duplicate Elements', {'Geometry': self, 'Selection': self.get_selection(), 'Amount': amount}, domain='LAYER')
    self._jump(node._out)
    return self._domain_to_geometry

evaluate_at_index(value=None, index=None) classmethod

Node Evaluate at Index

Fixed values

Kind Name Value
Parameter data_type from value type
Parameter domain 'LAYER'

Parameters:

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

socket 'Value' (id: Value)

 None
index Integer

socket 'Index' (id: Index)

 None

Returns:

Type Description
Float
Source code in core/generated/dom_layer.py 
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
@classmethod
def evaluate_at_index(cls,
                value: Float | Integer | Boolean | Vector | Color | Rotation | Matrix = None,
                index: Integer = None):
    """ > Node Evaluate at Index

    **Fixed values**

    | Kind      | Name        | Value             |
    | --------- | ----------- | ----------------- |
    | Parameter | `data_type` | from `value` type |
    | Parameter | `domain`    | `'LAYER'`         |

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

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


    Returns
    -------
    Float
    """
    data_type = SocketType.get_data_type_for_node(value, 'GeometryNodeFieldAtIndex')
    node = Node('Evaluate at Index', {'Value': value, 'Index': index}, data_type=data_type, domain='LAYER')
    return node._out

evaluate_on_domain(value=None) classmethod

Node Evaluate on Domain

Fixed values

Kind Name Value
Parameter data_type from value type
Parameter domain 'LAYER'

Parameters:

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

socket 'Value' (id: Value)

 None

Returns:

Type Description
Float
Source code in core/generated/dom_layer.py 
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
@classmethod
def evaluate_on_domain(cls,
                value: Float | Integer | Boolean | Vector | Color | Rotation | Matrix = None):
    """ > Node Evaluate on Domain

    **Fixed values**

    | Kind      | Name        | Value             |
    | --------- | ----------- | ----------------- |
    | Parameter | `data_type` | from `value` type |
    | Parameter | `domain`    | `'LAYER'`         |

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


    Returns
    -------
    Float
    """
    data_type = SocketType.get_data_type_for_node(value, 'GeometryNodeFieldOnDomain')
    node = Node('Evaluate on Domain', {'Value': value}, data_type=data_type, domain='LAYER')
    return node._out

field_average(value=None, group_id=None, domain='POINT') classmethod

Node Field Average

Fixed values

Kind Name Value
Parameter data_type from value type

Parameters:

Name Type Description Default
value Float | Vector

socket 'Value' (id: Value)

 None
group_id Integer

socket 'Group ID' (id: Group Index)

 None
domain Literal['Point', 'Edge', 'Face', 'Face Corner', 'Spline', 'Instance', 'Layer']

parameter domain

 'POINT'

Returns:

Type Description
Float

peer sockets: median_ (Float)
Source code in core/generated/dom_layer.py 
 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
@classmethod
def field_average(cls,
                value: Float | Vector = None,
                group_id: Integer = None,
                domain: Literal['POINT', 'EDGE', 'FACE', 'CORNER', 'CURVE', 'INSTANCE', 'LAYER'] = 'POINT'):
    """ > Node Field Average

    **Fixed values**

    | Kind      | Name        | Value             |
    | --------- | ----------- | ----------------- |
    | Parameter | `data_type` | from `value` type |

    Parameters
    ----------
    value : Float | Vector, optional
        socket 'Value' (id: Value)

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

    domain : Literal['Point', 'Edge', 'Face', 'Face Corner', 'Spline', 'Instance', 'Layer']
        parameter `domain`


    Returns
    -------
    Float
        peer sockets: median_ (Float)

    """
    utils.check_enum_arg('Field Average', 'domain', domain, 'field_average', ('POINT', 'EDGE', 'FACE', 'CORNER', 'CURVE', 'INSTANCE', 'LAYER'))
    data_type = SocketType.get_data_type_for_node(value, 'GeometryNodeFieldAverage')
    node = Node('Field Average', {'Value': value, 'Group Index': group_id}, data_type=data_type, domain=domain)
    return node._out

field_min_max(value=None, group_id=None, domain='POINT') classmethod

Node Field Min & Max

Fixed values

Kind Name Value
Parameter data_type from value type

Parameters:

Name Type Description Default
value Float | Integer | Vector

socket 'Value' (id: Value)

 None
group_id Integer

socket 'Group ID' (id: Group Index)

 None
domain Literal['Point', 'Edge', 'Face', 'Face Corner', 'Spline', 'Instance', 'Layer']

parameter domain

 'POINT'

Returns:

Type Description
Float

peer sockets: max_ (Float)
Source code in core/generated/dom_layer.py 
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
@classmethod
def field_min_max(cls,
                value: Float | Integer | Vector = None,
                group_id: Integer = None,
                domain: Literal['POINT', 'EDGE', 'FACE', 'CORNER', 'CURVE', 'INSTANCE', 'LAYER'] = 'POINT'):
    """ > Node Field Min & Max

    **Fixed values**

    | Kind      | Name        | Value             |
    | --------- | ----------- | ----------------- |
    | Parameter | `data_type` | from `value` type |

    Parameters
    ----------
    value : Float | Integer | Vector, optional
        socket 'Value' (id: Value)

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

    domain : Literal['Point', 'Edge', 'Face', 'Face Corner', 'Spline', 'Instance', 'Layer']
        parameter `domain`


    Returns
    -------
    Float
        peer sockets: max_ (Float)

    """
    utils.check_enum_arg('Field Min & Max', 'domain', domain, 'field_min_max', ('POINT', 'EDGE', 'FACE', 'CORNER', 'CURVE', 'INSTANCE', 'LAYER'))
    data_type = SocketType.get_data_type_for_node(value, 'GeometryNodeFieldMinAndMax')
    node = Node('Field Min & Max', {'Value': value, 'Group Index': group_id}, data_type=data_type, domain=domain)
    return node._out

field_variance(value=None, group_id=None, domain='POINT') classmethod

Node Field Variance

Fixed values

Kind Name Value
Parameter data_type from value type

Parameters:

Name Type Description Default
value Float | Vector

socket 'Value' (id: Value)

 None
group_id Integer

socket 'Group ID' (id: Group Index)

 None
domain Literal['Point', 'Edge', 'Face', 'Face Corner', 'Spline', 'Instance', 'Layer']

parameter domain

 'POINT'

Returns:

Type Description
Float

peer sockets: variance_ (Float)
Source code in core/generated/dom_layer.py 
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
@classmethod
def field_variance(cls,
                value: Float | Vector = None,
                group_id: Integer = None,
                domain: Literal['POINT', 'EDGE', 'FACE', 'CORNER', 'CURVE', 'INSTANCE', 'LAYER'] = 'POINT'):
    """ > Node Field Variance

    **Fixed values**

    | Kind      | Name        | Value             |
    | --------- | ----------- | ----------------- |
    | Parameter | `data_type` | from `value` type |

    Parameters
    ----------
    value : Float | Vector, optional
        socket 'Value' (id: Value)

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

    domain : Literal['Point', 'Edge', 'Face', 'Face Corner', 'Spline', 'Instance', 'Layer']
        parameter `domain`


    Returns
    -------
    Float
        peer sockets: variance_ (Float)

    """
    utils.check_enum_arg('Field Variance', 'domain', domain, 'field_variance', ('POINT', 'EDGE', 'FACE', 'CORNER', 'CURVE', 'INSTANCE', 'LAYER'))
    data_type = SocketType.get_data_type_for_node(value, 'GeometryNodeFieldVariance')
    node = Node('Field Variance', {'Value': value, 'Group Index': group_id}, data_type=data_type, domain=domain)
    return node._out

for_each_element(named_sockets={}, selection=None, **sockets)

Simulation zone

Parameters:

Name Type Description Default
named_sockets dict

named sockets default={}.

 {}
selection Boolean

selection default=None.

 None
sockets dict

other sockets

 {}

Returns:

Type Description
ZoneIterator
Source code in core/domain_class.py 
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
def for_each_element(self, named_sockets: dict={}, selection=None, **sockets):
    """ Simulation zone

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

    selection : Boolean, optional
        selection default=None.

    sockets : dict
        other sockets


    Returns
    -------
    ZoneIterator
    """

    # Selection socket
    if selection is None:
        selection = self.get_selection()

    #if "selection" not in [k.lower() for k in {**named_sockets, **sockets}.keys()]:
    #    named_sockets = {"Selection": self.get_selection(), **named_sockets}

    # Node Zone
    #node = ZoneNode('For Each Element', self._geo, named_sockets=named_sockets, domain=self.DOMAIN_NAME, **sockets)
    node = ZoneNode.ForEach(geometry=self._geo, selection=selection, named_sockets=named_sockets, domain=self.DOMAIN_NAME, **sockets)

    return ZoneIterator(self._geo, node)

get_selection()

Get the selection from Gometry and/or from Domain

Source code in core/domain_class.py 
154
155
156
157
158
159
160
161
162
163
164
165
def get_selection(self):
    """ Get the selection from Gometry and/or from Domain
    """
    dom_sel = super().get_selection()        
    geo_sel = self._geo.get_selection()

    if dom_sel is None:
        return geo_sel
    elif geo_sel is None:
        return dom_sel
    else:
        return dom_sel & geo_sel

named_selection(name=None) classmethod

Node Named Layer Selection

Parameters:

Name Type Description Default
name String

socket 'Name' (id: Name)

 None

Returns:

Type Description
Boolean
Source code in core/generated/dom_layer.py 
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
@classmethod
def named_selection(cls, name: String = None):
    """ > Node Named Layer Selection

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


    Returns
    -------
    Boolean
    """
    node = Node('Named Layer Selection', {'Name': name})
    return node._out

sample_index(value=None, index=None, clamp=False)

Node Sample Index

Fixed values

Kind Name Value
Socket Geometry self
Parameter data_type from value type
Parameter domain 'LAYER'

Parameters:

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

socket 'Value' (id: Value)

 None
index Integer

socket 'Index' (id: Index)

 None
clamp bool

parameter clamp

 False

Returns:

Type Description
Float
Source code in core/generated/dom_layer.py 
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
def sample_index(self,
                value: Float | Integer | Boolean | Vector | Color | Rotation | Matrix = None,
                index: Integer = None,
                clamp = False):
    """ > Node Sample Index

    **Fixed values**

    | Kind      | Name        | Value             |
    | --------- | ----------- | ----------------- |
    | Socket    | Geometry    | `self`            |
    | Parameter | `data_type` | from `value` type |
    | Parameter | `domain`    | `'LAYER'`         |

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

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

    clamp : bool
        parameter `clamp`


    Returns
    -------
    Float
    """
    data_type = SocketType.get_data_type_for_node(value, 'GeometryNodeSampleIndex')
    node = Node('Sample Index', {'Geometry': self, 'Value': value, 'Index': index}, clamp=clamp, data_type=data_type, domain='LAYER')
    return node._out

separate()

Node Separate Geometry

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter domain 'LAYER'

Returns:

Type Description
node[selection(Geometry), inverted(Geometry)]
Source code in core/generated/dom_layer.py 
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
def separate(self):
    """ > Node Separate Geometry

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

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Geometry  | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `domain`  | `'LAYER'`         |

    Returns
    -------
    node [selection (Geometry), inverted (Geometry)]
    """
    node = Node('Separate Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='LAYER')
    self._jump(node._out)
    return node

split_to_instances(group_id=None)

Node Split to Instances

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter domain 'LAYER'

Parameters:

Name Type Description Default
group_id Integer

socket 'Group ID' (id: Group ID)

 None

Returns:

Type Description
Instances

peer sockets: group_id_ (Integer)
Source code in core/generated/dom_layer.py 
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
def split_to_instances(self, group_id: Integer = None):
    """ > Node Split to Instances

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Geometry  | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `domain`  | `'LAYER'`         |

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


    Returns
    -------
    Instances
        peer sockets: group_id_ (Integer)

    """
    node = Node('Split to Instances', {'Geometry': self, 'Selection': self.get_selection(), 'Group ID': group_id}, domain='LAYER')
    return node._out

store(name=None, value=None)

Node Store Named Attribute

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter data_type from value type
Parameter domain 'LAYER'

Parameters:

Name Type Description Default
name String

socket 'Name' (id: Name)

 None
value Float | Integer | Boolean | Vector | Color | Rotation | Matrix | Integer | Vector | Color

socket 'Value' (id: Value)

 None

Returns:

Type Description
Geometry
Source code in core/generated/dom_layer.py 
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
def store(self,
                name: String = None,
                value: Float | Integer | Boolean | Vector | Color | Rotation | Matrix | Integer | Vector | Color = None):
    """ > Node Store Named Attribute

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

    **Fixed values**

    | Kind      | Name        | Value             |
    | --------- | ----------- | ----------------- |
    | Socket    | Geometry    | `self`            |
    | Socket    | Selection   | `self[selection]` |
    | Parameter | `data_type` | from `value` type |
    | Parameter | `domain`    | `'LAYER'`         |

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

    value : Float | Integer | Boolean | Vector | Color | Rotation | Matrix | Integer | Vector | Color, optional
        socket 'Value' (id: Value)


    Returns
    -------
    Geometry
    """
    data_type = SocketType.get_data_type_for_node(value, 'GeometryNodeStoreNamedAttribute')
    node = Node('Store Named Attribute', {'Geometry': self, 'Selection': self.get_selection(), 'Name': name, 'Value': value}, data_type=data_type, domain='LAYER')
    self._jump(node._out)
    return self._domain_to_geometry

store_named_attribute(name=None, value=None)

Node Store Named Attribute

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter data_type from value type
Parameter domain 'LAYER'

Parameters:

Name Type Description Default
name String

socket 'Name' (id: Name)

 None
value Float | Integer | Boolean | Vector | Color | Rotation | Matrix | Integer | Vector | Color

socket 'Value' (id: Value)

 None

Returns:

Type Description
Geometry
Source code in core/generated/dom_layer.py 
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
def store_named_attribute(self,
                name: String = None,
                value: Float | Integer | Boolean | Vector | Color | Rotation | Matrix | Integer | Vector | Color = None):
    """ > Node Store Named Attribute

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

    **Fixed values**

    | Kind      | Name        | Value             |
    | --------- | ----------- | ----------------- |
    | Socket    | Geometry    | `self`            |
    | Socket    | Selection   | `self[selection]` |
    | Parameter | `data_type` | from `value` type |
    | Parameter | `domain`    | `'LAYER'`         |

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

    value : Float | Integer | Boolean | Vector | Color | Rotation | Matrix | Integer | Vector | Color, optional
        socket 'Value' (id: Value)


    Returns
    -------
    Geometry
    """
    data_type = SocketType.get_data_type_for_node(value, 'GeometryNodeStoreNamedAttribute')
    node = Node('Store Named Attribute', {'Geometry': self, 'Selection': self.get_selection(), 'Name': name, 'Value': value}, data_type=data_type, domain='LAYER')
    self._jump(node._out)
    return self._domain_to_geometry

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

Node Viewer

Fixed values

Kind Name Value
Parameter domain 'LAYER'

Parameters:

Name Type Description Default
named_sockets dict

Sockets created with string names

 {}
ui_shortcut int

parameter ui_shortcut

 0
sockets dict

Socket created with python name attributes

 {}
Source code in core/generated/dom_layer.py 
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
@classmethod
def viewer(cls, named_sockets: dict = {}, ui_shortcut = 0, **sockets):
    """ > Node Viewer

    **Fixed values**

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

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

    ui_shortcut : int
        parameter `ui_shortcut`

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

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