.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEAtomStereoStyle

   This namespace encodes symbolic constants used as bit-masks to 
   indicate what and how atom stereo information is displayed.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle`
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle`

   The :oe:constns:`OEDepict::OEAtomStereoStyle` namespace contains the 
   following constants and nested namespaces:

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

   .. oe:constant:: Default

      The combination of the following flags:

      * :oe:const:`OEDepict::OEAtomStereoStyle::Display::Default`
      * :oe:const:`OEDepict::OEAtomStereoStyle::HashWedgeStyle::Default`

      See example in :ref:`Figure: Example of using the 'Default'
      atom stereo style<figure_OEAtomStereoStyle_Default>`.

      .. _figure_OEAtomStereoStyle_Default:

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

         **Example of using the 'Default' atom stereo style**


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

   .. oe:constant:: Hidden

      Displays no atom stereo information.
      See example in :ref:`Figure: Example of using the 'Hidden'
      atom stereo style<figure_OEAtomStereoStyle_Hidden>`.

      .. _figure_OEAtomStereoStyle_Hidden:

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

         **Example of using the 'Hidden' atom stereo style**


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

   .. oe:constant: DisplayMask # IGNORE


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

   .. oe:constant: HashWedgeStyleMask #IGNORE


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

   .. oe:constnamespace:: OEAtomStereoStyle::Display

      This nested namespace encodes symbolic constants used as bit-masks to
      indicate what atom stereo information is displayed.


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

      .. oe:constant:: Default

         The combination of the following flags:

         * :oe:const:`OEDepict::OEAtomStereoStyle::Display::AtomStereo`
         * :oe:const:`OEDepict::OEAtomStereoStyle::Display::MDLStereoCenter`

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

      .. oe:constant:: AtomStereo

         Displays atom stereo information in the form of hash/wedge bonds.
         See example in :ref:`Table: Example of using the 'AtomStereo'
         display style<table_OEAtomStereoStyle_Display_AtomStereo>`.

         .. _table_OEAtomStereoStyle_Display_AtomStereo:

         .. list-table::  **Example of using the 'AtomStereo' display style**

            * -  `O[C@@H]1CN[C@@H](O)CC1`
              -  `O[C@@H]1CC[C@@H](O)CC1`
            * - .. image:: ../images/OEAtomStereoStyle_Display_AtomStereo_RS.*
                  :align:  center
              - .. image:: ../images/OEAtomStereoStyle_Display_AtomStereo_X.*
                  :align:  center

         If the molecule is imported from an MOL or SDF file with an "either"
         stereo than it is depicted as a wavy bond.
         See example in :ref:`Figure: Example of depiction of up, down and
         either (wavy) bonds<figure_OEAtomStereoStyle_Display_Wavy>`.
 
         .. _figure_OEAtomStereoStyle_Display_Wavy:

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

            **Example of depiction of up, down and either (wavy) bonds**


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

      .. oe:constant:: CIPAtomStereo

         Displays the CIP atom stereo information next to the
         corresponding atom.
         See example in :ref:`Table: Example of using the 'CIPAtomStereo'
         display style<table_OEAtomStereoStyle_Display_AtomStereo>`.

         .. _table_OEAtomStereoStyle_Display_CIPAtomStereo:

         .. list-table::   **Example of using the 'CIPAtomStereo' display style**

            * -  `O[C@@H]1CN[C@@H](O)CC1`
              -  `O[C@@H]1CC[C@@H](O)CC1`
            * - .. image:: ../images/OEAtomStereoStyle_Display_CIPAtomStereo_RS.*
                   :align:  center
              - .. image:: ../images/OEAtomStereoStyle_Display_CIPAtomStereo_X.*
                   :align:  center

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

      .. oe:constant:: MDLStereoCenter

         Displays the MDL enhanced stereochemical atom labels.

         .. list-table::   **Example of using the 'MDLStereoCenter' display style**

            * - **MDL stereo group type**
              - Absolute
              - AND
              - OR

            * - **Label in molfile**
              - STEABS
              - STERACn
              - STERELn

            * - **Display label**
              - 'abs'
              - '&n'
              - 'orn'

            * - **Example**
              - .. image:: ../images/OEAtomStereoStyle_MDLStereoCenter_ABS.*
              - .. image:: ../images/OEAtomStereoStyle_MDLStereoCenter_AND.*
              - .. image:: ../images/OEAtomStereoStyle_MDLStereoCenter_OR.*


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

      .. oe:constant:: All

         The combination of the following flags:

         * :oe:const:`OEDepict::OEAtomStereoStyle::Display::AtomStereo`
         * :oe:const:`OEDepict::OEAtomStereoStyle::Display::CIPAtomStereo`
         * :oe:const:`OEDepict::OEAtomStereoStyle::Display::MDLStereoCenter`

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

   .. oe:constnamespace:: OEAtomStereoStyle::HashWedgeStyle

      This nested namespace encodes symbolic constants used to
      indicate the style of the hash/wedge bonds that depict
      atom stereo information.


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

      .. oe:constant:: Default

         The default hash/wedge display style is
         :oe:const:`OEDepict::OEAtomStereoStyle::HashWedgeStyle::Fancy`


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

      .. oe:constant:: Fancy

         See example in :ref:`Figure: Example of using the 'Fancy'
         hash/wedge style <figure_OEAtomStereoStyle_HashWedgeStyle_Fancy>`.

         .. _figure_OEAtomStereoStyle_HashWedgeStyle_Fancy:

         .. figure:: ../images/OEAtomStereoStyle_HashWedgeStyle_Fancy.*
            :scale:  100
            :align:  center

            **Example of using the 'Fancy' hash/wedge style**


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

      .. oe:constant:: Standard

         See example in :ref:`Figure: Example of using the 'Standard'
         hash/wedge style <figure_OEAtomStereoStyle_HashWedgeStyle_Standard>`.

         .. _figure_OEAtomStereoStyle_HashWedgeStyle_Standard:

         .. figure:: ../images/OEAtomStereoStyle_HashWedgeStyle_Standard.*
            :scale:  100
            :align:  center

            **Example of using the 'Standard' hash/wedge style**

