KiCad PCB EDA Suite
|
Plot layer implementing a x-scale ruler. More...
#include <mathplot.h>
Classes | |
struct | TickLabel |
Public Member Functions | |
mpScaleBase () | |
virtual | ~mpScaleBase () |
virtual bool | IsHorizontal () const =0 |
bool | HasBBox () const override |
Check whether this layer has a bounding box. More... | |
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 | SetDataRange (double minV, double maxV) |
void | GetDataRange (double &minV, double &maxV) const |
void | ExtendDataRange (double minV, double maxV) |
void | ResetDataRange () |
double | AbsMaxValue () const |
double | AbsVisibleMaxValue () const |
virtual double | TransformToPlot (double x) const |
virtual double | TransformFromPlot (double xplot) const |
std::vector< TickLabel > & | TickLabels () |
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... | |
virtual void | Plot (wxDC &dc, mpWindow &w)=0 |
Plot given view of layer to the given device context. 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 | 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) |
int | tickCount () const |
virtual int | labelCount () const |
virtual const wxString | formatLabel (double value, int nDigits) |
virtual void | formatLabels () |
virtual double | getTickPos (int n) const |
virtual double | getLabelPos (int n) const |
virtual wxString | getLabel (int n) const |
Protected Attributes | |
std::vector< double > | m_tickValues |
std::vector< TickLabel > | 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 |
int | m_maxLabelHeight |
int | m_maxLabelWidth |
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 |
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 695 of file mathplot.h.
mpScaleBase::mpScaleBase | ( | ) |
Definition at line 917 of file mathplot.cpp.
References m_absVisibleMaxV, 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 699 of file mathplot.h.
|
inline |
|
inline |
Definition at line 771 of file mathplot.h.
|
protected |
Definition at line 935 of file mathplot.cpp.
References getLabel(), labelCount(), m_maxLabelHeight, and m_maxLabelWidth.
Referenced by updateTickLabels().
|
inline |
Definition at line 740 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlineprotectedvirtual |
Definition at line 812 of file mathplot.h.
|
inlineprotectedvirtual |
|
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.
|
inline |
Definition at line 734 of file mathplot.h.
Referenced by mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and mpScaleY::recalculateTicks().
|
inlineinherited |
Get Draw mode: inside or outside margins.
Definition at line 285 of file mathplot.h.
|
inlineinherited |
|
inlineprotectedvirtual |
Definition at line 825 of file mathplot.h.
Referenced by computeLabelExtents(), and mpScaleY::Plot().
|
inlineprotectedvirtual |
Definition at line 820 of file mathplot.h.
Referenced by mpScaleXBase::Plot(), and mpScaleY::Plot().
|
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 mpFXY::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 mpFXY::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 mpFXY::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 mpFXY::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(), SIM_PLOT_PANEL::GetLabelY3(), mpInfoLegend::Plot(), mpText::Plot(), and SIMULATOR_FRAME::updateCursors().
|
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().
|
inlineprotectedvirtual |
Definition at line 815 of file mathplot.h.
Referenced by mpScaleXBase::Plot(), and mpScaleY::Plot().
|
inline |
Get X axis ticks or grid.
Definition at line 721 of file mathplot.h.
Referenced by SIM_PLOT_PANEL::IsGridShown().
|
inlineprotectedvirtual |
|
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 703 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 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().
|
inlineprotectedvirtual |
Definition at line 807 of file mathplot.h.
Referenced by computeLabelExtents(), mpScaleXBase::Plot(), and mpScaleY::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, mpInfoCoords, mpInfoLegend, mpFX, mpFY, mpFXY, mpProfile, mpScaleXBase, mpScaleY, mpText, mpMovableObject, and mpBitmapLayer.
Referenced by mpPrintout::OnPrintPage().
|
inlineprotectedvirtual |
Reimplemented in mpScaleX, mpScaleXLog, and mpScaleY.
Definition at line 800 of file mathplot.h.
Referenced by mpScaleXBase::Plot().
|
inline |
Definition at line 761 of file mathplot.h.
Referenced by SIM_PLOT_PANEL::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 709 of file mathplot.h.
|
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().
|
inline |
Definition at line 727 of file mathplot.h.
|
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().
|
inline |
Definition at line 711 of file mathplot.h.
Referenced by SIM_PLOT_PANEL::prepareDCAxes(), 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().
|
inline |
Set X axis ticks or grid.
enable | = true to plot axis ticks, false to plot grid. |
Definition at line 716 of file mathplot.h.
Referenced by SIM_PLOT_PANEL::ShowGrid().
|
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().
|
inlineprotected |
Definition at line 802 of file mathplot.h.
Referenced by mpScaleXBase::Plot(), and mpScaleY::Plot().
|
inline |
Definition at line 791 of file mathplot.h.
|
inlinevirtual |
Reimplemented in mpScaleX, mpScaleXLog, and mpScaleY.
Definition at line 777 of file mathplot.h.
Referenced by mpScaleXBase::getVisibleDataRange(), mpFXY::s2x(), and mpFXY::s2y().
|
inlinevirtual |
Reimplemented in mpScaleX, mpScaleXLog, and mpScaleY.
Definition at line 776 of file mathplot.h.
Referenced by mpFXY::Plot(), mpScaleXBase::Plot(), mpFXY::x2s(), and mpFXY::y2s().
|
protected |
Definition at line 952 of file mathplot.cpp.
References computeLabelExtents(), and formatLabels().
Referenced by mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and mpScaleY::recalculateTicks().
|
protected |
Definition at line 834 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), mpScaleBase(), mpScaleX::recalculateTicks(), and mpScaleY::recalculateTicks().
|
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().
|
protected |
Definition at line 835 of file mathplot.h.
Referenced by mpScaleBase(), and mpScaleXBase::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 |
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(), and mpScaleBase().
|
protected |
Definition at line 838 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), mpScaleBase(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleXLog::TransformFromPlot(), and mpScaleXLog::TransformToPlot().
|
protected |
Definition at line 838 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), mpScaleBase(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleXLog::TransformFromPlot(), and mpScaleXLog::TransformToPlot().
|
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().
|
protected |
Definition at line 836 of file mathplot.h.
Referenced by mpScaleBase(), mpScaleXBase::Plot(), and mpScaleY::Plot().
|
protected |
Definition at line 833 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), mpScaleBase(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleX::TransformFromPlot(), mpScaleY::TransformFromPlot(), mpScaleX::TransformToPlot(), and mpScaleY::TransformToPlot().
|
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().
|
protected |
Definition at line 839 of file mathplot.h.
Referenced by mpScaleBase().
|
protected |
Definition at line 833 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), mpScaleBase(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleX::TransformFromPlot(), mpScaleY::TransformFromPlot(), mpScaleX::TransformToPlot(), and mpScaleY::TransformToPlot().
|
protectedinherited |
Definition at line 319 of file mathplot.h.
Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().
|
protected |
Definition at line 831 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and mpScaleY::recalculateTicks().
|
protected |
Definition at line 837 of file mathplot.h.
Referenced by mpScaleBase(), and mpScaleXBase::Plot().
|
protected |
Definition at line 830 of file mathplot.h.
Referenced by mpScaleY::computeSlaveTicks(), mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and mpScaleY::recalculateTicks().
|
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().