KiCad PCB EDA Suite
mpScaleY Class Reference

Plot layer implementing a y-scale ruler. More...

#include <mathplot.h>

Inheritance diagram for mpScaleY:
mpScaleBase mpLayer

Public Member Functions

 mpScaleY (const wxString &name=wxT("Y"), int flags=mpALIGN_CENTER, bool ticks=true)
 
virtual bool IsHorizontal () const override
 
virtual void Plot (wxDC &dc, mpWindow &w) override
 Layer plot handler. More...
 
virtual bool HasBBox () const override
 Check whether this layer has a bounding box. More...
 
void SetAlign (int align)
 Set Y axis alignment. More...
 
void SetTicks (bool ticks)
 Set Y axis ticks or grid. More...
 
bool GetTicks () const
 Get Y axis ticks or grid. More...
 
virtual double TransformToPlot (double x) const override
 
virtual double TransformFromPlot (double xplot) const override
 
void SetMasterScale (mpScaleY *masterScale)
 
void SetNameAlign (int align)
 
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
 
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...
 
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 Member Functions

virtual void getVisibleDataRange (mpWindow &w, double &minV, double &maxV) override
 
virtual void recalculateTicks (wxDC &dc, mpWindow &w) override
 
void computeLabelExtents (wxDC &dc, mpWindow &w)
 
void computeSlaveTicks (mpWindow &w)
 
