Skip to content

Face

Bases: Domain, Face

Face domain of a Mesh

Source code in core/domains.py 
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
class Face(Domain, generated.Face):
    """ > Face domain of a Mesh
    """

    DOMAIN_NAME = 'FACE'

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

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

count property

Socket 'Face Count' of node Domain Size

Returns:

Type Description
Integer

material property writable

Write only property for node

material_index property writable

Property get node

normal property writable

Write only property for node

shade_smooth property writable

Property get node

smooth property writable

Property get node

__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 'FACE'

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_face.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`    | `'FACE'`          |

    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='FACE')
    return node._out

active_element() classmethod

Node Active Element

Fixed values

Kind Name Value
Parameter domain 'FACE'

Returns:

Type Description
Integer

peer sockets: exists_ (Boolean)
Source code in core/generated/dom_face.py 
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
@classmethod
def active_element(cls):
    """ > Node Active Element

    **Fixed values**

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

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

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

area()

Node Face Area

Returns:

Type Description
Float
Source code in core/generated/dom_face.py 
693
694
695
696
697
698
699
700
701
702
@utils.classproperty
def area(cls):
    """ > Node Face Area

    Returns
    -------
    Float
    """
    node = Node('Face Area', )
    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 'FACE'

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_face.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`    | `'FACE'`              |

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

corner_index(face_index=None, weights=None, sort_index=None) classmethod

Node Corners of Face

Parameters:

Name Type Description Default
face_index Integer

socket 'Face Index' (id: Face Index)

 None
weights Float

socket 'Weights' (id: Weights)

 None
sort_index Integer

socket 'Sort Index' (id: Sort Index)

 None

Returns:

Type Description
corner_index
Source code in core/generated/dom_face.py 
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
@classmethod
def corner_index(cls,
                face_index: Integer = None,
                weights: Float = None,
                sort_index: Integer = None):
    """ > Node Corners of Face

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

    weights : Float, optional
        socket 'Weights' (id: Weights)

    sort_index : Integer, optional
        socket 'Sort Index' (id: Sort Index)


    Returns
    -------
    corner_index
    """
    node = Node('Corners of Face', {'Face Index': face_index, 'Weights': weights, 'Sort Index': sort_index})
    return node.corner_index

corners(face_index=None, weights=None, sort_index=None) classmethod

Node Corners of Face

Parameters:

Name Type Description Default
face_index Integer

socket 'Face Index' (id: Face Index)

 None
weights Float

socket 'Weights' (id: Weights)

 None
sort_index Integer

socket 'Sort Index' (id: Sort Index)

 None

Returns:

Type Description
Integer

peer sockets: total_ (Integer)
Source code in core/generated/dom_face.py 
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
@classmethod
def corners(cls,
                face_index: Integer = None,
                weights: Float = None,
                sort_index: Integer = None):
    """ > Node Corners of Face

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

    weights : Float, optional
        socket 'Weights' (id: Weights)

    sort_index : Integer, optional
        socket 'Sort Index' (id: Sort Index)


    Returns
    -------
    Integer
        peer sockets: total_ (Integer)

    """
    node = Node('Corners of Face', {'Face Index': face_index, 'Weights': weights, 'Sort Index': sort_index})
    return node._out

corners_total(face_index=None, weights=None, sort_index=None) classmethod

Node Corners of Face

Parameters:

Name Type Description Default
face_index Integer

socket 'Face Index' (id: Face Index)

 None
weights Float

socket 'Weights' (id: Weights)

 None
sort_index Integer

socket 'Sort Index' (id: Sort Index)

 None

Returns:

