OEHighlightMonomers

Attention

This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

bool OEHighlightMonomers(OEDepict::OEImageBase& image,
                         const OEChem::OEMolBase& mol)
bool OEHighlightMonomers(OEDepict::OEImageBase& image,
                         const OEChem::OEMolBase& mol,
                         const OEHighlightMonomerDisplayOptions& opts)

The OEHighlightMonomers function is designed to depict a molecule initialized from a HELM string and highlight its monomer components.

image: The image on which the molecule is drawn.
mol: The molecule being depicted.
opts: The OEHighlightMonomerDisplayOptions object that stores properties that determine the styles of the molecule depiction.

Example:

../../_images/HighlightMonomers.svg — **Example of using OEHighlightMonomers function**

bool OEHighlightMonomers(OEDepict::OE2DMolDisplay& disp,
                         const OEHighlightMonomerDisplayOptions& opts)

This overload of the OEHighlightMonomers function renders the molecule with the monomer highlighting to the display object.

disp: The display object for the molecule being depicted.
opts: The OEHighlightMonomerDisplayOptions object that stores properties that determine the styles of the molecule depiction.