SimCenterCommon
Common functionality used within different SimCenter projects
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QCPAxisTickerFixed Class Reference

Specialized axis ticker with a fixed tick step. More...

#include <qcustomplot.h>

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

Public Types

enum  ScaleStrategy { ssNone, ssMultiples, ssPowers }
 
- Public Types inherited from QCPAxisTicker
enum  TickStepStrategy { tssReadability, tssMeetTickCount }
 

Public Member Functions

 QCPAxisTickerFixed ()
 
double tickStep () const
 
ScaleStrategy scaleStrategy () const
 
void setTickStep (double step)
 
void setScaleStrategy (ScaleStrategy strategy)
 
- Public Member Functions inherited from QCPAxisTicker
 QCPAxisTicker ()
 
virtual ~QCPAxisTicker ()
 
TickStepStrategy tickStepStrategy () const
 
int tickCount () const
 
double tickOrigin () const
 
void setTickStepStrategy (TickStepStrategy strategy)
 
void setTickCount (int count)
 
void setTickOrigin (double origin)
 
virtual void generate (const QCPRange &range, const QLocale &locale, QChar formatChar, int precision, QVector< double > &ticks, QVector< double > *subTicks, QVector< QString > *tickLabels)
 

Protected Member Functions

virtual double getTickStep (const QCPRange &range) Q_DECL_OVERRIDE
 
- Protected Member Functions inherited from QCPAxisTicker
virtual int getSubTickCount (double tickStep)
 
virtual QString getTickLabel (double tick, const QLocale &locale, QChar formatChar, int precision)
 
virtual QVector< double > createTickVector (double tickStep, const QCPRange &range)
 
virtual QVector< double > createSubTickVector (int subTickCount, const QVector< double > &ticks)
 
virtual QVector< QString > createLabelVector (const QVector< double > &ticks, const QLocale &locale, QChar formatChar, int precision)
 
void trimTicks (const QCPRange &range, QVector< double > &ticks, bool keepOneOutlier) const
 
double pickClosest (double target, const QVector< double > &candidates) const
 
double getMantissa (double input, double *magnitude=0) const
 
double cleanMantissa (double input) const
 

Protected Attributes

double mTickStep
 
ScaleStrategy mScaleStrategy
 
- Protected Attributes inherited from QCPAxisTicker
TickStepStrategy mTickStepStrategy
 
int mTickCount
 
double mTickOrigin
 

Detailed Description

Specialized axis ticker with a fixed tick step.

axisticker-fixed.png

This QCPAxisTicker subclass generates ticks with a fixed tick step set with setTickStep. It is also possible to allow integer multiples and integer powers of the specified tick step with setScaleStrategy.

A typical application of this ticker is to make an axis only display integers, by setting the tick step of the ticker to 1.0 and the scale strategy to ssMultiples.

Another case is when a certain number has a special meaning and axis ticks should only appear at multiples of that value. In this case you might also want to consider QCPAxisTickerPi because despite the name it is not limited to only pi symbols/values.

The ticker can be created and assigned to an axis like this:

Definition at line 1665 of file qcustomplot.h.

Member Enumeration Documentation

enum QCPAxisTickerFixed::ScaleStrategy

Defines how the axis ticker may modify the specified tick step (setTickStep) in order to control the number of ticks in the axis range.

See also
setScaleStrategy
Enumerator
ssNone 

Modifications are not allowed, the specified tick step is absolutely fixed. This might cause a high tick density and overlapping labels if the axis range is zoomed out.

ssMultiples 

An integer multiple of the specified tick step is allowed. The used factor follows the base class properties of setTickStepStrategy and setTickCount.

ssPowers 

An integer power of the specified tick step is allowed.

Definition at line 1675 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPAxisTickerFixed::QCPAxisTickerFixed ( )

Constructs the ticker and sets reasonable default values. Axis tickers are commonly created managed by a QSharedPointer, which then can be passed to QCPAxis::setTicker.

Definition at line 6305 of file qcustomplot.cpp.

Member Function Documentation

double QCPAxisTickerFixed::getTickStep ( const QCPRange &  range)
protectedvirtual

Reimplemented from QCPAxisTicker.

Definition at line 6350 of file qcustomplot.cpp.

ScaleStrategy QCPAxisTickerFixed::scaleStrategy ( ) const
inline

Definition at line 1685 of file qcustomplot.h.

void QCPAxisTickerFixed::setScaleStrategy ( QCPAxisTickerFixed::ScaleStrategy  strategy)

Sets whether the specified tick step (setTickStep) is absolutely fixed or whether modifications may be applied to it before calculating the finally used tick step, such as permitting multiples or powers. See ScaleStrategy for details.

The default strategy is ssNone, which means the tick step is absolutely fixed.

Definition at line 6335 of file qcustomplot.cpp.

void QCPAxisTickerFixed::setTickStep ( double  step)

Sets the fixed tick interval to step.

The axis ticker will only use this tick step when generating axis ticks. This might cause a very high tick density and overlapping labels if the axis range is zoomed out. Using setScaleStrategy it is possible to relax the fixed step and also allow multiples or powers of step. This will enable the ticker to reduce the number of ticks to a reasonable amount (see setTickCount).

Definition at line 6320 of file qcustomplot.cpp.

double QCPAxisTickerFixed::tickStep ( ) const
inline

Definition at line 1684 of file qcustomplot.h.

Member Data Documentation

ScaleStrategy QCPAxisTickerFixed::mScaleStrategy
protected

Definition at line 1694 of file qcustomplot.h.

double QCPAxisTickerFixed::mTickStep
protected

Definition at line 1693 of file qcustomplot.h.

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