406 lines
9.8 KiB
C++
406 lines
9.8 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2012 Miguel Angel Ajo Pelayo, miguelangel@nbee.es
|
|
* Copyright (C) 2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* Copyright (C) 2004-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
|
|
*/
|
|
|
|
/**
|
|
* @file footprint_wizard_frame_functions.cpp
|
|
*/
|
|
|
|
#include <fctsys.h>
|
|
#include <gr_basic.h>
|
|
#include <class_drawpanel.h>
|
|
#include <pcb_edit_frame.h>
|
|
#include <dialog_helpers.h>
|
|
|
|
#include <class_board.h>
|
|
#include <class_module.h>
|
|
|
|
#include <pcbnew.h>
|
|
#include <pcbnew_id.h>
|
|
#include "footprint_wizard_frame.h"
|
|
#include <wildcards_and_files_ext.h>
|
|
#include <dialogs/dialog_footprint_wizard_list.h>
|
|
#include <base_units.h>
|
|
|
|
|
|
void FOOTPRINT_WIZARD_FRAME::Process_Special_Functions( wxCommandEvent& event )
|
|
{
|
|
wxString msg;
|
|
int page;
|
|
|
|
switch( event.GetId() )
|
|
{
|
|
case ID_FOOTPRINT_WIZARD_NEXT:
|
|
m_pageList->SetSelection( m_pageList->GetSelection() + 1, true );
|
|
ClickOnPageList( event );
|
|
break;
|
|
|
|
case ID_FOOTPRINT_WIZARD_PREVIOUS:
|
|
page = m_pageList->GetSelection() - 1;
|
|
|
|
if( page < 0 )
|
|
page = 0;
|
|
|
|
m_pageList->SetSelection( page, true );
|
|
ClickOnPageList( event );
|
|
break;
|
|
|
|
default:
|
|
msg << wxT( "FOOTPRINT_WIZARD_FRAME::Process_Special_Functions error: id = " )
|
|
<< event.GetId();
|
|
wxMessageBox( msg );
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
/* Function OnLeftClick
|
|
* Captures a left click event in the dialog
|
|
*
|
|
*/
|
|
void FOOTPRINT_WIZARD_FRAME::OnLeftClick( wxDC* DC, const wxPoint& MousePos )
|
|
{
|
|
}
|
|
|
|
|
|
/* Function OnRightClick
|
|
* Captures a right click event in the dialog
|
|
*
|
|
*/
|
|
bool FOOTPRINT_WIZARD_FRAME::OnRightClick( const wxPoint& MousePos, wxMenu* PopMenu )
|
|
{
|
|
return true;
|
|
}
|
|
|
|
|
|
/* Displays the name of the current opened library in the caption */
|
|
void FOOTPRINT_WIZARD_FRAME::DisplayWizardInfos()
|
|
{
|
|
wxString msg;
|
|
|
|
msg = _( "Footprint Wizard" );
|
|
msg << wxT( " [" );
|
|
|
|
if( !m_wizardName.IsEmpty() )
|
|
msg << m_wizardName;
|
|
else
|
|
msg += _( "no wizard selected" );
|
|
|
|
msg << wxT( "]" );
|
|
|
|
SetTitle( msg );
|
|
}
|
|
|
|
|
|
void FOOTPRINT_WIZARD_FRAME::ReloadFootprint()
|
|
{
|
|
FOOTPRINT_WIZARD* footprintWizard = GetMyWizard();
|
|
|
|
if( !footprintWizard )
|
|
return;
|
|
|
|
SetCurItem( NULL );
|
|
// Delete the current footprint
|
|
GetBoard()->m_Modules.DeleteAll();
|
|
|
|
// Creates the module
|
|
wxString msg;
|
|
MODULE* module = footprintWizard->GetFootprint( &msg );
|
|
DisplayBuildMessage( msg );
|
|
|
|
if( module )
|
|
{
|
|
// Add the object to board
|
|
GetBoard()->Add( module, ADD_APPEND );
|
|
module->SetPosition( wxPoint( 0, 0 ) );
|
|
}
|
|
else
|
|
{
|
|
DBG(printf( "footprintWizard->GetFootprint() returns NULL\n" );)
|
|
}
|
|
|
|
m_canvas->Refresh();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_WIZARD_FRAME::DisplayBuildMessage( wxString& aMessage )
|
|
{
|
|
if( m_messagesFrame == NULL )
|
|
{
|
|
// Prepare the window to display the message generated by the footprint script builder
|
|
m_messagesFrame = new FOOTPRINT_WIZARD_MESSAGES( this, config() );
|
|
m_messagesFrame->Show( true );
|
|
}
|
|
|
|
m_messagesFrame->ClearScreen();
|
|
|
|
if( !aMessage.IsEmpty() )
|
|
m_messagesFrame->PrintMessage( aMessage );
|
|
}
|
|
|
|
|
|
FOOTPRINT_WIZARD* FOOTPRINT_WIZARD_FRAME::GetMyWizard()
|
|
{
|
|
if( m_wizardName.Length() == 0 )
|
|
return NULL;
|
|
|
|
FOOTPRINT_WIZARD* footprintWizard = FOOTPRINT_WIZARD_LIST::GetWizard( m_wizardName );
|
|
|
|
if( !footprintWizard )
|
|
{
|
|
wxMessageBox( _( "Couldn't reload footprint wizard" ) );
|
|
return NULL;
|
|
}
|
|
|
|
return footprintWizard;
|
|
}
|
|
|
|
|
|
MODULE* FOOTPRINT_WIZARD_FRAME::GetBuiltFootprint()
|
|
{
|
|
FOOTPRINT_WIZARD* footprintWizard = FOOTPRINT_WIZARD_LIST::GetWizard( m_wizardName );
|
|
|
|
if( footprintWizard && m_modal_ret_val )
|
|
{
|
|
wxString msg;
|
|
MODULE * footprint = footprintWizard->GetFootprint( &msg );
|
|
DisplayBuildMessage( msg );
|
|
|
|
return footprint;
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
|
|
void FOOTPRINT_WIZARD_FRAME::SelectFootprintWizard()
|
|
{
|
|
DIALOG_FOOTPRINT_WIZARD_LIST wizardSelector( this );
|
|
|
|
if( wizardSelector.ShowModal() != wxID_OK )
|
|
return;
|
|
|
|
FOOTPRINT_WIZARD* footprintWizard = wizardSelector.GetWizard();
|
|
|
|
if( footprintWizard )
|
|
{
|
|
m_wizardName = footprintWizard->GetName();
|
|
m_wizardDescription = footprintWizard->GetDescription();
|
|
|
|
footprintWizard->ResetParameters();
|
|
}
|
|
else
|
|
{
|
|
m_wizardName.Empty();
|
|
m_wizardDescription.Empty();
|
|
}
|
|
|
|
ReloadFootprint();
|
|
Zoom_Automatique( false );
|
|
DisplayWizardInfos();
|
|
ReCreatePageList();
|
|
ReCreateParameterList();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_WIZARD_FRAME::SelectCurrentWizard( wxCommandEvent& event )
|
|
{
|
|
SelectFootprintWizard();
|
|
}
|
|
|
|
void FOOTPRINT_WIZARD_FRAME::DefaultParameters( wxCommandEvent& event )
|
|
{
|
|
FOOTPRINT_WIZARD* footprintWizard = GetMyWizard();
|
|
|
|
if ( footprintWizard == NULL )
|
|
return;
|
|
|
|
footprintWizard->ResetParameters();
|
|
|
|
// Reload
|
|
ReCreateParameterList();
|
|
ReloadFootprint();
|
|
DisplayWizardInfos();
|
|
|
|
}
|
|
|
|
|
|
void FOOTPRINT_WIZARD_FRAME::ParametersUpdated( wxGridEvent& event )
|
|
{
|
|
FOOTPRINT_WIZARD* footprintWizard = GetMyWizard();
|
|
|
|
if( !footprintWizard )
|
|
return;
|
|
|
|
if( m_parameterGridPage < 0 )
|
|
return;
|
|
|
|
wxArrayString prmValues = footprintWizard->GetParameterValues( m_parameterGridPage );
|
|
wxArrayString ptList = footprintWizard->GetParameterTypes( m_parameterGridPage );
|
|
|
|
bool has_changed = false;
|
|
int count = m_parameterGrid->GetNumberRows();
|
|
|
|
// Skip extra event, useless
|
|
if( event.GetString() == m_parameterGrid->GetCellValue( event.GetRow(), WIZ_COL_VALUE ) )
|
|
return;
|
|
|
|
for( int prm_id = 0; prm_id < count; ++prm_id )
|
|
{
|
|
wxString value = m_parameterGrid->GetCellValue( prm_id, WIZ_COL_VALUE );
|
|
|
|
if( prmValues[prm_id] != value )
|
|
{
|
|
has_changed = true;
|
|
prmValues[prm_id] = value;
|
|
}
|
|
}
|
|
|
|
if( has_changed )
|
|
{
|
|
wxString res = footprintWizard->SetParameterValues( m_parameterGridPage, prmValues );
|
|
|
|
if( !res.IsEmpty() )
|
|
wxMessageBox( res );
|
|
|
|
ReloadFootprint();
|
|
DisplayWizardInfos();
|
|
}
|
|
}
|
|
|
|
|
|
void FOOTPRINT_WIZARD_FRAME::OnParameterCellClick( wxGridEvent& event )
|
|
{
|
|
auto footprintWizard = GetMyWizard();
|
|
|
|
if( !footprintWizard )
|
|
return;
|
|
|
|
if( m_parameterGridPage < 0 )
|
|
return;
|
|
|
|
if( event.GetCol() != WIZ_COL_VALUE )
|
|
return;
|
|
|
|
auto types = footprintWizard->GetParameterTypes( m_parameterGridPage );
|
|
auto values = footprintWizard->GetParameterValues( m_parameterGridPage );
|
|
|
|
int row = event.GetRow();
|
|
bool has_changed = false;
|
|
|
|
// Handle toggling of boolean parameters
|
|
if( types[row] == WIZARD_PARAM_UNITS_BOOL )
|
|
{
|
|
has_changed = true;
|
|
values[row] = ( values[row] == "1" ) ? "0" : "1";
|
|
m_parameterGrid->SetCellValue( row, WIZ_COL_VALUE, values[row] );
|
|
}
|
|
else
|
|
{
|
|
event.Skip();
|
|
}
|
|
|
|
if( has_changed )
|
|
{
|
|
wxString res = footprintWizard->SetParameterValues( m_parameterGridPage, values );
|
|
|
|
if( !res.IsEmpty() )
|
|
wxMessageBox( res );
|
|
|
|
ReloadFootprint();
|
|
DisplayWizardInfos();
|
|
}
|
|
}
|
|
|
|
|
|
void FOOTPRINT_WIZARD_FRAME::OnParameterGridKeyPress( wxKeyEvent& event )
|
|
{
|
|
auto footprintWizard = GetMyWizard();
|
|
int row = m_parameterGrid->GetGridCursorRow();
|
|
int col = m_parameterGrid->GetGridCursorCol();
|
|
bool has_changed = false;
|
|
|
|
|
|
if( !footprintWizard || m_parameterGridPage < 0 ||
|
|
col != WIZ_COL_VALUE || event.GetKeyCode() != ' ' )
|
|
{
|
|
event.Skip();
|
|
return;
|
|
}
|
|
|
|
auto types = footprintWizard->GetParameterTypes( m_parameterGridPage );
|
|
auto values = footprintWizard->GetParameterValues( m_parameterGridPage );
|
|
|
|
// Handle toggling of boolean parameters when user presses space
|
|
if( types[row] == WIZARD_PARAM_UNITS_BOOL )
|
|
{
|
|
has_changed = true;
|
|
values[row] = ( values[row] == "1" ) ? "0" : "1";
|
|
m_parameterGrid->SetCellValue( row, WIZ_COL_VALUE, values[row] );
|
|
}
|
|
else
|
|
{
|
|
m_parameterGrid->EnableCellEditControl();
|
|
}
|
|
|
|
if( has_changed )
|
|
{
|
|
wxString res = footprintWizard->SetParameterValues( m_parameterGridPage, values );
|
|
|
|
if( !res.IsEmpty() )
|
|
wxMessageBox( res );
|
|
|
|
ReloadFootprint();
|
|
DisplayWizardInfos();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Function RedrawActiveWindow
|
|
* Display the current selected component.
|
|
* If the component is an alias, the ROOT component is displayed
|
|
*
|
|
*/
|
|
void FOOTPRINT_WIZARD_FRAME::RedrawActiveWindow( wxDC* DC, bool EraseBg )
|
|
{
|
|
if( !GetBoard() )
|
|
return;
|
|
|
|
m_canvas->DrawBackGround( DC );
|
|
GetBoard()->Draw( m_canvas, DC, GR_COPY );
|
|
|
|
MODULE* module = GetBoard()->m_Modules;
|
|
|
|
if( module )
|
|
SetMsgPanel( module );
|
|
|
|
m_canvas->DrawCrossHair( DC );
|
|
|
|
ClearMsgPanel();
|
|
|
|
if( module )
|
|
SetMsgPanel( module );
|
|
}
|