.. oe:namespace:: OEDocking



.. meta::
   :keywords: OEBox


.. _OEDocking_OEBox:

.. oe:class:: OEBox

   .. oe:api::

      class OEBox : public OEBoxBase

   :ref:`OEBox <OEDocking_OEBox>` class represents a box aligned to the x, y and z coordinate axis.

   This class is an implementation of the :ref:`OEBoxBase <OEDocking_OEBoxBase>` class.

   The following free functions can take :ref:`OEBox <OEDocking_OEBox>` objects by virtue of
   their inheritance from :ref:`OEBoxBase <OEDocking_OEBoxBase>`.

   ======================================= ====================================
   :oe:func:`OEDocking::OEBoxXMid`         :oe:func:`OEDocking::OEBoxXDim`     
   :oe:func:`OEDocking::OEBoxYMid`         :oe:func:`OEDocking::OEBoxYDim`     
   :oe:func:`OEDocking::OEBoxZMid`         :oe:func:`OEDocking::OEBoxZDim`     
   :oe:func:`OEDocking::OEInBox`           :oe:func:`OEDocking::OEBoxTranslate`
   :oe:func:`OEDocking::OEBoxExtend`       :oe:func:`OEDocking::OESetupBox`    
   :oe:func:`OEDocking::OEBoxVolume`       :oe:func:`OEDocking::OEBoxArea`     
   :oe:func:`OEDocking::OEMakeBoxMolecule`                                     
   ======================================= ====================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEBox()

      .. oe:language:: python

         .. oe:api:: python

            OEBox() -> OEBox

      Default constructor.  All xyz min and max values are set to 0.

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

         .. oe:api::

            OEBox(float x1, float y1, float z1, float x2, float y2, float z2)

      .. oe:language:: python

         .. oe:api:: python

            OEBox(x1: float, y1: float, z1: float, x2: float, y2: float,
                  z2: float) -> OEBox

      Constructor that sets up the box.  The max and min X values will be set
      to the max and min of *x1*, *x2* respectively.  Minimum and maximum values of Y
      and Z are selected in an analogous fashion.

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

         .. oe:api::

            OEBox(const OEChem::OEMolBase& mol, float addbox = 0.0f)

      .. oe:language:: python

         .. oe:api:: python

            OEBox(mol: Union[OEGraphMol,OEQMol], addbox: float = 0.0) -> OEBox

      Constructs a box around the given molecule.  The maximum and minimum
      x, y and z values are set to the maximum and minimum values x, y and z
      coordinates of any atom of the molecule.

      If *addbox* is specified then each edge of the box is extended by *addbox*.

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

         .. oe:api::

            OEBox(const OEChem::OEMCMolBase& mol, float addbox = 0.0f)

      .. oe:language:: python

         .. oe:api:: python

            OEBox(mol: OEMol, addbox: float = 0.0) -> OEBox

      Constructs a box around the given molecule.  The maximum and minimum
      x, y and z values are set to the maximum and minimum values x, y and z
      coordinates of any atom of any pose of the molecule.

      If *addbox* is specified then each edge of the box is extended by *addbox*.

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

         .. oe:api::

            OEBox(const OEBox& box)

      .. oe:language:: python

         .. oe:api:: python

            OEBox(arg2: OEBox) -> OEBox

      Copy constructor.

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

         .. oe:api::

            OEBox(const OEBoxBase& box)

      .. oe:language:: python

         .. oe:api:: python

            OEBox(box: OEBoxBase) -> OEBox

      Constructs an :ref:`OEBox <OEDocking_OEBox>` from an :ref:`OEBoxBase <OEDocking_OEBoxBase>`.

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

         OEBox& operator=(const OEBox& rhs)

      Assignment operator for :ref:`OEBoxBase <OEDocking_OEBoxBase>`.
