Implements the legend to be added to the plot This layer allows you to add a legend to describe the plots in the window. More...

#include <mathplot.h>

Inheritance diagram for mpInfoLegend:

Public Member Functions
	mpInfoLegend ()
	Default constructor.

	mpInfoLegend (wxRect rect, const wxBrush *brush=wxTRANSPARENT_BRUSH)
	Complete constructor, setting initial rectangle and background brush.

	~mpInfoLegend ()
	Default destructor.

virtual void	Plot (wxDC &dc, mpWindow &w) override
	Plot method.

virtual bool	HasBBox () const override
	mpInfoLayer has not bounding box.

virtual bool	IsInfo () const override
	Specifies that this is an Info box layer.

virtual bool	Inside (const wxPoint &point) const
	Checks whether a point is inside the info box rectangle.

virtual bool	OnDoubleClick (const wxPoint &point, mpWindow &w)

virtual void	Move (wxPoint delta)
	Moves the layer rectangle of given pixel deltas.

virtual void	UpdateReference ()
	Updates the rectangle reference point.

wxPoint	GetPosition () const
	Returns the position of the upper left corner of the box (in pixels)

wxSize	GetSize () const
	Returns the size of the box (in pixels)

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.

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
wxRect	m_dim

wxPoint	m_reference

wxBrush	m_brush

int	m_winX

int	m_winY

wxFont	m_font
	Layer's font.

wxPen	m_pen
	Layer's pen.

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

Implements the legend to be added to the plot This layer allows you to add a legend to describe the plots in the window.

The legend uses the layer name as a label, and displays only layers of type mpLAYER_PLOT.

Definition at line 429 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpInfoLegend() [1/2]

mpInfoLegend::mpInfoLegend ( )

Default constructor.

Definition at line 209 of file mathplot.cpp.

References mpInfoLayer::mpInfoLayer().

◆ mpInfoLegend() [2/2]

mpInfoLegend::mpInfoLegend	(	wxRect	rect,
		const wxBrush *	brush = wxTRANSPARENT_BRUSH )

Complete constructor, setting initial rectangle and background brush.

Parameters

rect	The initial bounding rectangle.
brush	The wxBrush to be used for box background: default is transparent

See also: mpInfoLayer::mpInfoLayer

Definition at line 215 of file mathplot.cpp.

References mpInfoLayer::mpInfoLayer().

◆ ~mpInfoLegend()

mpInfoLegend::~mpInfoLegend ( )

Default destructor.

Definition at line 221 of file mathplot.cpp.

Member Function Documentation

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const

inlineinherited

Get brush set for this layer.

Returns: brush.

Definition at line 332 of file mathplot.h.

References m_brush.

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const

inlineinherited

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

inlineinherited

Definition at line 258 of file mathplot.h.

References m_displayName, and m_name.

Referenced by mpInfoLegend::Plot().

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const

inlineinherited

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

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

References m_type.

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 198 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 208 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 193 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 203 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetName()

const wxString & mpLayer::GetName ( ) const

inlineinherited

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

inlineinherited

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

inlineinherited

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().

◆ GetPosition()

wxPoint mpInfoLayer::GetPosition ( ) const

inherited

Returns the position of the upper left corner of the box (in pixels)

Returns: The rectangle position

Definition at line 197 of file mathplot.cpp.

References m_dim.

Referenced by SIM_PLOT_TAB::AddView().

◆ GetSize()

wxSize mpInfoLayer::GetSize ( ) const

inherited

Returns the size of the box (in pixels)

Returns: The rectangle size

Definition at line 203 of file mathplot.cpp.

References m_dim.

◆ HasBBox()

virtual bool mpInfoLayer::HasBBox ( ) const

inlineoverridevirtualinherited

mpInfoLayer has not bounding box.

See also: mpLayer::HasBBox

Returns: always false

Reimplemented from mpLayer.

Definition at line 379 of file mathplot.h.

◆ Inside()

bool mpInfoLayer::Inside ( const wxPoint & point ) const

virtualinherited

Checks whether a point is inside the info box rectangle.

Parameters

point The point to be checked

Returns: true if the point is inside the bounding box

Reimplemented in CURSOR, and SMITH_CURSOR.

Definition at line 133 of file mathplot.cpp.

References m_dim.

Referenced by mpWindow::IsInsideInfoLayer(), and mpWindow::onMouseMove().

◆ IsInfo()

virtual bool mpInfoLayer::IsInfo ( ) const

inlineoverridevirtualinherited

Specifies that this is an Info box layer.

Returns: always true

See also: mpLayer::IsInfo

Reimplemented from mpLayer.

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

References m_visible.

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

◆ Move()

void mpInfoLayer::Move ( wxPoint delta )

virtualinherited

Moves the layer rectangle of given pixel deltas.

Parameters

delta The wxPoint container for delta coordinates along x and y. Units are in pixels.

Reimplemented in CURSOR, and SMITH_CURSOR.

