KiCad PCB EDA Suite: mpWindow Class Reference

double m_posX

Definition: mathplot.h:1514

Referenced by mpScaleXBase::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ GetPosY()

double mpWindow::GetPosY ( void ) const

inline

Definition at line 1130 of file mathplot.h.

1130 { return m_posY; }

double m_posY

Definition: mathplot.h:1515

Referenced by mpScaleY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ GetScaleX()

double mpWindow::GetScaleX ( void ) const

inline

Definition at line 1109 of file mathplot.h.

1109 { return m_scaleX; }; // Schaling's method: maybe another method exists with the same name

double m_scaleX

Definition: mathplot.h:1512

Referenced by mpScaleXBase::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ GetScaleY()

double mpWindow::GetScaleY ( void ) const

inline

Definition at line 1116 of file mathplot.h.

1116 { return m_scaleY; } // Schaling's method: maybe another method exists with the same name

double m_scaleY

Definition: mathplot.h:1513

Referenced by mpScaleY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ GetScrX()

int mpWindow::GetScrX ( void ) const

inline

Get current view's X dimension in device context units.

Usually this is equal to wxDC::GetSize, but it might differ thus mpLayer implementations should rely on the value returned by the function. See rules for coordinate transformation

Returns: X dimension.

Definition at line 1138 of file mathplot.h.

1138 { return m_scrX; }

mpWindow::m_scrX

int m_scrX

Definition: mathplot.h:1516

