Specialized axis ticker to display ticks in units of an arbitrary constant, for example pi. More...

#include <qcustomplot.h>

Inheritance diagram for QCPAxisTickerPi:

Public Types
enum	FractionStyle { fsFloatingPoint, fsAsciiFractions, fsUnicodeFractions }

Public Types inherited from QCPAxisTicker
enum	TickStepStrategy { tssReadability, tssMeetTickCount }

Public Member Functions
FractionStyle	fractionStyle () const

bool	periodicity () const

QString	piSymbol () const

double	piValue () const

	QCPAxisTickerPi ()

void	setFractionStyle (FractionStyle style)

void	setPeriodicity (int multiplesOfPi)

void	setPiSymbol (QString symbol)

void	setPiValue (double pi)

Public Member Functions inherited from QCPAxisTicker
virtual void	generate (const QCPRange &range, const QLocale &locale, QChar formatChar, int precision, QVector< double > &ticks, QVector< double > subTicks, QVector< QString > tickLabels)

	QCPAxisTicker ()

void	setTickCount (int count)

void	setTickOrigin (double origin)

void	setTickStepStrategy (TickStepStrategy strategy)

int	tickCount () const

double	tickOrigin () const

TickStepStrategy	tickStepStrategy () const

virtual	~QCPAxisTicker ()

Protected Member Functions
QString	fractionToString (int numerator, int denominator) const

virtual int	getSubTickCount (double tickStep) Q_DECL_OVERRIDE

virtual QString	getTickLabel (double tick, const QLocale &locale, QChar formatChar, int precision) Q_DECL_OVERRIDE

virtual double	getTickStep (const QCPRange &range) Q_DECL_OVERRIDE

void	simplifyFraction (int &numerator, int &denominator) const

QString	unicodeFraction (int numerator, int denominator) const

QString	unicodeSubscript (int number) const

QString	unicodeSuperscript (int number) const

Protected Member Functions inherited from QCPAxisTicker
double	cleanMantissa (double input) const

virtual QVector< QString >	createLabelVector (const QVector< double > &ticks, const QLocale &locale, QChar formatChar, int precision)

virtual QVector< double >	createSubTickVector (int subTickCount, const QVector< double > &ticks)

virtual QVector< double >	createTickVector (double tickStep, const QCPRange &range)

double	getMantissa (double input, double *magnitude=0) const

double	pickClosest (double target, const QVector< double > &candidates) const

void	trimTicks (const QCPRange &range, QVector< double > &ticks, bool keepOneOutlier) const

Protected Attributes
FractionStyle	mFractionStyle

int	mPeriodicity

QString	mPiSymbol

double	mPiTickStep

double	mPiValue

Protected Attributes inherited from QCPAxisTicker
int	mTickCount

double	mTickOrigin

TickStepStrategy	mTickStepStrategy

Detailed Description

Specialized axis ticker to display ticks in units of an arbitrary constant, for example pi.

This QCPAxisTicker subclass generates ticks that are expressed with respect to a given symbolic constant with a numerical value specified with setPiValue and an appearance in the tick labels specified with setPiSymbol.

Ticks may be generated at fractions of the symbolic constant. How these fractions appear in the tick label can be configured with setFractionStyle.

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

Definition at line 1776 of file qcustomplot.h.

Member Enumeration Documentation

◆ FractionStyle

enum QCPAxisTickerPi::FractionStyle

Defines how fractions should be displayed in tick labels.

See also: setFractionStyle

Enumerator
fsFloatingPoint	Fractions are displayed as regular decimal floating point numbers, e.g. "0.25" or "0.125".
fsAsciiFractions	Fractions are written as rationals using ASCII characters only, e.g. "1/4" or "1/8".
fsUnicodeFractions	Fractions are written using sub- and superscript UTF-8 digits and the fraction symbol.

Definition at line 1785 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPAxisTickerPi()

QCPAxisTickerPi::QCPAxisTickerPi ( )

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 6740 of file qcustomplot.cpp.

Member Function Documentation

◆ fractionStyle()

FractionStyle QCPAxisTickerPi::fractionStyle ( ) const

inline

Definition at line 1797 of file qcustomplot.h.

◆ fractionToString()

QString QCPAxisTickerPi::fractionToString	(	int	numerator,
		int	denominator
	)		const

protected

Definition at line 6893 of file qcustomplot.cpp.

◆ getSubTickCount()

int QCPAxisTickerPi::getSubTickCount ( double tickStep )

protectedvirtual

Reimplemented from QCPAxisTicker.

