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

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

const wxString &	GetName () const
	Get layer name. More...

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 (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
wxFont	m_font

wxPen	m_pen

wxBrush	m_brush

wxString	m_name

bool	m_continuous

bool	m_showName

bool	m_drawOutsideMargins

mpLayerType	m_type

bool	m_visible

Detailed Description

Definition at line 147 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpLayer()

mpLayer::mpLayer ( )

Definition at line 64 of file mathplot.cpp.

 : m_type( mpLAYER_UNDEF )
{
 SetPen( (wxPen&) *wxBLACK_PEN );
 SetFont( (wxFont&) *wxNORMAL_FONT );
 m_continuous = false; // Default
 m_showName = true; // Default
 m_drawOutsideMargins = false;
 m_visible = true;
}

◆ ~mpLayer()

virtual mpLayer::~mpLayer ( )

inlinevirtual

Definition at line 152 of file mathplot.h.

152{};

Member Function Documentation

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const

inline

Get brush set for this layer.

Returns: brush.

Definition at line 306 of file mathplot.h.

306{ return m_brush; };

mpLayer::m_brush

wxBrush m_brush

Definition: mathplot.h:316

◆ GetColourSquare()

wxBitmap mpLayer::GetColourSquare ( int side = 16 ) const

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

{
 wxBitmap square( side, side, -1 );
 wxColour filler = m_pen.GetColour();
 wxBrush brush( filler, wxBRUSHSTYLE_SOLID );
 wxMemoryDC dc;
 
 dc.SelectObject( square );
 dc.SetBackground( brush );
 dc.Clear();
 dc.SelectObject( wxNullBitmap );
 return square;
}

References m_pen, and square().

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const

inline

Gets the 'continuity' property of the layer.

See also: SetContinuity

Definition at line 258 of file mathplot.h.

258{ return m_continuous; }

◆ GetDrawOutsideMargins()

bool mpLayer::GetDrawOutsideMargins ( )

inline

Get Draw mode: inside or outside margins.

Returns: The draw mode

Definition at line 285 of file mathplot.h.

285{ return m_drawOutsideMargins; };

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const

inline

Get font set for this layer.

Returns: Font

Definition at line 243 of file mathplot.h.

243{ return m_font; }

mpLayer::m_font

wxFont m_font

Definition: mathplot.h:314

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

294{ return 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, mpMovableObject, and mpBitmapLayer.

Definition at line 180 of file mathplot.h.

180{ return 1.0; }

Referenced by mpFXY::UpdateScales().

◆ GetMaxY()

virtual double mpLayer::GetMaxY ( ) const

inlinevirtual

Get inclusive top border of bounding box.

Returns: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 190 of file mathplot.h.

190{ return 1.0; }

Referenced by mpFXY::UpdateScales().

◆ GetMinX()

virtual double mpLayer::GetMinX ( ) const

inlinevirtual

Get inclusive left border of bounding box.

Returns: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 175 of file mathplot.h.

175{ return -1.0; }

Referenced by mpFXY::UpdateScales().

◆ GetMinY()

virtual double mpLayer::GetMinY ( ) const

inlinevirtual

Get inclusive bottom border of bounding box.

Returns: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 185 of file mathplot.h.

185{ return -1.0; }

Referenced by mpFXY::UpdateScales().

◆ GetName()

const wxString & mpLayer::GetName ( void ) const

inline

Get layer name.

Returns: Name

Definition at line 238 of file mathplot.h.

238{ return m_name; }

mpLayer::m_name

wxString m_name

Definition: mathplot.h:317

Referenced by SIM_PLOT_PANEL::GetLabelX(), SIM_PLOT_PANEL::GetLabelY1(), SIM_PLOT_PANEL::GetLabelY2(), SIM_PLOT_PANEL::GetLabelY3(), mpInfoLegend::Plot(), mpText::Plot(), and SIMULATOR_FRAME::updateCursors().

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const

inline

Get pen set for this layer.

Returns: Pen

Definition at line 248 of file mathplot.h.

248{ return m_pen; }

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

◆ 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, mpText, mpMovableObject, and mpBitmapLayer.

Definition at line 161 of file mathplot.h.

161{ return true; }

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

170{ return false; };

◆ IsVisible()

bool mpLayer::IsVisible ( ) const

inline

Checks whether the layer is visible or not.

Returns: true if visible

Definition at line 298 of file mathplot.h.

298{ return m_visible; };

Referenced by mpWindow::IsLayerVisible(), SIM_PLOT_PANEL::IsLegendShown(), 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, mpInfoLayer, mpInfoCoords, mpInfoLegend, mpFX, mpFY, mpFXY, mpProfile, mpScaleXBase, mpScaleY, mpText, mpMovableObject, and mpBitmapLayer.

Referenced by mpPrintout::OnPrintPage().

◆ SetBrush()

void mpLayer::SetBrush ( wxBrush brush )

inline

Set layer brush.

Parameters

brush brush, will be copied to internal class member

Definition at line 310 of file mathplot.h.

310{ m_brush = 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 253 of file mathplot.h.

253{ m_continuous = continuity; }

Referenced by TRACE::TRACE().

◆ SetDrawOutsideMargins()

void mpLayer::SetDrawOutsideMargins ( bool drawModeOutside )

inline

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

281{ m_drawOutsideMargins = drawModeOutside; };

Referenced by CURSOR::CURSOR(), and TRACE::TRACE().

◆ SetFont()

void mpLayer::SetFont ( wxFont & font )

inline

Set layer font.

Parameters

font	Font, will be copied to internal class member

Definition at line 272 of file mathplot.h.

272{ m_font = font; }

◆ SetName()

virtual void mpLayer::SetName ( wxString name )

inlinevirtual

Set layer name.

Parameters

name	Name, will be copied to internal class member

Reimplemented in TRACE.

Definition at line 267 of file mathplot.h.

267{ m_name = name; }

name

const char * name

Definition: DXF_plotter.cpp:56

References name.

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

◆ SetPen()

void mpLayer::SetPen ( wxPen pen )

inline

Set layer pen.

Parameters

pen	Pen, will be copied to internal class member

Definition at line 277 of file mathplot.h.

277{ m_pen = pen; }

Referenced by SIM_PLOT_PANEL::UpdateTraceStyle().

◆ SetVisible()

void mpLayer::SetVisible ( bool show )

inline

Sets layer visibility.

Parameters

show	visibility bool.

Definition at line 302 of file mathplot.h.

302{ m_visible = show; };

Referenced by mpWindow::SetLayerVisible(), SIM_PLOT_PANEL::ShowLegend(), and SIM_PLOT_PANEL::SIM_PLOT_PANEL().

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

262{ m_showName = show; };

Referenced by TRACE::TRACE().

Member Data Documentation

◆ m_brush

wxBrush mpLayer::m_brush

protected

Definition at line 316 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous

protected

Definition at line 318 of file mathplot.h.

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

◆ m_drawOutsideMargins

bool mpLayer::m_drawOutsideMargins

protected

Definition at line 320 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

protected

Definition at line 314 of file mathplot.h.

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

protected

Definition at line 317 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

protected

Definition at line 315 of file mathplot.h.

Referenced by GetColourSquare(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), and mpMovableObject::Plot().

◆ m_showName

bool mpLayer::m_showName

protected

Definition at line 319 of file mathplot.h.

Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ m_type

mpLayerType mpLayer::m_type

protected

Definition at line 321 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_visible

bool mpLayer::m_visible

protected

Definition at line 322 of file mathplot.h.

Referenced by CURSOR::Plot(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

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

◆ GetColourSquare()

◆ GetContinuity()

◆ GetDrawOutsideMargins()

◆ GetFont()

◆ GetLayerType()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetPen()

◆ HasBBox()

◆ IsInfo()

◆ IsVisible()

◆ Plot()

◆ SetBrush()

◆ SetContinuity()

◆ SetDrawOutsideMargins()

◆ SetFont()

◆ SetName()

◆ SetPen()

◆ SetVisible()

◆ ShowName()

Member Data Documentation

◆ m_brush

◆ m_continuous

◆ m_drawOutsideMargins

◆ m_font

◆ m_name

◆ m_pen

◆ m_showName

◆ m_type

◆ m_visible