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) |
virtual void | ResetDataRange () |
double | AbsMaxValue () const |
double | AbsVisibleMaxValue () 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 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 () |
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 |
bool | m_axisLocked |
double | m_axisMin |
double | m_axisMax |
int | m_maxLabelHeight |
int | m_maxLabelWidth |
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 |
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 613 of file mathplot.h.
mpScaleBase::mpScaleBase | ( | ) |
Definition at line 767 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 617 of file mathplot.h.
|
inline |
Definition at line 673 of file mathplot.h.
References std::abs().
|
inline |
Definition at line 678 of file mathplot.h.
|
protected |
Definition at line 788 of file mathplot.cpp.
References m_maxLabelHeight, m_maxLabelWidth, and m_tickLabels.
Referenced by updateTickLabels().
|
inlinevirtual |
Reimplemented in TIME_SCALE.
Definition at line 647 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlineprotectedvirtual |
Reimplemented in LIN_SCALE< mpScaleX >.
Definition at line 731 of file mathplot.h.
Referenced by updateTickLabels().
|
inline |
Definition at line 690 of file mathplot.h.
Referenced by SIM_PLOT_TAB::GetY1Scale(), SIM_PLOT_TAB::GetY2Scale(), and SIM_PLOT_TAB::GetY3Scale().
|
inlineinherited |
|
inlineinherited |
Gets the 'continuity' property of the layer.
Definition at line 264 of file mathplot.h.
|
inline |
Definition at line 641 of file mathplot.h.
Referenced by mpScaleX::recalculateTicks(), and mpScaleXLog::recalculateTicks().
|
inlineinherited |
Definition at line 241 of file mathplot.h.
Referenced by mpInfoLegend::Plot().
|
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 287 of file mathplot.h.
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.
Referenced by SIM_PLOT_TAB::GetLabelX(), SIM_PLOT_TAB::GetLabelY1(), SIM_PLOT_TAB::GetLabelY2(), SIM_PLOT_TAB::GetLabelY3(), SIMULATOR_FRAME_UI::updatePlotCursors(), and SIM_PLOT_TAB::UpdateTraceStyle().
|
inlineinherited |
Get pen set for this layer.
Definition at line 254 of file mathplot.h.
Referenced by CURSOR::Plot(), mpInfoLegend::Plot(), and SIMULATOR_FRAME_UI::rebuildSignalsGrid().
|
inline |
Get X axis ticks or grid.
Definition at line 639 of file mathplot.h.
Referenced by SIM_PLOT_TAB::IsGridShown().
|
inlineprotectedvirtual |
Reimplemented in mpScaleXBase, and mpScaleY.
Definition at line 728 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 621 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 171 of file mathplot.h.
|
inlineinherited |
Checks whether the layer is visible or not.
Definition at line 291 of file mathplot.h.
Referenced by SIM_PLOT_TAB::IsLegendShown(), 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, mpInfoLayer, mpInfoLegend, mpFX, mpFY, mpFXY, mpScaleXBase, and mpScaleY.
|
inlineprotectedvirtual |
Reimplemented in mpScaleX, mpScaleXLog, and mpScaleY.
Definition at line 729 of file mathplot.h.
Referenced by mpScaleXBase::Plot().
|
inlinevirtual |
Reimplemented in TIME_SCALE.
Definition at line 668 of file mathplot.h.
Referenced by SIM_PLOT_TAB::ResetScales().
|
inline |
Set X axis alignment.
align | alignment (choose between mpALIGN_BORDER_BOTTOM, mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP, mpALIGN_BORDER_TOP |
Definition at line 627 of file mathplot.h.
|
inline |
Definition at line 683 of file mathplot.h.
Referenced by SIM_PLOT_TAB::SetY1Scale(), SIM_PLOT_TAB::SetY2Scale(), and SIM_PLOT_TAB::SetY3Scale().
|
inlineinherited |
Set layer brush.
brush | brush, will be copied to internal class member |
Definition at line 303 of file mathplot.h.
|
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.
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.
Referenced by SIM_PLOT_TAB::updateAxes().
|
inlinevirtualinherited |
Set layer name.
name | Name, 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().
|
inline |
Definition at line 629 of file mathplot.h.
Referenced by SIM_PLOT_TAB::EnsureThirdYAxisExists(), SIM_PLOT_TAB::prepareDCAxes(), and SIM_PLOT_TAB::updateAxes().
|
inlineinherited |
Set layer pen.
pen | Pen, will be copied to internal class member |
Definition at line 283 of file mathplot.h.
Referenced by SIM_PLOT_TAB::UpdateTraceStyle().
|
inline |
Set X axis ticks or grid.
enable | = true to plot axis ticks, false to plot grid. |
Definition at line 634 of file mathplot.h.
Referenced by SIM_PLOT_TAB::ShowGrid().
|
inlineinherited |
Sets layer visibility.
show | visibility bool. |
Definition at line 295 of file mathplot.h.
Referenced by SIM_PLOT_TAB::ShowLegend(), and SIM_PLOT_TAB::SIM_PLOT_TAB().
|
inlineinherited |
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().
|
inlinevirtual |
Reimplemented in mpScaleX, mpScaleXLog, and mpScaleY.
Definition at line 707 of file mathplot.h.
Referenced by mpScaleXBase::getVisibleDataRange(), mpFXY::s2x(), and mpFXY::s2y().
|
inlinevirtual |
Reimplemented in mpScaleX, mpScaleXLog, and mpScaleY.
Definition at line 706 of file mathplot.h.
Referenced by mpFXY::Plot(), mpScaleXBase::Plot(), mpFXY::x2s(), and mpFXY::y2s().
|
protected |
Definition at line 805 of file mathplot.cpp.
References computeLabelExtents(), and formatLabels().
Referenced by mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and mpScaleY::recalculateTicks().
|
protected |
Definition at line 738 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), mpScaleBase(), mpScaleX::recalculateTicks(), and mpScaleY::recalculateTicks().
|
protected |
Definition at line 744 of file mathplot.h.
Referenced by mpScaleBase(), and mpScaleY::recalculateTicks().
|
protected |
Definition at line 746 of file mathplot.h.
Referenced by mpScaleBase(), and mpScaleY::recalculateTicks().
|
protected |
Definition at line 745 of file mathplot.h.
Referenced by mpScaleBase(), and mpScaleY::recalculateTicks().
|
protectedinherited |
Definition at line 309 of file mathplot.h.
|
protectedinherited |
Definition at line 312 of file mathplot.h.
Referenced by CURSOR::Plot(), and mpFXY::Plot().
|
protectedinherited |
Definition at line 311 of file mathplot.h.
Referenced by TRACE::SetName().
|
protected |
Definition at line 739 of file mathplot.h.
Referenced by mpScaleBase(), and mpScaleXBase::Plot().
|
protectedinherited |
Definition at line 307 of file mathplot.h.
Referenced by mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().
|
protected |
Definition at line 747 of file mathplot.h.
Referenced by computeLabelExtents(), mpScaleBase(), and mpScaleXBase::Plot().
|
protected |
Definition at line 748 of file mathplot.h.
Referenced by computeLabelExtents(), and mpScaleBase().
|
protected |
Definition at line 742 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), TIME_SCALE::ExtendDataRange(), mpScaleBase(), mpScaleXBase::Plot(), mpScaleY::Plot(), TIME_SCALE::ResetDataRange(), mpScaleXLog::TransformFromPlot(), and mpScaleXLog::TransformToPlot().
|
protected |
Definition at line 742 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), TIME_SCALE::ExtendDataRange(), mpScaleBase(), mpScaleXBase::Plot(), mpScaleY::Plot(), TIME_SCALE::ResetDataRange(), mpScaleXLog::TransformFromPlot(), and mpScaleXLog::TransformToPlot().
|
protectedinherited |
Definition at line 310 of file mathplot.h.
Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().
|
protected |
Definition at line 740 of file mathplot.h.
Referenced by mpScaleBase(), mpScaleXBase::Plot(), and mpScaleY::Plot().
|
protected |
Definition at line 737 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 |
Definition at line 308 of file mathplot.h.
Referenced by mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().
|
protected |
Definition at line 743 of file mathplot.h.
Referenced by mpScaleBase(), and TIME_SCALE::ResetDataRange().
|
protected |
Definition at line 737 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 |
Definition at line 313 of file mathplot.h.
Referenced by mpFX::Plot(), mpFY::Plot(), and mpFXY::Plot().
|
protected |
Definition at line 735 of file mathplot.h.
Referenced by computeLabelExtents(), mpScaleY::computeSlaveTicks(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and mpScaleY::recalculateTicks().
|
protected |
Definition at line 741 of file mathplot.h.
Referenced by mpScaleBase(), and mpScaleXBase::Plot().
|
protected |
Definition at line 734 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and mpScaleY::recalculateTicks().
|
protectedinherited |
Definition at line 314 of file mathplot.h.
Referenced by mpInfoLayer::mpInfoLayer().
|
protectedinherited |
Definition at line 315 of file mathplot.h.
Referenced by CURSOR::Plot(), mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().