KiCad PCB EDA Suite
|
#include <mathplot.h>
Public Member Functions | |
mpLayer () | |
virtual | ~mpLayer () |
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... | |
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 Attributes | |
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 |
Definition at line 147 of file mathplot.h.
mpLayer::mpLayer | ( | ) |
Definition at line 64 of file mathplot.cpp.
|
inlinevirtual |
Definition at line 152 of file mathplot.h.
|
inline |
wxBitmap mpLayer::GetColourSquare | ( | int | side = 16 | ) | const |
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.
|
inline |
Gets the 'continuity' property of the layer.
Definition at line 258 of file mathplot.h.
|
inline |
Get Draw mode: inside or outside margins.
Definition at line 285 of file mathplot.h.
|
inline |
|
inline |
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().
|
inlinevirtual |
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().
|
inlinevirtual |
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().
|
inlinevirtual |
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().
|
inlinevirtual |
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().
|
inline |
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().
|
inline |
Get pen set for this layer.
Definition at line 248 of file mathplot.h.
Referenced by CURSOR::Plot(), mpInfoLegend::Plot(), and SIMULATOR_FRAME::rebuildSignalsGrid().
|
inlinevirtual |
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.
|
inlinevirtual |
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.
|
inline |
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().
|
pure virtual |
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().
|
inline |
Set layer brush.
brush | brush, will be copied to internal class member |
Definition at line 310 of file mathplot.h.
|
inline |
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 |
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().
|
inline |
Set layer font.
font | Font, will be copied to internal class member |
Definition at line 272 of file mathplot.h.
|
inlinevirtual |
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 |
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 |
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().
|
inline |
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().
|
protected |
Definition at line 316 of file mathplot.h.
|
protected |
Definition at line 318 of file mathplot.h.
Referenced by CURSOR::Plot(), mpFXY::Plot(), and mpMovableObject::Plot().
|
protected |
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 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 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 315 of file mathplot.h.
Referenced by 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 319 of file mathplot.h.
Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().
|
protected |
Definition at line 321 of file mathplot.h.
Referenced by mpInfoLayer::mpInfoLayer().
|
protected |
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().