ACloudViewer  3.9.4
A Modern Library for 3D Data Processing
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QCPGrid Class Reference

Responsible for drawing the grid of a QCPAxis. More...

#include <qcustomplot.h>

Inheritance diagram for QCPGrid:
Inheritance graph
[legend]
Collaboration diagram for QCPGrid:
Collaboration graph
[legend]

Public Member Functions

 QCPGrid (QCPAxis *parentAxis)
 
bool subGridVisible () const
 
bool antialiasedSubGrid () const
 
bool antialiasedZeroLine () const
 
QPen pen () const
 
QPen subGridPen () const
 
QPen zeroLinePen () const
 
void setSubGridVisible (bool visible)
 
void setAntialiasedSubGrid (bool enabled)
 
void setAntialiasedZeroLine (bool enabled)
 
void setPen (const QPen &pen)
 
void setSubGridPen (const QPen &pen)
 
void setZeroLinePen (const QPen &pen)
 
 QCPGrid (QCPAxis *parentAxis)
 
bool subGridVisible () const
 
bool antialiasedSubGrid () const
 
bool antialiasedZeroLine () const
 
QPen pen () const
 
QPen subGridPen () const
 
QPen zeroLinePen () const
 
void setSubGridVisible (bool visible)
 
void setAntialiasedSubGrid (bool enabled)
 
void setAntialiasedZeroLine (bool enabled)
 
void setPen (const QPen &pen)
 
void setSubGridPen (const QPen &pen)
 
void setZeroLinePen (const QPen &pen)
 
- Public Member Functions inherited from QCPLayerable
 QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0)
 
virtual ~QCPLayerable ()
 
bool visible () const
 
QCustomPlot * parentPlot () const
 
QCPLayerable * parentLayerable () const
 
QCPLayer * layer () const
 
bool antialiased () const
 
void setVisible (bool on)
 
Q_SLOT bool setLayer (QCPLayer *layer)
 
bool setLayer (const QString &layerName)
 
void setAntialiased (bool enabled)
 
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
 
bool realVisibility () const
 
 QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0)
 
 ~QCPLayerable ()
 
bool visible () const
 
QCustomPlot * parentPlot () const
 
QCPLayerable * parentLayerable () const
 
QCPLayer * layer () const
 
bool antialiased () const
 
void setVisible (bool on)
 
Q_SLOT bool setLayer (QCPLayer *layer)
 
bool setLayer (const QString &layerName)
 
void setAntialiased (bool enabled)
 
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
 
bool realVisibility () const
 

Protected Member Functions

virtual void applyDefaultAntialiasingHint (QCPPainter *painter) const
 
virtual void draw (QCPPainter *painter)
 
void drawGridLines (QCPPainter *painter) const
 
void drawSubGridLines (QCPPainter *painter) const
 
virtual void applyDefaultAntialiasingHint (QCPPainter *painter) const
 
virtual void draw (QCPPainter *painter)
 
void drawGridLines (QCPPainter *painter) const
 
void drawSubGridLines (QCPPainter *painter) const
 
- Protected Member Functions inherited from QCPLayerable
virtual void parentPlotInitialized (QCustomPlot *parentPlot)
 
virtual QCP::Interaction selectionCategory () const
 
virtual QRect clipRect () const
 
virtual void selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
 
virtual void deselectEvent (bool *selectionStateChanged)
 
virtual void mousePressEvent (QMouseEvent *event, const QVariant &details)
 
virtual void mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)
 
virtual void mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)
 
virtual void mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)
 
virtual void wheelEvent (QWheelEvent *event)
 
void initializeParentPlot (QCustomPlot *parentPlot)
 
void setParentLayerable (QCPLayerable *parentLayerable)
 
bool moveToLayer (QCPLayer *layer, bool prepend)
 
void applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const
 
virtual void parentPlotInitialized (QCustomPlot *parentPlot)
 
virtual QCP::Interaction selectionCategory () const
 
virtual QRect clipRect () const
 
virtual void selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
 
virtual void deselectEvent (bool *selectionStateChanged)
 
void initializeParentPlot (QCustomPlot *parentPlot)
 
void setParentLayerable (QCPLayerable *parentLayerable)
 
bool moveToLayer (QCPLayer *layer, bool prepend)
 
void applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const
 

Protected Attributes

bool mSubGridVisible
 
bool mAntialiasedSubGrid
 
bool mAntialiasedZeroLine
 
QPen mPen
 
QPen mSubGridPen
 
QPen mZeroLinePen
 
QCPAxis * mParentAxis
 
- Protected Attributes inherited from QCPLayerable
bool mVisible
 
QCustomPlot * mParentPlot
 
QPointer< QCPLayerable > mParentLayerable
 
QCPLayer * mLayer
 
bool mAntialiased
 

Additional Inherited Members

- Signals inherited from QCPLayerable
void layerChanged (QCPLayer *newLayer)
 
void layerChanged (QCPLayer *newLayer)
 

Detailed Description

Responsible for drawing the grid of a QCPAxis.

