.. # split from OEDockingFunctions.rst:138


.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESetupBox

..  _OEDocking_OESetupBox:

.. oe:function:: OESetupBox

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

      .. oe:api::

         bool OESetupBox(OEBoxBase& box, float* xyz, unsigned int N,
                         bool addbox = 0.0f)

   .. oe:language:: python

      .. oe:api:: python

         OESetupBox(arg1: OEBoxBase, xyz: OEFloatArray, N: int,
                    addbox: bool = 0.0) -> bool


   Sets up *box* to contain the minimum size box that encloses all coordinates in
   the *xyz* array and then extends each box face by *addbox*.

      *box*
         Box to setup

      *xyz*
         Array of coordinates

      *N*
         Number of coordinates in *xyz* array

      *addbox*
         Optional parameter to extend each box face by a specified amount relative
         to the minimum box enclosing the *xyz* coordinates.

   Returns true if setup was successful.
 
   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OESetupBox(OEMath::OEBox& box, const OEChem::OEMolBase& mol,
                         float addbox = 0.0f)

   .. oe:language:: python

      .. oe:api:: python

         OESetupBox(arg1: OEBox, arg2: Union[OEGraphMol,OEQMol],
                    addbox: float = 0.0) -> bool


   Sets up *box* to be the minimum size box that encloses *mol*
   and then extends each box face by *addbox*.

      *box*
         Box to setup

      *mol*
         A molecule the box will be setup around 

      *addbox*
         Optional parameter to extend each box face by a specified amount relative
         to the minimum box enclosing the *mol*.
 
   Returns true if setup was successful.

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

      .. oe:api::

         bool OESetupBox(OEMath::OEBox& box, const OEChem::OEMCMolBase& mol,
                         float addbox = 0.0f)

   .. oe:language:: python

      .. oe:api:: python

         OESetupBox(arg1: OEBox, arg2: OEMol, addbox: float = 0.0) -> bool

   Sets up *box* to be the minimum size box that encloses all conformers of *mol*
   and then extends each box face by *addbox*.

      *box*
         Box to setup

      *mol*
         A multiconformer molecule the box will be setup around 

      *addbox*
         Optional parameter to extend each box face by a specified amount relative
         to the minimum box enclosing the *mol*.

   Returns true if setup was successful.

