Proportional class. Do the most work in all 2D plot figures. More...

#include <proportional.hpp>

Inheritance diagram for Proportional:

Public Member Functions
void	setWxPlotType (const WXPLOT_TYPE wxPlotType)
	Set the plot type selection.

void	setFontSize (const unsigned int fontSize)
	Set the size of the fonts.

void	setTitle (const wxString &title)
	Set the title of the plot.

void	setXlabel (const wxString &xLabel)
	Set the name of the X-label.

void	setYlabel (const wxString &yLabel)
	Set the name of the Y-label.

void	setTicks (const unsigned int ticks)
	Set the number of ticks at the figure in all axis.

void	gridOn (const bool useGrid)
	Enable grid on the figure.

void	setPlotStartWidth (const wxCoord plotStartWidth)
	Set the left upper corner in X-axis. Inside this rectangle, the plot is drawn. NOTE: This value is recalculated since the plot figure is drawn! (plotStartWidth, plotStartHeight) --------------------------------------------— (plotEndWidth, plotStartHeight)

void	setPlotStartHeight (const wxCoord plotStartHeight)
	Set the left upper corner in Y-axis. Inside this rectangle, the plot is drawn. NOTE: This value is recalculated since the plot figure is drawn! (plotStartWidth, plotStartHeight) --------------------------------------------— (plotEndWidth, plotStartHeight)

void	setPlotEndWidth (const wxCoord plotEndWidth)
	Set the right upper corner in X-axis. Inside this rectangle, the plot is drawn. NOTE: This value is recalculated since the plot figure is drawn! (plotStartWidth, plotStartHeight) --------------------------------------------— (plotEndWidth, plotStartHeight)

void	setPlotEndHeight (const wxCoord plotEndHeight)
	Set the right bottom corner in Y-axis. Inside this rectangle, the plot is drawn. NOTE: This value is recalculated since the plot figure is drawn! (plotStartWidth, plotStartHeight) --------------------------------------------— (plotEndWidth, plotStartHeight)

void	setData (const std::vector< std::vector< double > > &data2D)
	Set 2D data.

void	setData (const std::vector< double > &data1D)
	Set 1D data.

void	legendOn (const bool useLegend)
	Activate the legend.

void	setLegend (const std::vector< wxString > &legend, const PLACEMENT legendPosition=PLACEMENT_NORTH_EAST)
	Set the labels and placement for the legend.

void	setYlim (const double minY, const double maxY)
	Set the plot zoom limit in Y-axis.

wxCoord	getPlotStartWidth () const
	Get the recalculated start width X-axis value. This value is recalculated after the figure is drawn.

wxCoord	getPlotEndWidth () const
	Get the recalculated end width X-axis value. This value is recalculated after the figure is drawn.

wxCoord	getPlotStartHeight () const
	Get the recalculated start height Y-axis value. This value is recalculated after the figure is drawn.

wxCoord	getPlotEndHeight () const
	Get the recalculated end height Y-axis value. This value is recalculated after the figure is drawn.

void	drawFigure (wxDC &dc)
	This function will do the following:

void	drawGrid (wxDC &dc)
	This function will draw the grid. Call this function after you have drawn the plot type.

void	drawTicks (wxDC &dc)
	This function will draw the ticks. Call this function after you have drawn the plot type.

void	drawLegend (wxDC &dc)
	This function will draw the legend. Call this function after you have drawn the plot type.

Protected Attributes
wxCoord	plotEndWidth = 0
	Location of right upper corner in X-axis.

wxCoord	plotEndHeight = 0
	Location of right bottom corner in Y-axis.

wxCoord	plotStartWidth = 0
	Location of left upper corner in X-axis.

wxCoord	plotStartHeight = 0
	Location of left upper corner in Y-axis.

double	minX = 0
	Minimum value of data in X-axis.

double	maxX = 0
	Maximum value of data in X-axis.

double	minY = 0
	Minimum value of data in Y-axis.

double	maxY = 0
	Maximum value of data in Y-axis.