This class is tightly bound to QCPAxis. Every axis owns a grid instance and uses it to draw the grid lines, sub grid lines and zero-line. You can interact with the grid of an axis via QCPAxis::grid. Normally, you don't need to create an instance of QCPGrid yourself.

The axis and grid drawing was split into two classes to allow them to be placed on different layers (both QCPAxis and QCPGrid inherit from QCPLayerable). Thus it is possible to have the grid in the background and the axes in the foreground, and any plottables/items in between. This described situation is the default setup, see the QCPLayer documentation.

Definition at line 2202 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPGrid() [1/2]

QCPGrid::QCPGrid ( QCPAxis *  parentAxis)
explicit

Creates a QCPGrid instance and sets default values.

You shouldn't instantiate grids on their own, since every QCPAxis brings its own QCPGrid.

Definition at line 7349 of file qcustomplot.cpp.

References QCPLayerable::setAntialiased(), setAntialiasedSubGrid(), setAntialiasedZeroLine(), setPen(), setSubGridPen(), setSubGridVisible(), and setZeroLinePen().

◆ QCPGrid() [2/2]

QCPGrid::QCPGrid ( QCPAxis *  parentAxis)

Member Function Documentation

◆ antialiasedSubGrid() [1/2]

bool QCPGrid::antialiasedSubGrid ( ) const
inline

Definition at line 2219 of file qcustomplot.h.

◆ antialiasedSubGrid() [2/2]

bool QCPGrid::antialiasedSubGrid ( ) const
inline

Definition at line 1166 of file qcustomplot.h.

◆ antialiasedZeroLine() [1/2]

bool QCPGrid::antialiasedZeroLine ( ) const
inline

Definition at line 2220 of file qcustomplot.h.

◆ antialiasedZeroLine() [2/2]

bool QCPGrid::antialiasedZeroLine ( ) const
inline

Definition at line 1167 of file qcustomplot.h.

◆ applyDefaultAntialiasingHint() [1/2]

void QCPGrid::applyDefaultAntialiasingHint ( QCPPainter *  painter) const
protectedvirtual

Implements QCPLayerable.

Definition at line 7418 of file qcustomplot.cpp.

References QCP::aeGrid, QCPLayerable::applyAntialiasingHint(), and QCPLayerable::mAntialiased.

Referenced by drawGridLines().

◆ applyDefaultAntialiasingHint() [2/2]

virtual void QCPGrid::applyDefaultAntialiasingHint ( QCPPainter *  painter) const
protectedvirtual

Implements QCPLayerable.

◆ draw() [1/2]

void QCPGrid::draw ( QCPPainter *  painter)
protectedvirtual

Implements QCPLayerable.

Definition at line 7428 of file qcustomplot.cpp.

References drawGridLines(), drawSubGridLines(), mParentAxis, mSubGridVisible, and QCPAxis::subTicks().

◆ draw() [2/2]

virtual void QCPGrid::draw ( QCPPainter *  painter)
protectedvirtual

Implements QCPLayerable.

◆ drawGridLines() [1/2]

void QCPGrid::drawGridLines ( QCPPainter *  painter) const
protected

Definition at line 7444 of file qcustomplot.cpp.

References QCP::aeZeroLine, QCPLayerable::applyAntialiasingHint(), applyDefaultAntialiasingHint(), QCPAxisRect::bottom(), QCPAxis::coordToPixel(), QCPPainter::drawLine(), QCPAxisRect::left(), QCPRange::lower, mAntialiasedZeroLine, QCPAxis::mAxisRect, mParentAxis, mPen, QCPAxis::mRange, QCPAxis::mTickVector, mZeroLinePen, QCPAxis::orientation(), QCPAxis::range(), QCPAxisRect::right(), QCPPainter::setPen(), QCPRange::size(), QCPAxisRect::top(), and QCPRange::upper.

Referenced by draw().

◆ drawGridLines() [2/2]

void QCPGrid::drawGridLines ( QCPPainter *  painter) const
protected

◆ drawSubGridLines() [1/2]

void QCPGrid::drawSubGridLines ( QCPPainter *  painter) const
protected

Definition at line 7525 of file qcustomplot.cpp.

References QCP::aeSubGrid, QCPLayerable::applyAntialiasingHint(), QCPAxisRect::bottom(), QCPAxis::coordToPixel(), QCPPainter::drawLine(), QCPAxisRect::left(), mAntialiasedSubGrid, QCPAxis::mAxisRect, mParentAxis, mSubGridPen, QCPAxis::mSubTickVector, QCPAxis::orientation(), QCPAxisRect::right(), QCPPainter::setPen(), and QCPAxisRect::top().

Referenced by draw().

◆ drawSubGridLines() [2/2]

void QCPGrid::drawSubGridLines ( QCPPainter *  painter) const
protected

◆ pen() [1/2]

QPen QCPGrid::pen ( ) const
inline

Definition at line 2221 of file qcustomplot.h.

Referenced by setPen(), setSubGridPen(), and setZeroLinePen().

◆ pen() [2/2]

QPen QCPGrid::pen ( ) const
inline

Definition at line 1168 of file qcustomplot.h.

