MeshProfilePlotOptions Class Reference

#include <meshprofileplotoptions.h>

Inheritance diagram for MeshProfilePlotOptions:

Collaboration diagram for MeshProfilePlotOptions:

Public Types
enum	LegendPosition {   TopRight = 0 ,   TopLeft = 1 ,   BottomLeft = 2 ,   BottomRight = 3 }
enum	LabelFormatMode {   Decimals = 0 ,   SignificantFigures = 1 }
	Axis label number mode; values mirror openswmmvis::plot::NumberFormatMode (0=Decimals, 1=SignificantFigures). More...
enum	AxisNumberFormat {   Integer = 0 ,   Decimals1 = 1 ,   Decimals2 = 2 ,   Decimals3 = 3 ,   Decimals4 = 4 ,   Decimals6 = 5 ,   SigFigs3 = 6 ,   SigFigs4 = 7 ,   SigFigs6 = 8 }
enum	TimeLabelPosition {   TimeTopRight = 0 ,   TimeTopLeft = 1 ,   TimeBottomLeft = 2 ,   TimeBottomRight = 3 }

Public Slots
void	setShowDepthFill (bool v)
void	setShowWseLine (bool v)
void	setShowMaxEnvelopeFill (bool v)
void	setShowMaxEnvelopeLine (bool v)
void	setShowCellBoundaries (bool v)
void	setCellBoundaryColor (const QColor &c)
void	setSoilFill (const QBrush &b)
void	setGroundLinePen (const QPen &p)
void	setDepthFillBrush (const QBrush &b)
void	setWseLinePen (const QPen &p)
void	setMaxEnvelopePen (const QPen &p)
void	setMaxEnvelopeBrush (const QBrush &b)
void	setXAxisNumberFormat (AxisNumberFormat f)
void	setYAxisNumberFormat (AxisNumberFormat f)
void	setXLabelFormatMode (LabelFormatMode m)
void	setXLabelPrecision (int count)
void	setXLabelFormat (const QString &spec)
void	setYLabelFormatMode (LabelFormatMode m)
void	setYLabelPrecision (int count)
void	setYLabelFormat (const QString &spec)
void	setLegendVisible (bool v)
void	setLegendPosition (LegendPosition p)
void	setLegendFont (const QFont &f)
void	setLegendOpacity (double a)
void	setLegendOffset (const QPointF &p)
void	setShowTimeLabel (bool v)
void	setTimeLabelPosition (TimeLabelPosition p)
void	setTimeLabelColor (const QColor &c)
void	setTimeLabelFont (const QFont &f)
void	setTimeLabelFormat (const QString &fmt)
void	setTimeLabelOffset (const QPointF &p)

Signals
void	changed ()

Public Member Functions
	MeshProfilePlotOptions (QObject *parent=nullptr)
Q_INVOKABLE QString	displayLabelFor (const QString &propertyName) const
	Human-readable label for the QPropertyModel row header.
bool	showDepthFill () const
bool	showWseLine () const
bool	showMaxEnvelopeFill () const
bool	showMaxEnvelopeLine () const
bool	showCellBoundaries () const
QColor	cellBoundaryColor () const
QBrush	soilFill () const
QPen	groundLinePen () const
QBrush	depthFillBrush () const
QPen	wseLinePen () const
QPen	maxEnvelopePen () const
QBrush	maxEnvelopeBrush () const
AxisNumberFormat	xAxisNumberFormat () const
AxisNumberFormat	yAxisNumberFormat () const
LabelFormatMode	xLabelFormatMode () const
int	xLabelPrecision () const
QString	xLabelFormat () const
LabelFormatMode	yLabelFormatMode () const
int	yLabelPrecision () const
QString	yLabelFormat () const
openswmmvis::plot::NumberFormat	xFormat () const
	Current X/Y axis label format as the shared value type.
openswmmvis::plot::NumberFormat	yFormat () const
bool	legendVisible () const
LegendPosition	legendPosition () const
QFont	legendFont () const
double	legendOpacity () const
QPointF	legendOffset () const
bool	showTimeLabel () const
TimeLabelPosition	timeLabelPosition () const
QColor	timeLabelColor () const
QFont	timeLabelFont () const
QString	timeLabelFormat () const
QPointF	timeLabelOffset () const

Properties
bool	showDepthFill
bool	showWseLine
bool	showMaxEnvelopeFill
bool	showMaxEnvelopeLine
bool	showCellBoundaries
QBrush	soilFill
QPen	groundLinePen
QBrush	depthFillBrush
QPen	wseLinePen
QPen	maxEnvelopePen
QBrush	maxEnvelopeBrush
QColor	cellBoundaryColor
MeshProfilePlotOptions::AxisNumberFormat	xAxisNumberFormat
QString	xLabelFormat
MeshProfilePlotOptions::AxisNumberFormat	yAxisNumberFormat
QString	yLabelFormat
bool	legendVisible
MeshProfilePlotOptions::LegendPosition	legendPosition
QFont	legendFont
double	legendOpacity
QPointF	legendOffset
bool	showTimeLabel
MeshProfilePlotOptions::TimeLabelPosition	timeLabelPosition
QColor	timeLabelColor
QFont	timeLabelFont
QString	timeLabelFormat
QPointF	timeLabelOffset

Member Enumeration Documentation

AxisNumberFormat

enum MeshProfilePlotOptions::AxisNumberFormat

Combined number format offered as ONE dropdown, replacing a mode enum plus a free integer count. Mirrors openswmmvis::plot:: AxisNumberFormatPreset value-for-value; QPropertyModel needs the enumerator list on the declaring class and labels each row with the enumerator name. numberformat.h owns the mapping to mode + digits.

Enumerator
Integer
Decimals1
Decimals2
Decimals3
Decimals4
Decimals6
SigFigs3
SigFigs4
SigFigs6

LabelFormatMode

enum MeshProfilePlotOptions::LabelFormatMode

Axis label number mode; values mirror openswmmvis::plot::NumberFormatMode (0=Decimals, 1=SignificantFigures).

Enumerator
Decimals
SignificantFigures

LegendPosition

enum MeshProfilePlotOptions::LegendPosition

Enumerator
TopRight
TopLeft
BottomLeft
BottomRight

TimeLabelPosition

enum MeshProfilePlotOptions::TimeLabelPosition

Enumerator
TimeTopRight
TimeTopLeft
TimeBottomLeft
TimeBottomRight

Constructor & Destructor Documentation

MeshProfilePlotOptions()

MeshProfilePlotOptions::MeshProfilePlotOptions ( QObject *  parent = nullptr )

explicit

Here is the call graph for this function:

Member Function Documentation

cellBoundaryColor()

QColor MeshProfilePlotOptions::cellBoundaryColor ( ) const

inline

changed

void MeshProfilePlotOptions::changed ( )

signal

Here is the caller graph for this function:

depthFillBrush()

QBrush MeshProfilePlotOptions::depthFillBrush ( ) const

inline

displayLabelFor()

QString MeshProfilePlotOptions::displayLabelFor

(

const QString &

propertyName

)

const

Human-readable label for the QPropertyModel row header.

groundLinePen()

QPen MeshProfilePlotOptions::groundLinePen ( ) const

inline

legendFont()

QFont MeshProfilePlotOptions::legendFont ( ) const

inline

legendOffset()

QPointF MeshProfilePlotOptions::legendOffset ( ) const

inline

legendOpacity()

double MeshProfilePlotOptions::legendOpacity ( ) const

inline

legendPosition()

LegendPosition MeshProfilePlotOptions::legendPosition ( ) const

inline

legendVisible()

bool MeshProfilePlotOptions::legendVisible ( ) const

inline

maxEnvelopeBrush()

QBrush MeshProfilePlotOptions::maxEnvelopeBrush ( ) const

inline

maxEnvelopePen()

QPen MeshProfilePlotOptions::maxEnvelopePen ( ) const

inline

setCellBoundaryColor

void MeshProfilePlotOptions::setCellBoundaryColor ( const QColor &  c )

slot

setDepthFillBrush

void MeshProfilePlotOptions::setDepthFillBrush ( const QBrush &  b )

slot

setGroundLinePen

void MeshProfilePlotOptions::setGroundLinePen ( const QPen &  p )

slot

setLegendFont

void MeshProfilePlotOptions::setLegendFont ( const QFont &  f )

slot

setLegendOffset

void MeshProfilePlotOptions::setLegendOffset ( const QPointF &  p )

slot

setLegendOpacity

void MeshProfilePlotOptions::setLegendOpacity ( double  a )

slot

setLegendPosition

void MeshProfilePlotOptions::setLegendPosition ( LegendPosition  p )

slot

setLegendVisible

void MeshProfilePlotOptions::setLegendVisible ( bool  v )

