bluemira.geometry.compound
==========================

.. py:module:: bluemira.geometry.compound

.. autoapi-nested-parse::

   Wrapper for FreeCAD Part.Compounds objects



Classes
-------

.. autoapisummary::

   bluemira.geometry.compound.BluemiraCompound


Module Contents
---------------

.. py:class:: BluemiraCompound(boundary: list[bluemira.geometry.base.BluemiraGeo], label: str = '', *, _compound_obj: bluemira.codes._freecadapi.apiCompound | None = None)

   Bases: :py:obj:`bluemira.geometry.base.BluemiraGeo`

   .. autoapi-inheritance-diagram:: bluemira.geometry.compound.BluemiraCompound
      :parts: 1
      :private-bases:


   Bluemira Compound class.

   :param boundary: List of BluemiraGeo objects to include in the compound
   :param label: Label to assign to the compound
   :param _compound_obj: A pre-constructed compound object to use for the shape. This should only be used
                         by the _create classmethod.


   .. py:attribute:: _compound_obj
      :value: None



   .. py:method:: _create_shape() -> bluemira.codes._freecadapi.apiCompound

      :returns: Shape of the object as a single compound.
      :rtype: apiCompound



   .. py:method:: _create(obj: bluemira.codes._freecadapi.apiCompound, label='') -> BluemiraCompound
      :classmethod:



   .. py:property:: vertexes
      :type: bluemira.geometry.coordinates.Coordinates


      The vertexes of the compound.


   .. py:property:: edges
      :type: tuple[bluemira.geometry.wire.BluemiraWire, Ellipsis]


      The edges of the compound.


   .. py:property:: wires
      :type: tuple[bluemira.geometry.wire.BluemiraWire, Ellipsis]


      The wires of the compound.


   .. py:property:: faces
      :type: tuple[bluemira.geometry.face.BluemiraFace, Ellipsis]


      The faces of the compound.


   .. py:property:: shells
      :type: tuple[bluemira.geometry.shell.BluemiraShell, Ellipsis]


      The shells of the compound.


   .. py:property:: solids
      :type: tuple[bluemira.geometry.solid.BluemiraSolid, Ellipsis]


      The solids of the compound.