KiCad PCB EDA Suite
|
Abstract base class providing plot and labeling functionality for functions F:Y->X. More...
#include <mathplot.h>
Public Member Functions | |
mpFY (const wxString &name=wxEmptyString, int flags=mpALIGN_TOP) | |
virtual double | GetX (double y) const =0 |
Get function value for argument. | |
virtual void | Plot (wxDC &dc, mpWindow &w) override |
Layer plot handler. | |
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. | |
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 | |
int | m_flags |
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 |
Abstract base class providing plot and labeling functionality for functions F:Y->X.
Override mpFY::GetX to implement a function. Optionally implement a constructor and pass a name (label) and a label alignment to the constructor mpFY::mpFY. If the layer name is empty, no label will be plotted.
Definition at line 507 of file mathplot.h.
mpFY::mpFY | ( | const wxString & | name = wxEmptyString, |
int | flags = mpALIGN_TOP ) |
name | Label |
flags | Label alignment, pass one of mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP. |
Definition at line 355 of file mathplot.cpp.
References m_flags, mpLayer::m_type, mpFY(), mpLAYER_PLOT, name, and mpLayer::SetName().
Referenced by mpFY().
|
inlineinherited |
Get brush set for this layer.
Definition at line 299 of file mathplot.h.
References m_brush.
|
inlineinherited |
Gets the 'continuity' property of the layer.
Definition at line 264 of file mathplot.h.
References m_continuous.
|
inlineinherited |
Definition at line 241 of file mathplot.h.
References m_displayName, and m_name.
Referenced by mpInfoLegend::Plot().
|
inlineinherited |
Get font set for this layer.
Definition at line 249 of file mathplot.h.
References m_font.
|
inlineinherited |
Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value.
Definition at line 287 of file mathplot.h.
References m_type.
Referenced by mpInfoLegend::Plot().
|
inlinevirtualinherited |
Get inclusive right border of bounding box.
Reimplemented in mpFXYVector.
Definition at line 181 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlinevirtualinherited |
Get inclusive top border of bounding box.
Reimplemented in mpFXYVector.
Definition at line 191 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlinevirtualinherited |
Get inclusive left border of bounding box.
Reimplemented in mpFXYVector.
Definition at line 176 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlinevirtualinherited |
Get inclusive bottom border of bounding box.
Reimplemented in mpFXYVector.
Definition at line 186 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlineinherited |
Get layer name.
Definition at line 239 of file mathplot.h.
References m_name.
Referenced by SIMULATOR_FRAME_UI::updatePlotCursors(), and SIM_PLOT_TAB::UpdateTraceStyle().
|
inlineinherited |
Get pen set for this layer.
Definition at line 254 of file mathplot.h.
References m_pen.
Referenced by CURSOR::Plot(), mpInfoLegend::Plot(), and SIMULATOR_FRAME_UI::rebuildSignalsGrid().
|
pure virtual |
|
inlinevirtualinherited |
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.
true | Has bounding box |
false | Has not bounding box |
Reimplemented in mpInfoLayer, mpScaleBase, and mpScaleY.
Definition at line 162 of file mathplot.h.
|
inlinevirtualinherited |
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.
Reimplemented in mpInfoLayer.
Definition at line 171 of file mathplot.h.
|
inlineinherited |
Checks whether the layer is visible or not.
Definition at line 291 of file mathplot.h.
References m_visible.
Referenced by mpWindow::IsLayerVisible(), and mpInfoLegend::Plot().
|
overridevirtual |
Layer plot handler.
This implementation will plot the function in the visible area and put a label according to the alignment specified.
Implements mpLayer.
Definition at line 363 of file mathplot.cpp.
References mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpWindow::GetScrX(), mpWindow::GetScrY(), GetX(), m_flags, mpLayer::m_font, mpLayer::m_name, mpLayer::m_pen, mpLayer::m_showName, mpLayer::m_visible, mpALIGN_CENTER, mpALIGN_TOP, mpALIGNMASK, mpWindow::p2y(), and mpWindow::x2p().
Referenced by GetX().
|
inlineinherited |
Set layer brush.
brush | brush, will be copied to internal class member |
Definition at line 303 of file mathplot.h.
References m_brush.
|
inlineinherited |
Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).
Definition at line 259 of file mathplot.h.
References m_continuous.
Referenced by TRACE::TRACE().
|
inlineinherited |
Set layer font.
font | Font, will be copied to internal class member |
Definition at line 278 of file mathplot.h.
References m_font.
Referenced by mpLayer(), mpScaleXBase::mpScaleXBase(), and mpScaleY::mpScaleY().
|
inlinevirtualinherited |
Set layer name.
name | Name, will be copied to internal class member |
Reimplemented in TRACE.
Definition at line 273 of file mathplot.h.
Referenced by mpFX::mpFX(), mpFXY::mpFXY(), mpFY::mpFY(), mpScaleXBase::mpScaleXBase(), mpScaleY::mpScaleY(), and TRACE::SetName().
|
inlineinherited |
Set layer pen.
pen | Pen, will be copied to internal class member |
Definition at line 283 of file mathplot.h.
References m_pen.
Referenced by mpLayer(), mpScaleXBase::mpScaleXBase(), mpScaleY::mpScaleY(), mpInfoLegend::Plot(), and SIM_PLOT_TAB::UpdateTraceStyle().
|
inlineinherited |
Sets layer visibility.
show | visibility bool. |
Definition at line 295 of file mathplot.h.
References m_visible.
|
inlineinherited |
Shows or hides the text label with the name of the layer (default is visible).
Definition at line 268 of file mathplot.h.
References m_showName.
Referenced by TRACE::TRACE().
|
protectedinherited |
Definition at line 309 of file mathplot.h.
Referenced by GetBrush(), and SetBrush().
|
protectedinherited |
Definition at line 312 of file mathplot.h.
Referenced by GetContinuity(), mpLayer(), CURSOR::Plot(), mpFXY::Plot(), and SetContinuity().
|
protectedinherited |
Definition at line 311 of file mathplot.h.
Referenced by GetDisplayName(), and TRACE::SetName().
|
protected |
Definition at line 529 of file mathplot.h.
|
protectedinherited |
Definition at line 307 of file mathplot.h.
Referenced by GetFont(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpInfoLegend::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), and SetFont().
|
protectedinherited |
Definition at line 310 of file mathplot.h.
Referenced by GetDisplayName(), GetName(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), and SetName().
|
protectedinherited |
Definition at line 308 of file mathplot.h.
Referenced by GetPen(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), and SetPen().
|
protectedinherited |
Definition at line 313 of file mathplot.h.
Referenced by mpLayer(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), and ShowName().
|
protectedinherited |
Definition at line 314 of file mathplot.h.
Referenced by GetLayerType(), mpFX::mpFX(), mpFXY::mpFXY(), mpFXYVector::mpFXYVector(), mpFY::mpFY(), mpInfoLayer::mpInfoLayer(), mpInfoLayer::mpInfoLayer(), mpLayer(), mpScaleXBase::mpScaleXBase(), and mpScaleY::mpScaleY().
|
protectedinherited |
Definition at line 315 of file mathplot.h.
Referenced by IsVisible(), mpLayer(), CURSOR::Plot(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), and SetVisible().