KiCad PCB EDA Suite
mpText Class Reference

Plot layer implementing a text string. More...

#include <mathplot.h>

Inheritance diagram for mpText:
mpLayer

Public Member Functions

 mpText (const wxString &name=wxT("Title"), int offsetx=5, int offsety=50)
 
virtual void Plot (wxDC &dc, mpWindow &w) override
 Text Layer plot handler. More...
 
virtual bool HasBBox () const override
 mpText should not be used for scaling decisions. 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...
 
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

int m_offsetx
 
int m_offsety
 
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
 

Detailed Description

Plot layer implementing a text string.

The text is plotted using a percentage system 0-100%, so the actual coordinates for the location are not required, and the text stays on the plot regardless of the other layers location and scaling factors.

Definition at line 1671 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpText()

mpText::mpText ( const wxString &  name = wxT("Title"),
int  offsetx = 5,
int  offsety = 50 
)
Parameters
nametext to be drawn in the plot
offsetxholds offset for the X location in percentage (0-100)
offsetyholds offset for the Y location in percentage (0-100)
nametext to be displayed
offsetxx position in percentage (0-100)
offsetxy position in percentage (0-100)

Definition at line 3335 of file mathplot.cpp.

3336 {
3337  SetName( name );
3338 
3339  if( offsetx >= 0 && offsetx <= 100 )
3340  m_offsetx = offsetx;
3341  else
3342  m_offsetx = 5;
3343 
3344  if( offsety >= 0 && offsety <= 100 )
3345  m_offsety = offsety;
3346  else
3347  m_offsety = 50;
3348 
3349  m_type = mpLAYER_INFO;
3350 }
int m_offsetx
Definition: mathplot.h:1687
void SetName(wxString name)
Set layer name.
Definition: mathplot.h:267
const char * name
Definition: DXF_plotter.cpp:59
mpLayerType m_type
Definition: mathplot.h:321
int m_offsety
Definition: mathplot.h:1688

References mpLAYER_INFO, and name.

Member Function Documentation

◆ GetBrush()

const wxBrush& mpLayer::GetBrush ( ) const
inlineinherited

Get brush set for this layer.

Returns
brush.

Definition at line 306 of file mathplot.h.

306 { return m_brush; };
wxBrush m_brush
Definition: mathplot.h:316

◆ GetColourSquare()

wxBitmap mpLayer::GetColourSquare ( int  side = 16) const
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.

Parameters
sideside length in pixels
Returns
a wxBitmap filled with layer's colour

Definition at line 83 of file mathplot.cpp.

84 {
85  wxBitmap square( side, side, -1 );
86  wxColour filler = m_pen.GetColour();
87  wxBrush brush( filler, wxBRUSHSTYLE_SOLID );
88  wxMemoryDC dc;
89 
90  dc.SelectObject( square );
91  dc.SetBackground( brush );
92  dc.Clear();
93  dc.SelectObject( wxNullBitmap );
94  return square;
95 }
wxPen m_pen
Definition: mathplot.h:315
double square(double x)

References mpLayer::m_pen, and square().

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const
inlineinherited

Gets the 'continuity' property of the layer.

See also
SetContinuity

Definition at line 258 of file mathplot.h.

258 { return m_continuous; }
bool m_continuous
Definition: mathplot.h:318

◆ GetDrawOutsideMargins()

bool mpLayer::GetDrawOutsideMargins ( )
inlineinherited

Get Draw mode: inside or outside margins.

Returns
The draw mode

Definition at line 285 of file mathplot.h.

285 { return m_drawOutsideMargins; };
bool m_drawOutsideMargins
Definition: mathplot.h:320

◆ GetFont()

const wxFont& mpLayer::GetFont ( ) const
inlineinherited

Get font set for this layer.

Returns
Font

Definition at line 243 of file mathplot.h.

243 { return m_font; }
wxFont m_font
Definition: mathplot.h:310

◆ GetLayerType()

mpLayerType mpLayer::GetLayerType ( ) const
inlineinherited

Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value.

Returns
An integer indicating layer type

Definition at line 294 of file mathplot.h.

294 { return m_type; };
mpLayerType m_type
Definition: mathplot.h:321

Referenced by mpInfoLegend::Plot().

◆ GetMaxX()

virtual double mpLayer::GetMaxX ( ) const
inlinevirtualinherited

Get inclusive right border of bounding box.

Returns
Value

Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.

Definition at line 180 of file mathplot.h.

180 { return 1.0; }

Referenced by mpWindow::UpdateBBox(), and mpFXY::UpdateScales().

◆ GetMaxY()

