OEBondGlyphArrow¶
class OEBondGlyphArrow : public OEBondGlyphBase
By using the OEBondGlyphArrow class, bonds can be annotated by drawing an arrow across them.
See also
Annotating Atoms and Bonds chapter
OEBondGlyphCircle class
OEBondGlyphCross class
OEBondGlyphCurvedArrow class
OEBondGlyphScissors class
OEBondGlyphStitch class
OEBondGlyphZigZag class
The following methods are publicly inherited from OEBondGlyphBase:
Constructors¶
OEBondGlyphArrow(const OEDepict::OEPen &, double arrowLengthScale=1.0,
unsigned int layer=OEDepict::OELayerPosition::Above)
Creates an OEBondGlyphArrow object with the specified parameters.
Example of bond annotations¶
- pen
The pen used when drawing an arrow across the middle of the bond.
See examples (A) and (B) in Figure: Example of bond annotations.
- arrowLengthScale
The multiplier used to modify the length of the drawn arrows.
See examples (A) and (C) in Figure: Example of bond annotations.
- layer
Specifies whether the arrow is drawn above (
OELayerPosition::Above) or below (OELayerPosition::Below) the molecule.See examples (B) and (D) 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 OEBondGlyphArrow 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 straight arrow) 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.