Abstract base class providing plot and labeling functionality for functions F:Y->X. More...

#include <mathplot.h>

Inheritance diagram for mpFY:

Public Member Functions
	mpFY (const wxString &name=wxEmptyString, int flags=mpALIGN_TOP)

virtual double	GetX (double y) const =0
	Get function value for argument. More...

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

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 (const wxFont &font)
	Set layer font. More...

void	SetPen (const wxPen &pen)
	Set layer pen. 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 (const wxBrush &brush)
	Set layer brush. More...

Protected Attributes
int	m_flags

wxFont	m_font

wxPen	m_pen

wxBrush	m_brush

wxString	m_name

wxString	m_displayName

bool	m_continuous

bool	m_showName

mpLayerType	m_type

bool	m_visible

Detailed Description

Abstract base class providing plot and labeling functionality for functions F:Y->X.

Override mpFY::GetX to implement a function. Optionally implement a constructor and pass a name (label) and a label alignment to the constructor mpFY::mpFY. If the layer name is empty, no label will be plotted.

Definition at line 507 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpFY()

mpFY::mpFY	(	const wxString &	name = `wxEmptyString`,
		int	flags = `mpALIGN_TOP`
	)

Parameters

name	Label
flags	Label alignment, pass one of mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP.

Definition at line 351 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 299 of file mathplot.h.

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const

inlineinherited

Gets the 'continuity' property of the layer.

See also: SetContinuity

Definition at line 264 of file mathplot.h.

◆ GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const

inlineinherited

Definition at line 241 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const

inlineinherited

Get font set for this layer.

Returns: Font

Definition at line 249 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 287 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.

Definition at line 181 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetMaxY()

virtual double mpLayer::GetMaxY ( ) const

inlinevirtualinherited

Get inclusive top border of bounding box.

Returns: Value

Reimplemented in mpFXYVector.

Definition at line 191 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetMinX()

virtual double mpLayer::GetMinX ( ) const

inlinevirtualinherited

Get inclusive left border of bounding box.

Returns: Value

Reimplemented in mpFXYVector.

Definition at line 176 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetMinY()

virtual double mpLayer::GetMinY ( ) const

inlinevirtualinherited

Get inclusive bottom border of bounding box.

Returns: Value

Reimplemented in mpFXYVector.

Definition at line 186 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetName()

const wxString & mpLayer::GetName ( ) const

inlineinherited

Get layer name.

Returns: Name

Definition at line 239 of file mathplot.h.

Referenced by SIM_PLOT_TAB::GetLabelX(), SIM_PLOT_TAB::GetLabelY1(), SIM_PLOT_TAB::GetLabelY2(), SIM_PLOT_TAB::GetLabelY3(), SIMULATOR_FRAME_UI::updatePlotCursors(), and SIM_PLOT_TAB::UpdateTraceStyle().

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const

inlineinherited

Get pen set for this layer.

Returns: Pen

Definition at line 254 of file mathplot.h.

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

◆ GetX()

virtual double mpFY::GetX ( double y ) const

pure virtual

Get function value for argument.

Override this function in your implementation.

Parameters

y Argument

Returns: Function value

Referenced by Plot().

◆ 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, and mpScaleY.

Definition at line 162 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 171 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 291 of file mathplot.h.

Referenced by SIM_PLOT_TAB::IsLegendShown(), and mpInfoLegend::Plot().

◆ Plot()

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

overridevirtual

Layer plot handler.

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

Implements mpLayer.

Definition at line 359 of file mathplot.cpp.

References mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpWindow::GetScrX(), mpWindow::GetScrY(), GetX(), m_flags, mpLayer::m_font, mpLayer::m_name, mpLayer::m_pen, mpLayer::m_showName, mpLayer::m_visible, mpALIGN_CENTER, mpALIGN_TOP, mpALIGNMASK, mpWindow::p2y(), and mpWindow::x2p().

◆ SetBrush()

void mpLayer::SetBrush ( const wxBrush & brush )

inlineinherited

Set layer brush.

Parameters

brush brush, will be copied to internal class member

Definition at line 303 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 259 of file mathplot.h.

Referenced by TRACE::TRACE().

◆ SetFont()

void mpLayer::SetFont ( const wxFont & font )

inlineinherited

Set layer font.

Parameters

font	Font, will be copied to internal class member

Definition at line 278 of file mathplot.h.

Referenced by SIM_PLOT_TAB::updateAxes().

◆ 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 273 of file mathplot.h.

References name.

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

◆ SetPen()

void mpLayer::SetPen ( const wxPen & pen )

inlineinherited

Set layer pen.

Parameters

pen	Pen, will be copied to internal class member

Definition at line 283 of file mathplot.h.

Referenced by SIM_PLOT_TAB::UpdateTraceStyle().

◆ SetVisible()

void mpLayer::SetVisible ( bool show )

inlineinherited

Sets layer visibility.

Parameters

show	visibility bool.

Definition at line 295 of file mathplot.h.

Referenced by SIM_PLOT_TAB::ShowLegend(), and SIM_PLOT_TAB::SIM_PLOT_TAB().

◆ 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 268 of file mathplot.h.

Referenced by TRACE::TRACE().

Member Data Documentation

◆ m_brush

wxBrush mpLayer::m_brush

protectedinherited

Definition at line 309 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous

protectedinherited

Definition at line 312 of file mathplot.h.

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

◆ m_displayName

wxString mpLayer::m_displayName

protectedinherited

Definition at line 311 of file mathplot.h.

Referenced by TRACE::SetName().

◆ m_flags

int mpFY::m_flags

protected

Definition at line 529 of file mathplot.h.

Referenced by Plot().

◆ m_font

wxFont mpLayer::m_font

protectedinherited

Definition at line 307 of file mathplot.h.

Referenced by mpInfoLegend::Plot(), mpFX::Plot(), Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

◆ m_name

wxString mpLayer::m_name

protectedinherited

Definition at line 310 of file mathplot.h.

Referenced by mpFX::Plot(), Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

◆ m_pen

wxPen mpLayer::m_pen

protectedinherited

Definition at line 308 of file mathplot.h.

Referenced by mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

◆ m_showName

bool mpLayer::m_showName

protectedinherited

Definition at line 313 of file mathplot.h.

Referenced by mpFX::Plot(), Plot(), and mpFXY::Plot().

◆ m_type

mpLayerType mpLayer::m_type

protectedinherited

Definition at line 314 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_visible

bool mpLayer::m_visible

protectedinherited

Definition at line 315 of file mathplot.h.

Referenced by CURSOR::Plot(), mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mpFY()

Member Function Documentation

◆ GetBrush()

◆ GetContinuity()

◆ GetDisplayName()

◆ GetFont()

◆ GetLayerType()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetPen()

◆ GetX()

◆ HasBBox()

◆ IsInfo()

◆ IsVisible()

◆ Plot()

◆ SetBrush()

◆ SetContinuity()

◆ SetFont()

◆ SetName()

◆ SetPen()

◆ SetVisible()

◆ ShowName()

Member Data Documentation

◆ m_brush

◆ m_continuous

◆ m_displayName

◆ m_flags

◆ m_font

◆ m_name

◆ m_pen

◆ m_showName

◆ m_type

◆ m_visible