sim_plot_tab.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016-2023 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 * @author Maciej Suminski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef __SIM_PLOT_PANEL_H
#define __SIM_PLOT_PANEL_H
 
#include "sim_types.h"
#include <map>
#include <vector>
#include <limits>
#include <widgets/mathplot.h>
#include <math/util.h>
#include <wx/colour.h>
#include <wx/sizer.h>
#include "sim_tab.h"
#include "smith_math.h"
#include "sim_plot_colors.h"
 
class SIMULATOR_FRAME;
class SIM_PLOT_TAB;
class SIM_VIEW;
class TRACE;

 

class CURSOR : public mpInfoLayer
{
public:
    CURSOR( TRACE* aTrace, SIM_PLOT_TAB* aPlotTab ) :
            mpInfoLayer( wxRect( 0, 0, DRAG_MARGIN, DRAG_MARGIN ), wxTRANSPARENT_BRUSH ),
            m_trace( aTrace ),
            m_updateRequired( true ),
            m_updateRef( false ),
            m_coords( 0.0, 0.0 ),
            m_window( nullptr ),
            m_sweepIndex( 0 ),
            m_snapToNearest( false ),
            m_snapTargetY( 0.0 )
    {
    }
 
    void Plot( wxDC& aDC, mpWindow& aWindow ) override;
 
    void SetX( int aX )
    {
        m_reference.x = 0;
        m_updateRef = true;
        Move( wxPoint( aX, 0 ) );
    }
 
    void Update()
    {
        m_updateRequired = true;
    }
 
    virtual void UpdateForNewData() { SetCoordX( m_coords.x ); }
 
    bool Inside( const wxPoint& aPoint ) const override;
 
    void Move( wxPoint aDelta ) override;
 
    void UpdateReference() override;
 
    bool OnDoubleClick( const wxPoint& aPoint, mpWindow& aWindow ) override;
 
    const wxRealPoint& GetCoords() const
    {
        return m_coords;
    }
 
    virtual void SetCoordX( double aValue );
 
private:
    void doSetCoordX( double aValue );
 
protected:
    wxString getID();
 
protected:
    TRACE*       m_trace;
    bool         m_updateRequired;
    bool         m_updateRef;
    wxRealPoint  m_coords;
    mpWindow*    m_window;
    int          m_sweepIndex;
    bool         m_snapToNearest;
    double       m_snapTargetY;
 
    static constexpr int DRAG_MARGIN = 10;
};
 
 
class TRACE : public mpFXYVector
{
public:
    TRACE( const wxString& aName, SIM_TRACE_TYPE aType ) :
            mpFXYVector( aName ),
            m_type( aType ),
            m_isMultiRun( false ),
            m_view( nullptr ),
            m_yScaleView( nullptr )
    {
        SetContinuity( true );
        ShowName( false );
        SetName( aName );
    }
 
    void SetName( const wxString& aName ) override
    {
        for( auto& [ idx, cursor ] : m_cursors )
        {
            if( cursor )
                cursor->SetName( aName );
        }
 
        mpFXYVector::SetName( aName );
 
        if( m_type & SPT_AC_GAIN )
            m_displayName = aName + _( " (gain)" );
        else if( m_type & SPT_AC_PHASE )
            m_displayName = aName + _( " (phase)" );
        else
            m_displayName = aName;
    }

    void SetData( const std::vector<double>& aX, const std::vector<double>& aY ) override
    {
        for( auto& [ idx, cursor ] : m_cursors )
        {
            if( cursor )
                cursor->Update();
        }
 
        mpFXYVector::SetData( aX, aY );
    }
 
    const std::vector<double>& GetDataX() const { return m_xs; }
    const std::vector<double>& GetDataY() const { return m_ys; }
 
    bool HasCursor( int aCursorId ) { return m_cursors[ aCursorId ] != nullptr; }
 
    void SetCursor( int aCursorId, CURSOR* aCursor ) { m_cursors[ aCursorId ] = aCursor; }
    CURSOR* GetCursor( int aCursorId ) { return m_cursors[ aCursorId ]; }
    std::map<int, CURSOR*>& GetCursors() { return m_cursors; }
 
    SIM_TRACE_TYPE GetType() const { return m_type; }
 
    void SetTraceColour( const wxColour& aColour ) { m_traceColour = aColour; }
    wxColour GetTraceColour() const { return m_traceColour; }
 
    void SetIsMultiRun( bool aIsMultiRun ) { m_isMultiRun = aIsMultiRun; }
    bool IsMultiRun() const { return m_isMultiRun; }
 
