Abstract base class providing plot and labeling functionality for a locus plot F:N->X,Y. More...

#include <mathplot.h>

Inheritance diagram for mpFXY:

Public Member Functions
	mpFXY (const wxString &name=wxEmptyString, int flags=mpALIGN_NE)

virtual void	Rewind ()=0
	Rewind value enumeration with mpFXY::GetNextXY. More...

virtual bool	GetNextXY (double &x, double &y)=0
	Get locus value for next N. More...

virtual size_t	GetCount () const =0

virtual void	Plot (wxDC &dc, mpWindow &w) override
	Layer plot handler. More...

virtual void	SetScale (mpScaleBase scaleX, mpScaleBase scaleY)

void	UpdateScales ()

double	s2x (double plotCoordX) const

double	s2y (double plotCoordY) const

double	x2s (double x) const

double	y2s (double y) const

virtual bool	HasBBox () const
	Check whether this layer has a bounding box. More...

virtual bool	IsInfo () const
	Check whether the layer is an info box. More...

virtual double	GetMinX () const
	Get inclusive left border of bounding box. More...

virtual double	GetMaxX () const
	Get inclusive right border of bounding box. More...

virtual double	GetMinY () const
	Get inclusive bottom border of bounding box. More...

virtual double	GetMaxY () const
	Get inclusive top border of bounding box. More...

const wxString &	GetName () const
	Get layer name. More...

const wxString &	GetDisplayName () const

const wxFont &	GetFont () const
	Get font set for this layer. More...

const wxPen &	GetPen () const
	Get pen set for this layer. More...

void	SetContinuity (bool continuity)
	Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points). More...

bool	GetContinuity () const
	Gets the 'continuity' property of the layer. More...

void	ShowName (bool show)
	Shows or hides the text label with the name of the layer (default is visible). More...

virtual void	SetName (const wxString &name)
	Set layer name. More...

void	SetFont (wxFont &font)
	Set layer font. More...

void	SetPen (wxPen pen)
	Set layer pen. More...

void	SetDrawOutsideMargins (bool drawModeOutside)
	Set Draw mode: inside or outside margins. More...

bool	GetDrawOutsideMargins ()
	Get Draw mode: inside or outside margins. More...

wxBitmap	GetColourSquare (int side=16) const
	Get a small square bitmap filled with the colour of the pen used in the layer. More...

mpLayerType	GetLayerType () const
	Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value. More...

bool	IsVisible () const
	Checks whether the layer is visible or not. More...

void	SetVisible (bool show)
	Sets layer visibility. More...

const wxBrush &	GetBrush () const
	Get brush set for this layer. More...

void	SetBrush (wxBrush brush)
	Set layer brush. More...

Protected Member Functions
void	UpdateViewBoundary (wxCoord xnew, wxCoord ynew)
	Update label positioning data. More...

Protected Attributes
int	m_flags

wxCoord	maxDrawX

wxCoord	minDrawX

wxCoord	maxDrawY

wxCoord	minDrawY

mpScaleBase *	m_scaleX

mpScaleBase *	m_scaleY

wxFont	m_font

wxPen	m_pen

wxBrush	m_brush

wxString	m_name

wxString	m_displayName

bool	m_continuous

bool	m_showName

bool	m_drawOutsideMargins

mpLayerType	m_type

bool	m_visible

Detailed Description

Abstract base class providing plot and labeling functionality for a locus plot F:N->X,Y.

Locus argument N is assumed to be in range 0 .. MAX_N, and implicitly derived by enumerating all locus values. Override mpFXY::Rewind and mpFXY::GetNextXY to implement a locus. Optionally implement a constructor and pass a name (label) and a label alignment to the constructor mpFXY::mpFXY. If the layer name is empty, no label will be plotted.

Definition at line 602 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpFXY()

mpFXY::mpFXY	(	const wxString &	name = `wxEmptyString`,
		int	flags = `mpALIGN_NE`
	)

Parameters

name	Label
flags	Label alignment, pass one of mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE.

Definition at line 546 of file mathplot.cpp.

References mpLAYER_PLOT, and name.

Member Function Documentation

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const

inlineinherited

Get brush set for this layer.

Returns: brush.

Definition at line 315 of file mathplot.h.

◆ GetColourSquare()

wxBitmap mpLayer::GetColourSquare ( int side = 16 ) const

inherited

Get a small square bitmap filled with the colour of the pen used in the layer.

Useful to create legends or similar reference to the layers.

Parameters

side	side length in pixels

Returns: a wxBitmap filled with layer's colour

Definition at line 76 of file mathplot.cpp.

References mpLayer::m_pen, and square().

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const

inlineinherited

