Skip to content

Domain

Bases: Geom, NodeCache

Source code in core/domain_class.py 
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
class Domain(Geom, NodeCache):

    __slots__ = NodeCache.__slots__ + ('_geo', '_selection')

    DOMAIN_NAME = None

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

    # ====================================================================================================
    # str
    # ====================================================================================================

    def __str__(self):
        return f"<Domain {self.DOMAIN_NAME} of {self._geo}>"

    # ====================================================================================================
    # Jump
    # ====================================================================================================

    def _jump(self, socket, reset=True):
        return self._geo._jump(socket, reset=reset)

    # ====================================================================================================
    # To geometry
    # ====================================================================================================

    @property
    def _domain_to_geometry(self):
        return self._geo

    # ====================================================================================================
    # Overrides Geom selection
    # Selection can be done either on the geometry or on the domain (or both but strange !)
    # ====================================================================================================

    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 attributes
    # ====================================================================================================

    # ====================================================================================================
    # Attributes
    # ====================================================================================================

    def get(self, name, data_type=None):
        """Return a helper for a named attribute on this domain.

        > Node Named Attribute

        The returned Attribute remembers both the geometry and this domain.
        No node is created until the attribute is read or written. Reading the
        attribute creates the node.

        ``` python
        mesh = Mesh()
        direction = mesh.faces.get("Direction", Vector)
        field = direction.value
        ```

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

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

        attr = Attribute(name, data_type=data_type, domain=self)

        return attr

    def set(self, name, value):
        """Store a named attribute on this domain.

        > Node Store Named Attribute

        The domain is inferred from ``self`` and the value determines the
        attribute data type.

        ``` python
        mesh = Mesh()
        attr = mesh.faces.set("Material Weight", 1.0)
        mesh.points.set("Direction", (0, 0, 1))
        ```

        Parameters
        ----------
        name : str
            Name of the attribute to create or update.
        value : value | Socket
            Constant or field stored in the attribute.

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

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

        attr.set(value)

        return attr

    def get_attribute_names(self, data_type=None):
        """Return the attribute names available on this domain.

        > Node Get Attribute Names

        This domain is automatically used as the node's domain filter.
        Supplying ``data_type`` additionally enables the data-type filter.

        ``` python
        mesh = Mesh()

        face_names = mesh.faces.get_attribute_names()
        vector_names = mesh.faces.get_attribute_names(Vector)
        ```

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

        Returns
        -------
        String
            String socket containing the matching attribute names.
        """
        return self._geo.get_attribute_names(data_type=data_type, domain=self)

    def __setattr__(self, name, value):

        if name in Domain.__slots__ or name in dir(type(self)):
            super().__setattr__(name, value)
            return

        user_name = name.replace("_", " ").strip()
        if len(user_name) and user_name[0] == user_name[0].upper():
            self.store_named_attribute(user_name, value)
            return

        raise NodeError(
            f"{type(self).__name__} domain doesn't have an attribute named '{name}'.\n"
            f"If you want to create a Named Attribute on the domain, the name must start with an uppercase character, '{name.title()}' for instance."
            )

    # ====================================================================================================
    # Sample index
    # ====================================================================================================

    def __call__(self, value, index=None):

        from geonodes import nd

        if index is None:
            index = nd.index

        return self.sample_index(value, index=index)

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

    # ----------------------------------------------------------------------------------------------------
    # Capture attribute
    # ----------------------------------------------------------------------------------------------------

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

    # ----------------------------------------------------------------------------------------------------
    # Capture a single attribute
    # ----------------------------------------------------------------------------------------------------

    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)

    # ====================================================================================================
    # Loop
    # ====================================================================================================

    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)

    def for_each(self, named_sockets: dict={}, selection=None, **sockets):
        return self.for_each_element(named_sockets=named_sockets, selection=selection, **sockets)

    def foreach(self, named_sockets: dict={}, selection=None, **sockets):
        return self.for_each_element(named_sockets=named_sockets, selection=selection, **sockets)

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

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 
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
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 
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
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', 2)

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 
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
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(name, data_type=None)

Return a helper for a named attribute on this domain.

Node Named Attribute

The returned Attribute remembers both the geometry and this domain. No node is created until the attribute is read or written. Reading the attribute creates the node.

mesh = Mesh()
direction = mesh.faces.get("Direction", Vector)
field = direction.value

Parameters:

Name Type Description Default
name str

Name of the attribute.

 required
data_type type | str | value

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

 None

Returns:

Type Description
Attribute

Named-attribute helper attached to this domain and its geometry.
Source code in core/domain_class.py 
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
def get(self, name, data_type=None):
    """Return a helper for a named attribute on this domain.

    > Node Named Attribute

    The returned Attribute remembers both the geometry and this domain.
    No node is created until the attribute is read or written. Reading the
    attribute creates the node.

    ``` python
    mesh = Mesh()
    direction = mesh.faces.get("Direction", Vector)
    field = direction.value
    ```

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

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

    attr = Attribute(name, data_type=data_type, domain=self)

    return attr

get_attribute_names(data_type=None)

Return the attribute names available on this domain.

Node Get Attribute Names

This domain is automatically used as the node's domain filter. Supplying data_type additionally enables the data-type filter.

mesh = Mesh()

face_names = mesh.faces.get_attribute_names()
vector_names = mesh.faces.get_attribute_names(Vector)

Parameters:

Name Type Description Default
data_type type | str | value

Restrict the result to this attribute data type.

 None

Returns:

Type Description
String

String socket containing the matching attribute names.
Source code in core/domain_class.py 
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
def get_attribute_names(self, data_type=None):
    """Return the attribute names available on this domain.

    > Node Get Attribute Names

    This domain is automatically used as the node's domain filter.
    Supplying ``data_type`` additionally enables the data-type filter.

    ``` python
    mesh = Mesh()

    face_names = mesh.faces.get_attribute_names()
    vector_names = mesh.faces.get_attribute_names(Vector)
    ```

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

    Returns
    -------
    String
        String socket containing the matching attribute names.
    """
    return self._geo.get_attribute_names(data_type=data_type, domain=self)

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

set(name, value)

Store a named attribute on this domain.

Node Store Named Attribute

The domain is inferred from self and the value determines the attribute data type.

mesh = Mesh()
attr = mesh.faces.set("Material Weight", 1.0)
mesh.points.set("Direction", (0, 0, 1))

Parameters:

Name Type Description Default
name str

Name of the attribute to create or update.

 required
value value | Socket

Constant or field stored in the attribute.

 required

Returns:

Type Description
Attribute

Helper representing the stored attribute.
Source code in core/domain_class.py 
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
def set(self, name, value):
    """Store a named attribute on this domain.

    > Node Store Named Attribute

    The domain is inferred from ``self`` and the value determines the
    attribute data type.

    ``` python
    mesh = Mesh()
    attr = mesh.faces.set("Material Weight", 1.0)
    mesh.points.set("Direction", (0, 0, 1))
    ```

    Parameters
    ----------
    name : str
        Name of the attribute to create or update.
    value : value | Socket
        Constant or field stored in the attribute.

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

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

    attr.set(value)

    return attr