OEBondGlyphZigZag¶

class OEBondGlyphZigZag : public OEBondGlyphBase

By using the OEBondGlyphZigZag class, bonds can be annotated by drawing a zig-zag line across them.

Constructors¶

OEBondGlyphZigZag(const OEDepict::OEPen &pen, double zigzagLengthScale=1.0,
                  unsigned int layer=OEDepict::OELayerPosition::Above,
                  bool diagonal= false)

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 (D) in Figure: Example of bond annotations.

diagonal

Specifies whether the zig-zag line is drawn across the bond or in parallel with it.

See examples (A) and (E) 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: The OEBondBase object being annotated.