Type Description
total
Source code in core/generated/dom_face.py 
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
@classmethod
def corners_total(cls,
                face_index: Integer = None,
                weights: Float = None,
                sort_index: Integer = None):
    """ > Node Corners of Face

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

    weights : Float, optional
        socket 'Weights' (id: Weights)

    sort_index : Integer, optional
        socket 'Sort Index' (id: Sort Index)


    Returns
    -------
    total
    """
    node = Node('Corners of Face', {'Face Index': face_index, 'Weights': weights, 'Sort Index': sort_index})
    return node.total

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

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_face.py 
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
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`  | `'FACE'`          |

    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='FACE', 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 'FACE'
Parameter mode 'ALL'

Returns:

Type Description
Geometry
Source code in core/generated/dom_face.py 
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
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`  | `'FACE'`          |
    | Parameter | `mode`    | `'ALL'`           |

    Returns
    -------
    Geometry
    """
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='FACE', 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 'FACE'
Parameter mode 'EDGE_FACE'

Returns:

Type Description
Geometry
Source code in core/generated/dom_face.py 
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
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`  | `'FACE'`          |
    | Parameter | `mode`    | `'EDGE_FACE'`     |

    Returns
    -------
    Geometry
    """
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='FACE', 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 'FACE'

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_face.py 
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
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`  | `'FACE'`          |

    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='FACE', 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 'FACE'
Parameter mode 'ALL'

Returns:

Type Description
Geometry
Source code in core/generated/dom_face.py 
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
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`  | `'FACE'`          |
    | Parameter | `mode`    | `'ALL'`           |

    Returns
    -------
    Geometry
    """
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='FACE', 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 'FACE'
Parameter mode 'EDGE_FACE'

Returns:

Type Description
Geometry
Source code in core/generated/dom_face.py 
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
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`  | `'FACE'`          |
    | Parameter | `mode`    | `'EDGE_FACE'`     |

    Returns
    -------
    Geometry
    """
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='FACE', 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 'FACE'
Parameter mode 'ONLY_FACE'

Returns:

Type Description
Geometry
Source code in core/generated/dom_face.py 
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
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`  | `'FACE'`          |
    | Parameter | `mode`    | `'ONLY_FACE'`     |

    Returns
    -------
    Geometry
    """
    node = Node('Delete Geometry', {'Geometry': self, 'Selection': self.get_selection()}, domain='FACE', 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 'FACE'
Parameter mode 'ONLY_FACE'

Returns:

Type Description
Geometry
Source code in core/generated/dom_face.py 
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
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`  | `'FACE'`          |
    | Parameter | `mode`    | `'ONLY_FACE'`     |

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

distribute_points(density=None, seed=None, distribute_method='RANDOM')

Node Distribute Points on Faces

Fixed values

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

Parameters:

Name Type Description Default
density Float

socket 'Density' (id: Density)

 None
seed Integer

socket 'Seed' (id: Seed)

 None
distribute_method Literal['Random', 'Poisson Disk']

parameter distribute_method

 'RANDOM'

Returns:

Type Description
Cloud

peer sockets: normal_ (Vector), rotation_ (Rotation)
Source code in core/generated/dom_face.py 
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
def distribute_points(self,
                density: Float = None,
                seed: Integer = None,
                distribute_method: Literal['RANDOM', 'POISSON'] = 'RANDOM'):
    """ > Node Distribute Points on Faces

    **Fixed values**

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

    Parameters
    ----------
    density : Float, optional
        socket 'Density' (id: Density)

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

    distribute_method : Literal['Random', 'Poisson Disk']
        parameter `distribute_method`


    Returns
    -------
    Cloud
        peer sockets: normal_ (Vector), rotation_ (Rotation)

    """
    utils.check_enum_arg('Distribute Points on Faces', 'distribute_method', distribute_method, 'distribute_points', ('RANDOM', 'POISSON'))
    node = Node('Distribute Points on Faces', {'Mesh': self, 'Selection': self.get_selection(), 'Density': density, 'Seed': seed}, distribute_method=distribute_method)
    return node._out

distribute_points_poisson(distance_min=None, density_max=None, density_factor=None, seed=None)

Node Distribute Points on Faces

Fixed values

Kind Name Value
Socket Mesh self
Socket Selection self[selection]
Parameter distribute_method 'POISSON'

Parameters:

Name Type Description Default
distance_min Float

socket 'Distance Min' (id: Distance Min)

 None
density_max Float

socket 'Density Max' (id: Density Max)

 None
density_factor Float

socket 'Density Factor' (id: Density Factor)

 None
seed Integer

socket 'Seed' (id: Seed)

 None

Returns:

