471 lines
16 KiB
C++
471 lines
16 KiB
C++
/*
|
|
* 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 <dick@softplc.com>
|
|
* Copyright (C) 1992-2018 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 <fctsys.h>
|
|
#include <kiface_i.h>
|
|
#include <confirm.h>
|
|
#include <pcb_edit_frame.h>
|
|
#include <zones.h>
|
|
#include <bitmaps.h>
|
|
#include <widgets/unit_binder.h>
|
|
#include <class_zone.h>
|
|
#include <class_board.h>
|
|
|
|
#include <dialog_copper_zones_base.h>
|
|
|
|
|
|
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
|
|
|
|
bool m_settingsExported; // settings were written to all other zones
|
|
|
|
ZONE_SETTINGS m_settings;
|
|
ZONE_SETTINGS* m_ptr;
|
|
|
|
bool m_NetSortingByPadCount;
|
|
long m_NetFiltering;
|
|
static wxString m_netNameShowFilter; // the filter to show nets (default * "*").
|
|
// static to keep this pattern for an entire Pcbnew session
|
|
int m_cornerSmoothingType;
|
|
|
|
UNIT_BINDER m_cornerRadius;
|
|
UNIT_BINDER m_clearance;
|
|
UNIT_BINDER m_minWidth;
|
|
UNIT_BINDER m_antipadClearance ;
|
|
UNIT_BINDER m_spokeWidth;
|
|
|
|
bool TransferDataToWindow() override;
|
|
bool TransferDataFromWindow() override;
|
|
|
|
/**
|
|
* Function AcceptOptions
|
|
* @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 aUseExportableSetupOnly = false );
|
|
|
|
void OnLayerSelection( wxDataViewEvent& event ) override;
|
|
void OnNetSortingOptionSelected( wxCommandEvent& event ) override;
|
|
void ExportSetupToOtherCopperZones( wxCommandEvent& event ) override;
|
|
void OnRunFiltersButtonClick( wxCommandEvent& event ) override;
|
|
void OnUpdateUI( wxUpdateUIEvent& ) override;
|
|
void OnButtonCancelClick( wxCommandEvent& event ) override;
|
|
void OnClose( wxCloseEvent& event ) override;
|
|
|
|
void buildAvailableListOfNets();
|
|
};
|
|
|
|
|
|
// Initialize static member variables
|
|
wxString DIALOG_COPPER_ZONE::m_netNameShowFilter( wxT( "*" ) );
|
|
|
|
|
|
int InvokeCopperZonesEditor( PCB_BASE_FRAME* aCaller, ZONE_SETTINGS* aSettings )
|
|
{
|
|
DIALOG_COPPER_ZONE dlg( aCaller, aSettings );
|
|
|
|
return dlg.ShowModal();
|
|
}
|
|
|
|
|
|
DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE( PCB_BASE_FRAME* aParent, ZONE_SETTINGS* aSettings ) :
|
|
DIALOG_COPPER_ZONE_BASE( aParent ),
|
|
m_cornerSmoothingType( ZONE_SETTINGS::SMOOTHING_UNDEFINED ),
|
|
m_cornerRadius( aParent, m_cornerRadiusLabel, m_cornerRadiusCtrl, m_cornerRadiusUnits, true ),
|
|
m_clearance( aParent, m_clearanceLabel, m_clearanceCtrl, m_clearanceUnits, true ),
|
|
m_minWidth( aParent, m_minWidthLabel, m_minWidthCtrl, m_minWidthUnits, true ),
|
|
m_antipadClearance( aParent, m_antipadLabel, m_antipadCtrl, m_antipadUnits, true ),
|
|
m_spokeWidth( aParent, m_spokeWidthLabel, m_spokeWidthCtrl, m_spokeWidthUnits, true )
|
|
{
|
|
m_Parent = aParent;
|
|
m_Config = Kiface().KifaceSettings();
|
|
m_bitmapNoNetWarning->SetBitmap( KiBitmap( dialog_warning_xpm ) );
|
|
|
|
m_ptr = aSettings;
|
|
m_settings = *aSettings;
|
|
m_settings.SetupLayersList( m_layers, m_Parent, true );
|
|
|
|
m_settingsExported = false;
|
|
|
|
m_NetFiltering = false;
|
|
m_NetSortingByPadCount = true; // false = alphabetic sort, true = pad count sort
|
|
|
|
m_sdbSizerOK->SetDefault();
|
|
|
|
FinishDialogSettings();
|
|
}
|
|
|
|
|
|
bool DIALOG_COPPER_ZONE::TransferDataToWindow()
|
|
{
|
|
m_constrainOutline->SetValue( m_settings.m_Zone_45_Only );
|
|
m_cornerSmoothingChoice->SetSelection( m_settings.GetCornerSmoothingType() );
|
|
m_cornerRadius.SetValue( m_settings.GetCornerRadius() );
|
|
m_PriorityLevelCtrl->SetValue( m_settings.m_ZonePriority );
|
|
|
|
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_clearance.SetValue( m_settings.m_ZoneClearance );
|
|
m_minWidth.SetValue( m_settings.m_ZoneMinThickness );
|
|
|
|
switch( m_settings.GetPadConnection() )
|
|
{
|
|
default:
|
|
case PAD_ZONE_CONN_THERMAL: m_PadInZoneOpt->SetSelection( 1 ); break;
|
|
case PAD_ZONE_CONN_THT_THERMAL: m_PadInZoneOpt->SetSelection( 2 ); break;
|
|
case PAD_ZONE_CONN_NONE: m_PadInZoneOpt->SetSelection( 3 ); break;
|
|
case PAD_ZONE_CONN_FULL: m_PadInZoneOpt->SetSelection( 0 ); break;
|
|
}
|
|
|
|
// Do not enable/disable antipad clearance and spoke width. They might be needed if
|
|
// a module or pad overrides the zone to specify a thermal connection.
|
|
m_antipadClearance.SetValue( m_settings.m_ThermalReliefGap );
|
|
m_spokeWidth.SetValue( m_settings.m_ThermalReliefCopperBridge );
|
|
|
|
wxString netNameDoNotShowFilter = wxT( "Net-*" );
|
|
m_NetFiltering = false;
|
|
m_NetSortingByPadCount = true;
|
|
|
|
if( m_Config )
|
|
{
|
|
int opt = m_Config->Read( ZONE_NET_SORT_OPTION_KEY, 1l );
|
|
m_NetFiltering = opt >= 2;
|
|
m_NetSortingByPadCount = opt % 2;
|
|
m_Config->Read( ZONE_NET_FILTER_STRING_KEY, netNameDoNotShowFilter );
|
|
}
|
|
|
|
m_ShowNetNameFilter->SetValue( m_netNameShowFilter );
|
|
m_DoNotShowNetNameFilter->SetValue( netNameDoNotShowFilter );
|
|
m_showAllNetsOpt->SetValue( !m_NetFiltering );
|
|
m_sortByPadsOpt->SetValue( m_NetSortingByPadCount );
|
|
|
|
// Build list of nets:
|
|
buildAvailableListOfNets();
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void DIALOG_COPPER_ZONE::OnUpdateUI( wxUpdateUIEvent& )
|
|
{
|
|
if( m_ListNetNameSelection->GetSelection() < 0 )
|
|
m_ListNetNameSelection->SetSelection( 0 );
|
|
|
|
m_bNoNetWarning->Show( m_ListNetNameSelection->GetSelection() == 0 );
|
|
|
|
if( m_cornerSmoothingType != m_cornerSmoothingChoice->GetSelection() )
|
|
{
|
|
m_cornerSmoothingType = m_cornerSmoothingChoice->GetSelection();
|
|
|
|
if( m_cornerSmoothingChoice->GetSelection() == ZONE_SETTINGS::SMOOTHING_CHAMFER )
|
|
m_cornerRadiusLabel->SetLabel( _( "Chamfer distance:" ) );
|
|
else
|
|
m_cornerRadiusLabel->SetLabel( _( "Fillet radius:" ) );
|
|
}
|
|
}
|
|
|
|
|
|
void DIALOG_COPPER_ZONE::OnButtonCancelClick( wxCommandEvent& event )
|
|
{
|
|
// After an "Export Settings to Other Zones" cancel and close must return
|
|
// ZONE_EXPORT_VALUES instead of wxID_CANCEL.
|
|
Close( true );
|
|
}
|
|
|
|
|
|
bool DIALOG_COPPER_ZONE::TransferDataFromWindow()
|
|
{
|
|
m_netNameShowFilter = m_ShowNetNameFilter->GetValue();
|
|
|
|
if( !AcceptOptions() )
|
|
return false;
|
|
|
|
*m_ptr = m_settings;
|
|
return true;
|
|
}
|
|
|
|
void DIALOG_COPPER_ZONE::OnClose( wxCloseEvent& event )
|
|
{
|
|
EndModal( m_settingsExported ? ZONE_EXPORT_VALUES : wxID_CANCEL );
|
|
}
|
|
|
|
|
|
bool DIALOG_COPPER_ZONE::AcceptOptions( bool aUseExportableSetupOnly )
|
|
{
|
|
if( !m_clearance.Validate( 0, Mils2iu( ZONE_CLEARANCE_MAX_VALUE_MIL ) ) )
|
|
return false;
|
|
if( !m_minWidth.Validate( Mils2iu( ZONE_THICKNESS_MIN_VALUE_MIL ), INT_MAX ) )
|
|
return false;
|
|
if( !m_cornerRadius.Validate( 0, INT_MAX ) )
|
|
return false;
|
|
if( !m_spokeWidth.Validate( 0, INT_MAX ) )
|
|
return false;
|
|
|
|
if( m_settings.m_FillMode == ZFM_SEGMENTS )
|
|
{
|
|
KIDIALOG dlg( this, _( "The legacy segment fill mode is not recommended."
|
|
"Convert zone to polygon fill? "), _( "Legacy Warning" ),
|
|
wxYES_NO | wxICON_WARNING );
|
|
dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
|
|
|
|
if( dlg.ShowModal() == wxYES )
|
|
m_settings.m_FillMode = ZFM_POLYGONS;
|
|
}
|
|
|
|
switch( m_PadInZoneOpt->GetSelection() )
|
|
{
|
|
case 3: m_settings.SetPadConnection( PAD_ZONE_CONN_NONE ); break;
|
|
case 2: m_settings.SetPadConnection( PAD_ZONE_CONN_THT_THERMAL ); break;
|
|
case 1: m_settings.SetPadConnection( PAD_ZONE_CONN_THERMAL ); break;
|
|
case 0: 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;
|
|
}
|
|
|
|
if( m_Config )
|
|
{
|
|
m_Config->Write( ZONE_NET_OUTLINES_STYLE_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_ZoneClearance = m_clearance.GetValue();
|
|
|
|
m_settings.m_ZoneMinThickness = m_minWidth.GetValue();
|
|
|
|
m_settings.SetCornerSmoothingType( m_cornerSmoothingChoice->GetSelection() );
|
|
m_settings.SetCornerRadius( m_cornerRadius.GetValue() );
|
|
|
|
m_settings.m_ZonePriority = m_PriorityLevelCtrl->GetValue();
|
|
|
|
m_settings.m_Zone_45_Only = m_constrainOutline->GetValue();
|
|
|
|
m_settings.m_ThermalReliefGap = m_antipadClearance.GetValue();
|
|
m_settings.m_ThermalReliefCopperBridge = m_spokeWidth.GetValue();
|
|
|
|
if( m_settings.m_ThermalReliefCopperBridge <= m_settings.m_ZoneMinThickness )
|
|
{
|
|
DisplayError( this,
|
|
_( "Thermal relief spoke must be greater than the minimum width." ) );
|
|
return false;
|
|
}
|
|
|
|
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 we use only exportable to others zones parameters, exit here:
|
|
if( aUseExportableSetupOnly )
|
|
return true;
|
|
|
|
// Get the layer selection for this zone
|
|
int layer = -1;
|
|
for( int ii = 0; ii < m_layers->GetItemCount(); ++ii )
|
|
{
|
|
if( m_layers->GetToggleValue( (unsigned) ii, 0 ) )
|
|
{
|
|
layer = ii;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if( layer < 0 )
|
|
{
|
|
DisplayError( this, _( "No layer selected." ) );
|
|
return false;
|
|
}
|
|
|
|
NETINFO_ITEM* net = nullptr;
|
|
|
|
// Search net_code for this net, if a net was selected
|
|
if( m_ListNetNameSelection->GetSelection() > 0 )
|
|
net = m_Parent->GetBoard()->FindNet( m_ListNetNameSelection->GetStringSelection() );
|
|
|
|
m_settings.m_NetcodeSelection = net ? net->GetNet() : 0;
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void DIALOG_COPPER_ZONE::OnLayerSelection( wxDataViewEvent& event )
|
|
{
|
|
if( event.GetColumn() != 0 )
|
|
return;
|
|
|
|
int row = m_layers->ItemToRow( event.GetItem() );
|
|
|
|
if( m_layers->GetToggleValue( row, 0 ) )
|
|
{
|
|
wxVariant layerID;
|
|
m_layers->GetValue( layerID, row, 2 );
|
|
m_settings.m_CurrentZone_Layer = ToLAYER_ID( layerID.GetInteger() );
|
|
|
|
// Turn all other checkboxes off.
|
|
for( int ii = 0; ii < m_layers->GetItemCount(); ++ii )
|
|
{
|
|
if( ii != row )
|
|
m_layers->SetToggleValue( false, ii, 0 );
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void DIALOG_COPPER_ZONE::OnNetSortingOptionSelected( wxCommandEvent& event )
|
|
{
|
|
m_NetFiltering = !m_showAllNetsOpt->GetValue();
|
|
m_NetSortingByPadCount = m_sortByPadsOpt->GetValue();
|
|
m_netNameShowFilter = m_ShowNetNameFilter->GetValue();
|
|
|
|
buildAvailableListOfNets();
|
|
|
|
if( m_Config )
|
|
{
|
|
long configValue = m_NetFiltering ? 2 : 0;
|
|
|
|
if( m_NetSortingByPadCount )
|
|
configValue += 1;
|
|
|
|
m_Config->Write( ZONE_NET_SORT_OPTION_KEY, configValue );
|
|
wxString Filter = m_DoNotShowNetNameFilter->GetValue();
|
|
m_Config->Write( ZONE_NET_FILTER_STRING_KEY, Filter );
|
|
}
|
|
}
|
|
|
|
|
|
void DIALOG_COPPER_ZONE::ExportSetupToOtherCopperZones( wxCommandEvent& event )
|
|
{
|
|
if( !AcceptOptions( 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_settingsExported = true;
|
|
m_Parent->OnModify();
|
|
}
|
|
}
|
|
|
|
|
|
void DIALOG_COPPER_ZONE::OnRunFiltersButtonClick( wxCommandEvent& event )
|
|
{
|
|
m_NetFiltering = true;
|
|
m_showAllNetsOpt->SetValue( false );
|
|
|
|
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( "<no net>" ), 0 );
|
|
|
|
// Ensure currently selected net for the zone is visible, regardless of filters
|
|
int selectedNetListNdx = 0;
|
|
int net_select = m_settings.m_NetcodeSelection;
|
|
|
|
if( net_select > 0 )
|
|
{
|
|
NETINFO_ITEM* selectedNet = m_Parent->GetBoard()->FindNet( net_select );
|
|
if( selectedNet )
|
|
{
|
|
selectedNetListNdx = listNetName.Index( selectedNet->GetNetname() );
|
|
|
|
if( wxNOT_FOUND == selectedNetListNdx )
|
|
{
|
|
// the currently selected net must *always* be visible.
|
|
// <no net> is the zero'th index, so pick next lowest
|
|
listNetName.Insert( selectedNet->GetNetname(), 1 );
|
|
selectedNetListNdx = 1;
|
|
}
|
|
}
|
|
}
|
|
|
|
m_ListNetNameSelection->Clear();
|
|
m_ListNetNameSelection->InsertItems( listNetName, 0 );
|
|
m_ListNetNameSelection->SetSelection( selectedNetListNdx );
|
|
m_ListNetNameSelection->EnsureVisible( selectedNetListNdx );
|
|
}
|
|
|