void updateTickLabels (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

mpScaleYm_masterScale
 
int m_flags
 
bool m_ticks
 
std::vector< double > m_tickValues
 
std::vector< TickLabelm_tickLabels
 
double m_offset
 
double m_scale
 
double m_absVisibleMaxV
 
int m_nameFlags
 
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
 

Detailed Description

Plot layer implementing a y-scale ruler.

If align is set to mpALIGN_CENTER, the ruler is fixed at X=0 in the coordinate system. If the align is set to mpALIGN_TOP or mpALIGN_BOTTOM, the axis is always drawn respectively at top or bottom of the window. A label is plotted at the top-right hand of the ruler. The scale numbering automatically adjusts to view and zoom factor.

Definition at line 941 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpScaleY()

mpScaleY::mpScaleY ( const wxString &  name = wxT( "Y" ),
int  flags = mpALIGN_CENTER,
bool  ticks = true 
)
Parameters
nameLabel to plot by the ruler
flagsSet position of the scale respect to the window.
ticksSelect ticks or grid. Give true (default) for drawing axis ticks, false for drawing the grid

Definition at line 1389 of file mathplot.cpp.

1390{
1391 SetName( name );
1392 SetFont( (wxFont&) *wxSMALL_FONT );
1393 SetPen( (wxPen&) *wxGREY_PEN );
1394 m_flags = flags;
1395 m_ticks = ticks;
1397 m_masterScale = NULL;
1399}
const char * name
Definition: DXF_plotter.cpp:56
void SetPen(wxPen pen)
Set layer pen.
Definition: mathplot.h:277
void SetFont(wxFont &font)
Set layer font.
Definition: mathplot.h:272
mpLayerType m_type
Definition: mathplot.h:321
void SetName(wxString name)
Set layer name.
Definition: mathplot.h:267
int m_nameFlags
Definition: mathplot.h:834
int m_flags
Definition: mathplot.h:1000
mpScaleY * m_masterScale
Definition: mathplot.h:996
bool m_ticks
Definition: mathplot.h:1001
@ mpLAYER_AXIS
Definition: mathplot.h:129
#define mpALIGN_BORDER_LEFT
Aligns Y axis to left border.
Definition: mathplot.h:501

References mpALIGN_BORDER_LEFT, mpLAYER_AXIS, and name.

Member Function Documentation

◆ AbsMaxValue()

double mpScaleBase::AbsMaxValue ( ) const
inlineinherited

Definition at line 764 of file mathplot.h.

765 {
766 return std::max( std::abs( m_maxV ), std::abs( m_minV ) );
767 }
double m_maxV
Definition: mathplot.h:836
double m_minV
Definition: mathplot.h:836
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition: eda_angle.h:401

References std::abs().

◆ AbsVisibleMaxValue()

double mpScaleBase::AbsVisibleMaxValue ( ) const
inlineinherited

Definition at line 769 of file mathplot.h.

770 {
771 return m_absVisibleMaxV;
772 }
double m_absVisibleMaxV
Definition: mathplot.h:832

◆ computeLabelExtents()

void mpScaleY::computeLabelExtents ( wxDC &  dc,
mpWindow w 
)
protected

◆ computeSlaveTicks()

void mpScaleY::computeSlaveTicks ( mpWindow w)
protected

Definition at line 991 of file mathplot.cpp.

992{
993 if( m_masterScale->m_tickValues.size() == 0 )
994 return;
995
996 m_tickValues.clear();
997 m_tickLabels.clear();
998
1001
1002 m_scale = 1.0 / ( m_maxV - m_minV );
1003 m_offset = -m_minV;
1004
1005 double y_slave0 = p0 / m_scale;
1006 double y_slave1 = p1 / m_scale;
1007
1008 double dy_slave = (y_slave1 - y_slave0);
1009 double exponent = floor( log10( dy_slave ) );
1010 double base = dy_slave / pow( 10.0, exponent );
1011
1012 double dy_scaled = ceil( 2.0 * base ) / 2.0 * pow( 10.0, exponent );
1013
1014 double minvv, maxvv;
1015
1016 getVisibleDataRange( w, minvv, maxvv );
1017
1018 minvv = floor( minvv / dy_scaled ) * dy_scaled;
1019
1020 m_scale = 1.0 / ( m_maxV - m_minV );
1021 m_scale *= dy_slave / dy_scaled;
1022
1023 m_offset = p0 / m_scale - minvv;
1024
1025 m_tickValues.clear();
1026
1027 double m;
1028
1029 m_absVisibleMaxV = 0;
1030
1031 for( unsigned int i = 0; i < m_masterScale->m_tickValues.size(); i++ )
1032 {
1034 m_tickValues.push_back( m );
1035 m_tickLabels.emplace_back( m );
1036 m_absVisibleMaxV = std::max( m_absVisibleMaxV, fabs( m ) );
1037 }
1038}
double m_scale
Definition: mathplot.h:831
double m_offset
Definition: mathplot.h:831
std::vector< double > m_tickValues
Definition: mathplot.h:828
std::vector< TickLabel > m_tickLabels
Definition: mathplot.h:829
virtual void getVisibleDataRange(mpWindow &w, double &minV, double &maxV) override
Definition: mathplot.cpp:978
virtual double TransformFromPlot(double xplot) const override
Definition: mathplot.cpp:2813
virtual double TransformToPlot(double x) const override
Definition: mathplot.cpp:2807

References getVisibleDataRange(), mpScaleBase::m_absVisibleMaxV, m_masterScale, mpScaleBase::m_maxV, mpScaleBase::m_minV, mpScaleBase::m_offset, mpScaleBase::m_scale, mpScaleBase::m_tickLabels, mpScaleBase::m_tickValues, TransformFromPlot(), and TransformToPlot().

Referenced by recalculateTicks().

◆ ExtendDataRange()

void mpScaleBase::ExtendDataRange ( double  minV,
double  maxV 
)
inlineinherited

Definition at line 738 of file mathplot.h.

739 {
740 if( !m_rangeSet )
741 {
742 m_minV = minV;
743 m_maxV = maxV;
744 m_rangeSet = true;
745 }
746 else
747 {
748 m_minV = std::min( minV, m_minV );
749 m_maxV = std::max( maxV, m_maxV );
750 }
751
752 if( m_minV == m_maxV )
753 {
754 m_minV = m_minV - 1.0;
755 m_maxV = m_maxV + 1.0;
756 }
757 }
bool m_rangeSet
Definition: mathplot.h:837

Referenced by mpFXY::UpdateScales().

◆ formatLabel()

virtual const wxString mpScaleBase::formatLabel ( double  value,
int  nDigits 
)
inlineprotectedvirtualinherited

Definition at line 810 of file mathplot.h.

810{ return wxT( "" ); }

◆ formatLabels()

virtual void mpScaleBase::formatLabels ( )
inlineprotectedvirtualinherited

Definition at line 811 of file mathplot.h.

811{};

Referenced by mpScaleBase::updateTickLabels().

◆ 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 74 of file mathplot.cpp.

75{
76 wxBitmap square( side, side, -1 );
77 wxColour filler = m_pen.GetColour();
78 wxBrush brush( filler, wxBRUSHSTYLE_SOLID );
79 wxMemoryDC dc;
80
81 dc.SelectObject( square );
82 dc.SetBackground( brush );
83 dc.Clear();
84 dc.SelectObject( wxNullBitmap );
85 return square;
86}
double square(double x)
wxPen m_pen
Definition: mathplot.h:315

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

◆ GetDataRange()

void mpScaleBase::GetDataRange ( double &  minV,
double &  maxV 
) const
inlineinherited

Definition at line 732 of file mathplot.h.

733 {
734 minV = m_minV;
735 maxV = m_maxV;
736 }

Referenced by mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and recalculateTicks().

◆ 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:314

◆ getLabel()

virtual wxString mpScaleBase::getLabel ( int  n) const
inlineprotectedvirtualinherited

Definition at line 823 of file mathplot.h.

824 {
825 return m_tickLabels[n].label;
826 }

Referenced by mpScaleBase::computeLabelExtents(), and Plot().

◆ getLabelPos()

virtual double mpScaleBase::getLabelPos ( int  n) const
inlineprotectedvirtualinherited

Definition at line 818 of file mathplot.h.

819 {
820 return m_tickLabels[n].pos;
821 }

Referenced by mpScaleXBase::Plot(), and Plot().

◆ 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; };

