KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_base_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, [email protected]
5 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
7 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
8 * Copyright (C) 2022 CERN
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, you may find one here:
22 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23 * or you may search the http://www.gnu.org website for the version 2 license,
24 * or you may write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26 */
27
30#include <boost/version.hpp>
31
32#if BOOST_VERSION >= 106700
33#include <boost/uuid/entropy_error.hpp>
34#endif
35
36#include <3d_viewer/eda_3d_viewer_frame.h> // To include VIEWER3D_FRAMENAME
37#include <advanced_config.h>
38#include <base_units.h>
39#include <board.h>
40#include <cleanup_item.h>
41#include <collectors.h>
42#include <confirm.h>
43#include <footprint.h>
45#include <fp_lib_table.h>
46#include <lset.h>
47#include <kiface_base.h>
48#include <pcb_painter.h>
49#include <pcbnew_id.h>
50#include <pcbnew_settings.h>
51#include <pcb_base_frame.h>
52#include <pcb_draw_panel_gal.h>
53#include <pgm_base.h>
54#include <project_pcb.h>
56
57#include <math/vector2d.h>
58#include <math/vector2wx.h>
59#include <widgets/msgpanel.h>
60#include <wx/fswatcher.h>
61
64#include <tool/tool_manager.h>
66#include <tools/pcb_actions.h>
67#include <tool/grid_menu.h>
69
70#ifdef __linux__
72#else
74#endif
75
78
79wxDEFINE_EVENT( EDA_EVT_BOARD_CHANGED, wxCommandEvent );
80
81PCB_BASE_FRAME::PCB_BASE_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
82 const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
83 long aStyle, const wxString& aFrameName ) :
84 EDA_DRAW_FRAME( aKiway, aParent, aFrameType, aTitle, aPos, aSize, aStyle, aFrameName,
85 pcbIUScale ),
86 m_pcb( nullptr ),
87 m_originTransforms( *this ),
89{
91}
92
93
95{
96 // Ensure m_canvasType is up to date, to save it in config
97 if( GetCanvas() )
99
100 delete m_pcb;
101 m_pcb = nullptr;
102}
103
104
105bool PCB_BASE_FRAME::canCloseWindow( wxCloseEvent& aEvent )
106{
107 // Close modeless dialogs. They're trouble when they get destroyed after the frame and/or
108 // board.
109 wxWindow* viewer3D = Get3DViewerFrame();
110
111 if( viewer3D )
112 viewer3D->Close( true );
113
114 // Similarly, wxConvBrokenFileNames uses some statically allocated variables that make it
115 // crash when run later from a d'tor.
117
118 return true;
119}
120
121
122void PCB_BASE_FRAME::handleActivateEvent( wxActivateEvent& aEvent )
123{
125
126 if( m_spaceMouse )
127 m_spaceMouse->SetFocus( aEvent.GetActive() );
128}
129
130
131void PCB_BASE_FRAME::handleIconizeEvent( wxIconizeEvent& aEvent )
132{
134
135 if( m_spaceMouse && aEvent.IsIconized() )
136 m_spaceMouse->SetFocus( false );
137}
138
139
141{
142 wxWindow* frame = FindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( this ) );
143 return dynamic_cast<EDA_3D_VIEWER_FRAME*>( frame );
144}
145
146
147void PCB_BASE_FRAME::Update3DView( bool aMarkDirty, bool aRefresh, const wxString* aTitle )
148{
149 EDA_3D_VIEWER_FRAME* draw3DFrame = Get3DViewerFrame();
150
151 if( draw3DFrame )
152 {
153 if( aTitle )
154 draw3DFrame->SetTitle( *aTitle );
155
156 if( aMarkDirty )
157 draw3DFrame->ReloadRequest();
158
159 if( aRefresh )
160 draw3DFrame->Redraw();
161 }
162}
163
164
166{
167 if( m_pcb != aBoard )
168 {
169 delete m_pcb;
170 m_pcb = aBoard;
171
172 if( GetBoard() )
174
175 if( GetBoard() && GetCanvas() )
176 {
178
179 if( rs )
180 {
181 rs->SetDashLengthRatio( GetBoard()->GetPlotOptions().GetDashedLineDashRatio() );
182 rs->SetGapLengthRatio( GetBoard()->GetPlotOptions().GetDashedLineGapRatio() );
183 }
184 }
185
186 wxCommandEvent e( EDA_EVT_BOARD_CHANGED );
187 ProcessEventLocally( e );
188
189 for( wxEvtHandler* listener : m_boardChangeListeners )
190 {
191 wxCHECK2( listener, continue );
192
193 // Use the windows variant when handling event messages in case there is any special
194 // event handler pre and/or post processing specific to windows.
195 wxWindow* win = dynamic_cast<wxWindow*>( listener );
196
197 if( win )
198 win->HandleWindowEvent( e );
199 else
200 listener->SafelyProcessEvent( e );
201 }
202 }
203}
204
205
206void PCB_BASE_FRAME::AddBoardChangeListener( wxEvtHandler* aListener )
207{
208 auto it = std::find( m_boardChangeListeners.begin(), m_boardChangeListeners.end(), aListener );
209
210 // Don't add duplicate listeners.
211 if( it == m_boardChangeListeners.end() )
212 m_boardChangeListeners.push_back( aListener );
213}
214
215
216void PCB_BASE_FRAME::RemoveBoardChangeListener( wxEvtHandler* aListener )
217{
218 auto it = std::find( m_boardChangeListeners.begin(), m_boardChangeListeners.end(), aListener );
219
220 // Don't add duplicate listeners.
221 if( it != m_boardChangeListeners.end() )
222 m_boardChangeListeners.erase( it );
223}
224
225
227{
228 if( aFootprint )
229 {
230 GetBoard()->Add( aFootprint, ADD_MODE::APPEND );
231
232 aFootprint->SetFlags( IS_NEW );
233 aFootprint->SetPosition( VECTOR2I( 0, 0 ) ); // cursor in GAL may not be initialized yet
234
235 // Put it on FRONT layer (note that it might be stored flipped if the lib is an archive
236 // built from a board)
237 if( aFootprint->IsFlipped() )
238 aFootprint->Flip( aFootprint->GetPosition(), GetPcbNewSettings()->m_FlipDirection );
239
240 // Place it in orientation 0 even if it is not saved with orientation 0 in lib (note that
241 // it might be stored in another orientation if the lib is an archive built from a board)
242 aFootprint->SetOrientation( ANGLE_0 );
243
244 GetBoard()->UpdateUserUnits( aFootprint, GetCanvas()->GetView() );
245
247 }
248}
249
250
251EDA_ITEM* PCB_BASE_FRAME::ResolveItem( const KIID& aId, bool aAllowNullptrReturn ) const
252{
253 return GetBoard()->ResolveItem( aId, aAllowNullptrReturn );
254}
255
256void PCB_BASE_FRAME::FocusOnItem( EDA_ITEM* aItem, bool aAllowScroll )
257{
258 // nullptr will clear the current focus
259 if( aItem != nullptr && !aItem->IsBOARD_ITEM() )
260 return;
261
262 FocusOnItem( static_cast<BOARD_ITEM*>( aItem ), UNDEFINED_LAYER, aAllowScroll );
263}
264
265void PCB_BASE_FRAME::FocusOnItem( BOARD_ITEM* aItem, PCB_LAYER_ID aLayer, bool aAllowScroll )
266{
267 std::vector<BOARD_ITEM*> items;
268
269 if( aItem )
270 items.push_back( aItem );
271
272 FocusOnItems( items, aLayer, aAllowScroll );
273}
274
275
276void PCB_BASE_FRAME::FocusOnItems( std::vector<BOARD_ITEM*> aItems, PCB_LAYER_ID aLayer, bool aAllowScroll )
277{
278 static std::vector<KIID> lastBrightenedItemIDs;
279
280 bool itemsUnbrightened = false;
281
282 for( KIID lastBrightenedItemID : lastBrightenedItemIDs )
283 {
284 if( BOARD_ITEM* lastItem = GetBoard()->ResolveItem( lastBrightenedItemID, true ) )
285 {
286 lastItem->ClearBrightened();
287 GetCanvas()->GetView()->Update( lastItem );
288 itemsUnbrightened = true;
289 }
290 }
291
292 if( itemsUnbrightened )
293 GetCanvas()->Refresh();
294
295 lastBrightenedItemIDs.clear();
296
297 if( aItems.empty() )
298 return;
299
300 VECTOR2I focusPt;
301 KIGFX::VIEW* view = GetCanvas()->GetView();
302 SHAPE_POLY_SET viewportPoly( view->GetViewport() );
303
304 for( wxWindow* dialog : findDialogs() )
305 {
306 wxPoint dialogPos = GetCanvas()->ScreenToClient( dialog->GetScreenPosition() );
307 SHAPE_POLY_SET dialogPoly( BOX2D( view->ToWorld( ToVECTOR2D( dialogPos ), true ),
308 view->ToWorld( ToVECTOR2D( dialog->GetSize() ), false ) ) );
309
310 try
311 {
312 viewportPoly.BooleanSubtract( dialogPoly );
313 }
314 catch( const std::exception& e )
315 {
316 wxFAIL_MSG( wxString::Format( wxT( "Clipper exception occurred: %s" ), e.what() ) );
317 }
318 }
319
320 SHAPE_POLY_SET itemPoly, clippedPoly;
321
322 for( BOARD_ITEM* item : aItems )
323 {
324 if( item && item != DELETED_BOARD_ITEM::GetInstance() )
325 {
326 item->SetBrightened();
327 lastBrightenedItemIDs.push_back( item->m_Uuid );
328
329 item->RunOnChildren(
330 [&]( BOARD_ITEM* child )
331 {
332 child->SetBrightened();
333 lastBrightenedItemIDs.push_back( child->m_Uuid );
334 },
336
337 GetCanvas()->GetView()->Update( item );
338
339 // Focus on the object's location. Prefer a visible part of the object to its anchor
340 // in order to keep from scrolling around.
341
342 focusPt = item->GetPosition();
343
344 if( aLayer == UNDEFINED_LAYER && item->GetLayerSet().any() )
345 aLayer = item->GetLayerSet().Seq()[0];
346
347 switch( item->Type() )
348 {
349 case PCB_FOOTPRINT_T:
350 try
351 {
352 itemPoly = static_cast<FOOTPRINT*>( item )->GetBoundingHull();
353 }
354 catch( const std::exception& e )
355 {
356 wxFAIL_MSG( wxString::Format( wxT( "Clipper exception occurred: %s" ), e.what() ) );
357 }
358
359 break;
360
361 case PCB_PAD_T:
362 case PCB_MARKER_T:
363 case PCB_VIA_T:
364 FocusOnLocation( item->GetFocusPosition(), aAllowScroll );
365 GetCanvas()->Refresh();
366 return;
367
368 case PCB_SHAPE_T:
369 case PCB_FIELD_T:
370 case PCB_TEXT_T:
371 case PCB_TEXTBOX_T:
372 case PCB_TRACE_T:
373 case PCB_ARC_T:
375 case PCB_DIM_LEADER_T:
376 case PCB_DIM_CENTER_T:
377 case PCB_DIM_RADIAL_T:
379 item->TransformShapeToPolygon( itemPoly, aLayer, 0, pcbIUScale.mmToIU( 0.1 ), ERROR_INSIDE );
380 break;
381
382 case PCB_ZONE_T:
383 {
384 ZONE* zone = static_cast<ZONE*>( item );
385#if 0
386 // Using the filled area shapes to find a Focus point can give good results, but
387 // unfortunately the calculations are highly time consuming, even for not very
388 // large areas (can be easily a few minutes for large areas).
389 // so we used only the zone outline that usually do not have too many vertices.
390 zone->TransformShapeToPolygon( itemPoly, aLayer, 0, pcbIUScale.mmToIU( 0.1 ), ERROR_INSIDE );
391
392 if( itemPoly.IsEmpty() )
393 itemPoly = *zone->Outline();
394#else
395 // much faster calculation time when using only the zone outlines
396 itemPoly = *zone->Outline();
397#endif
398
399 break;
400 }
401
402 default:
403 {
404 BOX2I item_bbox = item->GetBoundingBox();
405 itemPoly.NewOutline();
406 itemPoly.Append( item_bbox.GetOrigin() );
407 itemPoly.Append( item_bbox.GetOrigin() + VECTOR2I( item_bbox.GetWidth(), 0 ) );
408 itemPoly.Append( item_bbox.GetOrigin() + VECTOR2I( 0, item_bbox.GetHeight() ) );
409 itemPoly.Append( item_bbox.GetOrigin() + VECTOR2I( item_bbox.GetWidth(),
410 item_bbox.GetHeight() ) );
411 break;
412 }
413 }
414
415 try
416 {
417 itemPoly.ClearArcs();
418 viewportPoly.ClearArcs();
419 clippedPoly.BooleanIntersection( itemPoly, viewportPoly );
420 }
421 catch( const std::exception& e )
422 {
423 wxFAIL_MSG( wxString::Format( wxT( "Clipper exception occurred: %s" ), e.what() ) );
424 }
425
426 if( !clippedPoly.IsEmpty() )
427 itemPoly = clippedPoly;
428 }
429 }
430
431 /*
432 * Perform a step-wise deflate to find the visual-center-of-mass
433 */
434
435 BOX2I bbox = itemPoly.BBox();
436 int step = std::min( bbox.GetWidth(), bbox.GetHeight() ) / 10;
437
438 while( !itemPoly.IsEmpty() )
439 {
440 focusPt = itemPoly.BBox().Centre();
441
442 try
443 {
445 }
446 catch( const std::exception& e )
447 {
448 wxFAIL_MSG( wxString::Format( wxT( "Clipper exception occurred: %s" ), e.what() ) );
449 }
450 }
451
452 FocusOnLocation( focusPt, aAllowScroll );
453
454 GetCanvas()->Refresh();
455}
456
457
459{
460 KIGFX::PCB_VIEW* view = GetCanvas()->GetView();
461
462 if( view && GetBoard()->m_SolderMaskBridges && view->HasItem( GetBoard()->m_SolderMaskBridges ) )
463 view->Remove( GetBoard()->m_SolderMaskBridges );
464}
465
466
468{
469 KIGFX::PCB_VIEW* view = GetCanvas()->GetView();
470
471 if( view && GetBoard()->m_SolderMaskBridges )
472 {
473 if( view->HasItem( GetBoard()->m_SolderMaskBridges ) )
474 view->Remove( GetBoard()->m_SolderMaskBridges );
475
476 view->Add( GetBoard()->m_SolderMaskBridges );
477 }
478}
479
480
481void PCB_BASE_FRAME::SetPageSettings( const PAGE_INFO& aPageSettings )
482{
483 m_pcb->SetPageSettings( aPageSettings );
484
485 if( GetScreen() )
486 GetScreen()->InitDataPoints( aPageSettings.GetSizeIU( pcbIUScale.IU_PER_MILS ) );
487}
488
489
491{
492 return m_pcb->GetPageSettings();
493}
494
495
497{
498 // this function is only needed because EDA_DRAW_FRAME is not compiled
499 // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
500 // into an application specific source file.
501 return m_pcb->GetPageSettings().GetSizeIU( pcbIUScale.IU_PER_MILS );
502}
503
504
506{
507 return m_pcb->GetDesignSettings().GetGridOrigin();
508}
509
510
512{
513 m_pcb->GetDesignSettings().SetGridOrigin( aPoint );
514}
515
516
518{
519 return m_pcb->GetDesignSettings().GetAuxOrigin();
520}
521
522
524{
525 VECTOR2I origin( 0, 0 );
526
527 switch( GetPcbNewSettings()->m_Display.m_DisplayOrigin )
528 {
530 case PCB_DISPLAY_ORIGIN::PCB_ORIGIN_AUX: origin = GetAuxOrigin(); break;
532 default: wxASSERT( false ); break;
533 }
534
535 return origin;
536}
537
542
543
545{
546 return m_pcb->GetTitleBlock();
547}
548
549
551{
552 m_pcb->SetTitleBlock( aTitleBlock );
553}
554
555
557{
558 return m_pcb->GetDesignSettings();
559}
560
561
563{
564 m_drawBgColor= aColor;
565 m_auimgr.Update();
566}
567
568
570{
571 return m_pcb->GetPlotOptions();
572}
573
574
576{
577 m_pcb->SetPlotOptions( aSettings );
578
579 // Plot Settings can also change the "tent vias" setting, which can affect the solder mask.
580 LSET visibleLayers = GetBoard()->GetVisibleLayers();
581
582 if( visibleLayers.test( F_Mask ) || visibleLayers.test( B_Mask ) )
583 {
585 [&]( KIGFX::VIEW_ITEM* aItem ) -> int
586 {
587 BOARD_ITEM* item = nullptr;
588
589 if( aItem->IsBOARD_ITEM() )
590 item = static_cast<BOARD_ITEM*>( aItem );
591
592 // Note: KIGFX::REPAINT isn't enough for things that go from invisible to
593 // visible as they won't be found in the view layer's itemset for re-painting.
594 if( item && item->Type() == PCB_VIA_T )
595 return KIGFX::ALL;
596
597 return 0;
598 } );
599
600 GetCanvas()->Refresh();
601 }
602}
603
604
605BOX2I PCB_BASE_FRAME::GetBoardBoundingBox( bool aBoardEdgesOnly ) const
606{
607 BOX2I area = aBoardEdgesOnly ? m_pcb->GetBoardEdgesBoundingBox() : m_pcb->GetBoundingBox();
608
609 if( area.GetWidth() == 0 && area.GetHeight() == 0 )
610 {
611 VECTOR2I pageSize = GetPageSizeIU();
612
614 {
615 area.SetOrigin( 0, 0 );
616 area.SetEnd( pageSize.x, pageSize.y );
617 }
618 else
619 {
620 area.SetOrigin( -pageSize.x / 2, -pageSize.y / 2 );
621 area.SetEnd( pageSize.x / 2, pageSize.y / 2 );
622 }
623 }
624
625 return area;
626}
627
628
629const BOX2I PCB_BASE_FRAME::GetDocumentExtents( bool aIncludeAllVisible ) const
630{
631 /* "Zoom to Fit" calls this with "aIncludeAllVisible" as true. Since that feature
632 * always ignored the page and border, this function returns a bbox without them
633 * as well when passed true. This technically is not all things visible, but it
634 * keeps behavior consistent.
635 *
636 * When passed false, this function returns a bbox of just the board edge. This
637 * allows things like fabrication text or anything else outside the board edge to
638 * be ignored, and just zooms up to the board itself.
639 *
640 * Calling "GetBoardBoundingBox(true)" when edge cuts are turned off will return
641 * the entire page and border, so we call "GetBoardBoundingBox(false)" instead.
642 */
643 if( aIncludeAllVisible || !m_pcb->IsLayerVisible( Edge_Cuts ) )
644 return GetBoardBoundingBox( false );
645 else
646 return GetBoardBoundingBox( true );
647}
648
649
650// Virtual function
654
655
657{
658 // call my base class
660
661 // tooltips in toolbars
663
665
666 if( viewer3D )
667 viewer3D->ShowChangedLanguage();
668}
669
670
672{
673 EDA_3D_VIEWER_FRAME* draw3DFrame = Get3DViewerFrame();
674
675 if( !draw3DFrame )
676 draw3DFrame = new EDA_3D_VIEWER_FRAME( &Kiway(), this, _( "3D Viewer" ) );
677
678 // Raising the window does not show the window on Windows if iconized. This should work
679 // on any platform.
680 if( draw3DFrame->IsIconized() )
681 draw3DFrame->Iconize( false );
682
683 draw3DFrame->Raise();
684 draw3DFrame->Show( true );
685
686 // Raising the window does not set the focus on Linux. This should work on any platform.
687 if( wxWindow::FindFocus() != draw3DFrame )
688 draw3DFrame->SetFocus();
689
690 // Allocate a slice of time to display the 3D frame
691 // a call to wxSafeYield() should be enough (and better), but on Linux we need
692 // to call wxYield()
693 // otherwise the activity messages are not displayed during the first board loading
694 wxYield();
695
696 // Note, the caller is responsible to load/update the board 3D view.
697 // after frame creation the board is not automatically created.
698
699 return draw3DFrame;
700}
701
702
704{
705 PCB_LAYER_ID preslayer = GetActiveLayer();
706 auto& displ_opts = GetDisplayOptions();
707
708 // Check if the specified layer matches the present layer
709 if( layer == preslayer )
710 return;
711
712 // Copper layers cannot be selected unconditionally; how many of those layers are
713 // currently enabled needs to be checked.
714 if( IsCopperLayer( layer ) )
715 {
716 if( layer > m_pcb->GetCopperLayerStackMaxId() )
717 return;
718 }
719
720 // Is yet more checking required? E.g. when the layer to be selected is a non-copper
721 // layer, or when switching between a copper layer and a non-copper layer, or vice-versa?
722 // ...
723
724 SetActiveLayer( layer );
725
726 if( displ_opts.m_ContrastModeDisplay != HIGH_CONTRAST_MODE::NORMAL )
727 GetCanvas()->Refresh();
728}
729
730
732{
733 GENERAL_COLLECTORS_GUIDE guide( m_pcb->GetVisibleLayers(), GetActiveLayer(),
734 GetCanvas()->GetView() );
735
736 // account for the globals
737 guide.SetIgnoreFPTextOnBack( !m_pcb->IsElementVisible( LAYER_FP_TEXT ) );
738 guide.SetIgnoreFPTextOnFront( !m_pcb->IsElementVisible( LAYER_FP_TEXT ) );
739 guide.SetIgnoreFootprintsOnBack( !m_pcb->IsElementVisible( LAYER_FOOTPRINTS_BK ) );
740 guide.SetIgnoreFootprintsOnFront( !m_pcb->IsElementVisible( LAYER_FOOTPRINTS_FR ) );
741 guide.SetIgnoreThroughHolePads( ! m_pcb->IsElementVisible( LAYER_PADS ) );
742 guide.SetIgnoreFPValues( !m_pcb->IsElementVisible( LAYER_FP_VALUES ) );
743 guide.SetIgnoreFPReferences( !m_pcb->IsElementVisible( LAYER_FP_REFERENCES ) );
744 guide.SetIgnoreThroughVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
745 guide.SetIgnoreBlindBuriedVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
746 guide.SetIgnoreMicroVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
747 guide.SetIgnoreTracks( ! m_pcb->IsElementVisible( LAYER_TRACKS ) );
748
749 return guide;
750}
751
752
754{
756
757 BASE_SCREEN* screen = GetScreen();
758
759 if( !screen )
760 return;
761
762 wxString line;
764
765 if( GetShowPolarCoords() ) // display polar coordinates
766 {
767 double dx = cursorPos.x - screen->m_LocalOrigin.x;
768 double dy = cursorPos.y - screen->m_LocalOrigin.y;
769 double theta = RAD2DEG( atan2( -dy, dx ) );
770 double ro = hypot( dx, dy );
771
772 line.Printf( wxT( "r %s theta %.3f" ),
773 MessageTextFromValue( ro, false ),
774 theta );
775
776 SetStatusText( line, 3 );
777 }
778
779 // Transform absolute coordinates for user origin preferences
780 double userXpos = m_originTransforms.ToDisplayAbsX( static_cast<double>( cursorPos.x ) );
781 double userYpos = m_originTransforms.ToDisplayAbsY( static_cast<double>( cursorPos.y ) );
782
783 // Display absolute coordinates:
784 line.Printf( wxT( "X %s Y %s" ),
785 MessageTextFromValue( userXpos, false ),
786 MessageTextFromValue( userYpos, false ) );
787 SetStatusText( line, 2 );
788
789 if( !GetShowPolarCoords() ) // display relative cartesian coordinates
790 {
791 // Calculate relative coordinates
792 double relXpos = cursorPos.x - screen->m_LocalOrigin.x;
793 double relYpos = cursorPos.y - screen->m_LocalOrigin.y;
794
795 // Transform relative coordinates for user origin preferences
796 userXpos = m_originTransforms.ToDisplayRelX( relXpos );
797 userYpos = m_originTransforms.ToDisplayRelY( relYpos );
798
799 line.Printf( wxT( "dx %s dy %s dist %s" ),
800 MessageTextFromValue( userXpos, false ),
801 MessageTextFromValue( userYpos, false ),
802 MessageTextFromValue( hypot( userXpos, userYpos ), false ) );
803 SetStatusText( line, 3 );
804 }
805
807}
808
809
811{
812 EDA_DRAW_FRAME::unitsChangeRefresh(); // Update the status bar.
813
814 if( GetBoard() )
816
818}
819
820
822{
824
825 // Move legacy user grids to grid list
826 if( !aCfg->m_Window.grid.user_grid_x.empty() )
827 {
828 aCfg->m_Window.grid.grids.emplace_back( GRID{ "User Grid", aCfg->m_Window.grid.user_grid_x,
829 aCfg->m_Window.grid.user_grid_y } );
830 aCfg->m_Window.grid.user_grid_x = wxEmptyString;
831 aCfg->m_Window.grid.user_grid_y = wxEmptyString;
832 }
833
834 // Some, but not all, derived classes have a PCBNEW_SETTINGS.
835 if( PCBNEW_SETTINGS* pcbnew_cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg ) )
836 m_polarCoords = pcbnew_cfg->m_PolarCoords;
837
838 wxASSERT( GetCanvas() );
839
840 if( GetCanvas() )
841 {
843
844 if( rs )
845 {
848 rs->SetDefaultFont( wxEmptyString ); // Always the KiCad font for PCBs
849 }
850 }
851}
852
853
855{
856 if( aErrorCode >= CLEANUP_FIRST )
857 return RPT_SEVERITY_ACTION;
858
860
861 return bds.m_DRCSeverities[ aErrorCode ];
862}
863
864
866{
868
869 // Some, but not all derived classes have a PCBNEW_SETTINGS.
870 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg );
871
872 if( cfg )
874}
875
876
881
882
887
888
910
911
913{
914 static MAGNETIC_SETTINGS fallback;
915
917 return &cfg->m_MagneticItems;
918
919 return &fallback;
920}
921
922
924{
926
927 KIGFX::VIEW* view = GetCanvas()->GetView();
928 KIGFX::PCB_PAINTER* painter = static_cast<KIGFX::PCB_PAINTER*>( view->GetPainter() );
929 PCB_RENDER_SETTINGS* settings = painter->GetSettings();
930
931 settings->LoadColors( GetColorSettings( true ) );
934
935 if( aFlags & TEXTVARS_CHANGED )
937
938 // Note: KIGFX::REPAINT isn't enough for things that go from invisible to visible as
939 // they won't be found in the view layer's itemset for re-painting.
941 [&]( KIGFX::VIEW_ITEM* aItem ) -> int
942 {
943 if( dynamic_cast<RATSNEST_VIEW_ITEM*>( aItem ) )
944 {
945 return KIGFX::ALL; // ratsnest display
946 }
947 else if( dynamic_cast<PCB_TRACK*>( aItem ) )
948 {
949 return KIGFX::REPAINT; // track, arc & via clearance display
950 }
951 else if( dynamic_cast<PAD*>( aItem ) )
952 {
953 return KIGFX::REPAINT; // pad clearance display
954 }
955 else if( EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( aItem ) )
956 {
957 if( text->HasTextVars() )
958 {
959 text->ClearRenderCache();
960 text->ClearBoundingBoxCache();
962 }
963 }
964
965 return 0;
966 } );
967
969
971
972 // The 3D viewer isn't in the Kiway, so send its update manually
974
975 if( viewer )
976 viewer->CommonSettingsChanged( aFlags );
977}
978
979
981{
983
986
987 if( m_isClosing )
988 return;
989
992}
993
994
1001
1002
1007
1008
1010{
1012
1013 EDA_DRAW_PANEL_GAL* canvas = GetCanvas();
1014 KIGFX::VIEW* view = canvas->GetView();
1015
1016 if( m_toolManager )
1017 {
1018 m_toolManager->SetEnvironment( m_pcb, view, canvas->GetViewControls(), config(), this );
1019
1020 m_toolManager->ResetTools( TOOL_BASE::GAL_SWITCH );
1021 }
1022
1023 KIGFX::PCB_PAINTER* painter = static_cast<KIGFX::PCB_PAINTER*>( view->GetPainter() );
1024 KIGFX::PCB_RENDER_SETTINGS* settings = painter->GetSettings();
1025 const PCB_DISPLAY_OPTIONS& displ_opts = GetDisplayOptions();
1026
1027 settings->LoadDisplayOptions( displ_opts );
1028 settings->LoadColors( GetColorSettings() );
1030
1031 view->RecacheAllItems();
1033 canvas->StartDrawing();
1034
1035 try
1036
1037 {
1038 if( !m_spaceMouse )
1039 {
1040#ifndef __linux__
1041 m_spaceMouse = std::make_unique<NL_PCBNEW_PLUGIN>( GetCanvas() );
1042#else
1043 m_spaceMouse = std::make_unique<SPNAV_2D_PLUGIN>( GetCanvas() );
1044 m_spaceMouse->SetScale( 0.01 );
1045#endif
1046 }
1047 }
1048 catch( const std::system_error& e )
1049 {
1050 wxLogTrace( wxT( "KI_TRACE_NAVLIB" ), e.what() );
1051 }
1052}
1053
1054
1055void PCB_BASE_FRAME::SetDisplayOptions( const PCB_DISPLAY_OPTIONS& aOptions, bool aRefresh )
1056{
1057 bool hcChanged = m_displayOptions.m_ContrastModeDisplay != aOptions.m_ContrastModeDisplay;
1058 bool hcVisChanged = m_displayOptions.m_ContrastModeDisplay == HIGH_CONTRAST_MODE::HIDDEN
1060 m_displayOptions = aOptions;
1061
1062 EDA_DRAW_PANEL_GAL* canvas = GetCanvas();
1063 KIGFX::PCB_VIEW* view = static_cast<KIGFX::PCB_VIEW*>( canvas->GetView() );
1064
1065 view->UpdateDisplayOptions( aOptions );
1068
1069 // Vias on a restricted layer set must be redrawn when high contrast mode is changed
1070 if( hcChanged )
1071 {
1072 bool showNetNames = false;
1073
1074 if( PCBNEW_SETTINGS* config = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() ) )
1075 showNetNames = config->m_Display.m_NetNames > 0;
1076
1077 // Note: KIGFX::REPAINT isn't enough for things that go from invisible to visible as
1078 // they won't be found in the view layer's itemset for re-painting.
1080 [&]( KIGFX::VIEW_ITEM* aItem ) -> int
1081 {
1082 if( PCB_VIA* via = dynamic_cast<PCB_VIA*>( aItem ) )
1083 {
1084 if( via->GetViaType() != VIATYPE::THROUGH
1085 || via->GetRemoveUnconnected()
1086 || showNetNames )
1087 {
1088 return hcVisChanged ? KIGFX::ALL : KIGFX::REPAINT;
1089 }
1090 }
1091 else if( PAD* pad = dynamic_cast<PAD*>( aItem ) )
1092 {
1093 if( pad->GetRemoveUnconnected()
1094 || showNetNames )
1095 {
1096 return hcVisChanged ? KIGFX::ALL : KIGFX::REPAINT;
1097 }
1098 }
1099
1100 return 0;
1101 } );
1102 }
1103
1104 if( aRefresh )
1105 canvas->Refresh();
1106}
1107
1108
1110{
1111 wxLogTrace( "KICAD_LIB_WATCH", "setFPWatcher" );
1112
1113 Unbind( wxEVT_FSWATCHER, &PCB_BASE_FRAME::OnFPChange, this );
1114
1115 if( m_watcher )
1116 {
1117 wxLogTrace( "KICAD_LIB_WATCH", "Remove watch" );
1118 m_watcher->RemoveAll();
1119 m_watcher->SetOwner( nullptr );
1120 m_watcher.reset();
1121 }
1122
1123 wxString libfullname;
1125
1126 if( !aFootprint || !tbl )
1127 return;
1128
1129 try
1130 {
1131 const FP_LIB_TABLE_ROW* row = tbl->FindRow( aFootprint->GetFPID().GetLibNickname() );
1132
1133 if( !row )
1134 return;
1135
1136 libfullname = row->GetFullURI( true );
1137 }
1138 catch( const std::exception& e )
1139 {
1140 DisplayInfoMessage( this, e.what() );
1141 return;
1142 }
1143 catch( const IO_ERROR& error )
1144 {
1145 wxLogTrace( "KICAD_LIB_WATCH", "Error: %s", error.What() );
1146 return;
1147 }
1148
1149 m_watcherFileName.Assign( libfullname, aFootprint->GetFPID().GetLibItemName(),
1151
1152 if( !m_watcherFileName.FileExists() )
1153 return;
1154
1155 m_watcherLastModified = m_watcherFileName.GetModificationTime();
1156
1157 Bind( wxEVT_FSWATCHER, &PCB_BASE_FRAME::OnFPChange, this );
1158 m_watcher = std::make_unique<wxFileSystemWatcher>();
1159 m_watcher->SetOwner( this );
1160
1161 wxFileName fn;
1162 fn.AssignDir( m_watcherFileName.GetPath() );
1163 fn.DontFollowLink();
1164
1165 wxLogTrace( "KICAD_LIB_WATCH", "Add watch: %s", fn.GetPath() );
1166
1167 {
1168 // Silence OS errors that come from the watcher
1169 wxLogNull silence;
1170 m_watcher->Add( fn );
1171 }
1172}
1173
1174
1175void PCB_BASE_FRAME::OnFPChange( wxFileSystemWatcherEvent& aEvent )
1176{
1177 if( aEvent.GetPath() != m_watcherFileName.GetFullPath() )
1178 return;
1179
1180 // Start the debounce timer (set to 1 second)
1181 if( !m_watcherDebounceTimer.StartOnce( 1000 ) )
1182 {
1183 wxLogTrace( "KICAD_LIB_WATCH", "Failed to start the debounce timer" );
1184 return;
1185 }
1186}
1187
1188
1190{
1191 if( aEvent.GetId() != m_watcherDebounceTimer.GetId() )
1192 {
1193 aEvent.Skip();
1194 return;
1195 }
1196
1198 {
1199 wxLogTrace( "KICAD_LIB_WATCH", "Restarting debounce timer" );
1200 m_watcherDebounceTimer.StartOnce( 3000 );
1201 }
1202
1203 wxLogTrace( "KICAD_LIB_WATCH", "OnFpChangeDebounceTimer" );
1204
1205 // Disable logging to avoid spurious messages and check if the file has changed
1206 wxLog::EnableLogging( false );
1207 wxDateTime lastModified = m_watcherFileName.GetModificationTime();
1208 wxLog::EnableLogging( true );
1209
1210 if( lastModified == m_watcherLastModified || !lastModified.IsValid() )
1211 return;
1212
1213 m_watcherLastModified = lastModified;
1214
1217
1218 // When loading a footprint from a library in the footprint editor
1219 // the items UUIDs must be keep and not reinitialized
1220 bool keepUUID = IsType( FRAME_FOOTPRINT_EDITOR );
1221
1222 if( !fp || !tbl )
1223 return;
1224
1226
1228 || IsOK( this, _( "The library containing the current footprint has changed.\n"
1229 "Do you want to reload the footprint?" ) ) )
1230 {
1231 wxString fpname = fp->GetFPID().GetLibItemName();
1232 wxString nickname = fp->GetFPID().GetLibNickname();
1233
1234 try
1235 {
1236 FOOTPRINT* newfp = tbl->FootprintLoad( nickname, fpname, keepUUID );
1237
1238 if( newfp )
1239 {
1240 std::vector<KIID> selectedItems;
1241
1242 for( const EDA_ITEM* item : GetCurrentSelection() )
1243 selectedItems.emplace_back( item->m_Uuid );
1244
1246
1247 ReloadFootprint( newfp );
1248
1249 newfp->ClearAllNets();
1253
1254 std::vector<EDA_ITEM*> sel;
1255
1256 for( const KIID& uuid : selectedItems )
1257 {
1258 if( BOARD_ITEM* item = GetBoard()->ResolveItem( uuid, true ) )
1259 sel.push_back( item );
1260 }
1261
1262 if( !sel.empty() )
1263 m_toolManager->RunAction( ACTIONS::selectItems, &sel );
1264 }
1265 }
1266 catch( const IO_ERROR& ioe )
1267 {
1268 DisplayError( this, ioe.What() );
1269 }
1270 }
1271
1272 m_inFpChangeTimerEvent = false;
1273}
@ ERROR_INSIDE
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:112
constexpr int ARC_LOW_DEF
Definition base_units.h:128
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
@ NORMAL
Inactive layers are shown normally (no high-contrast mode)
@ HIDDEN
Inactive layers are hidden.
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
BOX2< VECTOR2D > BOX2D
Definition box2.h:923
static TOOL_ACTION selectItems
Select a list of items (specified as the event parameter)
Definition actions.h:231
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
WINDOW_SETTINGS m_Window
Handles how to draw a screen (a board, a schematic ...)
Definition base_screen.h:41
VECTOR2D m_LocalOrigin
Relative Screen cursor coordinate (on grid) in user units.
Definition base_screen.h:90
void SetContentModified(bool aModified=true)
Definition base_screen.h:59
void InitDataPoints(const VECTOR2I &aPageSizeInternalUnits)
Container for design settings for a BOARD object.
std::map< int, SEVERITY > m_DRCSeverities
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:79
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:317
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
Removes an item from the container.
Definition board.cpp:1163
void UpdateUserUnits(BOARD_ITEM *aItem, KIGFX::VIEW *aView)
Update any references within aItem (or its descendants) to the user units.
Definition board.cpp:1534
const LSET & GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
Definition board.cpp:937
bool BuildConnectivity(PROGRESS_REPORTER *aReporter=nullptr)
Build or rebuild the board connectivity database for the board, especially the list of connected item...
Definition board.cpp:188
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition board.h:488
void IncrementTimeStamp()
Definition board.cpp:256
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition board.cpp:1040
void SynchronizeProperties()
Copy the current project's text variables into the boards property cache.
Definition board.cpp:2274
BOARD_ITEM * ResolveItem(const KIID &aID, bool aAllowNullptrReturn=false) const
Definition board.cpp:1613
void SetUserUnits(EDA_UNITS aUnits)
Definition board.h:754
constexpr void SetOrigin(const Vec &pos)
Definition box2.h:237
constexpr size_type GetWidth() const
Definition box2.h:214
constexpr Vec Centre() const
Definition box2.h:97
constexpr size_type GetHeight() const
Definition box2.h:215
constexpr const Vec & GetOrigin() const
Definition box2.h:210
constexpr void SetEnd(coord_type x, coord_type y)
Definition box2.h:297
static DELETED_BOARD_ITEM * GetInstance()
Definition board_item.h:490
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
void CommonSettingsChanged(int aFlags) override
Notification that common settings are updated.
void ShowChangedLanguage() override
void ReloadRequest()
Request reloading the 3D view.
FRAME_T GetFrameType() const
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 OnModify()
Must be called after a model change in order to set the "modify" flag and do other frame-specific pro...
wxAuiManager m_auimgr
virtual bool IsContentModified() const
Get if the contents of the frame have been modified since the last save.
virtual void RecreateToolbars()
bool m_isClosing
Set by the close window event handler after frames are asked if they can close.
bool IsType(FRAME_T aType) const
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.
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.
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 handleActivateEvent(wxActivateEvent &aEvent)
Handle a window activation event.
virtual void UpdateMsgPanel()
Redraw the message panel.
void FocusOnLocation(const VECTOR2I &aPos, bool aAllowScroll=true)
Useful to focus on a particular location, in find functions.
void UpdateStatusBar() override
Update the status bar information.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
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 ...
std::vector< wxWindow * > findDialogs()
virtual void DisplayGridMsg()
Display current grid size in the status bar.
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.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) 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.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition eda_item.h:98
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition eda_item.h:142
const KIID m_Uuid
Definition eda_item.h:516
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
void SetBrightened()
Definition eda_item.h:135
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition eda_text.h:79
static const TOOL_EVENT ConnectivityChangedEvent
Selected item had a property changed (except movement)
Definition actions.h:350
void SetPosition(const VECTOR2I &aPos) override
void SetOrientation(const EDA_ANGLE &aNewAngle)
bool IsFlipped() const
Definition footprint.h:434
const LIB_ID & GetFPID() const
Definition footprint.h:269
void ClearAllNets()
Clear (i.e.
void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
VECTOR2I GetPosition() const override
Definition footprint.h:245
Hold a record identifying a library accessed by the appropriate footprint library #PLUGIN object in t...
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an FP_LIB_TABLE_ROW if aNickName is found in this table or in any chained fall back table frag...
FOOTPRINT * FootprintLoad(const wxString &aNickname, const wxString &aFootprintName, bool aKeepUUID=false)
Load a footprint having aFootprintName from the library given by aNickname.
A general implementation of a COLLECTORS_GUIDE.
Definition collectors.h:324
void SetIgnoreBlindBuriedVias(bool ignore)
Definition collectors.h:464
void SetIgnoreTracks(bool ignore)
Definition collectors.h:470
void SetIgnoreFootprintsOnFront(bool ignore)
Definition collectors.h:428
void SetIgnoreFPTextOnFront(bool ignore)
Definition collectors.h:416
void SetIgnoreMicroVias(bool ignore)
Definition collectors.h:467
void SetIgnoreFPTextOnBack(bool ignore)
Definition collectors.h:410
void SetIgnoreThroughVias(bool ignore)
Definition collectors.h:461
void SetIgnoreThroughHolePads(bool ignore)
Definition collectors.h:446
void SetIgnoreFPReferences(bool ignore)
Definition collectors.h:458
void SetIgnoreFPValues(bool ignore)
Definition collectors.h:452
void SetIgnoreFootprintsOnBack(bool ignore)
Definition collectors.h:422
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:104
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
Contains methods for drawing PCB-specific items.
virtual PCB_RENDER_SETTINGS * GetSettings() override
Return a pointer to current settings that are going to be used when drawing items.
PCB specific render settings.
Definition pcb_painter.h:81
void LoadColors(const COLOR_SETTINGS *aSettings) override
void LoadDisplayOptions(const PCB_DISPLAY_OPTIONS &aOptions)
Load settings related to display options (high-contrast mode, full or outline modes for vias/pads/tra...
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition pcb_view.cpp:91
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1) override
Add a VIEW_ITEM to the view.
Definition pcb_view.cpp:57
virtual void Remove(VIEW_ITEM *aItem) override
Remove a VIEW_ITEM from the view.
Definition pcb_view.cpp:74
void UpdateDisplayOptions(const PCB_DISPLAY_OPTIONS &aOptions)
Definition pcb_view.cpp:149
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
void SetDefaultFont(const wxString &aFont)
void SetGapLengthRatio(double aRatio)
void SetDashLengthRatio(double aRatio)
void SetHighlightFactor(float aFactor)
void SetSelectFactor(float aFactor)
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:86
bool IsBOARD_ITEM() const
Definition view_item.h:102
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition view.h:66
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition view.cpp:530
bool HasItem(const VIEW_ITEM *aItem) const
Indicates whether or not the given item has been added to the view.
Definition view.cpp:1671
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
Definition view.cpp:467
void RecacheAllItems()
Rebuild GAL display lists.
Definition view.cpp:1451
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
Definition view.cpp:1561
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition view.h:220
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:1571
Definition kiid.h:49
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:286
const UTF8 & GetLibItemName() const
Definition lib_id.h:102
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition lib_id.h:87
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
A class to perform either relative or absolute display origin transforms for a single axis of a point...
Definition pad.h:54
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition page_info.h:79
const VECTOR2D GetSizeIU(double aIUScale) const
Gets the page size in internal units.
Definition page_info.h:177
DISPLAY_OPTIONS m_Display
static TOOL_ACTION rehatchShapes
SEVERITY GetSeverity(int aErrorCode) const override
std::unique_ptr< wxFileSystemWatcher > m_watcher
virtual void ReloadFootprint(FOOTPRINT *aFootprint)
Reload the footprint from the library.
virtual void OnDisplayOptionsChanged()
void handleIconizeEvent(wxIconizeEvent &aEvent) override
Handle a window iconize event.
ORIGIN_TRANSFORMS & GetOriginTransforms() override
Return a reference to the default ORIGIN_TRANSFORMS object.
virtual const PCB_PLOT_PARAMS & GetPlotSettings() const
Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.
std::unique_ptr< NL_PCBNEW_PLUGIN > m_spaceMouse
wxDateTime m_watcherLastModified
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void RemoveBoardChangeListener(wxEvtHandler *aListener)
Remove aListener to from the board changed listener list.
void handleActivateEvent(wxActivateEvent &aEvent) override
Handle a window activation event.
void setFPWatcher(FOOTPRINT *aFootprint)
Create or removes a watcher on the specified footprint.
virtual void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Return bounding box of document with option to not include some items.
const VECTOR2I GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
PCBNEW_SETTINGS * GetPcbNewSettings() const
virtual void SwitchLayer(PCB_LAYER_ID aLayer)
Change the active layer in the frame.
virtual PCB_LAYER_ID GetActiveLayer() const
PCB_BASE_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
void OnModify() override
Must be called after a change in order to set the "modify" flag and update other data structures and ...
const VECTOR2I & GetAuxOrigin() const
virtual PCB_VIEWERS_SETTINGS_BASE * GetViewerSettingsBase() const
const VECTOR2I GetUserOrigin() const
virtual MAGNETIC_SETTINGS * GetMagneticItemsSettings()
std::vector< wxEvtHandler * > m_boardChangeListeners
void FocusOnItems(std::vector< BOARD_ITEM * > aItems, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, bool aAllowScroll=true)
void OnFPChange(wxFileSystemWatcherEvent &aEvent)
Handler for FP change events.
bool canCloseWindow(wxCloseEvent &aCloseEvent) override
const VECTOR2I & GetGridOrigin() const override
Return the absolute coordinates of the origin of the snap grid.
void CommonSettingsChanged(int aFlags) override
Notification event that some of the common (suite-wide) settings have changed.
const TITLE_BLOCK & GetTitleBlock() const override
const PAGE_INFO & GetPageSettings() const override
BOX2I GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
EDA_ITEM * ResolveItem(const KIID &aId, bool aAllowNullptrReturn=false) const override
Fetch an item by KIID.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
void SetDrawBgColor(const COLOR4D &aColor) override
void OnFpChangeDebounceTimer(wxTimerEvent &aEvent)
Handler for the filesystem watcher debounce timer.
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.
virtual void SetPageSettings(const PAGE_INFO &aPageSettings) override
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock) override
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
BOARD * GetBoard() const
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Return the BOARD_DESIGN_SETTINGS for the open project.
virtual void ShowChangedLanguage() override
Redraw the menus and what not in current language.
void AddBoardChangeListener(wxEvtHandler *aListener)
Add aListener to post #EDA_EVT_BOARD_CHANGED command events to.
virtual void AddFootprintToBoard(FOOTPRINT *aFootprint)
Add the given footprint to the board.
virtual void doReCreateMenuBar() override
void SetDisplayOptions(const PCB_DISPLAY_OPTIONS &aOptions, bool aRefresh=true)
Update the current display options.
GENERAL_COLLECTORS_GUIDE GetCollectorsGuide()
virtual void SetPlotSettings(const PCB_PLOT_PARAMS &aSettings)
void FocusOnItem(EDA_ITEM *aItem, bool aAllowScroll=true) override
Focus on a particular canvas item.
PCB_DISPLAY_OPTIONS m_displayOptions
FOOTPRINT_EDITOR_SETTINGS * GetFootprintEditorSettings() const
void SetGridOrigin(const VECTOR2I &aPoint) override
PCB_ORIGIN_TRANSFORMS m_originTransforms
EDA_3D_VIEWER_FRAME * CreateAndShow3D_Frame()
Show the 3D view frame.
wxTimer m_watcherDebounceTimer
EDA_3D_VIEWER_FRAME * Get3DViewerFrame()
virtual void SetActiveLayer(PCB_LAYER_ID aLayer)
virtual COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
wxFileName m_watcherFileName
virtual void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
virtual void UpdateStatusBar() override
Update the status bar information.
HIGH_CONTRAST_MODE m_ContrastModeDisplay
How inactive layers are displayed.
void UpdateColors()
Update the color settings in the painter and GAL.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void DisplayBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr)
Add all items from the current board to the VIEW, so they can be displayed by GAL.
void RedrawRatsnest()
Return the bounding box of the view that should be used if model is not valid.
Parameters and options when plotting/printing a board.
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition pgm_base.h:125
A progress reporter interface for use in multi-threaded environments.
static FP_LIB_TABLE * PcbFootprintLibs(PROJECT *aProject)
Return the table of footprint libraries without Kiway.
static void Cleanup3DCache(PROJECT *aProject)
T * GetAppSettings(const char *aFilename)
Return a handle to the a given settings by type.
Represent a set of closed polygons.
void ClearArcs()
Removes all arc references from all the outlines and holes in the polyset.
bool IsEmpty() const
Return true if the set is empty (no polygons at all)
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline)
int NewOutline()
Creates a new empty polygon in the set and returns its index.
void Deflate(int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError)
void BooleanIntersection(const SHAPE_POLY_SET &b)
Perform boolean polyset intersection.
void BooleanSubtract(const SHAPE_POLY_SET &b)
Perform boolean polyset difference.
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition title_block.h:41
TOOL_MANAGER * m_toolManager
TOOL_DISPATCHER * m_toolDispatcher
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
@ MODEL_RELOAD
Model changes (the sheet for a schematic)
Definition tool_base.h:80
@ GAL_SWITCH
Rendering engine changes.
Definition tool_base.h:82
void PostEvent(const TOOL_EVENT &aEvent)
Put an event to the event queue to be processed at the end of event processing cycle.
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
EDA_UNITS GetUserUnits() const
Handle a list of polygons defining a copper zone.
Definition zone.h:74
SHAPE_POLY_SET * Outline()
Definition zone.h:335
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
Convert the zone shape to a closed polygon Used in filling zones calculations Circles and arcs are ap...
Definition zone.cpp:1577
@ CLEANUP_FIRST
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition confirm.cpp:251
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition confirm.cpp:222
void DisplayError(wxWindow *aParent, const wxString &aText)
Display an error or warning message box with aMessage.
Definition confirm.cpp:169
This file is part of the common library.
@ ALLOW_ACUTE_CORNERS
just inflate the polygon. Acute angles create spikes
#define _(s)
Declaration of the eda_3d_viewer class.
static constexpr EDA_ANGLE ANGLE_0
Definition eda_angle.h:411
#define QUALIFIED_VIEWER3D_FRAMENAME(parent)
@ RECURSE
Definition eda_item.h:51
#define IS_NEW
New item, just created.
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition frame_type.h:33
@ FRAME_PCB_EDITOR
Definition frame_type.h:42
@ FRAME_CVPCB_DISPLAY
Definition frame_type.h:53
@ FRAME_FOOTPRINT_VIEWER
Definition frame_type.h:45
@ FRAME_FOOTPRINT_WIZARD
Definition frame_type.h:46
@ FRAME_FOOTPRINT_PREVIEW
Definition frame_type.h:48
@ FRAME_FOOTPRINT_CHOOSER
Definition frame_type.h:44
@ FRAME_FOOTPRINT_EDITOR
Definition frame_type.h:43
@ FRAME_PCB_DISPLAY3D
Definition frame_type.h:47
@ FRAME_CVPCB
Definition frame_type.h:52
static const std::string KiCadFootprintFileExtension
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition layer_ids.h:674
@ LAYER_FOOTPRINTS_FR
Show footprints on front.
Definition layer_ids.h:258
@ LAYER_FP_REFERENCES
Show footprints references (when texts are visible).
Definition layer_ids.h:265
@ LAYER_PADS
Meta control for all pads opacity/visibility (color ignored).
Definition layer_ids.h:291
@ LAYER_TRACKS
Definition layer_ids.h:266
@ LAYER_FP_TEXT
Definition layer_ids.h:239
@ LAYER_FOOTPRINTS_BK
Show footprints on back.
Definition layer_ids.h:259
@ LAYER_FP_VALUES
Show footprints values (when texts are visible).
Definition layer_ids.h:262
@ LAYER_VIAS
Meta control for all vias opacity/visibility.
Definition layer_ids.h:232
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
@ Edge_Cuts
Definition layer_ids.h:112
@ B_Mask
Definition layer_ids.h:98
@ F_Mask
Definition layer_ids.h:97
@ UNDEFINED_LAYER
Definition layer_ids.h:61
Message panel definition file.
@ COLOR
Color has changed.
Definition view_item.h:54
@ REPAINT
Item needs to be redrawn.
Definition view_item.h:58
@ GEOMETRY
Position or shape has changed.
Definition view_item.h:55
@ ALL
All except INITIAL_ADD.
Definition view_item.h:59
Declaration of the NL_PCBNEW_PLUGIN class.
wxDEFINE_EVENT(EDA_EVT_BOARD_CHANGED, wxCommandEvent)
@ THROUGH
Definition pcb_track.h:67
@ PCB_ORIGIN_AUX
@ PCB_ORIGIN_GRID
@ PCB_ORIGIN_PAGE
PGM_BASE & Pgm()
The global program "get" accessor.
Definition pgm_base.cpp:913
see class PGM_BASE
SEVERITY
@ RPT_SEVERITY_ACTION
KIWAY Kiway(KFCTL_STANDALONE)
float highlight_factor
How much to brighten highlighted objects by.
float select_factor
How much to brighten selected objects by.
wxString user_grid_x
std::vector< GRID > grids
wxString user_grid_y
Common grid settings, available to every frame.
GRID_SETTINGS grid
#define TEXTVARS_CHANGED
double RAD2DEG(double rad)
Definition trigo.h:167
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition typeinfo.h:88
@ PCB_DIM_ORTHOGONAL_T
class PCB_DIM_ORTHOGONAL, a linear dimension constrained to x/y
Definition typeinfo.h:105
@ PCB_DIM_LEADER_T
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition typeinfo.h:102
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition typeinfo.h:97
@ PCB_DIM_CENTER_T
class PCB_DIM_CENTER, a center point marking (graphic item)
Definition typeinfo.h:103
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition typeinfo.h:93
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition typeinfo.h:107
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition typeinfo.h:92
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
Definition typeinfo.h:90
@ PCB_MARKER_T
class PCB_MARKER, a marker used to show something
Definition typeinfo.h:99
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition typeinfo.h:86
@ PCB_DIM_ALIGNED_T
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
Definition typeinfo.h:101
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition typeinfo.h:87
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition typeinfo.h:98
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition typeinfo.h:96
@ PCB_DIM_RADIAL_T
class PCB_DIM_RADIAL, a radius or diameter dimension
Definition typeinfo.h:104
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695
VECTOR2< double > VECTOR2D
Definition vector2d.h:694
VECTOR2D ToVECTOR2D(const wxPoint &aPoint)
Definition vector2wx.h:40
Definition of file extensions used in Kicad.