.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEGrapheme

.. oe:class::  OELigandAlignerBase

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      OESystem::OEUnaryFunction<OEChem::OEMolBase, bool, false, true>  OELigandAlignerBase;

   :oe:cls:`OEGrapheme::OELigandAlignerBase` is an abstract class. Functors deriving from this
   class can be used to perform custom ligand alignment when generating images of ligand-protein
   interactions.

   The following classes derive from this abstract class:
   
   * :oe:cls:`OEGrapheme::OENoOpLigandAligner` class

   .. seealso::

      * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetLigandAlignerFunctor` method

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(OEChem::OEMolBase&) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg0: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This is a virtual const method that must be implemented in the concrete
      derived classes.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OELigandAlignerBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OELigandAlignerBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.
