Grapheme TK 1.3.0
================================================================================

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

* Due to the deprecation of `OEFragmentNetwork` and related classes
  in **OEBio**, **Grapheme TK** has introduced the following overloads:

  * :oe:func:`OEGrapheme::OEPrepareActiveSiteDepiction` function has been overloaded.
    The new version takes an :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

  * :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` class now should be constructed
    with an :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

  All functions and methods using `OEFragmentNetwork` are deprecated in **Grapheme TK**
  and will throw a warning when called.
  Active site depictions generated with the deprecated API will have a "deprecated"
  watermark (see the example below).

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

     * - using the deprecated OEFragmentNetwork class
       - using the new OEInteractionHintContainer class

     * - .. image:: ../../graphemetk/images/releasenotes-1.3.0/pdb1avd-fragment-network.*
            :width: 400
       - .. image:: ../../graphemetk/images/releasenotes-1.3.0/pdb1avd-interaction-container.*
            :width: 400


  In order to avoid the "deprecated" watermark from appearing in the image, use

  .. oe:language:: c++

     .. code-block:: c++

        OEInteractionHintContainer asite(protein, ligand);

  .. oe:language:: python

     .. code-block:: python

         asite = OEInteractionHintContainer(protein, ligand)

  .. oe:language:: java csharp

     .. code-block:: java

        OEInteractionHintContainer asite = new OEInteractionHintContainer(protein, ligand);

  instead of

  .. oe:language:: c++

     .. code-block:: c++

        OEFragmentNetwork asite(protein, ligand);

  .. oe:language:: python

     .. code-block:: python

        asite = OEFragmentNetwork(protein, ligand)

  .. oe:language:: java csharp

     .. code-block:: java

        OEFragmentNetwork asite = new OEFragmentNetwork(protein, ligand);


  .. seealso::

     For more details about the deprecated classes and functions, see the
     :ref:`oebio_fragment_network_deprecation` section.


* :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` now can visualize salt-bridge and
  aromatic ring stacking interactions.

* The color scheme used to visualize different interaction types when depicting
  protein-ligand interaction has been changed to accommodate the
  new types (Pi- and T-stacking and salt-bridge).

  .. list-table::
     :header-rows: 1
     :widths: 200 240

     * - 2016.Feb color scheme
       - 2016.Jun color scheme

     * - .. image:: ../../graphemetk/images/releasenotes-1.3.0/DrawActiveSiteLegend_2016_Feb.*
            :width: 400
       - .. image:: ../../graphemetk/images/releasenotes-1.3.0/DrawActiveSiteLegend_2016_Jun.*
            :width: 500

* :oe:meth:`OEGrapheme::OE2DActiveSiteDisplay::GetDisplayedLigand` and
  :oe:meth:`OEGrapheme::OE2DActiveSiteDisplay::GetDisplayedResidues` methods have
  been added.

* :oe:func:`OEGrapheme::OEAddLigandHighlighting` and
  :oe:func:`OEGrapheme::OEAddResidueHighlighting` functions have been added to
  allow highlighting in active site depiction. See the example below.

  .. figure:: ../../graphemetk/images/OEAddHighlighting-ActiveSite-OEMatch.*
     :width: 350

     **Example of ligand highlighting**

* :oe:const:`OEGrapheme::OEShapeOverlapDisplayStyle::PropertyCloud` style
  has been added to visualize shape overlays along with the following APIs:

  * :oe:constns:`OEGrapheme::OEShapeOverlapDisplayStyle` namespace
  * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetOverlapDisplayStyle` and
    :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetOverlapDisplayStyle` methods

  .. figure:: ../../graphemetk/images/OEShapeOverlapDisplayStyle_PropertyCloud.*
     :width: 300

     **Example of visualizing shape overlaps with PropertyCloud style**

  Using this new style can result in a 10-times performance increase when generating
  shape overlay images; the generated images will also be significantly smaller
  (PNG 50%, SVG 60-times, PDF 9-times).

* The following APIs have been added to identify ligand atoms and bonds, along with
  residues of an :oe:meth:`OEGrapheme::OE2DActiveSiteDisplay` object that are
  close to a given 2D display coordinate:

  * :oe:func:`OEGrapheme::OEGetNearestAtom` and :oe:func:`OEGrapheme::OEGetNearbyAtom` functions
  * :oe:func:`OEGrapheme::OEGetNearestBond` and :oe:func:`OEGrapheme::OEGetNearbyBond` functions
  * :oe:func:`OEGrapheme::OEGetNearestResidue` and :oe:func:`OEGrapheme::OEGetNearbyResidue` functions
    along with the :ref:`OENearestResidue <OEGrapheme_OENearestResidue>` class


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

* All images in the **Grapheme TK** documentation were automatically regenerated to
  reflect the changes made since the previous release.

* The example in :ref:`section_examples_summary_complex2img` has
  been updated to use the new :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class
  instead of the deprecated `OEFragmentNetwork`.