virtual double mpLayer::GetMaxY ( ) const
inlinevirtualinherited

Get inclusive top border of bounding box.

Returns
Value

Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.

Definition at line 190 of file mathplot.h.

190 { return 1.0; }

Referenced by mpWindow::UpdateBBox(), and mpFXY::UpdateScales().

◆ GetMinX()

virtual double mpLayer::GetMinX ( ) const
inlinevirtualinherited

Get inclusive left border of bounding box.

Returns
Value

Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.

Definition at line 175 of file mathplot.h.

175 { return -1.0; }

Referenced by mpWindow::UpdateBBox(), and mpFXY::UpdateScales().

◆ GetMinY()

virtual double mpLayer::GetMinY ( ) const
inlinevirtualinherited

Get inclusive bottom border of bounding box.

Returns
Value

Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.

Definition at line 185 of file mathplot.h.

185 { return -1.0; }

Referenced by mpWindow::UpdateBBox(), and mpFXY::UpdateScales().

◆ GetName()

const wxString& mpLayer::GetName ( void  ) const
inlineinherited

Get layer name.

Returns
Name

Definition at line 238 of file mathplot.h.

238 { return m_name; }
wxString m_name
Definition: mathplot.h:317

Referenced by SIM_PLOT_PANEL::GetLabelX(), SIM_PLOT_PANEL::GetLabelY1(), SIM_PLOT_PANEL::GetLabelY2(), mpInfoLegend::Plot(), and Plot().

◆ GetPen()

const wxPen& mpLayer::GetPen ( ) const
inlineinherited

Get pen set for this layer.

Returns
Pen

Definition at line 248 of file mathplot.h.

248 { return m_pen; }
wxPen m_pen
Definition: mathplot.h:315

Referenced by CURSOR::Plot(), and mpInfoLegend::Plot().

◆ HasBBox()

virtual bool mpText::HasBBox ( ) const
inlineoverridevirtual

mpText should not be used for scaling decisions.

Reimplemented from mpLayer.

Definition at line 1684 of file mathplot.h.

1684 { return false; }

◆ IsInfo()

virtual bool mpLayer::IsInfo ( ) const
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.

Returns
whether the layer is an info boxes
See also
mpInfoLayer::IsInfo

Reimplemented in mpInfoLayer.

Definition at line 170 of file mathplot.h.

170 { return false; };

◆ IsVisible()

bool mpLayer::IsVisible ( ) const
inlineinherited

Checks whether the layer is visible or not.

Returns
true if visible

Definition at line 298 of file mathplot.h.

298 { return m_visible; };
bool m_visible
Definition: mathplot.h:322

Referenced by mpWindow::IsLayerVisible(), SIM_PLOT_PANEL::IsLegendShown(), and mpInfoLegend::Plot().

◆ Plot()

void mpText::Plot ( wxDC &  dc,
mpWindow w 
)
overridevirtual

Text Layer plot handler.

mpText Layer plot handler.

This implementation will plot text adjusted to the visible area.

This implementation will plot the text adjusted to the visible area.

Implements mpLayer.

Definition at line 3357 of file mathplot.cpp.

3358 {
3359  if( m_visible )
3360  {
3361  dc.SetPen( m_pen );
3362  dc.SetFont( m_font );
3363 
3364  wxCoord tw = 0, th = 0;
3365  dc.GetTextExtent( GetName(), &tw, &th );
3366 
3367  // int left = -dc.LogicalToDeviceX(0);
3368  // int width = dc.LogicalToDeviceX(0) - left;
3369  // int bottom = dc.LogicalToDeviceY(0);
3370  // int height = bottom - -dc.LogicalToDeviceY(0);
3371 
3372  /* dc.DrawText( GetName(),
3373  * (int)((((float)width/100.0) * m_offsety) + left - (tw/2)),
3374  * (int)((((float)height/100.0) * m_offsetx) - bottom) );*/
3375  int px = m_offsetx * ( w.GetScrX() - w.GetMarginLeft() - w.GetMarginRight() ) / 100;
3376  int py = m_offsety * ( w.GetScrY() - w.GetMarginTop() - w.GetMarginBottom() ) / 100;
3377  dc.DrawText( GetName(), px, py );
3378  }
3379 }
int m_offsetx
Definition: mathplot.h:1687
int GetMarginBottom() const
Definition: mathplot.h:1375
const wxString & GetName() const
Get layer name.
Definition: mathplot.h:238
bool m_visible
Definition: mathplot.h:322
int GetMarginRight() const
Definition: mathplot.h:1373
int GetScrX(void) const
Get current view's X dimension in device context units.
Definition: mathplot.h:1138
int GetMarginTop() const
Definition: mathplot.h:1371
wxFont m_font
Definition: mathplot.h:310
wxPen m_pen
Definition: mathplot.h:315
int GetMarginLeft() const
Definition: mathplot.h:1377
int m_offsety
Definition: mathplot.h:1688
int GetScrY(void) const
Get current view's Y dimension in device context units.
Definition: mathplot.h:1147

References mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpLayer::GetName(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpLayer::m_font, m_offsetx, m_offsety, mpLayer::m_pen, and mpLayer::m_visible.

◆ SetBrush()

void mpLayer::SetBrush ( wxBrush  brush)
inlineinherited

Set layer brush.

Parameters
brushbrush, will be copied to internal class member

Definition at line 310 of file mathplot.h.

310 { m_brush = brush; };
wxBrush m_brush
Definition: mathplot.h:316

◆ SetContinuity()

void mpLayer::SetContinuity ( bool  continuity)
inlineinherited

Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).

See also
GetContinuity

Definition at line 253 of file mathplot.h.

253 { m_continuous = continuity; }
bool m_continuous
Definition: mathplot.h:318

Referenced by TRACE::TRACE().

◆ SetDrawOutsideMargins()

void mpLayer::SetDrawOutsideMargins ( bool  drawModeOutside)
inlineinherited

Set Draw mode: inside or outside margins.

Default is outside, which allows the layer to draw up to the mpWindow border.

Parameters
drawModeOutsideThe draw mode to be set

Definition at line 281 of file mathplot.h.

281 { m_drawOutsideMargins = drawModeOutside; };
bool m_drawOutsideMargins
Definition: mathplot.h:320

Referenced by CURSOR::CURSOR(), and TRACE::TRACE().

◆ SetFont()

void mpLayer::SetFont ( wxFont &  font)
inlineinherited

Set layer font.

Parameters
fontFont, will be copied to internal class member

Definition at line 272 of file mathplot.h.

272 { m_font = font; }
wxFont m_font
Definition: mathplot.h:310

◆ SetName()

void mpLayer::SetName ( wxString  name)
inlineinherited

Set layer name.

Parameters
nameName, will be copied to internal class member

Definition at line 267 of file mathplot.h.

267 { m_name = name; }
const char * name
Definition: DXF_plotter.cpp:59
wxString m_name
Definition: mathplot.h:317

References name.

◆ SetPen()

void mpLayer::SetPen ( wxPen  pen)
inlineinherited

Set layer pen.

Parameters
penPen, will be copied to internal class member

Definition at line 277 of file mathplot.h.

277 { m_pen = pen; }
wxPen m_pen
Definition: mathplot.h:315

Referenced by SIM_PLOT_PANEL::EnableCursor(), and SIM_PLOT_PANEL::UpdateTraceStyle().

◆ SetVisible()

void mpLayer::SetVisible ( bool  show)
inlineinherited

Sets layer visibility.

Parameters
showvisibility bool.

Definition at line 302 of file mathplot.h.

302 { m_visible = show; };
bool m_visible
Definition: mathplot.h:322

Referenced by mpWindow::SetLayerVisible(), SIM_PLOT_PANEL::ShowLegend(), and SIM_PLOT_PANEL::SIM_PLOT_PANEL().

◆ ShowName()

void mpLayer::ShowName ( bool  show)
inlineinherited

Shows or hides the text label with the name of the layer (default is visible).

Definition at line 262 of file mathplot.h.

262 { m_showName = show; };
bool m_showName
Definition: mathplot.h:319

Referenced by TRACE::TRACE().

Member Data Documentation

◆ m_brush

wxBrush mpLayer::m_brush
protectedinherited

Definition at line 316 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous
protectedinherited

Definition at line 318 of file mathplot.h.

Referenced by CURSOR::Plot(), mpFXY::Plot(), and mpMovableObject::Plot().

◆ m_drawOutsideMargins

◆ m_font

◆ m_name

wxString mpLayer::m_name
protectedinherited

◆ m_offsetx

int mpText::m_offsetx
protected

Definition at line 1687 of file mathplot.h.

Referenced by Plot().

◆ m_offsety

int mpText::m_offsety
protected

Definition at line 1688 of file mathplot.h.

Referenced by Plot().

◆ m_pen

◆ m_showName

bool mpLayer::m_showName
protectedinherited

◆ m_type

mpLayerType mpLayer::m_type
protectedinherited

Definition at line 321 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_visible


The documentation for this class was generated from the following files: