.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlapPrep, OverlapPrep


.. _OEShape_OEOverlapPrep:

.. oe:class:: OEOverlapPrep

   .. oe:api::

      class OEOverlapPrep

   This class provides facilities to prepare molecules for overlap calculations. Preparing
   a molecule for overlap calculation consists of any or all of the following: adding or removing explicit
   hydrogens; adding color atoms; and assigning Bondi radii to all the atoms.
   When color atoms are added to molecules for overlap calculations, it is often required
   to remove them before further modeling work involving those molecules. Color atoms
   from molecules can be removed using the :oe:func:`OEShape::OERemoveColorAtoms` function.
   
   The :ref:`OEOverlapPrep <OEShape_OEOverlapPrep>` class defines the following public methods:
    * :oe:meth:`GetAssignBondiRadii<OEShape::OEOverlapPrep::GetAssignBondiRadii>`
    * :oe:meth:`GetAssignColor<OEShape::OEOverlapPrep::GetAssignColor>`
    * :oe:meth:`GetColorForceField<OEShape::OEOverlapPrep::GetColorForceField>`
    * :oe:meth:`GetUseHydrogens<OEShape::OEOverlapPrep::GetUseHydrogens>` 
    * :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`
    * :oe:meth:`SetAssignBondiRadii<OEShape::OEOverlapPrep::SetAssignBondiRadii>`
    * :oe:meth:`SetAssignColor<OEShape::OEOverlapPrep::SetAssignColor>`
    * :oe:meth:`SetColorForceField<OEShape::OEOverlapPrep::SetColorForceField>`
    * :oe:meth:`SetUseHydrogens<OEShape::OEOverlapPrep::SetUseHydrogens>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEOverlapPrep(const OEOverlapPrepOptions& opts = OEOverlapPrepOptions())
            OEOverlapPrep(const OEOverlapPrep&)

      .. oe:language:: python

         .. oe:api:: python

            OEOverlapPrep(opts: OEOverlapPrepOptions = OEOverlapPrepOptions()) -> OEOverlapPrep
            OEOverlapPrep(arg2: OEOverlapPrep) -> OEOverlapPrep

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEOverlapPrep &operator=(const OEOverlapPrep &)

   .. _OEShape_OEOverlapPrep_GetAssignBondRadii:

      Assignment operator.


   .. oe:method:: GetAssignBondiRadii

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAssignBondiRadii() const

      .. oe:language:: python

         .. oe:api:: python

            GetAssignBondiRadii() -> bool

      Returns the state of the assign Bondi radii flag. If true, Bondi radii 
      would be assigned to all atoms during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`.

   .. _OEShape_OEOverlapPrep_GetAssignColor:

   .. oe:method:: GetAssignColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetAssignColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAssignColor() -> bool

      Returns the state of the assign color flag. If true, color atoms would be 
      assigned during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`.

   .. _OEShape_OEOverlapPrep_GetColorForceField:

   .. oe:method:: GetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEColorForceField& GetColorForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceField() -> OEColorForceField

      Gets the instance of :ref:`OEColorForceField <OEShape_OEColorForceField>` currently associated
      with the :ref:`OEOverlapPrep <OEShape_OEOverlapPrep>`.

   .. _OEShape_OEOverlapPrep_GetUseHydrogens:

   .. oe:method:: GetUseHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetUseHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseHydrogens() -> bool

      Returns the state of the use hydrogens flag. If true, explicit hydrogen atoms would be
      created during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`. If false, all hydrogen
      atoms would be removed.

   .. _OEShape_OEOverlapPrep_Prep:


   .. oe:method:: Prep

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Prep(OEChem::OEMCMolBase&)
            bool Prep(OEChem::OEMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            Prep(argMol: OEMol) -> bool
            Prep(argMol: Union[OEGraphMol,OEQMol]) -> bool

      Prepares the specified molecule for overlap calculation based on the current set of
      options set on :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`.


   .. _OEShape_OEOverlapPrep_SetAssignBondiRadii:


   .. oe:method:: SetAssignBondiRadii

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAssignBondiRadii(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAssignBondiRadii(argValue: bool) -> None

      Sets the state of the assign Bondi radii flag. If true, Bondi radii 
      would be assigned to all atoms during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`.

   .. _OEShape_OEOverlapPrep_SetAssignColor:


   .. oe:method:: SetAssignColor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetAssignColor(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAssignColor(argValue: bool) -> None

      Sets the state of the assign color flag. If true, color atoms would be 
      assigned during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`.
      Color atoms from molecules can be removed using the 
      :oe:func:`OEShape::OERemoveColorAtoms` function for further modeling
      work involving a molecule.

   .. _OEShape_OEOverlapPrep_SetColorForceField:


   .. oe:method:: SetColorForceField

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetColorForceField(const OEColorForceField& cff)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceField(argCff: OEColorForceField) -> bool

      Sets the color force field to be used. By default, the ImplicitMillsDean
      color force field is used.

   .. _OEShape_OEOverlapPrep_SetUseHydrogens:

   .. oe:method:: SetUseHydrogens

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetUseHydrogens(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseHydrogens(argValue: bool) -> None

      Sets the state of the use hydrogens flag. If true, explicit hydrogen atoms would be
      created during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`. If false, all hydrogen
      atoms would be removed.

