Domain

Bases: Geom, NodeCache

Source code in core/domain_class.py

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

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

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

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

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

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)

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

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

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