KiCad PCB EDA Suite
TRACE Class Reference

#include <sim_plot_panel.h>

Inheritance diagram for TRACE:
mpFXYVector mpFXY mpLayer

Public Member Functions

 TRACE (const wxString &aName, SIM_PLOT_TYPE aType, const wxString &aParam)
 
void SetData (const std::vector< double > &aX, const std::vector< double > &aY) override
 Assigns new data set for the trace. More...
 
const std::vector< double > & GetDataX () const
 
const std::vector< double > & GetDataY () const
 
bool HasCursor () const
 
void SetCursor (CURSOR *aCursor)
 
CURSORGetCursor () const
 
SIM_PLOT_TYPE GetType () const
 
void SetTraceColour (wxColour aColour)
 
wxColour GetTraceColour ()
 
const wxString & GetParam () const
 
void Clear ()
 Clears all the data, leaving the layer empty. More...
 
double GetMinX () const override
 Returns the actual minimum X data (loaded in SetData). More...
 
double GetMinY () const override
 Returns the actual minimum Y data (loaded in SetData). More...
 
double GetMaxX () const override
 Returns the actual maximum X data (loaded in SetData). More...
 
double GetMaxY () const override
 Returns the actual maximum Y data (loaded in SetData). More...
 
virtual void Plot (wxDC &dc, mpWindow &w) override
 Layer plot handler. More...
 
virtual void SetScale (mpScaleBase *scaleX, mpScaleBase *scaleY)
 
void UpdateScales ()
 
double s2x (double plotCoordX) const
 
double s2y (double plotCoordY) const
 
double x2s (double x) const
 
double y2s (double y) const
 
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...
 
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

void Rewind () override
 Rewind value enumeration with mpFXY::GetNextXY. More...
 
bool GetNextXY (double &x, double &y) override
 Get locus value for next N. More...
 
size_t GetCount () const override
 
void UpdateViewBoundary (wxCoord xnew, wxCoord ynew)
 Update label positioning data. More...
 

Protected Attributes

CURSORm_cursor
 
SIM_PLOT_TYPE m_type
 
wxColour m_traceColour
 
std::vector< double > m_xs
 The internal copy of the set of data to draw. More...
 
std::vector< double > m_ys
 
size_t m_index
 The internal counter for the "GetNextXY" interface. More...
 
double m_minX
 Loaded at SetData. More...
 
double m_maxX
 
double m_minY
 
double m_maxY
 
int m_flags
 
wxCoord maxDrawX
 
wxCoord minDrawX
 
wxCoord maxDrawY
 
wxCoord minDrawY
 
mpScaleBasem_scaleX
 
mpScaleBasem_scaleY
 
wxFont m_font
 
wxPen m_pen
 
wxBrush m_brush
 
wxString m_name
 
bool m_continuous
 
bool m_showName
 
bool m_drawOutsideMargins
 
bool m_visible
 

Private Attributes

wxString m_param
 < Name of the signal parameter More...
 

Detailed Description

Definition at line 94 of file sim_plot_panel.h.

Constructor & Destructor Documentation

◆ TRACE()

TRACE::TRACE ( const wxString &  aName,
SIM_PLOT_TYPE  aType,
const wxString &  aParam 
)
inline

Definition at line 97 of file sim_plot_panel.h.

97  :
98  mpFXYVector( aName ), m_cursor( nullptr ), m_type( aType ), m_param( aParam )
99  {
100  SetContinuity( true );
101  SetDrawOutsideMargins( false );
102  ShowName( false );
103  }
void ShowName(bool show)
Shows or hides the text label with the name of the layer (default is visible).
Definition: mathplot.h:262
void SetContinuity(bool continuity)
Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points...
Definition: mathplot.h:253
SIM_PLOT_TYPE m_type
wxString m_param
< Name of the signal parameter
void SetDrawOutsideMargins(bool drawModeOutside)
Set Draw mode: inside or outside margins.
Definition: mathplot.h:281
mpFXYVector(const wxString &name=wxEmptyString, int flags=mpALIGN_NE)
Definition: mathplot.cpp:2784
CURSOR * m_cursor