Referenced by mpInfoLegend::Plot().

◆ GetMaxX()

virtual double mpLayer::GetMaxX ( ) const
inlinevirtualinherited

Get inclusive right border of bounding box.

Returns
Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 180 of file mathplot.h.

180{ return 1.0; }

Referenced by mpFXY::UpdateScales().

◆ GetMaxY()

virtual double mpLayer::GetMaxY ( ) const
inlinevirtualinherited

Get inclusive top border of bounding box.

Returns
Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 190 of file mathplot.h.

190{ return 1.0; }

Referenced by mpFXY::UpdateScales().

◆ GetMinX()

virtual double mpLayer::GetMinX ( ) const
inlinevirtualinherited

Get inclusive left border of bounding box.

Returns
Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 175 of file mathplot.h.

175{ return -1.0; }

Referenced by mpFXY::UpdateScales().

◆ GetMinY()

virtual double mpLayer::GetMinY ( ) const
inlinevirtualinherited

Get inclusive bottom border of bounding box.

Returns
Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 185 of file mathplot.h.

185{ return -1.0; }

Referenced by 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 mpText::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; }

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

◆ getTickPos()

virtual double mpScaleBase::getTickPos ( int  n) const
inlineprotectedvirtualinherited

Definition at line 813 of file mathplot.h.

814 {
815 return m_tickValues[n];
816 }

Referenced by mpScaleXBase::Plot(), and Plot().

◆ GetTicks()

bool mpScaleY::GetTicks ( ) const
inline

Get Y axis ticks or grid.

Returns
true if plot is drawing axis ticks, false if the grid is active.

Definition at line 973 of file mathplot.h.

973{ return m_ticks; };

Referenced by SIM_PLOT_PANEL::IsGridShown().

◆ getVisibleDataRange()

void mpScaleY::getVisibleDataRange ( mpWindow w,
double &  minV,
double &  maxV 
)
overrideprotectedvirtual

Reimplemented from mpScaleBase.

Definition at line 978 of file mathplot.cpp.

979{
980 wxCoord minYpx = m_drawOutsideMargins ? 0 : w.GetMarginTop();
981 wxCoord maxYpx = m_drawOutsideMargins ? w.GetScrY() : w.GetScrY() - w.GetMarginBottom();
982
983 double pymin = w.p2y( minYpx );
984 double pymax = w.p2y( maxYpx );
985
986 minV = TransformFromPlot( pymax );
987 maxV = TransformFromPlot( pymin );
988}
double p2y(wxCoord pixelCoordY)
Converts mpWindow (screen) pixel coordinates into graph (floating point) coordinates,...
Definition: mathplot.h:1197
int GetMarginTop() const
Definition: mathplot.h:1371
int GetMarginBottom() const
Definition: mathplot.h:1375
int GetScrY(void) const
Get current view's Y dimension in device context units.
Definition: mathplot.h:1147

