panel_board_stackup.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 2
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef PANEL_SETUP_BOARD_STACKUP_H
#define PANEL_SETUP_BOARD_STACKUP_H
 
 
#include <board.h>
#include <widgets/unit_binder.h>
#include <wx/gdicmn.h>
 
#include "panel_board_stackup_base.h"
#include "board_stackup.h"
#include "stackup_predefined_prms.h"
#include "dielectric_material.h"
 
class wxBitmapComboBox;
class PANEL_SETUP_LAYERS;
class PANEL_SETUP_BOARD_FINISH;
 
 
// A helper class to handle UI items managed by m_fgGridSizer
// in PANEL_SETUP_BOARD_STACKUP
// these items are shown or not in m_fgGridSizer, depending on
// the enabled layers in the current board.
// So we need to store the list of these UI items int m_fgGridSizer
// row by row
struct BOARD_STACKUP_ROW_UI_ITEM
{
    BOARD_STACKUP_ITEM* m_Item;            // The BOARD_STACKUP_ITEM managed by this BOARD_STACKUP_ROW_UI_ITEM
    int                 m_SubItem;         // For multilayer dielectric, the index in sublayer list.
                                           // Must be >= 0 and < m_Item sublayer count. Used only for dielectic
                                           // 0 is the base list of parameters (always existing)
    int  m_Row;                            // The row number in the parent grid
    bool m_isEnabled;                      // True if the row is in board
                                           // false if not (this row is not shown on the panel)
    wxStaticBitmap* m_Icon;                // Color icon in first column (column 1)
    wxStaticText*   m_LayerName;           // string shown in column 2
    wxControl*      m_LayerTypeCtrl;       // control shown in column 3
    wxControl*      m_MaterialCtrl;        // control shown in column 4, with m_MaterialButt
    wxButton*       m_MaterialButt;        // control shown in column 4, with m_MaterialCtrl
    wxControl*      m_ThicknessCtrl;       // control shown in column 5
    wxControl*      m_ThicknessLockCtrl;   // control shown in column 6
    wxControl*      m_ColorCtrl;           // control shown in column 7
    wxControl*      m_EpsilonCtrl;         // control shown in column 8
    wxControl*      m_LossTgCtrl;          // control shown in column 9
    wxControl*      m_SpecFreqCtrl;        // control shown in column 10
    wxControl*      m_SpecFreqUnitsCtrl;   // control shown in column 11
    wxControl*      m_DielectricModelCtrl; // control shown in column 12
 
    COLOR4D m_UserColor; // User-specified color (if any)
 
    BOARD_STACKUP_ROW_UI_ITEM( BOARD_STACKUP_ITEM* aItem, int aSubItem, int aRow ) :
            m_Item( aItem ),
            m_SubItem( aSubItem ),
            m_Row( aRow ),
            m_isEnabled( false ),
            m_Icon( nullptr ),
            m_LayerName( nullptr ),
            m_LayerTypeCtrl( nullptr ),
            m_MaterialCtrl( nullptr ),
            m_MaterialButt( nullptr ),
            m_ThicknessCtrl( nullptr ),
            m_ThicknessLockCtrl( nullptr ),
            m_ColorCtrl( nullptr ),
            m_EpsilonCtrl( nullptr ),
            m_LossTgCtrl( nullptr ),
            m_SpecFreqCtrl( nullptr ),
            m_SpecFreqUnitsCtrl( nullptr ),
            m_DielectricModelCtrl( nullptr )
    {}
};
 
 
class PANEL_SETUP_BOARD_STACKUP : public PANEL_SETUP_BOARD_STACKUP_BASE
{
public:
    PANEL_SETUP_BOARD_STACKUP( wxWindow* aParentWindow, PCB_EDIT_FRAME* aFrame,
                               PANEL_SETUP_LAYERS* aPanelLayers,
                               PANEL_SETUP_BOARD_FINISH* aPanelFinish );
    ~PANEL_SETUP_BOARD_STACKUP();
 
    void ImportSettingsFrom( BOARD* aBoard );

    void OnLayersOptionsChanged( const LSET& aNewLayerSet );

    int GetCopperLayerCount() const;

    BOARD_STACKUP_ITEM* GetStackupItem( int aRow );
    int GetSublayerId( int aRow );

