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

The SIMULATOR_FRAME holds the main user-interface for running simulations. More...

#include <sim_plot_tab.h>

Inheritance diagram for CURSOR:
mpInfoLayer mpLayer

Public Member Functions

 CURSOR (TRACE *aTrace, SIM_PLOT_TAB *aPlotTab)
 
void Plot (wxDC &aDC, mpWindow &aWindow) override
 Plot method. More...
 
void SetX (int aX)
 
void Update ()
 
bool Inside (const wxPoint &aPoint) const override
 Checks whether a point is inside the info box rectangle. More...
 
void Move (wxPoint aDelta) override
 Moves the layer rectangle of given pixel deltas. More...
 
void UpdateReference () override
 Updates the rectangle reference point. More...
 
const wxRealPoint & GetCoords () const
 
void SetCoordX (double aValue)
 
virtual bool HasBBox () const override
 mpInfoLayer has not bounding box. More...
 
virtual bool IsInfo () const override
 Specifies that this is an Info box layer. More...
 
wxPoint GetPosition () const
 Returns the position of the upper left corner of the box (in pixels) More...
 
wxSize GetSize () const
 Returns the size of the box (in pixels) 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 Attributes

wxRect m_dim
 
wxPoint m_reference
 
wxBrush m_brush
 
int m_winX
 
int m_winY
 
wxFont m_font
 
wxPen m_pen
 
wxString m_name
 
wxString m_displayName
 
bool m_continuous
 
bool m_showName
 
mpLayerType m_type
 
bool m_visible
 

Private Member Functions

void doSetCoordX (double aValue)
 
wxString getID ()
 

Private Attributes

TRACEm_trace
 
bool m_updateRequired
 
bool m_updateRef
 
wxRealPoint m_coords
 
mpWindowm_window
 

Static Private Attributes

static constexpr int DRAG_MARGIN = 10
 

Detailed Description

The SIMULATOR_FRAME holds the main user-interface for running simulations.

It contains a workbook with multiple tabs, each tab holding a SIM_PLOT_TAB, a specific simulation command (.TRAN, .AC, etc.), and simulation settings (save all currents, etc.).

Each plot can have multiple TRACEs. While internally each TRACE can have multiple cursors, the GUI supports only two cursors (and a differential cursor) for each plot.

TRACEs are identified by a signal (V(OUT), I(R2), etc.) and a type (SPT_VOLTAGE, SPT_AC_PHASE, etc.).

The simulator outputs simple signals in a vector of the same name. Complex signals (such as V(OUT) / V(IN)) are stored in vectors of the format "user%d". < Cursor attached to a trace to follow its values:

Definition at line 63 of file sim_plot_tab.h.

Constructor & Destructor Documentation

◆ CURSOR()

CURSOR::CURSOR ( TRACE aTrace,
SIM_PLOT_TAB aPlotTab 
)
inline

Definition at line 66 of file sim_plot_tab.h.

Member Function Documentation

◆ doSetCoordX()

void CURSOR::doSetCoordX ( double  aValue)
private

Definition at line 284 of file sim_plot_tab.cpp.

References TRACE::GetDataX(), TRACE::GetDataY(), m_coords, and m_trace.

Referenced by Plot(), and SetCoordX().

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

◆ GetCoords()

const wxRealPoint & CURSOR::GetCoords ( ) const
inline

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

◆ getID()

wxString CURSOR::getID ( )
private

Definition at line 319 of file sim_plot_tab.cpp.

References _, cursor, TRACE::GetCursors(), and m_trace.

Referenced by 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 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 Plot(), mpInfoLegend::Plot(), and SIMULATOR_FRAME_UI::rebuildSignalsGrid().

◆ GetPosition()

wxPoint mpInfoLayer::GetPosition ( ) const
inherited

Returns the position of the upper left corner of the box (in pixels)

Returns
The rectangle position

Definition at line 164 of file mathplot.cpp.

References mpInfoLayer::m_dim.

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

◆ GetSize()

wxSize mpInfoLayer::GetSize ( ) const
inherited

Returns the size of the box (in pixels)

Returns
The rectangle size

Definition at line 170 of file mathplot.cpp.

References mpInfoLayer::m_dim.

◆ HasBBox()

virtual bool mpInfoLayer::HasBBox ( ) const
inlineoverridevirtualinherited

mpInfoLayer has not bounding box.

See also
mpLayer::HasBBox
Returns
always false

Reimplemented from mpLayer.