References mpWindow::GetMarginBottom(), mpWindow::GetMarginTop(), mpWindow::GetScrY(), mpLayer::m_drawOutsideMargins, mpWindow::p2y(), and TransformFromPlot().

Referenced by computeSlaveTicks(), and recalculateTicks().

◆ HasBBox()

virtual bool mpScaleY::HasBBox ( ) const
inlineoverridevirtual

Check whether this layer has a bounding box.

This implementation returns false thus making the ruler invisible to the plot layer bounding box calculation by mpWindow.

Reimplemented from mpScaleBase.

Definition at line 961 of file mathplot.h.

961{ return false; }

◆ IsHorizontal()

virtual bool mpScaleY::IsHorizontal ( ) const
inlineoverridevirtual

Implements mpScaleBase.

Definition at line 950 of file mathplot.h.

950{ 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().

◆ labelCount()

virtual int mpScaleBase::labelCount ( ) const
inlineprotectedvirtualinherited

Definition at line 805 of file mathplot.h.

806 {
807 return m_tickLabels.size();
808 }

Referenced by mpScaleBase::computeLabelExtents(), mpScaleXBase::Plot(), and Plot().

◆ Plot()

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

Layer plot handler.

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

Implements mpLayer.

Definition at line 1402 of file mathplot.cpp.

1403{
1404 m_offset = -m_minV;
1405 m_scale = 1.0 / ( m_maxV - m_minV );
1406
1407 recalculateTicks( dc, w );
1408
1409 if( m_visible )
1410 {
1411 dc.SetPen( m_pen );
1412 dc.SetFont( m_font );
1413
1414 int orgx = 0;
1415
1416 // const int extend = w.GetScrY(); // /2;
1417 if( m_flags == mpALIGN_CENTER )
1418 orgx = w.x2p( 0 ); // (int)(w.GetPosX() * w.GetScaleX());
1419
1420 if( m_flags == mpALIGN_LEFT )
1421 {
1423 orgx = Y_BORDER_SEPARATION;
1424 else
1425 orgx = w.GetMarginLeft();
1426 }
1427
1428 if( m_flags == mpALIGN_RIGHT )
1429 {
1431 orgx = w.GetScrX() - Y_BORDER_SEPARATION;
1432 else
1433 orgx = w.GetScrX() - w.GetMarginRight();
1434 }
1435
1437 orgx = w.GetScrX() - 1; // dc.LogicalToDeviceX(0) - 1;
1438
1440 orgx = 1; // -dc.LogicalToDeviceX(0);
1441
1442 wxCoord endPx = m_drawOutsideMargins ? w.GetScrX() : w.GetScrX() - w.GetMarginRight();
1443 wxCoord minYpx = m_drawOutsideMargins ? 0 : w.GetMarginTop();
1444 wxCoord maxYpx = m_drawOutsideMargins ? w.GetScrY() : w.GetScrY() - w.GetMarginBottom();
1445 // Draw line
1446 dc.DrawLine( orgx, minYpx, orgx, maxYpx );
1447
1448
1449 wxCoord tx, ty;
1450 wxString s;
1451 wxString fmt;
1452 int n = 0;
1453
1454
1455 int labelW = 0;
1456 // Before staring cycle, calculate label height
1457 int labelHeight = 0;
1458 s.Printf( fmt, n );
1459 dc.GetTextExtent( s, &tx, &labelHeight );
1460
1461 for( n = 0; n < tickCount(); n++ )
1462 {
1463 double tp = getTickPos( n );
1464
1465 double py = TransformToPlot( tp ); // ( log10 ( tp ) - xlogmin) / (xlogmax - xlogmin);
1466 const int p = (int) ( ( w.GetPosY() - py ) * w.GetScaleY() );
1467
1468
1469 if( (p >= minYpx) && (p <= maxYpx) )
1470 {
1471 if( m_ticks ) // Draw axis ticks
1472 {
1474 {
1475 dc.DrawLine( orgx, p, orgx + 4, p );
1476 }
1477 else
1478 {
1479 dc.DrawLine( orgx - 4, p, orgx, p ); // ( orgx, p, orgx+4, p);
1480 }
1481 }
1482 else
1483 {
1484 dc.DrawLine( orgx - 4, p, orgx + 4, p );
1485
1486 m_pen.SetStyle( wxPENSTYLE_DOT );
1487 dc.SetPen( m_pen );
1488
1489 dc.DrawLine( orgx - 4, p, endPx, p );
1490
1491 m_pen.SetStyle( wxPENSTYLE_SOLID );
1492 dc.SetPen( m_pen );
1493 }
1494
1495 // Print ticks labels
1496 }
1497 }
1498
1499 for( n = 0; n < labelCount(); n++ )
1500 {
1501 double tp = getLabelPos( n );
1502
1503 double py = TransformToPlot( tp ); // ( log10 ( tp ) - xlogmin) / (xlogmax - xlogmin);
1504 const int p = (int) ( ( w.GetPosY() - py ) * w.GetScaleY() );
1505
1506 if( !m_tickLabels[n].visible )
1507 continue;
1508
1509 if( (p >= minYpx) && (p <= maxYpx) )
1510 {
1511 s = getLabel( n );
1512 dc.GetTextExtent( s, &tx, &ty );
1513
1515 dc.DrawText( s, orgx + 4, p - ty / 2 );
1516 else
1517 dc.DrawText( s, orgx - 4 - tx, p - ty / 2 ); // ( s, orgx+4, p-ty/2);
1518 }
1519 }
1520
1521 // Draw axis name
1522 // Draw axis name
1523
1524 dc.GetTextExtent( m_name, &tx, &ty );
1525
1526 switch( m_nameFlags )
1527 {
1529 dc.DrawText( m_name, labelW + 8, 4 );
1530 break;
1531
1532 case mpALIGN_LEFT:
1533 {
1534 // if ((!m_drawOutsideMargins) && (w.GetMarginLeft() > (ty + labelW + 8))) {
1535 // dc.DrawRotatedText( m_name, orgx - 6 - labelW - ty, (maxYpx + minYpx) / 2 + tx / 2, 90);
1536 // } else {
1537 dc.DrawText( m_name, orgx + 4, minYpx - ty - 4 );
1538 // }
1539 }
1540 break;
1541
1542 case mpALIGN_CENTER:
1543 dc.DrawText( m_name, orgx + 4, 4 );
1544 break;
1545
1546 case mpALIGN_RIGHT:
1547 {
1548 // dc.DrawRotatedText( m_name, orgx + 6, (maxYpx + minYpx) / 2 + tx / 2, 90);
1549
1550 /*if ((!m_drawOutsideMargins) && (w.GetMarginRight() > (ty + labelW + 8))) {
1551 * dc.DrawRotatedText( m_name, orgx + 6 + labelW, (maxYpx - minYpx + tx)>>1, 90);
1552 * } else {*/
1553 dc.DrawText( m_name, orgx - tx - 4, minYpx - ty - 4 );
1554 // }
1555 }
1556 break;
1557
1559 dc.DrawText( m_name, orgx - 6 - tx - labelW, 4 );
1560 break;
1561
1562 default:
1563 break;
1564 }
1565 }
1566}
virtual wxString getLabel(int n) const
Definition: mathplot.h:823
virtual double getTickPos(int n) const
Definition: mathplot.h:813
int tickCount() const
Definition: mathplot.h:800
virtual double getLabelPos(int n) const
Definition: mathplot.h:818
virtual int labelCount() const
Definition: mathplot.h:805
virtual void recalculateTicks(wxDC &dc, mpWindow &w) override
Definition: mathplot.cpp:1041
int GetMarginLeft() const
Definition: mathplot.h:1377
int GetScrX(void) const
Get current view's X dimension in device context units.
Definition: mathplot.h:1138
wxCoord x2p(double x)
Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates,...
Definition: mathplot.h:1202
double GetPosY(void) const
Definition: mathplot.h:1130
double GetScaleY(void) const
Definition: mathplot.h:1116
int GetMarginRight() const
Definition: mathplot.h:1373
#define mpALIGN_BORDER_RIGHT
Aligns Y axis to right border.
Definition: mathplot.h:503
#define mpALIGN_RIGHT
Aligns label to the right.
Definition: mathplot.h:477
#define mpALIGN_CENTER
Aligns label to the center.
Definition: mathplot.h:479
#define mpALIGN_LEFT
Aligns label to the left.
Definition: mathplot.h:481
#define Y_BORDER_SEPARATION
Definition: mathplot.h:95
static thread_pool * tp
Definition: thread_pool.cpp:30

References mpScaleBase::getLabel(), mpScaleBase::getLabelPos(), mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpWindow::GetPosY(), mpWindow::GetScaleY(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpScaleBase::getTickPos(), mpScaleBase::labelCount(), mpLayer::m_drawOutsideMargins, m_flags, mpLayer::m_font, mpScaleBase::m_maxV, mpScaleBase::m_minV, mpLayer::m_name, mpScaleBase::m_nameFlags, mpScaleBase::m_offset, mpLayer::m_pen, mpScaleBase::m_scale, mpScaleBase::m_tickLabels, m_ticks, mpLayer::m_visible, mpALIGN_BORDER_LEFT, mpALIGN_BORDER_RIGHT, mpALIGN_CENTER, mpALIGN_LEFT, mpALIGN_RIGHT, recalculateTicks(), mpScaleBase::tickCount(), tp, TransformToPlot(), mpWindow::x2p(), and Y_BORDER_SEPARATION.

◆ recalculateTicks()

void mpScaleY::recalculateTicks ( wxDC &  dc,
mpWindow w 
)
overrideprotectedvirtual

Reimplemented from mpScaleBase.

Definition at line 1041 of file mathplot.cpp.

1042{
1043 if( m_masterScale )
1044 {
1045 computeSlaveTicks( w );
1046 updateTickLabels( dc, w );
1047
1048 return;
1049 }
1050
1051 double minV, maxV, minVvis, maxVvis;
1052 GetDataRange( minV, maxV );
1053 getVisibleDataRange( w, minVvis, maxVvis );
1054
1055 m_absVisibleMaxV = std::max( std::abs( minVvis ), std::abs( maxVvis ) );
1056 m_tickValues.clear();
1057 m_tickLabels.clear();
1058
1059 double minErr = 1000000000000.0;
1060 double bestStep = 1.0;
1061
1062 for( int i = 10; i <= 20; i += 2 )
1063 {
1064 double curr_step = fabs( maxVvis - minVvis ) / (double) i;
1065 double base = pow( 10, floor( log10( curr_step ) ) );
1066 double stepInt = floor( curr_step / base ) * base;
1067 double err = fabs( curr_step - stepInt );
1068
1069 if( err< minErr )
1070 {
1071 minErr = err;
1072 bestStep = stepInt;
1073 }
1074 }
1075
1076
1077 double v = floor( minVvis / bestStep ) * bestStep;
1078
1079 double zeroOffset = 100000000.0;
1080
1081 const int iterLimit = 1000;
1082 int i = 0;
1083
1084 while( v < maxVvis && i < iterLimit )
1085 {
1086 m_tickValues.push_back( v );
1087
1088 if( fabs( v ) < zeroOffset )
1089 zeroOffset = fabs( v );
1090
1091 v += bestStep;
1092 i++;
1093 }
1094
1095
1096 // something weird happened...
1097 if( i == iterLimit )
1098 {
1099 m_tickValues.clear();
1100 }
1101
1102 if( zeroOffset <= bestStep )
1103 {
1104 for( double& t : m_tickValues )
1105 t -= zeroOffset;
1106 }
1107
1108 for( double t : m_tickValues )
1109 m_tickLabels.emplace_back( t );
1110
1111
1112 // n0 = floor(minVvis / bestStep) * bestStep;
1113 // end = n0 +
1114
1115 // n0 = floor( (w.GetPosX() ) / step ) * step ;
1116 updateTickLabels( dc, w );
1117
1118 // labelStep = ceil(((double) m_maxLabelWidth + mpMIN_X_AXIS_LABEL_SEPARATION)/(w.GetScaleX()*step))*step;
1119}
void GetDataRange(double &minV, double &maxV) const
Definition: mathplot.h:732
void updateTickLabels(wxDC &dc, mpWindow &w)
Definition: mathplot.cpp:934
void computeSlaveTicks(mpWindow &w)
Definition: mathplot.cpp:991

References std::abs(), computeSlaveTicks(), mpScaleBase::GetDataRange(), getVisibleDataRange(), mpScaleBase::m_absVisibleMaxV, m_masterScale, mpScaleBase::m_tickLabels, mpScaleBase::m_tickValues, and mpScaleBase::updateTickLabels().

Referenced by Plot().

◆ ResetDataRange()

void mpScaleBase::ResetDataRange ( )
inlineinherited

Definition at line 759 of file mathplot.h.

760 {
761 m_rangeSet = 0;
762 }

Referenced by SIM_PLOT_PANEL::ResetScales().

◆ SetAlign()

void mpScaleY::SetAlign ( int  align)
inline

Set Y axis alignment.

Parameters
alignalignment (choose between mpALIGN_BORDER_LEFT, mpALIGN_LEFT, mpALIGN_CENTER, mpALIGN_RIGHT, mpALIGN_BORDER_RIGHT)

Definition at line 965 of file mathplot.h.

965{ m_flags = align; };

◆ 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; };

◆ 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; }

