517 lines
15 KiB
C++
517 lines
15 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
/**
|
|
* @file footprint_editor_utils.cpp
|
|
*/
|
|
|
|
#include <fctsys.h>
|
|
#include <kiface_i.h>
|
|
#include <kiway.h>
|
|
#include <kiway_express.h>
|
|
#include <pcb_draw_panel_gal.h>
|
|
#include <confirm.h>
|
|
#include <gestfich.h>
|
|
#include <pgm_base.h>
|
|
#include <trigo.h>
|
|
#include <3d_viewer/eda_3d_viewer.h>
|
|
#include <macros.h>
|
|
#include <invoke_pcb_dialog.h>
|
|
#include <pcb_layer_widget.h>
|
|
#include <board_commit.h>
|
|
#include <view/view.h>
|
|
#include <class_board.h>
|
|
#include <class_module.h>
|
|
#include <class_edge_mod.h>
|
|
|
|
#include <ratsnest_data.h>
|
|
#include <pcbnew.h>
|
|
#include <pcbnew_id.h>
|
|
#include <footprint_edit_frame.h>
|
|
#include <footprint_viewer_frame.h>
|
|
#include <footprint_tree_pane.h>
|
|
#include <fp_lib_table.h>
|
|
#include <widgets/lib_tree.h>
|
|
#include <collectors.h>
|
|
#include <tool/tool_manager.h>
|
|
#include <tools/pcb_actions.h>
|
|
|
|
#include <dialog_edit_footprint_for_fp_editor.h>
|
|
#include <dialog_move_exact.h>
|
|
#include <dialog_create_array.h>
|
|
#include <wildcards_and_files_ext.h>
|
|
#include <menus_helpers.h>
|
|
#include <footprint_wizard_frame.h>
|
|
#include <config_params.h>
|
|
|
|
#include <functional>
|
|
using namespace std::placeholders;
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::LoadModuleFromBoard( wxCommandEvent& event )
|
|
{
|
|
Load_Module_From_BOARD( NULL );
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary( LIB_ID aFPID)
|
|
{
|
|
bool is_last_fp_from_brd = IsCurrentFPFromBoard();
|
|
|
|
MODULE* module = LoadFootprint( aFPID );
|
|
|
|
if( !module )
|
|
return;
|
|
|
|
if( !Clear_Pcb( true ) )
|
|
return;
|
|
|
|
GetCanvas()->GetViewControls()->SetCrossHairCursorPosition( VECTOR2D( 0, 0 ), false );
|
|
AddModuleToBoard( module );
|
|
|
|
auto fp = GetBoard()->GetFirstModule();
|
|
|
|
if( fp )
|
|
{
|
|
fp->ClearFlags();
|
|
|
|
// if either m_Reference or m_Value are gone, reinstall them -
|
|
// otherwise you cannot see what you are doing on board
|
|
TEXTE_MODULE* ref = &fp->Reference();
|
|
TEXTE_MODULE* val = &fp->Value();
|
|
|
|
if( val && ref )
|
|
{
|
|
ref->SetType( TEXTE_MODULE::TEXT_is_REFERENCE ); // just in case ...
|
|
|
|
if( ref->GetLength() == 0 )
|
|
ref->SetText( wxT( "Ref**" ) );
|
|
|
|
val->SetType( TEXTE_MODULE::TEXT_is_VALUE ); // just in case ...
|
|
|
|
if( val->GetLength() == 0 )
|
|
val->SetText( wxT( "Val**" ) );
|
|
}
|
|
}
|
|
|
|
Zoom_Automatique( false );
|
|
|
|
Update3DView( true );
|
|
|
|
GetScreen()->ClrModify();
|
|
|
|
updateView();
|
|
GetCanvas()->Refresh();
|
|
|
|
// Update the save items if needed.
|
|
if( is_last_fp_from_brd )
|
|
{
|
|
ReCreateMenuBar();
|
|
ReCreateHToolbar();
|
|
}
|
|
|
|
m_treePane->GetLibTree()->ExpandLibId( aFPID );
|
|
m_treePane->GetLibTree()->CenterLibId( aFPID );
|
|
m_treePane->GetLibTree()->Refresh(); // update highlighting
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::Process_Special_Functions( wxCommandEvent& event )
|
|
{
|
|
int id = event.GetId();
|
|
wxPoint pos;
|
|
|
|
wxGetMousePosition( &pos.x, &pos.y );
|
|
pos.y += 20;
|
|
|
|
switch( id )
|
|
{
|
|
case ID_MODEDIT_NEW_MODULE:
|
|
{
|
|
LIB_ID selected = m_treePane->GetLibTree()->GetSelectedLibId();
|
|
MODULE* module = CreateNewModule( wxEmptyString );
|
|
|
|
if( !module )
|
|
break;
|
|
|
|
if( !Clear_Pcb( true ) )
|
|
break;
|
|
|
|
GetCanvas()->GetViewControls()->SetCrossHairCursorPosition( VECTOR2D( 0, 0 ), false );
|
|
AddModuleToBoard( module );
|
|
|
|
// Initialize data relative to nets and netclasses (for a new
|
|
// module the defaults are used)
|
|
// This is mandatory to handle and draw pads
|
|
GetBoard()->BuildListOfNets();
|
|
module->SetPosition( wxPoint( 0, 0 ) );
|
|
|
|
if( GetBoard()->GetFirstModule() )
|
|
GetBoard()->GetFirstModule()->ClearFlags();
|
|
|
|
Zoom_Automatique( false );
|
|
GetScreen()->SetModify();
|
|
|
|
// If selected from the library tree then go ahead and save it there
|
|
if( !selected.GetLibNickname().empty() )
|
|
{
|
|
LIB_ID fpid = module->GetFPID();
|
|
fpid.SetLibNickname( selected.GetLibNickname() );
|
|
module->SetFPID( fpid );
|
|
SaveFootprint( module );
|
|
GetScreen()->ClrModify();
|
|
}
|
|
|
|
updateView();
|
|
GetCanvas()->Refresh();
|
|
Update3DView( true );
|
|
|
|
SyncLibraryTree( false );
|
|
}
|
|
break;
|
|
|
|
case ID_MODEDIT_NEW_MODULE_FROM_WIZARD:
|
|
{
|
|
LIB_ID selected = m_treePane->GetLibTree()->GetSelectedLibId();
|
|
|
|
if( GetScreen()->IsModify() && !GetBoard()->IsEmpty() )
|
|
{
|
|
if( !HandleUnsavedChanges( this, _( "The current footprint has been modified. "
|
|
"Save changes?" ),
|
|
[&]() -> bool {
|
|
return SaveFootprint( GetBoard()->GetFirstModule() );
|
|
} ) )
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
|
|
auto wizard = (FOOTPRINT_WIZARD_FRAME*) Kiway().Player( FRAME_FOOTPRINT_WIZARD, true,
|
|
this );
|
|
|
|
if( wizard->ShowModal( NULL, this ) )
|
|
{
|
|
// Creates the new footprint from python script wizard
|
|
MODULE* module = wizard->GetBuiltFootprint();
|
|
|
|
if( module == NULL ) // i.e. if create module command aborted
|
|
break;
|
|
|
|
Clear_Pcb( false );
|
|
|
|
GetCanvas()->GetViewControls()->SetCrossHairCursorPosition( VECTOR2D( 0, 0 ), false );
|
|
// Add the new object to board
|
|
AddModuleToBoard( module );
|
|
|
|
// Initialize data relative to nets and netclasses (for a new
|
|
// module the defaults are used)
|
|
// This is mandatory to handle and draw pads
|
|
GetBoard()->BuildListOfNets();
|
|
module->SetPosition( wxPoint( 0, 0 ) );
|
|
module->ClearFlags();
|
|
|
|
Zoom_Automatique( false );
|
|
GetScreen()->SetModify();
|
|
|
|
// If selected from the library tree then go ahead and save it there
|
|
if( !selected.GetLibNickname().empty() )
|
|
{
|
|
LIB_ID fpid = module->GetFPID();
|
|
fpid.SetLibNickname( selected.GetLibNickname() );
|
|
module->SetFPID( fpid );
|
|
SaveFootprint( module );
|
|
GetScreen()->ClrModify();
|
|
}
|
|
|
|
updateView();
|
|
GetCanvas()->Refresh();
|
|
Update3DView( true );
|
|
|
|
SyncLibraryTree( false );
|
|
}
|
|
|
|
wizard->Destroy();
|
|
}
|
|
break;
|
|
|
|
case ID_MODEDIT_SAVE:
|
|
if( !GetBoard()->GetFirstModule() ) // no loaded footprint
|
|
break;
|
|
|
|
if( GetTargetFPID() == GetLoadedFPID() )
|
|
{
|
|
if( SaveFootprint( GetBoard()->GetFirstModule() ) )
|
|
{
|
|
m_toolManager->GetView()->Update( GetBoard()->GetFirstModule() );
|
|
|
|
GetCanvas()->ForceRefresh();
|
|
GetScreen()->ClrModify();
|
|
}
|
|
}
|
|
|
|
m_treePane->GetLibTree()->Refresh();
|
|
break;
|
|
|
|
case ID_MODEDIT_SAVE_AS:
|
|
if( GetTargetFPID().GetLibItemName().empty() )
|
|
{
|
|
// Save Library As
|
|
const wxString& src_libNickname = GetTargetFPID().GetLibNickname();
|
|
wxString src_libFullName = Prj().PcbFootprintLibs()->GetFullURI( src_libNickname );
|
|
|
|
if( SaveLibraryAs( src_libFullName ) )
|
|
SyncLibraryTree( true );
|
|
}
|
|
else if( GetTargetFPID() == GetLoadedFPID() )
|
|
{
|
|
// Save Board Footprint As
|
|
MODULE* footprint = GetBoard()->GetFirstModule();
|
|
|
|
if( footprint && SaveFootprintAs( footprint ) )
|
|
{
|
|
m_footprintNameWhenLoaded = footprint->GetFPID().GetLibItemName();
|
|
m_toolManager->GetView()->Update( footprint );
|
|
GetScreen()->ClrModify();
|
|
|
|
GetCanvas()->ForceRefresh();
|
|
SyncLibraryTree( true );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Save Selected Footprint As
|
|
MODULE* footprint = LoadFootprint( GetTargetFPID() );
|
|
|
|
if( footprint && SaveFootprintAs( footprint ) )
|
|
SyncLibraryTree( true );
|
|
}
|
|
|
|
m_treePane->GetLibTree()->Refresh();
|
|
break;
|
|
|
|
case ID_ADD_FOOTPRINT_TO_BOARD:
|
|
SaveFootprintToBoard( true );
|
|
break;
|
|
|
|
case ID_MODEDIT_CHECK:
|
|
// Currently: not implemented
|
|
break;
|
|
|
|
default:
|
|
wxLogDebug( wxT( "FOOTPRINT_EDIT_FRAME::Process_Special_Functions error" ) );
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
class BASIC_FOOTPRINT_INFO : public FOOTPRINT_INFO
|
|
{
|
|
public:
|
|
BASIC_FOOTPRINT_INFO( MODULE* aModule )
|
|
{
|
|
m_nickname = aModule->GetFPID().GetLibNickname().wx_str();
|
|
m_fpname = aModule->GetFPID().GetLibItemName().wx_str();
|
|
m_pad_count = aModule->GetPadCount( DO_NOT_INCLUDE_NPTH );
|
|
m_unique_pad_count = aModule->GetUniquePadCount( DO_NOT_INCLUDE_NPTH );
|
|
m_keywords = aModule->GetKeywords();
|
|
m_doc = aModule->GetDescription();
|
|
m_loaded = true;
|
|
}
|
|
};
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::editFootprintProperties( MODULE* aModule )
|
|
{
|
|
LIB_ID oldFPID = aModule->GetFPID();
|
|
|
|
DIALOG_FOOTPRINT_FP_EDITOR dialog( this, aModule );
|
|
dialog.ShowModal();
|
|
|
|
// Update library tree
|
|
BASIC_FOOTPRINT_INFO footprintInfo( aModule );
|
|
wxDataViewItem treeItem = m_adapter->FindItem( oldFPID );
|
|
|
|
if( treeItem.IsOk() ) // Can be not found in tree if the current footprint is imported from file
|
|
// therefore not yet in tree.
|
|
{
|
|
static_cast<LIB_TREE_NODE_LIB_ID*>( treeItem.GetID() )->Update( &footprintInfo );
|
|
m_treePane->GetLibTree()->Refresh();
|
|
}
|
|
|
|
updateTitle(); // in case of a name change...
|
|
|
|
UpdateMsgPanel();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::OnEditItemRequest( BOARD_ITEM* aItem )
|
|
{
|
|
switch( aItem->Type() )
|
|
{
|
|
case PCB_PAD_T:
|
|
InstallPadOptionsFrame( static_cast<D_PAD*>( aItem ) );
|
|
break;
|
|
|
|
case PCB_MODULE_T:
|
|
editFootprintProperties( (MODULE*) aItem );
|
|
GetCanvas()->Refresh();
|
|
break;
|
|
|
|
case PCB_MODULE_TEXT_T:
|
|
InstallTextOptionsFrame( aItem );
|
|
break;
|
|
|
|
case PCB_MODULE_EDGE_T :
|
|
InstallGraphicItemPropertiesDialog( aItem );
|
|
break;
|
|
|
|
case PCB_MODULE_ZONE_AREA_T:
|
|
{
|
|
ZONE_CONTAINER* zone = static_cast<ZONE_CONTAINER*>( aItem );
|
|
bool success = false;
|
|
if( zone )
|
|
{
|
|
ZONE_SETTINGS zoneSettings;
|
|
zoneSettings << *zone;
|
|
if( zone->GetIsKeepout() )
|
|
{
|
|
success = InvokeKeepoutAreaEditor( this, &zoneSettings );
|
|
}
|
|
else if( zone->IsOnCopperLayer() )
|
|
{
|
|
success = InvokeCopperZonesEditor( this, &zoneSettings );
|
|
}
|
|
else
|
|
{
|
|
success = InvokeNonCopperZonesEditor( this, &zoneSettings );
|
|
}
|
|
|
|
if( success )
|
|
{
|
|
BOARD_COMMIT commit( this );
|
|
commit.Modify( zone );
|
|
commit.Push( _( "Edit Zone" ) );
|
|
zoneSettings.ExportSetting( *zone );
|
|
}
|
|
}
|
|
}
|
|
break;
|
|
|
|
default:
|
|
wxASSERT( 0 );
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
COLOR4D FOOTPRINT_EDIT_FRAME::GetGridColor()
|
|
{
|
|
return Settings().Colors().GetItemColor( LAYER_GRID );
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::SetActiveLayer( PCB_LAYER_ID aLayer )
|
|
{
|
|
PCB_BASE_FRAME::SetActiveLayer( aLayer );
|
|
|
|
m_Layers->SelectLayer( aLayer );
|
|
m_Layers->OnLayerSelected();
|
|
|
|
m_toolManager->RunAction( PCB_ACTIONS::layerChanged ); // notify other tools
|
|
GetCanvas()->SetFocus(); // allow capture of hotkeys
|
|
GetCanvas()->SetHighContrastLayer( aLayer );
|
|
GetCanvas()->Refresh();
|
|
}
|
|
|
|
bool FOOTPRINT_EDIT_FRAME::OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl )
|
|
{
|
|
if( ! Clear_Pcb( true ) )
|
|
return false; // //this command is aborted
|
|
|
|
GetCanvas()->GetViewControls()->SetCrossHairCursorPosition( VECTOR2D( 0, 0 ), false );
|
|
Import_Module( aFileSet[0] );
|
|
|
|
if( GetBoard()->GetFirstModule() )
|
|
GetBoard()->GetFirstModule()->ClearFlags();
|
|
|
|
GetScreen()->ClrModify();
|
|
Zoom_Automatique( false );
|
|
GetCanvas()->Refresh();
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::KiwayMailIn( KIWAY_EXPRESS& mail )
|
|
{
|
|
const std::string& payload = mail.GetPayload();
|
|
|
|
switch( mail.Command() )
|
|
{
|
|
case MAIL_FP_EDIT:
|
|
if( !payload.empty() )
|
|
{
|
|
wxFileName fpFileName( payload );
|
|
wxString libNickname;
|
|
wxString msg;
|
|
|
|
FP_LIB_TABLE* libTable = Prj().PcbFootprintLibs();
|
|
const LIB_TABLE_ROW* libTableRow = libTable->FindRowByURI( fpFileName.GetPath() );
|
|
|
|
if( !libTableRow )
|
|
{
|
|
msg.Printf( _( "The current configuration does not include the footprint library\n"
|
|
"\"%s\".\nUse Manage Footprint Libraries to edit the configuration." ),
|
|
fpFileName.GetPath() );
|
|
DisplayErrorMessage( this, _( "Library not found in footprint library table." ), msg );
|
|
break;
|
|
}
|
|
|
|
libNickname = libTableRow->GetNickName();
|
|
|
|
if( !libTable->HasLibrary( libNickname, true ) )
|
|
{
|
|
msg.Printf( _( "The library with the nickname \"%s\" is not enabled\n"
|
|
"in the current configuration. Use Manage Footprint Libraries to\n"
|
|
"edit the configuration." ), libNickname );
|
|
DisplayErrorMessage( this, _( "Footprint library not enabled." ), msg );
|
|
break;
|
|
}
|
|
|
|
LIB_ID fpId( libNickname, fpFileName.GetName() );
|
|
|
|
if( m_treePane )
|
|
{
|
|
m_treePane->GetLibTree()->SelectLibId( fpId );
|
|
wxCommandEvent event( COMPONENT_SELECTED );
|
|
wxPostEvent( m_treePane, event );
|
|
}
|
|
}
|
|
|
|
break;
|
|
|
|
default:
|
|
;
|
|
}
|
|
}
|