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 ),
98 m_boardAdapter(),
99 m_currentCamera( m_trackBallCamera ),
100 m_trackBallCamera( 2 * RANGE_SCALE_3D ),
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
134
135 // This board will only be used to hold a footprint for viewing
136 GetBoard()->SetBoardUse( BOARD_USE::FPHOLDER );
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 );
149 m_toggleDescription->SetBitmap( KiBitmapBundle( BITMAPS::text_visibility_off ) );
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 );
160 m_grButton3DView->SetBitmap( KiBitmapBundle( BITMAPS::shape_3d ) );
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 );
167 m_grButtonFpView->SetBitmap( KiBitmapBundle( BITMAPS::module ) );
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)" ),
198
199 Layout();
201
202 if( !m_showDescription )
203 {
204 m_chooserPanel->GetVerticalSpliter()->SetMinimumPaneSize( 0 );
205 m_chooserPanel->GetVerticalSpliter()->GetWindow2()->Hide();
206 m_chooserPanel->GetVerticalSpliter()->SetSashInvisible();
207
208 m_toggleDescription->SetBitmap( KiBitmapBundle( BITMAPS::text_visibility ) );
209 }
210
211 // Create the manager and dispatcher & route draw panel events to the dispatcher
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
224
225 m_toolManager->GetTool<PCB_VIEWER_TOOLS>()->SetFootprintFrame( true );
226 m_toolManager->GetTool<PCB_VIEWER_TOOLS>()->SetIsDefaultTool( true );
227
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();
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 {
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{
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{
456 FOOTPRINT_EDITOR_SETTINGS* cfg = GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>( "fpedit" );
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 wxSizer* filtersSizer = m_chooserPanel->GetFiltersSizer();
473 wxWindow* filtersWindow = filtersSizer->GetContainingWindow();
474 wxString msg;
475
476 m_pinCount = 0;
477 m_fpFilters.clear();
478
479 /*
480 * Symbol netlist format:
481 * pinNumber pinName <tab> pinNumber pinName...
482 * fpFilter fpFilter...
483 */
484 std::map<wxString, wxString> pinNames;
485 std::vector<std::string> strings = split( payload, "\r" );
486
487 if( strings.size() >= 1 && !strings[0].empty() )
488 {
489 for( const wxString& pin : wxSplit( strings[0], '\t' ) )
490 pinNames[ pin.BeforeFirst( ' ' ) ] = pin.AfterFirst( ' ' );
491
492 m_pinCount = (int) pinNames.size();
493 }
494
495 if( strings.size() >= 2 && !strings[1].empty() )
496 {
497 for( const wxString& filter : wxSplit( strings[1], ' ' ) )
498 {
499 m_fpFilters.push_back( std::make_unique<EDA_PATTERN_MATCH_WILDCARD_ANCHORED>() );
500 m_fpFilters.back()->SetPattern( filter.Lower() );
501 }
502 }
503
504 if( !m_fpFilters.empty() )
505 {
506 msg.Printf( _( "Apply footprint filters (%s)" ), strings[1] );
507
509 {
510 m_filterByFPFilters = new wxCheckBox( filtersWindow, wxID_ANY, msg );
511
512 m_filterByFPFilters->Bind( wxEVT_CHECKBOX,
513 [&]( wxCommandEvent& evt )
514 {
516 } );
517
518 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() ) )
519 m_filterByFPFilters->SetValue( cfg->m_FootprintChooser.use_fp_filters );
520
521 m_chooserPanel->GetFiltersSizer()->Add( m_filterByFPFilters, 0, wxEXPAND|wxBOTTOM, 4 );
522 }
523
524 m_filterByFPFilters->SetLabel( msg );
525 }
526 else
527 {
529 m_filterByFPFilters->Hide();
530 }
531
532 if( m_pinCount > 0 )
533 {
534 msg.Printf( _( "Filter by pin count (%d)" ), m_pinCount );
535
536 if( !m_filterByPinCount )
537 {
538 m_filterByPinCount = new wxCheckBox( filtersWindow, wxID_ANY, msg );
539
540 m_filterByPinCount->Bind( wxEVT_CHECKBOX,
541 [&]( wxCommandEvent& evt )
542 {
544 } );
545
546 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() ) )
547 m_filterByPinCount->SetValue( cfg->m_FootprintChooser.filter_on_pin_count );
548
549 m_chooserPanel->GetFiltersSizer()->Add( m_filterByPinCount, 0, wxEXPAND|wxBOTTOM, 4 );
550 }
551
552 m_filterByPinCount->SetLabel( msg );
553 }
554 else
555 {
557 m_filterByPinCount->Hide();
558 }
559
561
562 // Save the wxFormBuilder size of the dialog...
563 if( s_dialogRect.GetSize().x == 0 || s_dialogRect.GetSize().y == 0 )
564 s_dialogRect = wxRect( wxWindow::GetPosition(), wxWindow::GetSize() );
565
566 // ... and then give it a kick to get it to layout the new items
567 GetSizer()->SetSizeHints( this );
568 break;
569 }
570
571 default:
572 break;
573 }
574}
575
576
578{
579 return static_cast<FOOTPRINT_PREVIEW_PANEL*>( m_chooserPanel->GetViewerPanel()->GetPreviewPanel() )->GetCurrentFootprint();
580}
581
582
583bool FOOTPRINT_CHOOSER_FRAME::ShowModal( wxString* aFootprint, wxWindow* aParent )
584{
585 if( aFootprint && !aFootprint->IsEmpty() )
586 {
587 LIB_ID fpid;
588
589 fpid.Parse( *aFootprint, true );
590
591 if( fpid.IsValid() )
593 }
594
595 return KIWAY_PLAYER::ShowModal( aFootprint, aParent );
596}
597
598
599void FOOTPRINT_CHOOSER_FRAME::SetPosition( const wxPoint& aNewPosition )
600{
601 PCB_BASE_FRAME::SetPosition( aNewPosition );
602
603 s_dialogRect.SetPosition( aNewPosition );
604}
605
606
608{
609 bool ret;
610
611 // Show or hide the window. If hiding, save current position and size.
612 // If showing, use previous position and size.
613 if( show )
614 {
615#ifndef __WINDOWS__
616 PCB_BASE_FRAME::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
617#endif
618 ret = PCB_BASE_FRAME::Show( show );
619
620 // returns a zeroed-out default wxRect if none existed before.
621 wxRect savedDialogRect = s_dialogRect;
622
623 if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
624 {
625 SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
626 std::max( wxWindow::GetSize().x, savedDialogRect.GetSize().x ),
627 std::max( wxWindow::GetSize().y, savedDialogRect.GetSize().y ),
628 0 );
629 }
630
631 // Be sure that the dialog appears in a visible area
632 // (the dialog position might have been stored at the time when it was
633 // shown on another display)
634 if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
635 Centre();
636 }
637 else
638 {
639 s_dialogRect = wxRect( wxWindow::GetPosition(), wxWindow::GetSize() );
640 ret = PCB_BASE_FRAME::Show( show );
641 }
642
643 return ret;
644}
645
646
647void FOOTPRINT_CHOOSER_FRAME::OnPaint( wxPaintEvent& aEvent )
648{
650 {
653
654 m_firstPaintEvent = false;
655 }
656
657 aEvent.Skip();
658}
659
660
661void FOOTPRINT_CHOOSER_FRAME::OnOK( wxCommandEvent& aEvent )
662{
664
665 if( fpID.IsValid() )
666 {
667 wxString footprint = fpID.Format();
668
669 AddFootprintToHistory( footprint );
670 DismissModal( true, footprint );
671 }
672 else
673 {
674 DismissModal( false );
675 }
676}
677
678
680{
681 Close( false );
682}
683
684
685void FOOTPRINT_CHOOSER_FRAME::onFpChanged( wxCommandEvent& event )
686{
687 updateViews();
688
690}
691
692
694{
695 // initialize m_boardAdapter used by the 3D canvas
696 BOARD* dummyBoard = GetBoard();
697 m_boardAdapter.SetBoard( dummyBoard );
699 m_boardAdapter.m_IsPreviewer = true; // Force display 3D models, regardless the 3D viewer options
700
701 m_boardAdapter.m_Cfg = GetAppSettings<EDA_3D_VIEWER_SETTINGS>( "3d_viewer" );
702
703 // Build the 3D canvas
705 OGL_ATT_LIST::GetAttributesList( ANTIALIASING_MODE::AA_8X ),
708
709 m_chooserPanel->m_RightPanelSizer->Add( m_preview3DCanvas, 1, wxEXPAND, 5 );
710 m_chooserPanel->m_RightPanel->Layout();
711
712 BOARD_DESIGN_SETTINGS& dummy_bds = dummyBoard->GetDesignSettings();
713 dummy_bds.SetBoardThickness( pcbIUScale.mmToIU( 1.6 ) );
715 BOARD_STACKUP& dummy_board_stackup = dummyBoard->GetDesignSettings().GetStackupDescriptor();
716 dummy_board_stackup.RemoveAll();
717 dummy_board_stackup.BuildDefaultStackupList( &dummy_bds, 2 );
718}
719
720
722{
724
726
728
729 if( !m_showDescription )
730 {
731 m_chooserPanel->GetVerticalSpliter()->SetMinimumPaneSize( GetSize().GetHeight() );
732 m_chooserPanel->GetVerticalSpliter()->SetSashPosition(
733 GetSize().GetHeight() + m_chooserPanel->GetDetailsPanel()->GetSize().GetHeight() );
734
735 m_chooserPanel->GetVerticalSpliter()->GetWindow2()->Hide();
736 m_chooserPanel->GetVerticalSpliter()->SetSashInvisible();
737
738 m_toggleDescription->SetBitmap( KiBitmapBundle( BITMAPS::text_visibility ) );
739 }
740 else
741 {
742 m_chooserPanel->GetVerticalSpliter()->SetMinimumPaneSize( 80 );
743 m_chooserPanel->GetVerticalSpliter()->GetWindow2()->Show();
744 m_chooserPanel->GetVerticalSpliter()->SetSashInvisible( false );
745
746 m_toggleDescription->SetBitmap( KiBitmapBundle( BITMAPS::text_visibility_off ) );
747 }
748
749 m_chooserPanel->GetVerticalSpliter()->UpdateSize();
750
751 m_chooserPanel->Layout();
752 m_chooserPanel->Refresh();
753}
754
755void FOOTPRINT_CHOOSER_FRAME::on3DviewReq( wxCommandEvent& event )
756{
757 if( m_show3DMode == true )
758 {
759 if( m_showFpMode == true )
760 {
761 m_show3DMode = false;
764 }
765 }
766 else
767 {
768 if( m_show3DViewer->IsChecked() )
769 {
771 }
772 else
773 {
774 // Close 3D viewer frame, if it is still enabled
776 if( viewer3D )
777 viewer3D->Close( true );
778 }
779
780 m_show3DMode = true;
783 }
784}
785
786
787void FOOTPRINT_CHOOSER_FRAME::onFpViewReq( wxCommandEvent& event )
788{
789 if( m_showFpMode == true )
790 {
791 if( m_show3DMode == true )
792 {
793 m_showFpMode = false;
796 }
797 }
798 else
799 {
800 m_showFpMode = true;
803 }
804}
805
806
808{
810
811 if( m_preview3DCanvas->IsShown() )
812 {
815 }
816
817 if( viewer3D )
818 {
819 Update3DView( true, true );
820 }
821
822 m_chooserPanel->m_RightPanel->Layout();
823 m_chooserPanel->m_RightPanel->Refresh();
824}
825
827{
829 viewFpPanel->Show( m_showFpMode );
831
832 updateViews();
833}
834
835
837{
839
841 PCB_EDITOR_CONDITIONS cond( this );
842
843 wxASSERT( mgr );
844
845 // clang-format off
846#define CHECK( x ) ACTION_CONDITIONS().Check( x )
847
850
851 mgr->SetConditions( ACTIONS::millimetersUnits, CHECK( cond.Units( EDA_UNITS::MM ) ) );
852 mgr->SetConditions( ACTIONS::inchesUnits, CHECK( cond.Units( EDA_UNITS::INCH ) ) );
853 mgr->SetConditions( ACTIONS::milsUnits, CHECK( cond.Units( EDA_UNITS::MILS ) ) );
854
856
861
862#undef CHECK
863 // clang-format on
864}
865
866
const char * name
Definition: DXF_plotter.cpp:62
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
#define RANGE_SCALE_3D
This defines the range that all coord will have to be rendered.
Definition: board_adapter.h:66
static TOOL_ACTION toggleGrid
Definition: actions.h:195
static TOOL_ACTION millimetersUnits
Definition: actions.h:203
static TOOL_ACTION milsUnits
Definition: actions.h:202
static TOOL_ACTION inchesUnits
Definition: actions.h:201
static TOOL_ACTION toggleCursorStyle
Definition: actions.h:151
static TOOL_ACTION measureTool
Definition: actions.h:249
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.
Definition: app_settings.h:108
WINDOW_SETTINGS m_Window
Definition: app_settings.h:233
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:236
A bitmap button widget that behaves like an AUI toolbar item's button when it is drawn.
Definition: bitmap_button.h:42
void SetIsRadioButton()
bool IsChecked() const
void Check(bool aCheck=true)
Check the control.
void SetIsSeparator()
Render button as a toolbar separator.
void SetBitmap(const wxBitmapBundle &aBmp)
Set the bitmap shown when the button is enabled.
bool m_IsPreviewer
true if we're in a 3D preview panel, false for the standard 3D viewer
void SetBoard(BOARD *aBoard) noexcept
Set current board to be rendered.
EDA_3D_VIEWER_SETTINGS * m_Cfg
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:1024
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.
Definition: common_tools.h:38
Implement a canvas based on a wxGLCanvas.
Definition: eda_3d_canvas.h:51
void ReloadRequest(BOARD *aBoard=nullptr, S3D_CACHE *aCachePointer=nullptr)
void OnCloseWindow(wxCloseEvent &event)
void Request_refresh(bool aRedrawImmediately=true)
Schedule a refresh update of the canvas.
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 GridVisible()
Create a functor testing if the grid is visible in a frame.
SELECTION_CONDITION FullscreenCursor()
Create a functor testing if the cursor is full screen in a frame.
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.
virtual BOARD * GetBoard()=0
virtual EDA_DRAW_PANEL_GAL * GetCanvas()=0
Get the GAL canvas.
Panel that renders a single footprint via Cairo GAL, meant to be exported through Kiface.
void SetPinFunctions(const std::map< wxString, wxString > &aPinFunctions)
Set the pin functions from the symbol's netlist.
FOOTPRINT_PREVIEW_PANEL_BASE * GetPreviewPanel()
Carry a payload from one KIWAY_PLAYER to another within a PROJECT.
Definition: kiway_express.h:40
std::string & GetPayload()
Return the payload, which can be any text but it typically self identifying s-expression.
Definition: kiway_express.h:58
MAIL_T Command()
Returns the MAIL_T associated with this mail.
Definition: kiway_express.h:50
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...
bool IsDismissed()
void SetModal(bool aIsModal)
Definition: kiway_player.h:155
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.
enum TYPE m_Type
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.
wxWindow * GetFocusTarget() const
wxSplitterWindow * GetVerticalSpliter() const
FOOTPRINT_PREVIEW_WIDGET * GetViewerPanel() const
void SetPreselect(const LIB_ID &aPreselect)
LIB_ID GetSelectedLibId() const
To be called after this dialog returns from ShowModal().
Gather all the actions that are shared by tools.
Definition: pcb_actions.h:51
static TOOL_ACTION toggleHV45Mode
Definition: pcb_actions.h:539
static TOOL_ACTION padDisplayMode
Definition: pcb_actions.h:319
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
Definition: pcb_actions.h:511
static TOOL_ACTION textOutlines
Display texts as lines.
Definition: pcb_actions.h:514
static TOOL_ACTION showPadNumbers
Definition: pcb_actions.h:326
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
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 only 45 degree lines should be allowed.
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.
Definition: project_pcb.cpp:77
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:171
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:173
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
ACTIONS * m_actions
Definition: tools_holder.h:172
Master controller class:
Definition: tool_manager.h:62
bool RunAction(const std::string &aActionName, T aParam)
Run the specified action immediately, pausing the current action to run the new one.
Definition: tool_manager.h:150
ACTION_MANAGER * GetActionManager() const
Definition: tool_manager.h:306
void RegisterTool(TOOL_BASE *aTool)
Add a tool to the manager set and sets it up.
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, APP_SETTINGS_BASE *aSettings, TOOLS_HOLDER *aFrame)
Set the work environment (model, view, view controls and the parent window).
void InitTools()
Initialize all registered tools.
#define CHECK(x)
#define _(s)
Declaration of the eda_3d_viewer class.
#define FOOTPRINT_CHOOSER_FRAME_NAME
#define PARENT_STYLE
#define MODAL_STYLE
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:608
@ MAIL_SYMBOL_NETLIST
Definition: mail_type.h:45
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: wxgtk/ui.cpp:157
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
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.
Definition: string_utils.h:327
constexpr int mmToIU(double mm) const
Definition: base_units.h:92
Store the common settings that are saved and loaded for each window / frame.
Definition: app_settings.h:90