KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_draw_panel_gal.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) 2014-2017 CERN
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 * @author Maciej Suminski <[email protected]>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 */
21
22#include "pcb_draw_panel_gal.h"
23
25#include <pcb_view.h>
27#include <pcb_painter.h>
30
31#include <board.h>
32#include <footprint.h>
33#include <pad.h>
34#include <pcb_track.h>
35#include <macros.h>
36#include <pcb_generator.h>
37#include <pcb_marker.h>
38#include <pcb_point.h>
39#include <pcb_base_frame.h>
40#include <pcbnew_settings.h>
43#include <pcb_board_outline.h>
44
45#include <pgm_base.h>
47#include <confirm.h>
48#include <progress_reporter.h>
49#include <string_utils.h>
50
52#include <zoom_defines.h>
53
54#include <functional>
55#include <memory>
56#include <thread>
57#include <fmt/format.h>
58
59using namespace std::placeholders;
60
61
62const int GAL_LAYER_ORDER[] = {
65
67
74
105
107
109
114
117 // POINT_LAYER_FOR( F_Cu ),
121
182
187
190
203
206
215
218
220
222};
223
224
225PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
226 const wxPoint& aPosition, const wxSize& aSize,
227 KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
228 EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType )
229{
230 m_view = new KIGFX::PCB_VIEW();
231 m_view->SetGAL( m_gal );
232
234
235 if( EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( aParentWindow ) )
236 frameType = frame->GetFrameType();
237
238 m_painter = std::make_unique<KIGFX::PCB_PAINTER>( m_gal, frameType );
239 m_view->SetPainter( m_painter.get() );
240
241 // This fixes the zoom in and zoom out limits:
243
246
247 // View controls is the first in the event handler chain, so the Tool Framework operates
248 // on updated viewport data.
250
251 // Load display options (such as filled/outline display of items).
252 // Can be made only if the parent window is an EDA_DRAW_FRAME (or a derived class)
253 // which is not always the case (namely when it is used from a wxDialog like the pad editor)
254 if( !IsDialogPreview() )
255 {
256 KIGFX::PCB_VIEW* view = static_cast<KIGFX::PCB_VIEW*>( m_view );
257 PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
258
259 if( frame )
260 view->UpdateDisplayOptions( frame->GetDisplayOptions() );
261 }
262}
263
264
268
269
271{
272 m_view->Clear();
273
274 aBoard->CacheTriangulation( aReporter );
275
276 if( m_drawingSheet )
277 m_drawingSheet->SetFileName( TO_UTF8( aBoard->GetFileName() ) );
278
279 // Collect all board items, expanding footprints into their children (pads, fields,
280 // graphics, zones) which are individually registered in the VIEW for rendering and
281 // selection. Then bulk-load all items in a single pass for efficient R-tree construction.
282 std::vector<KIGFX::VIEW_ITEM*> viewItems;
283
284 for( BOARD_ITEM* item : aBoard->GetItemSet() )
285 {
286 // Geometry-free items (constraints) are never rendered; VIEW::Add would stamp their
287 // view data on an empty layer set and risk a later "already in a different view" assert.
288 if( item->Type() == PCB_CONSTRAINT_T )
289 continue;
290
291 viewItems.push_back( item );
292
293 if( item->Type() == PCB_FOOTPRINT_T )
294 {
295 static_cast<FOOTPRINT*>( item )->RunOnChildren(
296 [&viewItems]( BOARD_ITEM* child )
297 {
298 if( child->Type() != PCB_CONSTRAINT_T )
299 viewItems.push_back( child );
300 },
302 }
303 }
304
305 m_view->AddBatch( viewItems );
306
307 aBoard->UpdateBoardOutline();
308 m_view->Add( aBoard->BoardOutline() );
309
310 // Ratsnest
311 if( !aBoard->IsFootprintHolder() )
312 {
313 m_ratsnest = std::make_unique<RATSNEST_VIEW_ITEM>( aBoard->GetConnectivity() );
314 m_view->Add( m_ratsnest.get() );
315 }
316}
317
318
320{
321 m_drawingSheet.reset( aDrawingSheet );
322 m_view->Add( m_drawingSheet.get() );
323}
324
325
327{
329 PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
330
331 if( frame )
332 cs = frame->GetColorSettings();
333 else if( PCBNEW_SETTINGS* cfg = GetAppSettings<PCBNEW_SETTINGS>( "pcbnew" ) )
334 cs = ::GetColorSettings( cfg->m_ColorTheme );
335
336 wxCHECK_RET( cs, wxT( "null COLOR_SETTINGS" ) );
337
338 auto rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( m_view->GetPainter()->GetSettings() );
339 rs->LoadColors( cs );
340
341 m_gal->SetGridColor( cs->GetColor( LAYER_GRID ) );
342 m_gal->SetAxesColor( cs->GetColor( LAYER_GRID_AXES ) );
343 m_gal->SetCursorColor( cs->GetColor( LAYER_CURSOR ) );
344}
345
346
348{
349 // Set display settings for high contrast mode
350 KIGFX::RENDER_SETTINGS* rSettings = m_view->GetPainter()->GetSettings();
351
352 SetTopLayer( aLayer );
353 rSettings->SetActiveLayer( aLayer );
354
355 rSettings->ClearHighContrastLayers();
356 rSettings->SetLayerIsHighContrast( aLayer );
357
358 if( IsCopperLayer( aLayer ) )
359 {
360 // Bring some other layers to the front in case of copper layers and make them colored
361 // fixme do not like the idea of storing the list of layers here,
362 // should be done in some other way I guess..
363 int layers[] = {
365 GetNetnameLayer( aLayer ),
368 PAD_COPPER_LAYER_FOR( aLayer ),
369 VIA_COPPER_LAYER_FOR( aLayer ),
370 ZONE_LAYER_FOR( aLayer ),
371 BITMAP_LAYER_FOR( aLayer ),
372 POINT_LAYER_FOR( aLayer ),
383 };
384
385 for( int i : layers )
386 rSettings->SetLayerIsHighContrast( i );
387
388 for( int i = LAYER_UI_START; i < LAYER_UI_END; ++i )
389 rSettings->SetLayerIsHighContrast( i );
390
391 // Pads should be shown too
392 if( aLayer == B_Cu )
393 {
395 }
396 else if( aLayer == F_Cu )
397 {
399 }
400 }
401
402 m_view->UpdateAllLayersColor();
403}
404
405
407{
408 m_view->ClearTopLayers();
410 m_view->SetTopLayer( aLayer );
411
412 // Layers that should always have on-top attribute enabled
413 const std::vector<int> layers = {
419 };
420
421 for( auto layer : layers )
422 m_view->SetTopLayer( layer );
423
424 for( int i = LAYER_UI_START; i < LAYER_UI_END; i++ )
425 m_view->SetTopLayer( i );
426
427 // Extra layers that are brought to the top if a F.* or B.* is selected
428 const std::vector<int> frontLayers = {
431 };
432
433 const std::vector<int> backLayers = {
436 };
437
438 const std::vector<int>* extraLayers = nullptr;
439
440 // Bring a few more extra layers to the top depending on the selected board side
441 if( IsFrontLayer( aLayer ) )
442 extraLayers = &frontLayers;
443 else if( IsBackLayer( aLayer ) )
444 extraLayers = &backLayers;
445
446 if( extraLayers )
447 {
448 for( auto layer : *extraLayers )
449 {
450 m_view->SetTopLayer( layer );
451
452 if( layer < PCB_LAYER_ID_COUNT )
453 {
454 m_view->SetTopLayer( ZONE_LAYER_FOR( layer ) );
455 m_view->SetTopLayer( PAD_COPPER_LAYER_FOR( layer ) );
456 m_view->SetTopLayer( VIA_COPPER_LAYER_FOR( layer ) );
457 m_view->SetTopLayer( CLEARANCE_LAYER_FOR( layer ) );
458 m_view->SetTopLayer( POINT_LAYER_FOR( layer ) );
459 }
460 }
461
462 // Move the active layer to the top of the stack but below all the overlay layers
463 if( !IsCopperLayer( aLayer ) )
464 {
465 m_view->SetLayerOrder( aLayer, m_view->GetLayerOrder( LAYER_MARKER_SHADOWS ) + 1 );
466 m_view->SetLayerOrder( ZONE_LAYER_FOR( aLayer ),
467 m_view->GetLayerOrder( LAYER_MARKER_SHADOWS ) + 2 );
468 m_view->SetLayerOrder( POINT_LAYER_FOR( aLayer ),
469 m_view->GetLayerOrder( LAYER_MARKER_SHADOWS ) + 3 );
470
471 // Fix up pad and via netnames to be below. This is hacky, we need a rethink
472 // of layer ordering...
473 m_view->SetLayerOrder( LAYER_PAD_NETNAMES,
474 m_view->GetLayerOrder( LAYER_MARKER_SHADOWS ) + 4 );
475 m_view->SetLayerOrder( LAYER_VIA_NETNAMES,
476 m_view->GetLayerOrder( LAYER_MARKER_SHADOWS ) + 5 );
477 }
478 }
479
480 if( IsCopperLayer( aLayer ) )
481 {
482 m_view->SetTopLayer( ZONE_LAYER_FOR( aLayer ) );
483 m_view->SetTopLayer( PAD_COPPER_LAYER_FOR( aLayer ) );
484 m_view->SetTopLayer( VIA_COPPER_LAYER_FOR( aLayer ) );
485 m_view->SetTopLayer( CLEARANCE_LAYER_FOR( aLayer ) );
486
487 // Display labels for copper layers on the top
488 m_view->SetTopLayer( GetNetnameLayer( aLayer ) );
489 }
490
491 m_view->SetTopLayer( POINT_LAYER_FOR( aLayer ) );
492 m_view->SetTopLayer( BITMAP_LAYER_FOR( aLayer ) );
493 m_view->EnableTopLayer( true );
494 m_view->UpdateAllLayersOrder();
495}
496
497
499{
500 // Load layer & elements visibility settings
501 for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
502 m_view->SetLayerVisible( i, aBoard->IsLayerVisible( PCB_LAYER_ID( i ) ) );
503
505 m_view->SetLayerVisible( i, aBoard->IsElementVisible( i ) );
506
507 // Via layers controlled by dependencies
508 m_view->SetLayerVisible( LAYER_VIA_MICROVIA, true );
509 m_view->SetLayerVisible( LAYER_VIA_BLIND, true );
510 m_view->SetLayerVisible( LAYER_VIA_BURIED, true );
511 m_view->SetLayerVisible( LAYER_VIA_THROUGH, true );
512
513 // Always enable netname layers, as their visibility is controlled by layer dependencies
514 for( int i = NETNAMES_LAYER_ID_START; i < NETNAMES_LAYER_ID_END; ++i )
515 m_view->SetLayerVisible( i, true );
516
517 for( int i = LAYER_ZONE_START; i < LAYER_ZONE_END; i++ )
518 m_view->SetLayerVisible( i, true );
519
520 for( int i = LAYER_PAD_COPPER_START; i < LAYER_PAD_COPPER_END; i++ )
521 m_view->SetLayerVisible( i, true );
522
523 for( int i = LAYER_VIA_COPPER_START; i < LAYER_VIA_COPPER_END; i++ )
524 m_view->SetLayerVisible( i, true );
525
526 for( int i = LAYER_CLEARANCE_START; i < LAYER_CLEARANCE_END; i++ )
527 m_view->SetLayerVisible( i, false );
528
529 for( int i = LAYER_POINT_START; i < LAYER_POINT_END; i++ )
530 m_view->SetLayerVisible( i, true );
531
532 for( int i = LAYER_BITMAP_START; i < LAYER_BITMAP_END; i++ )
533 m_view->SetLayerVisible( i, true );
534
535 for( int i = LAYER_UI_START; i < LAYER_UI_END; i++ )
536 m_view->SetLayerVisible( i, true );
537
538 // Enable some layers that are GAL specific
539 m_view->SetLayerVisible( LAYER_PAD_PLATEDHOLES, true );
540 m_view->SetLayerVisible( LAYER_NON_PLATEDHOLES, true );
541 m_view->SetLayerVisible( LAYER_PAD_HOLEWALLS, true );
542 m_view->SetLayerVisible( LAYER_VIA_HOLES, true );
543 m_view->SetLayerVisible( LAYER_VIA_HOLEWALLS, true );
544 m_view->SetLayerVisible( LAYER_GP_OVERLAY, true );
545 m_view->SetLayerVisible( LAYER_SELECT_OVERLAY, true );
546 m_view->SetLayerVisible( LAYER_RATSNEST, true );
547 m_view->SetLayerVisible( LAYER_MARKER_SHADOWS, true );
548 m_view->SetLayerVisible( LAYER_DRC_SHAPES, true );
549 m_view->SetLayerVisible( LAYER_DRC_HIGHLIGHTED, true );
550}
551
552
554 std::vector<MSG_PANEL_ITEM>& aList )
555{
556 BOARD* board = static_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() )->GetBoard();
557 int padCount = 0;
558 int viaCount = 0;
559 int trackSegmentCount = 0;
560 std::set<int> netCodes;
561 int unconnected = (int) board->GetConnectivity()->GetUnconnectedCount( true );
562
563 for( PCB_TRACK* item : board->Tracks() )
564 {
565 if( item->Type() == PCB_VIA_T )
566 viaCount++;
567 else
568 trackSegmentCount++;
569
570 if( item->GetNetCode() > 0 )
571 netCodes.insert( item->GetNetCode() );
572 }
573
574 for( FOOTPRINT* footprint : board->Footprints() )
575 {
576 for( PAD* pad : footprint->Pads() )
577 {
578 padCount++;
579
580 if( pad->GetNetCode() > 0 )
581 netCodes.insert( pad->GetNetCode() );
582 }
583 }
584
585 aList.emplace_back( _( "Pads" ), fmt::format( "{}", padCount ) );
586 aList.emplace_back( _( "Vias" ), fmt::format( "{}", viaCount ) );
587 aList.emplace_back( _( "Track Segments" ), fmt::format( "{}", trackSegmentCount ) );
588 aList.emplace_back( _( "Nets" ), fmt::format( "{}", (int) netCodes.size() ) );
589 aList.emplace_back( _( "Unrouted" ), fmt::format( "{}", unconnected ) );
590}
591
592
594{
595 PCB_BASE_FRAME* frame = nullptr;
596
597 if( !IsDialogPreview() )
598 frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
599
600 try
601 {
602 // Check if the current rendering back end can be properly initialized
603 m_view->UpdateItems();
604 }
605 catch( const std::runtime_error& e )
606 {
607 DisplayError( GetParent(), e.what() );
608
609 // Use the fallback if we have one
610 if( GAL_FALLBACK != m_backend )
611 {
613
614 if( frame )
615 frame->ActivateGalCanvas();
616 }
617 }
618
619 if( frame )
620 {
621 SetTopLayer( frame->GetActiveLayer() );
622
623 KIGFX::PCB_PAINTER* painter = static_cast<KIGFX::PCB_PAINTER*>( m_view->GetPainter() );
624 KIGFX::PCB_RENDER_SETTINGS* settings = painter->GetSettings();
625
626 settings->LoadDisplayOptions( frame->GetDisplayOptions() );
628 }
629}
630
631
633{
634 for( int i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( int ); ++i )
635 {
636 int layer = GAL_LAYER_ORDER[i];
637 wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
638
639 // MW: Gross hack to make SetTopLayer bring the correct bitmap layer to
640 // the top of the other bitmaps, but still below all the other layers
641 if( layer >= LAYER_BITMAP_START && layer < LAYER_BITMAP_END )
642 aView->SetLayerOrder( layer, i - KIGFX::VIEW::TOP_LAYER_MODIFIER, false );
643 else
644 aView->SetLayerOrder( layer, i, false );
645 }
646
647 aView->SortOrderedLayers();
648}
649
650
655
656
658{
659 bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
661 m_gal->SetWorldUnitLength( 1e-9 /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
662 return rv;
663}
664
665
667{
668 if( m_ratsnest )
669 m_view->Update( m_ratsnest.get() );
670}
671
672
674{
675 if( m_drawingSheet && m_view->IsLayerVisible( LAYER_DRAWINGSHEET ) )
676 return m_drawingSheet->ViewBBox();
677
678 return BOX2I();
679}
680
681
683{
684 // caching makes no sense for Cairo and other software renderers
686
687 for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
688 m_view->SetLayerTarget( i, target );
689
690 for( int i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( int ); ++i )
691 {
692 int layer = GAL_LAYER_ORDER[i];
693 wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
694
695 // Set layer display dependencies & targets
696 if( IsCopperLayer( layer ) )
697 {
698 m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
699 m_view->SetRequired( PAD_COPPER_LAYER_FOR( layer ), layer );
700 m_view->SetRequired( VIA_COPPER_LAYER_FOR( layer ), layer );
701 m_view->SetRequired( CLEARANCE_LAYER_FOR( layer ), layer );
702 m_view->SetRequired( POINT_LAYER_FOR( layer ), layer );
703
704 m_view->SetRequired( BITMAP_LAYER_FOR( layer ), layer );
705 m_view->SetLayerTarget( BITMAP_LAYER_FOR( layer ), KIGFX::TARGET_NONCACHED );
706 m_view->SetRequired( GetNetnameLayer( layer ), layer );
707 }
708 else if( IsNonCopperLayer( layer ) )
709 {
710 m_view->SetRequired( POINT_LAYER_FOR( layer ), layer );
711 m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
712 m_view->SetLayerTarget( BITMAP_LAYER_FOR( layer ), KIGFX::TARGET_NONCACHED );
713 m_view->SetRequired( BITMAP_LAYER_FOR( layer ), layer );
714 }
715 else if( IsNetnameLayer( layer ) )
716 {
717 m_view->SetLayerDisplayOnly( layer );
718 }
719 }
720
721 m_view->SetLayerTarget( LAYER_ANCHOR, KIGFX::TARGET_NONCACHED );
722 m_view->SetLayerDisplayOnly( LAYER_ANCHOR );
723
724 // Use TARGET_OVERLAY for LAYER_CONFLICTS_SHADOW, it is for items
725 // that may change while the view stays the same.
727
728 // Constraint shadow drawn under item like locked-item shadow
729 // kept on cached target not overlay and re-cached on set change
730 m_view->SetLayerDisplayOnly( LAYER_LOCKED_ITEM_SHADOW );
731 m_view->SetLayerDisplayOnly( LAYER_CONFLICTS_SHADOW );
732 m_view->SetLayerDisplayOnly( LAYER_CONSTRAINT_SHADOW );
733 m_view->SetLayerDisplayOnly( LAYER_BOARD_OUTLINE_AREA );
734
735 // Some more required layers settings
736 m_view->SetRequired( LAYER_PAD_NETNAMES, LAYER_PADS );
737
738 // Holes can be independent of their host objects (cf: printing drill marks)
739 m_view->SetRequired( LAYER_VIA_HOLES, LAYER_VIAS );
740 m_view->SetRequired( LAYER_VIA_HOLEWALLS, LAYER_VIAS );
741 m_view->SetRequired( LAYER_PAD_PLATEDHOLES, LAYER_PADS );
742 m_view->SetRequired( LAYER_PAD_HOLEWALLS, LAYER_PADS );
743 m_view->SetRequired( LAYER_NON_PLATEDHOLES, LAYER_PADS );
744
745 // Via visibility
746 m_view->SetRequired( LAYER_VIA_MICROVIA, LAYER_VIAS );
747 m_view->SetRequired( LAYER_VIA_BLIND, LAYER_VIAS );
748 m_view->SetRequired( LAYER_VIA_BURIED, LAYER_VIAS );
749 m_view->SetRequired( LAYER_VIA_THROUGH, LAYER_VIAS );
750 m_view->SetRequired( LAYER_VIA_NETNAMES, LAYER_VIAS );
751
753 m_view->SetLayerDisplayOnly( LAYER_SELECT_OVERLAY ) ;
755 m_view->SetLayerDisplayOnly( LAYER_GP_OVERLAY ) ;
756 m_view->SetLayerTarget( LAYER_RATSNEST, KIGFX::TARGET_OVERLAY );
757 m_view->SetLayerDisplayOnly( LAYER_RATSNEST );
758
759 m_view->SetLayerTarget( LAYER_DRC_ERROR, KIGFX::TARGET_OVERLAY );
763 m_view->SetLayerDisplayOnly( LAYER_MARKER_SHADOWS );
765 m_view->SetLayerDisplayOnly( LAYER_DRC_SHAPES ); // markers can't be selected through shapes
766
768 m_view->SetLayerDisplayOnly( LAYER_DRAWINGSHEET ) ; // drawing sheet can't be selected
769 m_view->SetLayerDisplayOnly( LAYER_GRID ); // grid can't be selected
770
771 for( int i = LAYER_UI_START; i < LAYER_UI_END; ++i )
772 {
773 m_view->SetLayerTarget( i, KIGFX::TARGET_OVERLAY );
774 m_view->SetLayerDisplayOnly( i );
775 }
776}
777
778
780{
781 return static_cast<KIGFX::PCB_VIEW*>( m_view );
782}
BOX2< VECTOR2I > BOX2I
Definition box2.h:918
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:83
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:373
bool IsFootprintHolder() const
Find out if the board is being used to hold a single footprint for editing/viewing.
Definition board.h:403
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition board.cpp:1109
PCB_BOARD_OUTLINE * BoardOutline()
Definition board.h:436
void UpdateBoardOutline()
Definition board.cpp:4151
const FOOTPRINTS & Footprints() const
Definition board.h:421
const BOARD_ITEM_SET GetItemSet()
Collect every owned item (tracks, zones, generators, footprints, drawings, markers,...
Definition board.cpp:4056
const TRACKS & Tracks() const
Definition board.h:419
const wxString & GetFileName() const
Definition board.h:410
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer...
Definition board.cpp:1049
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition board.h:646
void CacheTriangulation(PROGRESS_REPORTER *aReporter=nullptr, const std::vector< ZONE * > &aZones={})
Definition board.cpp:1216
Color settings are a bit different than most of the settings objects in that there can be more than o...
COLOR4D GetColor(int aLayer) const
unsigned int GetUnconnectedCount(bool aVisibileOnly) const
The base frame for deriving all KiCad main window classes.
The base class for create windows for drawing purpose.
static constexpr GAL_TYPE GAL_FALLBACK
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
EDA_DRAW_PANEL_GAL(wxWindow *aParentWindow, wxWindowID aWindowId, const wxPoint &aPosition, const wxSize &aSize, KIGFX::GAL_DISPLAY_OPTIONS &aOptions, GAL_TYPE aGalType=GAL_TYPE_OPENGL)
Create a drawing panel that is contained inside aParentWindow.
@ GAL_TYPE_OPENGL
OpenGL implementation.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
virtual bool SwitchBackend(GAL_TYPE aGalType)
Switch method of rendering graphics.
GAL_TYPE m_backend
Currently used GAL.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:108
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:80
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...
void UpdateDisplayOptions(const PCB_DISPLAY_OPTIONS &aOptions)
Definition pcb_view.cpp:145
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
void ClearHighContrastLayers()
Clear the list of active layers.
void SetActiveLayer(PCB_LAYER_ID aLayer)
void SetLayerIsHighContrast(int aLayerId, bool aEnabled=true)
Set the specified layer as high-contrast.
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition view.h:63
static constexpr int TOP_LAYER_MODIFIER
Rendering order modifier for layers that are marked as top layers.
Definition view.h:774
void SetLayerOrder(int aLayer, int aRenderingOrder, bool aAutoSort=true)
Set rendering order of a particular layer.
Definition view.cpp:723
static constexpr int VIEW_MAX_LAYERS
Maximum number of layers that may be shown.
Definition view.h:771
void SortOrderedLayers()
Sorts m_orderedLayers after layer rendering order has changed.
Definition view.cpp:1366
An implementation of class VIEW_CONTROLS for wxWidgets library.
Definition pad.h:61
DISPLAY_OPTIONS m_Display
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
PCBNEW_SETTINGS * GetPcbNewSettings() const
virtual void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
virtual PCB_LAYER_ID GetActiveLayer() const
virtual COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
void UpdateColors()
Update the color settings in the painter and GAL.
PCB_DRAW_PANEL_GAL(wxWindow *aParentWindow, wxWindowID aWindowId, const wxPoint &aPosition, const wxSize &aSize, KIGFX::GAL_DISPLAY_OPTIONS &aOptions, GAL_TYPE aGalType=GAL_TYPE_OPENGL)
BOX2I GetDefaultViewBBox() const override
Return the bounding box of the view that should be used if model is not valid.
virtual void SetTopLayer(int aLayer) override
SetTopLayer(), with some extra smarts for PCB.
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Called when the window is shown for the first time.
std::unique_ptr< RATSNEST_VIEW_ITEM > m_ratsnest
Ratsnest view item.
void SetDrawingSheet(DS_PROXY_VIEW_ITEM *aDrawingSheet)
Sets (or updates) drawing-sheet used by the draw panel.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void OnShow() override
Called when the window is shown for the first time.
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 SyncLayersVisibility(const BOARD *aBoard)
Update "visibility" property of each layer of a given BOARD.
void setDefaultLayerOrder()
< Reassign layer order to the initial settings.
virtual void SetHighContrastLayer(int aLayer) override
SetHighContrastLayer(), with some extra smarts for PCB.
std::unique_ptr< DS_PROXY_VIEW_ITEM > m_drawingSheet
Currently used drawing-sheet.
bool SwitchBackend(GAL_TYPE aGalType) override
Force refresh of the ratsnest visual representation.
void RedrawRatsnest()
Return the bounding box of the view that should be used if model is not valid.
A progress reporter interface for use in multi-threaded environments.
void DisplayError(wxWindow *aParent, const wxString &aText)
Display an error or warning message box with aMessage.
Definition confirm.cpp:192
This file is part of the common library.
#define _(s)
@ NO_RECURSE
Definition eda_item.h:50
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition frame_type.h:29
@ FRAME_FOOTPRINT_PREVIEW
Definition frame_type.h:44
@ LAYER_PAD_FR_NETNAMES
Additional netnames layers (not associated with a PCB layer).
Definition layer_ids.h:196
@ LAYER_PAD_BK_NETNAMES
Definition layer_ids.h:197
@ LAYER_PAD_NETNAMES
Definition layer_ids.h:198
@ NETNAMES_LAYER_ID_START
Definition layer_ids.h:190
@ NETNAMES_LAYER_ID_END
Definition layer_ids.h:201
@ LAYER_VIA_NETNAMES
Definition layer_ids.h:199
#define BITMAP_LAYER_FOR(boardLayer)
Macros for getting the extra layers for a given board layer.
Definition layer_ids.h:373
#define NETNAMES_LAYER_INDEX(layer)
Macro for obtaining netname layer for a given PCB layer.
Definition layer_ids.h:205
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
Definition layer_ids.h:786
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
Definition layer_ids.h:809
#define POINT_LAYER_FOR(boardLayer)
Definition layer_ids.h:378
bool IsNonCopperLayer(int aLayerId)
Test whether a layer is a non copper layer.
Definition layer_ids.h:716
int GetNetnameLayer(int aLayer)
Return a netname layer corresponding to the given layer.
Definition layer_ids.h:860
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition layer_ids.h:683
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition layer_ids.h:224
@ LAYER_GRID
Definition layer_ids.h:250
@ LAYER_POINTS
PCB reference/manual snap points visibility.
Definition layer_ids.h:317
@ GAL_LAYER_ID_START
Definition layer_ids.h:225
@ LAYER_LOCKED_ITEM_SHADOW
Shadow layer for locked items.
Definition layer_ids.h:303
@ LAYER_PAD_COPPER_START
Virtual layers for pad copper on a given copper layer.
Definition layer_ids.h:343
@ LAYER_VIA_HOLEWALLS
Definition layer_ids.h:294
@ LAYER_CLEARANCE_END
Definition layer_ids.h:352
@ LAYER_GRID_AXES
Definition layer_ids.h:251
@ LAYER_CONFLICTS_SHADOW
Shadow layer for items flagged conflicting.
Definition layer_ids.h:306
@ LAYER_FOOTPRINTS_FR
Show footprints on front.
Definition layer_ids.h:255
@ LAYER_ZONE_END
Definition layer_ids.h:340
@ LAYER_NON_PLATEDHOLES
Draw usual through hole vias.
Definition layer_ids.h:235
@ LAYER_DRAWINGSHEET
Sheet frame and title block.
Definition layer_ids.h:274
@ LAYER_FP_REFERENCES
Show footprints references (when texts are visible).
Definition layer_ids.h:262
@ LAYER_BOARD_OUTLINE_AREA
PCB board outline.
Definition layer_ids.h:314
@ LAYER_DRC_EXCLUSION
Layer for DRC markers which have been individually excluded.
Definition layer_ids.h:300
@ LAYER_POINT_END
Definition layer_ids.h:360
@ LAYER_DRC_HIGHLIGHTED
Color for highlighted DRC markers.
Definition layer_ids.h:331
@ LAYER_DRC_SHAPES
Custom shapes for DRC markers.
Definition layer_ids.h:311
@ LAYER_PADS
Meta control for all pads opacity/visibility (color ignored).
Definition layer_ids.h:288
@ LAYER_DRC_WARNING
Layer for DRC markers with #SEVERITY_WARNING.
Definition layer_ids.h:297
@ LAYER_UI_START
Definition layer_ids.h:363
@ LAYER_PAD_PLATEDHOLES
to draw pad holes (plated)
Definition layer_ids.h:267
@ GAL_LAYER_ID_END
Definition layer_ids.h:366
@ LAYER_GP_OVERLAY
General purpose overlay.
Definition layer_ids.h:275
@ LAYER_VIA_COPPER_START
Virtual layers for via copper on a given copper layer.
Definition layer_ids.h:347
@ LAYER_CONSTRAINT_SHADOW
Shadow layer for items bound to a constraint.
Definition layer_ids.h:320
@ LAYER_CURSOR
PCB cursor.
Definition layer_ids.h:278
@ LAYER_RATSNEST
Definition layer_ids.h:249
@ LAYER_CLEARANCE_START
Virtual layers for pad/via/track clearance outlines for a given copper layer.
Definition layer_ids.h:351
@ LAYER_PAD_COPPER_END
Definition layer_ids.h:344
@ LAYER_ZONE_START
Virtual layers for stacking zones and tracks on a given copper layer.
Definition layer_ids.h:339
@ LAYER_FP_TEXT
Definition layer_ids.h:236
@ LAYER_FOOTPRINTS_BK
Show footprints on back.
Definition layer_ids.h:256
@ LAYER_UI_END
Definition layer_ids.h:364
@ LAYER_ANCHOR
Anchor of items having an anchor point (texts, footprints).
Definition layer_ids.h:244
@ LAYER_VIA_BURIED
Draw blind vias.
Definition layer_ids.h:231
@ LAYER_VIA_COPPER_END
Definition layer_ids.h:348
@ LAYER_MARKER_SHADOWS
Shadows for DRC markers.
Definition layer_ids.h:301
@ LAYER_VIA_HOLES
Draw via holes (pad holes do not use this layer).
Definition layer_ids.h:270
@ LAYER_VIA_BLIND
Draw micro vias.
Definition layer_ids.h:230
@ LAYER_FP_VALUES
Show footprints values (when texts are visible).
Definition layer_ids.h:259
@ LAYER_POINT_START
Virtual layers for points per board layer.
Definition layer_ids.h:359
@ LAYER_VIA_MICROVIA
Definition layer_ids.h:229
@ LAYER_SELECT_OVERLAY
Selected items overlay.
Definition layer_ids.h:276
@ LAYER_VIA_THROUGH
Draw buried vias.
Definition layer_ids.h:232
@ LAYER_BITMAP_END
Definition layer_ids.h:356
@ LAYER_BITMAP_START
Virtual layers for background images per board layer.
Definition layer_ids.h:355
@ LAYER_DRC_ERROR
Layer for DRC markers with #SEVERITY_ERROR.
Definition layer_ids.h:273
@ LAYER_VIAS
Meta control for all vias opacity/visibility.
Definition layer_ids.h:228
@ LAYER_PAD_HOLEWALLS
Definition layer_ids.h:293
#define CLEARANCE_LAYER_FOR(boardLayer)
Definition layer_ids.h:377
bool IsNetnameLayer(int aLayer)
Test whether a layer is a netname layer.
Definition layer_ids.h:875
#define VIA_COPPER_LAYER_FOR(boardLayer)
Definition layer_ids.h:376
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:56
@ User_16
Definition layer_ids.h:135
@ In22_Cu
Definition layer_ids.h:83
@ In11_Cu
Definition layer_ids.h:72
@ User_29
Definition layer_ids.h:148
@ In29_Cu
Definition layer_ids.h:90
@ In30_Cu
Definition layer_ids.h:91
@ User_40
Definition layer_ids.h:159
@ User_15
Definition layer_ids.h:134
@ User_8
Definition layer_ids.h:127
@ F_CrtYd
Definition layer_ids.h:112
@ User_11
Definition layer_ids.h:130
@ User_25
Definition layer_ids.h:144
@ In17_Cu
Definition layer_ids.h:78
@ User_34
Definition layer_ids.h:153
@ User_45
Definition layer_ids.h:164
@ B_Adhes
Definition layer_ids.h:99
@ User_36
Definition layer_ids.h:155
@ Edge_Cuts
Definition layer_ids.h:108
@ Dwgs_User
Definition layer_ids.h:103
@ F_Paste
Definition layer_ids.h:100
@ In9_Cu
Definition layer_ids.h:70
@ Cmts_User
Definition layer_ids.h:104
@ User_6
Definition layer_ids.h:125
@ User_7
Definition layer_ids.h:126
@ In19_Cu
Definition layer_ids.h:80
@ User_19
Definition layer_ids.h:138
@ User_23
Definition layer_ids.h:142
@ In7_Cu
Definition layer_ids.h:68
@ In28_Cu
Definition layer_ids.h:89
@ In26_Cu
Definition layer_ids.h:87
@ F_Adhes
Definition layer_ids.h:98
@ User_41
Definition layer_ids.h:160
@ B_Mask
Definition layer_ids.h:94
@ B_Cu
Definition layer_ids.h:61
@ User_14
Definition layer_ids.h:133
@ User_39
Definition layer_ids.h:158
@ User_5
Definition layer_ids.h:124
@ User_20
Definition layer_ids.h:139
@ Eco1_User
Definition layer_ids.h:105
@ F_Mask
Definition layer_ids.h:93
@ In21_Cu
Definition layer_ids.h:82
@ User_42
Definition layer_ids.h:161
@ User_43
Definition layer_ids.h:162
@ In23_Cu
Definition layer_ids.h:84
@ B_Paste
Definition layer_ids.h:101
@ In15_Cu
Definition layer_ids.h:76
@ In2_Cu
Definition layer_ids.h:63
@ User_10
Definition layer_ids.h:129
@ User_9
Definition layer_ids.h:128
@ User_27
Definition layer_ids.h:146
@ User_28
Definition layer_ids.h:147
@ F_Fab
Definition layer_ids.h:115
@ In10_Cu
Definition layer_ids.h:71
@ Margin
Definition layer_ids.h:109
@ F_SilkS
Definition layer_ids.h:96
@ In4_Cu
Definition layer_ids.h:65
@ B_CrtYd
Definition layer_ids.h:111
@ Eco2_User
Definition layer_ids.h:106
@ In16_Cu
Definition layer_ids.h:77
@ In24_Cu
Definition layer_ids.h:85
@ In1_Cu
Definition layer_ids.h:62
@ User_35
Definition layer_ids.h:154
@ User_31
Definition layer_ids.h:150
@ User_3
Definition layer_ids.h:122
@ User_1
Definition layer_ids.h:120
@ User_12
Definition layer_ids.h:131
@ B_SilkS
Definition layer_ids.h:97
@ User_30
Definition layer_ids.h:149
@ User_37
Definition layer_ids.h:156
@ User_22
Definition layer_ids.h:141
@ User_38
Definition layer_ids.h:157
@ In13_Cu
Definition layer_ids.h:74
@ User_4
Definition layer_ids.h:123
@ In8_Cu
Definition layer_ids.h:69
@ User_21
Definition layer_ids.h:140
@ In14_Cu
Definition layer_ids.h:75
@ User_24
Definition layer_ids.h:143
@ PCB_LAYER_ID_COUNT
Definition layer_ids.h:167
@ User_13
Definition layer_ids.h:132
@ User_2
Definition layer_ids.h:121
@ In12_Cu
Definition layer_ids.h:73
@ User_17
Definition layer_ids.h:136
@ In27_Cu
Definition layer_ids.h:88
@ In6_Cu
Definition layer_ids.h:67
@ In5_Cu
Definition layer_ids.h:66
@ User_33
Definition layer_ids.h:152
@ User_26
Definition layer_ids.h:145
@ In3_Cu
Definition layer_ids.h:64
@ User_32
Definition layer_ids.h:151
@ In20_Cu
Definition layer_ids.h:81
@ User_18
Definition layer_ids.h:137
@ User_44
Definition layer_ids.h:163
@ F_Cu
Definition layer_ids.h:60
@ In18_Cu
Definition layer_ids.h:79
@ In25_Cu
Definition layer_ids.h:86
@ B_Fab
Definition layer_ids.h:114
#define ZONE_LAYER_FOR(boardLayer)
Definition layer_ids.h:374
#define PAD_COPPER_LAYER_FOR(boardLayer)
Definition layer_ids.h:375
This file contains miscellaneous commonly used macros and functions.
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition definitions.h:34
@ TARGET_CACHED
Main rendering target (cached)
Definition definitions.h:33
@ TARGET_OVERLAY
Items that may change while the view stays the same (noncached)
Definition definitions.h:35
const int GAL_LAYER_ORDER[]
void ApplyPcbGalLayerOrder(KIGFX::VIEW *aView)
Apply pcbnew's canonical GAL layer order (copper and zones below silk, fab and courtyard) to any view...
void ApplyPcbGalLayerOrder(KIGFX::VIEW *aView)
Apply pcbnew's canonical GAL layer order (copper and zones below silk, fab and courtyard) to any view...
see class PGM_BASE
Class that computes missing connections on a PCB.
#define DEFAULT_THEME
COLOR_SETTINGS * GetColorSettings(const wxString &aName)
T * GetAppSettings(const char *aFilename)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
@ PCB_CONSTRAINT_T
class PCB_CONSTRAINT, a geometric constraint between board items
Definition typeinfo.h:238
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition typeinfo.h:90
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition typeinfo.h:79
WX_VIEW_CONTROLS class definition.
#define ZOOM_MAX_LIMIT_PCBNEW
#define ZOOM_MIN_LIMIT_PCBNEW