References mpLayer::SetContinuity(), mpLayer::SetDrawOutsideMargins(), and mpLayer::ShowName().

Member Function Documentation

◆ Clear()

void mpFXYVector::Clear ( )
inherited

Clears all the data, leaving the layer empty.

See also
SetData

Definition at line 2873 of file mathplot.cpp.

2874 {
2875  m_xs.clear();
2876  m_ys.clear();
2877 }
std::vector< double > m_xs
The internal copy of the set of data to draw.
Definition: mathplot.h:1593
std::vector< double > m_ys
Definition: mathplot.h:1593

References mpFXYVector::m_xs, and mpFXYVector::m_ys.

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

◆ GetCount()

size_t mpFXYVector::GetCount ( ) const
overrideprotectedvirtualinherited

Implements mpFXY.

Definition at line 2852 of file mathplot.cpp.

2853 {
2854  return m_xs.size();
2855 }
std::vector< double > m_xs
The internal copy of the set of data to draw.
Definition: mathplot.h:1593

References mpFXYVector::m_xs.

◆ GetCursor()

CURSOR* TRACE::GetCursor ( ) const
inline

Definition at line 139 of file sim_plot_panel.h.

140  {
141  return m_cursor;
142  }
CURSOR * m_cursor

References m_cursor.

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

◆ GetDataX()

const std::vector<double>& TRACE::GetDataX ( ) const
inline

Definition at line 119 of file sim_plot_panel.h.

120  {
121  return m_xs;
122  }
std::vector< double > m_xs
The internal copy of the set of data to draw.
Definition: mathplot.h:1593

References mpFXYVector::m_xs.

Referenced by SIM_PLOT_FRAME::menuSaveCsv(), and CURSOR::Plot().

◆ GetDataY()

const std::vector<double>& TRACE::GetDataY ( ) const
inline

Definition at line 124 of file sim_plot_panel.h.

125  {
126  return m_ys;
127  }
std::vector< double > m_ys
Definition: mathplot.h:1593

References mpFXYVector::m_ys.

Referenced by SIM_PLOT_FRAME::menuSaveCsv(), and CURSOR::Plot().

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

double mpFXYVector::GetMaxX ( ) const
inlineoverridevirtualinherited

Returns the actual maximum X data (loaded in SetData).

Reimplemented from mpLayer.

Definition at line 1628 of file mathplot.h.

1628 { return m_maxX; }
double m_maxX
Definition: mathplot.h:1601

◆ GetMaxY()

double mpFXYVector::GetMaxY ( ) const
inlineoverridevirtualinherited

Returns the actual maximum Y data (loaded in SetData).

Reimplemented from mpLayer.

Definition at line 1632 of file mathplot.h.

1632 { return m_maxY; }
double m_maxY
Definition: mathplot.h:1601

◆ GetMinX()

double mpFXYVector::GetMinX ( ) const
inlineoverridevirtualinherited

Returns the actual minimum X data (loaded in SetData).

Reimplemented from mpLayer.

Definition at line 1620 of file mathplot.h.

1620 { return m_minX; }
double m_minX
Loaded at SetData.
Definition: mathplot.h:1601

◆ GetMinY()

double mpFXYVector::GetMinY ( ) const
inlineoverridevirtualinherited

Returns the actual minimum Y data (loaded in SetData).

Reimplemented from mpLayer.

Definition at line 1624 of file mathplot.h.

1624 { return m_minY; }
double m_minY
Definition: mathplot.h:1601

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

◆ GetNextXY()

bool mpFXYVector::GetNextXY ( double &  x,
double &  y 
)
overrideprotectedvirtualinherited

Get locus value for next N.

Overridden in this implementation.

Parameters
xReturns X value
yReturns Y value

Implements mpFXY.

Definition at line 2858 of file mathplot.cpp.

