/** * @file dialog_copper_zones.cpp */ /* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2017 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck * Copyright (C) 1992-2017 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 */ #include #include #include #include #include #include #include #include #include #include #include #include #include // needed for wx/listctrl.h, in wxGTK 2.8.12 #include #include /** * Class DIALOG_COPPER_ZONE * is the derived class from dialog_copper_zone_frame created by wxFormBuilder */ class DIALOG_COPPER_ZONE : public DIALOG_COPPER_ZONE_BASE { public: DIALOG_COPPER_ZONE( PCB_BASE_FRAME* aParent, ZONE_SETTINGS* aSettings ); private: PCB_BASE_FRAME* m_Parent; wxConfigBase* m_Config; ///< Current config ZONE_EDIT_T m_OnExitCode; ///< exit code: ZONE_ABORT if no change, ///< ZONE_OK if new values accepted ///< ZONE_EXPORT_VALUES if values are exported to others zones ZONE_SETTINGS m_settings; ZONE_SETTINGS* m_ptr; bool m_NetSortingByPadCount; ///< false = alphabetic sort. ///< true = pad count sort. long m_NetFiltering; std::vector m_LayerId; ///< Handle the real layer number from layer ///< name position in m_LayerSelectionCtrl static wxString m_netNameShowFilter; ///< the filter to show nets (default * "*"). ///< static to keep this pattern for an entire Pcbnew session /** * Function initDialog * fills in the dialog controls using the current settings. */ void initDialog(); void OnButtonOkClick( wxCommandEvent& event ) override; void OnButtonCancelClick( wxCommandEvent& event ) override; void OnClose( wxCloseEvent& event ) override; void OnCornerSmoothingModeChoice( wxCommandEvent& event ) override; /** * Function AcceptOptions * @param aPromptForErrors is true to prompt user on incorrect params. * @param aUseExportableSetupOnly is true to use exportable parameters only (used to export this setup to other zones). * @return bool - false if incorrect options, true if ok. */ bool AcceptOptions( bool aPromptForErrors, bool aUseExportableSetupOnly = false ); void OnNetSortingOptionSelected( wxCommandEvent& event ) override; void ExportSetupToOtherCopperZones( wxCommandEvent& event ) override; void OnPadsInZoneClick( wxCommandEvent& event ) override; void OnRunFiltersButtonClick( wxCommandEvent& event ) override; void buildAvailableListOfNets(); /** * Function initListNetsParams * initializes m_NetSortingByPadCount and m_NetFiltering values * according to m_NetDisplayOption selection. */ void initListNetsParams(); /** * Function makeLayerBitmap * creates the colored rectangle bitmaps used in the layer selection widget. * @param aColor is the color to fill the rectangle with. */ wxBitmap makeLayerBitmap( COLOR4D aColor ); }; #define LAYER_BITMAP_SIZE_X 20 #define LAYER_BITMAP_SIZE_Y 10 // Initialize static member variables wxString DIALOG_COPPER_ZONE::m_netNameShowFilter( wxT( "*" ) ); ZONE_EDIT_T InvokeCopperZonesEditor( PCB_BASE_FRAME* aCaller, ZONE_SETTINGS* aSettings ) { DIALOG_COPPER_ZONE dlg( aCaller, aSettings ); ZONE_EDIT_T result = ZONE_EDIT_T( dlg.ShowModal() ); return result; } DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE( PCB_BASE_FRAME* aParent, ZONE_SETTINGS* aSettings ) : DIALOG_COPPER_ZONE_BASE( aParent ) { m_Parent = aParent; m_Config = Kiface().KifaceSettings(); m_ptr = aSettings; m_settings = *aSettings; m_NetSortingByPadCount = true; // false = alphabetic sort, true = pad count sort m_OnExitCode = ZONE_ABORT; SetReturnCode( ZONE_ABORT ); // Will be changed on buttons click // Fix static text widget minimum width to a suitable value so that // resizing the dialog is not necessary when changing the corner smoothing type. // Depends on the default text in the widget. m_cornerSmoothingValue->SetMinSize( m_cornerSmoothingValue->GetSize() ); initDialog(); m_sdbSizerOK->SetDefault(); FinishDialogSettings(); } void DIALOG_COPPER_ZONE::initDialog() { BOARD* board = m_Parent->GetBoard(); wxString msg; if( m_settings.m_Zone_45_Only ) m_OrientEdgesOpt->SetSelection( 1 ); m_FillModeCtrl->SetSelection( m_settings.m_FillMode ? 1 : 0 ); AddUnitSymbol( *m_ClearanceValueTitle, g_UserUnit ); msg = StringFromValue( g_UserUnit, m_settings.m_ZoneClearance ); m_ZoneClearanceCtrl->SetValue( msg ); AddUnitSymbol( *m_MinThicknessValueTitle, g_UserUnit ); msg = StringFromValue( g_UserUnit, m_settings.m_ZoneMinThickness ); m_ZoneMinThicknessCtrl->SetValue( msg ); switch( m_settings.GetPadConnection() ) { case PAD_ZONE_CONN_THT_THERMAL: // Thermals only for THT pads m_PadInZoneOpt->SetSelection( 2 ); break; case PAD_ZONE_CONN_NONE: // Pads are not covered m_PadInZoneOpt->SetSelection( 3 ); break; default: case PAD_ZONE_CONN_THERMAL: // Use thermal relief for pads m_PadInZoneOpt->SetSelection( 1 ); break; case PAD_ZONE_CONN_FULL: // pads are covered by copper m_PadInZoneOpt->SetSelection( 0 ); break; } m_PriorityLevelCtrl->SetValue( m_settings.m_ZonePriority ); AddUnitSymbol( *m_AntipadSizeText, g_UserUnit ); AddUnitSymbol( *m_CopperBridgeWidthText, g_UserUnit ); PutValueInLocalUnits( *m_AntipadSizeValue, m_settings.m_ThermalReliefGap ); PutValueInLocalUnits( *m_CopperWidthValue, m_settings.m_ThermalReliefCopperBridge ); m_cornerSmoothingChoice->SetSelection( m_settings.GetCornerSmoothingType() ); PutValueInLocalUnits( *m_cornerSmoothingCtrl, m_settings.GetCornerRadius() ); switch( m_settings.m_Zone_HatchingStyle ) { case ZONE_CONTAINER::NO_HATCH: m_OutlineAppearanceCtrl->SetSelection( 0 ); break; case ZONE_CONTAINER::DIAGONAL_EDGE: m_OutlineAppearanceCtrl->SetSelection( 1 ); break; case ZONE_CONTAINER::DIAGONAL_FULL: m_OutlineAppearanceCtrl->SetSelection( 2 ); break; } m_ArcApproximationOpt->SetSelection( m_settings.m_ArcToSegmentsCount == ARC_APPROX_SEGMENTS_COUNT_HIGHT_DEF ? 1 : 0 ); // Create one column in m_LayerSelectionCtrl wxListItem column0; column0.SetId( 0 ); m_LayerSelectionCtrl->InsertColumn( 0, column0 ); wxImageList* imageList = new wxImageList( LAYER_BITMAP_SIZE_X, LAYER_BITMAP_SIZE_Y ); m_LayerSelectionCtrl->AssignImageList( imageList, wxIMAGE_LIST_SMALL ); int ctrlWidth = 0; // Min width for m_LayerSelectionCtrl to show the layers names int imgIdx = 0; LSET cu_set = LSET::AllCuMask( board->GetCopperLayerCount() ); for( LSEQ cu_stack = cu_set.UIOrder(); cu_stack; ++cu_stack, imgIdx++ ) { PCB_LAYER_ID layer = *cu_stack; m_LayerId.push_back( layer ); msg = board->GetLayerName( layer ); msg.Trim(); COLOR4D layerColor = m_Parent->Settings().Colors().GetLayerColor( layer ); imageList->Add( makeLayerBitmap( layerColor ) ); int itemIndex = m_LayerSelectionCtrl->InsertItem( m_LayerSelectionCtrl->GetItemCount(), msg, imgIdx ); if( m_settings.m_CurrentZone_Layer == layer ) m_LayerSelectionCtrl->Select( itemIndex ); wxSize tsize( GetTextSize( msg, m_LayerSelectionCtrl ) ); ctrlWidth = std::max( ctrlWidth, tsize.x ); } // The most easy way to ensure the right size is to use wxLIST_AUTOSIZE // unfortunately this option does not work well both on // wxWidgets 2.8 ( column width too small), and // wxWidgets 2.9 ( column width too large) ctrlWidth += LAYER_BITMAP_SIZE_X + 25; // Add bitmap width + margin between bitmap and text m_LayerSelectionCtrl->SetColumnWidth( 0, ctrlWidth ); ctrlWidth += 25; // add small margin between text and window borders // and room for vertical scroll bar m_LayerSelectionCtrl->SetMinSize( wxSize( ctrlWidth, -1 ) ); wxString netNameDoNotShowFilter = wxT( "Net-*" ); if( m_Config ) { int opt = m_Config->Read( ZONE_NET_SORT_OPTION_KEY, 1l ); m_NetDisplayOption->SetSelection( opt ); m_Config->Read( ZONE_NET_FILTER_STRING_KEY, netNameDoNotShowFilter ); } else m_NetDisplayOption->SetSelection( 1 ); m_ShowNetNameFilter->SetValue( m_netNameShowFilter ); initListNetsParams(); // Build list of nets: m_DoNotShowNetNameFilter->SetValue( netNameDoNotShowFilter ); buildAvailableListOfNets(); wxCommandEvent event; OnCornerSmoothingModeChoice( event ); } void DIALOG_COPPER_ZONE::OnButtonCancelClick( wxCommandEvent& event ) { Close( true ); } void DIALOG_COPPER_ZONE::OnButtonOkClick( wxCommandEvent& event ) { m_netNameShowFilter = m_ShowNetNameFilter->GetValue(); if( AcceptOptions( true ) ) { *m_ptr = m_settings; EndModal( ZONE_OK ); } } // called on system close button void DIALOG_COPPER_ZONE::OnClose( wxCloseEvent& event ) { if( m_OnExitCode != ZONE_ABORT ) *m_ptr = m_settings; EndModal( m_OnExitCode ); } bool DIALOG_COPPER_ZONE::AcceptOptions( bool aPromptForErrors, bool aUseExportableSetupOnly ) { switch( m_PadInZoneOpt->GetSelection() ) { case 3: // Pads are not covered m_settings.SetPadConnection( PAD_ZONE_CONN_NONE ); break; case 2: // Use thermal relief for THT pads m_settings.SetPadConnection( PAD_ZONE_CONN_THT_THERMAL ); break; case 1: // Use thermal relief for pads m_settings.SetPadConnection( PAD_ZONE_CONN_THERMAL ); break; case 0: // pads are covered by copper m_settings.SetPadConnection( PAD_ZONE_CONN_FULL ); break; } switch( m_OutlineAppearanceCtrl->GetSelection() ) { case 0: m_settings.m_Zone_HatchingStyle = ZONE_CONTAINER::NO_HATCH; break; case 1: m_settings.m_Zone_HatchingStyle = ZONE_CONTAINER::DIAGONAL_EDGE; break; case 2: m_settings.m_Zone_HatchingStyle = ZONE_CONTAINER::DIAGONAL_FULL; break; } m_settings.m_ArcToSegmentsCount = m_ArcApproximationOpt->GetSelection() == 1 ? ARC_APPROX_SEGMENTS_COUNT_HIGHT_DEF : ARC_APPROX_SEGMENTS_COUNT_LOW_DEF; if( m_Config ) { m_Config->Write( ZONE_NET_OUTLINES_HATCH_OPTION_KEY, (long) m_settings.m_Zone_HatchingStyle ); wxString filter = m_DoNotShowNetNameFilter->GetValue(); m_Config->Write( ZONE_NET_FILTER_STRING_KEY, filter ); } m_netNameShowFilter = m_ShowNetNameFilter->GetValue(); m_settings.m_FillMode = (m_FillModeCtrl->GetSelection() == 0) ? 0 : 1; wxString txtvalue = m_ZoneClearanceCtrl->GetValue(); m_settings.m_ZoneClearance = ValueFromString( g_UserUnit, txtvalue ); // Test if this is a reasonable value for this parameter // A too large value can hang Pcbnew #define CLEARANCE_MAX_VALUE ZONE_CLEARANCE_MAX_VALUE_MIL*IU_PER_MILS if( m_settings.m_ZoneClearance > CLEARANCE_MAX_VALUE ) { wxString msg; msg.Printf( _( "Clearance must be smaller than %f\" / %f mm." ), ZONE_CLEARANCE_MAX_VALUE_MIL / 1000.0, ZONE_CLEARANCE_MAX_VALUE_MIL * 0.0254 ); DisplayError( this, msg ); return false; } txtvalue = m_ZoneMinThicknessCtrl->GetValue(); m_settings.m_ZoneMinThickness = ValueFromString( g_UserUnit, txtvalue ); if( m_settings.m_ZoneMinThickness < (ZONE_THICKNESS_MIN_VALUE_MIL*IU_PER_MILS) ) { wxString msg; msg.Printf( _( "Minimum width must be larger than %f\" / %f mm." ), ZONE_THICKNESS_MIN_VALUE_MIL / 1000.0, ZONE_THICKNESS_MIN_VALUE_MIL * 0.0254 ); DisplayError( this, msg ); return false; } m_settings.SetCornerSmoothingType( m_cornerSmoothingChoice->GetSelection() ); txtvalue = m_cornerSmoothingCtrl->GetValue(); m_settings.SetCornerRadius( ValueFromString( g_UserUnit, txtvalue ) ); m_settings.m_ZonePriority = m_PriorityLevelCtrl->GetValue(); if( m_OrientEdgesOpt->GetSelection() == 0 ) m_settings.m_Zone_45_Only = false; else m_settings.m_Zone_45_Only = true; m_settings.m_ThermalReliefGap = ValueFromTextCtrl( *m_AntipadSizeValue ); m_settings.m_ThermalReliefCopperBridge = ValueFromTextCtrl( *m_CopperWidthValue ); if( m_Config ) { ConfigBaseWriteDouble( m_Config, ZONE_CLEARANCE_WIDTH_STRING_KEY, (double) m_settings.m_ZoneClearance / IU_PER_MILS ); ConfigBaseWriteDouble( m_Config, ZONE_MIN_THICKNESS_WIDTH_STRING_KEY, (double) m_settings.m_ZoneMinThickness / IU_PER_MILS ); ConfigBaseWriteDouble( m_Config, ZONE_THERMAL_RELIEF_GAP_STRING_KEY, (double) m_settings.m_ThermalReliefGap / IU_PER_MILS ); ConfigBaseWriteDouble( m_Config, ZONE_THERMAL_RELIEF_COPPER_WIDTH_STRING_KEY, (double) m_settings.m_ThermalReliefCopperBridge / IU_PER_MILS ); } if( ( m_settings.GetPadConnection() == PAD_ZONE_CONN_THT_THERMAL || m_settings.GetPadConnection() == PAD_ZONE_CONN_THERMAL ) && m_settings.m_ThermalReliefCopperBridge <= m_settings.m_ZoneMinThickness ) { DisplayError( this, _( "Thermal relief spoke must be greater than the minimum width." ) ); return false; } // If we use only exportable to others zones parameters, exit here: if( aUseExportableSetupOnly ) return true; // Get the layer selection for this zone int ii = m_LayerSelectionCtrl->GetFirstSelected(); if( ii < 0 && aPromptForErrors ) { DisplayError( this, _( "No layer selected." ) ); return false; } m_settings.m_CurrentZone_Layer = ToLAYER_ID( m_LayerId[ii] ); // Get the net name selection for this zone ii = m_ListNetNameSelection->GetSelection(); if( ii < 0 && aPromptForErrors ) { DisplayError( this, _( "No net selected." ) ); return false; } if( ii == 0 ) // the not connected option was selected: this is not a good practice: warn: { if( !IsOK( this, _( "You have chosen the \"not connected\" option. This will create " "insulated copper islands. Are you sure ?" ) ) ) return false; } wxString net_name = m_ListNetNameSelection->GetString( ii ); m_settings.m_NetcodeSelection = 0; // Search net_code for this net, if a net was selected if( m_ListNetNameSelection->GetSelection() > 0 ) { NETINFO_ITEM* net = m_Parent->GetBoard()->FindNet( net_name ); if( net ) m_settings.m_NetcodeSelection = net->GetNet(); } return true; } void DIALOG_COPPER_ZONE::OnCornerSmoothingModeChoice( wxCommandEvent& event ) { int selection = m_cornerSmoothingChoice->GetSelection(); switch( selection ) { case ZONE_SETTINGS::SMOOTHING_NONE: m_cornerSmoothingValue->Enable( false ); m_cornerSmoothingCtrl->Enable( false ); break; case ZONE_SETTINGS::SMOOTHING_CHAMFER: m_cornerSmoothingValue->Enable( true ); m_cornerSmoothingCtrl->Enable( true ); m_cornerSmoothingValue->SetLabel( _( "Chamfer distance" ) ); AddUnitSymbol( *m_cornerSmoothingValue, g_UserUnit ); break; case ZONE_SETTINGS::SMOOTHING_FILLET: m_cornerSmoothingValue->Enable( true ); m_cornerSmoothingCtrl->Enable( true ); m_cornerSmoothingValue->SetLabel( _( "Fillet radius" ) ); AddUnitSymbol( *m_cornerSmoothingValue, g_UserUnit ); break; } } void DIALOG_COPPER_ZONE::OnNetSortingOptionSelected( wxCommandEvent& event ) { initListNetsParams(); buildAvailableListOfNets(); m_netNameShowFilter = m_ShowNetNameFilter->GetValue(); if( m_Config ) { m_Config->Write( ZONE_NET_SORT_OPTION_KEY, (long) m_NetDisplayOption->GetSelection() ); wxString Filter = m_DoNotShowNetNameFilter->GetValue(); m_Config->Write( ZONE_NET_FILTER_STRING_KEY, Filter ); } } void DIALOG_COPPER_ZONE::ExportSetupToOtherCopperZones( wxCommandEvent& event ) { if( !AcceptOptions( true, true ) ) return; // Export settings ( but layer and netcode ) to others copper zones BOARD* pcb = m_Parent->GetBoard(); for( int ii = 0; ii < pcb->GetAreaCount(); ii++ ) { ZONE_CONTAINER* zone = pcb->GetArea( ii ); // Cannot export settings from a copper zone // to a zone keepout: if( zone->GetIsKeepout() ) continue; m_settings.ExportSetting( *zone, false ); // false = partial export m_Parent->OnModify(); } m_OnExitCode = ZONE_EXPORT_VALUES; // values are exported to others zones } void DIALOG_COPPER_ZONE::OnPadsInZoneClick( wxCommandEvent& event ) { // Antipad and spokes are significant only for thermals // However, even if thermals are disabled, these parameters must be set // for pads which have local settings with thermal enabled // Previously, wxTextCtrl widgets related to thermal settings were disabled, // but this is not a good idea. We leave them always enabled. } void DIALOG_COPPER_ZONE::initListNetsParams() { switch( m_NetDisplayOption->GetSelection() ) { case 0: m_NetSortingByPadCount = false; m_NetFiltering = false; break; case 1: m_NetSortingByPadCount = true; m_NetFiltering = false; break; case 2: m_NetSortingByPadCount = false; m_NetFiltering = true; break; case 3: m_NetSortingByPadCount = true; m_NetFiltering = true; break; } } void DIALOG_COPPER_ZONE::OnRunFiltersButtonClick( wxCommandEvent& event ) { m_netNameShowFilter = m_ShowNetNameFilter->GetValue(); // Ensure filtered option for nets if( m_NetDisplayOption->GetSelection() == 0 ) m_NetDisplayOption->SetSelection( 2 ); else if( m_NetDisplayOption->GetSelection() == 1 ) m_NetDisplayOption->SetSelection( 3 ); initListNetsParams(); buildAvailableListOfNets(); } void DIALOG_COPPER_ZONE::buildAvailableListOfNets() { wxArrayString listNetName; m_Parent->GetBoard()->SortedNetnamesList( listNetName, m_NetSortingByPadCount ); if( m_NetFiltering ) { wxString doNotShowFilter = m_DoNotShowNetNameFilter->GetValue(); wxString ShowFilter = m_ShowNetNameFilter->GetValue(); for( unsigned ii = 0; ii < listNetName.GetCount(); ii++ ) { if( listNetName[ii].Matches( doNotShowFilter ) ) { listNetName.RemoveAt( ii ); ii--; } else if( !listNetName[ii].Matches( ShowFilter ) ) { listNetName.RemoveAt( ii ); ii--; } } } listNetName.Insert( wxT( "" ), 0 ); // Ensure currently selected net for the zone is visible, regardless of filters int selectedNetListNdx = -1; int net_select = m_settings.m_NetcodeSelection; if( net_select > 0 ) { NETINFO_ITEM* equipot = m_Parent->GetBoard()->FindNet( net_select ); if( equipot ) { selectedNetListNdx = listNetName.Index( equipot->GetNetname() ); if( wxNOT_FOUND == selectedNetListNdx ) { // the currently selected net must *always* be visible. listNetName.Insert( equipot->GetNetname(), 0 ); selectedNetListNdx = 0; } } } else if( net_select == 0 ) selectedNetListNdx = 0; // SetSelection() on "" else { // selectedNetListNdx remains -1, no net selected. } m_ListNetNameSelection->Clear(); m_ListNetNameSelection->InsertItems( listNetName, 0 ); m_ListNetNameSelection->SetSelection( 0 ); if( selectedNetListNdx >= 0 ) { m_ListNetNameSelection->SetSelection( selectedNetListNdx ); m_ListNetNameSelection->EnsureVisible( selectedNetListNdx ); } } wxBitmap DIALOG_COPPER_ZONE::makeLayerBitmap( COLOR4D aColor ) { wxBitmap bitmap( LAYER_BITMAP_SIZE_X, LAYER_BITMAP_SIZE_Y ); wxBrush brush; wxMemoryDC iconDC; iconDC.SelectObject( bitmap ); brush.SetColour( aColor.ToColour() ); brush.SetStyle( wxBRUSHSTYLE_SOLID ); iconDC.SetBrush( brush ); iconDC.DrawRectangle( 0, 0, LAYER_BITMAP_SIZE_X, LAYER_BITMAP_SIZE_Y ); return bitmap; }