OEBondGlyphZigZag¶
class OEBondGlyphZigZag : public OEBondGlyphBase
By using the OEBondGlyphZigZag class, bonds can be annotated by drawing a zig-zag line across them.
See also
- Annotating Atoms and Bonds chapter
- OEBondGlyphArrow class
- OEBondGlyphCircle class
- OEBondGlyphCross class
- OEBondGlyphCurvedArrow class
- OEBondGlyphScissors class
- OEBondGlyphStitch class
The following methods are publicly inherited from OEBondGlyphBase:
| CreateCopy | RenderGlyph |
Constructors¶
OEBondGlyphZigZag(const OEDepict::OEPen &pen, double zigzagLengthScale=1.0,
unsigned int layer=OEDepict::OELayerPosition::Above)
Creates an OEBondGlyphZigZag object with the specified parameters.
Example of bond annotations
- pen
The pen used when drawing a zig-zag line across bond.
See examples (A) and (B) in Figure: Example of bond annotations.
- zigzagLengthScale
The multiplier used to modify the length of the drawn zig-zag line.
See examples (A) and (C) in Figure: Example of bond annotations.
- layer
Specifies whether the zig-zag line 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 OEBondGlyphZigZag 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 zig-zag line) across the given bond.
- disp
- The OE2DMolDisplay object that is modified to annotate the specified bond.
bond