OEBondGlyphCircle¶
class OEBondGlyphCircle : public OEBondGlyphBase
By using the OEBondGlyphCircle class, bonds can be annotated by drawing a circle in the middle of them.
See also
Annotating Atoms and Bonds chapter
OECircleStylenamespaceOEBondGlyphArrow class
OEBondGlyphCross class
OEBondGlyphCurvedArrow class
OEBondGlyphScissors class
OEBondGlyphStitch class
OEBondGlyphZigZag class
The following methods are publicly inherited from OEBondGlyphBase:
Constructors¶
OEBondGlyphCircle(const OEDepict::OEPen &,
unsigned int circlestyle=OECircleStyle::Default,
double circleRadiusScale=1.0,
unsigned int layer=OEDepict::OELayerPosition::Above)
Creates an OEBondGlyphCircle object with the specified parameters.
Example of bond annotations¶
- pen
The pen used when drawing a circle in the middle of a bond.
See examples (A) and (B) in Figure: Example of bond annotations.
- circlestyle
The style of the drawn circle from the
OECircleStylenamespace.See examples (C) and (D) in Figure: Example of bond annotations.
- circleRadiusScale
The multiplier used to modify the radius of the drawn circles.
See examples (D) and (E) in Figure: Example of bond 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 bond annotations.
CreateCopy¶
OEBondGlyphBase *CreateCopy() const
Deep copy constructor that returns a copy of the object. The memory for the returned OEBondGlyphCircle object is dynamically allocated and owned by the caller.
RenderGlyph¶
bool RenderGlyph(OEDepict::OE2DMolDisplay &disp, const OEChem::OEBondBase *bond) const
Draws a glyph (in this case a circle) in the middle of the given bond.
- disp
The OE2DMolDisplay object that is modified to annotate the specified bond.
- bond
The OEBondBase object being annotated.