◆ setAntialiasedSubGrid() [1/2]

void QCPGrid::setAntialiasedSubGrid ( bool  enabled)

Sets whether sub grid lines are drawn antialiased.

Definition at line 7374 of file qcustomplot.cpp.

References mAntialiasedSubGrid.

Referenced by QCPGrid().

◆ setAntialiasedSubGrid() [2/2]

void QCPGrid::setAntialiasedSubGrid ( bool  enabled)

◆ setAntialiasedZeroLine() [1/2]

void QCPGrid::setAntialiasedZeroLine ( bool  enabled)

Sets whether zero lines are drawn antialiased.

Definition at line 7381 of file qcustomplot.cpp.

References mAntialiasedZeroLine.

Referenced by QCPGrid().

◆ setAntialiasedZeroLine() [2/2]

void QCPGrid::setAntialiasedZeroLine ( bool  enabled)

◆ setPen() [1/2]

void QCPGrid::setPen ( const QPen &  pen)

Sets the pen with which (major) grid lines are drawn.

Definition at line 7388 of file qcustomplot.cpp.

References mPen, and pen().

Referenced by QCPGrid().

◆ setPen() [2/2]

void QCPGrid::setPen ( const QPen &  pen)

◆ setSubGridPen() [1/2]

void QCPGrid::setSubGridPen ( const QPen &  pen)

Sets the pen with which sub grid lines are drawn.

Definition at line 7393 of file qcustomplot.cpp.

References mSubGridPen, and pen().

Referenced by QCPGrid().

◆ setSubGridPen() [2/2]

void QCPGrid::setSubGridPen ( const QPen &  pen)

◆ setSubGridVisible() [1/2]

void QCPGrid::setSubGridVisible ( bool  visible)

Sets whether grid lines at sub tick marks are drawn.

See also
setSubGridPen

Definition at line 7369 of file qcustomplot.cpp.

References mSubGridVisible, and QCPLayerable::visible().

Referenced by QCPGrid().

◆ setSubGridVisible() [2/2]

void QCPGrid::setSubGridVisible ( bool  visible)

◆ setZeroLinePen() [1/2]

void QCPGrid::setZeroLinePen ( const QPen &  pen)

Sets the pen with which zero lines are drawn.

Zero lines are lines at value coordinate 0 which may be drawn with a different pen than other grid lines. To disable zero lines and just draw normal grid lines at zero, set pen to Qt::NoPen.

Definition at line 7402 of file qcustomplot.cpp.

References mZeroLinePen, and pen().

Referenced by QCPAxisRect::QCPAxisRect(), and QCPGrid().

◆ setZeroLinePen() [2/2]

void QCPGrid::setZeroLinePen ( const QPen &  pen)

◆ subGridPen() [1/2]

QPen QCPGrid::subGridPen ( ) const
inline

Definition at line 2222 of file qcustomplot.h.

◆ subGridPen() [2/2]

QPen QCPGrid::subGridPen ( ) const
inline

Definition at line 1169 of file qcustomplot.h.

◆ subGridVisible() [1/2]

bool QCPGrid::subGridVisible ( ) const
inline

Definition at line 2218 of file qcustomplot.h.

◆ subGridVisible() [2/2]

bool QCPGrid::subGridVisible ( ) const
inline

Definition at line 1165 of file qcustomplot.h.

◆ zeroLinePen() [1/2]

QPen QCPGrid::zeroLinePen ( ) const
inline

Definition at line 2223 of file qcustomplot.h.

◆ zeroLinePen() [2/2]

QPen QCPGrid::zeroLinePen ( ) const
inline

Definition at line 1170 of file qcustomplot.h.

Member Data Documentation

◆ mAntialiasedSubGrid

bool QCPGrid::mAntialiasedSubGrid
protected

Definition at line 2236 of file qcustomplot.h.

Referenced by drawSubGridLines(), and setAntialiasedSubGrid().

◆ mAntialiasedZeroLine

bool QCPGrid::mAntialiasedZeroLine
protected

Definition at line 2236 of file qcustomplot.h.

Referenced by drawGridLines(), and setAntialiasedZeroLine().

◆ mParentAxis

QCPAxis * QCPGrid::mParentAxis
protected

Definition at line 2240 of file qcustomplot.h.

Referenced by draw(), drawGridLines(), and drawSubGridLines().

◆ mPen

QPen QCPGrid::mPen
protected

Definition at line 2237 of file qcustomplot.h.

Referenced by drawGridLines(), and setPen().

◆ mSubGridPen

QPen QCPGrid::mSubGridPen
protected

Definition at line 2237 of file qcustomplot.h.

Referenced by drawSubGridLines(), and setSubGridPen().

◆ mSubGridVisible

bool QCPGrid::mSubGridVisible
protected

Definition at line 2235 of file qcustomplot.h.

Referenced by draw(), and setSubGridVisible().

◆ mZeroLinePen

QPen QCPGrid::mZeroLinePen
protected

Definition at line 2237 of file qcustomplot.h.

Referenced by drawGridLines(), and setZeroLinePen().

The documentation for this class was generated from the following files: