KiCad PCB EDA Suite
|
Plot layer implementing a y-scale ruler. More...
#include <mathplot.h>
Public Member Functions | |
mpScaleY (const wxString &name=wxT("Y"), int flags=mpALIGN_CENTER, bool ticks=true) | |
virtual bool | IsHorizontal () const override |
virtual void | Plot (wxDC &dc, mpWindow &w) override |
Layer plot handler. More... | |
virtual bool | HasBBox () const override |
Check whether this layer has a bounding box. More... | |
virtual double | TransformToPlot (double x) const override |
virtual double | TransformFromPlot (double xplot) const override |
void | SetMasterScale (mpScaleY *masterScale) |
void | SetAlign (int align) |
Set X axis alignment. More... | |
void | SetNameAlign (int align) |
void | SetTicks (bool enable) |
Set X axis ticks or grid. More... | |
bool | GetTicks () const |
Get X axis ticks or grid. More... | |
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 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 wxString & | GetDisplayName () const |
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 (const wxString &name) |
Set layer name. More... | |
void | SetFont (const wxFont &font) |
Set layer font. More... | |
void | SetPen (const wxPen &pen) |
Set layer pen. 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 (const wxBrush &brush) |
Set layer brush. More... | |
Protected Member Functions | |
virtual void | getVisibleDataRange (mpWindow &w, double &minV, double &maxV) override |
virtual void | recalculateTicks (wxDC &dc, mpWindow &w) override |
void | computeSlaveTicks (mpWindow &w) |
void | updateTickLabels (wxDC &dc, mpWindow &w) |
void | computeLabelExtents (wxDC &dc, mpWindow &w) |
virtual void | formatLabels () |
Protected Attributes | |
mpScaleY * | m_masterScale |
int | m_flags |
bool | m_ticks |
std::vector< double > | m_tickValues |
std::vector< TICK_LABEL > | m_tickLabels |
double | m_offset |
double | m_scale |
double | m_absVisibleMaxV |
int | m_nameFlags |
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 y-scale ruler.
If align is set to mpALIGN_CENTER, the ruler is fixed at X=0 in the coordinate system. If the align is set to mpALIGN_TOP or mpALIGN_BOTTOM, the axis is always drawn respectively at top or bottom of the window. A label is plotted at the top-right hand of the ruler. The scale numbering automatically adjusts to view and zoom factor.
Definition at line 826 of file mathplot.h.
mpScaleY::mpScaleY | ( | const wxString & | name = wxT( "Y" ) , |
int | flags = mpALIGN_CENTER , |
||
bool | ticks = true |
||
) |
name | Label to plot by the ruler |
flags | Set position of the scale respect to the window. |
ticks | Select ticks or grid. Give true (default) for drawing axis ticks, false for drawing the grid |
Definition at line 1162 of file mathplot.cpp.
References mpALIGN_BORDER_LEFT, mpLAYER_AXIS, and name.
|
inlineinherited |
Definition at line 672 of file mathplot.h.
References std::abs().
|
inlineinherited |
Definition at line 677 of file mathplot.h.
|
protectedinherited |
Definition at line 751 of file mathplot.cpp.
References mpScaleBase::m_maxLabelHeight, mpScaleBase::m_maxLabelWidth, and mpScaleBase::m_tickLabels.
Referenced by mpScaleBase::updateTickLabels().
|
protected |
Definition at line 788 of file mathplot.cpp.
References getVisibleDataRange(), mpScaleBase::m_absVisibleMaxV, m_masterScale, mpScaleBase::m_maxV, mpScaleBase::m_minV, mpScaleBase::m_offset, mpScaleBase::m_scale, mpScaleBase::m_tickLabels, mpScaleBase::m_tickValues, TransformFromPlot(), and TransformToPlot().
Referenced by recalculateTicks().
|
inlinevirtualinherited |
Reimplemented in TIME_SCALE.
Definition at line 646 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlineprotectedvirtualinherited |
Reimplemented in LIN_SCALE< mpScaleX >.
Definition at line 730 of file mathplot.h.
Referenced by mpScaleBase::updateTickLabels().
|
inlineinherited |
Definition at line 689 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 265 of file mathplot.h.
|
inlineinherited |
Definition at line 640 of file mathplot.h.
Referenced by mpScaleX::recalculateTicks(), and mpScaleXLog::recalculateTicks().
|
inlineinherited |
Definition at line 242 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 288 of file mathplot.h.
Referenced by mpInfoLegend::Plot().
|
inlinevirtualinherited |
Get inclusive right border of bounding box.
Reimplemented in mpFXYVector.
Definition at line 182 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlinevirtualinherited |
Get inclusive top border of bounding box.
Reimplemented in mpFXYVector.
Definition at line 192 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlinevirtualinherited |
Get inclusive left border of bounding box.
Reimplemented in mpFXYVector.
Definition at line 177 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlinevirtualinherited |
Get inclusive bottom border of bounding box.
Reimplemented in mpFXYVector.
Definition at line 187 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlineinherited |
Get layer name.
Definition at line 240 of file mathplot.h.
Referenced by SIM_PLOT_TAB::GetLabelX(), SIM_PLOT_TAB::GetLabelY1(), SIM_PLOT_TAB::GetLabelY2(), SIM_PLOT_TAB::GetLabelY3(), and SIMULATOR_FRAME_UI::updatePlotCursors().
|
inlineinherited |
Get pen set for this layer.
Definition at line 255 of file mathplot.h.
Referenced by CURSOR::Plot(), mpInfoLegend::Plot(), and SIMULATOR_FRAME_UI::rebuildSignalsGrid().
|
inlineinherited |
Get X axis ticks or grid.
Definition at line 638 of file mathplot.h.
Referenced by SIM_PLOT_TAB::IsGridShown().
|
overrideprotectedvirtual |
Reimplemented from mpScaleBase.
Definition at line 775 of file mathplot.cpp.
References mpWindow::GetMarginBottom(), mpWindow::GetMarginTop(), mpWindow::GetScrY(), mpWindow::p2y(), and TransformFromPlot().
Referenced by computeSlaveTicks(), and recalculateTicks().
|
inlineoverridevirtual |
Check whether this layer has a bounding box.
This implementation returns false thus making the ruler invisible to the plot layer bounding box calculation by mpWindow.
Reimplemented from mpScaleBase.
Definition at line 847 of file mathplot.h.
|
inlineoverridevirtual |
Implements mpScaleBase.
Definition at line 836 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 172 of file mathplot.h.
|
inlineinherited |
Checks whether the layer is visible or not.
Definition at line 292 of file mathplot.h.
Referenced by SIM_PLOT_TAB::IsLegendShown(), and mpInfoLegend::Plot().
|
overridevirtual |
Layer plot handler.
This implementation will plot the ruler adjusted to the visible area.
Implements mpLayer.
Definition at line 1175 of file mathplot.cpp.
References mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpWindow::GetPosY(), mpWindow::GetScaleY(), mpWindow::GetScrX(), mpWindow::GetScrY(), m_flags, mpLayer::m_font, mpScaleBase::m_maxV, mpScaleBase::m_minV, mpLayer::m_name, mpScaleBase::m_nameFlags, mpScaleBase::m_offset, mpLayer::m_pen, mpScaleBase::m_scale, mpScaleBase::m_tickLabels, m_ticks, mpScaleBase::m_tickValues, mpLayer::m_visible, mpALIGN_BORDER_LEFT, mpALIGN_BORDER_RIGHT, mpALIGN_CENTER, mpALIGN_FAR_RIGHT, mpALIGN_LEFT, mpALIGN_RIGHT, recalculateTicks(), tp, TransformToPlot(), and mpWindow::x2p().
|
overrideprotectedvirtual |
Reimplemented from mpScaleBase.
Definition at line 837 of file mathplot.cpp.
References std::abs(), computeSlaveTicks(), getVisibleDataRange(), mpWindow::GetYScreen(), mpScaleBase::m_absVisibleMaxV, mpScaleBase::m_axisLocked, mpScaleBase::m_axisMax, mpScaleBase::m_axisMin, m_masterScale, mpScaleBase::m_offset, mpScaleBase::m_scale, mpScaleBase::m_tickLabels, mpScaleBase::m_tickValues, and mpScaleBase::updateTickLabels().
Referenced by Plot().
|
inlinevirtualinherited |
Reimplemented in TIME_SCALE.
Definition at line 667 of file mathplot.h.
Referenced by SIM_PLOT_TAB::ResetScales().
|
inlineinherited |
Set X axis alignment.
align | alignment (choose between mpALIGN_BORDER_BOTTOM, mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP, mpALIGN_BORDER_TOP |
Definition at line 626 of file mathplot.h.
|
inlineinherited |
Definition at line 682 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 304 of file mathplot.h.
|
inlineinherited |
Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).
Definition at line 260 of file mathplot.h.
Referenced by TRACE::TRACE().
|
inlineinherited |
Set layer font.
font | Font, will be copied to internal class member |
Definition at line 279 of file mathplot.h.
Referenced by SIM_PLOT_TAB::updateAxes().
|
inline |
Definition at line 852 of file mathplot.h.
Referenced by SIM_PLOT_TAB::AddTrace(), SIM_PLOT_TAB::prepareDCAxes(), and SIM_PLOT_TAB::updateAxes().
|
inlinevirtualinherited |
Set layer name.
name | Name, will be copied to internal class member |
Reimplemented in TRACE.
Definition at line 274 of file mathplot.h.
References name.
Referenced by SIM_PLOT_TAB::prepareDCAxes(), TRACE::SetName(), and SIM_PLOT_TAB::updateAxes().
|
inlineinherited |
Definition at line 628 of file mathplot.h.
Referenced by 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 284 of file mathplot.h.
Referenced by SIM_PLOT_TAB::UpdateTraceStyle().
|
inlineinherited |
Set X axis ticks or grid.
enable | = true to plot axis ticks, false to plot grid. |
Definition at line 633 of file mathplot.h.
Referenced by SIM_PLOT_TAB::ShowGrid().
|
inlineinherited |
Sets layer visibility.
show | visibility bool. |
Definition at line 296 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 269 of file mathplot.h.
Referenced by TRACE::TRACE().
|
overridevirtual |
Reimplemented from mpScaleBase.
Definition at line 2310 of file mathplot.cpp.
References mpScaleBase::m_offset, and mpScaleBase::m_scale.
Referenced by computeSlaveTicks(), and getVisibleDataRange().
|
overridevirtual |
Reimplemented from mpScaleBase.
Definition at line 2304 of file mathplot.cpp.
References mpScaleBase::m_offset, and mpScaleBase::m_scale.
Referenced by computeSlaveTicks(), and Plot().
|
protectedinherited |
Definition at line 768 of file mathplot.cpp.
References mpScaleBase::computeLabelExtents(), and mpScaleBase::formatLabels().
Referenced by mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and recalculateTicks().
|
protectedinherited |
Definition at line 737 of file mathplot.h.
Referenced by computeSlaveTicks(), mpScaleBase::mpScaleBase(), mpScaleX::recalculateTicks(), and recalculateTicks().
|
protectedinherited |
Definition at line 743 of file mathplot.h.
Referenced by mpScaleBase::mpScaleBase(), and recalculateTicks().
|
protectedinherited |
Definition at line 745 of file mathplot.h.
Referenced by mpScaleBase::mpScaleBase(), and recalculateTicks().
|
protectedinherited |
Definition at line 744 of file mathplot.h.
Referenced by mpScaleBase::mpScaleBase(), and recalculateTicks().
|
protectedinherited |
Definition at line 310 of file mathplot.h.
|
protectedinherited |
Definition at line 313 of file mathplot.h.
Referenced by CURSOR::Plot(), and mpFXY::Plot().
|
protectedinherited |
Definition at line 312 of file mathplot.h.
Referenced by TRACE::SetName().
|
protected |
Definition at line 861 of file mathplot.h.
Referenced by Plot().
|
protectedinherited |
Definition at line 308 of file mathplot.h.
Referenced by mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and Plot().
|
protected |
Definition at line 860 of file mathplot.h.
Referenced by computeSlaveTicks(), and recalculateTicks().
|
protectedinherited |
Definition at line 746 of file mathplot.h.
Referenced by mpScaleBase::computeLabelExtents(), mpScaleBase::mpScaleBase(), and mpScaleXBase::Plot().
|
protectedinherited |
Definition at line 747 of file mathplot.h.
Referenced by mpScaleBase::computeLabelExtents(), and mpScaleBase::mpScaleBase().
|
protectedinherited |
Definition at line 741 of file mathplot.h.
Referenced by computeSlaveTicks(), TIME_SCALE::ExtendDataRange(), mpScaleBase::mpScaleBase(), mpScaleXBase::Plot(), Plot(), TIME_SCALE::ResetDataRange(), mpScaleXLog::TransformFromPlot(), and mpScaleXLog::TransformToPlot().
|
protectedinherited |
Definition at line 741 of file mathplot.h.
Referenced by computeSlaveTicks(), TIME_SCALE::ExtendDataRange(), mpScaleBase::mpScaleBase(), mpScaleXBase::Plot(), Plot(), TIME_SCALE::ResetDataRange(), mpScaleXLog::TransformFromPlot(), and mpScaleXLog::TransformToPlot().
|
protectedinherited |
Definition at line 311 of file mathplot.h.
Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and Plot().
|
protectedinherited |
Definition at line 739 of file mathplot.h.
Referenced by mpScaleBase::mpScaleBase(), mpScaleXBase::Plot(), and Plot().
|
protectedinherited |
Definition at line 736 of file mathplot.h.
Referenced by computeSlaveTicks(), mpScaleBase::mpScaleBase(), mpScaleXBase::Plot(), Plot(), recalculateTicks(), mpScaleX::TransformFromPlot(), TransformFromPlot(), mpScaleX::TransformToPlot(), and TransformToPlot().
|
protectedinherited |
Definition at line 309 of file mathplot.h.
Referenced by mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and Plot().
|
protectedinherited |
Definition at line 742 of file mathplot.h.
Referenced by mpScaleBase::mpScaleBase(), and TIME_SCALE::ResetDataRange().
|
protectedinherited |
Definition at line 736 of file mathplot.h.
Referenced by computeSlaveTicks(), mpScaleBase::mpScaleBase(), mpScaleXBase::Plot(), Plot(), recalculateTicks(), mpScaleX::TransformFromPlot(), TransformFromPlot(), mpScaleX::TransformToPlot(), and TransformToPlot().
|
protectedinherited |
Definition at line 314 of file mathplot.h.
Referenced by mpFX::Plot(), mpFY::Plot(), and mpFXY::Plot().
|
protectedinherited |
Definition at line 734 of file mathplot.h.
Referenced by mpScaleBase::computeLabelExtents(), computeSlaveTicks(), mpScaleXBase::Plot(), Plot(), mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and recalculateTicks().
|
protected |
Definition at line 862 of file mathplot.h.
Referenced by Plot().
|
protectedinherited |
Definition at line 733 of file mathplot.h.
Referenced by computeSlaveTicks(), mpScaleXBase::Plot(), Plot(), mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and recalculateTicks().
|
protectedinherited |
Definition at line 315 of file mathplot.h.
Referenced by mpInfoLayer::mpInfoLayer().
|
protectedinherited |
Definition at line 316 of file mathplot.h.
Referenced by CURSOR::Plot(), mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and Plot().