    wxColor GetSelectedColor( int aRow ) const;
 
    // Called by wxWidgets: transfer current settings stored in m_stackup to the board
    bool TransferDataFromWindow() override;
 
private:
    void lazyBuildRowUI( BOARD_STACKUP_ROW_UI_ITEM& ui_row_item, int aPos );

    wxControl* addSpacer( int aPos );

    void buildLayerStackPanel( bool aCreateInitialStackup = false, bool aRelinkStackup = false );

    void synchronizeWithBoard( bool aFullSync );

    void showOnlyActiveLayers();

    void rebuildLayerStackPanel( bool aRelinkItems = false );

    bool transferDataFromUIToStackup();

    void updateCopperLayerCount();

    int computeBoardThickness();

    void setDefaultLayerWidths( int targetThickness );
 
    void onColorSelected( wxCommandEvent& event );
    void onMaterialChange( wxCommandEvent& event );
    void onThicknessChange( wxCommandEvent& event );
    void onExportToClipboard( wxCommandEvent& event ) override;
    void onAddDielectricLayer( wxCommandEvent& event ) override;
    void onRemoveDielectricLayer( wxCommandEvent& event ) override;
    void onRemoveDielUI( wxUpdateUIEvent& event ) override;
    void onCopperLayersSelCount( wxCommandEvent& event ) override;
    void onAdjustDielectricThickness( wxCommandEvent& event ) override;

    void updateIconColor( int aRow = -1 );

    wxColor getColorIconItem( int aRow );

    wxBitmapComboBox* createColorBox( BOARD_STACKUP_ITEM* aStackupItem, int aRow );
 
    void onUnitsChanged( wxCommandEvent& event );

    void disconnectEvents();

    static wxString m_specFreqChoices[4];

    static wxString m_dielecticModelChoices[2];

    enum class FREQ_UNITS : int
    {
        HZ = 0,
        KHZ,
        MHZ,
        GHZ
    };

    static std::pair<double, FREQ_UNITS> normaliseFrequency( double aFreq );
 
private:
    BOARD_STACKUP       m_stackup;
    PANEL_SETUP_LAYERS* m_panelLayers;      // The associated PANEL_SETUP_LAYERS, to know enabled
                                            //   layers and copper layer names
    LSET                m_enabledLayers;    // The current enabled layers in this panel restricted
                                            //   to allowed layers in stackup.  (When this doesn't
                                            //   match the enabled layers in PANEL_SETUP_LAYERS the
                                            //   stackup is not up to date.)
    PANEL_SETUP_BOARD_FINISH* m_panelFinish;
 
    DIELECTRIC_SUBSTRATE_LIST              m_delectricMatList;    // List of currently available
                                                                  //   dielectric materials
    DIELECTRIC_SUBSTRATE_LIST              m_solderMaskMatList;   // List of currently available
                                                                  //   solder mask materials
    DIELECTRIC_SUBSTRATE_LIST              m_silkscreenMatList;   // List of currently available
                                                                  //   solder mask materials
    std::vector<BOARD_STACKUP_ROW_UI_ITEM> m_rowUiItemsList;      // List of items in m_fgGridSizer
 
    BOARD*                  m_board;
    BOARD_DESIGN_SETTINGS*  m_brdSettings;
    PCB_EDIT_FRAME*         m_frame;
    EDA_UNITS               m_lastUnits;
    wxSize                  m_numericTextCtrlSize;  // Best size for wxTextCtrls with units
    wxSize                  m_numericFieldsSize;    // Best size for wxTextCtrls without units
    wxSize                  m_unitsFieldsSize;      // Best size for wxChoice units selection
    wxSize                  m_modelFieldSize;       // Best size for dielectric model selection
    wxArrayString           m_core_prepreg_choice;  // Used to display the option list in dialog
    wxSize                  m_colorSwatchesSize;    // Size of swatches in the wxBitmapComboBox.
    wxSize                  m_colorIconsSize;       // Size of swatches in the grid (left column)
 
    std::vector<wxControl*> m_controlItemsList;     // List of ctrls (wxChoice, wxTextCtrl, etc.)
                                                    //   with added event handlers
};
 
#endif      // #ifndef PANEL_SETUP_BOARD_STACKUP_H