.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEBondDisplayPosition

   This namespace controls how multi-line bonds are rendered. The
   :oe:constns:`OEDepict::OEBondDisplayPosition` only affects bonds of
   the following types (as returned by
   :oe:meth:`OEDepict::OE2DBondDisplay::GetDisplayType`):

   * :oe:const:`OEDepict::OEBondDisplayType::Double`
   * :oe:const:`OEDepict::OEBondDisplayType::AromaticDash`
   * :oe:const:`OEDepict::OEBondDisplayType::SingleDouble`
   * :oe:const:`OEDepict::OEBondDisplayType::SingleArom` 
   * :oe:const:`OEDepict::OEBondDisplayType::DoubleArom`  
   * :oe:const:`OEDepict::OEBondDisplayType::Aromatic`

   The concept of
   :oe:const:`Left<OEDepict::OEBondDisplayPosition::Left>` and
   :oe:const:`Right<OEDepict::OEBondDisplayPosition::Right>` are
   relative to the "begin" and "end" atoms of the associated
   :ref:`OEBondBase <OEChem_OEBondBase>`. The side of
   :oe:const:`Left<OEDepict::OEBondDisplayPosition::Left>` and
   :oe:const:`Right<OEDepict::OEBondDisplayPosition::Right>` is defined
   by standing on the "begin" atom and looking towards the "end"
   atom. 

   The following figure shows how both
   :oe:const:`Left<OEDepict::OEBondDisplayPosition::Left>` and
   :oe:const:`Right<OEDepict::OEBondDisplayPosition::Right>` double
   bonds can appear in a benzene ring. 

   .. figure:: ../images/OEBondDisplayPosition.*
      :align:  center

      *Example of various multi-line bond positions*

   .. note::

      The :ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>` does not store pointers
      to the "begin" and "end" atoms. The "begin" and "end" atoms can
      be retrieved by accessing the associated
      :ref:`OEBondBase <OEChem_OEBondBase>` through the
      :oe:meth:`OEDepict::OEBondDisplayBase::GetBond` method and then
      calling the :oe:meth:`OEChem::OEBondBase::GetBgn` and
      :oe:meth:`OEChem::OEBondBase::GetEnd` methods respectively. 

   .. seealso::

      * :oe:meth:`OEDepict::OE2DBondDisplay::GetDisplayPos` method
      * :oe:meth:`OEDepict::OE2DBondDisplay::SetDisplayPos` method

   The :oe:constns:`OEDepict::OEBondDisplayPosition` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant: Undefined # IGNORED


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Center

      Renders a double bond so that the "begin" and "end" atom
      coordinates end up between each line of the double bond.
      See example in :ref:`Figure: Example of a double bond rendered in the center<figure_OEBondDisplayPosition_Center>`.

      .. _figure_OEBondDisplayPosition_Center:

      .. figure:: ../images/OEBondDisplayPosition_Center.*
         :align:  center

         *Example of a double bond rendered in the center*


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Left

      Renders a double bond by drawing a line between the "begin" and
      "end" atom coordinates, and then drawing a parallel line to the
      left of that line.
      See example in :ref:`Figure: Example of a double bond rendered with its parallel line to the left<figure_OEBondDisplayPosition_Left>`.

      .. _figure_OEBondDisplayPosition_Left:

      .. figure:: ../images/OEBondDisplayPosition_Left.*
         :align:  center

         *Example of a double bond rendered with its parallel line to the left*


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Right

      Renders a double bond by drawing a line between the "begin" and
      "end" atom coordinates, and then drawing a parallel line to the
      right of that line.
      See example in :ref:`Figure: Example of a double bond rendered with its parallel line to the right<figure_OEBondDisplayPosition_Right>`.

      .. _figure_OEBondDisplayPosition_Right:

      .. figure:: ../images/OEBondDisplayPosition_Right.*
         :align:  center

         *Example of a double bond rendered with its parallel line to the right*