unsigned int	fontSize = 0
	The size of the all fonts.

unsigned int	ticks = 0
	The number of ticks at the figure in all axis.

bool	useGrid = false
	Flag for using grid or not.

bool	useLegend = false
	Flag for using legend or not.

wxString	title
	Title of the plot type.

wxString	xLabel
	Label under the plot type.

wxString	yLabel
	Label on the left side of the plot type.

std::vector< wxString >	legend
	Vector of labels for the legend.

PLACEMENT	legendPosition = PLACEMENT_NORTH_WEST
	Location of the legend.

WXPLOT_TYPE	wxPlotType = WXPLOT_TYPE_LINE
	Plot type selection.

Detailed Description

Proportional class. Do the most work in all 2D plot figures.

Member Function Documentation

◆ drawFigure()

void Proportional::drawFigure ( wxDC & dc )

This function will do the following:

Set the fonts
Draw the title
Draw the y-label
Draw the x-label
Draw the rectangle
Update the plotStartHeight, plotEndtHeight, plotStartWidth and plotEndtWidth for correct plotting the plot type
Parameters

dc The wxDC object for drawing lines, polygons etc.

◆ drawGrid()

void Proportional::drawGrid ( wxDC & dc )

This function will draw the grid. Call this function after you have drawn the plot type.

Parameters

dc	The wxDC object for drawing lines, polygons etc.

◆ drawLegend()

void Proportional::drawLegend ( wxDC & dc )

This function will draw the legend. Call this function after you have drawn the plot type.

Parameters

dc	The wxDC object for drawing lines, polygons etc.

◆ drawTicks()

void Proportional::drawTicks ( wxDC & dc )

This function will draw the ticks. Call this function after you have drawn the plot type.

Parameters

dc	The wxDC object for drawing lines, polygons etc.

◆ getPlotEndHeight()

wxCoord Proportional::getPlotEndHeight ( ) const

Get the recalculated end height Y-axis value. This value is recalculated after the figure is drawn.

Returns: wxCoord Recalculated value

◆ getPlotEndWidth()

wxCoord Proportional::getPlotEndWidth ( ) const

Get the recalculated end width X-axis value. This value is recalculated after the figure is drawn.

Returns: wxCoord Recalculated value

◆ getPlotStartHeight()

wxCoord Proportional::getPlotStartHeight ( ) const

Get the recalculated start height Y-axis value. This value is recalculated after the figure is drawn.

Returns: wxCoord Recalculated value

◆ getPlotStartWidth()

wxCoord Proportional::getPlotStartWidth ( ) const

Get the recalculated start width X-axis value. This value is recalculated after the figure is drawn.

Returns: wxCoord Recalculated value

◆ gridOn()

void Proportional::gridOn ( const bool useGrid )

Enable grid on the figure.

Parameters

useGrid Set true for enabling grid.

◆ legendOn()

void Proportional::legendOn ( const bool useLegend )

Activate the legend.

Parameters

useLegend Set true to make a little box with labels appear.

◆ setData() [1/2]

void Proportional::setData ( const std::vector< double > & data1D )

Set 1D data.

Parameters

data1D 1D data in form of 1D vector.

◆ setData() [2/2]

void Proportional::setData ( const std::vector< std::vector< double > > & data2D )

Set 2D data.

Parameters

data2D 2D data in form of 2D vector.

◆ setFontSize()

void Proportional::setFontSize ( const unsigned int fontSize )

Set the size of the fonts.

Parameters

fontSize The size of the fonts.

◆ setLegend()

void Proportional::setLegend	(	const std::vector< wxString > &	legend,
		const PLACEMENT	legendPosition = PLACEMENT_NORTH_EAST )

Set the labels and placement for the legend.

Parameters

legend	Vector of strings for the legend.
legendPosition	Position where the legend should be placed.

◆ setPlotEndHeight()

void Proportional::setPlotEndHeight ( const wxCoord plotEndHeight )

