OEBondSVGBondIdxMarkup¶

class OEBondSVGBondIdxMarkup : public OEBondSVGMarkupBase

This class represents the OEBondSVGBondIdxMarkup bond SVG markup functor. If this functor is passed to the OE2DMolDisplayOptions.SetBondSVGMarkupFunctor method, the bonds will be not marked in the svg image when calling the OERenderMolecule function.

Constructors¶

OEBondSVGBondIdxMarkup(const std::string prefix="",
                       const std::string classname="bond)

Creates an OEBondSVGBondIdxMarkup object.

prefix: The string that will be added at the beginning of each bond 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 bonds. For information about valid names see OEIsValidSVGClassName function.

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

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

The transparent circle will be drawn at the middle of the bond. This can be used to manipulate the generated .svg image and associate event with the SVG groups.

CreateCopy¶

OEBondSVGMarkupBase *CreateCopy() const

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

GetClassName¶

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

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

GetGroupId¶

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

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