Referenced by TRACE::TRACE().

◆ SetDataRange()

void mpScaleBase::SetDataRange ( double  minV,
double  maxV 
)
inlineinherited

Definition at line 725 of file mathplot.h.

726 {
727 m_rangeSet = true;
728 m_minV = minV;
729 m_maxV = maxV;
730 }

◆ 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; };

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; }

◆ SetMasterScale()

void mpScaleY::SetMasterScale ( mpScaleY masterScale)
inline

Definition at line 979 of file mathplot.h.

980 {
981 m_masterScale = masterScale;
982 }

Referenced by SIM_PLOT_PANEL::addTrace(), and SIM_PLOT_PANEL::updateAxes().

◆ 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; }

References name.

◆ SetNameAlign()

void mpScaleBase::SetNameAlign ( int  align)
inlineinherited

Definition at line 709 of file mathplot.h.

709{ m_nameFlags = align; }

Referenced by SIM_PLOT_PANEL::updateAxes().

◆ 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; }

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

◆ SetTicks()

void mpScaleY::SetTicks ( bool  ticks)
inline

Set Y axis ticks or grid.

Parameters
tickstrue to plot axis ticks, false to plot grid.

Definition at line 969 of file mathplot.h.

969{ m_ticks = ticks; };

Referenced by SIM_PLOT_PANEL::ShowGrid(), and SIM_PLOT_PANEL::updateAxes().

