#include <mathplot.h>

Inheritance diagram for mpLayer:

Public Member Functions
	mpLayer ()

virtual	~mpLayer ()

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

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

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

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

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

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

virtual void	Plot (wxDC &dc, mpWindow &w)=0
	Plot given view of layer to the given device context.

const wxString &	GetName () const
	Get layer name.

const wxString &	GetDisplayName () const

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

const wxFont &	GetPlotFont () const
	Get the font to draw this layer with, which is the default one when none was set.

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

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

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

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

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

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

void	SetPen (const wxPen &pen)
	Set layer pen.

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.

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

void	SetVisible (bool show)
	Sets layer visibility.

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

void	SetBrush (const wxBrush &brush)
	Set layer brush.

Protected Attributes
wxFont	m_font
	Layer's font.

wxPen	m_pen
	Layer's pen.

wxBrush	m_brush
	Layer's brush.

wxString	m_name
	Layer's name.

wxString	m_displayName

bool	m_continuous
	Specify if the layer will be plotted as a continuous line or a set of points.

bool	m_showName
	States whether the name of the layer must be shown (default is true).

mpLayerType	m_type
	Define layer type, which is assigned by constructor.

bool	m_visible
	Toggles layer visibility.

Detailed Description

Definition at line 165 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpLayer()

mpLayer::mpLayer ( )

Definition at line 90 of file mathplot.cpp.

References m_continuous, m_showName, m_type, m_visible, mpLayer(), mpLAYER_UNDEF, and SetPen().

Referenced by mpLayer().

◆ ~mpLayer()

virtual mpLayer::~mpLayer ( )

inlinevirtual

Definition at line 170 of file mathplot.h.

Member Function Documentation

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const

inline

Get brush set for this layer.

Returns: brush.

Definition at line 332 of file mathplot.h.

References m_brush.

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const

inline

Gets the 'continuity' property of the layer.

See also: SetContinuity

Definition at line 297 of file mathplot.h.

References m_continuous.

◆ GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const

inline

Definition at line 258 of file mathplot.h.

References m_displayName, and m_name.

Referenced by mpInfoLegend::Plot().

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const

inline

Get font set for this layer.

Invalid if none was set.

Returns: Font

Definition at line 266 of file mathplot.h.

References m_font.

Referenced by BOOST_AUTO_TEST_CASE().

◆ GetLayerType()

mpLayerType mpLayer::GetLayerType ( ) const

inline

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

References m_type.

Referenced by mpInfoLegend::Plot().

◆ GetMaxX()

virtual double mpLayer::GetMaxX ( ) const

inlinevirtual

Get inclusive right border of bounding box.

Returns: Value

Reimplemented in mpFXYVector.

Definition at line 198 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetMaxY()

virtual double mpLayer::GetMaxY ( ) const

inlinevirtual

Get inclusive top border of bounding box.

Returns: Value

Reimplemented in mpFXYVector.

Definition at line 208 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetMinX()

virtual double mpLayer::GetMinX ( ) const

inlinevirtual

Get inclusive left border of bounding box.

Returns: Value

Reimplemented in mpFXYVector.

Definition at line 193 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetMinY()

virtual double mpLayer::GetMinY ( ) const

inlinevirtual

Get inclusive bottom border of bounding box.

Returns: Value

Reimplemented in mpFXYVector.

Definition at line 203 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetName()

const wxString & mpLayer::GetName ( ) const

inline

Get layer name.

Returns: Name

Definition at line 256 of file mathplot.h.

References m_name.

Referenced by SIMULATOR_FRAME_UI::ToggleSmithChart(), SIMULATOR_FRAME_UI::updatePlotCursors(), and SIM_PLOT_TAB::UpdateTraceStyle().

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const

inline

Get pen set for this layer.

Returns: Pen

Definition at line 287 of file mathplot.h.

References m_pen.

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

◆ GetPlotFont()

const wxFont & mpLayer::GetPlotFont ( ) const

inline

Get the font to draw this layer with, which is the default one when none was set.

The stock fonts are built on first use from the running toolkit, so this must not be called before there is one; layers resolve their font when they plot, not when they are constructed.