    void SetMultiRunLabels( const std::vector<wxString>& aLabels ) { m_multiRunLabels = aLabels; }
    const std::vector<wxString>& GetMultiRunLabels() const { return m_multiRunLabels; }

    SIM_VIEW* GetView() const { return m_view; }
    void      SetView( SIM_VIEW* aView ) { m_view = aView; }

    SIM_VIEW* GetYScaleView() const { return m_yScaleView ? m_yScaleView : m_view; }
    void      SetYScaleView( SIM_VIEW* aView ) { m_yScaleView = ( aView == m_view ) ? nullptr : aView; }

    bool IsYScaleDefault() const { return m_yScaleView == nullptr; }

    void ClearYScaleViewIf( SIM_VIEW* aView )
    {
        if( m_yScaleView == aView )
            m_yScaleView = nullptr;
    }
 
protected:
    std::map<int, CURSOR*> m_cursors;       // No ownership; the mpWindow owns the CURSORs
    SIM_TRACE_TYPE         m_type;
    wxColour               m_traceColour;
    bool                   m_isMultiRun;
    std::vector<wxString>  m_multiRunLabels;
    SIM_VIEW*              m_view;       // No ownership; the SIM_PLOT_TAB owns the SIM_VIEWs
    SIM_VIEW*              m_yScaleView; // No ownership; nullptr means "same as m_view"
};
 

class SMITH_GRID : public mpLayer
{
public:
    SMITH_GRID() { m_type = mpLAYER_AXIS; }
 
    void Plot( wxDC& aDC, mpWindow& aWindow ) override;
 
    bool HasBBox() const override { return false; }

    void SetReferenceImpedance( double aZ0 ) { m_z0 = aZ0; }
 
    void SetMixedReferences( bool aMixed ) { m_mixedReferences = aMixed; }

    static bool GetChartView( mpWindow& aWindow, double aZoom, const wxRealPoint& aPan, SMITH_VIEW& aView );
 
private:
    double m_z0 = 0.0;
    bool   m_mixedReferences = false;
};
 

class SMITH_TRACE : public TRACE
{
public:
    SMITH_TRACE( const wxString& aName, SIM_TRACE_TYPE aType ) :
            TRACE( aName, aType )
    {
    }
 
    void Plot( wxDC& aDC, mpWindow& aWindow ) override;
 
    // drawn directly, keep the locus out of the axis auto-fit
    bool HasBBox() const override { return false; }
 
    void                       SetFrequencies( const std::vector<double>& aFreqs ) { m_frequencies = aFreqs; }
    const std::vector<double>& GetFrequencies() const { return m_frequencies; }

    void   SetReferenceImpedance( double aZ0 ) { m_z0 = aZ0; }
    double GetReferenceImpedance() const { return m_z0; }
 
private:
    std::vector<double> m_frequencies;
    double              m_z0 = 0.0;
};
 

class SMITH_CURSOR : public CURSOR
{
public:
    SMITH_CURSOR( SMITH_TRACE* aTrace, SIM_PLOT_TAB* aPlotTab ) :
            CURSOR( aTrace, aPlotTab ),
            m_index( -1 ),
            m_gamma( 0.0, 0.0 ),
            m_requestFreq( 0.0 ),
            m_pendingFreq( false ),
            m_dragging( false )
    {
    }
 
    void Plot( wxDC& aDC, mpWindow& aWindow ) override;
 
    bool Inside( const wxPoint& aPoint ) const override;
 
    void Move( wxPoint aDelta ) override;
 
    void UpdateReference() override;
 
    void SetCoordX( double aValue ) override;
 
    void UpdateForNewData() override;
 
    const wxRealPoint& GetGamma() const { return m_gamma; }
 
private:
    void snapToIndex( int aIndex );
    void snapToFrequency( double aFreq );
 
private:
    int         m_index;
    wxRealPoint m_gamma;
    double      m_requestFreq;
    bool        m_pendingFreq; // a saved frequency waiting for the sim data to load
    bool        m_dragging;    // the pending update comes from a drag, not a data refresh
};
 

struct SMITH_STASHED_TRACE
{
    wxString vectorName;
    wxString displayName;
    int      baseType;
};
 

struct SMITH_STASHED_CURSOR
{
    int      id;
    wxString vectorName;
    int      baseType;
    int      subType; // the SP subtype bit the cursor lived on before Smith mode
    double   frequency;
};
 

class SIM_VIEW : public mpWindow
{
public:
    SIM_VIEW( SIM_PLOT_TAB* aPlotTab, wxWindow* aParent );

    void OnXViewChanged() override;