2859 {
2860  if( m_index >= m_xs.size() )
2861  {
2862  return false;
2863  }
2864  else
2865  {
2866  x = m_xs[m_index];
2867  y = m_ys[m_index++];
2868  return m_index <= m_xs.size();
2869  }
2870 }
std::vector< double > m_xs
The internal copy of the set of data to draw.
Definition: mathplot.h:1593
std::vector< double > m_ys
Definition: mathplot.h:1593
size_t m_index
The internal counter for the "GetNextXY" interface.
Definition: mathplot.h:1597

References mpFXYVector::m_index, mpFXYVector::m_xs, and mpFXYVector::m_ys.

◆ GetParam()

const wxString& TRACE::GetParam ( ) const
inline

Definition at line 159 of file sim_plot_panel.h.

160  {
161  return m_param;
162  }
wxString m_param
< Name of the signal parameter

References m_param.

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

◆ GetTraceColour()

wxColour TRACE::GetTraceColour ( )
inline

Definition at line 154 of file sim_plot_panel.h.

155  {
156  return m_traceColour;
157  }
wxColour m_traceColour

References m_traceColour.

Referenced by SIM_PLOT_COLORS::GenerateColor(), and SIM_PLOT_PANEL::UpdateTraceStyle().

◆ GetType()

SIM_PLOT_TYPE TRACE::GetType ( ) const
inline

Definition at line 144 of file sim_plot_panel.h.

145  {
146  return m_type;
147  }
SIM_PLOT_TYPE m_type

References m_type.

Referenced by SIM_PLOT_PANEL::UpdateTraceStyle().

◆ HasBBox()

virtual bool mpLayer::HasBBox ( ) const
inlinevirtualinherited

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.

Return values
trueHas bounding box
falseHas not bounding box

Reimplemented in mpBitmapLayer, mpMovableObject, mpText, mpScaleY, mpScaleBase, and mpInfoLayer.

Definition at line 161 of file mathplot.h.

161 { return true; }

◆ HasCursor()

bool TRACE::HasCursor ( ) const
inline

Definition at line 129 of file sim_plot_panel.h.

130  {
131  return m_cursor != nullptr;
132  }
CURSOR * m_cursor

References m_cursor.

Referenced by SIM_PLOT_PANEL::EnableCursor(), SIM_PLOT_PANEL::HasCursorEnabled(), and SIM_PLOT_FRAME::SIGNAL_CONTEXT_MENU::SIGNAL_CONTEXT_MENU().

◆ 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 mpFXY::Plot ( wxDC &  dc,
mpWindow w 
)
overridevirtualinherited

Layer plot handler.

This implementation will plot the locus in the visible area and put a label according to the alignment specified.

Implements mpLayer.

Definition at line 562 of file mathplot.cpp.

