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#include <pcb_view.h>
29#include <pcb_painter.h>
32
33#include <board.h>
34#include <footprint.h>
35#include <pcb_track.h>
36#include <macros.h>
37#include <pcb_marker.h>
38#include <pcb_generator.h>
39#include <pcb_base_frame.h>
40#include <pcbnew_settings.h>
43
44#include <pgm_base.h>
46#include <confirm.h>
47#include <progress_reporter.h>
48
50#include <zoom_defines.h>
51
52#include <functional>
53#include <memory>
54#include <thread>
55
56using namespace std::placeholders;
57
58
59const int GAL_LAYER_ORDER[] =
60{
71
75
85
95
97
104
117
208
221
226
236
244
275
283
285};
286
287
288PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
289 const wxPoint& aPosition, const wxSize& aSize,
290 KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
291 EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType )
292{
293 m_view = new KIGFX::PCB_VIEW();
294 m_view->SetGAL( m_gal );
295
297
298 if( EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( aParentWindow ) )
299 frameType = frame->GetFrameType();
300
301 m_painter = std::make_unique<KIGFX::PCB_PAINTER>( m_gal, frameType );
302 m_view->SetPainter( m_painter.get() );
303
304 // This fixes the zoom in and zoom out limits:
306
309
310 // View controls is the first in the event handler chain, so the Tool Framework operates
311 // on updated viewport data.
313
314 // Load display options (such as filled/outline display of items).
315 // Can be made only if the parent window is an EDA_DRAW_FRAME (or a derived class)
316 // which is not always the case (namely when it is used from a wxDialog like the pad editor)
317 if( !IsDialogPreview() )
318 {
319 KIGFX::PCB_VIEW* view = static_cast<KIGFX::PCB_VIEW*>( m_view );
320 PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
321
322 if( frame )
323 view->UpdateDisplayOptions( frame->GetDisplayOptions() );
324 }
325}
326
327
329{
330}
331
332
334{
335 m_view->Clear();
336
337 aBoard->CacheTriangulation( aReporter );
338
339 if( m_drawingSheet )
340 m_drawingSheet->SetFileName( TO_UTF8( aBoard->GetFileName() ) );
341
342 // Load drawings
343 for( BOARD_ITEM* drawing : aBoard->Drawings() )
344 m_view->Add( drawing );
345
346 // Load tracks
347 for( PCB_TRACK* track : aBoard->Tracks() )
348 m_view->Add( track );
349
350 // Load footprints and its additional elements
351 for( FOOTPRINT* footprint : aBoard->Footprints() )
352 m_view->Add( footprint );
353
354 // DRC markers
355 for( PCB_MARKER* marker : aBoard->Markers() )
356 m_view->Add( marker );
357
358 // Load zones
359 for( ZONE* zone : aBoard->Zones() )
360 m_view->Add( zone );
361
362 for( PCB_GENERATOR* generator : aBoard->Generators() )
363 m_view->Add( generator );
364
365 // Ratsnest
366 if( !aBoard->IsFootprintHolder() )
367 {
368 m_ratsnest = std::make_unique<RATSNEST_VIEW_ITEM>( aBoard->GetConnectivity() );
369 m_view->Add( m_ratsnest.get() );
370 }
371}
372
373
375{
376 m_drawingSheet.reset( aDrawingSheet );
377 m_view->Add( m_drawingSheet.get() );
378}
379
380
382{
383 COLOR_SETTINGS* cs = nullptr;
384
385 PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
386
387 if( frame )
388 {
389 cs = frame->GetColorSettings();
390 }
391 else
392 {
393 auto* app = Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>( "pcbnew" );
394
395 if( app )
396 cs = Pgm().GetSettingsManager().GetColorSettings( app->m_ColorTheme );
397 else
399 }
400
401 wxCHECK_RET( cs, wxT( "null COLOR_SETTINGS" ) );
402
403 auto rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( m_view->GetPainter()->GetSettings() );
404 rs->LoadColors( cs );
405
409}
410
411
413{
414 // Set display settings for high contrast mode
416
417 SetTopLayer( aLayer );
418 rSettings->SetActiveLayer( aLayer );
419
420 rSettings->ClearHighContrastLayers();
421 rSettings->SetLayerIsHighContrast( aLayer );
422
423 if( IsCopperLayer( aLayer ) )
424 {
425 // Bring some other layers to the front in case of copper layers and make them colored
426 // fixme do not like the idea of storing the list of layers here,
427 // should be done in some other way I guess..
428 int layers[] = {
430 GetNetnameLayer( aLayer ),
433 PAD_COPPER_LAYER_FOR( aLayer ),
434 VIA_COPPER_LAYER_FOR( aLayer ),
435 ZONE_LAYER_FOR( aLayer ),
436 BITMAP_LAYER_FOR( aLayer ),
444 };
445
446 for( int i : layers )
447 rSettings->SetLayerIsHighContrast( i );
448
449 for( int i = LAYER_UI_START; i < LAYER_UI_END; ++i )
450 rSettings->SetLayerIsHighContrast( i );
451
452 // Pads should be shown too
453 if( aLayer == B_Cu )
454 {
456 }
457 else if( aLayer == F_Cu )
458 {
460 }
461 }
462
464}
465
466
468{
471 m_view->SetTopLayer( aLayer );
472
473 // Layers that should always have on-top attribute enabled
474 const std::vector<int> layers = {
484 };
485
486 for( auto layer : layers )
487 m_view->SetTopLayer( layer );
488
489 for( int i = LAYER_UI_START; i < LAYER_UI_END; i++ )
490 m_view->SetTopLayer( i );
491
492 // Extra layers that are brought to the top if a F.* or B.* is selected
493 const std::vector<int> frontLayers = {
496 };
497
498 const std::vector<int> backLayers = {
501 };
502
503 const std::vector<int>* extraLayers = nullptr;
504
505 // Bring a few more extra layers to the top depending on the selected board side
506 if( IsFrontLayer( aLayer ) )
507 extraLayers = &frontLayers;
508 else if( IsBackLayer( aLayer ) )
509 extraLayers = &backLayers;
510
511 if( extraLayers )
512 {
513 for( auto layer : *extraLayers )
514 {
515 m_view->SetTopLayer( layer );
516
517 if( layer < PCB_LAYER_ID_COUNT )
518 {
519 m_view->SetTopLayer( ZONE_LAYER_FOR( layer ) );
523 }
524 }
525
526 // Move the active layer to the top of the stack but below all the overlay layers
527 if( !IsCopperLayer( aLayer ) )
528 {
532
533 // Fix up pad and via netnames to be below. This is hacky, we need a rethink
534 // of layer ordering...
539 }
540 }
541
542 if( IsCopperLayer( aLayer ) )
543 {
544 m_view->SetTopLayer( ZONE_LAYER_FOR( aLayer ) );
548
549 // Display labels for copper layers on the top
550 m_view->SetTopLayer( GetNetnameLayer( aLayer ) );
551 }
552
553 m_view->SetTopLayer( BITMAP_LAYER_FOR( aLayer ) );
554 m_view->EnableTopLayer( true );
556}
557
558
560{
561 // Load layer & elements visibility settings
562 for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
563 m_view->SetLayerVisible( i, aBoard->IsLayerVisible( PCB_LAYER_ID( i ) ) );
564
566 m_view->SetLayerVisible( i, aBoard->IsElementVisible( i ) );
567
568 // Via layers controlled by dependencies
572
573 // Always enable netname layers, as their visibility is controlled by layer dependencies
574 for( int i = NETNAMES_LAYER_ID_START; i < NETNAMES_LAYER_ID_END; ++i )
575 m_view->SetLayerVisible( i, true );
576
577 for( int i = LAYER_ZONE_START; i < LAYER_ZONE_END; i++ )
578 m_view->SetLayerVisible( i, true );
579
580 for( int i = LAYER_PAD_COPPER_START; i < LAYER_PAD_COPPER_END; i++ )
581 m_view->SetLayerVisible( i, true );
582
583 for( int i = LAYER_VIA_COPPER_START; i < LAYER_VIA_COPPER_END; i++ )
584 m_view->SetLayerVisible( i, true );
585
586 for( int i = LAYER_CLEARANCE_START; i < LAYER_CLEARANCE_END; i++ )
587 m_view->SetLayerVisible( i, false );
588
589 for( int i = LAYER_BITMAP_START; i < LAYER_BITMAP_END; i++ )
590 m_view->SetLayerVisible( i, true );
591
592 for( int i = LAYER_UI_START; i < LAYER_UI_END; i++ )
593 m_view->SetLayerVisible( i, true );
594
595 // Enable some layers that are GAL specific
606}
607
608
610 std::vector<MSG_PANEL_ITEM>& aList )
611{
612 BOARD* board = static_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() )->GetBoard();
613 int padCount = 0;
614 int viaCount = 0;
615 int trackSegmentCount = 0;
616 std::set<int> netCodes;
617 int unconnected = (int) board->GetConnectivity()->GetUnconnectedCount( true );
618
619 for( PCB_TRACK* item : board->Tracks() )
620 {
621 if( item->Type() == PCB_VIA_T )
622 viaCount++;
623 else
624 trackSegmentCount++;
625
626 if( item->GetNetCode() > 0 )
627 netCodes.insert( item->GetNetCode() );
628 }
629
630 for( FOOTPRINT* footprint : board->Footprints() )
631 {
632 for( PAD* pad : footprint->Pads() )
633 {
634 padCount++;
635
636 if( pad->GetNetCode() > 0 )
637 netCodes.insert( pad->GetNetCode() );
638 }
639 }
640
641 aList.emplace_back( _( "Pads" ), wxString::Format( wxT( "%d" ), padCount ) );
642 aList.emplace_back( _( "Vias" ), wxString::Format( wxT( "%d" ), viaCount ) );
643 aList.emplace_back( _( "Track Segments" ), wxString::Format( wxT( "%d" ), trackSegmentCount ) );
644 aList.emplace_back( _( "Nets" ), wxString::Format( wxT( "%d" ), (int) netCodes.size() ) );
645 aList.emplace_back( _( "Unrouted" ), wxString::Format( wxT( "%d" ), unconnected ) );
646}
647
648
650{
651 PCB_BASE_FRAME* frame = nullptr;
652
653 if( !IsDialogPreview() )
654 frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
655
656 try
657 {
658 // Check if the current rendering back end can be properly initialized
660 }
661 catch( const std::runtime_error& e )
662 {
663 DisplayError( GetParent(), e.what() );
664
665 // Use the fallback if we have one
666 if( GAL_FALLBACK != m_backend )
667 {
669
670 if( frame )
671 frame->ActivateGalCanvas();
672 }
673 }
674
675 if( frame )
676 {
677 SetTopLayer( frame->GetActiveLayer() );
678
679 KIGFX::PCB_PAINTER* painter = static_cast<KIGFX::PCB_PAINTER*>( m_view->GetPainter() );
680 KIGFX::PCB_RENDER_SETTINGS* settings = painter->GetSettings();
681
682 settings->LoadDisplayOptions( frame->GetDisplayOptions() );
684 }
685}
686
687
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 // MW: Gross hack to make SetTopLayer bring the correct bitmap layer to
696 // the top of the other bitmaps, but still below all the other layers
697 if( layer >= LAYER_BITMAP_START && layer < LAYER_BITMAP_END )
699 else
700 m_view->SetLayerOrder( layer, i );
701 }
702}
703
704
706{
707 bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
709 m_gal->SetWorldUnitLength( 1e-9 /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
710 return rv;
711}
712
713
715{
716 if( m_ratsnest )
717 m_view->Update( m_ratsnest.get() );
718}
719
720
722{
724 return m_drawingSheet->ViewBBox();
725
726 return BOX2I();
727}
728
729
731{
732 // caching makes no sense for Cairo and other software renderers
734
735 for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
736 m_view->SetLayerTarget( i, target );
737
738 for( int i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( int ); ++i )
739 {
740 int layer = GAL_LAYER_ORDER[i];
741 wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
742
743 // Set layer display dependencies & targets
744 if( IsCopperLayer( layer ) )
745 {
746 m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
747 m_view->SetRequired( PAD_COPPER_LAYER_FOR( layer ), layer );
748 m_view->SetRequired( VIA_COPPER_LAYER_FOR( layer ), layer );
749 m_view->SetRequired( CLEARANCE_LAYER_FOR( layer ), layer );
750
751 m_view->SetRequired( BITMAP_LAYER_FOR( layer ), layer );
753 m_view->SetRequired( GetNetnameLayer( layer ), layer );
754 }
755 else if( IsNonCopperLayer( layer ) )
756 {
757 m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
759 m_view->SetRequired( BITMAP_LAYER_FOR( layer ), layer );
760 }
761 else if( IsNetnameLayer( layer ) )
762 {
763 m_view->SetLayerDisplayOnly( layer );
764 }
765 }
766
769
770 // Use TARGET_OVERLAY for LAYER_CONFLICTS_SHADOW, it is for items
771 // that may change while the view stays the same.
773
776
777 // Some more required layers settings
779
780 // Holes can be independent of their host objects (cf: printing drill marks)
786
787 // Via visibility
792
799
801 //m_view->SetLayerDisplayOnly( LAYER_DRC_ERROR );
803 //m_view->SetLayerDisplayOnly( LAYER_DRC_WARNING );
805 //m_view->SetLayerDisplayOnly( LAYER_DRC_EXCLUSION );
812
816
817 for( int i = LAYER_UI_START; i < LAYER_UI_END; ++i )
818 {
821 }
822}
823
824
826{
827 return static_cast<KIGFX::PCB_VIEW*>( m_view );
828}
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:79
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:295
bool IsFootprintHolder() const
Find out if the board is being used to hold a single footprint for editing/viewing.
Definition: board.h:325
const GENERATORS & Generators() const
Definition: board.h:342
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition: board.cpp:883
const ZONES & Zones() const
Definition: board.h:340
const MARKERS & Markers() const
Definition: board.h:344
const FOOTPRINTS & Footprints() const
Definition: board.h:336
const TRACKS & Tracks() const
Definition: board.h:334
const wxString & GetFileName() const
Definition: board.h:332
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:823
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:483
void CacheTriangulation(PROGRESS_REPORTER *aReporter=nullptr, const std::vector< ZONE * > &aZones={})
Definition: board.cpp:972
const DRAWINGS & Drawings() const
Definition: board.h:338
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
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.
@ 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.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
void SetAxesColor(const COLOR4D &aAxesColor)
Set the axes color.
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.
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.
Definition: pcb_painter.h:180
virtual PCB_RENDER_SETTINGS * GetSettings() override
Return a pointer to current settings that are going to be used when drawing items.
Definition: pcb_painter.h:185
PCB specific render settings.
Definition: pcb_painter.h:78
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:121
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:744
void UpdateAllLayersOrder()
Do everything that is needed to apply the rendering order of layers.
Definition: view.cpp:896
void SetRequired(int aLayerId, int aRequiredId, bool aRequired=true)
Mark the aRequiredId layer as required for the aLayerId layer.
Definition: view.cpp:398
void SetLayerDisplayOnly(int aLayer, bool aDisplayOnly=true)
Set a layer display-only (ie: to be rendered but not returned by hit test queries).
Definition: view.h:477
int GetLayerOrder(int aLayer) const
Return rendering order of a particular layer.
Definition: view.cpp:654
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:297
virtual void EnableTopLayer(bool aEnable)
Enable or disable display of the top layer.
Definition: view.cpp:856
void SetPainter(PAINTER *aPainter)
Set the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:206
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition: view.cpp:765
void SetGAL(GAL *aGal)
Assign a rendering device for the VIEW.
Definition: view.cpp:501
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Change the rendering target for a particular layer.
Definition: view.h:493
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1673
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition: view.h:396
void Clear()
Remove all items from the view.
Definition: view.cpp:1131
void ClearTopLayers()
Remove all layers from the on-the-top set (they are no longer displayed over the rest of layers).
Definition: view.cpp:881
static constexpr int VIEW_MAX_LAYERS
Maximum number of layers that may be shown.
Definition: view.h:741
void UpdateItems()
Iterate through the list of items that asked for updating and updates them.
Definition: view.cpp:1456
virtual void SetTopLayer(int aLayer, bool aEnabled=true)
Set given layer to be displayed on the top or sets back the default order of layers.
Definition: view.cpp:829
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition: view.h:418
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:216
void SetScaleLimits(double aMaximum, double aMinimum)
Set minimum and maximum values for scale.
Definition: view.h:312
void SetLayerOrder(int aLayer, int aRenderingOrder)
Set rendering order of a particular layer.
Definition: view.cpp:646
An implementation of class VIEW_CONTROLS for wxWidgets library.
Definition: pad.h:54
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 PCB_LAYER_ID GetActiveLayer() const
virtual void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
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.
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:125
A progress reporter interface for use in multi-threaded environments.
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieve a color settings object that applications can read colors from.
T * GetAppSettings(const wxString &aFilename)
Return a handle to the a given settings by type.
Handle a list of polygons defining a copper zone.
Definition: zone.h:73
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:170
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:163
@ LAYER_PAD_BK_NETNAMES
Definition: layer_ids.h:164
@ LAYER_PAD_NETNAMES
Definition: layer_ids.h:165
@ NETNAMES_LAYER_ID_START
Definition: layer_ids.h:157
@ NETNAMES_LAYER_ID_END
Definition: layer_ids.h:168
@ LAYER_VIA_NETNAMES
Definition: layer_ids.h:166
#define BITMAP_LAYER_FOR(boardLayer)
Macros for getting the extra layers for a given board layer.
Definition: layer_ids.h:320
#define NETNAMES_LAYER_INDEX(layer)
Macro for obtaining netname layer for a given PCB layer.
Definition: layer_ids.h:172
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
Definition: layer_ids.h:682
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
Definition: layer_ids.h:705
bool IsNonCopperLayer(int aLayerId)
Test whether a layer is a non copper layer.
Definition: layer_ids.h:614
int GetNetnameLayer(int aLayer)
Return a netname layer corresponding to the given layer.
Definition: layer_ids.h:756
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition: layer_ids.h:581
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition: layer_ids.h:191
@ LAYER_GRID
Definition: layer_ids.h:216
@ GAL_LAYER_ID_START
Definition: layer_ids.h:192
@ LAYER_LOCKED_ITEM_SHADOW
Shadow layer for locked items.
Definition: layer_ids.h:269
@ LAYER_PAD_COPPER_START
Virtual layers for pad copper on a given copper layer.
Definition: layer_ids.h:294
@ LAYER_VIA_HOLEWALLS
Definition: layer_ids.h:260
@ LAYER_CLEARANCE_END
Definition: layer_ids.h:303
@ LAYER_GRID_AXES
Definition: layer_ids.h:217
@ LAYER_CONFLICTS_SHADOW
Shadow layer for items flagged conflicting.
Definition: layer_ids.h:272
@ LAYER_FOOTPRINTS_FR
Show footprints on front.
Definition: layer_ids.h:221
@ LAYER_DRC_SHAPE1
Custom shape for DRC marker.
Definition: layer_ids.h:277
@ LAYER_ZONE_END
Definition: layer_ids.h:291
@ LAYER_NON_PLATEDHOLES
Draw usual through hole vias.
Definition: layer_ids.h:201
@ LAYER_DRAWINGSHEET
Sheet frame and title block.
Definition: layer_ids.h:240
@ LAYER_FP_REFERENCES
Show footprints references (when texts are visible).
Definition: layer_ids.h:228
@ LAYER_DRC_EXCLUSION
Layer for DRC markers which have been individually excluded.
Definition: layer_ids.h:266
@ LAYER_PADS
Meta control for all pads opacity/visibility (color ignored).
Definition: layer_ids.h:254
@ LAYER_DRC_WARNING
Layer for DRC markers with #SEVERITY_WARNING.
Definition: layer_ids.h:263
@ LAYER_UI_START
Definition: layer_ids.h:310
@ LAYER_PAD_PLATEDHOLES
to draw pad holes (plated)
Definition: layer_ids.h:233
@ GAL_LAYER_ID_END
Definition: layer_ids.h:313
@ LAYER_GP_OVERLAY
General purpose overlay.
Definition: layer_ids.h:241
@ LAYER_VIA_COPPER_START
Virtual layers for via copper on a given copper layer.
Definition: layer_ids.h:298
@ LAYER_CURSOR
PCB cursor.
Definition: layer_ids.h:244
@ LAYER_RATSNEST
Definition: layer_ids.h:215
@ LAYER_CLEARANCE_START
Virtual layers for pad/via/track clearance outlines for a given copper layer.
Definition: layer_ids.h:302
@ LAYER_DRC_SHAPE2
Custom shape for DRC marker.
Definition: layer_ids.h:278
@ LAYER_PAD_COPPER_END
Definition: layer_ids.h:295
@ LAYER_ZONE_START
Virtual layers for stacking zones and tracks on a given copper layer.
Definition: layer_ids.h:290
@ LAYER_FP_TEXT
Definition: layer_ids.h:202
@ LAYER_FOOTPRINTS_BK
Show footprints on back.
Definition: layer_ids.h:222
@ LAYER_UI_END
Definition: layer_ids.h:311
@ LAYER_ANCHOR
Anchor of items having an anchor point (texts, footprints).
Definition: layer_ids.h:210
@ LAYER_VIA_COPPER_END
Definition: layer_ids.h:299
@ LAYER_MARKER_SHADOWS
Shadows for DRC markers.
Definition: layer_ids.h:267
@ LAYER_VIA_HOLES
Draw via holes (pad holes do not use this layer).
Definition: layer_ids.h:236
@ LAYER_FP_VALUES
Show footprints values (when texts are visible).
Definition: layer_ids.h:225
@ LAYER_VIA_MICROVIA
Definition: layer_ids.h:196
@ LAYER_SELECT_OVERLAY
Selected items overlay.
Definition: layer_ids.h:242
@ LAYER_VIA_THROUGH
Draw blind/buried vias.
Definition: layer_ids.h:198
@ LAYER_BITMAP_END
Definition: layer_ids.h:307
@ LAYER_BITMAP_START
Virtual layers for background images per board layer.
Definition: layer_ids.h:306
@ LAYER_DRC_ERROR
Layer for DRC markers with #SEVERITY_ERROR.
Definition: layer_ids.h:239
@ LAYER_VIAS
Meta control for all vias opacity/visibility.
Definition: layer_ids.h:195
@ LAYER_VIA_BBLIND
Draw micro vias.
Definition: layer_ids.h:197
@ LAYER_PAD_HOLEWALLS
Definition: layer_ids.h:259
#define CLEARANCE_LAYER_FOR(boardLayer)
Definition: layer_ids.h:324
bool IsNetnameLayer(int aLayer)
Test whether a layer is a netname layer.
Definition: layer_ids.h:771
#define VIA_COPPER_LAYER_FOR(boardLayer)
Definition: layer_ids.h:323
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ In22_Cu
Definition: layer_ids.h:87
@ In11_Cu
Definition: layer_ids.h:76
@ In29_Cu
Definition: layer_ids.h:94
@ In30_Cu
Definition: layer_ids.h:95
@ User_8
Definition: layer_ids.h:131
@ F_CrtYd
Definition: layer_ids.h:116
@ In17_Cu
Definition: layer_ids.h:82
@ B_Adhes
Definition: layer_ids.h:103
@ 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
@ 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
@ B_Mask
Definition: layer_ids.h:98
@ B_Cu
Definition: layer_ids.h:65
@ User_5
Definition: layer_ids.h:128
@ Eco1_User
Definition: layer_ids.h:109
@ F_Mask
Definition: layer_ids.h:97
@ In21_Cu
Definition: layer_ids.h:86
@ 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_9
Definition: layer_ids.h:132
@ 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_3
Definition: layer_ids.h:126
@ User_1
Definition: layer_ids.h:124
@ B_SilkS
Definition: layer_ids.h:101
@ In13_Cu
Definition: layer_ids.h:78
@ User_4
Definition: layer_ids.h:127
@ In8_Cu
Definition: layer_ids.h:73
@ In14_Cu
Definition: layer_ids.h:79
@ PCB_LAYER_ID_COUNT
Definition: layer_ids.h:135
@ User_2
Definition: layer_ids.h:125
@ In12_Cu
Definition: layer_ids.h:77
@ In27_Cu
Definition: layer_ids.h:92
@ In6_Cu
Definition: layer_ids.h:71
@ In5_Cu
Definition: layer_ids.h:70
@ In3_Cu
Definition: layer_ids.h:68
@ In20_Cu
Definition: layer_ids.h:85
@ 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:321
#define PAD_COPPER_LAYER_FOR(boardLayer)
Definition: layer_ids.h:322
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()
PGM_BASE & Pgm()
The global program "get" accessor.
Definition: pgm_base.cpp:1073
see class PGM_BASE
Class that computes missing connections on a PCB.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:398
@ 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
Definition: zoom_defines.h:65
#define ZOOM_MIN_LIMIT_PCBNEW
Definition: zoom_defines.h:66