OpenMS
Painter2DBase Class Referenceabstract

A base class for painting all items from a data layer (as supported by class derived from here) onto a 2D Canvas. More...

#include <OpenMS/VISUAL/Painter2DBase.h>

Inheritance diagram for Painter2DBase:
[legend]
Collaboration diagram for Painter2DBase:
[legend]

Public Member Functions

virtual ~Painter2DBase ()=default
 
virtual void paint (QPainter *painter, Plot2DCanvas *canvas, int layer_index)=0
 Paints items using the given painter onto the canvas. More...
 
virtual void highlightElement (QPainter *painter, Plot2DCanvas *canvas, const PeakIndex element)
 Emphasize a certain element (e.g. feature), e.g. when mouse hovering. By default, nothing is highlighted. Override for subclasses if you need highlighting. More...
 

Static Protected Member Functions

static void paintConvexHull_ (QPainter &painter, Plot2DCanvas *canvas, const ConvexHull2D &hull, bool has_identifications)
 Paints a convex hull. More...
 
static void paintConvexHulls_ (QPainter &painter, Plot2DCanvas *canvas, const std::vector< ConvexHull2D > &hulls, bool has_identifications)
 Paints convex hulls. More...
 
static void paintPeptideIDs_ (QPainter *painter, Plot2DCanvas *canvas, const IPeptideIds::PepIds &ids, int layer_index)
 

Additional Inherited Members

- Static Public Member Functions inherited from PainterBase
static ShapeIcon toShapeIcon (const String &icon)
 
static void drawDashedLine (const QPoint &from, const QPoint &to, QPainter *painter, const QColor &color)
 static method to draw a dashed line More...
 
static void drawCross (const QPoint &position, QPainter *painter, const int size=8)
 draw a cross at position, using a certain size (= width = height) of the cross More...
 
static void drawCaret (const QPoint &position, QPainter *painter, const int size=8)
 draw a caret '^' at position, using a certain size (= width) of the caret More...
 
static void drawDiamond (const QPoint &position, QPainter *painter, const int size=8)
 draw an unfilled diamond at position, using a certain size (= width = height) of the diamond More...
 
static void drawIcon (const QPoint &pos, const QRgb &color, const ShapeIcon icon, Size s, QPainter &p)
 draws squares, circles etc More...
 
static QPainterPath getOpenArrow (int arrow_width)
 An arrow head which is open, i.e. '>'. More...
 
static QPainterPath getClosedArrow (int arrow_width)
 An arrow head which is closed, i.e. a triangle. More...
 
static QRectF drawLineWithArrows (QPainter *painter, const QPen &pen, const QPoint &start, const QPoint &end, const QPainterPath &arrow_start=QPainterPath(), const QPainterPath &arrow_end=QPainterPath())
 

Detailed Description

A base class for painting all items from a data layer (as supported by class derived from here) onto a 2D Canvas.

Constructor & Destructor Documentation

◆ ~Painter2DBase()

virtual ~Painter2DBase ( )
virtualdefault

Member Function Documentation

◆ highlightElement()

virtual void highlightElement ( QPainter *  painter,
Plot2DCanvas canvas,
const PeakIndex  element 
)
virtual

Emphasize a certain element (e.g. feature), e.g. when mouse hovering. By default, nothing is highlighted. Override for subclasses if you need highlighting.

Parameters
painterThe painter used for drawing
canvasThe canvas to paint onto (should expose all the details needed, like canvas size, draw mode, colors etc)
elementWhich item of the current layer should be drawn?

Reimplemented in Painter2DConsensus, and Painter2DFeature.

◆ paint()

virtual void paint ( QPainter *  painter,
Plot2DCanvas canvas,
int  layer_index 
)
pure virtual

Paints items using the given painter onto the canvas.

Parameters
painterThe painter used for drawing
canvasThe canvas to paint onto (should expose all the details needed, like canvas size, draw mode, colors etc)
layer_indexWhich layer is currently painted

Implemented in Painter2DIonMobility, Painter2DChrom, Painter2DIdent, Painter2DConsensus, Painter2DFeature, and Painter2DPeak.

◆ paintConvexHull_()

static void paintConvexHull_ ( QPainter &  painter,
Plot2DCanvas canvas,
const ConvexHull2D hull,
bool  has_identifications 
)
staticprotected

Paints a convex hull.

Parameters
painterThe QPainter to paint on
canvasThe canvas (for configuration details)
hullReference to convex hull
has_identificationsDraw hulls in green (true) or blue color (false)

◆ paintConvexHulls_()

static void paintConvexHulls_ ( QPainter &  painter,
Plot2DCanvas canvas,
const std::vector< ConvexHull2D > &  hulls,
bool  has_identifications 
)
staticprotected

Paints convex hulls.

Parameters
painterThe QPainter to paint on
canvasThe canvas (for configuration details)
hullsReference to convex hulls
has_identificationsDraw hulls in green (true) or blue color (false)

◆ paintPeptideIDs_()

static void paintPeptideIDs_ ( QPainter *  painter,
Plot2DCanvas canvas,
const IPeptideIds::PepIds ids,
int  layer_index 
)
staticprotected