Type Description
Cloud

peer sockets: normal_ (Vector), rotation_ (Rotation)
Source code in core/generated/dom_face.py 
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
def distribute_points_poisson(self,
                distance_min: Float = None,
                density_max: Float = None,
                density_factor: Float = None,
                seed: Integer = None):
    """ > Node Distribute Points on Faces

    **Fixed values**

    | Kind      | Name                | Value             |
    | --------- | ------------------- | ----------------- |
    | Socket    | Mesh                | `self`            |
    | Socket    | Selection           | `self[selection]` |
    | Parameter | `distribute_method` | `'POISSON'`       |

    Parameters
    ----------
    distance_min : Float, optional
        socket 'Distance Min' (id: Distance Min)

    density_max : Float, optional
        socket 'Density Max' (id: Density Max)

    density_factor : Float, optional
        socket 'Density Factor' (id: Density Factor)

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


    Returns
    -------
    Cloud
        peer sockets: normal_ (Vector), rotation_ (Rotation)

    """
    node = Node('Distribute Points on Faces', {'Mesh': self, 'Selection': self.get_selection(), 'Distance Min': distance_min, 'Density Max': density_max, 'Density Factor': density_factor, 'Seed': seed}, distribute_method='POISSON')
    return node._out

distribute_points_random(density=None, seed=None)

Node Distribute Points on Faces

Fixed values

Kind Name Value
Socket Mesh self
Socket Selection self[selection]
Parameter distribute_method 'RANDOM'

Parameters:

Name Type Description Default
density Float

socket 'Density' (id: Density)

 None
seed Integer

socket 'Seed' (id: Seed)

 None

Returns:

Type Description
Cloud

peer sockets: normal_ (Vector), rotation_ (Rotation)
Source code in core/generated/dom_face.py 
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
def distribute_points_random(self, density: Float = None, seed: Integer = None):
    """ > Node Distribute Points on Faces

    **Fixed values**

    | Kind      | Name                | Value             |
    | --------- | ------------------- | ----------------- |
    | Socket    | Mesh                | `self`            |
    | Socket    | Selection           | `self[selection]` |
    | Parameter | `distribute_method` | `'RANDOM'`        |

    Parameters
    ----------
    density : Float, optional
        socket 'Density' (id: Density)

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


    Returns
    -------
    Cloud
        peer sockets: normal_ (Vector), rotation_ (Rotation)

    """
    node = Node('Distribute Points on Faces', {'Mesh': self, 'Selection': self.get_selection(), 'Density': density, 'Seed': seed}, distribute_method='RANDOM')
    return node._out

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

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_face.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
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`  | `'FACE'`          |

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

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_face.py 
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
@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`    | `'FACE'`          |

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

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_face.py 
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
@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`    | `'FACE'`          |

    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='FACE')
    return node._out

extrude(offset=None, offset_scale=None, individual=None)

Node Extrude Mesh

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Mesh self
Socket Selection self[selection]
Parameter mode 'FACES'

Parameters:

Name Type Description Default
offset Vector

socket 'Offset' (id: Offset)

 None
offset_scale Float

socket 'Offset Scale' (id: Offset Scale)

 None
individual Boolean

socket 'Individual' (id: Individual)

 None

Returns:

Type Description
Mesh

peer sockets: top_ (Boolean), side_ (Boolean)
Source code in core/generated/dom_face.py 
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
def extrude(self,
                offset: Vector = None,
                offset_scale: Float = None,
                individual: Boolean = None):
    """ > Node Extrude Mesh

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

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Mesh      | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `mode`    | `'FACES'`         |

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

    offset_scale : Float, optional
        socket 'Offset Scale' (id: Offset Scale)

    individual : Boolean, optional
        socket 'Individual' (id: Individual)


    Returns
    -------
    Mesh
        peer sockets: top_ (Boolean), side_ (Boolean)

    """
    node = Node('Extrude Mesh', {'Mesh': self, 'Selection': self.get_selection(), 'Offset': offset, 'Offset Scale': offset_scale, 'Individual': individual}, mode='FACES')
    self._jump(node._out)
    return self._domain_to_geometry

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_face.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_face.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_face.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

is_planar(threshold=None) classmethod

Node Is Face Planar

Parameters:

Name Type Description Default
threshold Float

socket 'Threshold' (id: Threshold)

 None

Returns:

Type Description
Boolean
Source code in core/generated/dom_face.py 
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
@classmethod
def is_planar(cls, threshold: Float = None):
    """ > Node Is Face Planar

    Parameters
    ----------
    threshold : Float, optional
        socket 'Threshold' (id: Threshold)


    Returns
    -------
    Boolean
    """
    node = Node('Is Face Planar', {'Threshold': threshold})
    return node._out

neighbors()

Node Face Neighbors

Returns:

Type Description
Integer

peer sockets: face_count_ (Integer)
Source code in core/generated/dom_face.py 
721
722
723
724
725
726
727
728
729
730
731
732
@utils.classproperty
def neighbors(cls):
    """ > Node Face Neighbors

    Returns
    -------
    Integer
        peer sockets: face_count_ (Integer)

    """
    node = Node('Face Neighbors', )
    return node._out

neighbors_face_count()

Node Face Neighbors

Returns:

Type Description
face_count
Source code in core/generated/dom_face.py 
745
746
747
748
749
750
751
752
753
754
@utils.classproperty
def neighbors_face_count(cls):
    """ > Node Face Neighbors

    Returns
    -------
    face_count
    """
    node = Node('Face Neighbors', )
    return node.face_count

neighbors_vertex_count()

Node Face Neighbors

Returns:

Type Description
vertex_count
Source code in core/generated/dom_face.py 
734
735
736
737
738
739
740
741
742
743
@utils.classproperty
def neighbors_vertex_count(cls):
    """ > Node Face Neighbors

    Returns
    -------
    vertex_count
    """
    node = Node('Face Neighbors', )
    return node.vertex_count

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

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_face.py 
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
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`    | `'FACE'`          |

    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='FACE')
    return node._out