◆ 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; };

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().

◆ tickCount()

int mpScaleBase::tickCount ( ) const
inlineprotectedinherited

Definition at line 800 of file mathplot.h.

801 {
802 return m_tickValues.size();
803 }

Referenced by mpScaleXBase::Plot(), and Plot().

◆ TickLabels()

std::vector< TickLabel > & mpScaleBase::TickLabels ( )
inlineinherited

Definition at line 789 of file mathplot.h.

789{ return m_tickLabels; };

◆ TransformFromPlot()

double mpScaleY::TransformFromPlot ( double  xplot) const
overridevirtual

Reimplemented from mpScaleBase.

Definition at line 2813 of file mathplot.cpp.

2814{
2815 return xplot / m_scale - m_offset;
2816}

References mpScaleBase::m_offset, and mpScaleBase::m_scale.

Referenced by computeSlaveTicks(), and getVisibleDataRange().

◆ TransformToPlot()

double mpScaleY::TransformToPlot ( double  x) const
overridevirtual

Reimplemented from mpScaleBase.

Definition at line 2807 of file mathplot.cpp.

2808{
2809 return (x + m_offset) * m_scale;
2810}

References mpScaleBase::m_offset, and mpScaleBase::m_scale.

Referenced by computeSlaveTicks(), and Plot().

