KiCad PCB EDA Suite
Loading...
Searching...
No Matches
mpFXY Class Referenceabstract

Abstract base class providing plot and labeling functionality for a locus plot F:N->X,Y. More...

#include <mathplot.h>

Inheritance diagram for mpFXY:
mpLayer mpFXYVector TRACE

Public Member Functions

 mpFXY (const wxString &name=wxEmptyString, int flags=mpALIGN_NE)
 
virtual void Rewind ()=0
 Rewind value enumeration with mpFXY::GetNextXY.
 
virtual void SetSweepWindow (int aSweepIdx)
 
virtual bool GetNextXY (double &x, double &y)=0
 Get locus value for next N.
 
virtual size_t GetCount () const =0
 
virtual int GetSweepCount () const
 
virtual void Plot (wxDC &dc, mpWindow &w) override
 Layer plot handler.
 
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.
 
virtual bool IsInfo () const
 Check whether the layer is an info box.
 
virtual double GetMinX () const
 Get inclusive left border of bounding box.
 
virtual double GetMaxX () const
 Get inclusive right border of bounding box.
 
virtual double GetMinY () const
 Get inclusive bottom border of bounding box.
 
virtual double GetMaxY () const
 Get inclusive top border of bounding box.
 
const wxString & GetName () const
 Get layer name.
 
const wxString & GetDisplayName () const
 
const wxFont & GetFont () const
 Get font set for this layer.
 
const wxPen & GetPen () const
 Get pen set for this layer.
 
void SetContinuity (bool continuity)
 Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).
 
bool GetContinuity () const
 Gets the 'continuity' property of the layer.
 
void ShowName (bool show)
 Shows or hides the text label with the name of the layer (default is visible).
 
virtual void SetName (const wxString &name)
 Set layer name.
 
void SetFont (const wxFont &font)
 Set layer font.
 
void SetPen (const wxPen &pen)
 Set layer pen.
 
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.
 
bool IsVisible () const
 Checks whether the layer is visible or not.
 
void SetVisible (bool show)
 Sets layer visibility.
 
const wxBrush & GetBrush () const
 Get brush set for this layer.
 
void SetBrush (const wxBrush &brush)
 Set layer brush.
 

Protected Member Functions

void UpdateViewBoundary (wxCoord xnew, wxCoord ynew)
 Update label positioning data.
 

Protected Attributes

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
 
wxString m_displayName
 
bool m_continuous
 
bool m_showName
 
mpLayerType m_type
 
bool m_visible
 

Detailed Description

Abstract base class providing plot and labeling functionality for a locus plot F:N->X,Y.

Locus argument N is assumed to be in range 0 .. MAX_N, and implicitly derived by enumerating all locus values. Override mpFXY::Rewind and mpFXY::GetNextXY to implement a locus. Optionally implement a constructor and pass a name (label) and a label alignment to the constructor mpFXY::mpFXY. If the layer name is empty, no label will be plotted.

Definition at line 541 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpFXY()

mpFXY::mpFXY ( const wxString &  name = wxEmptyString,
int  flags = mpALIGN_NE 
)
Parameters
nameLabel
flagsLabel alignment, pass one of mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE.

Definition at line 415 of file mathplot.cpp.

References mpLAYER_PLOT, and name.

Member Function Documentation

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const
inlineinherited

Get brush set for this layer.

Returns
brush.

Definition at line 299 of file mathplot.h.

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const
inlineinherited

Gets the 'continuity' property of the layer.

See also
SetContinuity

Definition at line 264 of file mathplot.h.

◆ GetCount()

virtual size_t mpFXY::GetCount ( ) const
pure virtual

Implemented in mpFXYVector.

Referenced by Plot().

◆ GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const
inlineinherited

Definition at line 241 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const
inlineinherited

Get font set for this layer.

Returns
Font

Definition at line 249 of file mathplot.h.

◆ 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 287 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

◆ GetMaxX()

virtual double mpLayer::GetMaxX ( ) const
inlinevirtualinherited

Get inclusive right border of bounding box.

Returns
Value

Reimplemented in mpFXYVector.

Definition at line 181 of file mathplot.h.

Referenced by UpdateScales().

◆ GetMaxY()

virtual double mpLayer::GetMaxY ( ) const
inlinevirtualinherited

Get inclusive top border of bounding box.

Returns
Value

Reimplemented in mpFXYVector.

Definition at line 191 of file mathplot.h.

Referenced by UpdateScales().

◆ GetMinX()

virtual double mpLayer::GetMinX ( ) const
inlinevirtualinherited

Get inclusive left border of bounding box.

Returns
Value

Reimplemented in mpFXYVector.

Definition at line 176 of file mathplot.h.

Referenced by UpdateScales().

◆ GetMinY()

virtual double mpLayer::GetMinY ( ) const
inlinevirtualinherited

Get inclusive bottom border of bounding box.

Returns
Value

Reimplemented in mpFXYVector.

Definition at line 186 of file mathplot.h.

Referenced by UpdateScales().

◆ GetName()

const wxString & mpLayer::GetName ( ) const
inlineinherited

◆ GetNextXY()

virtual bool mpFXY::GetNextXY ( double &  x,
double &  y 
)
pure virtual

Get locus value for next N.

Override this function in your implementation.

Parameters
xReturns X value
yReturns Y value

Implemented in mpFXYVector.

Referenced by Plot().

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const
inlineinherited

Get pen set for this layer.

Returns
Pen

Definition at line 254 of file mathplot.h.

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

◆ GetSweepCount()

virtual int mpFXY::GetSweepCount ( ) const
inlinevirtual

Reimplemented in mpFXYVector.

Definition at line 563 of file mathplot.h.

Referenced by Plot().

◆ 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 mpInfoLayer, mpScaleBase, and mpScaleY.

Definition at line 162 of file mathplot.h.

◆ 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 171 of file mathplot.h.

◆ IsVisible()

bool mpLayer::IsVisible ( ) const
inlineinherited

Checks whether the layer is visible or not.

Returns
true if visible

Definition at line 291 of file mathplot.h.

Referenced by SIM_PLOT_TAB::IsLegendShown(), and mpInfoLegend::Plot().

◆ Plot()

◆ Rewind()

virtual void mpFXY::Rewind ( )
pure virtual

Rewind value enumeration with mpFXY::GetNextXY.

Override this function in your implementation.

Implemented in mpFXYVector.

Referenced by Plot().

◆ s2x()

double mpFXY::s2x ( double  plotCoordX) const

Definition at line 2694 of file mathplot.cpp.

References m_scaleX, and mpScaleBase::TransformFromPlot().

Referenced by CURSOR::Plot().

◆ s2y()

double mpFXY::s2y ( double  plotCoordY) const

Definition at line 2700 of file mathplot.cpp.

References m_scaleY, and mpScaleBase::TransformFromPlot().

◆ SetBrush()

void mpLayer::SetBrush ( const wxBrush &  brush)
inlineinherited

Set layer brush.

Parameters
brushbrush, will be copied to internal class member

Definition at line 303 of file mathplot.h.

◆ 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 259 of file mathplot.h.

Referenced by TRACE::TRACE().

◆ SetFont()

void mpLayer::SetFont ( const wxFont &  font)
inlineinherited

Set layer font.

Parameters
fontFont, will be copied to internal class member

Definition at line 278 of file mathplot.h.

Referenced by SIM_PLOT_TAB::updateAxes().

◆ SetName()

virtual void mpLayer::SetName ( const wxString &  name)
inlinevirtualinherited

Set layer name.

Parameters
nameName, will be copied to internal class member

Reimplemented in TRACE.

Definition at line 273 of file mathplot.h.

References name.

Referenced by SIM_PLOT_TAB::prepareDCAxes(), TRACE::SetName(), and SIM_PLOT_TAB::updateAxes().

◆ SetPen()

void mpLayer::SetPen ( const wxPen &  pen)
inlineinherited

Set layer pen.

Parameters
penPen, will be copied to internal class member

Definition at line 283 of file mathplot.h.

Referenced by SIM_PLOT_TAB::UpdateTraceStyle().

◆ SetScale()

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

Definition at line 2675 of file mathplot.cpp.

References m_scaleX, m_scaleY, and UpdateScales().

Referenced by SIM_PLOT_TAB::SetTraceData().

◆ SetSweepWindow()

virtual void mpFXY::SetSweepWindow ( int  aSweepIdx)
inlinevirtual

Reimplemented in mpFXYVector.

Definition at line 553 of file mathplot.h.

Referenced by Plot().

◆ SetVisible()

void mpLayer::SetVisible ( bool  show)
inlineinherited

Sets layer visibility.

Parameters
showvisibility bool.

Definition at line 295 of file mathplot.h.

Referenced by SIM_PLOT_TAB::ShowLegend(), and SIM_PLOT_TAB::SIM_PLOT_TAB().

◆ 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 268 of file mathplot.h.

Referenced by TRACE::TRACE().

◆ UpdateScales()

void mpFXY::UpdateScales ( )

◆ UpdateViewBoundary()

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

Update label positioning data.

Parameters
xnewNew x coordinate
ynewNew y coordinate

Definition at line 428 of file mathplot.cpp.

References maxDrawX, maxDrawY, minDrawX, and minDrawY.

Referenced by Plot().

◆ x2s()

double mpFXY::x2s ( double  x) const

◆ y2s()

double mpFXY::y2s ( double  y) const

Member Data Documentation

◆ m_brush

wxBrush mpLayer::m_brush
protectedinherited

Definition at line 309 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous
protectedinherited

Definition at line 312 of file mathplot.h.

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

◆ m_displayName

wxString mpLayer::m_displayName
protectedinherited

Definition at line 311 of file mathplot.h.

Referenced by TRACE::SetName().

◆ m_flags

int mpFXY::m_flags
protected

Definition at line 582 of file mathplot.h.

Referenced by Plot().

◆ m_font

wxFont mpLayer::m_font
protectedinherited

◆ m_name

wxString mpLayer::m_name
protectedinherited

Definition at line 310 of file mathplot.h.

Referenced by mpFX::Plot(), mpFY::Plot(), Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

◆ m_pen

wxPen mpLayer::m_pen
protectedinherited

◆ m_scaleX

mpScaleBase* mpFXY::m_scaleX
protected

Definition at line 587 of file mathplot.h.

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

◆ m_scaleY

mpScaleBase * mpFXY::m_scaleY
protected

Definition at line 587 of file mathplot.h.

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

◆ m_showName

bool mpLayer::m_showName
protectedinherited

Definition at line 313 of file mathplot.h.

Referenced by mpFX::Plot(), mpFY::Plot(), and Plot().

◆ m_type

mpLayerType mpLayer::m_type
protectedinherited

Definition at line 314 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_visible

bool mpLayer::m_visible
protectedinherited

◆ maxDrawX

wxCoord mpFXY::maxDrawX
protected

Definition at line 585 of file mathplot.h.

Referenced by Plot(), and UpdateViewBoundary().

◆ maxDrawY

wxCoord mpFXY::maxDrawY
protected

Definition at line 585 of file mathplot.h.

Referenced by Plot(), and UpdateViewBoundary().

◆ minDrawX

wxCoord mpFXY::minDrawX
protected

Definition at line 585 of file mathplot.h.

Referenced by Plot(), and UpdateViewBoundary().

◆ minDrawY

wxCoord mpFXY::minDrawY
protected

Definition at line 585 of file mathplot.h.

Referenced by Plot(), and UpdateViewBoundary().


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