563 {
564  if( m_visible )
565  {
566  dc.SetPen( m_pen );
567 
568  double x, y;
569  // Do this to reset the counters to evaluate bounding box for label positioning
570  Rewind(); GetNextXY( x, y );
571  maxDrawX = x; minDrawX = x; maxDrawY = y; minDrawY = y;
572  // drawnPoints = 0;
573  Rewind();
574 
575  wxCoord startPx = m_drawOutsideMargins ? 0 : w.GetMarginLeft();
576  wxCoord endPx = m_drawOutsideMargins ? w.GetScrX() : w.GetScrX() - w.GetMarginRight();
577  wxCoord minYpx = m_drawOutsideMargins ? 0 : w.GetMarginTop();
578  wxCoord maxYpx = m_drawOutsideMargins ? w.GetScrY() : w.GetScrY() - w.GetMarginBottom();
579 
580  dc.SetClippingRegion( startPx, minYpx, endPx - startPx + 1, maxYpx - minYpx + 1 );
581 
582  if( !m_continuous )
583  {
584  bool first = true;
585  wxCoord ix = 0;
586  std::set<wxCoord> ys;
587 
588  while( GetNextXY( x, y ) )
589  {
590  double px = m_scaleX->TransformToPlot( x );
591  double py = m_scaleY->TransformToPlot( y );
592  wxCoord newX = w.x2p( px );
593 
594  if( first )
595  {
596  ix = newX;
597  first = false;
598  }
599 
600  if( newX == ix ) // continue until a new X coordinate is reached
601  {
602  // collect all unique points
603  ys.insert( w.y2p( py ) );
604  continue;
605  }
606 
607  for( auto& iy: ys )
608  {
610  || ( (ix >= startPx) && (ix <= endPx) && (iy >= minYpx)
611  && (iy <= maxYpx) ) )
612  {
613  // for some reason DrawPoint does not use the current pen,
614  // so we use DrawLine for fat pens
615  if( m_pen.GetWidth() <= 1 )
616  {
617  dc.DrawPoint( ix, iy );
618  }
619  else
620  {
621  dc.DrawLine( ix, iy, ix, iy );
622  }
623 
624  UpdateViewBoundary( ix, iy );
625  }
626  }
627 
628  ys.clear();
629  ix = newX;
630  ys.insert( w.y2p( py ) );
631  }
632  }
633  else
634  {
635  int count = 0;
636  int x0=0; // X position of merged current vertical line
637  int ymin0=0; // y min coord of merged current vertical line
638  int ymax0=0; // y max coord of merged current vertical line
639  int dupx0 = 0; // count of currently merged vertical lines
640  wxPoint line_start; // starting point of the current line to draw
641 
642  // A buffer to store coordinates of lines to draw
643  std::vector<wxPoint>pointList;
644  pointList.reserve( endPx - startPx + 1 );
645 
646  // Note: we can use dc.DrawLines() only for a reasonable number or points (<10000),
647  // because at least on Windows dc.DrawLines() can hang for a lot of points.
648  // (> 10000 points) (can happens when a lot of points is calculated)
649  // To avoid long draw time (and perhaps hanging) one plot only not redundant lines.
650  // To avoid artifacts when skipping points to the same x coordinate, for each
651  // group of points at a give, x coordinate we also draw a vertical line at this coord,
652  // from the ymin to the ymax vertical coordinates of skipped points
653  while( GetNextXY( x, y ) )
654  {
655  double px = m_scaleX->TransformToPlot( x );
656  double py = m_scaleY->TransformToPlot( y );
657 
658  wxCoord x1 = w.x2p( px );
659  wxCoord y1 = w.y2p( py );
660 
661  // Store only points on the drawing area, to speed up the drawing time
662  // Note: x1 is a value truncated from px by w.x2p(). So to be sure the
663  // first point is drawn, the x1 low limit is startPx-1 in plot coordinates
664  if( x1 >= startPx-1 && x1 <= endPx )
665  {
666  if( !count || line_start.x != x1 )
667  {
668  if( count && dupx0 > 1 && ymin0 != ymax0 )
669  {
670  // Vertical points are merged, draw the pending vertical line
671  // However, if the line is one pixel length, it is not drawn,
672  // because the main trace show this point
673  dc.DrawLine( x0, ymin0, x0, ymax0 );
674  }
675 
676  x0 = x1;
677  ymin0 = ymax0 = y1;
678  dupx0 = 0;
679 
680  pointList.emplace_back( wxPoint( x1, y1 ) );
681 
682  line_start.x = x1;
683  line_start.y = y1;
684  count++;
685  }
686  else
687  {
688  ymin0 = std::min( ymin0, y1 );
689  ymax0 = std::max( ymax0, y1 );
690  x0 = x1;
691  dupx0++;
692  }
693  }
694  }
695 
696  if( pointList.size() > 1 )
697  {
698  // For a better look (when using dashed lines) and more optimization,
699  // try to merge horizontal segments, in order to plot longer lines
700  // we are merging horizontal segments because this is easy,
701  // and horizontal segments are a frequent cases
702  std::vector<wxPoint> drawPoints;
703  drawPoints.reserve( endPx - startPx + 1 );
704 
705  drawPoints.push_back( pointList[0] ); // push the first point in list
706 
707  for( size_t ii = 1; ii < pointList.size()-1; ii++ )
708  {
709  // Skip intermediate points between the first point and the last
710  // point of the segment candidate
711  if( drawPoints.back().y == pointList[ii].y &&
712  drawPoints.back().y == pointList[ii+1].y )
713  continue;
714  else
715  drawPoints.push_back( pointList[ii] );
716  }
717 
718  // push the last point to draw in list
719  if( drawPoints.back() != pointList.back() )
720  drawPoints.push_back( pointList.back() );
721 
722  dc.DrawLines( drawPoints.size(), &drawPoints[0] );
723  }
724  }
725 
726  if( !m_name.IsEmpty() && m_showName )
727  {
728  dc.SetFont( m_font );
729 
730  wxCoord tx, ty;
731  dc.GetTextExtent( m_name, &tx, &ty );
732 
733  // xxx implement else ... if (!HasBBox())
734  {
735  // const int sx = w.GetScrX();
736  // const int sy = w.GetScrY();
737 
738  if( (m_flags & mpALIGNMASK) == mpALIGN_NW )
739  {
740  tx = minDrawX + 8;
741  ty = maxDrawY + 8;
742  }
743  else if( (m_flags & mpALIGNMASK) == mpALIGN_NE )
744  {
745  tx = maxDrawX - tx - 8;
746  ty = maxDrawY + 8;
747  }
748  else if( (m_flags & mpALIGNMASK) == mpALIGN_SE )
749  {
750  tx = maxDrawX - tx - 8;
751  ty = minDrawY - ty - 8;
752  }
753  else
754  {
755  // mpALIGN_SW
756  tx = minDrawX + 8;
757  ty = minDrawY - ty - 8;
758  }
759  }
760 
761  dc.DrawText( m_name, tx, ty );
762  }
763  }
764 
765  dc.DestroyClippingRegion();
766 }
wxCoord maxDrawY
Definition: mathplot.h:631
int GetMarginBottom() const
Definition: mathplot.h:1375
bool m_continuous
Definition: mathplot.h:318
#define mpALIGN_NW
Aligns label to north-west.
Definition: mathplot.h:507
bool m_visible
Definition: mathplot.h:322
mpScaleBase * m_scaleY
Definition: mathplot.h:633
virtual double TransformToPlot(double x) const
Definition: mathplot.h:774
int GetMarginRight() const
Definition: mathplot.h:1373
wxCoord y2p(double y)
Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates,...
Definition: mathplot.h:1207
int GetScrX(void) const
Get current view's X dimension in device context units.
Definition: mathplot.h:1138
wxCoord minDrawY
Definition: mathplot.h:631
int GetMarginTop() const
Definition: mathplot.h:1371
wxFont m_font
Definition: mathplot.h:310
#define mpALIGN_NE
Aligns label to north-east.
Definition: mathplot.h:505
int m_flags
Definition: mathplot.h:628
#define mpALIGNMASK
Definition: mathplot.h:475
bool m_drawOutsideMargins
Definition: mathplot.h:320
void UpdateViewBoundary(wxCoord xnew, wxCoord ynew)
Update label positioning data.
Definition: mathplot.cpp:551
virtual bool GetNextXY(double &x, double &y)=0
Get locus value for next N.
bool m_showName
Definition: mathplot.h:319
wxCoord minDrawX
Definition: mathplot.h:631
wxCoord x2p(double x)
Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates,...
Definition: mathplot.h:1202
wxPen m_pen
Definition: mathplot.h:315
virtual void Rewind()=0
Rewind value enumeration with mpFXY::GetNextXY.
mpScaleBase * m_scaleX
Definition: mathplot.h:633
int GetMarginLeft() const
Definition: mathplot.h:1377
wxString m_name
Definition: mathplot.h:317
wxCoord maxDrawX
Definition: mathplot.h:631
#define mpALIGN_SE
Aligns label to south-east.
Definition: mathplot.h:511
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(), mpFXY::GetNextXY(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpLayer::m_continuous, mpLayer::m_drawOutsideMargins, mpFXY::m_flags, mpLayer::m_font, mpLayer::m_name, mpLayer::m_pen, mpFXY::m_scaleX, mpFXY::m_scaleY, mpLayer::m_showName, mpLayer::m_visible, mpFXY::maxDrawX, mpFXY::maxDrawY, mpFXY::minDrawX, mpFXY::minDrawY, mpALIGN_NE, mpALIGN_NW, mpALIGN_SE, mpALIGNMASK, mpFXY::Rewind(), mpScaleBase::TransformToPlot(), mpFXY::UpdateViewBoundary(), mpWindow::x2p(), and mpWindow::y2p().

◆ Rewind()

void mpFXYVector::Rewind ( )
overrideprotectedvirtualinherited

Rewind value enumeration with mpFXY::GetNextXY.

Overridden in this implementation.

Implements mpFXY.

Definition at line 2847 of file mathplot.cpp.

2848 {
2849  m_index = 0;
2850 }
size_t m_index
The internal counter for the "GetNextXY" interface.
Definition: mathplot.h:1597

References mpFXYVector::m_index.

◆ s2x()

double mpFXY::s2x ( double  plotCoordX) const
inherited

Definition at line 3542 of file mathplot.cpp.

3543 {
3544  return m_scaleX->TransformFromPlot( plotCoordX );
3545 }
virtual double TransformFromPlot(double xplot) const
Definition: mathplot.h:775
mpScaleBase * m_scaleX
Definition: mathplot.h:633

References mpFXY::m_scaleX, and mpScaleBase::TransformFromPlot().

Referenced by CURSOR::Plot().

◆ s2y()

double mpFXY::s2y ( double  plotCoordY) const
inherited

Definition at line 3548 of file mathplot.cpp.

3549 {
3550  return m_scaleY->TransformFromPlot( plotCoordY );
3551 }
virtual double TransformFromPlot(double xplot) const
Definition: mathplot.h:775
mpScaleBase * m_scaleY
Definition: mathplot.h:633

References mpFXY::m_scaleY, and mpScaleBase::TransformFromPlot().

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

◆ SetCursor()

void TRACE::SetCursor ( CURSOR aCursor)
inline

Definition at line 134 of file sim_plot_panel.h.

135  {
136  m_cursor = aCursor;
137  }
CURSOR * m_cursor

References m_cursor.

Referenced by SIM_PLOT_PANEL::EnableCursor().

◆ SetData()

void TRACE::SetData ( const std::vector< double > &  aX,
const std::vector< double > &  aY 
)
inlineoverridevirtual

Assigns new data set for the trace.

aX and aY need to have the same length.

Parameters
aXare the X axis values.
aYare the Y axis values.

Reimplemented from mpFXYVector.

Definition at line 111 of file sim_plot_panel.h.

112  {
113  if( m_cursor )
114  m_cursor->Update();
115 
116  mpFXYVector::SetData( aX, aY );
117  }
void Update()
virtual void SetData(const std::vector< double > &xs, const std::vector< double > &ys)
Changes the internal data: the set of points to draw.
Definition: mathplot.cpp:2880
CURSOR * m_cursor

References m_cursor, mpFXYVector::SetData(), and CURSOR::Update().

Referenced by SIM_PLOT_PANEL::addTrace().

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

◆ 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:56
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().

◆ SetScale()

void mpFXY::SetScale ( mpScaleBase scaleX,
mpScaleBase scaleY 
)
virtualinherited

Definition at line 3523 of file mathplot.cpp.

3524 {
3525  m_scaleX = scaleX;
3526  m_scaleY = scaleY;
3527 
3528  UpdateScales();
3529 }
mpScaleBase * m_scaleY
Definition: mathplot.h:633
void UpdateScales()
Definition: mathplot.cpp:3532
mpScaleBase * m_scaleX
Definition: mathplot.h:633

References mpFXY::m_scaleX, mpFXY::m_scaleY, and mpFXY::UpdateScales().

Referenced by SIM_PLOT_PANEL::addTrace().

◆ SetTraceColour()

void TRACE::SetTraceColour ( wxColour  aColour)
inline

Definition at line 149 of file sim_plot_panel.h.

150  {
151  m_traceColour = aColour;
152  }
wxColour m_traceColour

References m_traceColour.

Referenced by SIM_PLOT_PANEL::addTrace().

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

◆ UpdateScales()

void mpFXY::UpdateScales ( )
inherited

Definition at line 3532 of file mathplot.cpp.

3533 {
3534  if( m_scaleX )
3536 
3537  if( m_scaleY )
3539 }
virtual double GetMaxY() const
Get inclusive top border of bounding box.
Definition: mathplot.h:190
virtual double GetMaxX() const
Get inclusive right border of bounding box.
Definition: mathplot.h:180
void ExtendDataRange(double minV, double maxV)
Definition: mathplot.h:738
mpScaleBase * m_scaleY
Definition: mathplot.h:633
virtual double GetMinX() const
Get inclusive left border of bounding box.
Definition: mathplot.h:175
virtual double GetMinY() const
Get inclusive bottom border of bounding box.
Definition: mathplot.h:185
mpScaleBase * m_scaleX
Definition: mathplot.h:633

References mpScaleBase::ExtendDataRange(), mpLayer::GetMaxX(), mpLayer::GetMaxY(), mpLayer::GetMinX(), mpLayer::GetMinY(), mpFXY::m_scaleX, and mpFXY::m_scaleY.

Referenced by mpFXY::SetScale().

◆ UpdateViewBoundary()

void mpFXY::UpdateViewBoundary ( wxCoord  xnew,
wxCoord  ynew 
)
protectedinherited

Update label positioning data.

Parameters
xnewNew x coordinate
ynewNew y coordinate

Definition at line 551 of file mathplot.cpp.

552 {
553  // Keep track of how many points have been drawn and the bounding box
554  maxDrawX = (xnew > maxDrawX) ? xnew : maxDrawX;
555  minDrawX = (xnew < minDrawX) ? xnew : minDrawX;
556  maxDrawY = (maxDrawY > ynew) ? maxDrawY : ynew;
557  minDrawY = (minDrawY < ynew) ? minDrawY : ynew;
558  // drawnPoints++;
559 }
wxCoord maxDrawY
Definition: mathplot.h:631
wxCoord minDrawY
Definition: mathplot.h:631
wxCoord minDrawX
Definition: mathplot.h:631
wxCoord maxDrawX
Definition: mathplot.h:631

References mpFXY::maxDrawX, mpFXY::maxDrawY, mpFXY::minDrawX, and mpFXY::minDrawY.

Referenced by mpFXY::Plot().

◆ x2s()

double mpFXY::x2s ( double  x) const
inherited

Definition at line 3554 of file mathplot.cpp.

3555 {
3556  return m_scaleX->TransformToPlot( x );
3557 }
virtual double TransformToPlot(double x) const
Definition: mathplot.h:774
mpScaleBase * m_scaleX
Definition: mathplot.h:633

References mpFXY::m_scaleX, and mpScaleBase::TransformToPlot().

Referenced by CURSOR::Inside(), CURSOR::Plot(), and CURSOR::UpdateReference().

◆ y2s()

double mpFXY::y2s ( double  y) const
inherited

Definition at line 3560 of file mathplot.cpp.

3561 {
3562  return m_scaleY->TransformToPlot( y );
3563 }
mpScaleBase * m_scaleY
Definition: mathplot.h:633
virtual double TransformToPlot(double x) const
Definition: mathplot.h:774

References mpFXY::m_scaleY, and mpScaleBase::TransformToPlot().

Referenced by CURSOR::Inside(), CURSOR::Plot(), and CURSOR::UpdateReference().

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_cursor

CURSOR* TRACE::m_cursor
protected

Definition at line 166 of file sim_plot_panel.h.

Referenced by GetCursor(), HasCursor(), SetCursor(), and SetData().

◆ m_drawOutsideMargins

◆ m_flags

int mpFXY::m_flags
protectedinherited

Definition at line 628 of file mathplot.h.

Referenced by mpFXY::Plot().

◆ m_font

◆ m_index

size_t mpFXYVector::m_index
protectedinherited

The internal counter for the "GetNextXY" interface.

Definition at line 1597 of file mathplot.h.

Referenced by mpFXYVector::GetNextXY(), and mpFXYVector::Rewind().

◆ m_maxX

double mpFXYVector::m_maxX
protectedinherited

Definition at line 1601 of file mathplot.h.

Referenced by mpFXYVector::SetData().

◆ m_maxY

double mpFXYVector::m_maxY
protectedinherited

Definition at line 1601 of file mathplot.h.

Referenced by mpFXYVector::SetData().

◆ m_minX

double mpFXYVector::m_minX
protectedinherited

Loaded at SetData.

Definition at line 1601 of file mathplot.h.

Referenced by mpFXYVector::SetData().

◆ m_minY

double mpFXYVector::m_minY
protectedinherited

Definition at line 1601 of file mathplot.h.

Referenced by mpFXYVector::SetData().

◆ m_name

wxString mpLayer::m_name
protectedinherited

◆ m_param

wxString TRACE::m_param
private

< Name of the signal parameter

Definition at line 172 of file sim_plot_panel.h.

Referenced by GetParam().

◆ m_pen

◆ m_scaleX

mpScaleBase* mpFXY::m_scaleX
protectedinherited

Definition at line 633 of file mathplot.h.

Referenced by mpFXY::Plot(), mpFXY::s2x(), mpFXY::SetScale(), mpFXY::UpdateScales(), and mpFXY::x2s().

◆ m_scaleY

mpScaleBase * mpFXY::m_scaleY
protectedinherited

Definition at line 633 of file mathplot.h.

Referenced by mpFXY::Plot(), mpFXY::s2y(), mpFXY::SetScale(), mpFXY::UpdateScales(), and mpFXY::y2s().

◆ m_showName

bool mpLayer::m_showName
protectedinherited

◆ m_traceColour

wxColour TRACE::m_traceColour
protected

Definition at line 168 of file sim_plot_panel.h.

Referenced by GetTraceColour(), and SetTraceColour().

◆ m_type

SIM_PLOT_TYPE TRACE::m_type
protected

Definition at line 167 of file sim_plot_panel.h.

Referenced by GetType().

◆ m_visible

◆ m_xs

std::vector<double> mpFXYVector::m_xs
protectedinherited

The internal copy of the set of data to draw.

Definition at line 1593 of file mathplot.h.

Referenced by mpFXYVector::Clear(), mpFXYVector::GetCount(), GetDataX(), mpFXYVector::GetNextXY(), and mpFXYVector::SetData().

◆ m_ys

std::vector<double> mpFXYVector::m_ys
protectedinherited

◆ maxDrawX

wxCoord mpFXY::maxDrawX
protectedinherited

Definition at line 631 of file mathplot.h.

Referenced by mpFXY::Plot(), and mpFXY::UpdateViewBoundary().

◆ maxDrawY

wxCoord mpFXY::maxDrawY
protectedinherited

Definition at line 631 of file mathplot.h.

Referenced by mpFXY::Plot(), and mpFXY::UpdateViewBoundary().

◆ minDrawX

wxCoord mpFXY::minDrawX
protectedinherited

Definition at line 631 of file mathplot.h.

Referenced by mpFXY::Plot(), and mpFXY::UpdateViewBoundary().

◆ minDrawY

wxCoord mpFXY::minDrawY
protectedinherited

Definition at line 631 of file mathplot.h.

Referenced by mpFXY::Plot(), and mpFXY::UpdateViewBoundary().


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