KiCad PCB EDA Suite
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 (C) 2021-2022 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_base_frame.h>
39#include <pcbnew_settings.h>
42
43#include <pgm_base.h>
45#include <confirm.h>
46#include <progress_reporter.h>
47
49#include <zoom_defines.h>
50
51#include <functional>
52#include <memory>
53#include <thread>
54
55using namespace std::placeholders;
56
57
58const int GAL_LAYER_ORDER[] =
59{
71
81
83
91
100
131
140
145
155
163
194
202
204};
205
206
207PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
208 const wxPoint& aPosition, const wxSize& aSize,
209 KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
210 EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType )
211{
212 m_view = new KIGFX::PCB_VIEW( true );
213 m_view->SetGAL( m_gal );
214
216
217 if( EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( aParentWindow ) )
218 frameType = frame->GetFrameType();
219
220 m_painter = std::make_unique<KIGFX::PCB_PAINTER>( m_gal, frameType );
221 m_view->SetPainter( m_painter.get() );
222
223 // This fixes the zoom in and zoom out limits:
225
228
229 // View controls is the first in the event handler chain, so the Tool Framework operates
230 // on updated viewport data.
232
233 // Load display options (such as filled/outline display of items).
234 // Can be made only if the parent window is an EDA_DRAW_FRAME (or a derived class)
235 // which is not always the case (namely when it is used from a wxDialog like the pad editor)
236 if( !IsDialogPreview() )
237 {
238 KIGFX::PCB_VIEW* view = static_cast<KIGFX::PCB_VIEW*>( m_view );
239 PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
240
241 if( frame )
242 view->UpdateDisplayOptions( frame->GetDisplayOptions() );
243 }
244}
245
246
248{
249}
250
251
253{
254 m_view->Clear();
255
256 aBoard->CacheTriangulation( aReporter );
257
258 if( m_drawingSheet )
259 m_drawingSheet->SetFileName( TO_UTF8( aBoard->GetFileName() ) );
260
261 // Load drawings
262 for( BOARD_ITEM* drawing : aBoard->Drawings() )
263 m_view->Add( drawing );
264
265 // Load tracks
266 for( PCB_TRACK* track : aBoard->Tracks() )
267 m_view->Add( track );
268
269 // Load footprints and its additional elements
270 for( FOOTPRINT* footprint : aBoard->Footprints() )
271 m_view->Add( footprint );
272
273 // DRC markers
274 for( PCB_MARKER* marker : aBoard->Markers() )
275 m_view->Add( marker );
276
277 // Load zones
278 for( ZONE* zone : aBoard->Zones() )
279 m_view->Add( zone );
280
281 // Ratsnest
282 m_ratsnest = std::make_unique<RATSNEST_VIEW_ITEM>( aBoard->GetConnectivity() );
283 m_view->Add( m_ratsnest.get() );
284}
285
286
288{
289 m_drawingSheet.reset( aDrawingSheet );
290 m_view->Add( m_drawingSheet.get() );
291}
292
293
295{
296 COLOR_SETTINGS* cs = nullptr;
297
298 PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
299
300 if( frame )
301 {
302 cs = frame->GetColorSettings();
303 }
304 else
305 {
306 PCBNEW_SETTINGS* app = Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
307
308 if( app )
309 cs = Pgm().GetSettingsManager().GetColorSettings( app->m_ColorTheme );
310 else
311 cs = Pgm().GetSettingsManager().GetColorSettings();
312 }
313
314 wxCHECK_RET( cs, wxT( "null COLOR_SETTINGS" ) );
315
316 auto rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( m_view->GetPainter()->GetSettings() );
317 rs->LoadColors( cs );
318
322}
323
324
326{
327 // Set display settings for high contrast mode
329
330 SetTopLayer( aLayer );
331 rSettings->SetActiveLayer( aLayer );
332
333 rSettings->ClearHighContrastLayers();
334 rSettings->SetLayerIsHighContrast( aLayer );
335
336 if( IsCopperLayer( aLayer ) )
337 {
338 // Bring some other layers to the front in case of copper layers and make them colored
339 // fixme do not like the idea of storing the list of layers here,
340 // should be done in some other way I guess..
341 int layers[] = {
345 ZONE_LAYER_FOR( aLayer ),
346 BITMAP_LAYER_FOR( aLayer ),
353 };
354
355 for( unsigned int i : layers )
356 rSettings->SetLayerIsHighContrast( i );
357
358 // Pads should be shown too
359 if( aLayer == B_Cu )
360 {
363 }
364 else if( aLayer == F_Cu )
365 {
368 }
369 }
370
372}
373
374
376{
379 m_view->SetTopLayer( aLayer );
380
381 // Layers that should always have on-top attribute enabled
382 const std::vector<int> layers = {
391 };
392
393 for( auto layer : layers )
394 m_view->SetTopLayer( layer );
395
396 // Extra layers that are brought to the top if a F.* or B.* is selected
397 const std::vector<int> frontLayers = {
400 };
401
402 const std::vector<int> backLayers = {
405 };
406
407 const std::vector<int>* extraLayers = nullptr;
408
409 // Bring a few more extra layers to the top depending on the selected board side
410 if( IsFrontLayer( aLayer ) )
411 extraLayers = &frontLayers;
412 else if( IsBackLayer( aLayer ) )
413 extraLayers = &backLayers;
414
415 if( extraLayers )
416 {
417 for( auto layer : *extraLayers )
418 {
419 m_view->SetTopLayer( layer );
420
421 if( layer < PCB_LAYER_ID_COUNT )
422 m_view->SetTopLayer( ZONE_LAYER_FOR( layer ) );
423 }
424
425 // Move the active layer to the top of the stack but below all the overlay layers
426 if( !IsCopperLayer( aLayer ) )
427 {
431
432 // Fix up pad and via netnames to be below. This is hacky, we need a rethink
433 // of layer ordering...
438 }
439 }
440
441 if( IsCopperLayer( aLayer ) )
442 {
443 m_view->SetTopLayer( ZONE_LAYER_FOR( aLayer ) );
444
445 // Display labels for copper layers on the top
446 m_view->SetTopLayer( GetNetnameLayer( aLayer ) );
447 }
448
449 m_view->SetTopLayer( BITMAP_LAYER_FOR( aLayer ) );
450 m_view->EnableTopLayer( true );
452}
453
454
456{
457 // Load layer & elements visibility settings
458 for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
459 m_view->SetLayerVisible( i, aBoard->IsLayerVisible( PCB_LAYER_ID( i ) ) );
460
462 m_view->SetLayerVisible( i, aBoard->IsElementVisible( i ) );
463
464 // Via layers controlled by dependencies
468
469 // Pad layers controlled by dependencies
472
473 // Always enable netname layers, as their visibility is controlled by layer dependencies
474 for( int i = NETNAMES_LAYER_ID_START; i < NETNAMES_LAYER_ID_END; ++i )
475 m_view->SetLayerVisible( i, true );
476
477 for( int i = LAYER_ZONE_START; i < LAYER_ZONE_END; i++ )
478 m_view->SetLayerVisible( i, true );
479
480 for( int i = LAYER_BITMAP_START; i < LAYER_BITMAP_END; i++ )
481 m_view->SetLayerVisible( i, true );
482
483 // Enable some layers that are GAL specific
492}
493
494
496 std::vector<MSG_PANEL_ITEM>& aList )
497{
498 BOARD* board = static_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() )->GetBoard();
499 int padCount = 0;
500 int viaCount = 0;
501 int trackSegmentCount = 0;
502 std::set<int> netCodes;
503 int unconnected = board->GetConnectivity()->GetUnconnectedCount( true );
504
505 for( PCB_TRACK* item : board->Tracks() )
506 {
507 if( item->Type() == PCB_VIA_T )
508 viaCount++;
509 else
510 trackSegmentCount++;
511
512 if( item->GetNetCode() > 0 )
513 netCodes.insert( item->GetNetCode() );
514 }
515
516 for( FOOTPRINT* footprint : board->Footprints() )
517 {
518 for( PAD* pad : footprint->Pads() )
519 {
520 padCount++;
521
522 if( pad->GetNetCode() > 0 )
523 netCodes.insert( pad->GetNetCode() );
524 }
525 }
526
527 aList.emplace_back( _( "Pads" ), wxString::Format( wxT( "%d" ), padCount ) );
528 aList.emplace_back( _( "Vias" ), wxString::Format( wxT( "%d" ), viaCount ) );
529 aList.emplace_back( _( "Track Segments" ), wxString::Format( wxT( "%d" ), trackSegmentCount ) );
530 aList.emplace_back( _( "Nets" ), wxString::Format( wxT( "%d" ), (int) netCodes.size() ) );
531 aList.emplace_back( _( "Unrouted" ), wxString::Format( wxT( "%d" ), unconnected ) );
532}
533
534
536{
537 PCB_BASE_FRAME* frame = nullptr;
538
539 if( !IsDialogPreview() )
540 frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
541
542 try
543 {
544 // Check if the current rendering back end can be properly initialized
546 }
547 catch( const std::runtime_error& e )
548 {
549 DisplayError( GetParent(), e.what() );
550
551 // Use the fallback if we have one
552 if( GAL_FALLBACK != m_backend )
553 {
555
556 if( frame )
557 frame->ActivateGalCanvas();
558 }
559 }
560
561 if( frame )
562 {
563 SetTopLayer( frame->GetActiveLayer() );
564 KIGFX::PAINTER* painter = m_view->GetPainter();
565 auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
566 settings->LoadDisplayOptions( frame->GetDisplayOptions() );
567 }
568}
569
570
572{
573 for( int i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( int ); ++i )
574 {
575 int layer = GAL_LAYER_ORDER[i];
576 wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
577
578 // MW: Gross hack to make SetTopLayer bring the correct bitmap layer to
579 // the top of the other bitmaps, but still below all the other layers
580 if( layer < LAYER_BITMAP_START )
581 m_view->SetLayerOrder( layer, i );
582 else
584 }
585}
586
587
589{
590 bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
592 m_gal->SetWorldUnitLength( 1e-9 /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
593 return rv;
594}
595
596
598{
599 if( m_ratsnest )
600 m_view->Update( m_ratsnest.get() );
601}
602
603
605{
607 return m_drawingSheet->ViewBBox();
608
609 return BOX2I();
610}
611
612
614{
615 // caching makes no sense for Cairo and other software renderers
617
618 for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
619 m_view->SetLayerTarget( i, target );
620
621 for( int i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( int ); ++i )
622 {
623 int layer = GAL_LAYER_ORDER[i];
624 wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
625
626 // Set layer display dependencies & targets
627 if( IsCopperLayer( layer ) )
628 {
629 m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
630 m_view->SetRequired( BITMAP_LAYER_FOR( layer ), layer );
632 m_view->SetRequired( GetNetnameLayer( layer ), layer );
633 }
634 else if( IsNonCopperLayer( layer ) )
635 {
636 m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
638 m_view->SetRequired( BITMAP_LAYER_FOR( layer ), layer );
639 }
640 else if( IsNetnameLayer( layer ) )
641 {
642 m_view->SetLayerDisplayOnly( layer );
643 }
644 }
645
648
651
654
655 // Some more required layers settings
658
659 // Holes can be independent of their host objects (cf: printing drill marks)
665
666 // Via visibility
670
671 // Pad visibility
675
676 // Front footprints
679
680 // Back footprints
683
690
699
703}
704
705
707{
708 return static_cast<KIGFX::PCB_VIEW*>( m_view );
709}
BOX2< VECTOR2I > BOX2I
Definition: box2.h:847
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:196
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:58
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:265
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition: board.cpp:592
ZONES & Zones()
Definition: board.h:313
FOOTPRINTS & Footprints()
Definition: board.h:307
TRACKS & Tracks()
Definition: board.h:304
MARKERS & Markers()
Definition: board.h:316
const wxString & GetFileName() const
Definition: board.h:302
DRAWINGS & Drawings()
Definition: board.h:310
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:532
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:424
void CacheTriangulation(PROGRESS_REPORTER *aReporter=nullptr, const std::vector< ZONE * > &aZones={})
Definition: board.cpp:661
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.
Contains all the knowledge about how to draw graphical object onto any particular output device.
Definition: painter.h:58
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
PCB specific render settings.
Definition: pcb_painter.h:72
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:125
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
Definition: view.h:730
void UpdateAllLayersOrder()
Do everything that is needed to apply the rendering order of layers.
Definition: view.cpp:889
void SetRequired(int aLayerId, int aRequiredId, bool aRequired=true)
Mark the aRequiredId layer as required for the aLayerId layer.
Definition: view.cpp:386
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:457
int GetLayerOrder(int aLayer) const
Return rendering order of a particular layer.
Definition: view.cpp:639
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:316
virtual void EnableTopLayer(bool aEnable)
Enable or disable display of the top layer.
Definition: view.cpp:849
void SetPainter(PAINTER *aPainter)
Set the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:203
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition: view.cpp:758
void SetGAL(GAL *aGal)
Assign a rendering device for the VIEW.
Definition: view.cpp:489
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Change the rendering target for a particular layer.
Definition: view.h:469
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:1586
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition: view.h:393
void Clear()
Remove all items from the view.
Definition: view.cpp:1096
void ClearTopLayers()
Remove all layers from the on-the-top set (they are no longer displayed over the rest of layers).
Definition: view.cpp:874
static constexpr int VIEW_MAX_LAYERS
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:727
void UpdateItems()
Iterate through the list of items that asked for updating and updates them.
Definition: view.cpp:1398
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:822
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition: view.h:410
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:213
void SetScaleLimits(double aMaximum, double aMinimum)
Set minimum and maximum values for scale.
Definition: view.h:309
void SetLayerOrder(int aLayer, int aRenderingOrder)
Set rendering order of a particular layer.
Definition: view.cpp:631
An implementation of class VIEW_CONTROLS for wxWidgets library.
Definition: pad.h:59
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...
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
void SetDrawingSheet(DS_PROXY_VIEW_ITEM *aDrawingSheet)
Sets (or updates) drawing-sheet used by the draw panel.
void setDefaultLayerDeps()
Currently used drawing-sheet.
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
Ratsnest view item.
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.
Handle a list of polygons defining a copper zone.
Definition: zone.h:57
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:280
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:46
@ LAYER_PAD_FR_NETNAMES
Additional netnames layers (not associated with a PCB layer)
Definition: layer_ids.h:165
@ LAYER_PAD_BK_NETNAMES
Definition: layer_ids.h:166
@ LAYER_PAD_NETNAMES
Definition: layer_ids.h:167
@ NETNAMES_LAYER_ID_START
Definition: layer_ids.h:157
@ NETNAMES_LAYER_ID_END
Definition: layer_ids.h:170
@ LAYER_VIA_NETNAMES
Definition: layer_ids.h:168
#define BITMAP_LAYER_FOR(boardLayer)
Macros for getting the extra layers for a given board layer.
Definition: layer_ids.h:267
#define NETNAMES_LAYER_INDEX(layer)
Macro for obtaining netname layer for a given PCB layer.
Definition: layer_ids.h:174
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
Definition: layer_ids.h:899
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
Definition: layer_ids.h:922
bool IsNonCopperLayer(int aLayerId)
Test whether a layer is a non copper layer.
Definition: layer_ids.h:836
int GetNetnameLayer(int aLayer)
Returns a netname layer corresponding to the given layer.
Definition: layer_ids.h:966
bool IsCopperLayer(int aLayerId)
Tests whether a layer is a copper layer.
Definition: layer_ids.h:825
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition: layer_ids.h:190
@ LAYER_GRID
Definition: layer_ids.h:205
@ GAL_LAYER_ID_START
Definition: layer_ids.h:191
@ LAYER_LOCKED_ITEM_SHADOW
shadow layer for locked items
Definition: layer_ids.h:239
@ LAYER_VIA_HOLEWALLS
Definition: layer_ids.h:234
@ LAYER_GRID_AXES
Definition: layer_ids.h:206
@ LAYER_CONFLICTS_SHADOW
shadow layer for items flagged conficting
Definition: layer_ids.h:241
@ LAYER_ZONE_END
Definition: layer_ids.h:254
@ LAYER_NON_PLATEDHOLES
handle color for not plated holes (holes, not pads)
Definition: layer_ids.h:197
@ LAYER_PAD_FR
smd pads, front layer
Definition: layer_ids.h:202
@ LAYER_DRAWINGSHEET
drawingsheet frame and titleblock
Definition: layer_ids.h:217
@ LAYER_DRC_EXCLUSION
layer for drc markers which have been individually excluded
Definition: layer_ids.h:236
@ LAYER_MOD_TEXT
Definition: layer_ids.h:198
@ LAYER_PADS
Meta control for all pads opacity/visibility (color ignored)
Definition: layer_ids.h:230
@ LAYER_DRC_WARNING
layer for drc markers with SEVERITY_WARNING
Definition: layer_ids.h:235
@ LAYER_PAD_PLATEDHOLES
to draw pad holes (plated)
Definition: layer_ids.h:214
@ GAL_LAYER_ID_END
Definition: layer_ids.h:260
@ LAYER_GP_OVERLAY
general purpose overlay
Definition: layer_ids.h:218
@ LAYER_CURSOR
PCB cursor.
Definition: layer_ids.h:221
@ LAYER_RATSNEST
Definition: layer_ids.h:204
@ LAYER_MOD_FR
show footprints on front
Definition: layer_ids.h:208
@ LAYER_ZONE_START
Virtual layers for stacking zones and tracks on a given copper layer.
Definition: layer_ids.h:253
@ LAYER_ANCHOR
anchor of items having an anchor point (texts, footprints)
Definition: layer_ids.h:201
@ LAYER_PAD_BK
smd pads, back layer
Definition: layer_ids.h:203
@ LAYER_MOD_VALUES
show footprints values (when texts are visible)
Definition: layer_ids.h:210
@ LAYER_PADS_TH
multilayer pads, usually with holes
Definition: layer_ids.h:213
@ LAYER_MARKER_SHADOWS
shadows for drc markers
Definition: layer_ids.h:237
@ LAYER_VIA_HOLES
to draw via holes (pad holes do not use this layer)
Definition: layer_ids.h:215
@ LAYER_VIA_MICROVIA
to draw micro vias
Definition: layer_ids.h:194
@ LAYER_SELECT_OVERLAY
currently selected items overlay
Definition: layer_ids.h:219
@ LAYER_VIA_THROUGH
to draw usual through hole vias
Definition: layer_ids.h:196
@ LAYER_BITMAP_END
Definition: layer_ids.h:258
@ LAYER_BITMAP_START
Virtual layers for background images per board layer.
Definition: layer_ids.h:257
@ LAYER_DRC_ERROR
layer for drc markers with SEVERITY_ERROR
Definition: layer_ids.h:216
@ LAYER_VIAS
Meta control for all vias opacity/visibility.
Definition: layer_ids.h:193
@ LAYER_MOD_BK
show footprints on back
Definition: layer_ids.h:209
@ LAYER_MOD_REFERENCES
show footprints references (when texts are visible)
Definition: layer_ids.h:211
@ LAYER_VIA_BBLIND
to draw blind/buried vias
Definition: layer_ids.h:195
@ LAYER_PAD_HOLEWALLS
Definition: layer_ids.h:233
bool IsNetnameLayer(int aLayer)
Test whether a layer is a netname layer.
Definition: layer_ids.h:989
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:59
@ In22_Cu
Definition: layer_ids.h:86
@ In11_Cu
Definition: layer_ids.h:75
@ In29_Cu
Definition: layer_ids.h:93
@ In30_Cu
Definition: layer_ids.h:94
@ User_8
Definition: layer_ids.h:130
@ F_CrtYd
Definition: layer_ids.h:117
@ In17_Cu
Definition: layer_ids.h:81
@ B_Adhes
Definition: layer_ids.h:97
@ Edge_Cuts
Definition: layer_ids.h:113
@ Dwgs_User
Definition: layer_ids.h:109
@ F_Paste
Definition: layer_ids.h:101
@ In9_Cu
Definition: layer_ids.h:73
@ Cmts_User
Definition: layer_ids.h:110
@ User_6
Definition: layer_ids.h:128
@ User_7
Definition: layer_ids.h:129
@ In19_Cu
Definition: layer_ids.h:83
@ In7_Cu
Definition: layer_ids.h:71
@ In28_Cu
Definition: layer_ids.h:92
@ In26_Cu
Definition: layer_ids.h:90
@ F_Adhes
Definition: layer_ids.h:98
@ B_Mask
Definition: layer_ids.h:106
@ B_Cu
Definition: layer_ids.h:95
@ User_5
Definition: layer_ids.h:127
@ Eco1_User
Definition: layer_ids.h:111
@ F_Mask
Definition: layer_ids.h:107
@ In21_Cu
Definition: layer_ids.h:85
@ In23_Cu
Definition: layer_ids.h:87
@ B_Paste
Definition: layer_ids.h:100
@ In15_Cu
Definition: layer_ids.h:79
@ In2_Cu
Definition: layer_ids.h:66
@ User_9
Definition: layer_ids.h:131
@ F_Fab
Definition: layer_ids.h:120
@ In10_Cu
Definition: layer_ids.h:74
@ Margin
Definition: layer_ids.h:114
@ F_SilkS
Definition: layer_ids.h:104
@ In4_Cu
Definition: layer_ids.h:68
@ B_CrtYd
Definition: layer_ids.h:116
@ Eco2_User
Definition: layer_ids.h:112
@ In16_Cu
Definition: layer_ids.h:80
@ In24_Cu
Definition: layer_ids.h:88
@ In1_Cu
Definition: layer_ids.h:65
@ User_3
Definition: layer_ids.h:125
@ User_1
Definition: layer_ids.h:123
@ B_SilkS
Definition: layer_ids.h:103
@ In13_Cu
Definition: layer_ids.h:77
@ User_4
Definition: layer_ids.h:126
@ In8_Cu
Definition: layer_ids.h:72
@ In14_Cu
Definition: layer_ids.h:78
@ PCB_LAYER_ID_COUNT
Definition: layer_ids.h:137
@ User_2
Definition: layer_ids.h:124
@ In12_Cu
Definition: layer_ids.h:76
@ In27_Cu
Definition: layer_ids.h:91
@ In6_Cu
Definition: layer_ids.h:70
@ In5_Cu
Definition: layer_ids.h:69
@ In3_Cu
Definition: layer_ids.h:67
@ In20_Cu
Definition: layer_ids.h:84
@ F_Cu
Definition: layer_ids.h:64
@ In18_Cu
Definition: layer_ids.h:82
@ In25_Cu
Definition: layer_ids.h:89
@ B_Fab
Definition: layer_ids.h:119
#define ZONE_LAYER_FOR(boardLayer)
Definition: layer_ids.h:268
This file contains miscellaneous commonly used macros and functions.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition: definitions.h:49
@ TARGET_CACHED
Main rendering target (cached)
Definition: definitions.h:48
@ TARGET_OVERLAY
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
const int GAL_LAYER_ORDER[]
BOARD * GetBoard()
see class PGM_BASE
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
Class that computes missing connections on a PCB.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:111
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:102
WX_VIEW_CONTROLS class definition.
#define ZOOM_MAX_LIMIT_PCBNEW
Definition: zoom_defines.h:62
#define ZOOM_MIN_LIMIT_PCBNEW
Definition: zoom_defines.h:63