KiCad PCB EDA Suite
Loading...
Searching...
No Matches
gerbview_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) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * 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, see <https://www.gnu.org/licenses/>.
19 */
20
21#include <kiface_base.h>
23#include <base_units.h>
24#include <pgm_base.h>
25#include <bitmaps.h>
28#include <gerbview_frame.h>
29#include <gerbview_id.h>
30#include <gerber_file_image.h>
32#include <excellon_image.h>
34#include <gerbview_settings.h>
36#include <lset.h>
38#include <toolbars_gerber.h>
39#include <tool/tool_manager.h>
40#include <tool/action_toolbar.h>
42#include <tool/common_control.h>
43#include <tool/common_tools.h>
45#include <tool/zoom_tool.h>
51#include <trigo.h>
52#include <view/view.h>
53#include <view/view_controls.h>
54#include <base_screen.h>
55#include <gerbview_painter.h>
56#include <wx/wupdlock.h>
57
62
63#if defined(__linux__) || defined(__FreeBSD__)
65#else
67#endif
68
69#include <wx/log.h>
70
71GERBVIEW_FRAME::GERBVIEW_FRAME( KIWAY* aKiway, wxWindow* aParent ) :
72 EDA_DRAW_FRAME( aKiway, aParent, FRAME_GERBER, wxT( "GerbView" ), wxDefaultPosition,
75 m_TextInfo( nullptr ),
77 ID_GERBVIEW_ZIP_FILE_LIST_CLEAR, _( "Clear Recent Zip Files" ) ),
79 ID_GERBVIEW_DRILL_FILE_LIST_CLEAR, _( "Clear Recent Drill Files" ) ),
81 ID_GERBVIEW_JOB_FILE_LIST_CLEAR, _( "Clear Recent Job Files" ) ),
82 m_activeLayer( 0 )
83{
85 m_gerberLayout = nullptr;
87 m_showBorderAndTitleBlock = false; // true for reference drawings.
88 m_SelLayerBox = nullptr;
89 m_DCodeSelector = nullptr;
90 m_SelComponentBox = nullptr;
91 m_SelNetnameBox = nullptr;
92 m_SelAperAttributesBox = nullptr;
93 m_cmpText = nullptr;
94 m_netText = nullptr;
95 m_apertText = nullptr;
96 m_dcodeText = nullptr;
97 m_aboutTitle = _HKI( "KiCad Gerber Viewer" );
98
99 SHAPE_POLY_SET dummy; // A ugly trick to force the linker to include
100 // some methods in code and avoid link errors
101
102 int fileHistorySize = Pgm().GetCommonSettings()->m_System.file_history_size;
103 m_drillFileHistory.SetMaxFiles( fileHistorySize );
104 m_zipFileHistory.SetMaxFiles( fileHistorySize );
105 m_jobFileHistory.SetMaxFiles( fileHistorySize );
106
107 auto* galCanvas = new GERBVIEW_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
110
111 SetCanvas( galCanvas );
112
113 // GerbView requires draw priority for rendering negative objects
114 galCanvas->GetView()->UseDrawPriority( true );
115
116 // Give an icon
117 wxIcon icon;
118 wxIconBundle icon_bundle;
119
120 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview, 48 ) );
121 icon_bundle.AddIcon( icon );
122 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview, 128 ) );
123 icon_bundle.AddIcon( icon );
124 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview, 256 ) );
125 icon_bundle.AddIcon( icon );
126 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview_32 ) );
127 icon_bundle.AddIcon( icon );
128 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview_16 ) );
129 icon_bundle.AddIcon( icon );
130
131 SetIcons( icon_bundle );
132
133 // Be sure a page info is set. this default value will be overwritten later.
135 SetLayout( new GBR_LAYOUT() );
136 SetPageSettings( pageInfo );
137
138 SetVisibleLayers( LSET::AllLayersMask() ); // All draw layers visible.
139
140 SetScreen( new BASE_SCREEN( GetPageSettings().GetSizeIU( gerbIUScale.IU_PER_MILS ) ) );
141
142 // Create the PCB_LAYER_WIDGET *after* SetLayout():
144
145 // Update the minimum string length in the layer panel with the length of the last default layer
146 wxString lyrName = GetImagesList()->GetDisplayName( GetImagesList()->ImagesMaxCount(),
147 false, true );
148 m_LayersManager->SetSmallestLayerString( lyrName );
149
150 // LoadSettings() *after* creating m_LayersManager, because LoadSettings()
151 // initialize parameters in m_LayersManager
152 LoadSettings( config() );
153
154 setupTools();
157
161
162 m_auimgr.SetManagedWindow( this );
163
165
166 m_auimgr.AddPane( m_tbTopMain, EDA_PANE().HToolbar().Name( "TopMainToolbar" ).Top().Layer( 6 ) );
167 m_auimgr.AddPane( m_tbTopAux, EDA_PANE().HToolbar().Name( "TopAuxToolbar" ).Top().Layer(4) );
168 m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer( 6 ) );
169 m_auimgr.AddPane( m_tbLeft, EDA_PANE().VToolbar().Name( "LeftToolbar" ).Left().Layer( 3 ) );
170 m_auimgr.AddPane( m_LayersManager,
171 EDA_PANE().Palette().Name( "LayersManager" ).Right().Layer( 3 )
172 .Caption( _( "Layers Manager" ) ).PaneBorder( false )
173 .MinSize( FromDIP( 80 ), FromDIP( 80 ) )
174 .BestSize( m_LayersManager->GetBestSize() ) );
175
176 m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
177
178 ReFillLayerWidget(); // this is near end because contents establish size
179 m_auimgr.Update();
180
181 SetActiveLayer( 0, true );
183
185
186 setupUnits( config() );
187
188 // Enable the axes to match legacy draw style
189 auto& galOptions = GetGalDisplayOptions();
190 galOptions.m_axesEnabled = true;
191 galOptions.NotifyChanged();
192
193 m_LayersManager->ReFill();
194 m_LayersManager->ReFillRender(); // Update colors in Render after the config is read
195
196 // Drag and drop
197 // Note that all gerber files are aliased as GerberFileExtension
201 DragAcceptFiles( true );
202
204
205 // Ensure the window is on top
206 Raise();
207
208 // Register a call to update the toolbar sizes. It can't be done immediately because
209 // it seems to require some sizes calculated that aren't yet (at least on GTK).
210 CallAfter( [this]()
211 {
212 // Ensure the controls on the toolbars all are correctly sized
214 } );
215}
216
217
219{
220 // Ensure m_canvasType is up to date, to save it in config
222
223 // Shutdown all running tools
224 if( m_toolManager )
225 m_toolManager->ShutdownAllTools();
226
227 GetCanvas()->GetView()->Clear();
228
230 delete m_gerberLayout;
231}
232
233
235{
236 // No more vetos
237 m_isClosing = true;
239
240 if( m_toolManager )
241 m_toolManager->DeactivateTool();
242
243 // Be sure any OpenGL event cannot be fired after frame deletion:
244 GetCanvas()->SetEvtHandlerEnabled( false );
245
246 Destroy();
247}
248
249
250bool GERBVIEW_FRAME::OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl )
251{
252 // Ensure the frame is shown when opening the file(s), to avoid issues (crash) on GAL
253 // when trying to change the view if it is not fully initialized.
254 // It happens when starting GerbView with a gerber job file to load
255 if( !IsShownOnScreen() )
256 Show();
257
258 const unsigned limit = std::min( unsigned( aFileSet.size() ),
259 unsigned( GERBER_DRAWLAYERS_COUNT ) );
260
261 for( unsigned i = 0; i < limit; ++i )
262 {
263 wxString path = aFileSet[i];
264
265 // For some reason wxApp appears to leave the trailing double quote on quoted
266 // parameters which are required for paths with spaces. Maybe this should be
267 // pushed back into PGM_SINGLE_TOP::OnPgmInit() but that may cause other issues.
268 // We can't buy a break!
269 if( path.EndsWith( "\"" ) )
270 path.RemoveLast();
271
272 // The current project path is also a valid command parameter. Check if a path
273 // rather than a file name was passed to GerbView and use it as the initial MRU path.
274 if( i == 0 && !wxFileExists( path ) && wxDirExists( path ) )
275 {
276 m_mruPath = path;
277 return true;
278 }
279
280 wxString ext = wxFileName( path ).GetExt().Lower();
281
284 else if( ext == FILEEXT::GerberJobFileExtension )
286 else
287 {
288 GERBER_ORDER_ENUM fnameLayer;
289 wxString fnameExtensionMatched;
290
292 fnameExtensionMatched );
293
294 switch( fnameLayer )
295 {
298 break;
301 break;
302 default:
304 }
305 }
306 }
307
308 Zoom_Automatique( true ); // Zoom fit in frame
309
310 return true;
311}
312
313
315{
316 return dynamic_cast<GERBVIEW_SETTINGS*>( config() );
317}
318
319
341
342
344{
346
347 if( GERBVIEW_SETTINGS* cfg = dynamic_cast<GERBVIEW_SETTINGS*>( aCfg ) )
348 {
349 cfg->m_Appearance.page_type = GetPageSettings().GetTypeAsString();
350
351 m_drillFileHistory.Save( &cfg->m_DrillFileHistory );
352 m_zipFileHistory.Save( &cfg->m_ZipFileHistory );
353 m_jobFileHistory.Save( &cfg->m_JobFileHistory );
354 }
355
357}
358
359
361{
363 return ::GetColorSettings( cfg ? cfg->m_ColorTheme : DEFAULT_THEME );
364}
365
366
368{
369 wxWindowUpdateLocker no_update( m_LayersManager );
370
371 m_LayersManager->ReFill();
372 m_SelLayerBox->Resync();
373
374 // Re-build the various boxes in the toolbars
375 // TODO: Could this be made more precise instead of just blowing away all the toolbars?
377
378 wxAuiPaneInfo& lyrs = m_auimgr.GetPane( m_LayersManager );
379 wxSize bestz = m_LayersManager->GetBestSize();
380 bestz.x += 5; // gives a little margin
381
382 lyrs.MinSize( bestz );
383 lyrs.BestSize( bestz );
384 lyrs.FloatingSize( bestz );
385
386 if( lyrs.IsDocked() )
387 m_auimgr.Update();
388 else
389 m_LayersManager->SetSize( bestz );
390
392}
393
394
395void GERBVIEW_FRAME::SetElementVisibility( int aLayerID, bool aNewState )
396{
397 KIGFX::VIEW* view = GetCanvas()->GetView();
398
399 switch( aLayerID )
400 {
401 case LAYER_DCODES:
402 gvconfig()->m_Appearance.show_dcodes = aNewState;
403
404 for( int i = 0; i < GERBER_DRAWLAYERS_COUNT; i++ )
405 {
406 int layer = GERBER_DRAW_LAYER( i );
407 int dcode_layer = GERBER_DCODE_LAYER( layer );
408 view->SetLayerVisible( dcode_layer, aNewState && view->IsLayerVisible( layer ) );
409 }
410
411 break;
412
415
417 []( KIGFX::VIEW_ITEM* aItem )
418 {
419 GERBER_DRAW_ITEM* item = dynamic_cast<GERBER_DRAW_ITEM*>( aItem );
420
421 // GetLayerPolarity() returns true for negative items
422 return ( item && item->GetLayerPolarity() );
423 } );
424
425 break;
426
429
431
432 // NOTE: LAYER_DRAWINGSHEET always used for visibility, but the layer manager passes
433 // LAYER_GERBVIEW_DRAWINGSHEET because of independent color control
435 break;
436
438 SetGridVisibility( aNewState );
439 break;
440
444 break;
445
446 default:
447 wxFAIL_MSG( wxString::Format( wxT( "GERBVIEW_FRAME::SetElementVisibility(): bad arg %d" ),
448 aLayerID ) );
449 }
450
452 m_LayersManager->SetRenderState( aLayerID, aNewState );
453}
454
455
457{
458 auto painter = static_cast<KIGFX::GERBVIEW_PAINTER*>( GetCanvas()->GetView()->GetPainter() );
459 KIGFX::GERBVIEW_RENDER_SETTINGS* settings = painter->GetSettings();
460 settings->SetContrastMode( gvconfig()->m_Display.m_InactiveLayerMode );
461 settings->LoadColors( GetColorSettings() );
462
464}
465
466
468{
469 for( int i = 0; i < (int) ImagesMaxCount(); ++i )
470 {
471 const GERBER_FILE_IMAGE* gerber = GetGbrImage( i );
472
473 if( gerber == nullptr ) // this graphic layer is available: use it
474 return i;
475 }
476
477 return NO_AVAILABLE_LAYERS;
478}
479
480
482{
483 m_LayersManager->SelectLayer( GetActiveLayer() );
484}
485
486
487void GERBVIEW_FRAME::syncLayerBox( bool aRebuildLayerBox )
488{
489 if( aRebuildLayerBox )
490 m_SelLayerBox->Resync();
491
492 m_SelLayerBox->SetSelection( GetActiveLayer() );
493
494 int dcodeSelected = -1;
496
497 if( gerber )
498 dcodeSelected = gerber->m_Selected_Tool;
499
500 if( m_DCodeSelector )
501 {
503 m_DCodeSelector->SetDCodeSelection( dcodeSelected );
504 m_DCodeSelector->Enable( gerber != nullptr );
505 }
506}
507
508
510{
511 RemapLayers( GetImagesList()->SortImagesByFileExtension() );
512}
513
514
516{
517 RemapLayers( GetImagesList()->SortImagesByZOrder() );
518}
519
520
521void GERBVIEW_FRAME::RemapLayers( const std::unordered_map<int, int>& remapping )
522{
523 // Save the visibility of each existing gerber layer, in order to be able
524 // to restore this visibility after layer reorder.
525 // Note: the visibility of other objects (D_CODE, negative objects ... )
526 // must be not modified
527 for( int currlayer = GERBER_DRAWLAYERS_COUNT-1; currlayer >= 0; --currlayer )
528 {
529 GERBER_FILE_IMAGE* gerber = GetImagesList()->GetGbrImage( currlayer );
530
531 if( gerber )
532 {
533 if( IsLayerVisible( currlayer ) )
534 gerber->SetFlags( CANDIDATE );
535 else
536 gerber->ClearFlags( CANDIDATE );
537 }
538
539 }
540
541 std::unordered_map<int, int> view_remapping;
542
543 for( const std::pair<const int, int>& entry : remapping )
544 {
545 // GERBER_DCODE_LAYER() takes a draw layer id, not a graphic layer index, the same way
546 // GERBER_DRAW_ITEM::ViewGetLayers() builds it
547 int from = GERBER_DRAW_LAYER( entry.first );
548 int to = GERBER_DRAW_LAYER( entry.second );
549
550 view_remapping[from] = to;
551 view_remapping[GERBER_DCODE_LAYER( from )] = GERBER_DCODE_LAYER( to );
552 }
553
554 GetCanvas()->GetView()->ReorderLayerData( view_remapping );
555
556 // Restore visibility of gerber layers
557 LSET newVisibility = GetVisibleLayers();
558
559 for( int currlayer = GERBER_DRAWLAYERS_COUNT-1; currlayer >= 0; --currlayer )
560 {
561 GERBER_FILE_IMAGE* gerber = GetImagesList()->GetGbrImage( currlayer );
562
563 if( gerber )
564 {
565 if( gerber->HasFlag( CANDIDATE ) )
566 newVisibility.set( currlayer );
567 else
568 newVisibility.set( currlayer, false );
569
570 gerber->ClearFlags( CANDIDATE );
571 }
572 }
573
574 SetVisibleLayers( newVisibility );
575
577 syncLayerBox( true );
578
579 // Reordering draw layers need updating the view items
583
584 GetCanvas()->Refresh();
585}
586
587
589{
590 // Adjust draw params: draw offset and draw rotation for a gerber file image
592
593 if( !gerber )
594 return;
595
596 DIALOG_DRAW_LAYERS_SETTINGS dlg( this );
597
598 if( dlg.ShowModal() != wxID_OK )
599 return;
600
601 KIGFX::VIEW* view = GetCanvas()->GetView();
602
603 view->RecacheAllItems();
604 view->MarkDirty();
605 view->UpdateAllItems( KIGFX::ALL );
606
607 GetCanvas()->Refresh();
608}
609
610
612{
616 KIGFX::VIEW* view = GetCanvas()->GetView();
617
618 int lastVisibleLayer = -1;
619
620 for( int i = 0; i < GERBER_DRAWLAYERS_COUNT; i++ )
621 {
622 view->SetLayerDiff( GERBER_DRAW_LAYER( i ), gvconfig()->m_Display.m_XORMode );
623
624 // Caching doesn't work with layered rendering of XOR'd layers
625 if( gvconfig()->m_Display.m_XORMode )
627 else
628 view->SetLayerTarget( GERBER_DRAW_LAYER( i ), target );
629
630 // We want the last visible layer, but deprioritize the active layer unless it's the
631 // only layer. We must check visibility first to avoid selecting hidden layers.
632 if( view->IsLayerVisible( GERBER_DRAW_LAYER( i ) ) )
633 {
634 if( lastVisibleLayer == -1 || i != GetActiveLayer() )
635 lastVisibleLayer = i;
636 }
637 }
638
639 // We don't want to diff the last visible layer onto the background, etc.
640 // In XOR mode, we must keep TARGET_NONCACHED for all layers including the last one.
641 // This is because OpenGL's cached items are flushed at the end of the frame, which
642 // occurs after XOR compositing. If we used TARGET_CACHED for the last layer, its
643 // items would be drawn on top of the XOR result instead of being included in the
644 // XOR calculation.
645 if( lastVisibleLayer != -1 )
646 {
647 if( gvconfig()->m_Display.m_XORMode )
648 view->SetLayerTarget( GERBER_DRAW_LAYER( lastVisibleLayer ), KIGFX::TARGET_NONCACHED );
649 else
650 view->SetLayerTarget( GERBER_DRAW_LAYER( lastVisibleLayer ), target );
651
652 view->SetLayerDiff( GERBER_DRAW_LAYER( lastVisibleLayer ), false );
653 }
654
655 view->RecacheAllItems();
656 view->MarkDirty();
657 view->UpdateAllItems( KIGFX::ALL );
658}
659
660
662{
664
665 // Display the gerber filename
666 if( gerber == nullptr )
667 {
668 SetTitle( _("Gerber Viewer") );
669
670 SetStatusText( wxEmptyString, 0 );
671
672 wxString info = _( "Drawing layer not in use" );
673 m_TextInfo->SetValue( info );
674
675 if( KIUI::EnsureTextCtrlWidth( m_TextInfo, &info ) ) // Resized
676 m_auimgr.Update();
677
679 return;
680 }
681 else
682 {
683 wxString title;
684 wxFileName filename( gerber->m_FileName );
685
686 title = filename.GetFullName();
687
688 if( gerber->m_IsX2_file )
689 title += wxS( " " ) + _( "(with X2 attributes)" );
690
691 title += wxT( " \u2014 " ) + _( "Gerber Viewer" );
692 SetTitle( title );
693
694 gerber->DisplayImageInfo( this );
695
696 // Display Image Name and Layer Name (from the current gerber data):
697 wxString status;
698 status.Printf( _( "Image name: '%s' Layer name: '%s'" ),
699 gerber->m_ImageName,
700 gerber->GetLayerParams().m_LayerName );
701 SetStatusText( status, 0 );
702
703 // Display data format like fmt in X3.4Y3.4 no LZ or fmt mm X2.3 Y3.5 no TZ in main toolbar
704 wxString info;
705 info.Printf( wxT( "fmt: %s X%d.%d Y%d.%d no %cZ" ),
706 gerber->m_GerbMetric ? wxT( "mm" ) : wxT( "in" ),
707 gerber->m_FmtLen.x - gerber->m_FmtScale.x,
708 gerber->m_FmtScale.x,
709 gerber->m_FmtLen.y - gerber->m_FmtScale.y,
710 gerber->m_FmtScale.y,
711 gerber->m_NoTrailingZeros ? 'T' : 'L' );
712
713 if( gerber->m_IsX2_file )
714 info << wxT(" ") << _( "X2 attr" );
715
716 m_TextInfo->SetValue( info );
717
718 if( KIUI::EnsureTextCtrlWidth( m_TextInfo, &info ) ) // Resized
719 m_auimgr.Update();
720 }
721}
722
723
724bool GERBVIEW_FRAME::IsElementVisible( int aLayerID ) const
725{
726 switch( aLayerID )
727 {
733 case LAYER_GERBVIEW_BACKGROUND: return true;
734
735 default:
736 wxFAIL_MSG( wxString::Format( wxT( "GERBVIEW_FRAME::IsElementVisible(): bad arg %d" ), aLayerID ) );
737 }
738
739 return true;
740}
741
742
744{
745 LSET visible = LSET::AllLayersMask();
746
747 if( GetCanvas() )
748 {
749 for( int i = 0; i < GERBER_DRAWLAYERS_COUNT; i++ )
750 visible[i] = GetCanvas()->GetView()->IsLayerVisible( GERBER_DRAW_LAYER( i ) );
751 }
752
753 return visible;
754}
755
756
757void GERBVIEW_FRAME::SetVisibleLayers( const LSET& aLayerMask )
758{
759 if( GetCanvas() )
760 {
761 for( int i = 0; i < GERBER_DRAWLAYERS_COUNT; i++ )
762 {
763 bool v = aLayerMask[i];
764 int layer = GERBER_DRAW_LAYER( i );
765 GetCanvas()->GetView()->SetLayerVisible( layer, v );
767 gvconfig()->m_Appearance.show_dcodes && v );
768 }
769 }
770
771 if( gvconfig()->m_Display.m_XORMode )
773}
774
775
776bool GERBVIEW_FRAME::IsLayerVisible( int aLayer ) const
777{
778 return m_LayersManager->IsLayerVisible( aLayer );
779}
780
781
783{
785 COLOR_SETTINGS* settings = GetColorSettings();
786
787 switch( aLayerID )
788 {
790 case LAYER_DCODES:
794 color = settings->GetColor( aLayerID );
795 break;
796
798 color = GetGridColor();
799 break;
800
801 default:
802 wxFAIL_MSG( wxString::Format( wxT( "GERBVIEW_FRAME::GetVisibleElementColor(): bad arg %d" ),
803 aLayerID ) );
804 }
805
806 return color;
807}
808
809
811{
813 m_LayersManager->SetRenderState( LAYER_GERBVIEW_GRID, aVisible );
814}
815
816
817void GERBVIEW_FRAME::SetVisibleElementColor( int aLayerID, const COLOR4D& aColor )
818{
819 COLOR_SETTINGS* settings = GetColorSettings();
820
821 settings->SetColor( aLayerID, aColor );
822
823 switch( aLayerID )
824 {
828 break;
829
831 SetGridColor( aColor );
832 break;
833
835 SetDrawBgColor( aColor );
836 break;
837
838 default:
839 break;
840 }
841}
842
843
845{
846 return GetColorSettings()->GetColor( aLayer );
847}
848
849
850void GERBVIEW_FRAME::SetLayerColor( int aLayer, const COLOR4D& aColor )
851{
852 GetColorSettings()->SetColor( aLayer, aColor );
854}
855
856
857void GERBVIEW_FRAME::SetActiveLayer( int aLayer, bool doLayerWidgetUpdate )
858{
859 m_activeLayer = aLayer;
860
861 if( gvconfig()->m_Display.m_XORMode )
863
864 if( doLayerWidgetUpdate )
865 {
866 m_LayersManager->SelectLayer( aLayer );
867 m_LayersManager->OnLayerSelected();
868 }
869
871
872 m_toolManager->PostAction( GERBVIEW_ACTIONS::layerChanged ); // notify other tools
873 GetCanvas()->SetFocus(); // otherwise hotkeys are stuck somewhere
874
876 GetCanvas()->Refresh();
877}
878
879
880void GERBVIEW_FRAME::SetPageSettings( const PAGE_INFO& aPageSettings )
881{
882 m_paper = aPageSettings;
883
884 if( GetScreen() )
885 GetScreen()->InitDataPoints( aPageSettings.GetSizeIU( gerbIUScale.IU_PER_MILS ) );
886
887 GERBVIEW_DRAW_PANEL_GAL* drawPanel = static_cast<GERBVIEW_DRAW_PANEL_GAL*>( GetCanvas() );
888
889 // Prepare drawing-sheet template
891 &Prj(), &GetTitleBlock(), nullptr );
892
893 if( GetScreen() )
894 {
895 drawingSheet->SetPageNumber( "1" );
896 drawingSheet->SetSheetCount( 1 );
897 }
898
901
902 // Draw panel takes ownership of the drawing-sheet
903 drawPanel->SetDrawingSheet( drawingSheet );
904}
905
906
908{
909 return m_paper;
910}
911
912
914{
915 // this function is only needed because EDA_DRAW_FRAME is not compiled
916 // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
917 // into an application specific source file.
918 return GetPageSettings().GetSizeIU( gerbIUScale.IU_PER_MILS );
919}
920
921
923{
924 wxASSERT( m_gerberLayout );
925 return m_gerberLayout->GetTitleBlock();
926}
927
928
930{
931 wxASSERT( m_gerberLayout );
932 m_gerberLayout->SetTitleBlock( aTitleBlock );
933}
934
935
940
941
943{
945 GetCanvas()->GetGAL()->SetGridColor( aColor );
946 m_gridColor = aColor;
947}
948
949
951{
952 VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
953 wxString line;
954
955 line.Printf( wxT( "grid X %s Y %s" ),
956 MessageTextFromValue( gridSize.x, false ),
957 MessageTextFromValue( gridSize.y, false ) );
958
959 SetStatusText( line, 4 );
960 SetStatusText( line, 4 );
961}
962
963
965{
967
968 if( !GetScreen() )
969 return;
970
971 wxString line;
973
974 if( GetShowPolarCoords() ) // display relative polar coordinates
975 {
976 VECTOR2D v = cursorPos - GetScreen()->m_LocalOrigin;
977 EDA_ANGLE theta( VECTOR2D( v.x, -v.y ) );
978 double ro = hypot( v.x, v.y );
979
980 line.Printf( wxT( "r %s theta %s" ),
981 MessageTextFromValue( ro, false ),
982 MessageTextFromValue( theta, false ) );
983
984 SetStatusText( line, 3 );
985 }
986
987 // Display absolute coordinates:
988 line.Printf( wxT( "X %s Y %s" ),
989 MessageTextFromValue( cursorPos.x, false ),
990 MessageTextFromValue( cursorPos.y, false ) );
991 SetStatusText( line, 2 );
992
993 if( !GetShowPolarCoords() )
994 {
995 // Display relative cartesian coordinates:
996 double dXpos = cursorPos.x - GetScreen()->m_LocalOrigin.x;
997 double dYpos = cursorPos.y - GetScreen()->m_LocalOrigin.y;
998
999 line.Printf( wxT( "dx %s dy %s dist %s" ),
1000 MessageTextFromValue( dXpos, false ),
1001 MessageTextFromValue( dYpos,false ),
1002 MessageTextFromValue( hypot( dXpos, dYpos ), false ) );
1003 SetStatusText( line, 3 );
1004 }
1005
1007}
1008
1009
1011{
1012 return m_gerberLayout->GetImagesList()->GetGbrImage( aIdx );
1013}
1014
1015
1017{
1018 return m_gerberLayout->GetImagesList()->ImagesMaxCount();
1019}
1020
1021
1023{
1024 // Called on units change (see EDA_DRAW_FRAME)
1028}
1029
1030
1032{
1034
1035 EDA_DRAW_PANEL_GAL* galCanvas = GetCanvas();
1036
1037 if( m_toolManager )
1038 {
1039 m_toolManager->SetEnvironment( m_gerberLayout, GetCanvas()->GetView(),
1040 GetCanvas()->GetViewControls(), config(), this );
1041 m_toolManager->ResetTools( TOOL_BASE::GAL_SWITCH );
1042 }
1043
1045
1047
1048 galCanvas->GetView()->RecacheAllItems();
1050 galCanvas->StartDrawing();
1051
1052 m_LayersManager->ReFill();
1053 m_LayersManager->ReFillRender();
1054
1057
1058 try
1059 {
1060 if( !m_spaceMouse )
1061 {
1062#if defined(__linux__) || defined(__FreeBSD__)
1063 m_spaceMouse = std::make_unique<SPNAV_2D_PLUGIN>( galCanvas );
1064 m_spaceMouse->SetScale( gerbIUScale.IU_PER_MILS / pcbIUScale.IU_PER_MILS );
1065#else
1066 m_spaceMouse = std::make_unique<NL_GERBVIEW_PLUGIN>();
1067#endif
1068 }
1069
1070 m_spaceMouse->SetCanvas( galCanvas );
1071 }
1072 catch( const std::exception& e )
1073 {
1074 wxLogTrace( wxT( "KI_TRACE_NAVLIB" ), wxS( "%s" ), e.what() );
1075 }
1076 catch( ... )
1077 {
1078 wxLogTrace( wxT( "KI_TRACE_NAVLIB" ),
1079 wxT( "Unknown exception during SpaceMouse initialization" ) );
1080 }
1081}
1082
1083
1085{
1086 // Create the manager and dispatcher & route draw panel events to the dispatcher
1088 m_toolManager->SetEnvironment( m_gerberLayout, GetCanvas()->GetView(),
1089 GetCanvas()->GetViewControls(), config(), this );
1092
1093 // Register tools
1094 m_toolManager->RegisterTool( new COMMON_CONTROL );
1095 m_toolManager->RegisterTool( new COMMON_TOOLS );
1096 m_toolManager->RegisterTool( new GERBVIEW_SELECTION_TOOL );
1097 m_toolManager->RegisterTool( new GERBVIEW_CONTROL );
1098 m_toolManager->RegisterTool( new GERBVIEW_INSPECTION_TOOL );
1099 m_toolManager->RegisterTool( new ZOOM_TOOL );
1100 m_toolManager->InitTools();
1101
1102 // Run the selection tool, it is supposed to be always active
1103 m_toolManager->InvokeTool( "common.InteractiveSelection" );
1104}
1105
1106
1108{
1110
1111 ACTION_MANAGER* mgr = m_toolManager->GetActionManager();
1112 EDITOR_CONDITIONS cond( this );
1113
1114 wxASSERT( mgr );
1115
1116#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
1117#define CHECK( x ) ACTION_CONDITIONS().Check( x )
1118
1122
1128
1129 auto flashedDisplayOutlinesCond =
1130 [this] ( const SELECTION& )
1131 {
1133 };
1134
1135 auto linesFillCond =
1136 [this] ( const SELECTION& )
1137 {
1139 };
1140
1141 auto polygonsFilledCond =
1142 [this] ( const SELECTION& )
1143 {
1145 };
1146
1147 auto negativeObjectsCond =
1148 [this] ( const SELECTION& )
1149 {
1151 };
1152
1153 auto dcodeCond =
1154 [this] ( const SELECTION& )
1155 {
1157 };
1158
1159 auto forceOpacityModeCond =
1160 [this] ( const SELECTION& )
1161 {
1163 };
1164
1165 auto xorModeCond =
1166 [this] ( const SELECTION& )
1167 {
1168 return gvconfig()->m_Display.m_XORMode;
1169 };
1170
1171 auto highContrastModeCond =
1172 [this] ( const SELECTION& )
1173 {
1175 };
1176
1177 auto showInactiveLayersCond =
1178 [this] ( const SELECTION& )
1179 {
1181 };
1182
1183 auto dimInactiveLayersCond =
1184 [this] ( const SELECTION& )
1185 {
1187 };
1188
1189 auto hideInactiveLayersCond =
1190 [this] ( const SELECTION& )
1191 {
1193 };
1194
1195 auto flipGerberCond =
1196 [this] ( const SELECTION& )
1197 {
1199 };
1200
1201 auto layersManagerShownCondition =
1202 [this] ( const SELECTION& aSel )
1203 {
1205 };
1206
1207 mgr->SetConditions( GERBVIEW_ACTIONS::flashedDisplayOutlines, CHECK( flashedDisplayOutlinesCond ) );
1209 mgr->SetConditions( GERBVIEW_ACTIONS::polygonsDisplayOutlines, CHECK( polygonsFilledCond ) );
1210 mgr->SetConditions( GERBVIEW_ACTIONS::negativeObjectDisplay, CHECK( negativeObjectsCond ) );
1212 mgr->SetConditions( GERBVIEW_ACTIONS::toggleForceOpacityMode, CHECK( forceOpacityModeCond ) );
1213 mgr->SetConditions( GERBVIEW_ACTIONS::toggleXORMode, CHECK( xorModeCond ) );
1214 mgr->SetConditions( GERBVIEW_ACTIONS::flipGerberView, CHECK( flipGerberCond ) );
1215 mgr->SetConditions( ACTIONS::highContrastMode, CHECK( highContrastModeCond ) );
1216 mgr->SetConditions( GERBVIEW_ACTIONS::showInactiveLayers, CHECK( showInactiveLayersCond ) );
1217 mgr->SetConditions( GERBVIEW_ACTIONS::dimInactiveLayers, CHECK( dimInactiveLayersCond ) );
1218 mgr->SetConditions( GERBVIEW_ACTIONS::hideInactiveLayers, CHECK( hideInactiveLayersCond ) );
1219 mgr->SetConditions( GERBVIEW_ACTIONS::toggleLayerManager, CHECK( layersManagerShownCondition ) );
1220
1221#undef CHECK
1222#undef ENABLE
1223}
1224
1225
1227{
1229
1230 // Update gal display options like cursor shape, grid options:
1231 if( GERBVIEW_SETTINGS* cfg = GetAppSettings<GERBVIEW_SETTINGS>( "gerbview" ) )
1232 {
1233 GetGalDisplayOptions().ReadWindowSettings( cfg->m_Window );
1234
1235 PAGE_INFO pgInfo;
1236 pgInfo.SetType( cfg->m_Appearance.page_type );
1237
1238 SetPageSettings( pgInfo );
1239 SetElementVisibility( LAYER_DCODES, cfg->m_Appearance.show_dcodes );
1240 }
1241
1243
1247
1249 ReFillLayerWidget(); // Update the layers list
1250 m_LayersManager->ReFillRender(); // Update colors in Render after the config is read
1251
1252 Layout();
1253 SendSizeEvent();
1254}
1255
1256
1258{
1259 return m_toolManager->GetTool<GERBVIEW_SELECTION_TOOL>()->GetSelection();
1260}
1261
1262
1264{
1266
1267 // show/hide auxiliary Vertical layers and visibility manager toolbar
1268 m_auimgr.GetPane( "LayersManager" ).Show( m_show_layer_manager_tools );
1269 m_auimgr.Update();
1270}
1271
1272void GERBVIEW_FRAME::handleActivateEvent( wxActivateEvent& aEvent )
1273{
1275
1276 if( m_spaceMouse )
1277 m_spaceMouse->SetFocus( aEvent.GetActive() );
1278}
1279
1280void GERBVIEW_FRAME::handleIconizeEvent( wxIconizeEvent& aEvent )
1281{
1283
1284 if( m_spaceMouse )
1285 m_spaceMouse->SetFocus( false );
1286}
BASE_SCREEN class implementation.
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:128
constexpr EDA_IU_SCALE gerbIUScale
Definition base_units.h:127
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition bitmap.cpp:100
@ icon_gerbview_16
@ icon_gerbview_32
static TOOL_ACTION toggleGrid
Definition actions.h:194
static TOOL_ACTION cursorSmallCrosshairs
Definition actions.h:148
static TOOL_ACTION togglePolarCoords
Definition actions.h:205
static TOOL_ACTION highContrastMode
Definition actions.h:151
static TOOL_ACTION measureTool
Definition actions.h:248
static TOOL_ACTION selectionTool
Definition actions.h:247
static TOOL_ACTION zoomFitScreen
Definition actions.h:138
static TOOL_ACTION zoomTool
Definition actions.h:142
static TOOL_ACTION cursor45Crosshairs
Definition actions.h:150
static TOOL_ACTION cursorFullCrosshairs
Definition actions.h:149
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.
Handles how to draw a screen (a board, a schematic ...)
Definition base_screen.h:37
VECTOR2D m_LocalOrigin
Relative Screen cursor coordinate (on grid) in user units.
Definition base_screen.h:86
void InitDataPoints(const VECTOR2I &aPageSizeInternalUnits)
BASE_SET & set(size_t pos)
Definition base_set.h:126
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
Definition color4d.h:400
Color settings are a bit different than most of the settings objects in that there can be more than o...
void SetColor(int aLayer, const COLOR4D &aColor)
COLOR4D GetColor(int aLayer) const
Handle actions that are shared between different applications.
Handles action that are shared between different applications.
int ShowModal() override
void SetSheetCount(int aSheetCount)
Change the sheet-count number displayed in the title block.
void SetPageNumber(const std::string &aPageNumber)
Change the page number displayed in the title block.
void SetPageBorderColorLayer(int aLayerId)
Override the layer used to pick the color of the page border (normally LAYER_GRID)
void SetColorLayer(int aLayerId)
Can be used to override which layer ID is used for drawing sheet item colors.
virtual APP_SETTINGS_BASE * config() const
Return the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
virtual void handleIconizeEvent(wxIconizeEvent &aEvent)
Handle a window iconize event.
virtual void UpdateToolbarControlSizes()
Update the sizes of any controls in the toolbars of the frame.
TOOLBAR_SETTINGS * m_toolbarSettings
wxAuiManager m_auimgr
virtual void RecreateToolbars()
ACTION_TOOLBAR * m_tbLeft
ACTION_TOOLBAR * m_tbTopAux
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
Associate file extensions with action to execute.
ACTION_TOOLBAR * m_tbTopMain
wxString m_aboutTitle
bool m_isClosing
Set by the close window event handler after frames are asked if they can close.
void ReCreateMenuBar()
Recreate the menu bar.
virtual void ClearMsgPanel()
Clear all messages from the message panel.
virtual void ActivateGalCanvas()
Use to start up the GAL drawing canvas.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
The current canvas type.
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
void setupUnits(APP_SETTINGS_BASE *aCfg)
void UpdateGridSelectBox()
Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes,...
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
GAL_DISPLAY_OPTIONS_IMPL & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
virtual void resolveCanvasType()
Determine the canvas type to load (with prompt if required) and initializes m_canvasType.
EDA_MSG_PANEL * m_messagePanel
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
virtual void SetScreen(BASE_SCREEN *aScreen)
EDA_DRAW_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName, const EDA_IU_SCALE &aIuScale)
virtual void Zoom_Automatique(bool aWarpPointer)
Redraw the screen with best zoom level and the best centering that shows all the page or the board.
virtual void SetGridVisibility(bool aVisible)
virtual void handleActivateEvent(wxActivateEvent &aEvent)
Handle a window activation event.
virtual void SetDrawBgColor(const COLOR4D &aColor)
void UpdateStatusBar() override
Update the status bar information.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void CommonSettingsChanged(int aFlags) override
Notification event that some of the common (suite-wide) settings have changed.
bool m_showBorderAndTitleBlock
bool GetShowPolarCoords() const
For those frames that support polar coordinates.
GAL_TYPE GetBackend() const
Return the type of backend currently used by GAL canvas.
virtual void SetHighContrastLayer(int aLayer)
Take care of display settings for the given layer to be displayed in high contrast mode.
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the KIGFX::VIEW_CONTROLS instance used in the panel.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the KIGFX::VIEW instance used in the panel.
void ForceRefresh()
Force a redraw.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
@ GAL_TYPE_OPENGL
OpenGL implementation.
@ GAL_TYPE_NONE
GAL not used (the legacy wxDC engine is used)
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
void SetFocus() override
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
void StartDrawing()
Begin drawing if it was stopped previously.
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition eda_item.h:158
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition eda_item.h:160
bool HasFlag(EDA_ITEM_FLAGS aFlag) const
Definition eda_item.h:168
Specialization of the wxAuiPaneInfo class for KiCad panels.
Class that groups generic conditions for editor states.
SELECTION_CONDITION CurrentTool(const TOOL_ACTION &aTool)
Create a functor testing if the specified tool is the current active tool in the frame.
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 PolarCoordinates()
Create a functor testing if polar coordinates are current being used.
SELECTION_CONDITION Cursor45Crosshairs()
SELECTION_CONDITION CursorFullCrosshairs()
void ReadWindowSettings(WINDOW_SETTINGS &aCfg)
Read GAL config options from application-level config.
bool m_DisplayFlashedItemsFill
Option to draw flashed items (filled/sketch)
GBR_INACTIVE_LAYER_MODE m_InactiveLayerMode
How inactive layers are displayed.
bool m_XORMode
Display layers in exclusive-or mode.
bool m_FlipGerberView
Display as a mirror image.
bool m_ForceOpacityMode
Display layers in transparency (alpha channel) forced mode.
bool m_DisplayPolygonsFill
Option to draw polygons (filled/sketch)
bool m_DisplayLinesFill
Option to draw line items (filled/sketch)
A list of GERBER_DRAW_ITEM objects currently loaded.
Definition gbr_layout.h:42
GERBER_FILE_IMAGE_LIST * GetImagesList() const
bool GetLayerPolarity() const
static void GetGerberLayerFromFilename(const wxString &filename, enum GERBER_ORDER_ENUM &order, wxString &matchedExtension)
Utility function to guess which PCB layer of a gerber/drill file corresponds to based on its file ext...
const wxString GetDisplayName(int aIdx, bool aNameOnly=false, bool aFullName=false)
Get the display name for the layer at aIdx.
void DeleteAllImages()
Remove all loaded data in list, and delete all images, freeing the memory.
GERBER_FILE_IMAGE * GetGbrImage(int aIdx)
Hold the image data and parameters for one gerber file and layer parameters.
wxSize m_FmtScale
Fmt 2.3: m_FmtScale = 3, fmt 3.4: m_FmtScale = 4.
wxString m_FileName
Full File Name for this layer.
wxString m_ImageName
Image name, from IN <name>* command.
bool m_IsX2_file
True if a X2 gerber attribute was found in file.
wxSize m_FmtLen
Nb chars per coord. ex fmt 2.3, m_FmtLen = 5.
bool m_GerbMetric
false = Inches, true = metric
bool m_NoTrailingZeros
true: remove tailing zeros.
GERBER_LAYER & GetLayerParams()
void DisplayImageInfo(GERBVIEW_FRAME *aMainFrame)
Display information about image parameters in the status bar.
Abstract functions of LAYER_WIDGET so they may be tied into the GERBVIEW_FRAME's data and we can add ...
Gather all the actions that are shared by tools.
static TOOL_ACTION dcodeDisplay
static TOOL_ACTION negativeObjectDisplay
static TOOL_ACTION flashedDisplayOutlines
static TOOL_ACTION toggleXORMode
static TOOL_ACTION loadZipFile
static TOOL_ACTION toggleLayerManager
static TOOL_ACTION showInactiveLayers
static TOOL_ACTION flipGerberView
static TOOL_ACTION toggleForceOpacityMode
static TOOL_ACTION dimInactiveLayers
static TOOL_ACTION linesDisplayOutlines
static TOOL_ACTION polygonsDisplayOutlines
static TOOL_ACTION layerChanged
static TOOL_ACTION loadGerbFiles
static TOOL_ACTION hideInactiveLayers
Handle actions that are shared between different frames in Pcbnew.
void SetDrawingSheet(DS_PROXY_VIEW_ITEM *aDrawingSheet)
Set or update the drawing-sheet (borders and title block) used by the draw panel.
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Returns a pointer to the active color theme settings.
void SetLayerColor(int aLayer, const COLOR4D &aColor)
wxStaticText * m_dcodeText
wxChoice * m_SelAperAttributesBox
void UpdateXORLayers()
Update each layers' differential option.
void UpdateStatusBar() override
Update the status bar information.
void configureToolbars() override
COLOR4D GetVisibleElementColor(int aLayerID)
Return the color of a gerber visible element.
GERBVIEW_SETTINGS * gvconfig() const
const PAGE_INFO & GetPageSettings() const override
bool IsLayerVisible(int aLayer) const
Test whether a given layer is visible.
void DisplayGridMsg() override
Display the current grid pane on the status bar.
void SortLayersByX2Attributes()
void SetLayout(GBR_LAYOUT *aLayout)
Set the m_gerberLayout member in such as way as to ensure deleting any previous GBR_LAYOUT.
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
GBR_LAYER_BOX_SELECTOR * m_SelLayerBox
bool m_show_layer_manager_tools
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
GBR_LAYOUT * m_gerberLayout
void SetPageSettings(const PAGE_INFO &aPageSettings) override
void ApplyDisplaySettingsToGAL()
Updates the GAL with display settings changes.
bool LoadGerberJobFile(const wxString &aFileName)
Load a Gerber job file, and load gerber files found in job files.
wxStaticText * m_cmpText
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
void syncLayerBox(bool aRebuildLayerBox=false)
Update the currently "selected" layer within m_SelLayerBox.
GBR_LAYOUT * GetGerberLayout() const
bool LoadGerberFiles(const wxString &aFileName)
Load a given Gerber file or selected file(s), if the filename is empty.
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock) override
void doCloseWindow() override
wxChoice * m_SelComponentBox
FILE_HISTORY m_jobFileHistory
std::unique_ptr< NL_GERBVIEW_PLUGIN > m_spaceMouse
wxChoice * m_SelNetnameBox
bool LoadZipArchiveFile(const wxString &aFileName, const wxArrayString *aMembers=nullptr)
Load a zipped archive file.
int GetActiveLayer() const
Return the active layer.
wxTextCtrl * m_TextInfo
bool IsElementVisible(int aLayerID) const
Test whether a given element category is visible.
DCODE_SELECTION_BOX * m_DCodeSelector
GERBER_LAYER_WIDGET * m_LayersManager
void SetActiveLayer(int aLayer, bool doLayerWidgetUpdate=true)
change the currently active layer to aLayer and update the GERBER_LAYER_WIDGET.
wxStaticText * m_netText
void SetVisibleLayers(const LSET &aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
void syncLayerWidget()
Update the currently "selected" layer within the GERBER_LAYER_WIDGET.
void SetVisibleElementColor(int aLayerID, const COLOR4D &aColor)
GERBVIEW_FRAME(KIWAY *aKiway, wxWindow *aParent)
unsigned ImagesMaxCount() const
The max number of file images.
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
wxStaticText * m_apertText
COLOR4D GetLayerColor(int aLayer) const
void SortLayersByFileExtension()
GERBER_FILE_IMAGE * GetGbrImage(int aIdx) const
void handleActivateEvent(wxActivateEvent &aEvent) override
Handle a window activation event.
void SetGridVisibility(bool aVisible) override
void CommonSettingsChanged(int aFlags) override
Called after the preferences dialog is run.
const TITLE_BLOCK & GetTitleBlock() const override
bool LoadAutodetectedFiles(const wxString &aFileName)
Load a given file or selected file(s), if the filename is empty.
void RemapLayers(const std::unordered_map< int, int > &remapping)
Takes a layer remapping and reorders the layers.
void ReFillLayerWidget()
Change out all the layers in m_Layers; called upon loading new gerber files.
FILE_HISTORY m_zipFileHistory
bool OpenProjectFiles(const std::vector< wxString > &aFileSet, int aCtl) override
Open a project or set of files given by aFileList.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
int getNextAvailableLayer() const
Find the next empty layer.
void UpdateTitleAndInfo()
Display the short filename (if exists) of the selected layer on the caption of the main GerbView wind...
void SetElementVisibility(int aLayerID, bool aNewState)
Change the visibility of an element category.
virtual void SetGridColor(const COLOR4D &aColor) override
void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
const VECTOR2I GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
void handleIconizeEvent(wxIconizeEvent &aEvent) override
Handle a window iconize event.
FILE_HISTORY m_drillFileHistory
bool LoadExcellonFiles(const wxString &aFileName)
Load a drill (EXCELLON) file or many files.
COLOR4D GetGridColor() override
Selection tool for GerbView, based on the one in Pcbnew.
std::vector< wxString > m_JobFileHistory
std::vector< wxString > m_DrillFileHistory
GBR_DISPLAY_OPTIONS m_Display
std::vector< wxString > m_ZipFileHistory
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:101
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
const VECTOR2D & GetGridSize() const
Return the grid size.
Methods for drawing GerbView specific items.
Store GerbView specific render settings.
void LoadColors(const COLOR_SETTINGS *aSettings) override
void SetContrastMode(GBR_INACTIVE_LAYER_MODE aMode)
VECTOR2D GetCursorPosition() const
Return the current cursor position in world coordinates.
An abstract base class for deriving all objects that can be added to a VIEW.
Definition view_item.h:82
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition view.h:63
void SetLayerDiff(int aLayer, bool aDiff=true)
Set the whether the layer should drawn differentially.
Definition view.h:452
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Change the rendering target for a particular layer.
Definition view.h:511
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition view.h:407
void Clear()
Remove all items from the view.
Definition view.cpp:1262
void RecacheAllItems()
Rebuild GAL display lists.
Definition view.cpp:1597
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
Definition view.cpp:1743
void MarkDirty()
Force redraw of view on the next rendering.
Definition view.h:681
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition view.h:429
PAINTER * GetPainter() const
Return the painter object used by the view for drawing VIEW_ITEM objects.
Definition view.h:227
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition view.h:661
void UpdateAllItemsConditionally(int aUpdateFlags, std::function< bool(VIEW_ITEM *)> aCondition)
Update items in the view according to the given flags and condition.
Definition view.cpp:1759
void ReorderLayerData(std::unordered_map< int, int > aReorderMap)
Remap the data between layer ids without invalidating that data.
Definition view.cpp:762
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:348
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
static const LSET & AllLayersMask()
Definition lset.cpp:637
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition page_info.h:75
wxString GetTypeAsString() const
bool SetType(PAGE_SIZE_TYPE aPageSize, bool aIsPortrait=false)
Set the name of the page type and also the sizes and margins commonly associated with that type name.
const VECTOR2D GetSizeIU(double aIUScale) const
Gets the page size in internal units.
Definition page_info.h:172
virtual COMMON_SETTINGS * GetCommonSettings() const
Definition pgm_base.cpp:546
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition pgm_base.h:123
void SaveColorSettings(COLOR_SETTINGS *aSettings, const std::string &aNamespace="")
Safely save a COLOR_SETTINGS to disk, preserving any changes outside the given namespace.
Represent a set of closed polygons.
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition title_block.h:38
TOOL_MANAGER * m_toolManager
TOOL_DISPATCHER * m_toolDispatcher
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
ACTIONS * m_actions
@ GAL_SWITCH
Rendering engine changes.
Definition tool_base.h:78
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.
bool PostAction(const std::string &aActionName, T aParam)
Run the specified action after the current action (coroutine) ends.
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
#define CHECK(x)
#define _(s)
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define CANDIDATE
flag indicating that the structure is connected
@ FRAME_GERBER
Definition frame_type.h:53
#define NO_AVAILABLE_LAYERS
#define GERBVIEW_FRAME_NAME
The main window used in GerbView.
@ ID_GERBVIEW_JOB_FILE_LIST_CLEAR
Definition gerbview_id.h:56
@ ID_GERBVIEW_DRILL_FILE1
Definition gerbview_id.h:48
@ ID_GERBVIEW_ZIP_FILE_LIST_CLEAR
Definition gerbview_id.h:62
@ ID_GERBVIEW_JOB_FILE1
Definition gerbview_id.h:54
@ ID_GERBVIEW_ZIP_FILE1
Definition gerbview_id.h:60
@ ID_GERBVIEW_DRILL_FILE_LIST_CLEAR
Definition gerbview_id.h:50
static const std::string GerberJobFileExtension
static const std::string GerberFileExtension
static const std::string DrillFileExtension
static const std::string ArchiveFileExtension
#define DEFAULT_FILE_HISTORY_SIZE
IDs range for menuitems file history: The default range file history size is 9 (compatible with defau...
Definition id.h:45
@ LAYER_GERBVIEW_DRAWINGSHEET
Definition layer_ids.h:556
@ LAYER_GERBVIEW_BACKGROUND
Definition layer_ids.h:555
@ LAYER_DCODES
Definition layer_ids.h:551
@ LAYER_NEGATIVE_OBJECTS
Definition layer_ids.h:552
@ LAYER_GERBVIEW_PAGE_LIMITS
Definition layer_ids.h:557
@ LAYER_GERBVIEW_GRID
Definition layer_ids.h:553
#define GERBER_DCODE_LAYER(x)
Definition layer_ids.h:564
@ LAYER_DRAWINGSHEET
Sheet frame and title block.
Definition layer_ids.h:274
#define GERBER_DRAWLAYERS_COUNT
Number of draw layers in Gerbview.
Definition layer_ids.h:541
#define GERBER_DRAW_LAYER(x)
Definition layer_ids.h:562
@ REPAINT
Item needs to be redrawn.
Definition view_item.h:54
@ ALL
All except INITIAL_ADD.
Definition view_item.h:55
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition definitions.h:34
@ TARGET_CACHED
Main rendering target (cached)
Definition definitions.h:33
KICOMMON_API bool EnsureTextCtrlWidth(wxTextCtrl *aCtrl, const wxString *aString=nullptr)
Set the minimum pixel width on a text control in order to make a text string be fully visible within ...
Declaration of the NL_GERBVIEW_PLUGIN class.
#define _HKI(x)
Definition page_info.cpp:40
PGM_BASE & Pgm()
The global program "get" accessor.
see class PGM_BASE
#define DEFAULT_THEME
T * GetToolbarSettings(const wxString &aFilename)
T * GetAppSettings(const char *aFilename)
std::vector< FAB_LAYER_COLOR > dummy
GRID_SETTINGS grid
std::string path
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:708
VECTOR2< double > VECTOR2D
Definition vector2d.h:707
Definition of file extensions used in Kicad.