KiCad PCB EDA Suite
Loading...
Searching...
No Matches
mpScaleXBase Class Reference

#include <mathplot.h>

Inheritance diagram for mpScaleXBase:
mpScaleBase mpLayer mpScaleX mpScaleXLog LIN_SCALE< mpScaleX > TIME_SCALE

Public Member Functions

 mpScaleXBase (const wxString &name=wxT("X"), int flags=mpALIGN_CENTER, bool ticks=true, unsigned int type=mpX_NORMAL)
 Full constructor. More...
 
virtual ~mpScaleXBase ()
 
virtual bool IsHorizontal () const override
 
virtual void Plot (wxDC &dc, mpWindow &w) override
 Plot given view of layer to the given device context. More...
 
virtual void getVisibleDataRange (mpWindow &w, double &minV, double &maxV) override
 
bool HasBBox () const override
 Check whether this layer has a bounding box. More...
 
void SetAlign (int align)
 Set X axis alignment. More...
 
void SetNameAlign (int align)
 
void SetTicks (bool enable)
 Set X axis ticks or grid. More...
 
bool GetTicks () const
 Get X axis ticks or grid. More...
 
void GetDataRange (double &minV, double &maxV) const
 
virtual void ExtendDataRange (double minV, double maxV)
 
virtual void ResetDataRange ()
 
double AbsMaxValue () const
 
double AbsVisibleMaxValue () const
 
void SetAxisMinMax (bool lock, double minV, double maxV)
 
bool GetAxisMinMax (double *minV, double *maxV)
 
virtual double TransformToPlot (double x) const
 
virtual double TransformFromPlot (double xplot) const
 
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 wxString & GetDisplayName () const
 
const wxFont & GetFont () const
 Get font set for this layer. More...
 
const wxPen & GetPen () const
 Get pen set for this layer. More...
 
void SetContinuity (bool continuity)
 Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points). More...
 
bool GetContinuity () const
 Gets the 'continuity' property of the layer. More...
 
void ShowName (bool show)
 Shows or hides the text label with the name of the layer (default is visible). More...
 
virtual void SetName (const wxString &name)
 Set layer name. More...
 
void SetFont (const wxFont &font)
 Set layer font. More...
 
void SetPen (const wxPen &pen)
 Set layer pen. 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 (const wxBrush &brush)
 Set layer brush. More...
 

Protected Member Functions

void updateTickLabels (wxDC &dc, mpWindow &w)
 
void computeLabelExtents (wxDC &dc, mpWindow &w)
 
virtual void recalculateTicks (wxDC &dc, mpWindow &w)
 
virtual void formatLabels ()
 

Protected Attributes

std::vector< double > m_tickValues
 
std::vector< TICK_LABELm_tickLabels
 
double m_offset
 
double m_scale
 
double m_absVisibleMaxV
 
int m_flags
 
int m_nameFlags
 
bool m_ticks
 
double m_minV
 
double m_maxV
 
bool m_rangeSet
 
bool m_axisLocked
 
double m_axisMin
 
double m_axisMax
 
int m_maxLabelHeight
 
int m_maxLabelWidth
 
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

Definition at line 749 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpScaleXBase()

mpScaleXBase::mpScaleXBase ( const wxString &  name = wxT( "X" ),
int  flags = mpALIGN_CENTER,
bool  ticks = true,
unsigned int  type = mpX_NORMAL 
)

Full constructor.

Parameters
nameLabel to plot by the ruler
flagsSet the position of the scale with respect to the window.
ticksSelect ticks or grid. Give true (default) for drawing axis ticks, false for drawing the grid.
typempX_NORMAL for normal labels, mpX_TIME for time axis in hours, minutes, seconds.

Definition at line 990 of file mathplot.cpp.

References mpLAYER_AXIS, and name.

◆ ~mpScaleXBase()

virtual mpScaleXBase::~mpScaleXBase ( )
inlinevirtual

Definition at line 761 of file mathplot.h.

Member Function Documentation

◆ AbsMaxValue()

double mpScaleBase::AbsMaxValue ( ) const
inlineinherited

Definition at line 671 of file mathplot.h.

References std::abs().

◆ AbsVisibleMaxValue()

double mpScaleBase::AbsVisibleMaxValue ( ) const
inlineinherited

Definition at line 676 of file mathplot.h.

◆ computeLabelExtents()

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

◆ ExtendDataRange()

virtual void mpScaleBase::ExtendDataRange ( double  minV,
double  maxV 
)
inlinevirtualinherited

Reimplemented in TIME_SCALE.

Definition at line 645 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ formatLabels()

virtual void mpScaleBase::formatLabels ( )
inlineprotectedvirtualinherited

Reimplemented in LIN_SCALE< mpScaleX >.

Definition at line 729 of file mathplot.h.

Referenced by mpScaleBase::updateTickLabels().

◆ GetAxisMinMax()

bool mpScaleBase::GetAxisMinMax ( double *  minV,
double *  maxV 
)
inlineinherited

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

◆ GetDataRange()

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

Definition at line 639 of file mathplot.h.

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

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

◆ GetName()

const wxString & mpLayer::GetName ( ) const
inlineinherited

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

◆ GetTicks()

bool mpScaleBase::GetTicks ( ) const
inlineinherited

Get X axis ticks or grid.

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

Definition at line 637 of file mathplot.h.

Referenced by SIM_PLOT_TAB::IsGridShown().

◆ getVisibleDataRange()

void mpScaleXBase::getVisibleDataRange ( mpWindow w,
double &  minV,
double &  maxV 
)
overridevirtual

◆ HasBBox()

bool mpScaleBase::HasBBox ( ) const
inlineoverridevirtualinherited

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 from mpLayer.

Reimplemented in mpScaleY.

Definition at line 619 of file mathplot.h.

◆ IsHorizontal()

virtual bool mpScaleXBase::IsHorizontal ( ) const
inlineoverridevirtual

Implements mpScaleBase.

Definition at line 763 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()

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

Plot given view of layer to the given device context.

An implementation of this function has to transform layer coordinates to wxDC coordinates based on the view parameters retrievable from the mpWindow passed in w. Note that the public methods of mpWindow: x2p,y2p and p2x,p2y are already provided which transform layer coordinates to DC pixel coordinates, and user code should rely on them for portability and future changes to be applied transparently, instead of implementing the following formulas manually.

The passed device context dc has its coordinate origin set to the top-left corner of the visible area (the default). The coordinate orientation is as shown in the following picture:

(wxDC origin 0,0)
x-------------> ascending X ----------------+
|                                           |
|                                           |
|  V ascending Y                            |
|                                           |
|                                           |
|                                           |
|+------------------------------------------+  <-- right-bottom corner of the mpWindow visible area.

Note that Y ascends in downward direction, whereas the usual vertical orientation for mathematical plots is vice versa. Thus Y-orientation will be swapped usually, when transforming between wxDC and mpLayer coordinates. This change of coordinates is taken into account in the methods p2x,p2y,x2p,y2p.

Rules for transformation between mpLayer and wxDC coordinates

dc_X = (layer_X - mpWindow::GetPosX()) * mpWindow::GetScaleX()
dc_Y = (mpWindow::GetPosY() - layer_Y) * mpWindow::GetScaleY() // swapping Y-orientation
layer_X = (dc_X / mpWindow::GetScaleX()) + mpWindow::GetPosX() // scale guaranteed to be not 0
layer_Y = mpWindow::GetPosY() - (dc_Y / mpWindow::GetScaleY()) // swapping Y-orientation
double GetScaleY() const
Get current view's Y scale.
Definition: mathplot.h:975
double GetScaleX() const
Get current view's X scale.
Definition: mathplot.h:969
double GetPosY() const
Get current view's Y position.
Definition: mathplot.h:987
double GetPosX() const
Get current view's X position.
Definition: mathplot.h:981
Parameters
dcDevice context to plot to.
wView to plot. The visible area can be retrieved from this object.
See also
mpWindow::p2x,mpWindow::p2y,mpWindow::x2p,mpWindow::y2p

2;

Implements mpLayer.

Definition at line 1013 of file mathplot.cpp.

References mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpWindow::GetPosX(), mpWindow::GetScaleX(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpScaleBase::m_flags, mpLayer::m_font, mpScaleBase::m_maxLabelHeight, mpScaleBase::m_maxV, mpScaleBase::m_minV, mpLayer::m_name, mpScaleBase::m_nameFlags, mpScaleBase::m_offset, mpLayer::m_pen, mpScaleBase::m_scale, mpScaleBase::m_tickLabels, mpScaleBase::m_ticks, mpScaleBase::m_tickValues, mpLayer::m_visible, mpALIGN_BORDER_BOTTOM, mpALIGN_BORDER_TOP, mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP, mpScaleBase::recalculateTicks(), tp, mpScaleBase::TransformToPlot(), and mpWindow::y2p().

◆ recalculateTicks()

virtual void mpScaleBase::recalculateTicks ( wxDC &  dc,
mpWindow w 
)
inlineprotectedvirtualinherited

Reimplemented in mpScaleX, mpScaleXLog, and mpScaleY.

Definition at line 727 of file mathplot.h.

Referenced by Plot().

◆ ResetDataRange()

virtual void mpScaleBase::ResetDataRange ( )
inlinevirtualinherited

Reimplemented in TIME_SCALE.

Definition at line 666 of file mathplot.h.

Referenced by SIM_PLOT_TAB::ResetScales().

◆ SetAlign()

void mpScaleBase::SetAlign ( int  align)
inlineinherited

Set X axis alignment.

Parameters
alignalignment (choose between mpALIGN_BORDER_BOTTOM, mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP, mpALIGN_BORDER_TOP

Definition at line 625 of file mathplot.h.

◆ SetAxisMinMax()

void mpScaleBase::SetAxisMinMax ( bool  lock,
double  minV,
double  maxV 
)
inlineinherited

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

◆ SetNameAlign()

void mpScaleBase::SetNameAlign ( int  align)
inlineinherited

Definition at line 627 of file mathplot.h.

Referenced by SIM_PLOT_TAB::prepareDCAxes(), 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().

◆ SetTicks()

void mpScaleBase::SetTicks ( bool  enable)
inlineinherited

Set X axis ticks or grid.

Parameters
enable= true to plot axis ticks, false to plot grid.

Definition at line 632 of file mathplot.h.

Referenced by SIM_PLOT_TAB::ShowGrid().

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

◆ TransformFromPlot()

virtual double mpScaleBase::TransformFromPlot ( double  xplot) const
inlinevirtualinherited

Reimplemented in mpScaleX, mpScaleXLog, and mpScaleY.

Definition at line 705 of file mathplot.h.

Referenced by getVisibleDataRange(), mpFXY::s2x(), and mpFXY::s2y().

◆ TransformToPlot()

virtual double mpScaleBase::TransformToPlot ( double  x) const
inlinevirtualinherited

Reimplemented in mpScaleX, mpScaleXLog, and mpScaleY.

Definition at line 704 of file mathplot.h.

Referenced by mpFXY::Plot(), Plot(), mpFXY::x2s(), and mpFXY::y2s().

◆ updateTickLabels()

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

Member Data Documentation

◆ m_absVisibleMaxV

double mpScaleBase::m_absVisibleMaxV
protectedinherited

◆ m_axisLocked

bool mpScaleBase::m_axisLocked
protectedinherited

Definition at line 742 of file mathplot.h.

Referenced by mpScaleBase::mpScaleBase(), and mpScaleY::recalculateTicks().

◆ m_axisMax

double mpScaleBase::m_axisMax
protectedinherited

Definition at line 744 of file mathplot.h.

Referenced by mpScaleBase::mpScaleBase(), and mpScaleY::recalculateTicks().

◆ m_axisMin

double mpScaleBase::m_axisMin
protectedinherited

Definition at line 743 of file mathplot.h.

Referenced by mpScaleBase::mpScaleBase(), and mpScaleY::recalculateTicks().

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

◆ m_displayName

wxString mpLayer::m_displayName
protectedinherited

Definition at line 311 of file mathplot.h.

Referenced by TRACE::SetName().

◆ m_flags

int mpScaleBase::m_flags
protectedinherited

Definition at line 737 of file mathplot.h.

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

◆ m_font

wxFont mpLayer::m_font
protectedinherited

◆ m_maxLabelHeight

int mpScaleBase::m_maxLabelHeight
protectedinherited

Definition at line 745 of file mathplot.h.

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

◆ m_maxLabelWidth

int mpScaleBase::m_maxLabelWidth
protectedinherited

Definition at line 746 of file mathplot.h.

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

◆ m_maxV

◆ m_minV

◆ m_name

wxString mpLayer::m_name
protectedinherited

Definition at line 310 of file mathplot.h.

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

◆ m_nameFlags

int mpScaleBase::m_nameFlags
protectedinherited

Definition at line 738 of file mathplot.h.

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

◆ m_offset

◆ m_pen

wxPen mpLayer::m_pen
protectedinherited

◆ m_rangeSet

bool mpScaleBase::m_rangeSet
protectedinherited

Definition at line 741 of file mathplot.h.

Referenced by mpScaleBase::mpScaleBase(), and TIME_SCALE::ResetDataRange().

◆ m_scale

◆ m_showName

bool mpLayer::m_showName
protectedinherited

Definition at line 313 of file mathplot.h.

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

◆ m_tickLabels

◆ m_ticks

bool mpScaleBase::m_ticks
protectedinherited

Definition at line 739 of file mathplot.h.

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

◆ m_tickValues

std::vector<double> mpScaleBase::m_tickValues
protectedinherited

◆ 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

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