Returns: Font

Definition at line 276 of file mathplot.h.

References m_font.

Referenced by BOOST_AUTO_TEST_CASE(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpInfoLegend::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), SMITH_CURSOR::Plot(), and SMITH_GRID::Plot().

◆ HasBBox()

virtual bool mpLayer::HasBBox ( ) const

inlinevirtual

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, SMITH_GRID, and SMITH_TRACE.

Definition at line 179 of file mathplot.h.

◆ IsInfo()

virtual bool mpLayer::IsInfo ( ) const

inlinevirtual

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

◆ IsVisible()

bool mpLayer::IsVisible ( ) const

inline

Checks whether the layer is visible or not.

Returns: true if visible

Definition at line 324 of file mathplot.h.

References m_visible.

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

◆ Plot()

virtual void mpLayer::Plot	(	wxDC &	dc,
		mpWindow &	w )

pure virtual

Plot given view of layer to the given device context.

An implementation of this function has to transform layer coordinates to wxDC coordinates based on the view parameters retrievable from the mpWindow passed in w. Note that the public methods of mpWindow: x2p,y2p and p2x,p2y are already provided which transform layer coordinates to DC pixel coordinates, and user code should rely on them for portability and future changes to be applied transparently, instead of implementing the following formulas manually.

The passed device context dc has its coordinate origin set to the top-left corner of the visible area (the default). The coordinate orientation is as shown in the following picture:

(wxDC origin 0,0)
x-------------> ascending X ----------------+
|                                           |
|                                           |
|  V ascending Y                            |
|                                           |
|                                           |
|                                           |
|+------------------------------------------+  <-- right-bottom corner of the mpWindow visible area.

Note that Y ascends in downward direction, whereas the usual vertical orientation for mathematical plots is vice versa. Thus Y-orientation will be swapped usually, when transforming between wxDC and mpLayer coordinates. This change of coordinates is taken into account in the methods p2x,p2y,x2p,y2p.

Rules for transformation between mpLayer and wxDC coordinates

dc_X = (layer_X - mpWindow::GetPosX()) * mpWindow::GetScaleX()
dc_Y = (mpWindow::GetPosY() - layer_Y) * mpWindow::GetScaleY() // swapping Y-orientation
 
layer_X = (dc_X / mpWindow::GetScaleX()) + mpWindow::GetPosX() // scale guaranteed to be not 0
layer_Y = mpWindow::GetPosY() - (dc_Y / mpWindow::GetScaleY()) // swapping Y-orientation

Parameters

dc	Device context to plot to.
w	View to plot. The visible area can be retrieved from this object.

See also: mpWindow::p2x,mpWindow::p2y,mpWindow::x2p,mpWindow::y2p

Implemented in CURSOR, mpFX, mpFXY, mpFY, mpInfoLayer, mpInfoLegend, mpScaleXBase, mpScaleY, SMITH_CURSOR, SMITH_GRID, and SMITH_TRACE.

◆ SetBrush()

void mpLayer::SetBrush ( const wxBrush & brush )

inline

Set layer brush.

Parameters

brush brush, will be copied to internal class member

Definition at line 336 of file mathplot.h.

References m_brush.

◆ SetContinuity()

void mpLayer::SetContinuity ( bool continuity )

inline

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

See also: GetContinuity

Definition at line 292 of file mathplot.h.

References m_continuous.

Referenced by TRACE::TRACE().

◆ SetFont()

void mpLayer::SetFont ( const wxFont & font )

inline

Set layer font.

Parameters

font	Font, will be copied to internal class member

Definition at line 311 of file mathplot.h.

References m_font.

Referenced by BOOST_AUTO_TEST_CASE().

◆ SetName()

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

inlinevirtual

Set layer name.

Parameters

name	Name, will be copied to internal class member

Reimplemented in TRACE.

Definition at line 306 of file mathplot.h.

References m_name, and name.

Referenced by mpFX::mpFX(), mpFXY::mpFXY(), mpFY::mpFY(), mpScaleXBase::mpScaleXBase(), mpScaleY::mpScaleY(), and TRACE::SetName().

