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

wxPen	m_pen

wxString	m_name

wxString	m_displayName

bool	m_continuous

bool	m_showName

mpLayerType	m_type

bool	m_visible

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

Constructor & Destructor Documentation

◆ mpInfoLegend() [1/2]

mpInfoLegend::mpInfoLegend ( )

Default constructor.

Definition at line 176 of file mathplot.cpp.

◆ 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 182 of file mathplot.cpp.

◆ ~mpInfoLegend()

mpInfoLegend::~mpInfoLegend ( )

Default destructor.

Definition at line 188 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 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 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 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(), Plot(), and SIMULATOR_FRAME_UI::rebuildSignalsGrid().

◆ 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 164 of file mathplot.cpp.

References mpInfoLayer::m_dim.

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

◆ GetSize()

wxSize mpInfoLayer::GetSize ( ) const

inherited

Returns the size of the box (in pixels)

Returns: The rectangle size

Definition at line 170 of file mathplot.cpp.

References mpInfoLayer::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 345 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.

Definition at line 106 of file mathplot.cpp.

References mpInfoLayer::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 356 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 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.

Definition at line 112 of file mathplot.cpp.

References delta, mpInfoLayer::m_dim, and mpInfoLayer::m_reference.

Referenced by CURSOR::Move(), mpWindow::onMouseMove(), CURSOR::SetCoordX(), and SIM_PLOT_TAB::SetLegendPosition().

◆ 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 193 of file mathplot.cpp.

References mpWindow::CountAllLayers(), mpLayer::GetDisplayName(), mpWindow::GetLayer(), mpLayer::GetLayerType(), mpLayer::GetPen(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpLayer::IsVisible(), mpInfoLayer::m_brush, mpInfoLayer::m_dim, mpLayer::m_font, mpLayer::m_pen, mpLayer::m_visible, mpInfoLayer::m_winX, mpInfoLayer::m_winY, mpLAYER_PLOT, mpLEGEND_LINEWIDTH, mpLEGEND_MARGIN, 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 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().

◆ UpdateReference()

void mpInfoLayer::UpdateReference ( )

virtualinherited

Updates the rectangle reference point.

Used by internal methods of mpWindow to correctly move mpInfoLayers.

Reimplemented in CURSOR.

Definition at line 119 of file mathplot.cpp.

References mpInfoLayer::m_dim, and mpInfoLayer::m_reference.

Referenced by mpWindow::onMouseLeftRelease(), mpInfoLayer::Plot(), Plot(), and SIM_PLOT_TAB::SetLegendPosition().

Member Data Documentation

◆ m_brush

wxBrush mpInfoLayer::m_brush

protectedinherited

Definition at line 382 of file mathplot.h.

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

◆ m_continuous

bool mpLayer::m_continuous

protectedinherited

Definition at line 312 of file mathplot.h.

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

◆ m_dim

wxRect mpInfoLayer::m_dim

protectedinherited

Definition at line 379 of file mathplot.h.

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

◆ m_displayName

wxString mpLayer::m_displayName

protectedinherited

Definition at line 311 of file mathplot.h.

Referenced by TRACE::SetName().

◆ m_font

wxFont mpLayer::m_font

protectedinherited

Definition at line 307 of file mathplot.h.

Referenced by Plot(), mpFX::Plot(), mpFY::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(), mpFY::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(), Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

◆ m_reference

wxPoint mpInfoLayer::m_reference

protectedinherited

Definition at line 381 of file mathplot.h.

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

◆ m_showName

bool mpLayer::m_showName

protectedinherited

Definition at line 313 of file mathplot.h.

Referenced by mpFX::Plot(), mpFY::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(), Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

◆ m_winX

int mpInfoLayer::m_winX

protectedinherited

Definition at line 383 of file mathplot.h.

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

◆ m_winY

int mpInfoLayer::m_winY

protectedinherited

Definition at line 384 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer(), mpInfoLayer::Plot(), and 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()

◆ GetPosition()

◆ GetSize()

◆ HasBBox()

◆ Inside()

◆ IsInfo()

◆ IsVisible()

◆ Move()

◆ 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