    void SetXRange( double aPos, double aDesiredMax, double aDesiredMin )
    {
        SetXView( aPos, aDesiredMax, aDesiredMin );
    }
 
    SIM_PLOT_TAB* GetPlotTab() const { return m_plotTab; }
 
    wxString GetLabelX() const { return m_axis_x ? m_axis_x->GetName() : wxString( wxS( "" ) ); }
 
    wxString GetLabelY1() const { return m_axis_y1 ? m_axis_y1->GetName() : wxString( wxS( "" ) ); }
 
    wxString GetLabelY2() const { return m_axis_y2 ? m_axis_y2->GetName() : wxString( wxS( "" ) ); }
 
    wxString GetLabelY3() const { return m_axis_y3 ? m_axis_y3->GetName() : wxString( wxS( "" ) ); }
 
    bool GetY1Scale( double* aMin, double* aMax ) const
    {
        if( m_axis_y1 )
            return m_axis_y1->GetAxisMinMax( aMin, aMax );
 
        return false;
    }
 
    bool GetY2Scale( double* aMin, double* aMax ) const
    {
        if( m_axis_y2 )
            return m_axis_y2->GetAxisMinMax( aMin, aMax );
 
        return false;
    }
 
    bool GetY3Scale( double* aMin, double* aMax ) const
    {
        if( m_axis_y3 )
            return m_axis_y3->GetAxisMinMax( aMin, aMax );
 
        return false;
    }
 
    void SetY1Scale( bool aLock, double aMin, double aMax );
    void SetY2Scale( bool aLock, double aMin, double aMax );
    void SetY3Scale( bool aLock, double aMin, double aMax );
 
    wxString GetUnitsX() const;
    wxString GetUnitsY1() const;
    wxString GetUnitsY2() const;
    wxString GetUnitsY3() const;

    wxString GetUnitsForTrace( TRACE* aTrace ) const;

    int GetAxisSlot( TRACE* aTrace ) const;

    mpScaleY* GetAxisBySlot( int aSlot ) const;
 
    void ShowGrid( bool aEnable )
    {
        if( m_axis_x )
            m_axis_x->SetTicks( !aEnable );
 
        if( m_axis_y1 )
            m_axis_y1->SetTicks( !aEnable );
 
        if( m_axis_y2 )
            m_axis_y2->SetTicks( !aEnable );
 
        if( m_axis_y3 )
            m_axis_y3->SetTicks( !aEnable );
 
        UpdateAll();
    }
 
    bool IsGridShown() const
    {
        if( !m_axis_x || !m_axis_y1 )
            return false;
 
        return !m_axis_x->GetTicks();
    }
 
    void ShowLegend( bool aEnable )
    {
        m_legend->SetVisible( aEnable );
        UpdateAll();
    }
 
    bool IsLegendShown() const { return m_legend->IsVisible(); }
 
    wxPoint GetLegendPosition() const { return m_legend->GetPosition(); }
 
    void SetLegendPosition( const wxPoint& aPosition )
    {
        m_legend->Move( aPosition );
        m_legend->UpdateReference();
        m_lastLegendPosition = aPosition;
    }

    void ResetScales( bool aIncludeX );

    void updateAxes( int aNewTraceType = SIM_TRACE_TYPE::SPT_UNKNOWN );
 
    void UpdateAxisVisibility();
 
    void EnsureThirdYAxisExists();
 
    // ---- Smith chart --------------------------------------------------------------------

    void SetSmithChart( bool aEnable );
 
    bool IsSmithChart() const { return m_smithChart; }

    void UpdateSmithReferenceImpedance();

    void UpdateSmithGridColor();
 
    double             GetSmithZoom() const { return m_smithZoom; }
    const wxRealPoint& GetSmithPan() const { return m_smithPan; }
 
    void ResetSmithView()
    {
        m_smithZoom = 1.0;
        m_smithPan = wxRealPoint( 0.0, 0.0 );
    }
 
    void SetSmithView( double aZoom, double aPanX, double aPanY )
    {
        m_smithZoom = std::isfinite( aZoom ) ? std::clamp( aZoom, 1.0, 50.0 ) : 1.0;
        m_smithPan.x = std::isfinite( aPanX ) ? std::clamp( aPanX, -100.0, 100.0 ) : 0.0;
        m_smithPan.y = std::isfinite( aPanY ) ? std::clamp( aPanY, -100.0, 100.0 ) : 0.0;
    }
 
    void SmithZoomAt( const wxPoint& aPos, double aFactor );
    void SmithPanBy( const wxPoint& aDelta );
 
public:
    wxPoint m_lastLegendPosition;
 
