OEAtomGlyphCircle¶
class OEAtomGlyphCircle : public OEAtomGlyphBase
By using the OEAtomGlyphCircle
class, atoms
can be annotated by drawing a circle around them.
See also
Annotating Atoms and Bonds chapter
OECircleStyle
namespace
The following methods are publicly inherited from OEAtomGlyphBase
:
Constructors¶
OEAtomGlyphCircle(const OEDepict::OEPen &pen,
unsigned int circlestyle=OECircleStyle::Default,
double circleRadiusScale=1.0,
unsigned int layer=OEDepict::OELayerPosition::Below)
Creates an OEAtomGlyphCircle
object with the
specified parameters

Example of atom annotations¶
- pen
The pen used when drawing a circle around an atom.
See example (A) and (B) in Figure: Example of atom annotations.
- circlestyle
The style of the drawn circle from the
OECircleStyle
namespace.See examples (C) and (D) in Figure: Example of atom annotations.
- circleRadiusScale
The multiplier used to modify the radius of the drawn circles
See examples (D) and (E) in Figure: Example of atom annotations.
- layer
Specifies whether the circle is drawn above (
OELayerPosition.Above
) or below (OELayerPosition.Below
) the molecule.See examples (B) and (F) in Figure: Example of atom annotations.
CreateCopy¶
OEAtomGlyphBase *CreateCopy() const
Deep copy constructor that returns a copy of the object.
The memory for the returned OEAtomGlyphCircle
object is dynamically allocated and owned by the caller.
RenderGlyph¶
bool RenderGlyph(OEDepict::OE2DMolDisplay &disp, const OEChem::OEAtomBase *atom) const
Draws a glyph (in this case a circle) around the given atom.
- disp
The
OE2DMolDisplay
object that is modified to annotate the specified atom.- atom
The
OEAtomBase
object being annotated.