bluemira.codes.python_occ.imprintable_solid
===========================================

.. py:module:: bluemira.codes.python_occ.imprintable_solid

.. autoapi-nested-parse::

   Working class for imprinting solids.



Classes
-------

.. autoapisummary::

   bluemira.codes.python_occ.imprintable_solid.ImprintableSolid


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

.. py:class:: ImprintableSolid(label: str, bm_solid: bluemira.geometry.solid.BluemiraSolid, occ_solid: OCC.Core.TopoDS.TopoDS_Solid)

   Represents a solid that can be imprinted.


   .. py:attribute:: _label


   .. py:attribute:: _bm_solid


   .. py:attribute:: _imprinted_occ_solid


   .. py:attribute:: _has_imprinted
      :value: False



   .. py:attribute:: _imprinted_faces
      :type:  set[OCC.Core.TopoDS.TopoDS_Face]


   .. py:attribute:: _shadow_imprinted_faces
      :type:  set[OCC.Core.TopoDS.TopoDS_Face]


   .. py:method:: from_bluemira_solid(label: str, bm_solid: bluemira.geometry.solid.BluemiraSolid)
      :classmethod:


      Creates an ImprintableSolid from a BluemiraSolid.

      :param label: The label of the solid.
      :type label: str
      :param bm_solid: The BluemiraSolid to imprint.
      :type bm_solid: BluemiraSolid

      :returns: The ImprintableSolid.
      :rtype: ImprintableSolid

      :raises TypeError: If bm_solid is not a BluemiraSolid.



   .. py:property:: label
      :type: str


      Returns the label of the solid.


   .. py:property:: occ_solid
      :type: OCC.Core.TopoDS.TopoDS_Solid


      Returns the TopoDS_Solid of the solid.


   .. py:property:: imprinted_faces
      :type: set[OCC.Core.TopoDS.TopoDS_Face]


      Returns the imprinted faces of the solid.


   .. py:method:: bind_imprinted_face(face: OCC.Core.TopoDS.TopoDS_Face)

      Binds a face to the imprintable solid, adding it to the shadow set.
      The finalise_binding method must be called after binding all faces.



   .. py:method:: finalise_binding()

      Finalises the binding of the imprinted faces, moving them from the
      shadow set to the imprinted set.



   .. py:method:: set_imprinted_solid(imprinted_occ_solid)

      Sets the imprinted solid of the imprintable solid.
      This is used to set the solid after imprinting.



   .. py:method:: to_bluemira_solid() -> bluemira.geometry.solid.BluemiraSolid

      Returns the imprinted BluemiraSolid.
      If the solid has not been imprinted, it returns the original solid.

      :returns: The imprinted BluemiraSolid.
      :rtype: BluemiraSolid