    mpScaleXBase* m_axis_x;
    mpScaleY*     m_axis_y1;
    mpScaleY*     m_axis_y2;
    mpScaleY*     m_axis_y3;
    mpInfoLegend* m_legend;
 
private:
    void prepareDCAxes( int aNewTraceType );
 
    void onSmithMouseWheel( wxMouseEvent& aEvent );
    void onSmithMagnify( wxMouseEvent& aEvent );
    void onSmithMiddleDown( wxMouseEvent& aEvent );
    void onSmithLeftDown( wxMouseEvent& aEvent );
    void onSmithMotion( wxMouseEvent& aEvent );
    void onSmithLeftUp( wxMouseEvent& aEvent );
    void onSmithDClick( wxMouseEvent& aEvent );
    void onSmithRightDown( wxMouseEvent& aEvent );
    void onSmithRightUp( wxMouseEvent& aEvent );
    void onSmithMenuCommand( wxCommandEvent& aEvent );
 
    bool getSmithView( SMITH_VIEW& aView ) const;
 
private:
    SIM_PLOT_TAB* m_plotTab;
 
    SMITH_GRID* m_smithGrid;
 
    bool        m_smithChart;
    double      m_smithZoom;
    wxRealPoint m_smithPan;
    bool        m_smithPanning;
    bool        m_smithLeftSkipped;
    wxPoint     m_smithPanLast;
    wxPoint     m_smithMenuPos;
};
 
 
class SIM_PLOT_TAB : public SIM_TAB
{
public:
    SIM_PLOT_TAB( const wxString& aSimCommand, wxWindow* parent );
 
    virtual ~SIM_PLOT_TAB();
 
    void ApplyPreferences( const SIM_PREFERENCES& aPrefs ) override;
 
    // ---- View management ----------------------------------------------------------------
 
    const std::vector<SIM_VIEW*>& GetViews() const { return m_views; }
 
    SIM_VIEW* GetView( int aIndex ) const
    {
        return ( aIndex >= 0 && aIndex < (int) m_views.size() ) ? m_views[aIndex] : nullptr;
    }
 
    int GetViewIndex( SIM_VIEW* aView ) const;
 
    int GetViewCount() const { return (int) m_views.size(); }

    SIM_VIEW* GetDefaultView() const { return m_views.empty() ? nullptr : m_views[0]; }

    SIM_VIEW* AddView();

    bool RemoveView( SIM_VIEW* aView );

    void SyncXView( SIM_VIEW* aSource );
 
    // ---- Tab-wide accessors (identical across views; delegate to the default view) -------
 
    wxString GetLabelX() const;
    wxString GetUnitsX() const;

    wxString GetUnitsForTrace( TRACE* aTrace ) const;
 
    // ---- Settings shared/fanned out across all views --------------------------------------
 
    void ShowGrid( bool aEnable );
    bool IsGridShown() const;
 
    void    ShowLegend( bool aEnable );
    bool    IsLegendShown() const;
    wxPoint GetLegendPosition() const;
    void    SetLegendPosition( const wxPoint& aPosition );
 
    // ---- Default-view convenience (used by the Analysis Properties dialog) ----------------
 
    wxString GetLabelY1() const;
    wxString GetLabelY2() const;
    wxString GetLabelY3() const;
    wxString GetUnitsY1() const;
    wxString GetUnitsY2() const;
    wxString GetUnitsY3() const;
 
    bool GetY1Scale( double* aMin, double* aMax ) const;
    bool GetY2Scale( double* aMin, double* aMax ) const;
    bool GetY3Scale( double* aMin, double* aMax ) const;
    void SetY1Scale( bool aLock, double aMin, double aMax );
    void SetY2Scale( bool aLock, double aMin, double aMax );
    void SetY3Scale( bool aLock, double aMin, double aMax );
 
    void EnsureThirdYAxisExists();

    void SetDottedSecondary( bool aEnable )
    {
        m_dotted_cp = aEnable;
 
        for( const auto& [name, trace] : m_traces )
            UpdateTraceStyle( trace );
 
        for( SIM_VIEW* view : m_views )
            view->UpdateAll();
    }
 
    bool GetDottedSecondary() const { return m_dotted_cp; }

    void SetSmithMode( bool aEnable );
    bool IsSmithMode() const { return m_smithMode; }

    void UpdateSmithReferenceImpedance();

    double      GetSmithZoom() const;
    wxRealPoint GetSmithPan() const;
 
    void ResetSmithView();

    void SetSmithView( double aZoom, double aPanX, double aPanY );
 