Referenced by mpScaleXBase::getVisibleDataRange(), CURSOR::Plot(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ GetScrY()

int mpWindow::GetScrY ( void ) const

inline

Get current view's Y dimension in device context units.

Usually this is equal to wxDC::GetSize, but it might differ thus mpLayer implementations should rely on the value returned by the function. See rules for coordinate transformation

Returns: Y dimension.

Definition at line 1147 of file mathplot.h.

1147 { return m_scrY; }

mpWindow::m_scrY

int m_scrY

Definition: mathplot.h:1517

Referenced by mpScaleY::getVisibleDataRange(), CURSOR::Plot(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ GetXpos()

double mpWindow::GetXpos ( ) const

inline

Get current view's X position.

Returns: X Position in layer coordinate system, that corresponds to the center point of the view.

Definition at line 1122 of file mathplot.h.

1122 { return m_posX; }

double m_posX

Definition: mathplot.h:1514

◆ GetXscl()

double mpWindow::GetXscl ( ) const

inline

Get current view's X scale.

Returns: Scale

Definition at line 1108 of file mathplot.h.

1108 { return m_scaleX; }

double m_scaleX

Definition: mathplot.h:1512

◆ GetXScreen()

int mpWindow::GetXScreen ( void ) const

inline

Definition at line 1139 of file mathplot.h.

1139 { return m_scrX; }

mpWindow::m_scrX

int m_scrX

Definition: mathplot.h:1516

Referenced by SIM_PLOT_PANEL::EnableCursor().

◆ GetYpos()

double mpWindow::GetYpos ( ) const

inline

Get current view's Y position.

Returns: Y Position in layer coordinate system, that corresponds to the center point of the view.

Definition at line 1129 of file mathplot.h.

1129 { return m_posY; }

double m_posY

Definition: mathplot.h:1515

◆ GetYscl()

double mpWindow::GetYscl ( ) const

inline

Get current view's Y scale.

Returns: Scale

Definition at line 1115 of file mathplot.h.

1115 { return m_scaleY; }

double m_scaleY

Definition: mathplot.h:1513

◆ GetYScreen()

int mpWindow::GetYScreen ( void ) const

inline

Definition at line 1148 of file mathplot.h.

1148 { return m_scrY; }

mpWindow::m_scrY

int m_scrY

Definition: mathplot.h:1517

◆ IsAspectLocked()

bool mpWindow::IsAspectLocked ( ) const

inline

Checks whether the X/Y scale aspect is locked.

Return values

true	Locked
false	Unlocked

Definition at line 1233 of file mathplot.h.

1233 { return m_lockaspect; }

mpWindow::m_lockaspect

bool m_lockaspect

Definition: mathplot.h:1502

◆ IsInsideInfoLayer()

mpInfoLayer * mpWindow::IsInsideInfoLayer ( wxPoint & point )

Check if a given point is inside the area of a mpInfoLayer and eventually returns its pointer.

Parameters

point The position to be checked

Returns: If an info layer is found, returns its pointer, NULL otherwise

Definition at line 2691 of file mathplot.cpp.

 {
     for( mpLayer* layer : m_layers )
     {
         if( layer->IsInfo() )
         {
             mpInfoLayer* tmpLyr = static_cast<mpInfoLayer*>( layer );
 
             if( tmpLyr->Inside( point ) )
                 return tmpLyr;
         }
     }
 
     return NULL;
 }

References mpInfoLayer::Inside(), and m_layers.

Referenced by OnMouseLeftDown().

◆ IsLayerVisible() [1/2]

bool mpWindow::IsLayerVisible ( const wxString & name ) const

Check whether a layer with given name is visible.

Parameters

name	The layer name

Returns: layer visibility status

Definition at line 2720 of file mathplot.cpp.

 {
     const mpLayer* lx = GetLayerByName( name );
 
     return lx ? lx->IsVisible() : false;
 }

References GetLayerByName(), mpLayer::IsVisible(), and name.

◆ IsLayerVisible() [2/2]

bool mpWindow::IsLayerVisible ( unsigned int position ) const

Check whether the layer at given position is visible.

Parameters

position The layer position in layer list

Returns: layer visibility status

Definition at line 2740 of file mathplot.cpp.

 {
     mpLayer* lx = GetLayer( position );
 
     return (lx) ? lx->IsVisible() : false;
 }

References GetLayer(), and mpLayer::IsVisible().

◆ LimitView()

void mpWindow::LimitView ( bool aEnable )

inline

Limit zooming & panning to the area used by the plots.

Definition at line 1429 of file mathplot.h.

     {
         m_enableLimitedView = aEnable;
     }

Referenced by SIM_PLOT_PANEL::SIM_PLOT_PANEL().

◆ LockAspect()

void mpWindow::LockAspect ( bool enable = true )

Enable or disable X/Y scale aspect locking for the view.

Note: Explicit calls to mpWindow::SetScaleX and mpWindow::SetScaleY will set an unlocked aspect, but any other action changing the view scale will lock the aspect again.

Definition at line 2197 of file mathplot.cpp.

 {
     m_lockaspect = enable;
     m_popmenu.Check( mpID_LOCKASPECT, enable );
 
     // Try to fit again with the new config:
     Fit( m_desiredXmin, m_desiredXmax, m_desiredYmin, m_desiredYmax );
 }

References Fit(), m_desiredXmax, m_desiredXmin, m_desiredYmax, m_desiredYmin, m_lockaspect, m_popmenu, and mpID_LOCKASPECT.

Referenced by OnLockAspect().

◆ OnCenter()

void mpWindow::OnCenter ( wxCommandEvent & event )

protected

Definition at line 2227 of file mathplot.cpp.

 {
     GetClientSize( &m_scrX, &m_scrY );
     int centerX = (m_scrX - m_marginLeft - m_marginRight) / 2;      // + m_marginLeft; // c.x = m_scrX/2;
     int centerY = (m_scrY - m_marginTop - m_marginBottom) / 2;      // - m_marginTop; // c.y = m_scrY/2;
     SetPos( p2x( m_clickedX - centerX ), p2y( m_clickedY - centerY ) );
     // SetPos( p2x(m_clickedX-m_scrX/2), p2y(m_clickedY-m_scrY/2) );  //SetPos( (double)(m_clickedX-m_scrX/2) / m_scaleX + m_posX, (double)(m_scrY/2-m_clickedY) / m_scaleY + m_posY);
 }

References m_clickedX, m_clickedY, m_marginBottom, m_marginLeft, m_marginRight, m_marginTop, m_scrX, m_scrY, p2x(), p2y(), and SetPos().

◆ OnFit()

void mpWindow::OnFit ( wxCommandEvent & event )

protected

Definition at line 2221 of file mathplot.cpp.

 {
     Fit();
 }

References Fit().

◆ OnLockAspect()

void mpWindow::OnLockAspect ( wxCommandEvent & event )

protected

Definition at line 2215 of file mathplot.cpp.

 {
     LockAspect( !m_lockaspect );
 }

References LockAspect(), and m_lockaspect.

◆ OnMagnify()

void mpWindow::OnMagnify ( wxMouseEvent & event )

protected

◆ OnMouseLeftDown()

void mpWindow::OnMouseLeftDown ( wxMouseEvent & event )

protected

Definition at line 1876 of file mathplot.cpp.

 {
     m_mouseLClick.x = event.GetX();
     m_mouseLClick.y = event.GetY();
     m_zooming = true;
     wxPoint pointClicked = event.GetPosition();
     m_movingInfoLayer = IsInsideInfoLayer( pointClicked );
 
     event.Skip();
 }

References IsInsideInfoLayer(), m_mouseLClick, m_movingInfoLayer, and m_zooming.

◆ OnMouseLeftRelease()

void mpWindow::OnMouseLeftRelease ( wxMouseEvent & event )

protected

Definition at line 1888 of file mathplot.cpp.

 {
     wxPoint release( event.GetX(), event.GetY() );
     wxPoint press( m_mouseLClick.x, m_mouseLClick.y );
 
     m_zooming = false;
 
     if( m_movingInfoLayer != NULL )
     {
         m_movingInfoLayer->UpdateReference();
         m_movingInfoLayer = NULL;
     }
     else
     {
         if( release != press )
             ZoomRect( press, release );
     }
 
     event.Skip();
 }

References m_mouseLClick, m_movingInfoLayer, m_zooming, mpInfoLayer::UpdateReference(), and ZoomRect().

◆ OnMouseMiddleDown()

void mpWindow::OnMouseMiddleDown ( wxMouseEvent & event )

protected

Definition at line 1702 of file mathplot.cpp.

 {
     m_mouseMClick.x = event.GetX();
     m_mouseMClick.y = event.GetY();
 }

References m_mouseMClick.

◆ OnMouseMove()

void mpWindow::OnMouseMove ( wxMouseEvent & event )

protected

Definition at line 1785 of file mathplot.cpp.

 {
     if( !m_enableMouseNavigation )
     {
         event.Skip();
         return;
     }
 
     if( event.m_middleDown )
     {
         // The change:
         int Ax  = m_mouseMClick.x - event.GetX();
         int Ay  = m_mouseMClick.y - event.GetY();
 
         // For the next event, use relative to this coordinates.
         m_mouseMClick.x = event.GetX();
         m_mouseMClick.y = event.GetY();
 
         double  Ax_units    = Ax / m_scaleX;
         double  Ay_units    = -Ay / m_scaleY;
 
         bool updateRequired = false;
         updateRequired |= SetXView( m_posX + Ax_units,
                                     m_desiredXmax + Ax_units,
                                     m_desiredXmin + Ax_units );
         updateRequired |= SetYView( m_posY + Ay_units,
                                     m_desiredYmax + Ay_units,
                                     m_desiredYmin + Ay_units );
 
         if( updateRequired )
             UpdateAll();
     }
     else
     {
         if( event.m_leftDown )
         {
             if( m_movingInfoLayer == NULL )
             {
                 wxClientDC dc( this );
                 wxPen pen( m_fgColour, 1, wxPENSTYLE_DOT );
                 dc.SetPen( pen );
                 dc.SetBrush( *wxTRANSPARENT_BRUSH );
                 dc.DrawRectangle( m_mouseLClick.x, m_mouseLClick.y,
                         event.GetX() - m_mouseLClick.x, event.GetY() - m_mouseLClick.y );
                 m_zooming = true;
                 m_zoomRect.x    = m_mouseLClick.x;
                 m_zoomRect.y    = m_mouseLClick.y;
                 m_zoomRect.width    = event.GetX() - m_mouseLClick.x;
                 m_zoomRect.height   = event.GetY() - m_mouseLClick.y;
             }
             else
             {
                 wxPoint moveVector( event.GetX() - m_mouseLClick.x, event.GetY() - m_mouseLClick.y );
                 m_movingInfoLayer->Move( moveVector );
                 m_zooming = false;
             }
 
             UpdateAll();
         }
         else
         {
 #if 0
             wxLayerList::iterator li;
 
             for( li = m_layers.begin(); li != m_layers.end(); li++ )
             {
                 if( (*li)->IsInfo() && (*li)->IsVisible() )
                 {
                     mpInfoLayer* tmpLyr = (mpInfoLayer*) (*li);
                     tmpLyr->UpdateInfo( *this, event );
                     // UpdateAll();
                     RefreshRect( tmpLyr->GetRectangle() );
                 }
             }
 
 #endif
             /* if (m_coordTooltip) {
              *  wxString toolTipContent;
              *  toolTipContent.Printf( "X = %f\nY = %f", p2x(event.GetX()), p2y(event.GetY()));
              *  wxTipWindow** ptr = NULL;
              *  wxRect rectBounds(event.GetX(), event.GetY(), 5, 5);
              *  wxTipWindow* tip = new wxTipWindow(this, toolTipContent, 100, ptr, &rectBounds);
              *
              *  } */
         }
     }
 
     event.Skip();
 }

References mpInfoLayer::GetRectangle(), m_desiredXmax, m_desiredXmin, m_desiredYmax, m_desiredYmin, m_enableMouseNavigation, m_fgColour, m_layers, m_mouseLClick, m_mouseMClick, m_movingInfoLayer, m_posX, m_posY, m_scaleX, m_scaleY, m_zooming, m_zoomRect, mpInfoLayer::Move(), SetXView(), SetYView(), UpdateAll(), and mpInfoLayer::UpdateInfo().

◆ OnMouseWheel()

void mpWindow::OnMouseWheel ( wxMouseEvent & event )

protected

Definition at line 1730 of file mathplot.cpp.

 {
     if( !m_enableMouseNavigation )
     {
         event.Skip();
         return;
     }
 
     int       change = event.GetWheelRotation();
     const int axis = event.GetWheelAxis();
     double    changeUnitsX = change / m_scaleX;
     double    changeUnitsY = change / m_scaleY;
 
     if( ( !m_enableMouseWheelPan && ( event.ControlDown() || event.ShiftDown() ) )
             || ( m_enableMouseWheelPan && !event.ControlDown() ) )
     {
         // Scrolling
         if( m_enableMouseWheelPan )
         {
             if( axis == wxMOUSE_WHEEL_HORIZONTAL || event.ShiftDown() )
                 SetXView( m_posX + changeUnitsX, m_desiredXmax + changeUnitsX,
                         m_desiredXmin + changeUnitsX );
             else
                 SetYView( m_posY + changeUnitsY, m_desiredYmax + changeUnitsY,
                         m_desiredYmin + changeUnitsY );
         }
         else
         {
             if( event.ControlDown() )
                 SetXView( m_posX + changeUnitsX, m_desiredXmax + changeUnitsX,
                         m_desiredXmin + changeUnitsX );
             else
                 SetYView( m_posY + changeUnitsY, m_desiredYmax + changeUnitsY,
                         m_desiredYmin + changeUnitsY );
         }
 
         UpdateAll();
     }
     else
     {
         // zoom in/out
         wxPoint clickPt( event.GetX(), event.GetY() );
 
         if( event.GetWheelRotation() > 0 )
             ZoomIn( clickPt );
         else
             ZoomOut( clickPt );
 
         return;
     }
 }

References m_desiredXmax, m_desiredXmin, m_desiredYmax, m_desiredYmin, m_enableMouseNavigation, m_enableMouseWheelPan, m_posX, m_posY, m_scaleX, m_scaleY, SetXView(), SetYView(), UpdateAll(), ZoomIn(), and ZoomOut().

◆ OnPaint()

void mpWindow::OnPaint ( wxPaintEvent & event )

protected

Definition at line 2316 of file mathplot.cpp.

 {
     wxPaintDC dc( this );
 
     dc.GetSize( &m_scrX, &m_scrY );    // This is the size of the visible area only!
 
     // Selects direct or buffered draw:
     wxDC* trgDc;
 
     // J.L.Blanco @ Aug 2007: Added double buffer support
     if( m_enableDoubleBuffer )
     {
         if( m_last_lx != m_scrX || m_last_ly != m_scrY )
         {
             if( m_buff_bmp )
                 delete m_buff_bmp;
 
             m_buff_bmp = new wxBitmap( m_scrX, m_scrY );
             m_buff_dc.SelectObject( *m_buff_bmp );
             m_last_lx   = m_scrX;
             m_last_ly   = m_scrY;
         }
 
         trgDc = &m_buff_dc;
     }
     else
     {
         trgDc = &dc;
     }
 
     // Draw background:
     // trgDc->SetDeviceOrigin(0,0);
     trgDc->SetPen( *wxTRANSPARENT_PEN );
     wxBrush brush( GetBackgroundColour() );
     trgDc->SetBrush( brush );
     trgDc->SetTextForeground( m_fgColour );
     trgDc->DrawRectangle( 0, 0, m_scrX, m_scrY );
 
     // Draw all the layers:
     // trgDc->SetDeviceOrigin( m_scrX>>1, m_scrY>>1);  // Origin at the center
     wxLayerList::iterator li;
 
     for( li = m_layers.begin(); li != m_layers.end(); li++ )
         (*li)->Plot( *trgDc, *this );
 
     if( m_zooming )
     {
         wxPen pen( m_fgColour, 1, wxPENSTYLE_DOT );
         trgDc->SetPen( pen );
         trgDc->SetBrush( *wxTRANSPARENT_BRUSH );
         trgDc->DrawRectangle( m_zoomRect );
     }
 
     // If doublebuffer, draw now to the window:
     if( m_enableDoubleBuffer )
     {
         // trgDc->SetDeviceOrigin(0,0);
         // dc.SetDeviceOrigin(0,0);  // Origin at the center
         dc.Blit( 0, 0, m_scrX, m_scrY, trgDc, 0, 0 );
     }
 
     // If scrollbars are enabled, refresh them
     if( m_enableScrollBars )
     {
         /*       m_scroll.x = (int) floor((m_posX - m_minX)*m_scaleX);
          *        m_scroll.y = (int) floor((m_maxY - m_posY )*m_scaleY);
          *        Scroll(m_scroll.x, m_scroll.y);*/
         // Scroll(x2p(m_posX), y2p(m_posY));
         // SetVirtualSize((int) ((m_maxX - m_minX)*m_scaleX), (int) ((m_maxY - m_minY)*m_scaleY));
         // int centerX = (m_scrX - m_marginLeft - m_marginRight)/2; // + m_marginLeft; // c.x = m_scrX/2;
         // int centerY = (m_scrY - m_marginTop - m_marginBottom)/2; // - m_marginTop; // c.y = m_scrY/2;
         /*SetScrollbars(1, 1, (int) ((m_maxX - m_minX)*m_scaleX), (int) ((m_maxY - m_minY)*m_scaleY));*/    // , x2p(m_posX + centerX/m_scaleX), y2p(m_posY - centerY/m_scaleY), true);
     }
 }

References m_buff_bmp, m_buff_dc, m_enableDoubleBuffer, m_enableScrollBars, m_fgColour, m_last_lx, m_last_ly, m_layers, m_scrX, m_scrY, m_zooming, and m_zoomRect.

◆ OnScrollBottom()

void mpWindow::OnScrollBottom ( wxScrollWinEvent & event )

protected

Definition at line 2561 of file mathplot.cpp.

 {
     int scrollOrientation = event.GetOrientation();
     // Get thumb size
     int thumbSize = GetScrollThumb( scrollOrientation );
     // Get scroll range
     int scrollRange = GetScrollRange( scrollOrientation );
 
     DoScrollCalc( scrollRange - thumbSize, scrollOrientation );
 }

References DoScrollCalc().

◆ OnScrollLineDown()

void mpWindow::OnScrollLineDown ( wxScrollWinEvent & event )

protected

Definition at line 2535 of file mathplot.cpp.

 {
     int scrollOrientation = event.GetOrientation();
     // Get position before page up
     int position = GetScrollPos( scrollOrientation );
     // Get thumb size
     int thumbSize = GetScrollThumb( scrollOrientation );
     // Get scroll range
     int scrollRange = GetScrollRange( scrollOrientation );
 
     // Need to adjust position by a page
     position += mpSCROLL_NUM_PIXELS_PER_LINE;
 
     if( position > (scrollRange - thumbSize) )
         position = scrollRange - thumbSize;
 
     DoScrollCalc( position, scrollOrientation );
 }

References DoScrollCalc(), and mpSCROLL_NUM_PIXELS_PER_LINE.

◆ OnScrollLineUp()

void mpWindow::OnScrollLineUp ( wxScrollWinEvent & event )

protected

Definition at line 2519 of file mathplot.cpp.

 {
     int scrollOrientation = event.GetOrientation();
     // Get position before page up
     int position = GetScrollPos( scrollOrientation );
 
     // Need to adjust position by a line
     position -= mpSCROLL_NUM_PIXELS_PER_LINE;
 
     if( position < 0 )
         position = 0;
 
     DoScrollCalc( position, scrollOrientation );
 }

References DoScrollCalc(), and mpSCROLL_NUM_PIXELS_PER_LINE.

◆ OnScrollPageDown()

void mpWindow::OnScrollPageDown ( wxScrollWinEvent & event )

protected

Definition at line 2499 of file mathplot.cpp.

 {
     int scrollOrientation = event.GetOrientation();
     // Get position before page up
     int position = GetScrollPos( scrollOrientation );
     // Get thumb size
     int thumbSize = GetScrollThumb( scrollOrientation );
     // Get scroll range
     int scrollRange = GetScrollRange( scrollOrientation );
 
     // Need to adjust position by a page
     position += thumbSize;
 
     if( position > (scrollRange - thumbSize) )
         position = scrollRange - thumbSize;
 
     DoScrollCalc( position, scrollOrientation );
 }

References DoScrollCalc().

◆ OnScrollPageUp()

void mpWindow::OnScrollPageUp ( wxScrollWinEvent & event )

protected

Definition at line 2481 of file mathplot.cpp.

 {
     int scrollOrientation = event.GetOrientation();
     // Get position before page up
     int position = GetScrollPos( scrollOrientation );
     // Get thumb size
     int thumbSize = GetScrollThumb( scrollOrientation );
 
     // Need to adjust position by a page
     position -= thumbSize;
 
     if( position < 0 )
         position = 0;
 
     DoScrollCalc( position, scrollOrientation );
 }

References DoScrollCalc().

◆ OnScrollThumbTrack()

void mpWindow::OnScrollThumbTrack ( wxScrollWinEvent & event )

protected

Definition at line 2475 of file mathplot.cpp.

 {
     DoScrollCalc( event.GetPosition(), event.GetOrientation() );
 }

References DoScrollCalc().

◆ OnScrollTop()

void mpWindow::OnScrollTop ( wxScrollWinEvent & event )

protected

Definition at line 2555 of file mathplot.cpp.

 {
     DoScrollCalc( 0, event.GetOrientation() );
 }

References DoScrollCalc().

◆ OnShowPopupMenu()

void mpWindow::OnShowPopupMenu ( wxMouseEvent & event )

protected

Definition at line 2207 of file mathplot.cpp.

 {
     m_clickedX  = event.GetX();
     m_clickedY  = event.GetY();
     PopupMenu( &m_popmenu, event.GetX(), event.GetY() );
 }

References m_clickedX, m_clickedY, and m_popmenu.

◆ OnSize()

void mpWindow::OnSize ( wxSizeEvent & event )

protected

Definition at line 2249 of file mathplot.cpp.

 {
     // Try to fit again with the new window size:
     Fit( m_desiredXmin, m_desiredXmax, m_desiredYmin, m_desiredYmax );
 }

References Fit(), m_desiredXmax, m_desiredXmin, m_desiredYmax, and m_desiredYmin.

◆ OnZoomIn()

void mpWindow::OnZoomIn ( wxCommandEvent & event )

protected

Definition at line 2237 of file mathplot.cpp.

 {
     ZoomIn( wxPoint( m_mouseMClick.x, m_mouseMClick.y ) );
 }

References m_mouseMClick, and ZoomIn().

◆ OnZoomOut()

void mpWindow::OnZoomOut ( wxCommandEvent & event )

protected

Definition at line 2243 of file mathplot.cpp.

 {
     ZoomOut();
 }

References ZoomOut().

◆ p2x()

double mpWindow::p2x ( wxCoord pixelCoordX )

inline

Converts mpWindow (screen) pixel coordinates into graph (floating point) coordinates, using current mpWindow position and scale.

See also: p2y,x2p,y2p

Definition at line 1192 of file mathplot.h.

1192 { return m_posX + pixelCoordX / m_scaleX; }

double m_posX

Definition: mathplot.h:1514

double m_scaleX

Definition: mathplot.h:1512

Referenced by DoZoomInXCalc(), mpScaleXBase::getVisibleDataRange(), OnCenter(), CURSOR::Plot(), mpFX::Plot(), mpProfile::Plot(), ZoomIn(), ZoomOut(), and ZoomRect().

◆ p2y()

double mpWindow::p2y ( wxCoord pixelCoordY )

inline

Converts mpWindow (screen) pixel coordinates into graph (floating point) coordinates, using current mpWindow position and scale.

See also: p2x,x2p,y2p

Definition at line 1197 of file mathplot.h.

1197 { return m_posY - pixelCoordY / m_scaleY; }

double m_scaleY

Definition: mathplot.h:1513

double m_posY

Definition: mathplot.h:1515

Referenced by mpScaleY::getVisibleDataRange(), OnCenter(), mpFY::Plot(), ZoomIn(), ZoomOut(), and ZoomRect().

◆ SaveScreenshot()

bool mpWindow::SaveScreenshot	(	const wxString &	filename,
		wxBitmapType	type = `wxBITMAP_TYPE_BMP`,
		wxSize	imageSize = `wxDefaultSize`,
		bool	fit = `false`
	)

Draw the window on a wxBitmap, then save it to a file.

Parameters

filename	File name where to save the screenshot
type	image type to be saved: see wxImage output file types for flags
imageSize	Set a size for the output image. Default is the same as the screen size
fit	Decide whether to fit the plot into the size

Definition at line 2630 of file mathplot.cpp.

 {
     int sizeX, sizeY;
     int bk_scrX, bk_scrY;
 
     if( imageSize == wxDefaultSize )
     {
         sizeX   = m_scrX;
         sizeY   = m_scrY;
     }
     else
     {
         sizeX   = imageSize.x;
         sizeY   = imageSize.y;
         bk_scrX = m_scrX;
         bk_scrY = m_scrY;
         SetScr( sizeX, sizeY );
     }
 
     wxBitmap screenBuffer( sizeX, sizeY );
     wxMemoryDC screenDC;
     screenDC.SelectObject( screenBuffer );
     screenDC.SetPen( *wxWHITE_PEN );
     screenDC.SetTextForeground( m_fgColour );
     wxBrush brush( GetBackgroundColour() );
     screenDC.SetBrush( brush );
     screenDC.DrawRectangle( 0, 0, sizeX, sizeY );
 
     if( fit )
         Fit( m_minX, m_maxX, m_minY, m_maxY, &sizeX, &sizeY );
     else
         Fit( m_desiredXmin, m_desiredXmax, m_desiredYmin, m_desiredYmax, &sizeX, &sizeY );
 
     // Draw all the layers:
     for( mpLayer* layer : m_layers )
         layer->Plot( screenDC, *this );
 
     if( imageSize != wxDefaultSize )
     {
         // Restore dimensions
         SetScr( bk_scrX, bk_scrY );
         Fit( m_desiredXmin, m_desiredXmax, m_desiredYmin, m_desiredYmax, &bk_scrX, &bk_scrY );
         UpdateAll();
     }
 
     // Once drawing is complete, actually save screen shot
     wxImage screenImage = screenBuffer.ConvertToImage();
     return screenImage.SaveFile( filename, type );
 }

References Fit(), m_desiredXmax, m_desiredXmin, m_desiredYmax, m_desiredYmin, m_fgColour, m_layers, m_maxX, m_maxY, m_minX, m_minY, m_scrX, m_scrY, SetScr(), and UpdateAll().

Referenced by SIM_PLOT_FRAME::menuSaveImage().

◆ SetColourTheme()

void mpWindow::SetColourTheme	(	const wxColour &	bgColour,
		const wxColour &	drawColour,
		const wxColour &	axesColour
	)

Set Color theme.

Provide colours to set a new colour theme.

Parameters

bgColour	Background colour
drawColour	The colour used to draw all elements in foreground, axes excluded
axesColour	The colour used to draw axes (but not their labels)

Definition at line 2748 of file mathplot.cpp.

 {
     SetBackgroundColour( bgColour );
     SetForegroundColour( drawColour );
     m_bgColour  = bgColour;
     m_fgColour  = drawColour;
     m_axColour  = axesColour;
 
     // Cycle between layers to set colours and properties to them
     for( mpLayer* layer : m_layers )
     {
         if( layer->GetLayerType() == mpLAYER_AXIS )
         {
             wxPen axisPen = layer->GetPen();    // Get the old pen to modify only colour, not style or width
             axisPen.SetColour( axesColour );
             layer->SetPen( axisPen );
         }
 
         if( layer->GetLayerType() == mpLAYER_INFO )
         {
             wxPen infoPen = layer->GetPen();    // Get the old pen to modify only colour, not style or width
             infoPen.SetColour( drawColour );
             layer->SetPen( infoPen );
         }
     }
 }

References m_axColour, m_bgColour, m_fgColour, m_layers, mpLAYER_AXIS, and mpLAYER_INFO.

Referenced by mpPrintout::OnPrintPage(), and SIM_PLOT_PANEL::UpdatePlotColors().

◆ SetLayerVisible() [1/2]

void mpWindow::SetLayerVisible	(	const wxString &	name,
		bool	viewable
	)

Sets the visibility of a layer by its name.

Parameters

name	The layer name to set visibility
viewable	the view status to be set

Definition at line 2708 of file mathplot.cpp.

 {
     mpLayer* lx = GetLayerByName( name );
 
     if( lx )
     {
         lx->SetVisible( viewable );
         UpdateAll();
     }
 }

References GetLayerByName(), name, mpLayer::SetVisible(), and UpdateAll().

◆ SetLayerVisible() [2/2]

void mpWindow::SetLayerVisible	(	const unsigned int	position,
		bool	viewable
	)

Sets the visibility of a layer by its position in layer list.

Parameters

position	The layer position in layer list
viewable	the view status to be set

Definition at line 2728 of file mathplot.cpp.

 {
     mpLayer* lx = GetLayer( position );
 
     if( lx )
     {
         lx->SetVisible( viewable );
         UpdateAll();
     }
 }

References GetLayer(), mpLayer::SetVisible(), and UpdateAll().

◆ SetMarginBottom()

void mpWindow::SetMarginBottom ( int bottom )

inline

Set the bottom margin.

Parameters

bottom Bottom Margin

Definition at line 1366 of file mathplot.h.

1366 { m_marginBottom = bottom; };

mpWindow::m_marginBottom

int m_marginBottom

Definition: mathplot.h:1526

◆ SetMarginLeft()

void mpWindow::SetMarginLeft ( int left )

inline

Set the left margin.

Parameters

left	Left Margin

Definition at line 1368 of file mathplot.h.

1368 { m_marginLeft = left; };

mpWindow::m_marginLeft

int m_marginLeft

Definition: mathplot.h:1526

BITMAPS::left

References left.

◆ SetMarginRight()

void mpWindow::SetMarginRight ( int right )

inline

Set the right margin.

Parameters

right Right Margin

Definition at line 1364 of file mathplot.h.

1364 { m_marginRight = right; };

mpWindow::m_marginRight

int m_marginRight

Definition: mathplot.h:1526

BITMAPS::right

References right.

◆ SetMargins()

void mpWindow::SetMargins	(	int	top,
		int	right,
		int	bottom,
		int	left
	)

Set window margins, creating a blank area where some kinds of layers cannot draw.

This is useful for example to draw axes outside the area where the plots are drawn.

Parameters

top	Top border
right	Right border
bottom	Bottom border
left	Left border

Definition at line 2682 of file mathplot.cpp.

 {
     m_marginTop    = top;
     m_marginRight  = right;
     m_marginBottom = bottom;
     m_marginLeft   = left;
 }

References left, m_marginBottom, m_marginLeft, m_marginRight, m_marginTop, and right.

Referenced by SIM_PLOT_PANEL::SIM_PLOT_PANEL().

◆ SetMarginTop()

void mpWindow::SetMarginTop ( int top )

inline

Set the top margin.

Parameters

top	Top Margin

Definition at line 1362 of file mathplot.h.

1362 { m_marginTop = top; };

mpWindow::m_marginTop

int m_marginTop

Definition: mathplot.h:1526

◆ SetMPScrollbars()

void mpWindow::SetMPScrollbars ( bool status )

Enable/disable scrollbars.

Parameters

status Set to true to show scrollbars

◆ SetPos()

void mpWindow::SetPos	(	double	posX,
		double	posY
	)

inline

Set current view's X and Y position and refresh display.

Parameters

posX	New position that corresponds to the center point of the view.
posY	New position that corresponds to the center point of the view.

Definition at line 1180 of file mathplot.h.

1180 { m_posX = posX; m_posY = posY; UpdateAll(); }

double m_posX

Definition: mathplot.h:1514

mpWindow::UpdateAll

void UpdateAll()

Refresh display.

Definition: mathplot.cpp:2403

double m_posY

Definition: mathplot.h:1515

Referenced by OnCenter().

◆ SetPosX()

void mpWindow::SetPosX ( double posX )

inline

Set current view's X position and refresh display.

Parameters

posX	New position that corresponds to the center point of the view.

Definition at line 1169 of file mathplot.h.

1169 { m_posX = posX; UpdateAll(); }

double m_posX

Definition: mathplot.h:1514

mpWindow::UpdateAll

void UpdateAll()

Refresh display.

Definition: mathplot.cpp:2403

Referenced by DoScrollCalc().

◆ SetPosY()

void mpWindow::SetPosY ( double posY )

inline

Set current view's Y position and refresh display.

Parameters

posY	New position that corresponds to the center point of the view.

Definition at line 1174 of file mathplot.h.

1174 { m_posY = posY; UpdateAll(); }

mpWindow::UpdateAll

void UpdateAll()

Refresh display.

Definition: mathplot.cpp:2403

double m_posY

Definition: mathplot.h:1515

Referenced by DoScrollCalc().

◆ SetScaleX()

void mpWindow::SetScaleX ( double scaleX )

Set current view's X scale and refresh display.

Parameters

scaleX New scale, must not be 0.

Definition at line 2575 of file mathplot.cpp.

 {
     if( scaleX != 0 )
         m_scaleX = scaleX;
 
     UpdateAll();
 }

References m_scaleX, and UpdateAll().

◆ SetScaleY()

void mpWindow::SetScaleY ( double scaleY )

inline

Set current view's Y scale and refresh display.

Parameters

scaleY New scale, must not be 0.

Definition at line 1158 of file mathplot.h.

     {
         if( scaleY != 0 )
             m_scaleY = scaleY;
 
         UpdateAll();
     }

◆ SetScr()

void mpWindow::SetScr	(	int	scrX,
		int	scrY
	)

inline

Set current view's dimensions in device context units.

Needed by plotting functions. It doesn't refresh display.

Parameters

scrX	New position that corresponds to the center point of the view.
scrY	New position that corresponds to the center point of the view.

Definition at line 1187 of file mathplot.h.

1187 { m_scrX = scrX; m_scrY = scrY; }

mpWindow::m_scrY

int m_scrY

Definition: mathplot.h:1517

mpWindow::m_scrX

int m_scrX

Definition: mathplot.h:1516

Referenced by SaveScreenshot().

◆ SetXView()

bool mpWindow::SetXView	(	double	pos,
		double	desiredMax,
		double	desiredMin
	)

protectedvirtual

Applies new X view coordinates depending on the settings.

Returns: true if the changes were applied

Definition at line 2042 of file mathplot.cpp.

 {
     // if(!CheckXLimits(desiredMax, desiredMin))
     // return false;
 
     m_posX = pos;
     m_desiredXmax   = desiredMax;
     m_desiredXmin   = desiredMin;
     AdjustLimitedView();
 
     return true;
 }

References AdjustLimitedView(), m_desiredXmax, m_desiredXmin, and m_posX.

Referenced by OnMouseMove(), and OnMouseWheel().

◆ SetYView()

bool mpWindow::SetYView	(	double	pos,
		double	desiredMax,
		double	desiredMin
	)

protectedvirtual

Applies new Y view coordinates depending on the settings.

Returns: true if the changes were applied

Definition at line 2056 of file mathplot.cpp.

 {
     // if(!CheckYLimits(desiredMax, desiredMin))
     // return false;
 
     m_posY = pos;
     m_desiredYmax   = desiredMax;
     m_desiredYmin   = desiredMin;
     AdjustLimitedView();
 
     return true;
 }

References AdjustLimitedView(), m_desiredYmax, m_desiredYmin, and m_posY.

Referenced by OnMouseMove(), and OnMouseWheel().

◆ UpdateAll()

void mpWindow::UpdateAll ( )

Refresh display.

Definition at line 2403 of file mathplot.cpp.

 {
     if( UpdateBBox() )
     {
         if( m_enableScrollBars )
         {
             int cx, cy;
             GetClientSize( &cx, &cy );
             // Do x scroll bar
             {
                 // Convert margin sizes from pixels to coordinates
                 double leftMargin = m_marginLeft / m_scaleX;
                 // Calculate the range in coords that we want to scroll over
                 double  maxX    = (m_desiredXmax > m_maxX) ? m_desiredXmax : m_maxX;
                 double  minX    = (m_desiredXmin < m_minX) ? m_desiredXmin : m_minX;
 
                 if( (m_posX + leftMargin) < minX )
                     minX = m_posX + leftMargin;
 
                 // Calculate scroll bar size and thumb position
                 int sizeX   = (int) ( (maxX - minX) * m_scaleX );
                 int thumbX  = (int) ( ( (m_posX + leftMargin) - minX ) * m_scaleX );
                 SetScrollbar( wxHORIZONTAL, thumbX, cx - (m_marginRight + m_marginLeft), sizeX );
             }
             // Do y scroll bar
             {
                 // Convert margin sizes from pixels to coordinates
                 double topMargin = m_marginTop / m_scaleY;
                 // Calculate the range in coords that we want to scroll over
                 double maxY = (m_desiredYmax > m_maxY) ? m_desiredYmax : m_maxY;
 
                 if( (m_posY - topMargin) > maxY )
                     maxY = m_posY - topMargin;
 
                 double minY = (m_desiredYmin < m_minY) ? m_desiredYmin : m_minY;
                 // Calculate scroll bar size and thumb position
                 int sizeY   = (int) ( (maxY - minY) * m_scaleY );
                 int thumbY  = (int) ( ( maxY - (m_posY - topMargin) ) * m_scaleY );
                 SetScrollbar( wxVERTICAL, thumbY, cy - (m_marginTop + m_marginBottom), sizeY );
             }
         }
     }
 
     Refresh( false );
 }

References m_desiredXmax, m_desiredXmin, m_desiredYmax, m_desiredYmin, m_enableScrollBars, m_marginBottom, m_marginLeft, m_marginRight, m_marginTop, m_maxX, m_maxY, m_minX, m_minY, m_posX, m_posY, m_scaleX, m_scaleY, Refresh(), and UpdateBBox().

Referenced by AddLayer(), SIM_PLOT_PANEL::addTrace(), DelAllLayers(), DelLayer(), Fit(), mpWindow(), OnMouseMove(), OnMouseWheel(), mpPrintout::OnPrintPage(), SIM_PLOT_FRAME::onSimFinished(), SaveScreenshot(), SIM_PLOT_PANEL::SetDottedCurrentPhase(), SetLayerVisible(), SetScaleX(), SIM_PLOT_PANEL::ShowGrid(), SIM_PLOT_PANEL::ShowLegend(), SIM_PLOT_PANEL::SIM_PLOT_PANEL(), SIM_PLOT_PANEL::UpdatePlotColors(), ZoomIn(), ZoomInX(), and ZoomOut().

◆ UpdateBBox()

bool mpWindow::UpdateBBox ( )

protectedvirtual

Recalculate global layer bounding box, and save it in m_minX,...

Returns: true if there is any valid BBox information.

Definition at line 2392 of file mathplot.cpp.

 {
     m_minX  = 0.0;
     m_maxX  = 1.0;
     m_minY  = 0.0;
     m_maxY  = 1.0;
 
     return true;
 }

References m_maxX, m_maxY, m_minX, and m_minY.

Referenced by Fit(), and UpdateAll().

◆ x2p()

wxCoord mpWindow::x2p ( double x )

inline

Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates, using current mpWindow position and scale.

See also: p2x,p2y,y2p

Definition at line 1202 of file mathplot.h.

1202 { return (wxCoord) ( (x - m_posX) * m_scaleX ); }

double m_posX

Definition: mathplot.h:1514

double m_scaleX

Definition: mathplot.h:1512

Referenced by CURSOR::Inside(), CURSOR::Plot(), mpFY::Plot(), mpFXY::Plot(), mpScaleY::Plot(), mpMovableObject::Plot(), mpBitmapLayer::Plot(), and CURSOR::UpdateReference().

◆ y2p()

wxCoord mpWindow::y2p ( double y )

inline

Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates, using current mpWindow position and scale.

See also: p2x,p2y,x2p

Definition at line 1207 of file mathplot.h.

1207 { return (wxCoord) ( (m_posY - y) * m_scaleY ); }

double m_scaleY

Definition: mathplot.h:1513