Public Types | Public Member Functions | Private Attributes | List of all members
QwtScaleDiv Class Reference

A class representing a scale division. More...

#include <qwt_scale_div.h>

Public Types

enum  TickType {
  NoTick = -1, MinorTick, MediumTick, MajorTick,
  NTickTypes
}
 Scale tick types. More...
 

Public Member Functions

QwtScaleDiv bounded (double lowerBound, double upperBound) const
 
bool contains (double value) const
 
QwtInterval interval () const
 
void invert ()
 
QwtScaleDiv inverted () const
 
bool isEmpty () const
 Check if the scale division is empty( lowerBound() == upperBound() ) More...
 
bool isIncreasing () const
 Check if the scale division is increasing( lowerBound() <= upperBound() ) More...
 
double lowerBound () const
 
bool operator!= (const QwtScaleDiv &) const
 Inequality. More...
 
bool operator== (const QwtScaleDiv &) const
 Equality operator. More...
 
 QwtScaleDiv (const QwtInterval &, QList< double >[NTickTypes])
 
 QwtScaleDiv (double lowerBound, double upperBound, const QList< double > &minorTicks, const QList< double > &mediumTicks, const QList< double > &majorTicks)
 
 QwtScaleDiv (double lowerBound, double upperBound, QList< double >[NTickTypes])
 
 QwtScaleDiv (double lowerBound=0.0, double upperBound=0.0)
 
double range () const
 
void setInterval (const QwtInterval &)
 
void setInterval (double lowerBound, double upperBound)
 
void setLowerBound (double)
 
void setTicks (int tickType, const QList< double > &)
 
void setUpperBound (double)
 
QList< double > ticks (int tickType) const
 
double upperBound () const
 

Private Attributes

double m_lowerBound
 
QList< double > m_ticks [NTickTypes]
 
double m_upperBound
 

Detailed Description

A class representing a scale division.

A Qwt scale is defined by its boundaries and 3 list for the positions of the major, medium and minor ticks.

The upperBound() might be smaller than the lowerBound() to indicate inverted scales.

Scale divisions can be calculated from a QwtScaleEngine.

See also
QwtScaleEngine::divideScale(), QwtPlot::setAxisScaleDiv(), QwtAbstractSlider::setScaleDiv()

Definition at line 33 of file qwt_scale_div.h.

Member Enumeration Documentation

◆ TickType

Scale tick types.

Enumerator
NoTick 

No ticks.

MinorTick 

Minor ticks.

MediumTick 

Medium ticks.

MajorTick 

Major ticks.

NTickTypes 

Number of valid tick types.

Definition at line 37 of file qwt_scale_div.h.

Constructor & Destructor Documentation

◆ QwtScaleDiv() [1/4]

QwtScaleDiv::QwtScaleDiv ( double  lowerBound = 0.0,
double  upperBound = 0.0 
)
explicit

Construct a division without ticks

Parameters
lowerBoundFirst boundary
upperBoundSecond boundary
Note
lowerBound might be greater than upperBound for inverted scales

Definition at line 21 of file qwt_scale_div.cpp.

◆ QwtScaleDiv() [2/4]

QwtScaleDiv::QwtScaleDiv ( const QwtInterval interval,
QList< double >  ticks[NTickTypes] 
)
explicit

Construct a scale division

Parameters
intervalInterval
ticksList of major, medium and minor ticks

Definition at line 33 of file qwt_scale_div.cpp.

◆ QwtScaleDiv() [3/4]

QwtScaleDiv::QwtScaleDiv ( double  lowerBound,
double  upperBound,
QList< double >  ticks[NTickTypes] 
)
explicit

Construct a scale division

Parameters
lowerBoundFirst boundary
upperBoundSecond boundary
ticksList of major, medium and minor ticks
Note
lowerBound might be greater than upperBound for inverted scales

Definition at line 51 of file qwt_scale_div.cpp.

◆ QwtScaleDiv() [4/4]

QwtScaleDiv::QwtScaleDiv ( double  lowerBound,
double  upperBound,
const QList< double > &  minorTicks,
const QList< double > &  mediumTicks,
const QList< double > &  majorTicks 
)
explicit

Construct a scale division

Parameters
lowerBoundFirst boundary
upperBoundSecond boundary
minorTicksList of minor ticks
mediumTicksList medium ticks
majorTicksList of major ticks
Note
lowerBound might be greater than upperBound for inverted scales

Definition at line 71 of file qwt_scale_div.cpp.

Member Function Documentation

◆ bounded()

QwtScaleDiv QwtScaleDiv::bounded ( double  lowerBound,
double  upperBound 
) const

Return a scale division with an interval [lowerBound, upperBound] where all ticks outside this interval are removed

Parameters
lowerBoundLower bound
upperBoundUpper bound
Returns
Scale division with all ticks inside of the given interval
Note
lowerBound might be greater than upperBound for inverted scales

Definition at line 263 of file qwt_scale_div.cpp.

◆ contains()

bool QwtScaleDiv::contains ( double  value) const

Return if a value is between lowerBound() and upperBound()

Parameters
valueValue
Returns
true/false

Definition at line 212 of file qwt_scale_div.cpp.

◆ interval()

QwtInterval QwtScaleDiv::interval ( ) const
Returns
lowerBound -> upperBound

Definition at line 111 of file qwt_scale_div.cpp.

◆ invert()

void QwtScaleDiv::invert ( )

Invert the scale division

See also
inverted()

Definition at line 224 of file qwt_scale_div.cpp.

◆ inverted()

QwtScaleDiv QwtScaleDiv::inverted ( ) const
Returns
A scale division with inverted boundaries and ticks
See also
invert()

Definition at line 244 of file qwt_scale_div.cpp.

◆ isEmpty()

bool QwtScaleDiv::isEmpty ( ) const

Check if the scale division is empty( lowerBound() == upperBound() )

Definition at line 195 of file qwt_scale_div.cpp.

◆ isIncreasing()

bool QwtScaleDiv::isIncreasing ( ) const

Check if the scale division is increasing( lowerBound() <= upperBound() )

Definition at line 201 of file qwt_scale_div.cpp.

◆ lowerBound()

double QwtScaleDiv::lowerBound ( ) const
Returns
First boundary
See also
upperBound()

Definition at line 131 of file qwt_scale_div.cpp.

◆ operator!=()

bool QwtScaleDiv::operator!= ( const QwtScaleDiv other) const

Inequality.

Returns
true if this instance is not equal to other

Definition at line 189 of file qwt_scale_div.cpp.

◆ operator==()

bool QwtScaleDiv::operator== ( const QwtScaleDiv other) const

Equality operator.

Returns
true if this instance is equal to other

Definition at line 168 of file qwt_scale_div.cpp.

◆ range()

double QwtScaleDiv::range ( ) const
Returns
upperBound() - lowerBound()

Definition at line 159 of file qwt_scale_div.cpp.

◆ setInterval() [1/2]

void QwtScaleDiv::setInterval ( const QwtInterval interval)

Change the interval

Parameters
intervalInterval

Definition at line 102 of file qwt_scale_div.cpp.

◆ setInterval() [2/2]

void QwtScaleDiv::setInterval ( double  lowerBound,
double  upperBound 
)

Change the interval

Parameters
lowerBoundFirst boundary
upperBoundSecond boundary
Note
lowerBound might be greater than upperBound for inverted scales

Definition at line 91 of file qwt_scale_div.cpp.

◆ setLowerBound()

void QwtScaleDiv::setLowerBound ( double  lowerBound)

Set the first boundary

Parameters
lowerBoundFirst boundary
See also
lowerBound(), setUpperBound()

Definition at line 122 of file qwt_scale_div.cpp.

◆ setTicks()

void QwtScaleDiv::setTicks ( int  tickType,
const QList< double > &  ticks 
)

Assign ticks

Parameters
tickTypeMinorTick, MediumTick or MajorTick
ticksValues of the tick positions

Definition at line 297 of file qwt_scale_div.cpp.

◆ setUpperBound()

void QwtScaleDiv::setUpperBound ( double  upperBound)

Set the second boundary

Parameters
upperBoundSecond boundary
See also
upperBound(), setLowerBound()

Definition at line 142 of file qwt_scale_div.cpp.

◆ ticks()

QList< double > QwtScaleDiv::ticks ( int  tickType) const

Return a list of ticks

Parameters
tickTypeMinorTick, MediumTick or MajorTick
Returns
Tick list

Definition at line 309 of file qwt_scale_div.cpp.

◆ upperBound()

double QwtScaleDiv::upperBound ( ) const
Returns
upper bound
See also
lowerBound()

Definition at line 151 of file qwt_scale_div.cpp.

Member Data Documentation

◆ m_lowerBound

double QwtScaleDiv::m_lowerBound
private

Definition at line 96 of file qwt_scale_div.h.

◆ m_ticks

QList< double > QwtScaleDiv::m_ticks[NTickTypes]
private

Definition at line 98 of file qwt_scale_div.h.

◆ m_upperBound

double QwtScaleDiv::m_upperBound
private

Definition at line 97 of file qwt_scale_div.h.


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


plotjuggler
Author(s): Davide Faconti
autogenerated on Mon Nov 11 2024 03:23:51