◆ updateTickLabels()

void mpScaleBase::updateTickLabels ( wxDC &  dc,
mpWindow w 
)
protectedinherited

Definition at line 934 of file mathplot.cpp.

935{
936 formatLabels();
937 computeLabelExtents( dc, w );
938
939 // int gap = IsHorizontal() ? m_maxLabelWidth + 10 : m_maxLabelHeight + 5;
940
941 // if ( m_tickLabels.size() <= 2)
942 // return;
943
944 /*
945 * fixme!
946 *
947 * for ( auto &l : m_tickLabels )
948 * {
949 * double p = TransformToPlot ( l.pos );
950 *
951 * if ( !IsHorizontal() )
952 * l.pixelPos = (int)(( w.GetPosY() - p ) * w.GetScaleY());
953 * else
954 * l.pixelPos = (int)(( p - w.GetPosX()) * w.GetScaleX());
955 * }
956 *
957 *
958 * for (int i = 1; i < m_tickLabels.size() - 1; i++)
959 * {
960 * int dist_prev;
961 *
962 * for(int j = i-1; j >= 1; j--)
963 * {
964 * if( m_tickLabels[j].visible)
965 * {
966 * dist_prev = abs( m_tickLabels[j].pixelPos - m_tickLabels[i].pixelPos );
967 * break;
968 * }
969 * }
970 *
971 * if (dist_prev < gap)
972 * m_tickLabels[i].visible = false;
973 * }
974 */
975}
virtual void formatLabels()
Definition: mathplot.h:811
void computeLabelExtents(wxDC &dc, mpWindow &w)
Definition: mathplot.cpp:917