slot

setMaxEnvelopeBrush

void MeshProfilePlotOptions::setMaxEnvelopeBrush ( const QBrush &  b )

slot

setMaxEnvelopePen

void MeshProfilePlotOptions::setMaxEnvelopePen ( const QPen &  p )

slot

setShowCellBoundaries

void MeshProfilePlotOptions::setShowCellBoundaries ( bool  v )

slot

Here is the caller graph for this function:

setShowDepthFill

void MeshProfilePlotOptions::setShowDepthFill ( bool  v )

slot

Here is the caller graph for this function:

setShowMaxEnvelopeFill

void MeshProfilePlotOptions::setShowMaxEnvelopeFill ( bool  v )

slot

Here is the caller graph for this function:

setShowMaxEnvelopeLine

void MeshProfilePlotOptions::setShowMaxEnvelopeLine ( bool  v )

slot

Here is the caller graph for this function:

setShowTimeLabel

void MeshProfilePlotOptions::setShowTimeLabel ( bool  v )

slot

setShowWseLine

void MeshProfilePlotOptions::setShowWseLine ( bool  v )

slot

Here is the caller graph for this function:

setSoilFill

void MeshProfilePlotOptions::setSoilFill ( const QBrush &  b )

slot

setTimeLabelColor

void MeshProfilePlotOptions::setTimeLabelColor ( const QColor &  c )

slot

setTimeLabelFont

void MeshProfilePlotOptions::setTimeLabelFont ( const QFont &  f )

slot

setTimeLabelFormat

void MeshProfilePlotOptions::setTimeLabelFormat ( const QString &  fmt )

slot

setTimeLabelOffset

void MeshProfilePlotOptions::setTimeLabelOffset ( const QPointF &  p )

slot

setTimeLabelPosition

void MeshProfilePlotOptions::setTimeLabelPosition ( TimeLabelPosition  p )

slot

setWseLinePen

void MeshProfilePlotOptions::setWseLinePen ( const QPen &  p )

slot

setXAxisNumberFormat

void MeshProfilePlotOptions::setXAxisNumberFormat ( AxisNumberFormat  f )

slot

Here is the call graph for this function:

setXLabelFormat

void MeshProfilePlotOptions::setXLabelFormat ( const QString &  spec )

slot

setXLabelFormatMode

void MeshProfilePlotOptions::setXLabelFormatMode ( LabelFormatMode  m )

slot

Here is the caller graph for this function:

setXLabelPrecision

void MeshProfilePlotOptions::setXLabelPrecision ( int  count )

slot

Here is the caller graph for this function:

setYAxisNumberFormat

void MeshProfilePlotOptions::setYAxisNumberFormat ( AxisNumberFormat  f )

slot

Here is the call graph for this function:

setYLabelFormat

void MeshProfilePlotOptions::setYLabelFormat ( const QString &  spec )

slot

setYLabelFormatMode

void MeshProfilePlotOptions::setYLabelFormatMode ( LabelFormatMode  m )

slot

Here is the caller graph for this function:

setYLabelPrecision

void MeshProfilePlotOptions::setYLabelPrecision ( int  count )

slot

Here is the caller graph for this function:

showCellBoundaries()

bool MeshProfilePlotOptions::showCellBoundaries ( ) const

inline

showDepthFill()

bool MeshProfilePlotOptions::showDepthFill ( ) const

inline

showMaxEnvelopeFill()

bool MeshProfilePlotOptions::showMaxEnvelopeFill ( ) const

inline

showMaxEnvelopeLine()

bool MeshProfilePlotOptions::showMaxEnvelopeLine ( ) const

inline

showTimeLabel()

bool MeshProfilePlotOptions::showTimeLabel ( ) const

inline

showWseLine()

bool MeshProfilePlotOptions::showWseLine ( ) const

inline

soilFill()

QBrush MeshProfilePlotOptions::soilFill ( ) const

inline

timeLabelColor()

QColor MeshProfilePlotOptions::timeLabelColor ( ) const

inline

timeLabelFont()

QFont MeshProfilePlotOptions::timeLabelFont ( ) const

inline

timeLabelFormat()

QString MeshProfilePlotOptions::timeLabelFormat ( ) const

inline

timeLabelOffset()

QPointF MeshProfilePlotOptions::timeLabelOffset ( ) const

inline

timeLabelPosition()

TimeLabelPosition MeshProfilePlotOptions::timeLabelPosition ( ) const