◆ SetPen()

void mpLayer::SetPen ( const wxPen & pen )

inline

Set layer pen.

Parameters

pen	Pen, will be copied to internal class member

Definition at line 316 of file mathplot.h.

References m_pen.

Referenced by mpLayer(), mpScaleXBase::mpScaleXBase(), mpScaleY::mpScaleY(), mpInfoLegend::Plot(), and SIM_PLOT_TAB::UpdateTraceStyle().

◆ SetVisible()

void mpLayer::SetVisible ( bool show )

inline

Sets layer visibility.

Parameters

show	visibility bool.

Definition at line 328 of file mathplot.h.

References m_visible.

Referenced by SIM_PLOT_TAB::AddView().

◆ ShowName()

void mpLayer::ShowName ( bool show )

inline

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

Definition at line 301 of file mathplot.h.

References m_showName.

Referenced by TRACE::TRACE().

Member Data Documentation

◆ m_brush

wxBrush mpLayer::m_brush

protected

Layer's brush.

Definition at line 342 of file mathplot.h.

Referenced by GetBrush(), and SetBrush().

◆ m_continuous

bool mpLayer::m_continuous

protected

Specify if the layer will be plotted as a continuous line or a set of points.

Definition at line 345 of file mathplot.h.

Referenced by GetContinuity(), mpLayer(), CURSOR::Plot(), mpFXY::Plot(), and SetContinuity().

◆ m_displayName

wxString mpLayer::m_displayName

protected

Definition at line 344 of file mathplot.h.

Referenced by GetDisplayName(), and TRACE::SetName().

◆ m_font

wxFont mpLayer::m_font

protected

Layer's font.

Definition at line 340 of file mathplot.h.

Referenced by GetFont(), GetPlotFont(), and SetFont().

◆ m_name

wxString mpLayer::m_name

protected

Layer's name.

Definition at line 343 of file mathplot.h.

Referenced by GetDisplayName(), GetName(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), and SetName().

◆ m_pen

wxPen mpLayer::m_pen

protected

Layer's pen.

Definition at line 341 of file mathplot.h.

Referenced by GetPen(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), SMITH_GRID::Plot(), SMITH_TRACE::Plot(), and SetPen().

◆ m_showName

bool mpLayer::m_showName

protected

States whether the name of the layer must be shown (default is true).

Definition at line 346 of file mathplot.h.

Referenced by mpLayer(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), and ShowName().

◆ m_type

mpLayerType mpLayer::m_type

protected

Define layer type, which is assigned by constructor.

Definition at line 347 of file mathplot.h.

Referenced by GetLayerType(), mpFX::mpFX(), mpFXY::mpFXY(), mpFXYVector::mpFXYVector(), mpFY::mpFY(), mpInfoLayer::mpInfoLayer(), mpInfoLayer::mpInfoLayer(), mpLayer(), mpScaleXBase::mpScaleXBase(), mpScaleY::mpScaleY(), and SMITH_GRID::SMITH_GRID().

◆ m_visible

bool mpLayer::m_visible

protected

Toggles layer visibility.

Definition at line 348 of file mathplot.h.

Referenced by IsVisible(), mpLayer(), CURSOR::Plot(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), SMITH_CURSOR::Plot(), SMITH_GRID::Plot(), SMITH_TRACE::Plot(), and SetVisible().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mpLayer()

◆ ~mpLayer()

Member Function Documentation

◆ GetBrush()

◆ GetContinuity()

◆ GetDisplayName()

◆ GetFont()

◆ GetLayerType()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetPen()

◆ GetPlotFont()

◆ HasBBox()

◆ IsInfo()

◆ IsVisible()

◆ Plot()

◆ SetBrush()

◆ SetContinuity()

◆ SetFont()

◆ SetName()

◆ SetPen()

◆ SetVisible()

◆ ShowName()

Member Data Documentation

◆ m_brush

◆ m_continuous

◆ m_displayName

◆ m_font

◆ m_name

◆ m_pen

◆ m_showName

◆ m_type

◆ m_visible