Definition at line 345 of file mathplot.h.

◆ Inside()

bool CURSOR::Inside ( const wxPoint &  point) const
overridevirtual

Checks whether a point is inside the info box rectangle.

Parameters
pointThe point to be checked
Returns
true if the point is inside the bounding box

Reimplemented from mpInfoLayer.

Definition at line 410 of file sim_plot_tab.cpp.

References std::abs(), DRAG_MARGIN, m_coords, m_trace, m_window, mpWindow::x2p(), mpFXY::x2s(), mpWindow::y2p(), and mpFXY::y2s().

◆ IsInfo()

virtual bool mpInfoLayer::IsInfo ( ) const
inlineoverridevirtualinherited

Specifies that this is an Info box layer.

Returns
always true
See also
mpLayer::IsInfo

Reimplemented from mpLayer.

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

◆ Move()

void CURSOR::Move ( wxPoint  delta)
inlineoverridevirtual

Moves the layer rectangle of given pixel deltas.

Parameters
deltaThe wxPoint container for delta coordinates along x and y. Units are in pixels.

Reimplemented from mpInfoLayer.

Definition at line 92 of file sim_plot_tab.h.

References mpInfoLayer::Move(), and Update().

Referenced by SetX().

◆ Plot()

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

◆ SetCoordX()

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

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

◆ SetX()

void CURSOR::SetX ( int  aX)
inline

Definition at line 78 of file sim_plot_tab.h.

References mpInfoLayer::m_reference, m_updateRef, and Move().

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

◆ Update()

void CURSOR::Update ( )
inline

Definition at line 85 of file sim_plot_tab.h.

References m_updateRequired.

Referenced by Move().

◆ UpdateReference()

void CURSOR::UpdateReference ( )
overridevirtual

Updates the rectangle reference point.

Used by internal methods of mpWindow to correctly move mpInfoLayers.

Reimplemented from mpInfoLayer.

Definition at line 422 of file sim_plot_tab.cpp.

References m_coords, mpInfoLayer::m_reference, m_trace, m_window, mpWindow::x2p(), mpFXY::x2s(), mpWindow::y2p(), and mpFXY::y2s().

Referenced by Plot().

Member Data Documentation

◆ DRAG_MARGIN

constexpr int CURSOR::DRAG_MARGIN = 10
staticconstexprprivate

Definition at line 119 of file sim_plot_tab.h.

Referenced by Inside().

◆ m_brush

wxBrush mpInfoLayer::m_brush
protectedinherited

Definition at line 382 of file mathplot.h.

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

◆ m_continuous

bool mpLayer::m_continuous
protectedinherited

Definition at line 312 of file mathplot.h.

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

◆ m_coords

wxRealPoint CURSOR::m_coords
private

Definition at line 116 of file sim_plot_tab.h.

Referenced by doSetCoordX(), GetCoords(), Inside(), Plot(), SetCoordX(), and UpdateReference().

◆ m_dim

◆ m_displayName

wxString mpLayer::m_displayName
protectedinherited

Definition at line 311 of file mathplot.h.

Referenced by TRACE::SetName().

◆ 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(), mpFXY::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

◆ m_pen

wxPen mpLayer::m_pen
protectedinherited

◆ m_reference

wxPoint mpInfoLayer::m_reference
protectedinherited

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

TRACE* CURSOR::m_trace
private

Definition at line 113 of file sim_plot_tab.h.

Referenced by doSetCoordX(), getID(), Inside(), Plot(), SetCoordX(), and UpdateReference().

◆ m_type

mpLayerType mpLayer::m_type
protectedinherited

Definition at line 314 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_updateRef

bool CURSOR::m_updateRef
private

Definition at line 115 of file sim_plot_tab.h.

Referenced by Plot(), SetCoordX(), and SetX().

◆ m_updateRequired

bool CURSOR::m_updateRequired
private

Definition at line 114 of file sim_plot_tab.h.

Referenced by Plot(), SetCoordX(), and Update().

◆ m_visible

bool mpLayer::m_visible
protectedinherited

◆ m_window

mpWindow* CURSOR::m_window
private

Definition at line 117 of file sim_plot_tab.h.

Referenced by Inside(), Plot(), SetCoordX(), and UpdateReference().

◆ m_winX

int mpInfoLayer::m_winX
protectedinherited

Definition at line 383 of file mathplot.h.

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

◆ m_winY

int mpInfoLayer::m_winY
protectedinherited

Definition at line 384 of file mathplot.h.

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


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