Gets the 'continuity' property of the layer.

See also: SetContinuity

Definition at line 267 of file mathplot.h.

◆ GetCount()

virtual size_t mpFXY::GetCount ( ) const

pure virtual

Implemented in mpFXYVector.

Referenced by Plot().

◆ GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const

inlineinherited

Definition at line 244 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

◆ GetDrawOutsideMargins()

bool mpLayer::GetDrawOutsideMargins ( )

inlineinherited

Get Draw mode: inside or outside margins.

Returns: The draw mode

Definition at line 294 of file mathplot.h.

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const

inlineinherited

Get font set for this layer.

Returns: Font

Definition at line 252 of file mathplot.h.

◆ GetLayerType()

mpLayerType mpLayer::GetLayerType ( ) const

inlineinherited

Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value.

Returns: An integer indicating layer type

Definition at line 303 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

◆ GetMaxX()

virtual double mpLayer::GetMaxX ( ) const

inlinevirtualinherited

Get inclusive right border of bounding box.

Returns: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 184 of file mathplot.h.

Referenced by UpdateScales().

◆ GetMaxY()

virtual double mpLayer::GetMaxY ( ) const

inlinevirtualinherited

Get inclusive top border of bounding box.

Returns: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 194 of file mathplot.h.

Referenced by UpdateScales().

◆ GetMinX()

virtual double mpLayer::GetMinX ( ) const

inlinevirtualinherited

Get inclusive left border of bounding box.

Returns: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 179 of file mathplot.h.

Referenced by UpdateScales().

◆ GetMinY()

virtual double mpLayer::GetMinY ( ) const

inlinevirtualinherited

Get inclusive bottom border of bounding box.

Returns: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 189 of file mathplot.h.

Referenced by UpdateScales().

◆ GetName()

const wxString & mpLayer::GetName ( ) const

inlineinherited

Get layer name.

Returns: Name

Definition at line 242 of file mathplot.h.

Referenced by SIM_PLOT_PANEL::GetLabelX(), SIM_PLOT_PANEL::GetLabelY1(), SIM_PLOT_PANEL::GetLabelY2(), SIM_PLOT_PANEL::GetLabelY3(), mpText::Plot(), and SIMULATOR_FRAME::updateCursors().

◆ GetNextXY()

virtual bool mpFXY::GetNextXY	(	double &	x,
		double &	y
	)

pure virtual

Get locus value for next N.

Override this function in your implementation.

Parameters

x	Returns X value
y	Returns Y value

Implemented in mpFXYVector.

Referenced by Plot().

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const

inlineinherited

Get pen set for this layer.

Returns: Pen

Definition at line 257 of file mathplot.h.

Referenced by CURSOR::Plot(), mpInfoLegend::Plot(), and SIMULATOR_FRAME::rebuildSignalsGrid().

◆ HasBBox()

virtual bool mpLayer::HasBBox ( ) const

inlinevirtualinherited

Check whether this layer has a bounding box.

The default implementation returns true. Override and return false if your mpLayer implementation should be ignored by the calculation of the global bounding box for all layers in a mpWindow.

Return values

true	Has bounding box
false	Has not bounding box

Reimplemented in mpInfoLayer, mpScaleBase, mpScaleY, mpText, mpMovableObject, and mpBitmapLayer.

Definition at line 165 of file mathplot.h.

◆ IsInfo()

virtual bool mpLayer::IsInfo ( ) const

inlinevirtualinherited

Check whether the layer is an info box.

The default implementation returns false. It is overridden to true for mpInfoLayer class and its derivative. It is necessary to define mouse actions behaviour over info boxes.

Returns: whether the layer is an info boxes

See also: mpInfoLayer::IsInfo

Reimplemented in mpInfoLayer.

Definition at line 174 of file mathplot.h.

◆ IsVisible()

bool mpLayer::IsVisible ( ) const

inlineinherited

Checks whether the layer is visible or not.

Returns: true if visible

Definition at line 307 of file mathplot.h.

Referenced by mpWindow::IsLayerVisible(), SIM_PLOT_PANEL::IsLegendShown(), and mpInfoLegend::Plot().

◆ Plot()

void mpFXY::Plot	(	wxDC &	dc,
		mpWindow &	w
	)

overridevirtual

Layer plot handler.

This implementation will plot the locus in the visible area and put a label according to the alignment specified.

Implements mpLayer.

Definition at line 570 of file mathplot.cpp.

References GetCount(), mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), GetNextXY(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpLayer::m_continuous, mpLayer::m_drawOutsideMargins, m_flags, mpLayer::m_font, mpLayer::m_name, mpLayer::m_pen, m_scaleX, m_scaleY, mpLayer::m_showName, mpLayer::m_visible, maxDrawX, maxDrawY, minDrawX, minDrawY, mpALIGN_NE, mpALIGN_NW, mpALIGN_SE, mpALIGNMASK, Rewind(), mpScaleBase::TransformToPlot(), UpdateViewBoundary(), mpWindow::x2p(), and mpWindow::y2p().

◆ Rewind()

virtual void mpFXY::Rewind ( )

pure virtual

Rewind value enumeration with mpFXY::GetNextXY.

Override this function in your implementation.

Implemented in mpFXYVector.

Referenced by Plot().

◆ s2x()

double mpFXY::s2x ( double plotCoordX ) const

Definition at line 3608 of file mathplot.cpp.

References m_scaleX, and mpScaleBase::TransformFromPlot().

Referenced by CURSOR::Plot().

◆ s2y()

double mpFXY::s2y ( double plotCoordY ) const

Definition at line 3614 of file mathplot.cpp.

References m_scaleY, and mpScaleBase::TransformFromPlot().

◆ SetBrush()

void mpLayer::SetBrush ( wxBrush brush )

inlineinherited

Set layer brush.

Parameters

brush brush, will be copied to internal class member

Definition at line 319 of file mathplot.h.

◆ SetContinuity()

void mpLayer::SetContinuity ( bool continuity )

inlineinherited

Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).

See also: GetContinuity

Definition at line 262 of file mathplot.h.

Referenced by TRACE::TRACE().

◆ SetDrawOutsideMargins()

void mpLayer::SetDrawOutsideMargins ( bool drawModeOutside )

inlineinherited

Set Draw mode: inside or outside margins.

Default is outside, which allows the layer to draw up to the mpWindow border.

Parameters

drawModeOutside The draw mode to be set

Definition at line 290 of file mathplot.h.

Referenced by CURSOR::CURSOR(), and TRACE::TRACE().

◆ SetFont()

void mpLayer::SetFont ( wxFont & font )

inlineinherited

Set layer font.

Parameters

font	Font, will be copied to internal class member

Definition at line 281 of file mathplot.h.

◆ SetName()

virtual void mpLayer::SetName ( const wxString & name )

inlinevirtualinherited

Set layer name.

Parameters

name	Name, will be copied to internal class member

Reimplemented in TRACE.

Definition at line 276 of file mathplot.h.

References name.

Referenced by SIM_PLOT_PANEL::prepareDCAxes(), TRACE::SetName(), and SIM_PLOT_PANEL::updateAxes().

◆ SetPen()

void mpLayer::SetPen ( wxPen pen )

inlineinherited

Set layer pen.

Parameters

pen	Pen, will be copied to internal class member

Definition at line 286 of file mathplot.h.

Referenced by SIM_PLOT_PANEL::UpdateTraceStyle().

◆ SetScale()

void mpFXY::SetScale	(	mpScaleBase *	scaleX,
		mpScaleBase *	scaleY
	)

virtual

Definition at line 3589 of file mathplot.cpp.

References m_scaleX, m_scaleY, and UpdateScales().

Referenced by SIM_PLOT_PANEL::SetTraceData().

◆ SetVisible()

void mpLayer::SetVisible ( bool show )

inlineinherited

Sets layer visibility.

Parameters

show	visibility bool.

Definition at line 311 of file mathplot.h.

Referenced by mpWindow::SetLayerVisible(), SIM_PLOT_PANEL::ShowLegend(), and SIM_PLOT_PANEL::SIM_PLOT_PANEL().

◆ ShowName()

void mpLayer::ShowName ( bool show )

inlineinherited

Shows or hides the text label with the name of the layer (default is visible).

Definition at line 271 of file mathplot.h.

Referenced by TRACE::TRACE().

◆ UpdateScales()

void mpFXY::UpdateScales ( )

Definition at line 3598 of file mathplot.cpp.

References mpScaleBase::ExtendDataRange(), mpLayer::GetMaxX(), mpLayer::GetMaxY(), mpLayer::GetMinX(), mpLayer::GetMinY(), m_scaleX, and m_scaleY.

Referenced by SetScale().

◆ UpdateViewBoundary()

void mpFXY::UpdateViewBoundary	(	wxCoord	xnew,
		wxCoord	ynew
	)

protected

Update label positioning data.

Parameters

xnew	New x coordinate
ynew	New y coordinate

Definition at line 559 of file mathplot.cpp.

References maxDrawX, maxDrawY, minDrawX, and minDrawY.

Referenced by Plot().

◆ x2s()

double mpFXY::x2s ( double x ) const

Definition at line 3620 of file mathplot.cpp.

References m_scaleX, and mpScaleBase::TransformToPlot().