    void SmithZoomAt( const wxPoint& aPos, double aFactor );
    void SmithPanBy( const wxPoint& aDelta );

    std::vector<SMITH_STASHED_TRACE>&  SmithStashedTraces() { return m_smithStashedTraces; }
    std::vector<SMITH_STASHED_CURSOR>& SmithStashedCursors() { return m_smithStashedCursors; }

    void EnableCursor( TRACE* aTrace, int aCursorId, const wxString& aSignalName );
    void DisableCursor( TRACE* aTrace, int aCursorId );

    void ResetScales( bool aIncludeX );

    void UpdateTraceStyle( TRACE* trace );

    void UpdatePlotColors();
 
    wxColour GetPlotColor( SIM_PLOT_COLORS::COLOR_SET aColorId ) { return m_colors.GetPlotColor( aColorId ); }
 
    void OnLanguageChanged() override;

    mpWindow* GetPlotWin() const;

    TRACE* GetOrAddTrace( const wxString& aVectorName, int aType, SIM_VIEW* aView );
 
    void SetTraceData( TRACE* aTrace, std::vector<double>& aX, std::vector<double>& aY, int aSweepCount,
                       size_t aSweepSize, bool aIsMultiRun = false, const std::vector<wxString>& aMultiRunLabels = {} );
 
    bool DeleteTrace( const wxString& aVectorName, int aTraceType );
    void DeleteTrace( TRACE* aTrace );
 
    const std::map<wxString, TRACE*>& GetTraces() const { return m_traces; }
 
    TRACE* GetTrace( const wxString& aVecName, int aType ) const
    {
        auto trace = m_traces.find( getTraceId( aVecName, aType ) );
 
        return trace == m_traces.end() ? nullptr : trace->second;
    }
 
    std::vector<std::pair<wxString, wxString>>& Measurements() { return m_measurements; }
 
public:
    wxPoint m_LastLegendPosition;
 
private:
    static mpWindow::MouseWheelActionSet convertMouseWheelActions( const SIM_MOUSE_WHEEL_ACTION_SET& s )
    {
        static_assert( static_cast<unsigned>( mpWindow::MouseWheelAction::COUNT )
                               == static_cast<unsigned>( SIM_MOUSE_WHEEL_ACTION::COUNT ),
                       "mpWindow::MouseWheelAction enum must match SIM_MOUSE_WHEEL_ACTION" );
 
        using A = mpWindow::MouseWheelAction;
        mpWindow::MouseWheelActionSet m;
        m.verticalUnmodified = static_cast<A>( s.vertical_unmodified );
        m.verticalWithCtrl = static_cast<A>( s.vertical_with_ctrl );
        m.verticalWithShift = static_cast<A>( s.vertical_with_shift );
        m.verticalWithAlt = static_cast<A>( s.vertical_with_alt );
        m.horizontal = static_cast<A>( s.horizontal );
 
        return m;
    }
 
    wxString getTraceId( const wxString& aVectorName, int aType ) const
    {
        return wxString::Format( wxS( "%s%d" ), aVectorName, aType & SPT_Y_AXIS_MASK );
    }
 
private:
    SIM_PLOT_COLORS               m_colors;
    std::map<wxString, wxColour>  m_sessionTraceColors;
 
    wxBoxSizer*                   m_viewsSizer;      // Holds all the stacked SIM_VIEWs
 
    // Stacked plot views (owned via wx parent-child, except when explicitly removed)
    std::vector<SIM_VIEW*>        m_views;
 
    // Cached so newly-added views can be initialized with the current preferences
    mpWindow::MouseWheelActionSet m_mouseWheelActions;
 
    // Traces to be plotted; each knows which view (if any) it's currently plotted on
    std::map<wxString, TRACE*>    m_traces;
 
    bool m_dotted_cp;
 
    // Re-entrancy guard for SyncXView()
    bool m_syncingXView;
 
    // Smith-chart mode is a property of the whole tab; each SIM_VIEW carries its own grid
    // layer and pan/zoom state.
    bool m_smithMode;
 
    std::vector<SMITH_STASHED_TRACE>  m_smithStashedTraces;
    std::vector<SMITH_STASHED_CURSOR> m_smithStashedCursors;
 
    // Measurements (and their format strings)
    std::vector<std::pair<wxString, wxString>> m_measurements;
};
 
wxDECLARE_EVENT( EVT_SIM_CURSOR_UPDATE, wxCommandEvent );

wxDECLARE_EVENT( EVT_SIM_VIEWS_CHANGED, wxCommandEvent );
 
#endif