KiCad PCB EDA Suite
|
Base class to create small rectangular info boxes mpInfoLayer is the base class to create a small rectangular info box in transparent overlay over plot layers. More...
#include <mathplot.h>
Public Member Functions | |
mpInfoLayer () | |
Default constructor. More... | |
mpInfoLayer (wxRect rect, const wxBrush *brush=wxTRANSPARENT_BRUSH) | |
Complete constructor. More... | |
virtual | ~mpInfoLayer () |
Destructor. More... | |
virtual void | UpdateInfo (mpWindow &w, wxEvent &event) |
Updates the content of the info box. More... | |
virtual bool | HasBBox () const override |
mpInfoLayer has not bounding box. More... | |
virtual void | Plot (wxDC &dc, mpWindow &w) override |
Plot method. More... | |
virtual bool | IsInfo () const override |
Specifies that this is an Info box layer. More... | |
virtual bool | Inside (const wxPoint &point) const |
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 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 (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 | |
wxRect | m_dim |
wxPoint | m_reference |
wxBrush | m_brush |
int | m_winX |
int | m_winY |
wxFont | m_font |
wxPen | m_pen |
wxString | m_name |
wxString | m_displayName |
bool | m_continuous |
bool | m_showName |
bool | m_drawOutsideMargins |
mpLayerType | m_type |
bool | m_visible |
Base class to create small rectangular info boxes mpInfoLayer is the base class to create a small rectangular info box in transparent overlay over plot layers.
It is used to implement objects like legends.
Definition at line 346 of file mathplot.h.
mpInfoLayer::mpInfoLayer | ( | ) |
mpInfoLayer::mpInfoLayer | ( | wxRect | rect, |
const wxBrush * | brush = wxTRANSPARENT_BRUSH |
||
) |
Complete constructor.
rect | Sets the initial size rectangle of the layer. |
brush | pointer to a fill brush. Default is transparent |
Definition at line 107 of file mathplot.cpp.
References m_brush, m_reference, mpLayer::m_type, m_winX, m_winY, and mpLAYER_INFO.
|
virtual |
Destructor.
Definition at line 119 of file mathplot.cpp.
|
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 76 of file mathplot.cpp.
References mpLayer::m_pen, and square().
|
inlineinherited |
Gets the 'continuity' property of the layer.
Definition at line 267 of file mathplot.h.
|
inlineinherited |
Definition at line 244 of file mathplot.h.
Referenced by mpInfoLegend::Plot().
|
inlineinherited |
Get Draw mode: inside or outside margins.
Definition at line 294 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 303 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 184 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 194 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 179 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 189 of file mathplot.h.
Referenced by mpFXY::UpdateScales().
|
inlineinherited |
Get layer name.
Definition at line 242 of file mathplot.h.
Referenced by SIM_PLOT_PANEL::GetLabelX(), SIM_PLOT_PANEL::GetLabelY1(), SIM_PLOT_PANEL::GetLabelY2(), SIM_PLOT_PANEL::GetLabelY3(), mpText::Plot(), and SIMULATOR_FRAME::updateCursors().
|
inlineinherited |
Get pen set for this layer.
Definition at line 257 of file mathplot.h.
Referenced by CURSOR::Plot(), mpInfoLegend::Plot(), and SIMULATOR_FRAME::rebuildSignalsGrid().
wxPoint mpInfoLayer::GetPosition | ( | ) | const |
Returns the position of the upper left corner of the box (in pixels)
Definition at line 190 of file mathplot.cpp.
References m_dim.
Referenced by SIM_PLOT_PANEL::GetLegendPosition().
|
inline |
Returns the current rectangle coordinates.
Definition at line 403 of file mathplot.h.
wxSize mpInfoLayer::GetSize | ( | ) | const |
Returns the size of the box (in pixels)
Definition at line 196 of file mathplot.cpp.
References m_dim.
|
inlineoverridevirtual |
mpInfoLayer has not bounding box.
Reimplemented from mpLayer.
Definition at line 368 of file mathplot.h.
|
virtual |
Checks whether a point is inside the info box rectangle.
point | The point to be checked |
Reimplemented in CURSOR.
Definition at line 129 of file mathplot.cpp.
References m_dim.
Referenced by mpWindow::IsInsideInfoLayer(), and mpWindow::OnMouseMove().
|
inlineoverridevirtual |
Specifies that this is an Info box layer.
Reimplemented from mpLayer.
Definition at line 379 of file mathplot.h.
|
inlineinherited |
Checks whether the layer is visible or not.
Definition at line 307 of file mathplot.h.
Referenced by mpWindow::IsLayerVisible(), SIM_PLOT_PANEL::IsLegendShown(), and mpInfoLegend::Plot().
|
virtual |
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 135 of file mathplot.cpp.
References delta, m_dim, and m_reference.
Referenced by CURSOR::Move(), mpWindow::OnMouseMove(), CURSOR::SetCoordX(), and SIM_PLOT_PANEL::SetLegendPosition().
|
overridevirtual |
Plot method.
Can be overridden by derived classes.
dc | the device content where to plot |
w | the window to plot |
Implements mpLayer.
Reimplemented in CURSOR, mpInfoCoords, and mpInfoLegend.
Definition at line 149 of file mathplot.cpp.
References mpWindow::GetScrX(), mpWindow::GetScrY(), m_brush, m_dim, mpLayer::m_pen, mpLayer::m_visible, m_winX, m_winY, and UpdateReference().
|
inlineinherited |
Set layer brush.
brush | brush, will be copied to internal class member |
Definition at line 319 of file mathplot.h.
|
inlineinherited |
Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).
Definition at line 262 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 290 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 281 of file mathplot.h.
|
inlinevirtualinherited |
Set layer name.
name | Name, will be copied to internal class member |
Reimplemented in TRACE.
Definition at line 276 of file mathplot.h.
References name.
Referenced by SIM_PLOT_PANEL::prepareDCAxes(), TRACE::SetName(), and SIM_PLOT_PANEL::updateAxes().
|
inlineinherited |
Set layer pen.
pen | Pen, will be copied to internal class member |
Definition at line 286 of file mathplot.h.
Referenced by SIM_PLOT_PANEL::UpdateTraceStyle().
|
inlineinherited |
Sets layer visibility.
show | visibility bool. |
Definition at line 311 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 271 of file mathplot.h.
Referenced by TRACE::TRACE().
|
virtual |
Updates the content of the info box.
Should be overridden by derived classes. Update may behave in different ways according to the type of event which called it.
w | parent mpWindow from which to obtain information |
event | The event which called the update. |
Reimplemented in mpInfoCoords, and mpInfoLegend.
Definition at line 124 of file mathplot.cpp.
|
virtual |
Updates the rectangle reference point.
Used by internal methods of mpWindow to correctly move mpInfoLayers.
Reimplemented in CURSOR.
Definition at line 142 of file mathplot.cpp.
References m_dim, and m_reference.
Referenced by mpWindow::OnMouseLeftRelease(), Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), and SIM_PLOT_PANEL::SetLegendPosition().
|
protected |
Definition at line 408 of file mathplot.h.
Referenced by mpInfoLayer(), Plot(), mpInfoCoords::Plot(), and mpInfoLegend::Plot().
|
protectedinherited |
Definition at line 328 of file mathplot.h.
Referenced by CURSOR::Plot(), mpFXY::Plot(), and mpMovableObject::Plot().
|
protected |
Definition at line 406 of file mathplot.h.
Referenced by GetPosition(), GetSize(), Inside(), Move(), CURSOR::Plot(), Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), and UpdateReference().
|
protectedinherited |
Definition at line 327 of file mathplot.h.
Referenced by TRACE::SetName().
|
protectedinherited |
Definition at line 330 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 323 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().
|
protectedinherited |
Definition at line 326 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 324 of file mathplot.h.
Referenced by mpLayer::GetColourSquare(), 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 407 of file mathplot.h.
Referenced by Move(), mpInfoLayer(), CURSOR::SetX(), UpdateReference(), and CURSOR::UpdateReference().
|
protectedinherited |
Definition at line 329 of file mathplot.h.
Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().
|
protectedinherited |
Definition at line 331 of file mathplot.h.
Referenced by mpInfoLayer().
|
protectedinherited |
Definition at line 332 of file mathplot.h.
Referenced by CURSOR::Plot(), Plot(), 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 409 of file mathplot.h.
Referenced by mpInfoLayer(), Plot(), mpInfoCoords::Plot(), and mpInfoLegend::Plot().
|
protected |
Definition at line 409 of file mathplot.h.
Referenced by mpInfoLayer(), Plot(), mpInfoCoords::Plot(), and mpInfoLegend::Plot().