KiCad PCB EDA Suite
|
Abstract base class providing plot and labeling functionality for a locus plot F:N->X,Y. More...
#include <mathplot.h>
Public Member Functions | |
mpFXY (const wxString &name=wxEmptyString, int flags=mpALIGN_NE) | |
virtual void | Rewind ()=0 |
Rewind value enumeration with mpFXY::GetNextXY. More... | |
virtual bool | GetNextXY (double &x, double &y)=0 |
Get locus value for next N. More... | |
virtual size_t | GetCount () const =0 |
virtual void | Plot (wxDC &dc, mpWindow &w) override |
Layer plot handler. More... | |
virtual void | SetScale (mpScaleBase *scaleX, mpScaleBase *scaleY) |
void | UpdateScales () |
double | s2x (double plotCoordX) const |
double | s2y (double plotCoordY) const |
double | x2s (double x) const |
double | y2s (double y) const |
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... | |
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... | |
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 Member Functions | |
void | UpdateViewBoundary (wxCoord xnew, wxCoord ynew) |
Update label positioning data. More... | |
Protected Attributes | |
int | m_flags |
wxCoord | maxDrawX |
wxCoord | minDrawX |
wxCoord | maxDrawY |
wxCoord | minDrawY |
mpScaleBase * | m_scaleX |
mpScaleBase * | m_scaleY |
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 |
Abstract base class providing plot and labeling functionality for a locus plot F:N->X,Y.
Locus argument N is assumed to be in range 0 .. MAX_N, and implicitly derived by enumerating all locus values. Override mpFXY::Rewind and mpFXY::GetNextXY to implement a locus. Optionally implement a constructor and pass a name (label) and a label alignment to the constructor mpFXY::mpFXY. If the layer name is empty, no label will be plotted.
Definition at line 589 of file mathplot.h.
mpFXY::mpFXY | ( | const wxString & | name = wxEmptyString , |
int | flags = mpALIGN_NE |
||
) |
name | Label |
flags | Label alignment, pass one of mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE. |
Definition at line 539 of file mathplot.cpp.
References mpLAYER_PLOT, and name.
|
inlineinherited |
|
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.
side | side length in pixels |
Definition at line 75 of file mathplot.cpp.
References mpLayer::m_pen, and square().
|
inlineinherited |
Gets the 'continuity' property of the layer.
Definition at line 258 of file mathplot.h.
|
pure virtual |
Implemented in mpFXYVector.
|
inlineinherited |
Get Draw mode: inside or outside margins.
Definition at line 285 of file mathplot.h.
|
inlineinherited |
|
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 294 of file mathplot.h.
Referenced by mpInfoLegend::Plot().
|
inlinevirtualinherited |
Get inclusive right border of bounding box.
Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.
Definition at line 180 of file mathplot.h.
Referenced by UpdateScales().
|
inlinevirtualinherited |
Get inclusive top border of bounding box.
Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.
Definition at line 190 of file mathplot.h.
Referenced by UpdateScales().
|
inlinevirtualinherited |
Get inclusive left border of bounding box.
Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.
Definition at line 175 of file mathplot.h.
Referenced by UpdateScales().
|
inlinevirtualinherited |
Get inclusive bottom border of bounding box.
Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.
Definition at line 185 of file mathplot.h.
Referenced by UpdateScales().
|
inlineinherited |
Get layer name.
Definition at line 238 of file mathplot.h.
Referenced by SIM_PLOT_PANEL::GetLabelX(), SIM_PLOT_PANEL::GetLabelY1(), SIM_PLOT_PANEL::GetLabelY2(), mpInfoLegend::Plot(), and mpText::Plot().
|
pure virtual |
Get locus value for next N.
Override this function in your implementation.
x | Returns X value |
y | Returns Y value |
Implemented in mpFXYVector.
Referenced by Plot().
|
inlineinherited |
Get pen set for this layer.
Definition at line 248 of file mathplot.h.
Referenced by CURSOR::Plot(), and mpInfoLegend::Plot().
|
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, mpScaleY, mpText, mpMovableObject, and mpBitmapLayer.
Definition at line 161 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 170 of file mathplot.h.
|
inlineinherited |
Checks whether the layer is visible or not.
Definition at line 298 of file mathplot.h.
Referenced by mpWindow::IsLayerVisible(), SIM_PLOT_PANEL::IsLegendShown(), and mpInfoLegend::Plot().
|
overridevirtual |
Layer plot handler.
This implementation will plot the locus in the visible area and put a label according to the alignment specified.
Implements mpLayer.
Definition at line 563 of file mathplot.cpp.
References mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), GetNextXY(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpLayer::m_continuous, mpLayer::m_drawOutsideMargins, m_flags, mpLayer::m_font, mpLayer::m_name, mpLayer::m_pen, m_scaleX, m_scaleY, mpLayer::m_showName, mpLayer::m_visible, maxDrawX, maxDrawY, minDrawX, minDrawY, mpALIGN_NE, mpALIGN_NW, mpALIGN_SE, mpALIGNMASK, Rewind(), mpScaleBase::TransformToPlot(), UpdateViewBoundary(), mpWindow::x2p(), and mpWindow::y2p().
|
pure virtual |
Rewind value enumeration with mpFXY::GetNextXY.
Override this function in your implementation.
Implemented in mpFXYVector.
Referenced by Plot().
double mpFXY::s2x | ( | double | plotCoordX | ) | const |
Definition at line 3576 of file mathplot.cpp.
References m_scaleX, and mpScaleBase::TransformFromPlot().
Referenced by CURSOR::Plot().
double mpFXY::s2y | ( | double | plotCoordY | ) | const |
Definition at line 3582 of file mathplot.cpp.
References m_scaleY, and mpScaleBase::TransformFromPlot().
|
inlineinherited |
Set layer brush.
brush | brush, will be copied to internal class member |
Definition at line 310 of file mathplot.h.
|
inlineinherited |
Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).
Definition at line 253 of file mathplot.h.
Referenced by TRACE::TRACE().
|
inlineinherited |
Set Draw mode: inside or outside margins.
Default is outside, which allows the layer to draw up to the mpWindow border.
drawModeOutside | The draw mode to be set |
Definition at line 281 of file mathplot.h.
Referenced by CURSOR::CURSOR(), and TRACE::TRACE().
|
inlineinherited |
Set layer font.
font | Font, will be copied to internal class member |
Definition at line 272 of file mathplot.h.
|
inlineinherited |
Set layer name.
name | Name, will be copied to internal class member |
Definition at line 267 of file mathplot.h.
References name.
|
inlineinherited |
Set layer pen.
pen | Pen, will be copied to internal class member |
Definition at line 277 of file mathplot.h.
Referenced by SIM_PLOT_PANEL::EnableCursor(), and SIM_PLOT_PANEL::UpdateTraceStyle().
|
virtual |
Definition at line 3557 of file mathplot.cpp.
References m_scaleX, m_scaleY, and UpdateScales().
Referenced by SIM_PLOT_PANEL::addTrace().
|
inlineinherited |
Sets layer visibility.
show | visibility bool. |
Definition at line 302 of file mathplot.h.
Referenced by mpWindow::SetLayerVisible(), SIM_PLOT_PANEL::ShowLegend(), and SIM_PLOT_PANEL::SIM_PLOT_PANEL().
|
inlineinherited |
Shows or hides the text label with the name of the layer (default is visible).
Definition at line 262 of file mathplot.h.
Referenced by TRACE::TRACE().
void mpFXY::UpdateScales | ( | ) |
Definition at line 3566 of file mathplot.cpp.
References mpScaleBase::ExtendDataRange(), mpLayer::GetMaxX(), mpLayer::GetMaxY(), mpLayer::GetMinX(), mpLayer::GetMinY(), m_scaleX, and m_scaleY.
Referenced by SetScale().
|
protected |
Update label positioning data.
xnew | New x coordinate |
ynew | New y coordinate |
Definition at line 552 of file mathplot.cpp.
References maxDrawX, maxDrawY, minDrawX, and minDrawY.
Referenced by Plot().
double mpFXY::x2s | ( | double | x | ) | const |
Definition at line 3588 of file mathplot.cpp.
References m_scaleX, and mpScaleBase::TransformToPlot().
Referenced by CURSOR::Inside(), CURSOR::Plot(), and CURSOR::UpdateReference().
double mpFXY::y2s | ( | double | y | ) | const |
Definition at line 3594 of file mathplot.cpp.
References m_scaleY, and mpScaleBase::TransformToPlot().
Referenced by CURSOR::Inside(), CURSOR::Plot(), and CURSOR::UpdateReference().
|
protectedinherited |
Definition at line 316 of file mathplot.h.
|
protectedinherited |
Definition at line 318 of file mathplot.h.
Referenced by CURSOR::Plot(), Plot(), and mpMovableObject::Plot().
|
protectedinherited |
Definition at line 320 of file mathplot.h.
Referenced by mpScaleXBase::getVisibleDataRange(), mpScaleY::getVisibleDataRange(), CURSOR::Plot(), mpFX::Plot(), mpFY::Plot(), Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().
|
protected |
Definition at line 628 of file mathplot.h.
Referenced by Plot().
|
protectedinherited |
Definition at line 314 of file mathplot.h.
Referenced by mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().
|
protectedinherited |
Definition at line 317 of file mathplot.h.
Referenced by mpFX::Plot(), mpFY::Plot(), Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().
|
protectedinherited |
Definition at line 315 of file mathplot.h.
Referenced by mpLayer::GetColourSquare(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), and mpMovableObject::Plot().
|
protected |
Definition at line 633 of file mathplot.h.
Referenced by Plot(), s2x(), SetScale(), UpdateScales(), and x2s().
|
protected |
Definition at line 633 of file mathplot.h.
Referenced by Plot(), s2y(), SetScale(), UpdateScales(), and y2s().
|
protectedinherited |
Definition at line 319 of file mathplot.h.
Referenced by mpFX::Plot(), mpFY::Plot(), Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().
|
protectedinherited |
Definition at line 321 of file mathplot.h.
Referenced by mpInfoLayer::mpInfoLayer().
|
protectedinherited |
Definition at line 322 of file mathplot.h.
Referenced by CURSOR::Plot(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().
|
protected |
Definition at line 631 of file mathplot.h.
Referenced by Plot(), and UpdateViewBoundary().
|
protected |
Definition at line 631 of file mathplot.h.
Referenced by Plot(), and UpdateViewBoundary().
|
protected |
Definition at line 631 of file mathplot.h.
Referenced by Plot(), and UpdateViewBoundary().
|
protected |
Definition at line 631 of file mathplot.h.
Referenced by Plot(), and UpdateViewBoundary().