KiCad PCB EDA Suite
Loading...
Searching...
No Matches
footprint_chooser_frame.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2023 CERN
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#include <pgm_base.h>
26#include <kiface_base.h>
27#include <kiway.h>
28#include <kiway_express.h>
29#include <board.h>
30#include <wx/button.h>
31#include <wx/checkbox.h>
32#include <wx/splitter.h>
33#include <kiplatform/ui.h>
34#include <lset.h>
39#include <tool/tool_manager.h>
41#include <tool/common_tools.h>
42#include <tool/zoom_tool.h>
44#include <tools/pcb_actions.h>
48#include "wx/display.h"
51#include <project_pcb.h>
55
56
57static wxArrayString s_FootprintHistoryList;
58static unsigned s_FootprintHistoryMaxCount = 8;
59
60static void AddFootprintToHistory( const wxString& aName )
61{
62 // Remove duplicates
63 for( int ii = (int) s_FootprintHistoryList.GetCount() - 1; ii >= 0; --ii )
64 {
65 if( s_FootprintHistoryList[ ii ] == aName )
66 s_FootprintHistoryList.RemoveAt( (size_t) ii );
67 }
68
69 // Add the new name at the beginning of the history list
70 s_FootprintHistoryList.Insert( aName, 0 );
71
72 // Remove extra names
74 s_FootprintHistoryList.RemoveAt( s_FootprintHistoryList.GetCount() - 1 );
75}
76
77
78BEGIN_EVENT_TABLE( FOOTPRINT_CHOOSER_FRAME, PCB_BASE_FRAME )
80 EVT_BUTTON( wxID_OK, FOOTPRINT_CHOOSER_FRAME::OnOK )
81 EVT_BUTTON( wxID_CANCEL, FOOTPRINT_CHOOSER_FRAME::closeFootprintChooser )
83END_EVENT_TABLE()
84
85
86#define PARENT_STYLE ( wxRESIZE_BORDER | wxSYSTEM_MENU | wxCAPTION | wxCLOSE_BOX | wxCLIP_CHILDREN \
87 | wxWANTS_CHARS | wxFRAME_NO_TASKBAR | wxFRAME_FLOAT_ON_PARENT )
88#define MODAL_STYLE ( wxRESIZE_BORDER | wxSYSTEM_MENU | wxCAPTION | wxCLOSE_BOX | wxCLIP_CHILDREN \
89 | wxWANTS_CHARS | wxFRAME_NO_TASKBAR )
90
91
93 PCB_BASE_FRAME( aKiway, aParent, FRAME_FOOTPRINT_CHOOSER, _( "Footprint Chooser" ),
94 wxDefaultPosition, wxDefaultSize, aParent ? PARENT_STYLE : MODAL_STYLE,
96 m_filterByPinCount( nullptr ),
97 m_filterByFPFilters( nullptr ),
101 m_pinCount( 0 ),
102 m_firstPaintEvent( true )
103{
104 SetModal( true );
105
106 m_messagePanel->Hide();
107
108 m_bottomPanel = new wxPanel( this );
109 wxBoxSizer* bottomSizer = new wxBoxSizer( wxVERTICAL );
110 wxBoxSizer* frameSizer = new wxBoxSizer( wxVERTICAL );
111
113 // Filter
114 [this]( LIB_TREE_NODE& aNode ) -> bool
115 {
116 return filterFootprint( aNode );
117 },
118 // Accept handler
119 [this]()
120 {
121 wxCommandEvent dummy;
122 OnOK( dummy );
123 },
124 // Escape handler
125 [this]()
126 {
127 DismissModal( false );
128 } );
129
130 frameSizer->Add( m_chooserPanel, 1, wxEXPAND );
131
132 SetCanvas( m_chooserPanel->GetViewerPanel()->GetPreviewPanel()->GetCanvas() );
133 SetBoard( m_chooserPanel->GetViewerPanel()->GetPreviewPanel()->GetBoard() );
134
135 // This board will only be used to hold a footprint for viewing
137
138 build3DCanvas(); // must be called after creating m_chooserPanel
140
141 // buttonsSizer contains the BITMAP buttons
142 wxBoxSizer* buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
143
144 buttonsSizer->Add( 0, 0, 1, 0, 5 ); // Add spacer to right-align buttons
145
146
147 m_toggleDescription = new BITMAP_BUTTON( m_bottomPanel, wxID_ANY, wxNullBitmap );
148 m_toggleDescription->SetIsRadioButton();
150 m_toggleDescription->SetToolTip( _( "Show/hide description panel" ) );
152 buttonsSizer->Add( m_toggleDescription, 0, wxRIGHT | wxLEFT | wxALIGN_CENTER_VERTICAL, 1 );
153
154 BITMAP_BUTTON* separator = new BITMAP_BUTTON( m_bottomPanel, wxID_ANY, wxNullBitmap );
155 separator->SetIsSeparator();
156 buttonsSizer->Add( separator, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, 1 );
157
158 m_grButton3DView = new BITMAP_BUTTON( m_bottomPanel, wxID_ANY, wxNullBitmap );
159 m_grButton3DView->SetIsRadioButton();
161 m_grButton3DView->SetToolTip( _( "Show/hide 3D view panel" ) );
163 buttonsSizer->Add( m_grButton3DView, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, 1 );
164
165 m_grButtonFpView = new BITMAP_BUTTON( m_bottomPanel, wxID_ANY, wxNullBitmap );
166 m_grButtonFpView->SetIsRadioButton();
168 m_grButtonFpView->SetToolTip( _( "Show/hide footprint view panel" ) );
170 buttonsSizer->Add( m_grButtonFpView, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, 1 );
171
172 separator = new BITMAP_BUTTON( m_bottomPanel, wxID_ANY, wxNullBitmap );
173 separator->SetIsSeparator();
174 buttonsSizer->Add( separator, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, 1 );
175
176 m_show3DViewer = new wxCheckBox( m_bottomPanel, wxID_ANY, _( "Show 3D viewer in own window" ) );
177 buttonsSizer->Add( m_show3DViewer, 0, wxALL | wxALIGN_CENTER_VERTICAL, 3 );
178
179 wxStdDialogButtonSizer* sdbSizer = new wxStdDialogButtonSizer();
180 wxButton* okButton = new wxButton( m_bottomPanel, wxID_OK );
181 wxButton* cancelButton = new wxButton( m_bottomPanel, wxID_CANCEL );
182
183 sdbSizer->AddButton( okButton );
184 sdbSizer->AddButton( cancelButton );
185 sdbSizer->Realize();
186
187 buttonsSizer->Add( 20, 0, 0, 0, 5 ); // Add spacer
188 buttonsSizer->Add( sdbSizer, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
189 bottomSizer->Add( buttonsSizer, 0, wxEXPAND, 5 );
190
191 m_bottomPanel->SetSizer( bottomSizer );
192 frameSizer->Add( m_bottomPanel, 0, wxEXPAND );
193
194 SetSizer( frameSizer );
195
196 SetTitle( GetTitle() + wxString::Format( _( " (%d items loaded)" ),
197 m_chooserPanel->GetItemCount() ) );
198
199 Layout();
200 m_chooserPanel->FinishSetup();
201
202 if( !m_showDescription )
203 {
204 m_chooserPanel->GetVerticalSpliter()->SetMinimumPaneSize( 0 );
205 m_chooserPanel->GetVerticalSpliter()->GetWindow2()->Hide();
206 m_chooserPanel->GetVerticalSpliter()->SetSashInvisible();
207
209 }
210
211 // Create the manager and dispatcher & route draw panel events to the dispatcher
213 m_toolManager->SetEnvironment( GetBoard(), GetCanvas()->GetView(),
214 GetCanvas()->GetViewControls(), GetViewerSettingsBase(), this );
215 m_actions = new PCB_ACTIONS();
218
219 m_toolManager->RegisterTool( new COMMON_TOOLS ); // for std context menus (zoom & grid)
220 m_toolManager->RegisterTool( new PCB_PICKER_TOOL ); // for setting grid origin
221 m_toolManager->RegisterTool( new ZOOM_TOOL );
222 m_toolManager->RegisterTool( new PCB_VIEWER_TOOLS );
224
225 m_toolManager->GetTool<PCB_VIEWER_TOOLS>()->SetFootprintFrame( true );
226 m_toolManager->GetTool<PCB_VIEWER_TOOLS>()->SetIsDefaultTool( true );
227
228 m_toolManager->InitTools();
229
232
233 // clang-format off
234 // Connect Events
235 m_toggleDescription->Connect( wxEVT_COMMAND_BUTTON_CLICKED ,
236 wxCommandEventHandler( FOOTPRINT_CHOOSER_FRAME::toggleBottomSplit ),
237 nullptr, this );
238
239 m_grButton3DView->Connect( wxEVT_COMMAND_BUTTON_CLICKED ,
240 wxCommandEventHandler( FOOTPRINT_CHOOSER_FRAME::on3DviewReq ),
241 nullptr, this );
242
243 m_grButtonFpView->Connect( wxEVT_COMMAND_BUTTON_CLICKED ,
244 wxCommandEventHandler( FOOTPRINT_CHOOSER_FRAME::onFpViewReq ),
245 nullptr, this );
246
247 m_show3DViewer->Connect( wxEVT_COMMAND_CHECKBOX_CLICKED ,
249 nullptr, this );
250
251 Connect( FP_SELECTION_EVENT, // custom event fired by a PANEL_FOOTPRINT_CHOOSER
252 wxCommandEventHandler( FOOTPRINT_CHOOSER_FRAME::onFpChanged ), nullptr, this );
253 // clang-format on
254
255 // Needed on Linux to fix the position of widgets in bottomPanel
256 PostSizeEvent();
257}
258
259
261{
262 // Work around assertion firing when we try to LockCtx on a hidden 3D canvas during dtor
263 wxCloseEvent dummy;
264 m_preview3DCanvas->Show();
265 m_preview3DCanvas->OnCloseWindow( dummy );
266
267 // Ensure view and data used by the preview panel are cleared before deleting other items
268 static_cast<FOOTPRINT_PREVIEW_PANEL*>( m_chooserPanel->GetViewerPanel()->GetPreviewPanel() )->ClearViewAndData();
269
270 // Disconnect board, which is owned by FOOTPRINT_PREVIEW_PANEL.
271 m_pcb = nullptr;
272
273 // clang-format off
274 // Disconnect Events
275 m_toggleDescription->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED,
276 wxCommandEventHandler( FOOTPRINT_CHOOSER_FRAME::toggleBottomSplit ),
277 nullptr, this );
278
279 m_grButton3DView->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED,
280 wxCommandEventHandler( FOOTPRINT_CHOOSER_FRAME::on3DviewReq ),
281 nullptr, this );
282 m_grButtonFpView->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED,
283 wxCommandEventHandler( FOOTPRINT_CHOOSER_FRAME::onFpViewReq ),
284 nullptr, this );
285
286 m_show3DViewer->Disconnect( wxEVT_COMMAND_CHECKBOX_CLICKED ,
288 nullptr, this );
289
290 Disconnect( FP_SELECTION_EVENT,
291 wxCommandEventHandler( FOOTPRINT_CHOOSER_FRAME::onFpChanged ), nullptr, this );
292 // clang-format on
293
294 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() ) )
295 {
297 cfg->m_FootprintChooser.use_fp_filters = m_filterByFPFilters->GetValue();
298
300 cfg->m_FootprintChooser.filter_on_pin_count = m_filterByPinCount->GetValue();
301 }
302}
303
304
306{
307 if( aEvent.IsChecked() )
308 {
309 if( m_grButton3DView->IsChecked() )
310 Show3DViewerFrame(); // show external 3D viewer
311 }
312 else
313 {
314 // Close the external 3D viewer frame, if it is still enabled
316
317 if( viewer3D )
318 viewer3D->Close( true );
319 }
320
322}
323
324
326{
327 bool do_reload_board = true; // reload board flag
328
329 // At EDA_3D_VIEWER_FRAME creation, the current board is loaded, so disable loading
330 // the current board if the 3D frame is not yet created
331 if( Get3DViewerFrame() == nullptr )
332 do_reload_board = false;
333
335
336 // A stronger version of Raise() which promotes the window to its parent's level.
337 KIPLATFORM::UI::ReparentModal( draw3DFrame );
338
339 // And load or update the current board (if needed)
340 if( do_reload_board )
341 Update3DView( true, true );
342}
343
344
345void FOOTPRINT_CHOOSER_FRAME::Update3DView( bool aMarkDirty, bool aRefresh, const wxString* aTitle )
346{
347 LIB_ID fpID = m_chooserPanel->GetSelectedLibId();
348 wxString footprintName;
349
350 if( fpID.IsValid() )
351 footprintName << fpID.Format();
352
353 wxString title = _( "3D Viewer" ) + wxT( " \u2014 " ) + footprintName;
354 PCB_BASE_FRAME::Update3DView( aMarkDirty, aRefresh, &title );
355}
356
357
359{
361 return m_filterByPinCount->GetValue();
362
363 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() ) )
364 return cfg->m_FootprintChooser.filter_on_pin_count;
365
366 return false;
367}
368
369
371{
373 return m_filterByFPFilters->GetValue();
374
375 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() ) )
376 return cfg->m_FootprintChooser.use_fp_filters;
377
378 return false;
379}
380
381
383{
384 if( aNode.m_Type == LIB_TREE_NODE::TYPE::LIBRARY )
385 {
386 // Normally lib nodes get scored by the max of their children's scores. However, if a
387 // lib node *has* no children then the scorer will call the filter on the lib node itself,
388 // and we just want to return true if we're not filtering at all.
389 return !filterByPinCount() && !filterByFPFilters();
390 }
391
392 auto patternMatch =
393 []( LIB_ID& id, std::vector<std::unique_ptr<EDA_PATTERN_MATCH>>& filters ) -> bool
394 {
395 // The matching is case insensitive
396 wxString name;
397
398 for( const std::unique_ptr<EDA_PATTERN_MATCH>& filter : filters )
399 {
400 name.Empty();
401
402 // If the filter contains a ':' then include the library name in the pattern
403 if( filter->GetPattern().Contains( wxS( ":" ) ) )
404 name = id.GetUniStringLibNickname().Lower() + wxS( ":" );
405
406 name += id.GetUniStringLibItemName().Lower();
407
408 if( filter->Find( name ) )
409 return true;
410 }
411
412 return false;
413 };
414
415 if( m_pinCount > 0 && filterByPinCount() )
416 {
417 if( aNode.m_PinCount != m_pinCount )
418 return false;
419 }
420
421 if( !m_fpFilters.empty() && filterByFPFilters() )
422 {
423 if( !patternMatch( aNode.m_LibId, m_fpFilters ) )
424 return false;
425 }
426
427 return true;
428}
429
430
432{
433 // Only dismiss a modal frame once, so that the return values set by
434 // the prior DismissModal() are not bashed for ShowModal().
435 if( !IsDismissed() )
436 DismissModal( false );
437
438 // window to be destroyed by the caller of KIWAY_PLAYER::ShowModal()
439}
440
441
443{
444 if( PCBNEW_SETTINGS* pcb_cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg ) )
445 return &pcb_cfg->m_FootprintViewer;
446 else if( CVPCB_SETTINGS* cvpcb_cfg = dynamic_cast<CVPCB_SETTINGS*>( aCfg ) )
447 return &cvpcb_cfg->m_FootprintViewer;
448
449 wxFAIL_MSG( wxT( "FOOTPRINT_CHOOSER not running with PCBNEW_SETTINGS or CVPCB_SETTINGS" ) );
450 return &aCfg->m_Window; // non-null fail-safe
451}
452
453
455{
457 return ::GetColorSettings( cfg ? cfg->m_ColorTheme : DEFAULT_THEME );
458}
459
460
461static wxRect s_dialogRect( 0, 0, 0, 0 );
462
463
465{
466 const std::string& payload = mail.GetPayload();
467
468 switch( mail.Command() )
469 {
471 {
472 wxLogTrace( "FOOTPRINT_CHOOSER", wxS( "MAIL_SYMBOL_NETLIST received: size=%zu" ),
473 payload.size() );
474 wxSizer* filtersSizer = m_chooserPanel->GetFiltersSizer();
475 wxWindow* filtersWindow = filtersSizer->GetContainingWindow();
476 wxString msg;
477
478 m_pinCount = 0;
479 m_fpFilters.clear();
480
481 /*
482 * Symbol netlist format:
483 * pinNumber pinName <tab> pinNumber pinName...
484 * fpFilter fpFilter...
485 */
486 std::map<wxString, wxString> pinNames;
487 std::vector<std::string> strings = split( payload, "\r" );
488
489 if( strings.size() >= 1 && !strings[0].empty() )
490 {
491 wxArrayString tokens = wxSplit( strings[0], '\t' );
492
493 wxLogTrace( "FOOTPRINT_CHOOSER", wxS( "First line entries=%u" ), (unsigned) tokens.size() );
494
495 for( const wxString& pin : tokens )
496 pinNames[ pin.BeforeFirst( ' ' ) ] = pin.AfterFirst( ' ' );
497
498 m_pinCount = (int) pinNames.size();
499
500 wxString pinList;
501 for( const auto& kv : pinNames )
502 {
503 if( !pinList.IsEmpty() )
504 pinList << wxS( "," );
505 pinList << kv.first;
506 }
507
508 wxLogTrace( "FOOTPRINT_CHOOSER", wxS( "Parsed pins=%d -> [%s]" ), m_pinCount, pinList );
509 }
510
511 if( strings.size() >= 2 && !strings[1].empty() )
512 {
513 for( const wxString& filter : wxSplit( strings[1], ' ' ) )
514 {
515 m_fpFilters.push_back( std::make_unique<EDA_PATTERN_MATCH_WILDCARD_ANCHORED>() );
516 m_fpFilters.back()->SetPattern( filter.Lower() );
517 }
518 }
519
520 if( !m_fpFilters.empty() )
521 {
522 msg.Printf( _( "Apply footprint filters (%s)" ), strings[1] );
523
525 {
526 m_filterByFPFilters = new wxCheckBox( filtersWindow, wxID_ANY, msg );
527
528 m_filterByFPFilters->Bind( wxEVT_CHECKBOX,
529 [&]( wxCommandEvent& evt )
530 {
531 m_chooserPanel->Regenerate();
532 } );
533
534 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() ) )
535 m_filterByFPFilters->SetValue( cfg->m_FootprintChooser.use_fp_filters );
536
537 m_chooserPanel->GetFiltersSizer()->Add( m_filterByFPFilters, 0, wxEXPAND|wxBOTTOM, 4 );
538 }
539
540 m_filterByFPFilters->SetLabel( msg );
541 }
542 else
543 {
545 m_filterByFPFilters->Hide();
546 }
547
548 if( m_pinCount > 0 )
549 {
550 msg.Printf( _( "Filter by pin count (%d)" ), m_pinCount );
551 wxLogTrace( "FOOTPRINT_CHOOSER", wxS( "Pin-count label: %s" ), msg );
552
553 if( !m_filterByPinCount )
554 {
555 m_filterByPinCount = new wxCheckBox( filtersWindow, wxID_ANY, msg );
556
557 m_filterByPinCount->Bind( wxEVT_CHECKBOX,
558 [&]( wxCommandEvent& evt )
559 {
560 m_chooserPanel->Regenerate();
561 } );
562
563 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() ) )
564 m_filterByPinCount->SetValue( cfg->m_FootprintChooser.filter_on_pin_count );
565
566 m_chooserPanel->GetFiltersSizer()->Add( m_filterByPinCount, 0, wxEXPAND|wxBOTTOM, 4 );
567 }
568
569 m_filterByPinCount->SetLabel( msg );
570 }
571 else
572 {
574 m_filterByPinCount->Hide();
575 }
576
577 m_chooserPanel->GetViewerPanel()->SetPinFunctions( pinNames );
578 wxLogTrace( "FOOTPRINT_CHOOSER", wxS( "SetPinFunctions called with %zu entries" ),
579 pinNames.size() );
580
581 // Save the wxFormBuilder size of the dialog...
582 if( s_dialogRect.GetSize().x == 0 || s_dialogRect.GetSize().y == 0 )
583 s_dialogRect = wxRect( wxWindow::GetPosition(), wxWindow::GetSize() );
584
585 // ... and then give it a kick to get it to layout the new items
586 GetSizer()->SetSizeHints( this );
587 break;
588 }
589
590 default:
591 break;
592 }
593}
594
595
597{
598 return static_cast<FOOTPRINT_PREVIEW_PANEL*>( m_chooserPanel->GetViewerPanel()->GetPreviewPanel() )->GetCurrentFootprint();
599}
600
601
602bool FOOTPRINT_CHOOSER_FRAME::ShowModal( wxString* aFootprint, wxWindow* aParent )
603{
604 if( aFootprint && !aFootprint->IsEmpty() )
605 {
606 LIB_ID fpid;
607
608 fpid.Parse( *aFootprint, true );
609
610 if( fpid.IsValid() )
611 m_chooserPanel->SetPreselect( fpid );
612 }
613
614 return KIWAY_PLAYER::ShowModal( aFootprint, aParent );
615}
616
617
618void FOOTPRINT_CHOOSER_FRAME::SetPosition( const wxPoint& aNewPosition )
619{
620 PCB_BASE_FRAME::SetPosition( aNewPosition );
621
622 s_dialogRect.SetPosition( aNewPosition );
623}
624
625
627{
628 bool ret;
629
630 // Show or hide the window. If hiding, save current position and size.
631 // If showing, use previous position and size.
632 if( show )
633 {
634#ifndef __WINDOWS__
635 PCB_BASE_FRAME::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
636#endif
637 ret = PCB_BASE_FRAME::Show( show );
638
639 // returns a zeroed-out default wxRect if none existed before.
640 wxRect savedDialogRect = s_dialogRect;
641
642 if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
643 {
644 SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
645 std::max( wxWindow::GetSize().x, savedDialogRect.GetSize().x ),
646 std::max( wxWindow::GetSize().y, savedDialogRect.GetSize().y ),
647 0 );
648 }
649
650 // Be sure that the dialog appears in a visible area
651 // (the dialog position might have been stored at the time when it was
652 // shown on another display)
653 if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
654 Centre();
655 }
656 else
657 {
658 s_dialogRect = wxRect( wxWindow::GetPosition(), wxWindow::GetSize() );
659 ret = PCB_BASE_FRAME::Show( show );
660 }
661
662 return ret;
663}
664
665
666void FOOTPRINT_CHOOSER_FRAME::OnPaint( wxPaintEvent& aEvent )
667{
669 {
671 KIPLATFORM::UI::ForceFocus( m_chooserPanel->GetFocusTarget() );
672
673 m_firstPaintEvent = false;
674 }
675
676 aEvent.Skip();
677}
678
679
680void FOOTPRINT_CHOOSER_FRAME::OnOK( wxCommandEvent& aEvent )
681{
682 LIB_ID fpID = m_chooserPanel->GetSelectedLibId();
683
684 if( fpID.IsValid() )
685 {
686 wxString footprint = fpID.Format();
687
688 AddFootprintToHistory( footprint );
689 DismissModal( true, footprint );
690 }
691 else
692 {
693 DismissModal( false );
694 }
695}
696
697
699{
700 Close( false );
701}
702
703
704void FOOTPRINT_CHOOSER_FRAME::onFpChanged( wxCommandEvent& event )
705{
706 updateViews();
707
709}
710
711
713{
714 // initialize m_boardAdapter used by the 3D canvas
715 BOARD* dummyBoard = GetBoard();
716 m_boardAdapter.SetBoard( dummyBoard );
717 m_boardAdapter.m_IsBoardView = false;
718 m_boardAdapter.m_IsPreviewer = true; // Force display 3D models, regardless the 3D viewer options
719
721
722 // Build the 3D canvas
727
728 m_chooserPanel->m_RightPanelSizer->Add( m_preview3DCanvas, 1, wxEXPAND, 5 );
729 m_chooserPanel->m_RightPanel->Layout();
730
731 BOARD_DESIGN_SETTINGS& dummy_bds = dummyBoard->GetDesignSettings();
732 dummy_bds.SetBoardThickness( pcbIUScale.mmToIU( 1.6 ) );
734 BOARD_STACKUP& dummy_board_stackup = dummyBoard->GetDesignSettings().GetStackupDescriptor();
735 dummy_board_stackup.RemoveAll();
736 dummy_board_stackup.BuildDefaultStackupList( &dummy_bds, 2 );
737}
738
739
741{
743
745
746 m_chooserPanel->GetDetailsPanel()->Show( m_showDescription );
747
748 if( !m_showDescription )
749 {
750 m_chooserPanel->GetVerticalSpliter()->SetMinimumPaneSize( GetSize().GetHeight() );
751 m_chooserPanel->GetVerticalSpliter()->SetSashPosition(
752 GetSize().GetHeight() + m_chooserPanel->GetDetailsPanel()->GetSize().GetHeight() );
753
754 m_chooserPanel->GetVerticalSpliter()->GetWindow2()->Hide();
755 m_chooserPanel->GetVerticalSpliter()->SetSashInvisible();
756
758 }
759 else
760 {
761 m_chooserPanel->GetVerticalSpliter()->SetMinimumPaneSize( 80 );
762 m_chooserPanel->GetVerticalSpliter()->GetWindow2()->Show();
763 m_chooserPanel->GetVerticalSpliter()->SetSashInvisible( false );
764
766 }
767
768 m_chooserPanel->GetVerticalSpliter()->UpdateSize();
769
770 m_chooserPanel->Layout();
771 m_chooserPanel->Refresh();
772}
773
774void FOOTPRINT_CHOOSER_FRAME::on3DviewReq( wxCommandEvent& event )
775{
776 if( m_show3DMode == true )
777 {
778 if( m_showFpMode == true )
779 {
780 m_show3DMode = false;
783 }
784 }
785 else
786 {
787 if( m_show3DViewer->IsChecked() )
788 {
790 }
791 else
792 {
793 // Close 3D viewer frame, if it is still enabled
795 if( viewer3D )
796 viewer3D->Close( true );
797 }
798
799 m_show3DMode = true;
802 }
803}
804
805
806void FOOTPRINT_CHOOSER_FRAME::onFpViewReq( wxCommandEvent& event )
807{
808 if( m_showFpMode == true )
809 {
810 if( m_show3DMode == true )
811 {
812 m_showFpMode = false;
815 }
816 }
817 else
818 {
819 m_showFpMode = true;
822 }
823}
824
825
827{
829
830 if( m_preview3DCanvas->IsShown() )
831 {
832 m_preview3DCanvas->ReloadRequest();
833 m_preview3DCanvas->Request_refresh();
834 }
835
836 if( viewer3D )
837 {
838 Update3DView( true, true );
839 }
840
841 m_chooserPanel->m_RightPanel->Layout();
842 m_chooserPanel->m_RightPanel->Refresh();
843}
844
846{
847 FOOTPRINT_PREVIEW_WIDGET* viewFpPanel = m_chooserPanel->GetViewerPanel();
848 viewFpPanel->Show( m_showFpMode );
850
851 updateViews();
852}
853
854
856{
858
859 ACTION_MANAGER* mgr = m_toolManager->GetActionManager();
860 PCB_EDITOR_CONDITIONS cond( this );
861
862 wxASSERT( mgr );
863
864 // clang-format off
865#define CHECK( x ) ACTION_CONDITIONS().Check( x )
866
871
875
877
882
883#undef CHECK
884 // clang-format on
885}
886
887
const char * name
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:112
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap, int aMinHeight)
Definition bitmap.cpp:110
@ text_visibility_off
@ text_visibility
@ FPHOLDER
Definition board.h:309
#define RANGE_SCALE_3D
This defines the range that all coord will have to be rendered.
static TOOL_ACTION toggleGrid
Definition actions.h:197
static TOOL_ACTION millimetersUnits
Definition actions.h:205
static TOOL_ACTION cursorSmallCrosshairs
Definition actions.h:151
static TOOL_ACTION milsUnits
Definition actions.h:204
static TOOL_ACTION inchesUnits
Definition actions.h:203
static TOOL_ACTION measureTool
Definition actions.h:251
static TOOL_ACTION cursor45Crosshairs
Definition actions.h:153
static TOOL_ACTION cursorFullCrosshairs
Definition actions.h:152
Manage TOOL_ACTION objects.
void SetConditions(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Set the conditions the UI elements for activating a specific tool action should use for determining t...
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
WINDOW_SETTINGS m_Window
wxString m_ColorTheme
Active color theme name.
A bitmap button widget that behaves like an AUI toolbar item's button when it is drawn.
void SetIsSeparator()
Render button as a toolbar separator.
Container for design settings for a BOARD object.
void SetEnabledLayers(const LSET &aMask)
Change the bit-mask of enabled layers to aMask.
BOARD_STACKUP & GetStackupDescriptor()
void SetBoardThickness(int aThickness)
Abstract interface for BOARD_ITEMs capable of storing other items inside.
Manage layers needed to make a physical board.
void RemoveAll()
Delete all items in list and clear the list.
void BuildDefaultStackupList(const BOARD_DESIGN_SETTINGS *aSettings, int aActiveCopperLayersCount=0)
Create a default stackup, according to the current BOARD_DESIGN_SETTINGS settings.
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:317
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition board.h:329
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition board.cpp:1040
Color settings are a bit different than most of the settings objects in that there can be more than o...
Handles action that are shared between different applications.
Implement a canvas based on a wxGLCanvas.
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
virtual void setupUIConditions()
Setup the UI conditions for the various actions and their controls in this frame.
EDA_MSG_PANEL * m_messagePanel
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
SELECTION_CONDITION Units(EDA_UNITS aUnit)
Create a functor that tests if the frame has the specified units.
SELECTION_CONDITION CursorSmallCrosshairs()
Create a functor testing if the cursor is full screen in a frame.
SELECTION_CONDITION GridVisible()
Create a functor testing if the grid is visible in a frame.
SELECTION_CONDITION Cursor45Crosshairs()
SELECTION_CONDITION CursorFullCrosshairs()
void onFpViewReq(wxCommandEvent &event)
void updateViews()
Must be called after loading a new footprint: update footprint and/or 3D views.
WINDOW_SETTINGS * GetWindowSettings(APP_SETTINGS_BASE *aCfg) override
Return a pointer to the window settings for this frame.
void closeFootprintChooser(wxCommandEvent &aEvent)
bool filterFootprint(LIB_TREE_NODE &aNode)
void on3DviewReq(wxCommandEvent &event)
void onFpChanged(wxCommandEvent &event)
FOOTPRINT_CHOOSER_FRAME(KIWAY *aKiway, wxWindow *aParent)
bool ShowModal(wxString *aFootprint, wxWindow *aParent) override
void OnPaint(wxPaintEvent &aEvent)
BOARD_ITEM_CONTAINER * GetModel() const override
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
bool Show(bool show) override
void OnOK(wxCommandEvent &aEvent)
void updatePanelsVisibility()
Show hide footprint view panel and/or 3d view panel according to the options (display 3D shapes and u...
void toggleBottomSplit(wxCommandEvent &event)
void SetPosition(const wxPoint &aNewPosition)
Force the position of the dialog to a new position.
void KiwayMailIn(KIWAY_EXPRESS &mail) override
Receive KIWAY_EXPRESS messages from other players.
void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr) override
Update the 3D view, if the viewer is opened by this frame.
std::vector< std::unique_ptr< EDA_PATTERN_MATCH > > m_fpFilters
void onExternalViewer3DEnable(wxCommandEvent &aEvent)
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh) const override
Helper to retrieve the current color settings.
PANEL_FOOTPRINT_CHOOSER * m_chooserPanel
Selection tool for the footprint viewer in CvPcb.
Panel that renders a single footprint via Cairo GAL, meant to be exported through Kiface.
FOOTPRINT * GetCurrentFootprint() const
Carry a payload from one KIWAY_PLAYER to another within a PROJECT.
std::string & GetPayload()
Return the payload, which can be any text but it typically self identifying s-expression.
MAIL_T Command()
Returns the MAIL_T associated with this mail.
virtual bool ShowModal(wxString *aResult=nullptr, wxWindow *aResultantFocusWindow=nullptr)
Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until t...
void SetModal(bool aIsModal)
void DismissModal(bool aRetVal, const wxString &aResult=wxEmptyString)
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:286
A logical library item identifier and consists of various portions much like a URI.
Definition lib_id.h:49
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition lib_id.cpp:52
bool IsValid() const
Check if this LID_ID is valid.
Definition lib_id.h:172
UTF8 Format() const
Definition lib_id.cpp:119
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
static const LSET & FrontMask()
Return a mask holding all technical layers and the external CU layer on front side.
Definition lset.cpp:705
static const LSET & BackMask()
Return a mask holding all technical layers and the external CU layer on back side.
Definition lset.cpp:712
static const wxGLAttributes GetAttributesList(ANTIALIASING_MODE aAntiAliasingMode, bool aAlpha=false)
Get a list of attributes to pass to wxGLCanvas.
Gather all the actions that are shared by tools.
Definition pcb_actions.h:51
static TOOL_ACTION toggleHV45Mode
static TOOL_ACTION padDisplayMode
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
static TOOL_ACTION textOutlines
Display texts as lines.
static TOOL_ACTION showPadNumbers
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
PCB_BASE_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
virtual PCB_VIEWERS_SETTINGS_BASE * GetViewerSettingsBase() const
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void SetBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr)
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
BOARD * GetBoard() const
EDA_3D_VIEWER_FRAME * CreateAndShow3D_Frame()
Show the 3D view frame.
EDA_3D_VIEWER_FRAME * Get3DViewerFrame()
virtual void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
Group generic conditions for PCB editor states.
SELECTION_CONDITION PadFillDisplay()
Create a functor that tests if the frame fills the pads.
SELECTION_CONDITION GraphicsFillDisplay()
Create a functor that tests if the frame fills graphics items.
SELECTION_CONDITION Get45degMode()
Create a functor that tests whether angle constraints are enabled.
SELECTION_CONDITION PadNumbersDisplay()
Create a functor that tests if the pad numbers are displayed.
SELECTION_CONDITION TextFillDisplay()
Create a functor that tests if the frame fills text items.
Generic tool for picking an item.
Tool useful for viewing footprints.
static S3D_CACHE * Get3DCacheManager(PROJECT *aProject, bool updateProjDir=false)
Return a pointer to an instance of the 3D cache manager.
TOOL_MANAGER * m_toolManager
TOOL_DISPATCHER * m_toolDispatcher
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
ACTIONS * m_actions
Master controller class:
bool RunAction(const std::string &aActionName, T aParam)
Run the specified action immediately, pausing the current action to run the new one.
#define CHECK(x)
#define _(s)
Declaration of the eda_3d_viewer class.
#define FOOTPRINT_CHOOSER_FRAME_NAME
static wxRect s_dialogRect(0, 0, 0, 0)
static wxArrayString s_FootprintHistoryList
static unsigned s_FootprintHistoryMaxCount
static void AddFootprintToHistory(const wxString &aName)
@ FRAME_FOOTPRINT_CHOOSER
Definition frame_type.h:44
PROJECT & Prj()
Definition kicad.cpp:612
@ MAIL_SYMBOL_NETLIST
Definition mail_type.h:45
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition wxgtk/ui.cpp:163
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition wxgtk/ui.cpp:124
void ReparentModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition wxgtk/ui.cpp:151
see class PGM_BASE
#define DEFAULT_THEME
T * GetAppSettings(const char *aFilename)
std::vector< FAB_LAYER_COLOR > dummy
static std::vector< std::string > split(const std::string &aStr, const std::string &aDelim)
Split the input string into a vector of output strings.
Store the common settings that are saved and loaded for each window / frame.
#define PARENT_STYLE
#define MODAL_STYLE
#define kv