Set the right bottom corner in Y-axis. Inside this rectangle, the plot is drawn. NOTE: This value is recalculated since the plot figure is drawn! (plotStartWidth, plotStartHeight) --------------------------------------------— (plotEndWidth, plotStartHeight)

(plotStartWidth, plotEndHeight) --------------------------------------------— (plotEndWidth, plotEndHeight)

Parameters

plotEndHeight End height is at the end of Y-axis.

◆ setPlotEndWidth()

void Proportional::setPlotEndWidth ( const wxCoord plotEndWidth )

Set the right upper corner in X-axis. Inside this rectangle, the plot is drawn. NOTE: This value is recalculated since the plot figure is drawn! (plotStartWidth, plotStartHeight) --------------------------------------------— (plotEndWidth, plotStartHeight)

(plotStartWidth, plotEndHeight) --------------------------------------------— (plotEndWidth, plotEndHeight)

Parameters

plotEndWidth End width is at the end of X-axis.

◆ setPlotStartHeight()

void Proportional::setPlotStartHeight ( const wxCoord plotStartHeight )

Set the left upper corner in Y-axis. Inside this rectangle, the plot is drawn. NOTE: This value is recalculated since the plot figure is drawn! (plotStartWidth, plotStartHeight) --------------------------------------------— (plotEndWidth, plotStartHeight)

(plotStartWidth, plotEndHeight) --------------------------------------------— (plotEndWidth, plotEndHeight)

Parameters

plotStartHeight Start height is at the start of Y-axis.

◆ setPlotStartWidth()

void Proportional::setPlotStartWidth ( const wxCoord plotStartWidth )

Set the left upper corner in X-axis. Inside this rectangle, the plot is drawn. NOTE: This value is recalculated since the plot figure is drawn! (plotStartWidth, plotStartHeight) --------------------------------------------— (plotEndWidth, plotStartHeight)

(plotStartWidth, plotEndHeight) --------------------------------------------— (plotEndWidth, plotEndHeight)

Parameters

plotStartWidth Start width is at the start of X-axis.

◆ setTicks()

void Proportional::setTicks ( const unsigned int ticks )

Set the number of ticks at the figure in all axis.

Parameters

ticks Number of ticks.

◆ setTitle()

void Proportional::setTitle ( const wxString & title )

Set the title of the plot.

Parameters

title Name of the title.

◆ setWxPlotType()

void Proportional::setWxPlotType ( const WXPLOT_TYPE wxPlotType )

Set the plot type selection.

Parameters

wxPlotType Selection of plot type.

◆ setXlabel()

void Proportional::setXlabel ( const wxString & xLabel )

Set the name of the X-label.

Parameters

xLabel Name of the X-label.

◆ setYlabel()

void Proportional::setYlabel ( const wxString & yLabel )

Set the name of the Y-label.

Parameters

yLabel Name of the Y-label.

◆ setYlim()

void Proportional::setYlim	(	const double	minY,
		const double	maxY )

Set the plot zoom limit in Y-axis.

Parameters

minY	Minimum limit in Y-axis.
maxY	Maximum limit in Y-axis.

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

C:/Users/danie/Documents/GitHub/wxPlot/wxPlot/src/plots/plotfigures/2D/proportional/proportional.hpp
C:/Users/danie/Documents/GitHub/wxPlot/wxPlot/src/plots/plotfigures/2D/proportional/proportional.cpp

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ drawFigure()

◆ drawGrid()

◆ drawLegend()

◆ drawTicks()

◆ getPlotEndHeight()

◆ getPlotEndWidth()

◆ getPlotStartHeight()

◆ getPlotStartWidth()

◆ gridOn()

◆ legendOn()

◆ setData() [1/2]

◆ setData() [2/2]

◆ setFontSize()

◆ setLegend()

◆ setPlotEndHeight()

◆ setPlotEndWidth()

◆ setPlotStartHeight()

◆ setPlotStartWidth()

◆ setTicks()

◆ setTitle()

◆ setWxPlotType()

◆ setXlabel()

◆ setYlabel()

◆ setYlim()