References mpScaleBase::computeLabelExtents(), and mpScaleBase::formatLabels().

Referenced by mpScaleX::recalculateTicks(), mpScaleXLog::recalculateTicks(), and recalculateTicks().

Member Data Documentation

◆ m_absVisibleMaxV

double mpScaleBase::m_absVisibleMaxV
protectedinherited

◆ 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

bool mpLayer::m_drawOutsideMargins
protectedinherited

◆ m_flags

int mpScaleY::m_flags
protected

Definition at line 1000 of file mathplot.h.

Referenced by Plot().

◆ m_font

◆ m_masterScale

mpScaleY* mpScaleY::m_masterScale
protected

Definition at line 996 of file mathplot.h.

Referenced by computeSlaveTicks(), and recalculateTicks().

◆ m_maxLabelHeight

int mpScaleBase::m_maxLabelHeight
protectedinherited

◆ m_maxLabelWidth

int mpScaleBase::m_maxLabelWidth
protectedinherited

Definition at line 839 of file mathplot.h.

Referenced by mpScaleBase::computeLabelExtents(), and mpScaleBase::mpScaleBase().

◆ m_maxV

double mpScaleBase::m_maxV
protectedinherited

◆ m_minV

double mpScaleBase::m_minV
protectedinherited

◆ m_name

wxString mpLayer::m_name
protectedinherited

◆ m_nameFlags

int mpScaleBase::m_nameFlags
protectedinherited

Definition at line 834 of file mathplot.h.

Referenced by mpScaleBase::mpScaleBase(), mpScaleXBase::Plot(), and Plot().

◆ m_offset

◆ m_pen

◆ m_rangeSet

bool mpScaleBase::m_rangeSet
protectedinherited

Definition at line 837 of file mathplot.h.

Referenced by mpScaleBase::mpScaleBase().

◆ m_scale

◆ m_showName

bool mpLayer::m_showName
protectedinherited

◆ m_tickLabels

std::vector<TickLabel> mpScaleBase::m_tickLabels
protectedinherited

◆ m_ticks

bool mpScaleY::m_ticks
protected

Definition at line 1001 of file mathplot.h.

Referenced by Plot().

◆ m_tickValues

std::vector<double> mpScaleBase::m_tickValues
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: