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

Abstract base class providing plot and labeling functionality for functions F:Y->X. More...

#include <mathplot.h>

Inheritance diagram for mpFY:
mpLayer

Public Member Functions

 mpFY (const wxString &name=wxEmptyString, int flags=mpALIGN_TOP)
 
virtual double GetX (double y) const =0
 Get function value for argument. More...
 
virtual void Plot (wxDC &dc, mpWindow &w) override
 Layer plot handler. More...
 
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...
 
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 (wxFont &font)
 Set layer font. More...
 
void SetPen (wxPen pen)
 Set layer pen. More...
 
void SetDrawOutsideMargins (bool drawModeOutside)
 Set Draw mode: inside or outside margins. More...
 
bool GetDrawOutsideMargins ()
 Get Draw mode: inside or outside margins. More...
 
wxBitmap GetColourSquare (int side=16) const
 Get a small square bitmap filled with the colour of the pen used in the layer. More...
 
mpLayerType GetLayerType () const
 Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value. More...
 
bool IsVisible () const
 Checks whether the layer is visible or not. More...
 
void SetVisible (bool show)
 Sets layer visibility. More...
 
const wxBrush & GetBrush () const
 Get brush set for this layer. More...
 
void SetBrush (wxBrush brush)
 Set layer brush. More...
 

Protected Attributes

int m_flags
 
wxFont m_font
 
wxPen m_pen
 
wxBrush m_brush
 
wxString m_name
 
wxString m_displayName
 
bool m_continuous
 
bool m_showName
 
bool m_drawOutsideMargins
 
mpLayerType m_type
 
bool m_visible
 

Detailed Description

Abstract base class providing plot and labeling functionality for functions F:Y->X.

Override mpFY::GetX to implement a function. Optionally implement a constructor and pass a name (label) and a label alignment to the constructor mpFY::mpFY. If the layer name is empty, no label will be plotted.

Definition at line 568 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpFY()

mpFY::mpFY ( const wxString &  name = wxEmptyString,
int  flags = mpALIGN_TOP 
)
Parameters
nameLabel
flagsLabel alignment, pass one of mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP.

Definition at line 477 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 315 of file mathplot.h.

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

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

◆ GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const
inlineinherited

Definition at line 244 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

◆ GetDrawOutsideMargins()

bool mpLayer::GetDrawOutsideMargins ( )
inlineinherited

Get Draw mode: inside or outside margins.

Returns
The draw mode

Definition at line 294 of file mathplot.h.

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const
inlineinherited

Get font set for this layer.

Returns
Font

Definition at line 252 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 303 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, mpMovableObject, and mpBitmapLayer.

Definition at line 184 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, mpMovableObject, and mpBitmapLayer.

Definition at line 194 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, mpMovableObject, and mpBitmapLayer.

Definition at line 179 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, mpMovableObject, and mpBitmapLayer.

Definition at line 189 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 257 of file mathplot.h.

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

◆ GetX()

virtual double mpFY::GetX ( double  y) const
pure virtual

Get function value for argument.

Override this function in your implementation.

Parameters
yArgument
Returns
Function value

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, mpScaleY, mpText, mpMovableObject, and mpBitmapLayer.

Definition at line 165 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 174 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 307 of file mathplot.h.

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

◆ Plot()

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

Layer plot handler.

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

Implements mpLayer.

Definition at line 485 of file mathplot.cpp.

References mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpWindow::GetScrX(), mpWindow::GetScrY(), GetX(), mpLayer::m_drawOutsideMargins, m_flags, mpLayer::m_font, mpLayer::m_name, mpLayer::m_pen, mpLayer::m_showName, mpLayer::m_visible, mpALIGN_CENTER, mpALIGN_TOP, mpALIGNMASK, mpWindow::p2y(), and mpWindow::x2p().

◆ SetBrush()

void mpLayer::SetBrush ( wxBrush  brush)
inlineinherited

Set layer brush.

Parameters
brushbrush, will be copied to internal class member

Definition at line 319 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 262 of file mathplot.h.

Referenced by TRACE::TRACE().

◆ SetDrawOutsideMargins()

void mpLayer::SetDrawOutsideMargins ( bool  drawModeOutside)
inlineinherited

Set Draw mode: inside or outside margins.

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

Parameters
drawModeOutsideThe draw mode to be set

Definition at line 290 of file mathplot.h.

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

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

References name.

Referenced by SIM_PLOT_PANEL::prepareDCAxes(), TRACE::SetName(), and 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 286 of file mathplot.h.

Referenced by SIM_PLOT_PANEL::UpdateTraceStyle().

◆ SetVisible()

void mpLayer::SetVisible ( bool  show)
inlineinherited

Sets layer visibility.

Parameters
showvisibility bool.

Definition at line 311 of file mathplot.h.

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

Referenced by TRACE::TRACE().

Member Data Documentation

◆ m_brush

wxBrush mpLayer::m_brush
protectedinherited

Definition at line 325 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous
protectedinherited

Definition at line 328 of file mathplot.h.

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

◆ m_displayName

wxString mpLayer::m_displayName
protectedinherited

Definition at line 327 of file mathplot.h.

Referenced by TRACE::SetName().

◆ m_drawOutsideMargins

bool mpLayer::m_drawOutsideMargins
protectedinherited

◆ m_flags

int mpFY::m_flags
protected

Definition at line 590 of file mathplot.h.

Referenced by Plot().

◆ m_font

◆ m_name

wxString mpLayer::m_name
protectedinherited

◆ m_pen

◆ m_showName

bool mpLayer::m_showName
protectedinherited

Definition at line 329 of file mathplot.h.

Referenced by mpFX::Plot(), Plot(), mpFXY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ m_type

mpLayerType mpLayer::m_type
protectedinherited

Definition at line 331 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_visible


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