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, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include "pcb_draw_panel_gal.h"
27
29#include <pcb_view.h>
31#include <pcb_painter.h>
34
35#include <board.h>
36#include <footprint.h>
37#include <pcb_track.h>
38#include <macros.h>
39#include <pcb_generator.h>
40#include <pcb_marker.h>
41#include <pcb_point.h>
42#include <pcb_base_frame.h>
43#include <pcbnew_settings.h>
46#include <pcb_board_outline.h>
47
48#include <pgm_base.h>
50#include <confirm.h>
51#include <progress_reporter.h>
52#include <string_utils.h>
53
55#include <zoom_defines.h>
56
57#include <functional>
58#include <memory>
59#include <thread>
60#include <fmt/format.h>
61
62using namespace std::placeholders;
63
64
65const int GAL_LAYER_ORDER[] =
66{
77
81
90
136
138
140
148
154 // POINT_LAYER_FOR( F_Cu ),
162
283
297
302
348
356
387
395
397
399};
400
401
402PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
403 const wxPoint& aPosition, const wxSize& aSize,
404 KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
405 EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType )
406{
407 m_view = new KIGFX::PCB_VIEW();
408 m_view->SetGAL( m_gal );
409
411
412 if( EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( aParentWindow ) )
413 frameType = frame->GetFrameType();
414
415 m_painter = std::make_unique<KIGFX::PCB_PAINTER>( m_gal, frameType );
416 m_view->SetPainter( m_painter.get() );
417
418 // This fixes the zoom in and zoom out limits:
420
423
424 // View controls is the first in the event handler chain, so the Tool Framework operates
425 // on updated viewport data.
427
428 // Load display options (such as filled/outline display of items).
429 // Can be made only if the parent window is an EDA_DRAW_FRAME (or a derived class)
430 // which is not always the case (namely when it is used from a wxDialog like the pad editor)
431 if( !IsDialogPreview() )
432 {
433 KIGFX::PCB_VIEW* view = static_cast<KIGFX::PCB_VIEW*>( m_view );
434 PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
435
436 if( frame )
437 view->UpdateDisplayOptions( frame->GetDisplayOptions() );
438 }
439}
440
441
445
446
448{
449 m_view->Clear();
450
451 aBoard->CacheTriangulation( aReporter );
452
453 if( m_drawingSheet )
454 m_drawingSheet->SetFileName( TO_UTF8( aBoard->GetFileName() ) );
455
456 for( BOARD_ITEM* item : aBoard->GetItemSet() )
457 m_view->Add( item );
458
459 aBoard->UpdateBoardOutline();
460 m_view->Add( aBoard->BoardOutline() );
461
462 // Ratsnest
463 if( !aBoard->IsFootprintHolder() )
464 {
465 m_ratsnest = std::make_unique<RATSNEST_VIEW_ITEM>( aBoard->GetConnectivity() );
466 m_view->Add( m_ratsnest.get() );
467 }
468}
469
470
472{
473 m_drawingSheet.reset( aDrawingSheet );
474 m_view->Add( m_drawingSheet.get() );
475}
476
477
479{
481 PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
482
483 if( frame )
484 cs = frame->GetColorSettings();
485 else if( PCBNEW_SETTINGS* cfg = GetAppSettings<PCBNEW_SETTINGS>( "pcbnew" ) )
486 cs = ::GetColorSettings( cfg->m_ColorTheme );
487
488 wxCHECK_RET( cs, wxT( "null COLOR_SETTINGS" ) );
489
490 auto rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( m_view->GetPainter()->GetSettings() );
491 rs->LoadColors( cs );
492
493 m_gal->SetGridColor( cs->GetColor( LAYER_GRID ) );
494 m_gal->SetAxesColor( cs->GetColor( LAYER_GRID_AXES ) );
495 m_gal->SetCursorColor( cs->GetColor( LAYER_CURSOR ) );
496}
497
498
500{
501 // Set display settings for high contrast mode
502 KIGFX::RENDER_SETTINGS* rSettings = m_view->GetPainter()->GetSettings();
503
504 SetTopLayer( aLayer );
505 rSettings->SetActiveLayer( aLayer );
506
507 rSettings->ClearHighContrastLayers();
508 rSettings->SetLayerIsHighContrast( aLayer );
509
510 if( IsCopperLayer( aLayer ) )
511 {
512 // Bring some other layers to the front in case of copper layers and make them colored
513 // fixme do not like the idea of storing the list of layers here,
514 // should be done in some other way I guess..
515 int layers[] = {
517 GetNetnameLayer( aLayer ),
520 PAD_COPPER_LAYER_FOR( aLayer ),
521 VIA_COPPER_LAYER_FOR( aLayer ),
522 ZONE_LAYER_FOR( aLayer ),
523 BITMAP_LAYER_FOR( aLayer ),
524 POINT_LAYER_FOR( aLayer ),
534 };
535
536 for( int i : layers )
537 rSettings->SetLayerIsHighContrast( i );
538
539 for( int i = LAYER_UI_START; i < LAYER_UI_END; ++i )
540 rSettings->SetLayerIsHighContrast( i );
541
542 // Pads should be shown too
543 if( aLayer == B_Cu )
544 {
546 }
547 else if( aLayer == F_Cu )
548 {
550 }
551 }
552
553 m_view->UpdateAllLayersColor();
554}
555
556
558{
559 m_view->ClearTopLayers();
561 m_view->SetTopLayer( aLayer );
562
563 // Layers that should always have on-top attribute enabled
564 const std::vector<int> layers = {
574 };
575
576 for( auto layer : layers )
577 m_view->SetTopLayer( layer );
578
579 for( int i = LAYER_UI_START; i < LAYER_UI_END; i++ )
580 m_view->SetTopLayer( i );
581
582 // Extra layers that are brought to the top if a F.* or B.* is selected
583 const std::vector<int> frontLayers = {
586 };
587
588 const std::vector<int> backLayers = {
591 };
592
593 const std::vector<int>* extraLayers = nullptr;
594
595 // Bring a few more extra layers to the top depending on the selected board side
596 if( IsFrontLayer( aLayer ) )
597 extraLayers = &frontLayers;
598 else if( IsBackLayer( aLayer ) )
599 extraLayers = &backLayers;
600
601 if( extraLayers )
602 {
603 for( auto layer : *extraLayers )
604 {
605 m_view->SetTopLayer( layer );
606
607 if( layer < PCB_LAYER_ID_COUNT )
608 {
609 m_view->SetTopLayer( ZONE_LAYER_FOR( layer ) );
610 m_view->SetTopLayer( PAD_COPPER_LAYER_FOR( layer ) );
611 m_view->SetTopLayer( VIA_COPPER_LAYER_FOR( layer ) );
612 m_view->SetTopLayer( CLEARANCE_LAYER_FOR( layer ) );
613 m_view->SetTopLayer( POINT_LAYER_FOR( layer ) );
614 }
615 }
616
617 // Move the active layer to the top of the stack but below all the overlay layers
618 if( !IsCopperLayer( aLayer ) )
619 {
620 m_view->SetLayerOrder( aLayer, m_view->GetLayerOrder( LAYER_MARKER_SHADOWS ) + 1 );
621 m_view->SetLayerOrder( ZONE_LAYER_FOR( aLayer ),
622 m_view->GetLayerOrder( LAYER_MARKER_SHADOWS ) + 2 );
623 m_view->SetLayerOrder( POINT_LAYER_FOR( aLayer ),
624 m_view->GetLayerOrder( LAYER_MARKER_SHADOWS ) + 3 );
625
626 // Fix up pad and via netnames to be below. This is hacky, we need a rethink
627 // of layer ordering...
628 m_view->SetLayerOrder( LAYER_PAD_NETNAMES,
629 m_view->GetLayerOrder( LAYER_MARKER_SHADOWS ) + 4 );
630 m_view->SetLayerOrder( LAYER_VIA_NETNAMES,
631 m_view->GetLayerOrder( LAYER_MARKER_SHADOWS ) + 5 );
632 }
633 }
634
635 if( IsCopperLayer( aLayer ) )
636 {
637 m_view->SetTopLayer( ZONE_LAYER_FOR( aLayer ) );
638 m_view->SetTopLayer( PAD_COPPER_LAYER_FOR( aLayer ) );
639 m_view->SetTopLayer( VIA_COPPER_LAYER_FOR( aLayer ) );
640 m_view->SetTopLayer( CLEARANCE_LAYER_FOR( aLayer ) );
641
642 // Display labels for copper layers on the top
643 m_view->SetTopLayer( GetNetnameLayer( aLayer ) );
644 }
645
646 m_view->SetTopLayer( POINT_LAYER_FOR( aLayer ) );
647 m_view->SetTopLayer( BITMAP_LAYER_FOR( aLayer ) );
648 m_view->EnableTopLayer( true );
649 m_view->UpdateAllLayersOrder();
650}
651
652
654{
655 // Load layer & elements visibility settings
656 for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
657 m_view->SetLayerVisible( i, aBoard->IsLayerVisible( PCB_LAYER_ID( i ) ) );
658
660 m_view->SetLayerVisible( i, aBoard->IsElementVisible( i ) );
661
662 // Via layers controlled by dependencies
663 m_view->SetLayerVisible( LAYER_VIA_MICROVIA, true );
664 m_view->SetLayerVisible( LAYER_VIA_BLIND, true );
665 m_view->SetLayerVisible( LAYER_VIA_BURIED, true );
666 m_view->SetLayerVisible( LAYER_VIA_THROUGH, true );
667
668 // Always enable netname layers, as their visibility is controlled by layer dependencies
669 for( int i = NETNAMES_LAYER_ID_START; i < NETNAMES_LAYER_ID_END; ++i )
670 m_view->SetLayerVisible( i, true );
671
672 for( int i = LAYER_ZONE_START; i < LAYER_ZONE_END; i++ )
673 m_view->SetLayerVisible( i, true );
674
675 for( int i = LAYER_PAD_COPPER_START; i < LAYER_PAD_COPPER_END; i++ )
676 m_view->SetLayerVisible( i, true );
677
678 for( int i = LAYER_VIA_COPPER_START; i < LAYER_VIA_COPPER_END; i++ )
679 m_view->SetLayerVisible( i, true );
680
681 for( int i = LAYER_CLEARANCE_START; i < LAYER_CLEARANCE_END; i++ )
682 m_view->SetLayerVisible( i, false );
683
684 for( int i = LAYER_POINT_START; i < LAYER_POINT_END; i++ )
685 m_view->SetLayerVisible( i, true );
686
687 for( int i = LAYER_BITMAP_START; i < LAYER_BITMAP_END; i++ )
688 m_view->SetLayerVisible( i, true );
689
690 for( int i = LAYER_UI_START; i < LAYER_UI_END; i++ )
691 m_view->SetLayerVisible( i, true );
692
693 // Enable some layers that are GAL specific
694 m_view->SetLayerVisible( LAYER_PAD_PLATEDHOLES, true );
695 m_view->SetLayerVisible( LAYER_NON_PLATEDHOLES, true );
696 m_view->SetLayerVisible( LAYER_PAD_HOLEWALLS, true );
697 m_view->SetLayerVisible( LAYER_VIA_HOLES, true );
698 m_view->SetLayerVisible( LAYER_VIA_HOLEWALLS, true );
699 m_view->SetLayerVisible( LAYER_GP_OVERLAY, true );
700 m_view->SetLayerVisible( LAYER_SELECT_OVERLAY, true );
701 m_view->SetLayerVisible( LAYER_RATSNEST, true );
702 m_view->SetLayerVisible( LAYER_MARKER_SHADOWS, true );
703 m_view->SetLayerVisible( LAYER_DRC_SHAPES, true );
704}
705
706
708 std::vector<MSG_PANEL_ITEM>& aList )
709{
710 BOARD* board = static_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() )->GetBoard();
711 int padCount = 0;
712 int viaCount = 0;
713 int trackSegmentCount = 0;
714 std::set<int> netCodes;
715 int unconnected = (int) board->GetConnectivity()->GetUnconnectedCount( true );
716
717 for( PCB_TRACK* item : board->Tracks() )
718 {
719 if( item->Type() == PCB_VIA_T )
720 viaCount++;
721 else
722 trackSegmentCount++;
723
724 if( item->GetNetCode() > 0 )
725 netCodes.insert( item->GetNetCode() );
726 }
727
728 for( FOOTPRINT* footprint : board->Footprints() )
729 {
730 for( PAD* pad : footprint->Pads() )
731 {
732 padCount++;
733
734 if( pad->GetNetCode() > 0 )
735 netCodes.insert( pad->GetNetCode() );
736 }
737 }
738
739 aList.emplace_back( _( "Pads" ), fmt::format( "{}", padCount ) );
740 aList.emplace_back( _( "Vias" ), fmt::format( "{}", viaCount ) );
741 aList.emplace_back( _( "Track Segments" ), fmt::format( "{}", trackSegmentCount ) );
742 aList.emplace_back( _( "Nets" ), fmt::format( "{}", (int) netCodes.size() ) );
743 aList.emplace_back( _( "Unrouted" ), fmt::format( "{}", unconnected ) );
744}
745
746
748{
749 PCB_BASE_FRAME* frame = nullptr;
750
751 if( !IsDialogPreview() )
752 frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
753
754 try
755 {
756 // Check if the current rendering back end can be properly initialized
757 m_view->UpdateItems();
758 }
759 catch( const std::runtime_error& e )
760 {
761 DisplayError( GetParent(), e.what() );
762
763 // Use the fallback if we have one
764 if( GAL_FALLBACK != m_backend )
765 {
767
768 if( frame )
769 frame->ActivateGalCanvas();
770 }
771 }
772
773 if( frame )
774 {
775 SetTopLayer( frame->GetActiveLayer() );
776
777 KIGFX::PCB_PAINTER* painter = static_cast<KIGFX::PCB_PAINTER*>( m_view->GetPainter() );
778 KIGFX::PCB_RENDER_SETTINGS* settings = painter->GetSettings();
779
780 settings->LoadDisplayOptions( frame->GetDisplayOptions() );
782 }
783}
784
785
787{
788 for( int i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( int ); ++i )
789 {
790 int layer = GAL_LAYER_ORDER[i];
791 wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
792
793 // MW: Gross hack to make SetTopLayer bring the correct bitmap layer to
794 // the top of the other bitmaps, but still below all the other layers
795 if( layer >= LAYER_BITMAP_START && layer < LAYER_BITMAP_END )
796 m_view->SetLayerOrder( layer, i - KIGFX::VIEW::TOP_LAYER_MODIFIER );
797 else
798 m_view->SetLayerOrder( layer, i );
799 }
800}
801
802
804{
805 bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
807 m_gal->SetWorldUnitLength( 1e-9 /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
808 return rv;
809}
810
811
813{
814 if( m_ratsnest )
815 m_view->Update( m_ratsnest.get() );
816}
817
818
820{
821 if( m_drawingSheet && m_view->IsLayerVisible( LAYER_DRAWINGSHEET ) )
822 return m_drawingSheet->ViewBBox();
823
824 return BOX2I();
825}
826
827
829{
830 // caching makes no sense for Cairo and other software renderers
832
833 for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
834 m_view->SetLayerTarget( i, target );
835
836 for( int i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( int ); ++i )
837 {
838 int layer = GAL_LAYER_ORDER[i];
839 wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
840
841 // Set layer display dependencies & targets
842 if( IsCopperLayer( layer ) )
843 {
844 m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
845 m_view->SetRequired( PAD_COPPER_LAYER_FOR( layer ), layer );
846 m_view->SetRequired( VIA_COPPER_LAYER_FOR( layer ), layer );
847 m_view->SetRequired( CLEARANCE_LAYER_FOR( layer ), layer );
848 m_view->SetRequired( POINT_LAYER_FOR( layer ), layer );
849
850 m_view->SetRequired( BITMAP_LAYER_FOR( layer ), layer );
851 m_view->SetLayerTarget( BITMAP_LAYER_FOR( layer ), KIGFX::TARGET_NONCACHED );
852 m_view->SetRequired( GetNetnameLayer( layer ), layer );
853 }
854 else if( IsNonCopperLayer( layer ) )
855 {
856 m_view->SetRequired( POINT_LAYER_FOR( layer ), layer );
857 m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
858 m_view->SetLayerTarget( BITMAP_LAYER_FOR( layer ), KIGFX::TARGET_NONCACHED );
859 m_view->SetRequired( BITMAP_LAYER_FOR( layer ), layer );
860 }
861 else if( IsNetnameLayer( layer ) )
862 {
863 m_view->SetLayerDisplayOnly( layer );
864 }
865 }
866
867 m_view->SetLayerTarget( LAYER_ANCHOR, KIGFX::TARGET_NONCACHED );
868 m_view->SetLayerDisplayOnly( LAYER_ANCHOR );
869
870 // Use TARGET_OVERLAY for LAYER_CONFLICTS_SHADOW, it is for items
871 // that may change while the view stays the same.
873
874 m_view->SetLayerDisplayOnly( LAYER_LOCKED_ITEM_SHADOW );
875 m_view->SetLayerDisplayOnly( LAYER_CONFLICTS_SHADOW );
876 m_view->SetLayerDisplayOnly( LAYER_BOARD_OUTLINE_AREA );
877
878 // Some more required layers settings
879 m_view->SetRequired( LAYER_PAD_NETNAMES, LAYER_PADS );
880
881 // Holes can be independent of their host objects (cf: printing drill marks)
882 m_view->SetRequired( LAYER_VIA_HOLES, LAYER_VIAS );
883 m_view->SetRequired( LAYER_VIA_HOLEWALLS, LAYER_VIAS );
884 m_view->SetRequired( LAYER_PAD_PLATEDHOLES, LAYER_PADS );
885 m_view->SetRequired( LAYER_PAD_HOLEWALLS, LAYER_PADS );
886 m_view->SetRequired( LAYER_NON_PLATEDHOLES, LAYER_PADS );
887
888 // Via visibility
889 m_view->SetRequired( LAYER_VIA_MICROVIA, LAYER_VIAS );
890 m_view->SetRequired( LAYER_VIA_BLIND, LAYER_VIAS );
891 m_view->SetRequired( LAYER_VIA_BURIED, LAYER_VIAS );
892 m_view->SetRequired( LAYER_VIA_THROUGH, LAYER_VIAS );
893 m_view->SetRequired( LAYER_VIA_NETNAMES, LAYER_VIAS );
894
896 m_view->SetLayerDisplayOnly( LAYER_SELECT_OVERLAY ) ;
898 m_view->SetLayerDisplayOnly( LAYER_GP_OVERLAY ) ;
899 m_view->SetLayerTarget( LAYER_RATSNEST, KIGFX::TARGET_OVERLAY );
900 m_view->SetLayerDisplayOnly( LAYER_RATSNEST );
901
902 m_view->SetLayerTarget( LAYER_DRC_ERROR, KIGFX::TARGET_OVERLAY );
906 m_view->SetLayerDisplayOnly( LAYER_MARKER_SHADOWS );
908 m_view->SetLayerDisplayOnly( LAYER_DRC_SHAPES ); // markers can't be selected through shapes
909
911 m_view->SetLayerDisplayOnly( LAYER_DRAWINGSHEET ) ; // drawing sheet can't be selected
912 m_view->SetLayerDisplayOnly( LAYER_GRID ); // grid can't be selected
913
914 for( int i = LAYER_UI_START; i < LAYER_UI_END; ++i )
915 {
916 m_view->SetLayerTarget( i, KIGFX::TARGET_OVERLAY );
917 m_view->SetLayerDisplayOnly( i );
918 }
919}
920
921
923{
924 return static_cast<KIGFX::PCB_VIEW*>( m_view );
925}
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:84
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:322
bool IsFootprintHolder() const
Find out if the board is being used to hold a single footprint for editing/viewing.
Definition board.h:352
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition board.cpp:1033
PCB_BOARD_OUTLINE * BoardOutline()
Definition board.h:371
void UpdateBoardOutline()
Definition board.cpp:3642
const FOOTPRINTS & Footprints() const
Definition board.h:363
const BOARD_ITEM_SET GetItemSet()
Definition board.cpp:3557
const TRACKS & Tracks() const
Definition board.h:361
const wxString & GetFileName() const
Definition board.h:359
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:973
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition board.h:563
void CacheTriangulation(PROGRESS_REPORTER *aReporter=nullptr, const std::vector< ZONE * > &aZones={})
Definition board.cpp:1140
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.
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:82
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:149
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.
static constexpr int TOP_LAYER_MODIFIER
Rendering order modifier for layers that are marked as top layers.
Definition view.h:749
static constexpr int VIEW_MAX_LAYERS
Maximum number of layers that may be shown.
Definition view.h:746
An implementation of class VIEW_CONTROLS for wxWidgets library.
Definition pad.h:55
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:177
This file is part of the common library.
#define _(s)
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition frame_type.h:33
@ FRAME_FOOTPRINT_PREVIEW
Definition frame_type.h:48
@ LAYER_PAD_FR_NETNAMES
Additional netnames layers (not associated with a PCB layer).
Definition layer_ids.h:200
@ LAYER_PAD_BK_NETNAMES
Definition layer_ids.h:201
@ LAYER_PAD_NETNAMES
Definition layer_ids.h:202
@ NETNAMES_LAYER_ID_START
Definition layer_ids.h:194
@ NETNAMES_LAYER_ID_END
Definition layer_ids.h:205
@ LAYER_VIA_NETNAMES
Definition layer_ids.h:203
#define BITMAP_LAYER_FOR(boardLayer)
Macros for getting the extra layers for a given board layer.
Definition layer_ids.h:367
#define NETNAMES_LAYER_INDEX(layer)
Macro for obtaining netname layer for a given PCB layer.
Definition layer_ids.h:209
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
Definition layer_ids.h:780
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
Definition layer_ids.h:803
#define POINT_LAYER_FOR(boardLayer)
Definition layer_ids.h:372
bool IsNonCopperLayer(int aLayerId)
Test whether a layer is a non copper layer.
Definition layer_ids.h:710
int GetNetnameLayer(int aLayer)
Return a netname layer corresponding to the given layer.
Definition layer_ids.h:854
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition layer_ids.h:677
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition layer_ids.h:228
@ LAYER_GRID
Definition layer_ids.h:254
@ LAYER_POINTS
PCB reference/manual snap points visibility.
Definition layer_ids.h:321
@ GAL_LAYER_ID_START
Definition layer_ids.h:229
@ LAYER_LOCKED_ITEM_SHADOW
Shadow layer for locked items.
Definition layer_ids.h:307
@ LAYER_PAD_COPPER_START
Virtual layers for pad copper on a given copper layer.
Definition layer_ids.h:337
@ LAYER_VIA_HOLEWALLS
Definition layer_ids.h:298
@ LAYER_CLEARANCE_END
Definition layer_ids.h:346
@ LAYER_GRID_AXES
Definition layer_ids.h:255
@ LAYER_CONFLICTS_SHADOW
Shadow layer for items flagged conflicting.
Definition layer_ids.h:310
@ LAYER_FOOTPRINTS_FR
Show footprints on front.
Definition layer_ids.h:259
@ LAYER_ZONE_END
Definition layer_ids.h:334
@ LAYER_NON_PLATEDHOLES
Draw usual through hole vias.
Definition layer_ids.h:239
@ LAYER_DRAWINGSHEET
Sheet frame and title block.
Definition layer_ids.h:278
@ LAYER_FP_REFERENCES
Show footprints references (when texts are visible).
Definition layer_ids.h:266
@ LAYER_BOARD_OUTLINE_AREA
PCB board outline.
Definition layer_ids.h:318
@ LAYER_DRC_EXCLUSION
Layer for DRC markers which have been individually excluded.
Definition layer_ids.h:304
@ LAYER_POINT_END
Definition layer_ids.h:354
@ LAYER_DRC_SHAPES
Custom shapes for DRC markers.
Definition layer_ids.h:315
@ LAYER_PADS
Meta control for all pads opacity/visibility (color ignored).
Definition layer_ids.h:292
@ LAYER_DRC_WARNING
Layer for DRC markers with #SEVERITY_WARNING.
Definition layer_ids.h:301
@ LAYER_UI_START
Definition layer_ids.h:357
@ LAYER_PAD_PLATEDHOLES
to draw pad holes (plated)
Definition layer_ids.h:271
@ GAL_LAYER_ID_END
Definition layer_ids.h:360
@ LAYER_GP_OVERLAY
General purpose overlay.
Definition layer_ids.h:279
@ LAYER_VIA_COPPER_START
Virtual layers for via copper on a given copper layer.
Definition layer_ids.h:341
@ LAYER_CURSOR
PCB cursor.
Definition layer_ids.h:282
@ LAYER_RATSNEST
Definition layer_ids.h:253
@ LAYER_CLEARANCE_START
Virtual layers for pad/via/track clearance outlines for a given copper layer.
Definition layer_ids.h:345
@ LAYER_PAD_COPPER_END
Definition layer_ids.h:338
@ LAYER_ZONE_START
Virtual layers for stacking zones and tracks on a given copper layer.
Definition layer_ids.h:333
@ LAYER_FP_TEXT
Definition layer_ids.h:240
@ LAYER_FOOTPRINTS_BK
Show footprints on back.
Definition layer_ids.h:260
@ LAYER_UI_END
Definition layer_ids.h:358
@ LAYER_ANCHOR
Anchor of items having an anchor point (texts, footprints).
Definition layer_ids.h:248
@ LAYER_VIA_BURIED
Draw blind vias.
Definition layer_ids.h:235
@ LAYER_VIA_COPPER_END
Definition layer_ids.h:342
@ LAYER_MARKER_SHADOWS
Shadows for DRC markers.
Definition layer_ids.h:305
@ LAYER_VIA_HOLES
Draw via holes (pad holes do not use this layer).
Definition layer_ids.h:274
@ LAYER_VIA_BLIND
Draw micro vias.
Definition layer_ids.h:234
@ LAYER_FP_VALUES
Show footprints values (when texts are visible).
Definition layer_ids.h:263
@ LAYER_POINT_START
Virtual layers for points per board layer.
Definition layer_ids.h:353
@ LAYER_VIA_MICROVIA
Definition layer_ids.h:233
@ LAYER_SELECT_OVERLAY
Selected items overlay.
Definition layer_ids.h:280
@ LAYER_VIA_THROUGH
Draw buried vias.
Definition layer_ids.h:236
@ LAYER_BITMAP_END
Definition layer_ids.h:350
@ LAYER_BITMAP_START
Virtual layers for background images per board layer.
Definition layer_ids.h:349
@ LAYER_DRC_ERROR
Layer for DRC markers with #SEVERITY_ERROR.
Definition layer_ids.h:277
@ LAYER_VIAS
Meta control for all vias opacity/visibility.
Definition layer_ids.h:232
@ LAYER_PAD_HOLEWALLS
Definition layer_ids.h:297
#define CLEARANCE_LAYER_FOR(boardLayer)
Definition layer_ids.h:371
bool IsNetnameLayer(int aLayer)
Test whether a layer is a netname layer.
Definition layer_ids.h:869
#define VIA_COPPER_LAYER_FOR(boardLayer)
Definition layer_ids.h:370
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
@ User_16
Definition layer_ids.h:139
@ In22_Cu
Definition layer_ids.h:87
@ In11_Cu
Definition layer_ids.h:76
@ User_29
Definition layer_ids.h:152
@ In29_Cu
Definition layer_ids.h:94
@ In30_Cu
Definition layer_ids.h:95
@ User_40
Definition layer_ids.h:163
@ User_15
Definition layer_ids.h:138
@ User_8
Definition layer_ids.h:131
@ F_CrtYd
Definition layer_ids.h:116
@ User_11
Definition layer_ids.h:134
@ User_25
Definition layer_ids.h:148
@ In17_Cu
Definition layer_ids.h:82
@ User_34
Definition layer_ids.h:157
@ User_45
Definition layer_ids.h:168
@ B_Adhes
Definition layer_ids.h:103
@ User_36
Definition layer_ids.h:159
@ Edge_Cuts
Definition layer_ids.h:112
@ Dwgs_User
Definition layer_ids.h:107
@ F_Paste
Definition layer_ids.h:104
@ In9_Cu
Definition layer_ids.h:74
@ Cmts_User
Definition layer_ids.h:108
@ User_6
Definition layer_ids.h:129
@ User_7
Definition layer_ids.h:130
@ In19_Cu
Definition layer_ids.h:84
@ User_19
Definition layer_ids.h:142
@ User_23
Definition layer_ids.h:146
@ In7_Cu
Definition layer_ids.h:72
@ In28_Cu
Definition layer_ids.h:93
@ In26_Cu
Definition layer_ids.h:91
@ F_Adhes
Definition layer_ids.h:102
@ User_41
Definition layer_ids.h:164
@ B_Mask
Definition layer_ids.h:98
@ B_Cu
Definition layer_ids.h:65
@ User_14
Definition layer_ids.h:137
@ User_39
Definition layer_ids.h:162
@ User_5
Definition layer_ids.h:128
@ User_20
Definition layer_ids.h:143
@ Eco1_User
Definition layer_ids.h:109
@ F_Mask
Definition layer_ids.h:97
@ In21_Cu
Definition layer_ids.h:86
@ User_42
Definition layer_ids.h:165
@ User_43
Definition layer_ids.h:166
@ In23_Cu
Definition layer_ids.h:88
@ B_Paste
Definition layer_ids.h:105
@ In15_Cu
Definition layer_ids.h:80
@ In2_Cu
Definition layer_ids.h:67
@ User_10
Definition layer_ids.h:133
@ User_9
Definition layer_ids.h:132
@ User_27
Definition layer_ids.h:150
@ User_28
Definition layer_ids.h:151
@ F_Fab
Definition layer_ids.h:119
@ In10_Cu
Definition layer_ids.h:75
@ Margin
Definition layer_ids.h:113
@ F_SilkS
Definition layer_ids.h:100
@ In4_Cu
Definition layer_ids.h:69
@ B_CrtYd
Definition layer_ids.h:115
@ Eco2_User
Definition layer_ids.h:110
@ In16_Cu
Definition layer_ids.h:81
@ In24_Cu
Definition layer_ids.h:89
@ In1_Cu
Definition layer_ids.h:66
@ User_35
Definition layer_ids.h:158
@ User_31
Definition layer_ids.h:154
@ User_3
Definition layer_ids.h:126
@ User_1
Definition layer_ids.h:124
@ User_12
Definition layer_ids.h:135
@ B_SilkS
Definition layer_ids.h:101
@ User_30
Definition layer_ids.h:153
@ User_37
Definition layer_ids.h:160
@ User_22
Definition layer_ids.h:145
@ User_38
Definition layer_ids.h:161
@ In13_Cu
Definition layer_ids.h:78
@ User_4
Definition layer_ids.h:127
@ In8_Cu
Definition layer_ids.h:73
@ User_21
Definition layer_ids.h:144
@ In14_Cu
Definition layer_ids.h:79
@ User_24
Definition layer_ids.h:147
@ PCB_LAYER_ID_COUNT
Definition layer_ids.h:171
@ User_13
Definition layer_ids.h:136
@ User_2
Definition layer_ids.h:125
@ In12_Cu
Definition layer_ids.h:77
@ User_17
Definition layer_ids.h:140
@ In27_Cu
Definition layer_ids.h:92
@ In6_Cu
Definition layer_ids.h:71
@ In5_Cu
Definition layer_ids.h:70
@ User_33
Definition layer_ids.h:156
@ User_26
Definition layer_ids.h:149
@ In3_Cu
Definition layer_ids.h:68
@ User_32
Definition layer_ids.h:155
@ In20_Cu
Definition layer_ids.h:85
@ User_18
Definition layer_ids.h:141
@ User_44
Definition layer_ids.h:167
@ F_Cu
Definition layer_ids.h:64
@ In18_Cu
Definition layer_ids.h:83
@ In25_Cu
Definition layer_ids.h:90
@ B_Fab
Definition layer_ids.h:118
#define ZONE_LAYER_FOR(boardLayer)
Definition layer_ids.h:368
#define PAD_COPPER_LAYER_FOR(boardLayer)
Definition layer_ids.h:369
This file contains miscellaneous commonly used macros and functions.
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition definitions.h:38
@ TARGET_CACHED
Main rendering target (cached)
Definition definitions.h:37
@ TARGET_OVERLAY
Items that may change while the view stays the same (noncached)
Definition definitions.h:39
const int GAL_LAYER_ORDER[]
BOARD * GetBoard()
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_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition typeinfo.h:97
WX_VIEW_CONTROLS class definition.
#define ZOOM_MAX_LIMIT_PCBNEW
#define ZOOM_MIN_LIMIT_PCBNEW