Definition at line 145 of file mathplot.cpp.

References delta, m_dim, and m_reference.

Referenced by CURSOR::Move(), SMITH_CURSOR::Move(), and CURSOR::SetCoordX().

◆ OnDoubleClick()

bool mpInfoLayer::OnDoubleClick	(	const wxPoint &	point,
		mpWindow &	w )

virtualinherited

Reimplemented in CURSOR.

Definition at line 139 of file mathplot.cpp.

◆ Plot()

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

overridevirtual

Plot method.

Parameters

dc	the device content where to plot
w	the window to plot

Reimplemented from mpInfoLayer.

Definition at line 226 of file mathplot.cpp.

References mpWindow::CountAllLayers(), mpLayer::GetDisplayName(), mpWindow::GetLayer(), mpLayer::GetLayerType(), mpLayer::GetPen(), mpLayer::GetPlotFont(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpLayer::IsVisible(), mpInfoLayer::m_brush, mpInfoLayer::m_dim, mpLayer::m_pen, mpLayer::m_visible, mpInfoLayer::m_winX, mpInfoLayer::m_winY, mpLAYER_PLOT, mpLEGEND_LINEWIDTH, mpLEGEND_MARGIN, mpLayer::SetPen(), and mpInfoLayer::UpdateReference().

◆ SetBrush()

void mpLayer::SetBrush ( const wxBrush & brush )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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 )

inlinevirtualinherited

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 )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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().

◆ UpdateReference()

void mpInfoLayer::UpdateReference ( )

virtualinherited

Updates the rectangle reference point.

Used by internal methods of mpWindow to correctly move mpInfoLayers.

Reimplemented in CURSOR, and SMITH_CURSOR.

Definition at line 152 of file mathplot.cpp.

References m_dim, and m_reference.

Referenced by Plot(), mpInfoLegend::Plot(), SMITH_CURSOR::Plot(), and SMITH_CURSOR::UpdateReference().

Member Data Documentation

◆ m_brush

wxBrush mpInfoLayer::m_brush

protectedinherited

Definition at line 418 of file mathplot.h.

Referenced by mpInfoLayer(), mpInfoLayer(), Plot(), and mpInfoLegend::Plot().

◆ m_continuous

bool mpLayer::m_continuous

protectedinherited

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_dim

wxRect mpInfoLayer::m_dim

protectedinherited

Definition at line 415 of file mathplot.h.

Referenced by GetPosition(), GetSize(), Inside(), Move(), mpInfoLayer(), mpInfoLayer(), CURSOR::Plot(), Plot(), mpInfoLegend::Plot(), SMITH_CURSOR::Plot(), and UpdateReference().

◆ m_displayName

wxString mpLayer::m_displayName

protectedinherited

Definition at line 344 of file mathplot.h.

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

◆ m_font

wxFont mpLayer::m_font

protectedinherited

Layer's font.

Definition at line 340 of file mathplot.h.

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

◆ m_name

wxString mpLayer::m_name

protectedinherited

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

protectedinherited

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_reference

wxPoint mpInfoLayer::m_reference

protectedinherited

Definition at line 417 of file mathplot.h.

Referenced by CURSOR::Move(), Move(), mpInfoLayer(), mpInfoLayer(), CURSOR::SetX(), CURSOR::UpdateReference(), and UpdateReference().

◆ m_showName

bool mpLayer::m_showName

protectedinherited

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

protectedinherited

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

protectedinherited

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().

◆ m_winX

int mpInfoLayer::m_winX

protectedinherited

Definition at line 419 of file mathplot.h.

Referenced by mpInfoLayer(), mpInfoLayer(), Plot(), and mpInfoLegend::Plot().

◆ m_winY

int mpInfoLayer::m_winY

protectedinherited

Definition at line 420 of file mathplot.h.

Referenced by mpInfoLayer(), mpInfoLayer(), Plot(), and mpInfoLegend::Plot().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mpInfoLegend() [1/2]

◆ mpInfoLegend() [2/2]

◆ ~mpInfoLegend()

Member Function Documentation

◆ GetBrush()

◆ GetContinuity()

◆ GetDisplayName()

◆ GetFont()

◆ GetLayerType()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetPen()

◆ GetPlotFont()

◆ GetPosition()

◆ GetSize()

◆ HasBBox()

◆ Inside()

◆ IsInfo()

◆ IsVisible()

◆ Move()

◆ OnDoubleClick()

◆ Plot()

◆ SetBrush()

◆ SetContinuity()

◆ SetFont()

◆ SetName()

◆ SetPen()

◆ SetVisible()

◆ ShowName()

◆ UpdateReference()

Member Data Documentation

◆ m_brush

◆ m_continuous

◆ m_dim

◆ m_displayName

◆ m_font

◆ m_name

◆ m_pen

◆ m_reference

◆ m_showName

◆ m_type

◆ m_visible

◆ m_winX

◆ m_winY