KiCad PCB EDA Suite
|
Implements an overlay box which shows the mouse coordinates in plot units. More...
#include <mathplot.h>
Public Member Functions | |
mpInfoCoords () | |
Default constructor. More... | |
mpInfoCoords (wxRect rect, const wxBrush *brush=wxTRANSPARENT_BRUSH) | |
Complete constructor, setting initial rectangle and background brush. More... | |
~mpInfoCoords () | |
Default destructor. More... | |
virtual void | UpdateInfo (mpWindow &w, wxEvent &event) override |
Updates the content of the info box. More... | |
virtual void | Plot (wxDC &dc, mpWindow &w) override |
Plot method. More... | |
virtual bool | HasBBox () const override |
mpInfoLayer has not bounding box. More... | |
virtual bool | IsInfo () const override |
Specifies that this is an Info box layer. More... | |
virtual bool | Inside (wxPoint &point) |
Checks whether a point is inside the info box rectangle. More... | |
virtual void | Move (wxPoint delta) |
Moves the layer rectangle of given pixel deltas. More... | |
virtual void | UpdateReference () |
Updates the rectangle reference point. More... | |
wxPoint | GetPosition () const |
Returns the position of the upper left corner of the box (in pixels) More... | |
wxSize | GetSize () const |
Returns the size of the box (in pixels) More... | |
const wxRect & | GetRectangle () const |
Returns the current rectangle coordinates. 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 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... | |
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 | |
wxString | m_content |
wxRect | m_dim |
wxPoint | m_reference |
wxBrush | m_brush |
int | m_winX |
int | m_winY |
wxFont | m_font |
wxPen | m_pen |
wxString | m_name |
bool | m_continuous |
bool | m_showName |
bool | m_drawOutsideMargins |
mpLayerType | m_type |
bool | m_visible |
Implements an overlay box which shows the mouse coordinates in plot units.
When an mpInfoCoords layer is activated, when mouse is moved over the mpWindow, its coordinates (in mpWindow units, not pixels) are continuously reported inside the layer box.
Definition at line 406 of file mathplot.h.
mpInfoCoords::mpInfoCoords | ( | ) |
mpInfoCoords::mpInfoCoords | ( | wxRect | rect, |
const wxBrush * | brush = wxTRANSPARENT_BRUSH |
||
) |
Complete constructor, setting initial rectangle and background brush.
rect | The initial bounding rectangle. |
brush | The wxBrush to be used for box background: default is transparent |
Definition at line 205 of file mathplot.cpp.
mpInfoCoords::~mpInfoCoords | ( | ) |
|
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.
|
inlineinherited |
Get Draw mode: inside or outside margins.
Definition at line 285 of file mathplot.h.
|
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 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(), mpInfoLegend::Plot(), and mpText::Plot().
|
inlineinherited |
Get pen set for this layer.
Definition at line 248 of file mathplot.h.
Referenced by CURSOR::Plot(), and mpInfoLegend::Plot().
|
inherited |
Returns the position of the upper left corner of the box (in pixels)
Definition at line 188 of file mathplot.cpp.
References mpInfoLayer::m_dim.
|
inlineinherited |
Returns the current rectangle coordinates.
Definition at line 392 of file mathplot.h.
Referenced by mpWindow::OnMouseMove().
|
inherited |
Returns the size of the box (in pixels)
Definition at line 194 of file mathplot.cpp.
References mpInfoLayer::m_dim.
|
inlineoverridevirtualinherited |
mpInfoLayer has not bounding box.
Reimplemented from mpLayer.
Definition at line 357 of file mathplot.h.
|
virtualinherited |
Checks whether a point is inside the info box rectangle.
point | The point to be checked |
Reimplemented in CURSOR.
Definition at line 127 of file mathplot.cpp.
References mpInfoLayer::m_dim.
Referenced by mpWindow::IsInsideInfoLayer().
|
inlineoverridevirtualinherited |
Specifies that this is an Info box layer.
Reimplemented from mpLayer.
Definition at line 368 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().
|
virtualinherited |
Moves the layer rectangle of given pixel deltas.
delta | The wxPoint container for delta coordinates along x and y. Units are in pixels. |
Reimplemented in CURSOR.
Definition at line 133 of file mathplot.cpp.
References delta, mpInfoLayer::m_dim, and mpInfoLayer::m_reference.
Referenced by CURSOR::Move(), and mpWindow::OnMouseMove().
|
overridevirtual |
Plot method.
dc | the device content where to plot |
w | the window to plot |
Reimplemented from mpInfoLayer.
Definition at line 231 of file mathplot.cpp.
References mpWindow::GetScrX(), mpWindow::GetScrY(), mpInfoLayer::m_brush, m_content, mpInfoLayer::m_dim, mpLayer::m_font, mpLayer::m_pen, mpLayer::m_visible, mpInfoLayer::m_winX, mpInfoLayer::m_winY, and mpInfoLayer::UpdateReference().
|
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().
|
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.
|
inlineinherited |
Set layer name.
name | Name, will be copied to internal class member |
Definition at line 267 of file mathplot.h.
References name.
|
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::EnableCursor(), and SIM_PLOT_PANEL::UpdateTraceStyle().
|
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().
|
overridevirtual |
Updates the content of the info box.
It is used to update coordinates.
w | parent mpWindow from which to obtain information |
event | The event which called the update. |
Reimplemented from mpInfoLayer.
Definition at line 215 of file mathplot.cpp.
|
virtualinherited |
Updates the rectangle reference point.
Used by internal methods of mpWindow to correctly move mpInfoLayers.
Reimplemented in CURSOR.
Definition at line 140 of file mathplot.cpp.
References mpInfoLayer::m_dim, and mpInfoLayer::m_reference.
Referenced by mpWindow::OnMouseLeftRelease(), mpInfoLayer::Plot(), Plot(), and mpInfoLegend::Plot().
|
protectedinherited |
Definition at line 397 of file mathplot.h.
Referenced by mpInfoLayer::mpInfoLayer(), mpInfoLayer::Plot(), Plot(), and mpInfoLegend::Plot().
|
protected |
Definition at line 431 of file mathplot.h.
Referenced by Plot().
|
protectedinherited |
Definition at line 318 of file mathplot.h.
Referenced by CURSOR::Plot(), mpFXY::Plot(), and mpMovableObject::Plot().
|
protectedinherited |
Definition at line 395 of file mathplot.h.
Referenced by mpInfoLayer::GetPosition(), mpInfoLayer::GetSize(), mpInfoLayer::Inside(), mpInfoLayer::Move(), CURSOR::Plot(), mpInfoLayer::Plot(), Plot(), mpInfoLegend::Plot(), and mpInfoLayer::UpdateReference().
|
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().
|
protectedinherited |
Definition at line 314 of file mathplot.h.
Referenced by Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().
|
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().
|
protectedinherited |
Definition at line 315 of file mathplot.h.
Referenced by mpLayer::GetColourSquare(), mpInfoLayer::Plot(), Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), and mpMovableObject::Plot().
|
protectedinherited |
Definition at line 396 of file mathplot.h.
Referenced by mpInfoLayer::Move(), mpInfoLayer::mpInfoLayer(), CURSOR::SetX(), mpInfoLayer::UpdateReference(), and CURSOR::UpdateReference().
|
protectedinherited |
Definition at line 319 of file mathplot.h.
Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().
|
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(), Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().
|
protectedinherited |
Definition at line 398 of file mathplot.h.
Referenced by mpInfoLayer::mpInfoLayer(), mpInfoLayer::Plot(), Plot(), and mpInfoLegend::Plot().
|
protectedinherited |
Definition at line 398 of file mathplot.h.
Referenced by mpInfoLayer::mpInfoLayer(), mpInfoLayer::Plot(), Plot(), and mpInfoLegend::Plot().