KiCad PCB EDA Suite
|
A class providing graphs functionality for a 2D plot (either continuous or a set of points), from vectors of data. More...
#include <mathplot.h>
Public Member Functions | |
mpFXYVector (const wxString &name=wxEmptyString, int flags=mpALIGN_NE) | |
virtual | ~mpFXYVector () |
virtual void | SetData (const std::vector< double > &xs, const std::vector< double > &ys) |
Changes the internal data: the set of points to draw. More... | |
void | Clear () |
Clears all the data, leaving the layer empty. More... | |
double | GetMinX () const override |
Returns the actual minimum X data (loaded in SetData). More... | |
double | GetMinY () const override |
Returns the actual minimum Y data (loaded in SetData). More... | |
double | GetMaxX () const override |
Returns the actual maximum X data (loaded in SetData). More... | |
double | GetMaxY () const override |
Returns the actual maximum Y data (loaded in SetData). More... | |
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... | |
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 Member Functions | |
void | Rewind () override |
Rewind value enumeration with mpFXY::GetNextXY. More... | |
bool | GetNextXY (double &x, double &y) override |
Get locus value for next N. More... | |
size_t | GetCount () const override |
void | UpdateViewBoundary (wxCoord xnew, wxCoord ynew) |
Update label positioning data. More... | |
Protected Attributes | |
std::vector< double > | m_xs |
The internal copy of the set of data to draw. More... | |
std::vector< double > | m_ys |
size_t | m_index |
The internal counter for the "GetNextXY" interface. More... | |
double | m_minX |
Loaded at SetData. More... | |
double | m_maxX |
double | m_minY |
double | m_maxY |
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 |
A class providing graphs functionality for a 2D plot (either continuous or a set of points), from vectors of data.
This class can be used directly, the user does not need to derive any new class. Simply pass the data as two vectors with the same length containing the X and Y coordinates to the method SetData.
To generate a graph with a set of points, call
or
to render the sequence of coordinates as a continuous line.
(Added: Jose Luis Blanco, AGO-2007)
Definition at line 1571 of file mathplot.h.
mpFXYVector::mpFXYVector | ( | 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 2834 of file mathplot.cpp.
References mpLAYER_PLOT.
|
inlinevirtual |
Definition at line 1579 of file mathplot.h.
void mpFXYVector::Clear | ( | ) |
Clears all the data, leaving the layer empty.
Definition at line 2923 of file mathplot.cpp.
|
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.
|
overrideprotectedvirtual |
|
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().
|
inlineoverridevirtual |
Returns the actual maximum X data (loaded in SetData).
Reimplemented from mpLayer.
Definition at line 1630 of file mathplot.h.
|
inlineoverridevirtual |
Returns the actual maximum Y data (loaded in SetData).
Reimplemented from mpLayer.
Definition at line 1634 of file mathplot.h.
|
inlineoverridevirtual |
Returns the actual minimum X data (loaded in SetData).
Reimplemented from mpLayer.
Definition at line 1622 of file mathplot.h.
|
inlineoverridevirtual |
Returns the actual minimum Y data (loaded in SetData).
Reimplemented from mpLayer.
Definition at line 1626 of file mathplot.h.
|
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(), SIM_PLOT_PANEL::GetLabelY3(), mpInfoLegend::Plot(), mpText::Plot(), and SIMULATOR_FRAME::updateCursors().
|
overrideprotectedvirtual |
Get locus value for next N.
Overridden in this implementation.
x | Returns X value |
y | Returns Y value |
Implements mpFXY.
Definition at line 2908 of file mathplot.cpp.
|
inlineinherited |
Get pen set for this layer.
Definition at line 248 of file mathplot.h.
Referenced by CURSOR::Plot(), mpInfoLegend::Plot(), and SIMULATOR_FRAME::rebuildSignalsGrid().
|
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().
|
overridevirtualinherited |
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 564 of file mathplot.cpp.
References mpFXY::GetCount(), mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpFXY::GetNextXY(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpLayer::m_continuous, mpLayer::m_drawOutsideMargins, mpFXY::m_flags, mpLayer::m_font, mpLayer::m_name, mpLayer::m_pen, mpFXY::m_scaleX, mpFXY::m_scaleY, mpLayer::m_showName, mpLayer::m_visible, mpFXY::maxDrawX, mpFXY::maxDrawY, mpFXY::minDrawX, mpFXY::minDrawY, mpALIGN_NE, mpALIGN_NW, mpALIGN_SE, mpALIGNMASK, mpFXY::Rewind(), mpScaleBase::TransformToPlot(), mpFXY::UpdateViewBoundary(), mpWindow::x2p(), and mpWindow::y2p().
|
overrideprotectedvirtual |
Rewind value enumeration with mpFXY::GetNextXY.
Overridden in this implementation.
Implements mpFXY.
Definition at line 2897 of file mathplot.cpp.
References m_index.
|
inherited |
Definition at line 3592 of file mathplot.cpp.
References mpFXY::m_scaleX, and mpScaleBase::TransformFromPlot().
Referenced by CURSOR::Plot().
|
inherited |
Definition at line 3598 of file mathplot.cpp.
References mpFXY::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().
|
virtual |
Changes the internal data: the set of points to draw.
Both vectors MUST be of the same length. This method DOES NOT refresh the mpWindow; do it manually.
Reimplemented in TRACE.
Definition at line 2930 of file mathplot.cpp.
References m_maxX, m_maxY, m_minX, m_minY, m_xs, and m_ys.
Referenced by TRACE::SetData().
|
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.
|
inlinevirtualinherited |
Set layer name.
name | Name, will be copied to internal class member |
Reimplemented in TRACE.
Definition at line 267 of file mathplot.h.
References name.
Referenced by SIM_PLOT_PANEL::prepareDCAxes(), TRACE::SetName(), and SIM_PLOT_PANEL::updateAxes().
|
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::UpdateTraceStyle().
|
virtualinherited |
Definition at line 3573 of file mathplot.cpp.
References mpFXY::m_scaleX, mpFXY::m_scaleY, and mpFXY::UpdateScales().
Referenced by SIM_PLOT_PANEL::SetTraceData().
|
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().
|
inherited |
Definition at line 3582 of file mathplot.cpp.
References mpScaleBase::ExtendDataRange(), mpLayer::GetMaxX(), mpLayer::GetMaxY(), mpLayer::GetMinX(), mpLayer::GetMinY(), mpFXY::m_scaleX, and mpFXY::m_scaleY.
Referenced by mpFXY::SetScale().
|
protectedinherited |
Update label positioning data.
xnew | New x coordinate |
ynew | New y coordinate |
Definition at line 553 of file mathplot.cpp.
References mpFXY::maxDrawX, mpFXY::maxDrawY, mpFXY::minDrawX, and mpFXY::minDrawY.
Referenced by mpFXY::Plot().
|
inherited |
Definition at line 3604 of file mathplot.cpp.
References mpFXY::m_scaleX, and mpScaleBase::TransformToPlot().
Referenced by CURSOR::Inside(), CURSOR::Plot(), CURSOR::SetCoordX(), and CURSOR::UpdateReference().
|
inherited |
Definition at line 3610 of file mathplot.cpp.
References mpFXY::m_scaleY, and mpScaleBase::TransformToPlot().
Referenced by CURSOR::Inside(), CURSOR::Plot(), CURSOR::SetCoordX(), 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(), mpFXY::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(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().
|
protectedinherited |
Definition at line 630 of file mathplot.h.
Referenced by mpFXY::Plot().
|
protectedinherited |
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().
|
protected |
The internal counter for the "GetNextXY" interface.
Definition at line 1599 of file mathplot.h.
Referenced by GetNextXY(), and Rewind().
|
protected |
Definition at line 1603 of file mathplot.h.
Referenced by SetData().
|
protected |
Definition at line 1603 of file mathplot.h.
Referenced by SetData().
|
protected |
|
protected |
Definition at line 1603 of file mathplot.h.
Referenced by SetData().
|
protectedinherited |
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().
|
protectedinherited |
Definition at line 315 of file mathplot.h.
Referenced by mpLayer::GetColourSquare(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), and mpMovableObject::Plot().
|
protectedinherited |
Definition at line 635 of file mathplot.h.
Referenced by mpFXY::Plot(), mpFXY::s2x(), mpFXY::SetScale(), mpFXY::UpdateScales(), and mpFXY::x2s().
|
protectedinherited |
Definition at line 635 of file mathplot.h.
Referenced by mpFXY::Plot(), mpFXY::s2y(), mpFXY::SetScale(), mpFXY::UpdateScales(), and mpFXY::y2s().
|
protectedinherited |
Definition at line 319 of file mathplot.h.
Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::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(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().
|
protected |
The internal copy of the set of data to draw.
Definition at line 1595 of file mathplot.h.
Referenced by Clear(), GetCount(), TRACE::GetDataX(), GetNextXY(), and SetData().
|
protected |
Definition at line 1595 of file mathplot.h.
Referenced by Clear(), TRACE::GetDataY(), GetNextXY(), and SetData().
|
protectedinherited |
Definition at line 633 of file mathplot.h.
Referenced by mpFXY::Plot(), and mpFXY::UpdateViewBoundary().
|
protectedinherited |
Definition at line 633 of file mathplot.h.
Referenced by mpFXY::Plot(), and mpFXY::UpdateViewBoundary().
|
protectedinherited |
Definition at line 633 of file mathplot.h.
Referenced by mpFXY::Plot(), and mpFXY::UpdateViewBoundary().
|
protectedinherited |
Definition at line 633 of file mathplot.h.
Referenced by mpFXY::Plot(), and mpFXY::UpdateViewBoundary().