KiCad PCB EDA Suite
Loading...
Searching...
No Matches
mpLayer Class Referenceabstract

#include <mathplot.h>

Inheritance diagram for mpLayer:
mpFX mpFXY mpFY mpInfoLayer mpScaleBase mpFXYVector CURSOR mpInfoLegend mpScaleXBase mpScaleY TRACE mpScaleX mpScaleXLog LIN_SCALE< mpScaleX > TIME_SCALE

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 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
 
wxPen m_pen
 
wxBrush m_brush
 
wxString m_name
 
wxString m_displayName
 
bool m_continuous
 
bool m_showName
 
mpLayerType m_type
 
bool m_visible
 

Detailed Description

Definition at line 148 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpLayer()

mpLayer::mpLayer ( )

Definition at line 62 of file mathplot.cpp.

◆ ~mpLayer()

virtual mpLayer::~mpLayer ( )
inlinevirtual

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

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const
inline

Gets the 'continuity' property of the layer.

See also
SetContinuity

Definition at line 264 of file mathplot.h.

◆ GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const
inline

Definition at line 241 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const
inline

Get font set for this layer.

Returns
Font

Definition at line 249 of file mathplot.h.

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

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 181 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 191 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 176 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 186 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetName()

const wxString & mpLayer::GetName ( ) const
inline

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const
inline

Get pen set for this layer.

Returns
Pen

Definition at line 254 of file mathplot.h.

Referenced by CURSOR::Plot(), mpInfoLegend::Plot(), and SIMULATOR_FRAME_UI::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
trueHas bounding box
falseHas not bounding box

Reimplemented in mpInfoLayer, mpScaleBase, and mpScaleY.

Definition at line 162 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 171 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 291 of file mathplot.h.

Referenced by SIM_PLOT_TAB::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
double GetScaleY() const
Get current view's Y scale.
Definition: mathplot.h:1009
double GetScaleX() const
Get current view's X scale.
Definition: mathplot.h:1003
double GetPosY() const
Get current view's Y position.
Definition: mathplot.h:1021
double GetPosX() const
Get current view's X position.
Definition: mathplot.h:1015
Parameters
dcDevice context to plot to.
wView 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, mpInfoLegend, mpFX, mpFY, mpFXY, mpScaleXBase, and mpScaleY.

◆ SetBrush()

void mpLayer::SetBrush ( const wxBrush &  brush)
inline

Set layer brush.

Parameters
brushbrush, will be copied to internal class member

Definition at line 303 of file mathplot.h.

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

Referenced by TRACE::TRACE().

◆ SetFont()

void mpLayer::SetFont ( const wxFont &  font)
inline

Set layer font.

Parameters
fontFont, 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)
inlinevirtual

Set layer name.

Parameters
nameName, 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)
inline

Set layer pen.

Parameters
penPen, 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)
inline

Sets layer visibility.

Parameters
showvisibility 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)
inline

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

Member Data Documentation

◆ m_brush

wxBrush mpLayer::m_brush
protected

Definition at line 309 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous
protected

Definition at line 312 of file mathplot.h.

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

◆ m_displayName

wxString mpLayer::m_displayName
protected

Definition at line 311 of file mathplot.h.

Referenced by TRACE::SetName().

◆ m_font

wxFont mpLayer::m_font
protected

◆ m_name

wxString mpLayer::m_name
protected

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
protected

◆ m_showName

bool mpLayer::m_showName
protected

Definition at line 313 of file mathplot.h.

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

◆ m_type

mpLayerType mpLayer::m_type
protected

Definition at line 314 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_visible

bool mpLayer::m_visible
protected

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