My Project
|
Holds multiple axes and arranges them in a rectangular shape. More...
Public Member Functions | |
QCPAxisRect (QCustomPlot *parentPlot, bool setupDefaultAxes=true) | |
QPixmap | background () const |
bool | backgroundScaled () const |
Qt::AspectRatioMode | backgroundScaledMode () const |
Qt::Orientations | rangeDrag () const |
Qt::Orientations | rangeZoom () const |
QCPAxis * | rangeDragAxis (Qt::Orientation orientation) |
QCPAxis * | rangeZoomAxis (Qt::Orientation orientation) |
double | rangeZoomFactor (Qt::Orientation orientation) |
void | setBackground (const QPixmap &pm) |
void | setBackground (const QPixmap &pm, bool scaled, Qt::AspectRatioMode mode=Qt::KeepAspectRatioByExpanding) |
void | setBackground (const QBrush &brush) |
void | setBackgroundScaled (bool scaled) |
void | setBackgroundScaledMode (Qt::AspectRatioMode mode) |
void | setRangeDrag (Qt::Orientations orientations) |
void | setRangeZoom (Qt::Orientations orientations) |
void | setRangeDragAxes (QCPAxis *horizontal, QCPAxis *vertical) |
void | setRangeZoomAxes (QCPAxis *horizontal, QCPAxis *vertical) |
void | setRangeZoomFactor (double horizontalFactor, double verticalFactor) |
void | setRangeZoomFactor (double factor) |
int | axisCount (QCPAxis::AxisType type) const |
QCPAxis * | axis (QCPAxis::AxisType type, int index=0) const |
QList< QCPAxis * > | axes (QCPAxis::AxisTypes types) const |
QList< QCPAxis * > | axes () const |
QCPAxis * | addAxis (QCPAxis::AxisType type) |
QList< QCPAxis * > | addAxes (QCPAxis::AxisTypes types) |
bool | removeAxis (QCPAxis *axis) |
QCPLayoutInset * | insetLayout () const |
void | setupFullAxesBox (bool connectRanges=false) |
QList< QCPAbstractPlottable * > | plottables () const |
QList< QCPGraph * > | graphs () const |
QList< QCPAbstractItem * > | items () const |
int | left () const |
int | right () const |
int | top () const |
int | bottom () const |
int | width () const |
int | height () const |
QSize | size () const |
QPoint | topLeft () const |
QPoint | topRight () const |
QPoint | bottomLeft () const |
QPoint | bottomRight () const |
QPoint | center () const |
virtual void | update () |
virtual QList< QCPLayoutElement * > | elements (bool recursive) const |
![]() | |
QCPLayoutElement (QCustomPlot *parentPlot=0) | |
QCPLayout * | layout () const |
QRect | rect () const |
QRect | outerRect () const |
QMargins | margins () const |
QMargins | minimumMargins () const |
QCP::MarginSides | autoMargins () const |
QSize | minimumSize () const |
QSize | maximumSize () const |
QCPMarginGroup * | marginGroup (QCP::MarginSide side) const |
QHash< QCP::MarginSide, QCPMarginGroup * > | marginGroups () const |
void | setOuterRect (const QRect &rect) |
void | setMargins (const QMargins &margins) |
void | setMinimumMargins (const QMargins &margins) |
void | setAutoMargins (QCP::MarginSides sides) |
void | setMinimumSize (const QSize &size) |
void | setMinimumSize (int width, int height) |
void | setMaximumSize (const QSize &size) |
void | setMaximumSize (int width, int height) |
void | setMarginGroup (QCP::MarginSides sides, QCPMarginGroup *group) |
virtual QSize | minimumSizeHint () const |
virtual QSize | maximumSizeHint () const |
virtual double | selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const |
![]() | |
QCPLayerable (QCustomPlot *plot, QString targetLayer="", QCPLayerable *parentLayerable=0) | |
bool | visible () const |
QCustomPlot * | parentPlot () const |
QCPLayerable * | parentLayerable () const |
QCPLayer * | layer () const |
bool | antialiased () const |
void | setVisible (bool on) |
bool | setLayer (QCPLayer *layer) |
bool | setLayer (const QString &layerName) |
void | setAntialiased (bool enabled) |
bool | realVisibility () const |
Protected Member Functions | |
virtual void | applyDefaultAntialiasingHint (QCPPainter *painter) const |
virtual void | draw (QCPPainter *painter) |
virtual int | calculateAutoMargin (QCP::MarginSide side) |
virtual void | mousePressEvent (QMouseEvent *event) |
virtual void | mouseMoveEvent (QMouseEvent *event) |
virtual void | mouseReleaseEvent (QMouseEvent *event) |
virtual void | wheelEvent (QWheelEvent *event) |
void | drawBackground (QCPPainter *painter) |
void | updateAxesOffset (QCPAxis::AxisType type) |
![]() | |
virtual void | mouseDoubleClickEvent (QMouseEvent *event) |
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 | |
QBrush | mBackgroundBrush |
QPixmap | mBackgroundPixmap |
QPixmap | mScaledBackgroundPixmap |
bool | mBackgroundScaled |
Qt::AspectRatioMode | mBackgroundScaledMode |
QCPLayoutInset * | mInsetLayout |
Qt::Orientations | mRangeDrag |
Qt::Orientations | mRangeZoom |
QPointer< QCPAxis > | mRangeDragHorzAxis |
QPointer< QCPAxis > | mRangeDragVertAxis |
QPointer< QCPAxis > | mRangeZoomHorzAxis |
QPointer< QCPAxis > | mRangeZoomVertAxis |
double | mRangeZoomFactorHorz |
double | mRangeZoomFactorVert |
QCPRange | mDragStartHorzRange |
QCPRange | mDragStartVertRange |
QCP::AntialiasedElements | mAADragBackup |
QCP::AntialiasedElements | mNotAADragBackup |
QPoint | mDragStart |
bool | mDragging |
QHash< QCPAxis::AxisType, QList< QCPAxis * > > | mAxes |
![]() | |
QCPLayout * | mParentLayout |
QSize | mMinimumSize |
QSize | mMaximumSize |
QRect | mRect |
QRect | mOuterRect |
QMargins | mMargins |
QMargins | mMinimumMargins |
QCP::MarginSides | mAutoMargins |
QHash< QCP::MarginSide, QCPMarginGroup * > | mMarginGroups |
![]() | |
bool | mVisible |
QCustomPlot * | mParentPlot |
QPointer< QCPLayerable > | mParentLayerable |
QCPLayer * | mLayer |
bool | mAntialiased |
Friends | |
class | QCustomPlot |
Holds multiple axes and arranges them in a rectangular shape.
This class represents an axis rect, a rectangular area that is bounded on all sides with an arbitrary number of axes.
Initially QCustomPlot has one axis rect, accessible via QCustomPlot::axisRect(). However, the layout system allows to have multiple axis rects, e.g. arranged in a grid layout (QCustomPlot::plotLayout).
By default, QCPAxisRect comes with four axes, at bottom, top, left and right. They can be accessed via axis by providing the respective axis type (QCPAxis::AxisType) and index. If you need all axes in the axis rect, use axes. The top and right axes are set to be invisible initially (QCPAxis::setVisible). To add more axes to a side, use addAxis or addAxes. To remove an axis, use removeAxis.
The axis rect layerable itself only draws a background pixmap or color, if specified (setBackground). It is placed on the "background" layer initially (see QCPLayer for an explanation of the QCustomPlot layer system). The axes that are held by the axis rect can be placed on other layers, independently of the axis rect.
Every axis rect has a child layout of type QCPLayoutInset. It is accessible via insetLayout and can be used to have other layout elements (or even other layouts with multiple elements) hovering inside the axis rect.
If an axis rect is clicked and dragged, it processes this by moving certain axis ranges. The behaviour can be controlled with setRangeDrag and setRangeDragAxes. If the mouse wheel is scrolled while the cursor is on the axis rect, certain axes are scaled. This is controllable via setRangeZoom, setRangeZoomAxes and setRangeZoomFactor. These interactions are only enabled if QCustomPlot::setInteractions contains QCP::iRangeDrag and QCP::iRangeZoom.
|
explicit |
Creates a QCPAxisRect instance and sets default values. An axis is added for each of the four sides, the top and right axes are set invisible initially.
QList< QCPAxis * > QCPAxisRect::addAxes | ( | QCPAxis::AxisTypes | types | ) |
Adds a new axis with addAxis to each axis rect side specified in types. This may be an or
-combination of QCPAxis::AxisType, so axes can be added to multiple sides at once.
Returns a list of the added axes.
QCPAxis * QCPAxisRect::addAxis | ( | QCPAxis::AxisType | type | ) |
Adds a new axis to the axis rect side specified with type, and returns it.
If an axis rect side already contains one or more axes, the lower and upper endings of the new axis (QCPAxis::setLowerEnding, QCPAxis::setUpperEnding) are initialized to QCPLineEnding::esHalfBar.
QList< QCPAxis * > QCPAxisRect::axes | ( | QCPAxis::AxisTypes | types | ) | const |
Returns all axes on the axis rect sides specified with types.
types may be a single QCPAxis::AxisType or an or
-combination, to get the axes of multiple sides.
QList< QCPAxis * > QCPAxisRect::axes | ( | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Returns all axes of this axis rect.
QCPAxis * QCPAxisRect::axis | ( | QCPAxis::AxisType | type, |
int | index = 0 |
||
) | const |
int QCPAxisRect::axisCount | ( | QCPAxis::AxisType | type | ) | const |
Returns the number of axes on the axis rect side specified with type.
|
inline |
Returns the pixel position of the bottom border of this axis rect. Margins are not taken into account here, so the returned value is with respect to the inner rect.
|
inline |
Returns the bottom left corner of this axis rect in pixels. Margins are not taken into account here, so the returned value is with respect to the inner rect.
|
inline |
Returns the bottom right corner of this axis rect in pixels. Margins are not taken into account here, so the returned value is with respect to the inner rect.
|
inline |
Returns the center of this axis rect in pixels. Margins are not taken into account here, so the returned value is with respect to the inner rect.
|
virtual |
Returns a list of all child elements in this layout element. If recursive is true, all sub-child elements are included in the list, too.
Note that there may be entries with value 0 in the returned list. (For example, QCPLayoutGrid may have empty cells which yield 0 at the respective index.)
Reimplemented from QCPLayoutElement.
QList< QCPGraph * > QCPAxisRect::graphs | ( | ) | const |
Returns a list of all the graphs that are associated with this axis rect.
A graph is considered associated with an axis rect if its key or value axis (or both) is in this axis rect.
|
inline |
Returns the pixel height of this axis rect. Margins are not taken into account here, so the returned value is with respect to the inner rect.
|
inline |
Returns the inset layout of this axis rect. It can be used to place other layout elements (or even layouts with multiple other elements) inside/on top of an axis rect.
QList< QCPAbstractItem * > QCPAxisRect::items | ( | ) | const |
Returns a list of all the items that are associated with this axis rect.
An item is considered associated with an axis rect if any of its positions has key or value axis set to an axis that is in this axis rect, or if any of its positions has QCPItemPosition::setAxisRect set to the axis rect, or if the clip axis rect (QCPAbstractItem::setClipAxisRect) is set to this axis rect.
|
inline |
Returns the pixel position of the left border of this axis rect. Margins are not taken into account here, so the returned value is with respect to the inner rect.
|
protectedvirtual |
This event is called, if the mouse is moved inside the outer rect of this layout element.
Reimplemented from QCPLayoutElement.
|
protectedvirtual |
This event is called, if the mouse was pressed while being inside the outer rect of this layout element.
Reimplemented from QCPLayoutElement.
|
protectedvirtual |
This event is called, if the mouse was previously pressed inside the outer rect of this layout element and is now released.
Reimplemented from QCPLayoutElement.
QList< QCPAbstractPlottable * > QCPAxisRect::plottables | ( | ) | const |
QCPAxis * QCPAxisRect::rangeDragAxis | ( | Qt::Orientation | orientation | ) |
Returns the range drag axis of the orientation provided.
QCPAxis * QCPAxisRect::rangeZoomAxis | ( | Qt::Orientation | orientation | ) |
Returns the range zoom axis of the orientation provided.
double QCPAxisRect::rangeZoomFactor | ( | Qt::Orientation | orientation | ) |
Returns the range zoom factor of the orientation provided.
bool QCPAxisRect::removeAxis | ( | QCPAxis * | axis | ) |
Removes the specified axis from the axis rect and deletes it.
Returns true on success, i.e. if axis was a valid axis in this axis rect.
|
inline |
Returns the pixel position of the right border of this axis rect. Margins are not taken into account here, so the returned value is with respect to the inner rect.
void QCPAxisRect::setBackground | ( | const QPixmap & | pm | ) |
Sets pm as the axis background pixmap. The axis background pixmap will be drawn inside the axis rect. Since axis rects place themselves on the "background" layer by default, the axis rect backgrounds are usually drawn below everything else.
For cases where the provided pixmap doesn't have the same size as the axis rect, scaling can be enabled with setBackgroundScaled and the scaling mode (i.e. whether and how the aspect ratio is preserved) can be set with setBackgroundScaledMode. To set all these options in one call, consider using the overloaded version of this function.
Below the pixmap, the axis rect may be optionally filled with a brush, if specified with setBackground(const QBrush &brush).
void QCPAxisRect::setBackground | ( | const QPixmap & | pm, |
bool | scaled, | ||
Qt::AspectRatioMode | mode = Qt::KeepAspectRatioByExpanding |
||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Allows setting the background pixmap of the axis rect, whether it shall be scaled and how it shall be scaled in one call.
void QCPAxisRect::setBackground | ( | const QBrush & | brush | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Sets brush as the background brush. The axis rect background will be filled with this brush. Since axis rects place themselves on the "background" layer by default, the axis rect backgrounds are usually drawn below everything else.
The brush will be drawn before (under) any background pixmap, which may be specified with setBackground(const QPixmap &pm).
To disable drawing of a background brush, set brush to Qt::NoBrush.
void QCPAxisRect::setBackgroundScaled | ( | bool | scaled | ) |
Sets whether the axis background pixmap shall be scaled to fit the axis rect or not. If scaled is set to true, you may control whether and how the aspect ratio of the original pixmap is preserved with setBackgroundScaledMode.
Note that the scaled version of the original pixmap is buffered, so there is no performance penalty on replots. (Except when the axis rect dimensions are changed continuously.)
void QCPAxisRect::setBackgroundScaledMode | ( | Qt::AspectRatioMode | mode | ) |
If scaling of the axis background pixmap is enabled (setBackgroundScaled), use this function to define whether and how the aspect ratio of the original pixmap passed to setBackground is preserved.
void QCPAxisRect::setRangeDrag | ( | Qt::Orientations | orientations | ) |
Sets which axis orientation may be range dragged by the user with mouse interaction. What orientation corresponds to which specific axis can be set with setRangeDragAxes(QCPAxis *horizontal, QCPAxis *vertical). By default, the horizontal axis is the bottom axis (xAxis) and the vertical axis is the left axis (yAxis).
To disable range dragging entirely, pass 0 as orientations or remove QCP::iRangeDrag from QCustomPlot::setInteractions. To enable range dragging for both directions, pass Qt::Horizontal | Qt::Vertical
as orientations.
In addition to setting orientations to a non-zero value, make sure QCustomPlot::setInteractions contains QCP::iRangeDrag to enable the range dragging interaction.
Sets the axes whose range will be dragged when setRangeDrag enables mouse range dragging on the QCustomPlot widget.
void QCPAxisRect::setRangeZoom | ( | Qt::Orientations | orientations | ) |
Sets which axis orientation may be zoomed by the user with the mouse wheel. What orientation corresponds to which specific axis can be set with setRangeZoomAxes(QCPAxis *horizontal, QCPAxis *vertical). By default, the horizontal axis is the bottom axis (xAxis) and the vertical axis is the left axis (yAxis).
To disable range zooming entirely, pass 0 as orientations or remove QCP::iRangeZoom from QCustomPlot::setInteractions. To enable range zooming for both directions, pass Qt::Horizontal | Qt::Vertical
as orientations.
In addition to setting orientations to a non-zero value, make sure QCustomPlot::setInteractions contains QCP::iRangeZoom to enable the range zooming interaction.
Sets the axes whose range will be zoomed when setRangeZoom enables mouse wheel zooming on the QCustomPlot widget. The two axes can be zoomed with different strengths, when different factors are passed to setRangeZoomFactor(double horizontalFactor, double verticalFactor).
void QCPAxisRect::setRangeZoomFactor | ( | double | horizontalFactor, |
double | verticalFactor | ||
) |
Sets how strong one rotation step of the mouse wheel zooms, when range zoom was activated with setRangeZoom. The two parameters horizontalFactor and verticalFactor provide a way to let the horizontal axis zoom at different rates than the vertical axis. Which axis is horizontal and which is vertical, can be set with setRangeZoomAxes.
When the zoom factor is greater than one, scrolling the mouse wheel backwards (towards the user) will zoom in (make the currently visible range smaller). For zoom factors smaller than one, the same scrolling direction will zoom out.
void QCPAxisRect::setRangeZoomFactor | ( | double | factor | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Sets both the horizontal and vertical zoom factor.
void QCPAxisRect::setupFullAxesBox | ( | bool | connectRanges = false | ) |
Convenience function to create an axis on each side that doesn't have any axes yet, and assign the top/right axes the following properties of the bottom/left axes (even if they already existed and weren't created by this function):
Tick labels (QCPAxis::setTickLabels) of the right and top axes are set to false.
If connectRanges is true, the rangeChanged signals of the bottom and left axes are connected to the QCPAxis::setRange slots of the top and right axes.
|
inline |
Returns the pixel size of this axis rect. Margins are not taken into account here, so the returned value is with respect to the inner rect.
|
inline |
Returns the pixel position of the top border of this axis rect. Margins are not taken into account here, so the returned value is with respect to the inner rect.
|
inline |
Returns the top left corner of this axis rect in pixels. Margins are not taken into account here, so the returned value is with respect to the inner rect.
|
inline |
Returns the top right corner of this axis rect in pixels. Margins are not taken into account here, so the returned value is with respect to the inner rect.
|
virtual |
This method is called automatically upon replot and doesn't need to be called by users of QCPAxisRect.
Calls the base class implementation to update the margins (see QCPLayoutElement::update), and finally passes the rect to the inset layout (insetLayout) and calls its QCPInsetLayout::update function.
Reimplemented from QCPLayoutElement.
|
protectedvirtual |
This event is called, if the mouse wheel is scrolled while the cursor is inside the rect of this layout element.
Reimplemented from QCPLayoutElement.
|
inline |
Returns the pixel width of this axis rect. Margins are not taken into account here, so the returned value is with respect to the inner rect.