OEAtomSVGAtomIdxMarkup¶

class OEAtomSVGAtomIdxMarkup : public OEAtomSVGMarkupBase

This class represents the OEAtomSVGAtomIdxMarkup atom SVG markup functor. If this functor is passed to the OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor method, the atoms will be not marked in the svg image when calling the OERenderMolecule function.

Constructors¶

OEAtomSVGAtomIdxMarkup(const std::string prefix="",
                       const std::string classname="atom")

Creates an OEAtomSVGAtomIdxMarkup object.

prefix: The string that will be added at the beginning of each atom group id. For information about valid ids see OEIsValidSVGGroupId function. By default, no prefix will be added.
classname: The class name that is going to be used to mark atoms. For information about valid names see OEIsValidSVGClassName function.

By default, the svg image for the first atom of a molecule will be marked as follows:

<g id='idx=0' class='atom'>
..
list of drawing elements
..
<circle ... >
</g>

The transparent circle will be drawn with the atom position OE2DAtomDisplay::GetCoords center. This can be used to manipulate the generated .svg image and associate event with the SVG groups.

CreateCopy¶

OEAtomSVGMarkupBase *CreateCopy() const

Deep copy constructor that returns a copy of the object. The memory for the returned OEAtomSVGAtomIdxMarkup object is dynamically allocated and owned by the caller.

GetClassName¶

std::string GetClassName(const OEChem::OEAtomBase &) const

Returns the string that specifies the group id of an atom in an svg image.

GetGroupId¶

std::string GetGroupId(const OEChem::OEAtomBase &) const

Returns the string that specifies the class name of an atom in an svg image.