sample_nearest(sample_position=None)

Node Sample Nearest

Fixed values

Kind Name Value
Socket Geometry self
Parameter domain 'FACE'

Parameters:

Name Type Description Default
sample_position Vector

socket 'Sample Position' (id: Sample Position)

 None

Returns:

Type Description
Integer
Source code in core/generated/dom_face.py 
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
def sample_nearest(self, sample_position: Vector = None):
    """ > Node Sample Nearest

    **Fixed values**

    | Kind      | Name     | Value    |
    | --------- | -------- | -------- |
    | Socket    | Geometry | `self`   |
    | Parameter | `domain` | `'FACE'` |

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


    Returns
    -------
    Integer
    """
    node = Node('Sample Nearest', {'Geometry': self, 'Sample Position': sample_position}, domain='FACE')
    return node._out

scale(scale=None, center=None, scale_mode=None, axis=None)

Node Scale 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 'FACE'

Parameters:

Name Type Description Default
scale Float

socket 'Scale' (id: Scale)

 None
center Vector

socket 'Center' (id: Center)

 None
scale_mode menu='Uniform'

('Uniform', 'Single Axis')

 None
axis Vector

socket 'Axis' (id: Axis)

 None

Returns:

Type Description
Geometry
Source code in core/generated/dom_face.py 
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
865
866
867
868
869
870
871
872
873
874
875
876
877
878
def scale(self,
                scale: Float = None,
                center: Vector = None,
                scale_mode: Literal['Uniform', 'Single Axis'] = None,
                axis: Vector = None):
    """ > Node Scale 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`  | `'FACE'`          |

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

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

    scale_mode : menu='Uniform', optional
        ('Uniform', 'Single Axis')

    axis : Vector, optional
        socket 'Axis' (id: Axis)


    Returns
    -------
    Geometry
    """
    node = Node('Scale Elements', {'Geometry': self, 'Selection': self.get_selection(), 'Scale': scale, 'Center': center, 'Scale Mode': scale_mode, 'Axis': axis}, domain='FACE')
    self._jump(node._out)
    return self._domain_to_geometry

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

Returns:

Type Description
node[selection(Geometry), inverted(Geometry)]
Source code in core/generated/dom_face.py 
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
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`  | `'FACE'`          |

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

set_selection()

Node Set Selection

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Geometry self
Socket Selection self[selection]
Parameter domain 'FACE'
Parameter selection_type from selection type

Returns:

Type Description
Geometry
Source code in core/generated/dom_face.py 
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
def set_selection(self):
    """ > Node Set Selection

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

    **Fixed values**

    | Kind      | Name             | Value                 |
    | --------- | ---------------- | --------------------- |
    | Socket    | Geometry         | `self`                |
    | Socket    | Selection        | `self[selection]`     |
    | Parameter | `domain`         | `'FACE'`              |
    | Parameter | `selection_type` | from `selection` type |

    Returns
    -------
    Geometry
    """
    selection_type = SocketType.get_data_type_for_node(selection, 'GeometryNodeToolSetSelection')
    node = Node('Set Selection', {'Geometry': self, 'Selection': self.get_selection()}, domain='FACE', selection_type=selection_type)
    self._jump(node._out)
    return self._domain_to_geometry

set_shade_smooth(shade_smooth=None)

Node Set Shade Smooth

Jump : Socket refers to node output socket after the call

Fixed values

Kind Name Value
Socket Mesh self
Socket Selection self[selection]
Parameter domain 'FACE'

Parameters:

Name Type Description Default
shade_smooth Boolean

socket 'Shade Smooth' (id: Shade Smooth)

 None

Returns:

Type Description
Mesh
Source code in core/generated/dom_face.py 
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
def set_shade_smooth(self, shade_smooth: Boolean = None):
    """ > Node Set Shade Smooth

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

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Mesh      | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `domain`  | `'FACE'`          |

    Parameters
    ----------
    shade_smooth : Boolean, optional
        socket 'Shade Smooth' (id: Shade Smooth)


    Returns
    -------
    Mesh
    """
    node = Node('Set Shade Smooth', {'Geometry': self, 'Selection': self.get_selection(), 'Shade Smooth': shade_smooth}, domain='FACE')
    self._jump(node._out)
    return self._domain_to_geometry

sort(group_id=None, sort_weight=None)

Node Sort 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 'FACE'

Parameters:

Name Type Description Default
group_id Integer

socket 'Group ID' (id: Group ID)

 None
sort_weight Float

socket 'Sort Weight' (id: Sort Weight)

 None

Returns:

Type Description
Geometry
Source code in core/generated/dom_face.py 
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
def sort(self, group_id: Integer = None, sort_weight: Float = None):
    """ > Node Sort 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`  | `'FACE'`          |

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

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


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

split_to_instances(group_id=None)

Node Split to Instances

Fixed values

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

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_face.py 
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
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`  | `'FACE'`          |

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

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_face.py 
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
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`    | `'FACE'`          |

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

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_face.py 
 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
1010
1011
1012
1013
1014
1015
1016
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`    | `'FACE'`          |

    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='FACE')
    self._jump(node._out)
    return self._domain_to_geometry

to_points(position=None, radius=None)

Node Mesh to Points

Fixed values

Kind Name Value
Socket Mesh self
Socket Selection self[selection]
Parameter mode 'FACES'

Parameters:

Name Type Description Default
position Vector

socket 'Position' (id: Position)

 None
radius Float

socket 'Radius' (id: Radius)

 None

Returns:

Type Description
Cloud
Source code in core/generated/dom_face.py 
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
def to_points(self, position: Vector = None, radius: Float = None):
    """ > Node Mesh to Points

    **Fixed values**

    | Kind      | Name      | Value             |
    | --------- | --------- | ----------------- |
    | Socket    | Mesh      | `self`            |
    | Socket    | Selection | `self[selection]` |
    | Parameter | `mode`    | `'FACES'`         |

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

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


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

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

Node Viewer

Fixed values

Kind Name Value
Parameter domain 'FACE'

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_face.py 
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
@classmethod
def viewer(cls, named_sockets: dict = {}, ui_shortcut = 0, **sockets):
    """ > Node Viewer

    **Fixed values**

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

    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='FACE', ui_shortcut=ui_shortcut, **sockets)
    return