Loading...
Searching...
No Matches
DrawAnnotation.h
Go to the documentation of this file.
//
// Copyright (C) 2021-2022 David Cosgrove and other RDKit contributors
//
// @@ All Rights Reserved @@
// This file is part of the RDKit.
// The contents are covered by the terms of the BSD license
// which is included in the file license.txt, found at the root
// of the RDKit source tree.
//
// Original author: David Cosgrove (CozChemIx Limited)
//
// This class is a helper used by DrawMol to draw annotation (atom and bond
// notes, for example) onto the molecule.
// It is not part of the public API.
#ifndef RDKIT_DRAWANNOTATION_H
#define RDKIT_DRAWANNOTATION_H
#include <Geometry/point.h>
#include <GraphMol/MolDraw2D/DrawText.h>
#include <GraphMol/MolDraw2D/MolDraw2DHelpers.h>
namespace RDKit {
class MolDraw2D;
namespace MolDraw2D_detail {
class DrawAnnotation {
public:
~DrawAnnotation() = default;
DrawAnnotation(const std::string &note, const TextAlignType &align,
const std::string &cls, double relFontScale,
const Point2D &pos, const DrawColour &colour,
DrawText &textDrawer);
DrawAnnotation(const DrawAnnotation &) = delete;
DrawAnnotation(DrawAnnotation &&) = delete;
DrawAnnotation &operator=(const DrawAnnotation &) = delete;
DrawAnnotation &operator=(DrawAnnotation &&) = delete;
// expects xmin etc to be initialised to something sensible.
void findExtremes(double &xmin, double &xmax, double &ymin, double &ymax,
double padding = 0.0) const;
void getDimensions(double &width, double &height) const;
void extractRects();
void draw(MolDraw2D &molDrawer) const;
// this is for debugging almost always.
void drawRects(MolDraw2D &molDrawer) const;
void scale(const Point2D &scaleFactor);
void move(const Point2D &trans);
bool doesRectClash(const StringRect &rect, double padding) const;
std::string text_;
TextAlignType align_;
std::string class_; // for SVG output, most likely
double fontScale_; // fontScale to use
DrawText &textDrawer_;
Point2D pos_ = Point2D(0.0, 0.0);
DrawColour colour_ = DrawColour(0.0, 0.0, 0.0, 0.0);
std::vector<std::shared_ptr<StringRect>> rects_;
};
} // namespace MolDraw2D_detail
} // namespace RDKit
#endif // RDKIT_DRAWANNOTATION_H
DrawText.h
MolDraw2DHelpers.h
RDGeom::Point2D
Definition point.h:274
RDKit::MolDraw2D_detail::DrawAnnotation
Definition DrawAnnotation.h:29
RDKit::MolDraw2D_detail::DrawAnnotation::DrawAnnotation
DrawAnnotation(const DrawAnnotation &)=delete
RDKit::MolDraw2D_detail::DrawAnnotation::operator=
DrawAnnotation & operator=(DrawAnnotation &&)=delete
RDKit::MolDraw2D_detail::DrawAnnotation::colour_
DrawColour colour_
Definition DrawAnnotation.h:60
RDKit::MolDraw2D_detail::DrawAnnotation::textDrawer_
DrawText & textDrawer_
Definition DrawAnnotation.h:58
RDKit::MolDraw2D_detail::DrawAnnotation::DrawAnnotation
DrawAnnotation(DrawAnnotation &&)=delete
RDKit::MolDraw2D_detail::DrawAnnotation::pos_
Point2D pos_
Definition DrawAnnotation.h:59
RDKit::MolDraw2D_detail::DrawAnnotation::DrawAnnotation
DrawAnnotation(const std::string &note, const TextAlignType &align, const std::string &cls, double relFontScale, const Point2D &pos, const DrawColour &colour, DrawText &textDrawer)
RDKit::MolDraw2D_detail::DrawAnnotation::scale
void scale(const Point2D &scaleFactor)
RDKit::MolDraw2D_detail::DrawAnnotation::doesRectClash
bool doesRectClash(const StringRect &rect, double padding) const
RDKit::MolDraw2D_detail::DrawAnnotation::~DrawAnnotation
~DrawAnnotation()=default
RDKit::MolDraw2D_detail::DrawAnnotation::extractRects
void extractRects()
RDKit::MolDraw2D_detail::DrawAnnotation::move
void move(const Point2D &trans)
RDKit::MolDraw2D_detail::DrawAnnotation::getDimensions
void getDimensions(double &width, double &height) const
RDKit::MolDraw2D_detail::DrawAnnotation::fontScale_
double fontScale_
Definition DrawAnnotation.h:57
RDKit::MolDraw2D_detail::DrawAnnotation::class_
std::string class_
Definition DrawAnnotation.h:56
RDKit::MolDraw2D_detail::DrawAnnotation::align_
TextAlignType align_
Definition DrawAnnotation.h:55
RDKit::MolDraw2D_detail::DrawAnnotation::drawRects
void drawRects(MolDraw2D &molDrawer) const
RDKit::MolDraw2D_detail::DrawAnnotation::text_
std::string text_
Definition DrawAnnotation.h:54
RDKit::MolDraw2D_detail::DrawAnnotation::draw
void draw(MolDraw2D &molDrawer) const
RDKit::MolDraw2D_detail::DrawAnnotation::operator=
DrawAnnotation & operator=(const DrawAnnotation &)=delete
RDKit::MolDraw2D_detail::DrawAnnotation::findExtremes
void findExtremes(double &xmin, double &xmax, double &ymin, double &ymax, double padding=0.0) const
RDKit::MolDraw2D_detail::DrawAnnotation::rects_
std::vector< std::shared_ptr< StringRect > > rects_
Definition DrawAnnotation.h:61
RDKit::MolDraw2D_detail::DrawText
Definition DrawText.h:46
RDKit::MolDraw2D
MolDraw2D is the base class for doing 2D renderings of molecules.
Definition MolDraw2D.h:47
RDKit::MolDraw2D_detail::TextAlignType
TextAlignType
Definition MolDraw2DHelpers.h:26
RDKit
Std stuff.
Definition Abbreviations.h:19
RDKit::rdvalue_is
bool rdvalue_is(const RDValue_cast_t)
Definition RDValue-doublemagic.h:372
point.h
RDKit::DrawColour
Definition MolDraw2DHelpers.h:29
RDKit::MolDraw2D_detail::StringRect
Definition StringRect.h:24