Definition at line 6818 of file qcustomplot.cpp.

◆ getTickLabel()

QString QCPAxisTickerPi::getTickLabel	(	double	tick,
		const QLocale &	locale,
		QChar	formatChar,
		int	precision
	)

protectedvirtual

Reimplemented from QCPAxisTicker.

Definition at line 6831 of file qcustomplot.cpp.

◆ getTickStep()

double QCPAxisTickerPi::getTickStep ( const QCPRange & range )

protectedvirtual

Reimplemented from QCPAxisTicker.

Definition at line 6803 of file qcustomplot.cpp.

◆ periodicity()

bool QCPAxisTickerPi::periodicity ( ) const

inline

Definition at line 1796 of file qcustomplot.h.

◆ piSymbol()

QString QCPAxisTickerPi::piSymbol ( ) const

inline

Definition at line 1794 of file qcustomplot.h.

◆ piValue()

double QCPAxisTickerPi::piValue ( ) const

inline

Definition at line 1795 of file qcustomplot.h.

◆ setFractionStyle()

void QCPAxisTickerPi::setFractionStyle ( QCPAxisTickerPi::FractionStyle style )

Sets how the numerical/fractional part preceding the symbolic constant is displayed in tick labels. See FractionStyle for the various options.

Definition at line 6790 of file qcustomplot.cpp.

◆ setPeriodicity()

void QCPAxisTickerPi::setPeriodicity ( int multiplesOfPi )

Sets whether the axis labels shall appear periodicly and if so, at which multiplicity of the symbolic constant.

To disable periodicity, set multiplesOfPi to zero.

For example, an axis that identifies 0 with 2pi would set multiplesOfPi to two.

Definition at line 6781 of file qcustomplot.cpp.

◆ setPiSymbol()

void QCPAxisTickerPi::setPiSymbol ( QString symbol )

Sets how the symbol part (which is always a suffix to the number) shall appear in the axis tick label.

If a space shall appear between the number and the symbol, make sure the space is contained in symbol.

Definition at line 6757 of file qcustomplot.cpp.

◆ setPiValue()

void QCPAxisTickerPi::setPiValue ( double pi )

Sets the numerical value that the symbolic constant has.

This will be used to place the appropriate fractions of the symbol at the respective axis coordinates.

Definition at line 6768 of file qcustomplot.cpp.

◆ simplifyFraction()

void QCPAxisTickerPi::simplifyFraction	(	int &	numerator,
		int &	denominator
	)		const

protected

Definition at line 6866 of file qcustomplot.cpp.

◆ unicodeFraction()

QString QCPAxisTickerPi::unicodeFraction	(	int	numerator,
		int	denominator
	)		const

protected

Definition at line 6949 of file qcustomplot.cpp.

◆ unicodeSubscript()

QString QCPAxisTickerPi::unicodeSubscript ( int number ) const

protected

Definition at line 6985 of file qcustomplot.cpp.

◆ unicodeSuperscript()

QString QCPAxisTickerPi::unicodeSuperscript ( int number ) const

protected

Definition at line 6959 of file qcustomplot.cpp.

Member Data Documentation

◆ mFractionStyle

FractionStyle QCPAxisTickerPi::mFractionStyle

protected

Definition at line 1810 of file qcustomplot.h.

◆ mPeriodicity

int QCPAxisTickerPi::mPeriodicity

protected

Definition at line 1809 of file qcustomplot.h.

◆ mPiSymbol

QString QCPAxisTickerPi::mPiSymbol

protected

Definition at line 1807 of file qcustomplot.h.

◆ mPiTickStep

double QCPAxisTickerPi::mPiTickStep

protected

Definition at line 1813 of file qcustomplot.h.

◆ mPiValue

double QCPAxisTickerPi::mPiValue

protected

Definition at line 1808 of file qcustomplot.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ FractionStyle

Constructor & Destructor Documentation

◆ QCPAxisTickerPi()

Member Function Documentation

◆ fractionStyle()

◆ fractionToString()

◆ getSubTickCount()

◆ getTickLabel()

◆ getTickStep()

◆ periodicity()

◆ piSymbol()

◆ piValue()

◆ setFractionStyle()

◆ setPeriodicity()

◆ setPiSymbol()

◆ setPiValue()

◆ simplifyFraction()

◆ unicodeFraction()

◆ unicodeSubscript()

◆ unicodeSuperscript()

Member Data Documentation

◆ mFractionStyle

◆ mPeriodicity

◆ mPiSymbol

◆ mPiTickStep

◆ mPiValue