inline

wseLinePen()

QPen MeshProfilePlotOptions::wseLinePen ( ) const

inline

xAxisNumberFormat()

MeshProfilePlotOptions::AxisNumberFormat MeshProfilePlotOptions::xAxisNumberFormat

(

)

const

Combined format per axis, derived from the mode + digit count that remain the internal representation.

Here is the call graph for this function:

xFormat()

openswmmvis::plot::NumberFormat MeshProfilePlotOptions::xFormat ( ) const

inline

Current X/Y axis label format as the shared value type.

xLabelFormat()

QString MeshProfilePlotOptions::xLabelFormat ( ) const

inline

xLabelFormatMode()

LabelFormatMode MeshProfilePlotOptions::xLabelFormatMode ( ) const

inline

xLabelPrecision()

int MeshProfilePlotOptions::xLabelPrecision ( ) const

inline

yAxisNumberFormat()

MeshProfilePlotOptions::AxisNumberFormat MeshProfilePlotOptions::yAxisNumberFormat

(

)

const

Here is the call graph for this function:

yFormat()

openswmmvis::plot::NumberFormat MeshProfilePlotOptions::yFormat ( ) const

inline

yLabelFormat()

QString MeshProfilePlotOptions::yLabelFormat ( ) const

inline

yLabelFormatMode()

LabelFormatMode MeshProfilePlotOptions::yLabelFormatMode ( ) const

inline

yLabelPrecision()

int MeshProfilePlotOptions::yLabelPrecision ( ) const

inline

Property Documentation

cellBoundaryColor

QColor MeshProfilePlotOptions::cellBoundaryColor

readwrite

depthFillBrush

QBrush MeshProfilePlotOptions::depthFillBrush

readwrite

groundLinePen

QPen MeshProfilePlotOptions::groundLinePen

readwrite

legendFont

QFont MeshProfilePlotOptions::legendFont

readwrite

legendOffset

QPointF MeshProfilePlotOptions::legendOffset

readwrite

legendOpacity

double MeshProfilePlotOptions::legendOpacity

readwrite

legendPosition

MeshProfilePlotOptions::LegendPosition MeshProfilePlotOptions::legendPosition

readwrite

legendVisible

bool MeshProfilePlotOptions::legendVisible

readwrite

maxEnvelopeBrush

QBrush MeshProfilePlotOptions::maxEnvelopeBrush

readwrite

maxEnvelopePen

QPen MeshProfilePlotOptions::maxEnvelopePen

readwrite

showCellBoundaries

bool MeshProfilePlotOptions::showCellBoundaries

readwrite

showDepthFill

bool MeshProfilePlotOptions::showDepthFill

readwrite

showMaxEnvelopeFill

bool MeshProfilePlotOptions::showMaxEnvelopeFill

readwrite

showMaxEnvelopeLine

bool MeshProfilePlotOptions::showMaxEnvelopeLine

readwrite

showTimeLabel

bool MeshProfilePlotOptions::showTimeLabel

readwrite

showWseLine

bool MeshProfilePlotOptions::showWseLine

readwrite

soilFill

QBrush MeshProfilePlotOptions::soilFill

readwrite

timeLabelColor

QColor MeshProfilePlotOptions::timeLabelColor

readwrite

timeLabelFont

QFont MeshProfilePlotOptions::timeLabelFont

readwrite

timeLabelFormat

QString MeshProfilePlotOptions::timeLabelFormat

readwrite

timeLabelOffset

QPointF MeshProfilePlotOptions::timeLabelOffset

readwrite

timeLabelPosition

MeshProfilePlotOptions::TimeLabelPosition MeshProfilePlotOptions::timeLabelPosition

readwrite

wseLinePen

QPen MeshProfilePlotOptions::wseLinePen

readwrite

xAxisNumberFormat

MeshProfilePlotOptions::AxisNumberFormat MeshProfilePlotOptions::xAxisNumberFormat

readwrite

xLabelFormat

QString MeshProfilePlotOptions::xLabelFormat

readwrite

yAxisNumberFormat

MeshProfilePlotOptions::AxisNumberFormat MeshProfilePlotOptions::yAxisNumberFormat

readwrite

yLabelFormat

QString MeshProfilePlotOptions::yLabelFormat

readwrite

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/include/plot/meshprofileplotoptions.h
• /home/runner/work/openswmm.gui/openswmm.gui/src/plot/meshprofileplotoptions.cpp