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

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

	~mpInfoLegend ()
	Default destructor. More...

virtual void	UpdateInfo (mpWindow &w, wxEvent &event) override
	Updates the content of the info box. More...

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

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

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

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

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

virtual void	UpdateReference ()
	Updates the rectangle reference point. More...

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

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

const wxRect &	GetRectangle () const
	Returns the current rectangle coordinates. 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 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

bool	m_drawOutsideMargins

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

Constructor & Destructor Documentation

◆ mpInfoLegend() [1/2]

mpInfoLegend::mpInfoLegend ( )

Default constructor.

Definition at line 280 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 286 of file mathplot.cpp.

◆ ~mpInfoLegend()

mpInfoLegend::~mpInfoLegend ( )

Default destructor.

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

◆ GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const

inlineinherited

Definition at line 244 of file mathplot.h.

Referenced by 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 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 mpFXY::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 mpFXY::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 mpFXY::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 mpFXY::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().

◆ 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(), Plot(), and SIMULATOR_FRAME::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 190 of file mathplot.cpp.

References mpInfoLayer::m_dim.

Referenced by SIM_PLOT_PANEL::GetLegendPosition().

◆ GetRectangle()

const wxRect & mpInfoLayer::GetRectangle ( ) const

inlineinherited

Returns the current rectangle coordinates.

Returns: The info layer rectangle

Definition at line 403 of file mathplot.h.

◆ GetSize()

wxSize mpInfoLayer::GetSize ( ) const

inherited

Returns the size of the box (in pixels)

Returns: The rectangle size

Definition at line 196 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 368 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 129 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 379 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 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 135 of file mathplot.cpp.

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

Referenced by CURSOR::Move(), mpWindow::OnMouseMove(), CURSOR::SetCoordX(), and SIM_PLOT_PANEL::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

See also: mpLayer::Plot

Reimplemented from mpInfoLayer.

Definition at line 302 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 ( 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().

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

◆ UpdateInfo()

void mpInfoLegend::UpdateInfo	(	mpWindow &	w,
		wxEvent &	event
	)

overridevirtual

Updates the content of the info box.

Unused in this class.

Parameters

w	parent mpWindow from which to obtain information
event	The event which called the update.

Reimplemented from mpInfoLayer.

Definition at line 297 of file mathplot.cpp.

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

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

Referenced by mpWindow::OnMouseLeftRelease(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), Plot(), and SIM_PLOT_PANEL::SetLegendPosition().

Member Data Documentation

◆ m_brush

wxBrush mpInfoLayer::m_brush

protectedinherited

Definition at line 408 of file mathplot.h.

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

◆ m_continuous

bool mpLayer::m_continuous

protectedinherited

Definition at line 328 of file mathplot.h.

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

◆ m_dim

wxRect mpInfoLayer::m_dim

protectedinherited

Definition at line 406 of file mathplot.h.

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

◆ 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(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

◆ m_font

wxFont mpLayer::m_font

protectedinherited

Definition at line 323 of file mathplot.h.

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

◆ m_reference

wxPoint mpInfoLayer::m_reference

protectedinherited

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

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

◆ m_winX

int mpInfoLayer::m_winX

protectedinherited

Definition at line 409 of file mathplot.h.

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

◆ m_winY

int mpInfoLayer::m_winY

protectedinherited

Definition at line 409 of file mathplot.h.

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

◆ GetColourSquare()

◆ GetContinuity()

◆ GetDisplayName()

◆ GetDrawOutsideMargins()

◆ GetFont()

◆ GetLayerType()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetPen()

◆ GetPosition()

◆ GetRectangle()

◆ GetSize()

◆ HasBBox()

◆ Inside()

◆ IsInfo()

◆ IsVisible()

◆ Move()

◆ Plot()

◆ SetBrush()

◆ SetContinuity()

◆ SetDrawOutsideMargins()

◆ SetFont()

◆ SetName()

◆ SetPen()

◆ SetVisible()

◆ ShowName()

◆ UpdateInfo()

◆ UpdateReference()

Member Data Documentation

◆ m_brush

◆ m_continuous

◆ m_dim

◆ m_displayName

◆ m_drawOutsideMargins

◆ m_font

◆ m_name

◆ m_pen

◆ m_reference

◆ m_showName

◆ m_type

◆ m_visible

◆ m_winX

◆ m_winY