Referenced by CURSOR::Inside(), CURSOR::Plot(), CURSOR::SetCoordX(), and CURSOR::UpdateReference().

◆ y2s()

double mpFXY::y2s ( double y ) const

Definition at line 3626 of file mathplot.cpp.

References m_scaleY, and mpScaleBase::TransformToPlot().

Referenced by CURSOR::Inside(), CURSOR::Plot(), CURSOR::SetCoordX(), and CURSOR::UpdateReference().

Member Data Documentation

◆ m_brush

wxBrush mpLayer::m_brush

protectedinherited

Definition at line 325 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous

protectedinherited

Definition at line 328 of file mathplot.h.

Referenced by CURSOR::Plot(), Plot(), and mpMovableObject::Plot().

◆ m_displayName

wxString mpLayer::m_displayName

protectedinherited

Definition at line 327 of file mathplot.h.

Referenced by TRACE::SetName().

◆ m_drawOutsideMargins

bool mpLayer::m_drawOutsideMargins

protectedinherited

Definition at line 330 of file mathplot.h.

Referenced by mpScaleXBase::getVisibleDataRange(), mpScaleY::getVisibleDataRange(), CURSOR::Plot(), mpFX::Plot(), mpFY::Plot(), Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

◆ m_flags

int mpFXY::m_flags

protected

Definition at line 641 of file mathplot.h.

Referenced by Plot().

◆ m_font

wxFont mpLayer::m_font

protectedinherited

Definition at line 323 of file mathplot.h.

Referenced by mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ m_name

wxString mpLayer::m_name

protectedinherited

Definition at line 326 of file mathplot.h.

Referenced by mpFX::Plot(), mpFY::Plot(), Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ m_pen

wxPen mpLayer::m_pen

protectedinherited

Definition at line 324 of file mathplot.h.

Referenced by mpLayer::GetColourSquare(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), and mpMovableObject::Plot().

◆ m_scaleX

mpScaleBase* mpFXY::m_scaleX

protected

Definition at line 646 of file mathplot.h.

Referenced by Plot(), s2x(), SetScale(), UpdateScales(), and x2s().

◆ m_scaleY

mpScaleBase * mpFXY::m_scaleY

protected

Definition at line 646 of file mathplot.h.

Referenced by Plot(), s2y(), SetScale(), UpdateScales(), and y2s().

◆ m_showName

bool mpLayer::m_showName

protectedinherited

Definition at line 329 of file mathplot.h.

Referenced by mpFX::Plot(), mpFY::Plot(), Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ m_type

mpLayerType mpLayer::m_type

protectedinherited

Definition at line 331 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_visible

bool mpLayer::m_visible

protectedinherited

Definition at line 332 of file mathplot.h.

Referenced by CURSOR::Plot(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ maxDrawX

wxCoord mpFXY::maxDrawX

protected

Definition at line 644 of file mathplot.h.

Referenced by Plot(), and UpdateViewBoundary().

◆ maxDrawY

wxCoord mpFXY::maxDrawY

protected

Definition at line 644 of file mathplot.h.

Referenced by Plot(), and UpdateViewBoundary().

◆ minDrawX

wxCoord mpFXY::minDrawX

protected

Definition at line 644 of file mathplot.h.

Referenced by Plot(), and UpdateViewBoundary().

◆ minDrawY

wxCoord mpFXY::minDrawY

protected

Definition at line 644 of file mathplot.h.

Referenced by Plot(), and UpdateViewBoundary().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mpFXY()

Member Function Documentation

◆ GetBrush()

◆ GetColourSquare()

◆ GetContinuity()

◆ GetCount()

◆ GetDisplayName()

◆ GetDrawOutsideMargins()

◆ GetFont()

◆ GetLayerType()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetNextXY()

◆ GetPen()

◆ HasBBox()

◆ IsInfo()

◆ IsVisible()

◆ Plot()

◆ Rewind()

◆ s2x()

◆ s2y()

◆ SetBrush()

◆ SetContinuity()

◆ SetDrawOutsideMargins()

◆ SetFont()

◆ SetName()

◆ SetPen()

◆ SetScale()

◆ SetVisible()

◆ ShowName()

◆ UpdateScales()

◆ UpdateViewBoundary()

◆ x2s()

◆ y2s()

Member Data Documentation

◆ m_brush

◆ m_continuous

◆ m_displayName

◆ m_drawOutsideMargins

◆ m_flags

◆ m_font

◆ m_name

◆ m_pen

◆ m_scaleX

◆ m_scaleY

◆ m_showName

◆ m_type

◆ m_visible

◆ maxDrawX

◆ maxDrawY

◆ minDrawX

◆ minDrawY