OEDepict TK 2.3.5
================================================================================

New features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions`, has
  been added to help generate consistent command line interfaces for depiction
  examples and utilities.  Generated interfaces now include correspondence
  between each command line option and its related entrypoint in
  **OEDepict TK**.  For more details see the documentation for
  :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions`.

* A position property has been added to the "lasso" highlighting style that
  allows drawing the highlights either below or above the depicted molecules.
  This property can be set either by the constructor of the
  :oe:meth:`OEDepict::OEHighlightByLasso` class or via the
  :oe:meth:`OEDepict::OEHighlightByLasso::SetPosition` method.

* The :ref:`OE2DPath <OEDepict_OE2DPath>` class has been extended to handle
  "empty" 2D paths:

  * :oe:meth:`OE2DPath<OEDepict::OE2DPath::Constructors>` default constructor
  * :oe:meth:`OEDepict::OE2DPath::AddStartPoint` method
  * :oe:meth:`OEDepict::OE2DPath::SetClosed` method
  * :oe:meth:`OEDepict::OE2DPath::IsValid` method

Preliminary API
--------------------------------------------------------------------------------

* A new :term:`Preliminary API` has been added to support the
  generation of interactive SVG images:

  * :ref:`OESVGClass <OEDepict_OESVGClass>` and
    :ref:`OESVGGroup <OEDepict_OESVGGroup>` classes
  * :oe:meth:`OEDepict::OEImageBase::PushGroup`,
    :oe:meth:`OEDepict::OEImageBase::PopGroup`,
    :oe:meth:`OEDepict::OEImageBase::NewSVGGroup`,
    :oe:meth:`OEDepict::OEImageBase::NewSVGClass`,
    :oe:meth:`OEDepict::OEImageBase::GetSVGGroup`, and
    :oe:meth:`OEDepict::OEImageBase::GetSVGClass` methods of the
    :ref:`OEImageBase <OEDepict_OEImageBase>` base class and its derived classes
  * :oe:func:`OEDepict::OEDrawSVGHoverText`,
    :oe:func:`OEDepict::OEDrawSVGToggleText`, and
    :oe:func:`OEDepict::OEAddSVGClickEvent` functions

.. only:: oehtml


   .. list-table:: **Gallery of OEDepict TK examples of interactive SVG images**
      :widths: 150 150

      * - Hover the mouse over any atom
        - Click on any atom

      * - .. raw:: html

             <p align="center">
             <object data="../../_images/HoverAtomText.svg" type="image/svg+xml"  width = "300" ></object>
             <p>

        - .. raw:: html

             <p align="center">
             <object data="../../_images/ToggleAtomText.svg" type="image/svg+xml"  width = "300" ></object>
             <p>

      * - Hover the mouse over any bond
        - Click on the middle on any bond

      * - .. raw:: html

             <p align="center">
             <object data="../../_images/HoverBondText.svg" type="image/svg+xml"  width = "300" ></object>
             <p>

        - .. raw:: html

             <p align="center">
             <object data="../../_images/ToggleBondText.svg" type="image/svg+xml"  width = "300" ></object>
             <p>


Major bug fixes
--------------------------------------------------------------------------------

* On OSX, the deprecated ``CGContextSelectFont`` and
  ``CGContextShowTextAtPoint`` Core Graphics functions have been replaced.
  These function were used to handle fonts when drawing text in PNG images.
  **OEDepict TK** currently supports the following font mapping on OSX for
  PNG images:

  .. list-table::
     :widths: 100 100
     :header-rows: 1

     * - OpenEye Font Family Type
       - Font Name

     * - :oe:const:`OEDepict::OEFontFamily::Arial`
       - ``Arial``

     * - :oe:const:`OEDepict::OEFontFamily::Courier`
       - ``CourierNewPS``

     * - :oe:const:`OEDepict::OEFontFamily::Helvetica`
       - ``Helvetica``

     * - :oe:const:`OEDepict::OEFontFamily::Times`
       - ``TimesNewRomanPS``

Minor bug fixes
--------------------------------------------------------------------------------

* When performing fixed coordinate molecule alignment
  (see :oe:meth:`OEDepict::OEAlignmentOptions::SetFixedCoords`),
  only the set of atoms considered during the alignment are now used to
  evaluate the quality of the alignment. As a result, fixed
  coordinate alignment succeeds more frequently, circumventing the need to
  fall back to the more exhaustive alignment method.

* Bond stereo information is now re-perceived by calling the
  :oe:func:`OEChem::OEMDLPerceiveBondStereo` function after
  finding the best 2D alignment with the
  :oe:func:`OEDepict::OEPrepareAlignedDepiction` function when the alignment
  is defined by either an :ref:`OESubSearch <OEChem_OESubSearch>` or an
  :ref:`OEMCSSearch <OEChem_OEMCSSearch>` object.

Python-specific changes
--------------------------------------------------------------------------------

* The following Python functions have been added:

  * :oe:func:`OEDepict::OERenderMoleculeToBytes`
  * :oe:func:`OEDepict::OEWriteImageToBytes`
  * :oe:func:`OEDepict::OEWriteReportToBytes`


Documentation changes
--------------------------------------------------------------------------------

* A new chapter, :ref:`chapter_svg`, has been added.

* A new section, :ref:`oedepict_chapter_cookbook_examples`, has been added.
