|
KiCad PCB EDA Suite
|
Plot layer implementing a x-scale ruler. More...
#include <mathplot.h>
Classes | |
| struct | TICK_LABEL |
Public Member Functions | |
| mpScaleBase () | |
| virtual | ~mpScaleBase () |
| virtual bool | IsHorizontal () const =0 |
| bool | HasBBox () const override |
| Check whether this layer has a bounding box. | |
| void | SetAlign (int align) |
| Set X axis alignment. | |
| void | SetNameAlign (int align) |
| void | SetTicks (bool enable) |
| Set X axis ticks or grid. | |
| bool | GetTicks () const |
| Get X axis ticks or grid. | |
| void | GetDataRange (double &minV, double &maxV) const |
| virtual void | ExtendDataRange (double minV, double maxV) |
| void | SetDataRange (double minV, double maxV) |
| Force this axis' data range to an explicit [minV, maxV], as if it had been computed by ExtendDataRange(). | |
| virtual void | ResetDataRange () |
| True once ExtendDataRange()/SetDataRange() has established a real data range. | |
| bool | IsRangeSet () const |
| double | AbsMaxValue () const |
| double | AbsVisibleMaxValue () const |
| int | GetMaxLabelWidth () const |
| void | SetAxisMinMax (bool lock, double minV, double maxV) |
| bool | GetAxisMinMax (double *minV, double *maxV) |
| virtual double | TransformToPlot (double x) const |
| virtual double | TransformFromPlot (double xplot) const |
| 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 wxFont & | GetPlotFont () const |
| Get the font to draw this layer with, which is the default one when none was set. | |
| 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 Member Functions | |
| void | updateTickLabels (wxDC &dc, mpWindow &w) |
| void | computeLabelExtents (wxDC &dc, mpWindow &w) |
| virtual void | getVisibleDataRange (mpWindow &w, double &minV, double &maxV) |
| virtual void | recalculateTicks (wxDC &dc, mpWindow &w) |
| virtual void | formatLabels () |
| void | updateDisplayRange () |
| Padding a running hull after every trace would make the result depend on trace order. | |
Protected Attributes | |
| std::vector< double > | m_tickValues |
| std::vector< TICK_LABEL > | m_tickLabels |
| double | m_offset |
| double | m_scale |
| double | m_absVisibleMaxV |
| int | m_flags |
| int | m_nameFlags |
| bool | m_ticks |
| double | m_minV |
| double | m_maxV |
| bool | m_rangeSet |
| double | m_dataMinV = 0.0 |
| double | m_dataMaxV = 0.0 |
| bool | m_axisLocked |
| double | m_axisMin |
| double | m_axisMax |
| int | m_maxLabelHeight |
| int | m_maxLabelWidth |
| wxFont | m_font |
| Layer's font. | |
| wxPen | m_pen |
| Layer's pen. | |
| wxBrush | m_brush |
| Layer's brush. | |
| wxString | m_name |
| Layer's name. | |
| wxString | m_displayName |
| bool | m_continuous |
| Specify if the layer will be plotted as a continuous line or a set of points. | |
| bool | m_showName |
| States whether the name of the layer must be shown (default is true). | |
| mpLayerType | m_type |
| Define layer type, which is assigned by constructor. | |
| bool | m_visible |
| Toggles layer visibility. | |
Plot layer implementing a x-scale ruler.
The ruler is fixed at Y=0 in the coordinate system. A label is plotted at the bottom-right hand of the ruler. The scale numbering automatically adjusts to view and zoom factor.
Definition at line 680 of file mathplot.h.
| mpScaleBase::mpScaleBase | ( | ) |
Definition at line 854 of file mathplot.cpp.
References m_absVisibleMaxV, m_axisLocked, m_axisMax, m_axisMin, m_flags, m_maxLabelHeight, m_maxLabelWidth, m_maxV, m_minV, m_nameFlags, m_offset, m_rangeSet, m_scale, m_ticks, and mpALIGN_BORDER_BOTTOM.
|
inlinevirtual |
Definition at line 684 of file mathplot.h.
|
inline |
Definition at line 752 of file mathplot.h.
References std::abs(), m_maxV, and m_minV.
|
inline |
Definition at line 757 of file mathplot.h.
References m_absVisibleMaxV.
|
protected |
Definition at line 875 of file mathplot.cpp.
References dc, m_maxLabelHeight, m_maxLabelWidth, and m_tickLabels.
Referenced by updateTickLabels().
|
inlinevirtual |
Reimplemented in TIME_SCALE.
Definition at line 714 of file mathplot.h.
References m_dataMaxV, m_dataMinV, m_rangeSet, and updateDisplayRange().
Referenced by BOOST_AUTO_TEST_CASE().
|
inlineprotectedvirtual |
Reimplemented in LIN_SCALE< mpScaleX >.
Definition at line 812 of file mathplot.h.
Referenced by updateTickLabels().
|
inline |
Definition at line 771 of file mathplot.h.
References m_axisLocked, m_axisMax, m_axisMin, and m_tickValues.
|
inlineinherited |
Get brush set for this layer.
Definition at line 361 of file mathplot.h.
References m_brush.
|
inlineinherited |
Gets the 'continuity' property of the layer.
Definition at line 326 of file mathplot.h.
References m_continuous.
|
inline |
Definition at line 708 of file mathplot.h.
References m_maxV, and m_minV.
Referenced by BOOST_AUTO_TEST_CASE(), SIM_PLOT_TAB::getYScale(), mpScaleX::recalculateTicks(), and mpScaleXLog::recalculateTicks().
|
inlineinherited |
Definition at line 287 of file mathplot.h.
References m_displayName, and m_name.
Referenced by mpInfoLegend::Plot().
|
inlineinherited |
Get font set for this layer.
Invalid if none was set.
Definition at line 295 of file mathplot.h.
References m_font.
Referenced by BOOST_AUTO_TEST_CASE().
|
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 349 of file mathplot.h.
References m_type.
Referenced by mpInfoLegend::Plot().
|
inline |
Definition at line 762 of file mathplot.h.
References m_maxLabelWidth.
|
inlinevirtualinherited |
Get inclusive right border of bounding box.
Reimplemented in mpFXYVector.
Definition at line 227 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlinevirtualinherited |
Get inclusive top border of bounding box.
Reimplemented in mpFXYVector.
Definition at line 237 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlinevirtualinherited |
Get inclusive left border of bounding box.
Reimplemented in mpFXYVector.
Definition at line 222 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlinevirtualinherited |
Get inclusive bottom border of bounding box.
Reimplemented in mpFXYVector.
Definition at line 232 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlineinherited |
Get layer name.
Definition at line 285 of file mathplot.h.
References m_name.
Referenced by SIMULATOR_FRAME_UI::ToggleSmithChart(), SIMULATOR_FRAME_UI::updatePlotCursors(), and SIMULATOR_FRAME_UI::updateTrace().
|
inlineinherited |
Get pen set for this layer.
Definition at line 316 of file mathplot.h.
References m_pen.
Referenced by SIMULATOR_FRAME_UI::onSignalsTreeMenuSelection(), CURSOR::Plot(), mpInfoLegend::Plot(), SMITH_CURSOR::Plot(), SIMULATOR_FRAME_UI::refreshMeasurementGroupIcons(), and SIMULATOR_FRAME_UI::updateSignalsTree().
|
inlineinherited |
Get the font to draw this layer with, which is the default one when none was set.
The stock fonts are built on first use from the running toolkit, so this must not be called before there is one; layers resolve their font when they plot, not when they are constructed.
Definition at line 305 of file mathplot.h.
References m_font.
Referenced by BOOST_AUTO_TEST_CASE(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpInfoLegend::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), SMITH_CURSOR::Plot(), SMITH_GRID::Plot(), and TRACK_CURSOR::Plot().
|
inline |
Get X axis ticks or grid.
Definition at line 706 of file mathplot.h.
References m_ticks.
|
inlineprotectedvirtual |
Reimplemented in mpScaleXBase, and mpScaleY.
Definition at line 809 of file mathplot.h.
|
inlineoverridevirtual |
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 from mpLayer.
Reimplemented in mpScaleY.
Definition at line 688 of file mathplot.h.
|
pure virtual |
Implemented in mpScaleXBase, and mpScaleY.
|
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 217 of file mathplot.h.
|
inline |
Definition at line 750 of file mathplot.h.
References m_rangeSet.
Referenced by SIM_PLOT_TAB::getYScale().
|
inlineinherited |
Checks whether the layer is visible or not.
Definition at line 353 of file mathplot.h.
References m_visible.
Referenced by mpWindow::IsLayerVisible(), and mpInfoLegend::Plot().
|
pure virtualinherited |
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 | Device context to plot to. |
| w | View to plot. The visible area can be retrieved from this object. |
Implemented in CURSOR, mpFX, mpFXY, mpFY, mpInfoLayer, mpInfoLegend, mpScaleXBase, mpScaleY, SMITH_CURSOR, SMITH_GRID, SMITH_TRACE, and TRACK_CURSOR.
References dc.
|
inlineprotectedvirtual |
Reimplemented in mpScaleX, mpScaleXLog, and mpScaleY.
Definition at line 810 of file mathplot.h.
References dc.
Referenced by mpScaleXBase::Plot().
|
inlinevirtual |
True once ExtendDataRange()/SetDataRange() has established a real data range.
Reimplemented in TIME_SCALE.
Definition at line 744 of file mathplot.h.
References m_rangeSet.
|
inline |
Set X axis alignment.
| align | alignment (choose between mpALIGN_BORDER_BOTTOM, mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP, mpALIGN_BORDER_TOP |
Definition at line 694 of file mathplot.h.
References m_flags.
|
inline |
Definition at line 764 of file mathplot.h.
References m_axisLocked, m_axisMax, and m_axisMin.
|
inlineinherited |
Set layer brush.
| brush | brush, will be copied to internal class member |
Definition at line 365 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 321 of file mathplot.h.
References m_continuous.
Referenced by TRACE::TRACE().
|
inline |
Force this axis' data range to an explicit [minV, maxV], as if it had been computed by ExtendDataRange().
Used to synchronize the Y-axis range across views when signals are routed to share another view's Y-axis scale (see SIM_PLOT_TAB's "Y Scale" column).
Definition at line 735 of file mathplot.h.
References m_dataMaxV, m_dataMinV, m_rangeSet, and updateDisplayRange().
Referenced by TIME_SCALE::ResetDataRange().
|
inlineinherited |
Set layer font.
| font | Font, will be copied to internal class member |
Definition at line 340 of file mathplot.h.
References m_font.
Referenced by BOOST_AUTO_TEST_CASE().
|
inlinevirtualinherited |
Set layer name.
| name | Name, will be copied to internal class member |
Reimplemented in TRACE.
Definition at line 335 of file mathplot.h.
Referenced by mpFX::mpFX(), mpFXY::mpFXY(), mpFY::mpFY(), mpScaleXBase::mpScaleXBase(), mpScaleY::mpScaleY(), and TRACE::SetName().
|
inline |
Definition at line 696 of file mathplot.h.
References m_nameFlags.
|
inlineinherited |
Set layer pen.
| pen | Pen, will be copied to internal class member |
Definition at line 345 of file mathplot.h.
References m_pen.
Referenced by mpLayer(), mpScaleXBase::mpScaleXBase(), mpScaleY::mpScaleY(), and SIM_PLOT_TAB::UpdateTraceStyle().
|
inline |
Set X axis ticks or grid.
| enable | = true to plot axis ticks, false to plot grid. |
Definition at line 701 of file mathplot.h.
References m_ticks.
|
inlineinherited |
Sets layer visibility.
| show | visibility bool. |
Definition at line 357 of file mathplot.h.
References m_visible.
Referenced by SIM_PLOT_TAB::AddView(), TRACK_CURSOR::SetHidden(), and TRACK_CURSOR::SetPlotX().
|
inlineinherited |
Shows or hides the text label with the name of the layer (default is visible).
Definition at line 330 of file mathplot.h.
References m_showName.
Referenced by TRACE::TRACE().
|
inlinevirtual |
Reimplemented in mpScaleX, mpScaleXLog, and mpScaleY.
Definition at line 788 of file mathplot.h.
Referenced by mpScaleXBase::getVisibleDataRange().
|
inlinevirtual |
Reimplemented in mpScaleX, mpScaleXLog, and mpScaleY.
Definition at line 787 of file mathplot.h.
Referenced by mpScaleXBase::Plot().
|
inlineprotected |
Padding a running hull after every trace would make the result depend on trace order.
Definition at line 816 of file mathplot.h.
References m_dataMaxV, m_dataMinV, m_maxV, m_minV, mpIsDegenerateRange(), and mpPadDegenerateRange().
Referenced by ExtendDataRange(), and SetDataRange().
|
protected |
Definition at line 892 of file mathplot.cpp.
References computeLabelExtents(), dc, and formatLabels().
Referenced by mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and mpScaleY::recalculateTicks().
|
protected |
Definition at line 829 of file mathplot.h.
Referenced by AbsVisibleMaxValue(), mpScaleY::computeSlaveTicks(), mpScaleBase(), mpScaleX::recalculateTicks(), and mpScaleY::recalculateTicks().
|
protected |
Definition at line 837 of file mathplot.h.
Referenced by GetAxisMinMax(), mpScaleBase(), mpScaleY::recalculateTicks(), and SetAxisMinMax().
|
protected |
Definition at line 839 of file mathplot.h.
Referenced by GetAxisMinMax(), mpScaleBase(), mpScaleY::recalculateTicks(), and SetAxisMinMax().
|
protected |
Definition at line 838 of file mathplot.h.
Referenced by GetAxisMinMax(), mpScaleBase(), mpScaleY::recalculateTicks(), and SetAxisMinMax().
|
protectedinherited |
Layer's brush.
Definition at line 371 of file mathplot.h.
Referenced by GetBrush(), mpInfoLayer::mpInfoLayer(), mpInfoLayer::mpInfoLayer(), mpInfoLayer::Plot(), and SetBrush().
|
protectedinherited |
Specify if the layer will be plotted as a continuous line or a set of points.
Definition at line 374 of file mathplot.h.
Referenced by GetContinuity(), mpLayer(), CURSOR::Plot(), mpFXY::Plot(), and SetContinuity().
|
protected |
Definition at line 836 of file mathplot.h.
Referenced by ExtendDataRange(), SetDataRange(), and updateDisplayRange().
|
protected |
Definition at line 835 of file mathplot.h.
Referenced by ExtendDataRange(), SetDataRange(), and updateDisplayRange().
|
protectedinherited |
Definition at line 373 of file mathplot.h.
Referenced by GetDisplayName(), and TRACE::SetName().
|
protected |
Definition at line 830 of file mathplot.h.
Referenced by mpScaleBase(), mpScaleXBase::mpScaleXBase(), mpScaleXBase::Plot(), and SetAlign().
|
protectedinherited |
Layer's font.
Definition at line 369 of file mathplot.h.
Referenced by GetFont(), GetPlotFont(), and SetFont().
|
protected |
Definition at line 840 of file mathplot.h.
Referenced by computeLabelExtents(), mpScaleBase(), and mpScaleXBase::Plot().
|
protected |
Definition at line 841 of file mathplot.h.
Referenced by computeLabelExtents(), GetMaxLabelWidth(), and mpScaleBase().
|
protected |
Definition at line 833 of file mathplot.h.
Referenced by AbsMaxValue(), mpScaleY::computeSlaveTicks(), TIME_SCALE::ExtendDataRange(), GetDataRange(), mpScaleBase(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleXLog::TransformFromPlot(), mpScaleXLog::TransformToPlot(), and updateDisplayRange().
|
protected |
Definition at line 833 of file mathplot.h.
Referenced by AbsMaxValue(), mpScaleY::computeSlaveTicks(), TIME_SCALE::ExtendDataRange(), GetDataRange(), mpScaleBase(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleXLog::TransformFromPlot(), mpScaleXLog::TransformToPlot(), and updateDisplayRange().
|
protectedinherited |
Layer's name.
Definition at line 372 of file mathplot.h.
Referenced by GetDisplayName(), GetName(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), and SetName().
|
protected |
Definition at line 831 of file mathplot.h.
Referenced by mpScaleBase(), mpScaleY::mpScaleY(), mpScaleXBase::Plot(), mpScaleY::Plot(), and SetNameAlign().
|
protected |
Definition at line 828 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), mpScaleBase(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleY::recalculateTicks(), mpScaleX::TransformFromPlot(), mpScaleY::TransformFromPlot(), mpScaleX::TransformToPlot(), and mpScaleY::TransformToPlot().
|
protectedinherited |
Layer's pen.
Definition at line 370 of file mathplot.h.
Referenced by GetPen(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), SMITH_GRID::Plot(), SMITH_TRACE::Plot(), and SetPen().
|
protected |
Definition at line 834 of file mathplot.h.
Referenced by ExtendDataRange(), IsRangeSet(), mpScaleBase(), ResetDataRange(), and SetDataRange().
|
protected |
Definition at line 828 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), mpScaleBase(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleY::recalculateTicks(), mpScaleX::TransformFromPlot(), mpScaleY::TransformFromPlot(), mpScaleX::TransformToPlot(), and mpScaleY::TransformToPlot().
|
protectedinherited |
States whether the name of the layer must be shown (default is true).
Definition at line 375 of file mathplot.h.
Referenced by mpLayer(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), and ShowName().
|
protected |
Definition at line 826 of file mathplot.h.
Referenced by computeLabelExtents(), mpScaleY::computeSlaveTicks(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and mpScaleY::recalculateTicks().
|
protected |
Definition at line 832 of file mathplot.h.
Referenced by GetTicks(), mpScaleBase(), mpScaleXBase::mpScaleXBase(), mpScaleXBase::Plot(), and SetTicks().
|
protected |
Definition at line 825 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), GetAxisMinMax(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and mpScaleY::recalculateTicks().
|
protectedinherited |
Define layer type, which is assigned by constructor.
Definition at line 376 of file mathplot.h.
Referenced by GetLayerType(), mpFX::mpFX(), mpFXY::mpFXY(), mpFXYVector::mpFXYVector(), mpFY::mpFY(), mpInfoLayer::mpInfoLayer(), mpInfoLayer::mpInfoLayer(), mpLayer(), mpScaleXBase::mpScaleXBase(), mpScaleY::mpScaleY(), and SMITH_GRID::SMITH_GRID().
|
protectedinherited |
Toggles layer visibility.
Definition at line 377 of file mathplot.h.
Referenced by IsVisible(), mpLayer(), CURSOR::Plot(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), SMITH_CURSOR::Plot(), SMITH_GRID::Plot(), SMITH_TRACE::Plot(), TRACK_CURSOR::Plot(), SetVisible(), and TRACK_CURSOR::TRACK_CURSOR().