KiCad PCB EDA Suite
Loading...
Searching...
No Matches
layer_ids.h
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 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
5 * Copyright (C) 2010 Jean-Pierre Charras, jp.charras at wanadoo.fr
6 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
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#ifndef LAYER_IDS_H
27#define LAYER_IDS_H
28
29#include <set>
30#include <vector>
31#include <bitset>
32#include <stdexcept>
33#include <wx/string.h>
34#include <kicommon.h>
35
36
51
52
59enum PCB_LAYER_ID: int
60{
63
64 F_Cu = 0,
65 B_Cu = 2,
66 In1_Cu = 4,
67 In2_Cu = 6,
68 In3_Cu = 8,
69 In4_Cu = 10,
70 In5_Cu = 12,
71 In6_Cu = 14,
72 In7_Cu = 16,
73 In8_Cu = 18,
74 In9_Cu = 20,
75 In10_Cu = 22,
76 In11_Cu = 24,
77 In12_Cu = 26,
78 In13_Cu = 28,
79 In14_Cu = 30,
80 In15_Cu = 32,
81 In16_Cu = 34,
82 In17_Cu = 36,
83 In18_Cu = 38,
84 In19_Cu = 40,
85 In20_Cu = 42,
86 In21_Cu = 44,
87 In22_Cu = 46,
88 In23_Cu = 48,
89 In24_Cu = 50,
90 In25_Cu = 52,
91 In26_Cu = 54,
92 In27_Cu = 56,
93 In28_Cu = 58,
94 In29_Cu = 60,
95 In30_Cu = 62,
96
97 F_Mask = 1,
98 B_Mask = 3,
99
106
111
113 Margin = 27,
114
117
118 B_Fab = 33,
119 F_Fab = 35,
120
121 Rescue = 37,
122
123 // User definable layers.
124 User_1 = 39,
125 User_2 = 41,
126 User_3 = 43,
127 User_4 = 45,
128 User_5 = 47,
129 User_6 = 49,
130 User_7 = 51,
131 User_8 = 53,
132 User_9 = 55,
155 User_32 = 101,
156 User_33 = 103,
157 User_34 = 105,
158 User_35 = 107,
159 User_36 = 109,
160 User_37 = 111,
161 User_38 = 113,
162 User_39 = 115,
163 User_40 = 117,
164 User_41 = 119,
165 User_42 = 121,
166 User_43 = 123,
167 User_44 = 125,
168 User_45 = 127,
169
170
172};
173
175
176#define MAX_CU_LAYERS 32
177#define MAX_USER_DEFINED_LAYERS 45
178
189
207
209#define NETNAMES_LAYER_INDEX( layer ) ( static_cast<int>( NETNAMES_LAYER_ID_START ) + layer )
210
211#define GAL_UI_LAYER_COUNT 10
212
228{
230
236
240
241// LAYER_MOD_TEXT_BK deprecated + 6,
242
243// DEPRECATED, UNUSED SINCE 9.0. text marked as invisible.
244// LAYER_HIDDEN_TEXT = GAL_LAYER_ID_START + 7,
245
248
249// LAYER_PADS_SMD_FR = GAL_LAYER_ID_START + 9, // Deprecated since 9.0
250// LAYER_PADS_SMD_BK = GAL_LAYER_ID_START + 10, // Deprecated since 9.0
251
255
256// LAYER_NO_CONNECTS deprecated + 14, // show a marker on pads with no nets
257
260
263
267
268// LAYER_PADS_TH = GAL_LAYER_ID_START + 20, ///< Deprecated since 9.0
269
271
274
284
287
288 // Layers in this section have visibility controls but were not present in legacy board files.
289
292
295
298
301
305
307
310
313
315// LAYER_DRC_SHAPE2 = GAL_LAYER_ID_START + 43, ///< Deprecated since 10.0
316
318
321
322 // Add layers below this point that do not have visibility controls, so don't need explicit
323 // enum values
324
327
330
334
338
342
346
350
354
355 // Layers for drawing on-canvas UI
358
360};
361
363#define GAL_LAYER_INDEX( x ) ( x - GAL_LAYER_ID_START )
364
366#define BITMAP_LAYER_FOR( boardLayer ) ( LAYER_BITMAP_START + boardLayer )
367#define ZONE_LAYER_FOR( boardLayer ) ( LAYER_ZONE_START + boardLayer )
368#define PAD_COPPER_LAYER_FOR( boardLayer ) ( LAYER_PAD_COPPER_START + boardLayer )
369#define VIA_COPPER_LAYER_FOR( boardLayer ) ( LAYER_VIA_COPPER_START + boardLayer )
370#define CLEARANCE_LAYER_FOR( boardLayer ) ( LAYER_CLEARANCE_START + boardLayer )
371#define POINT_LAYER_FOR( boardLayer ) ( LAYER_POINT_START + boardLayer )
372
374
376{
377 a = GAL_LAYER_ID( int( a ) + 1 );
378 return a;
379}
380
381inline GAL_LAYER_ID ToGalLayer( int aInteger )
382{
383 wxASSERT( aInteger >= GAL_LAYER_ID_START && aInteger <= GAL_LAYER_ID_END );
384 return static_cast<GAL_LAYER_ID>( aInteger );
385}
386
388inline GAL_LAYER_ID operator+( const GAL_LAYER_ID& a, int b )
389{
390 GAL_LAYER_ID t = GAL_LAYER_ID( int( a ) + b );
391 wxASSERT( t <= GAL_LAYER_ID_END );
392 return t;
393}
394
395
397typedef std::bitset<GAL_LAYER_ID_COUNT> GAL_BASE_SET;
398
399
402{
403
404private:
405 static constexpr int start = static_cast<int>( GAL_LAYER_ID_START );
406
407public:
409 {
410 }
411
412 GAL_SET( const GAL_SET& aOther ) : std::bitset<GAL_LAYER_ID_COUNT>( aOther )
413 {
414 }
415
416 GAL_SET( const GAL_LAYER_ID* aArray, unsigned aCount );
417
419 {
420 GAL_BASE_SET::set();
421 return *this;
422 }
423
424 GAL_SET& set( int aPos, bool aVal = true )
425 {
426 GAL_BASE_SET::set( aPos, aVal );
427 return *this;
428 }
429
430 GAL_SET& set( GAL_LAYER_ID aPos, bool aVal = true )
431 {
432 GAL_BASE_SET::set( static_cast<std::size_t>( aPos ) - start, aVal );
433 return *this;
434 }
435
437 {
438 return test( static_cast<std::size_t>( aPos ) - start );
439 }
440
441 std::vector<GAL_LAYER_ID> Seq() const;
442
443 static GAL_SET DefaultVisible();
444};
445
504
505#define SCH_LAYER_ID_COUNT ( SCH_LAYER_ID_END - SCH_LAYER_ID_START )
506
507#define SCH_LAYER_INDEX( x ) ( x - SCH_LAYER_ID_START )
508
510{
511 a = SCH_LAYER_ID( int( a ) + 1 );
512 return a;
513}
514
516#define GERBER_DRAWLAYERS_COUNT static_cast<int>( PCB_LAYER_ID_COUNT )
517
536
537#define GERBER_DRAW_LAYER( x ) ( GERBVIEW_LAYER_ID_START + x )
538
539#define GERBER_DCODE_LAYER( x ) ( GERBER_DRAWLAYERS_COUNT + x )
540
541#define GERBER_DRAW_LAYER_INDEX( x ) ( x - GERBVIEW_LAYER_ID_START )
542
543
545enum LAYER_3D_ID : int
546{
548
618
620};
621
623#define LAYER_ID_COUNT LAYER_3D_END
624
625
631KICOMMON_API wxString LayerName( int aLayer );
632
633
634// Some elements do not have yet a visibility control
635// from a dialog, but have a visibility control flag.
636// Here is a mask to set them visible, to be sure they are displayed
637// after loading a board for instance
638#define MIN_VISIBILITY_MASK int( ( 1 << GAL_LAYER_INDEX( LAYER_PAD_PLATEDHOLES ) ) +\
639 ( 1 << GAL_LAYER_INDEX( LAYER_VIA_HOLES ) ) +\
640 ( 1 << GAL_LAYER_INDEX( LAYER_SELECT_OVERLAY ) ) +\
641 ( 1 << GAL_LAYER_INDEX( LAYER_GP_OVERLAY ) ) +\
642 ( 1 << GAL_LAYER_INDEX( LAYER_RATSNEST ) ) )
643
644
652inline bool IsValidLayer( int aLayerId )
653{
654 return unsigned( aLayerId ) < PCB_LAYER_ID_COUNT;
655}
656
663inline bool IsPcbLayer( int aLayer )
664{
665 return aLayer >= F_Cu && aLayer < PCB_LAYER_ID_COUNT;
666}
667
674inline bool IsCopperLayer( int aLayerId )
675{
676 return !( aLayerId & 1 ) && aLayerId < PCB_LAYER_ID_COUNT && aLayerId >= 0;
677}
678
685inline bool IsExternalCopperLayer( int aLayerId )
686{
687 return aLayerId == F_Cu || aLayerId == B_Cu;
688}
689
696inline bool IsInnerCopperLayer( int aLayerId )
697{
698 return IsCopperLayer( aLayerId ) && !IsExternalCopperLayer( aLayerId );
699}
700
707inline bool IsNonCopperLayer( int aLayerId )
708{
709 return ( aLayerId & 1 ) && aLayerId <= PCB_LAYER_ID_COUNT;
710}
711
720inline bool IsCopperLayer( int aLayerId, bool aIncludeSyntheticCopperLayers )
721{
722 if( aIncludeSyntheticCopperLayers )
723 return !IsNonCopperLayer( aLayerId );
724 else
725 return IsCopperLayer( aLayerId );
726}
727
728inline bool IsViaPadLayer( int aLayer )
729{
730 return aLayer == LAYER_VIA_THROUGH
731 || aLayer == LAYER_VIA_MICROVIA
732 || aLayer == LAYER_VIA_BBLIND;
733}
734
735inline bool IsHoleLayer( int aLayer )
736{
737 return aLayer == LAYER_VIA_HOLES
738 || aLayer == LAYER_VIA_HOLEWALLS
739 || aLayer == LAYER_PAD_PLATEDHOLES
740 || aLayer == LAYER_PAD_HOLEWALLS
741 || aLayer == LAYER_NON_PLATEDHOLES;
742}
743
744inline bool IsSolderMaskLayer( int aLayer )
745{
746 return aLayer == F_Mask || aLayer == B_Mask;
747}
748
755inline bool IsUserLayer( PCB_LAYER_ID aLayerId )
756{
757 return aLayerId == Dwgs_User || aLayerId == Cmts_User || aLayerId == Eco1_User
758 || aLayerId == Eco2_User || ( aLayerId >= User_1 && !IsCopperLayer( aLayerId ) );
759}
760
761
762/*
763 * IMPORTANT: If a layer is not a front layer that doesn't necessarily mean it's a back layer.
764 *
765 * So a layer can be:
766 * - Front
767 * - Back
768 * - Neither (internal or auxiliary)
769 *
770 * The check most frequent is for back layers, since it involves flips.
771 */
772
776inline bool IsFrontLayer( PCB_LAYER_ID aLayerId )
777{
778 switch( aLayerId )
779 {
780 case F_Cu:
781 case F_Adhes:
782 case F_Paste:
783 case F_SilkS:
784 case F_Mask:
785 case F_CrtYd:
786 case F_Fab:
787 return true;
788 default:
789 ;
790 }
791
792 return false;
793}
794
795
799inline bool IsBackLayer( PCB_LAYER_ID aLayerId )
800{
801 switch( aLayerId )
802 {
803 case B_Cu:
804 case B_Adhes:
805 case B_Paste:
806 case B_SilkS:
807 case B_Mask:
808 case B_CrtYd:
809 case B_Fab:
810 return true;
811 default:
812 return false;
813 }
814}
815
816
820inline bool IsCopperLayerLowerThan( PCB_LAYER_ID aLayerA, PCB_LAYER_ID aLayerB )
821{
822 if( aLayerA == aLayerB )
823 return false;
824
825 if( aLayerA == B_Cu )
826 return true;
827
828 if( aLayerB == B_Cu )
829 return false;
830
831 return aLayerA > aLayerB;
832}
833
834
844KICOMMON_API PCB_LAYER_ID FlipLayer( PCB_LAYER_ID aLayerId, int aCopperLayersCount = 0 );
845
846
850inline int GetNetnameLayer( int aLayer )
851{
852 if( IsCopperLayer( aLayer ) || IsViaPadLayer( aLayer ) )
853 return NETNAMES_LAYER_INDEX( aLayer );
854
855 // Fallback
856 return Cmts_User;
857}
858
865inline bool IsNetnameLayer( int aLayer )
866{
867 return aLayer >= NETNAMES_LAYER_INDEX( F_Cu ) && aLayer < NETNAMES_LAYER_ID_END;
868}
869
870
871inline bool IsZoneFillLayer( int aLayer )
872{
873 return aLayer >= LAYER_ZONE_START && aLayer <= LAYER_ZONE_END;
874}
875
876
877inline bool IsPadCopperLayer( int aLayer )
878{
879 return aLayer >= LAYER_PAD_COPPER_START && aLayer <= LAYER_PAD_COPPER_END;
880}
881
882
883inline bool IsViaCopperLayer( int aLayer )
884{
885 return aLayer >= LAYER_VIA_COPPER_START && aLayer <= LAYER_VIA_COPPER_END;
886}
887
888
889inline bool IsClearanceLayer( int aLayer )
890{
891 return aLayer >= LAYER_CLEARANCE_START && aLayer <= LAYER_CLEARANCE_END;
892}
893
894
895inline bool IsPointsLayer( int aLayer )
896{
897 return aLayer >= LAYER_POINT_START && aLayer <= LAYER_POINT_END;
898}
899
900
901inline bool IsDCodeLayer( int aLayer )
902{
904 && aLayer < ( GERBVIEW_LAYER_ID_START + ( 2 * GERBER_DRAWLAYERS_COUNT ) );
905}
906
907
909inline size_t CopperLayerToOrdinal( PCB_LAYER_ID aLayer )
910{
911 wxCHECK( IsCopperLayer( aLayer ), 0 );
912
913 switch( aLayer )
914 {
915 case F_Cu: return 0;
916 case B_Cu: return MAX_CU_LAYERS - 1;
917 default: return ( aLayer - B_Cu ) / 2;
918 }
919}
920
921
926
927
930
931
933
934#endif // LAYER_IDS_H
Helper for storing and iterating over GAL_LAYER_IDs.
Definition layer_ids.h:402
bool Contains(GAL_LAYER_ID aPos)
Definition layer_ids.h:436
GAL_SET & set()
Definition layer_ids.h:418
static constexpr int start
Definition layer_ids.h:405
GAL_SET(const GAL_SET &aOther)
Definition layer_ids.h:412
GAL_SET & set(int aPos, bool aVal=true)
Definition layer_ids.h:424
GAL_SET & set(GAL_LAYER_ID aPos, bool aVal=true)
Definition layer_ids.h:430
#define KICOMMON_API
Definition kicommon.h:28
bool IsSolderMaskLayer(int aLayer)
Definition layer_ids.h:744
NETNAMES_LAYER_ID
Dedicated layers for net names used in Pcbnew.
Definition layer_ids.h:192
@ 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
@ NETNAMES_LAYER_ID_RESERVED
Reserved space for board layer netnames.
Definition layer_ids.h:197
std::bitset< GAL_LAYER_ID_COUNT > GAL_BASE_SET
Wraps a std::bitset.
Definition layer_ids.h:397
GAL_LAYER_ID operator++(GAL_LAYER_ID &a)
Definition layer_ids.h:375
GERBVIEW_LAYER_ID
Gerbview draw layers.
Definition layer_ids.h:520
@ GERBVIEW_LAYER_ID_RESERVED
Gerbview draw layers and d-code layers.
Definition layer_ids.h:524
@ LAYER_GERBVIEW_DRAWINGSHEET
Definition layer_ids.h:531
@ GERBVIEW_LAYER_ID_START
Definition layer_ids.h:521
@ LAYER_GERBVIEW_BACKGROUND
Definition layer_ids.h:530
@ LAYER_DCODES
Definition layer_ids.h:526
@ LAYER_NEGATIVE_OBJECTS
Definition layer_ids.h:527
@ LAYER_GERBVIEW_PAGE_LIMITS
Definition layer_ids.h:532
@ GERBVIEW_LAYER_ID_END
Definition layer_ids.h:534
@ LAYER_GERBVIEW_AXES
Definition layer_ids.h:529
@ LAYER_GERBVIEW_GRID
Definition layer_ids.h:528
KICOMMON_API PCB_LAYER_ID Map3DLayerToPCBLayer(int aLayer)
Definition layer_id.cpp:266
GAL_LAYER_ID operator+(const GAL_LAYER_ID &a, int b)
Used for via types.
Definition layer_ids.h:388
bool IsPcbLayer(int aLayer)
Test whether a layer is a valid layer for Pcbnew.
Definition layer_ids.h:663
bool IsPadCopperLayer(int aLayer)
Definition layer_ids.h:877
LAYER_3D_ID
3D Viewer virtual layers for color settings
Definition layer_ids.h:546
@ LAYER_3D_USER_1
Definition layer_ids.h:564
@ LAYER_3D_SOLDERMASK_TOP
Definition layer_ids.h:557
@ LAYER_3D_USER_8
Definition layer_ids.h:571
@ LAYER_3D_USER_22
Definition layer_ids.h:585
@ LAYER_3D_USER_44
Definition layer_ids.h:607
@ LAYER_3D_USER_23
Definition layer_ids.h:586
@ LAYER_3D_NAVIGATOR
Definition layer_ids.h:614
@ LAYER_3D_USER_28
Definition layer_ids.h:591
@ LAYER_3D_BOUNDING_BOXES
Definition layer_ids.h:615
@ LAYER_3D_START
Definition layer_ids.h:547
@ LAYER_3D_USER_32
Definition layer_ids.h:595
@ LAYER_3D_USER_19
Definition layer_ids.h:582
@ LAYER_3D_USER_25
Definition layer_ids.h:588
@ LAYER_3D_ADHESIVE
Definition layer_ids.h:559
@ LAYER_3D_USER_3
Definition layer_ids.h:566
@ LAYER_3D_USER_21
Definition layer_ids.h:584
@ LAYER_3D_USER_26
Definition layer_ids.h:589
@ LAYER_3D_SMD_MODELS
Definition layer_ids.h:610
@ LAYER_3D_USER_24
Definition layer_ids.h:587
@ LAYER_3D_USER_43
Definition layer_ids.h:606
@ LAYER_3D_BACKGROUND_TOP
Definition layer_ids.h:550
@ LAYER_3D_USER_COMMENTS
Definition layer_ids.h:560
@ LAYER_3D_SOLDERMASK_BOTTOM
Definition layer_ids.h:556
@ LAYER_3D_USER_11
Definition layer_ids.h:574
@ LAYER_3D_USER_41
Definition layer_ids.h:604
@ LAYER_3D_USER_17
Definition layer_ids.h:580
@ LAYER_3D_BOARD
Definition layer_ids.h:551
@ LAYER_3D_PLATED_BARRELS
Definition layer_ids.h:617
@ LAYER_3D_USER_ECO1
Definition layer_ids.h:562
@ LAYER_3D_USER_20
Definition layer_ids.h:583
@ LAYER_3D_USER_31
Definition layer_ids.h:594
@ LAYER_3D_USER_ECO2
Definition layer_ids.h:563
@ LAYER_3D_TH_MODELS
Definition layer_ids.h:609
@ LAYER_3D_USER_15
Definition layer_ids.h:578
@ LAYER_3D_USER_38
Definition layer_ids.h:601
@ LAYER_3D_USER_13
Definition layer_ids.h:576
@ LAYER_3D_USER_33
Definition layer_ids.h:596
@ LAYER_3D_USER_35
Definition layer_ids.h:598
@ LAYER_3D_USER_29
Definition layer_ids.h:592
@ LAYER_3D_USER_40
Definition layer_ids.h:603
@ LAYER_3D_SILKSCREEN_TOP
Definition layer_ids.h:555
@ LAYER_3D_VIRTUAL_MODELS
Definition layer_ids.h:611
@ LAYER_3D_MODELS_MARKED_DNP
Definition layer_ids.h:613
@ LAYER_3D_USER_7
Definition layer_ids.h:570
@ LAYER_3D_COPPER_TOP
Definition layer_ids.h:552
@ LAYER_3D_USER_12
Definition layer_ids.h:575
@ LAYER_3D_SOLDERPASTE
Definition layer_ids.h:558
@ LAYER_3D_USER_30
Definition layer_ids.h:593
@ LAYER_3D_USER_36
Definition layer_ids.h:599
@ LAYER_3D_USER_2
Definition layer_ids.h:565
@ LAYER_3D_USER_18
Definition layer_ids.h:581
@ LAYER_3D_OFF_BOARD_SILK
Definition layer_ids.h:616
@ LAYER_3D_USER_14
Definition layer_ids.h:577
@ LAYER_3D_USER_5
Definition layer_ids.h:568
@ LAYER_3D_USER_37
Definition layer_ids.h:600
@ LAYER_3D_USER_10
Definition layer_ids.h:573
@ LAYER_3D_MODELS_NOT_IN_POS
Definition layer_ids.h:612
@ LAYER_3D_USER_42
Definition layer_ids.h:605
@ LAYER_3D_USER_45
Definition layer_ids.h:608
@ LAYER_3D_USER_6
Definition layer_ids.h:569
@ LAYER_3D_USER_4
Definition layer_ids.h:567
@ LAYER_3D_USER_27
Definition layer_ids.h:590
@ LAYER_3D_USER_DRAWINGS
Definition layer_ids.h:561
@ LAYER_3D_COPPER_BOTTOM
Definition layer_ids.h:553
@ LAYER_3D_USER_39
Definition layer_ids.h:602
@ LAYER_3D_USER_9
Definition layer_ids.h:572
@ LAYER_3D_BACKGROUND_BOTTOM
Definition layer_ids.h:549
@ LAYER_3D_USER_16
Definition layer_ids.h:579
@ LAYER_3D_SILKSCREEN_BOTTOM
Definition layer_ids.h:554
@ LAYER_3D_USER_34
Definition layer_ids.h:597
@ LAYER_3D_END
Definition layer_ids.h:619
bool IsUserLayer(PCB_LAYER_ID aLayerId)
Test whether a layer is a non copper and a non tech layer.
Definition layer_ids.h:755
bool IsCopperLayerLowerThan(PCB_LAYER_ID aLayerA, PCB_LAYER_ID aLayerB)
Return true if copper aLayerA is placed lower than aLayerB, false otherwise.
Definition layer_ids.h:820
constexpr PCB_LAYER_ID PCBNEW_LAYER_ID_START
Definition layer_ids.h:174
KICOMMON_API PCB_LAYER_ID BoardLayerFromLegacyId(int aLegacyId)
Retrieve a layer ID from an integer converted from a legacy (pre-V9) enum value.
Definition layer_id.cpp:216
#define NETNAMES_LAYER_INDEX(layer)
Macro for obtaining netname layer for a given PCB layer.
Definition layer_ids.h:209
GAL_LAYER_ID ToGalLayer(int aInteger)
Definition layer_ids.h:381
constexpr int GAL_LAYER_ID_COUNT
Definition layer_ids.h:373
bool IsPointsLayer(int aLayer)
Definition layer_ids.h:895
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
Definition layer_ids.h:776
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition layer_ids.h:184
@ NEVER_FLASHED
Never flashed for connectivity.
Definition layer_ids.h:187
@ ALWAYS_FLASHED
Always flashed for connectivity.
Definition layer_ids.h:186
bool IsDCodeLayer(int aLayer)
Definition layer_ids.h:901
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
Definition layer_ids.h:799
#define MAX_CU_LAYERS
Definition layer_ids.h:176
KICOMMON_API PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount=0)
Definition layer_id.cpp:170
bool IsNonCopperLayer(int aLayerId)
Test whether a layer is a non copper layer.
Definition layer_ids.h:707
int GetNetnameLayer(int aLayer)
Return a netname layer corresponding to the given layer.
Definition layer_ids.h:850
KICOMMON_API wxString LayerName(int aLayer)
Return the string equivalent of a given layer.
Definition layer_id.cpp:31
bool IsClearanceLayer(int aLayer)
Definition layer_ids.h:889
#define GAL_UI_LAYER_COUNT
Definition layer_ids.h:211
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition layer_ids.h:674
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition layer_ids.h:228
@ LAYER_GRID
Definition layer_ids.h:253
@ LAYER_POINTS
PCB reference/manual snap points visibility.
Definition layer_ids.h:320
@ GAL_LAYER_ID_START
Definition layer_ids.h:229
@ LAYER_PAGE_LIMITS
Color for drawing the page extents (visibility stored in PCBNEW_SETTINGS::m_ShowPageLimits)
Definition layer_ids.h:328
@ LAYER_LOCKED_ITEM_SHADOW
Shadow layer for locked items.
Definition layer_ids.h:306
@ LAYER_PAD_COPPER_START
Virtual layers for pad copper on a given copper layer.
Definition layer_ids.h:336
@ LAYER_VIA_HOLEWALLS
Definition layer_ids.h:297
@ LAYER_CLEARANCE_END
Definition layer_ids.h:345
@ LAYER_GRID_AXES
Definition layer_ids.h:254
@ LAYER_DRAWINGSHEET_PAGEn
Sheet Editor previewing pages after first page.
Definition layer_ids.h:326
@ LAYER_FILLED_SHAPES
Copper graphic shape opacity/visibility (color ignored).
Definition layer_ids.h:312
@ LAYER_CONFLICTS_SHADOW
Shadow layer for items flagged conflicting.
Definition layer_ids.h:309
@ LAYER_FOOTPRINTS_FR
Show footprints on front.
Definition layer_ids.h:258
@ LAYER_ZONE_END
Definition layer_ids.h:333
@ LAYER_NON_PLATEDHOLES
Draw usual through hole vias.
Definition layer_ids.h:238
@ LAYER_DRAWINGSHEET
Sheet frame and title block.
Definition layer_ids.h:277
@ LAYER_DRAW_BITMAPS
Draw images.
Definition layer_ids.h:283
@ LAYER_FP_REFERENCES
Show footprints references (when texts are visible).
Definition layer_ids.h:265
@ LAYER_BOARD_OUTLINE_AREA
PCB board outline.
Definition layer_ids.h:317
@ LAYER_DRC_EXCLUSION
Layer for DRC markers which have been individually excluded.
Definition layer_ids.h:303
@ LAYER_PCB_BACKGROUND
PCB background color.
Definition layer_ids.h:280
@ LAYER_POINT_END
Definition layer_ids.h:353
@ LAYER_ZONES
Control for copper zone opacity/visibility (color ignored).
Definition layer_ids.h:294
@ LAYER_DRC_SHAPES
Custom shapes for DRC markers.
Definition layer_ids.h:314
@ LAYER_PADS
Meta control for all pads opacity/visibility (color ignored).
Definition layer_ids.h:291
@ LAYER_DRC_WARNING
Layer for DRC markers with #SEVERITY_WARNING.
Definition layer_ids.h:300
@ LAYER_UI_START
Definition layer_ids.h:356
@ LAYER_PAD_PLATEDHOLES
to draw pad holes (plated)
Definition layer_ids.h:270
@ GAL_LAYER_ID_END
Definition layer_ids.h:359
@ LAYER_GP_OVERLAY
General purpose overlay.
Definition layer_ids.h:278
@ GAL_LAYER_ID_BITMASK_END
This is the end of the layers used for visibility bit masks in legacy board files.
Definition layer_ids.h:286
@ LAYER_VIA_COPPER_START
Virtual layers for via copper on a given copper layer.
Definition layer_ids.h:340
@ LAYER_TRACKS
Definition layer_ids.h:266
@ LAYER_CURSOR
PCB cursor.
Definition layer_ids.h:281
@ LAYER_AUX_ITEMS
Auxiliary items (guides, rule, etc).
Definition layer_ids.h:282
@ LAYER_RATSNEST
Definition layer_ids.h:252
@ LAYER_CLEARANCE_START
Virtual layers for pad/via/track clearance outlines for a given copper layer.
Definition layer_ids.h:344
@ LAYER_PAD_COPPER_END
Definition layer_ids.h:337
@ LAYER_ZONE_START
Virtual layers for stacking zones and tracks on a given copper layer.
Definition layer_ids.h:332
@ LAYER_FP_TEXT
Definition layer_ids.h:239
@ LAYER_FOOTPRINTS_BK
Show footprints on back.
Definition layer_ids.h:259
@ LAYER_UI_END
Definition layer_ids.h:357
@ LAYER_ANCHOR
Anchor of items having an anchor point (texts, footprints).
Definition layer_ids.h:247
@ LAYER_DRAWINGSHEET_PAGE1
Sheet Editor previewing first page.
Definition layer_ids.h:325
@ LAYER_VIA_COPPER_END
Definition layer_ids.h:341
@ LAYER_MARKER_SHADOWS
Shadows for DRC markers.
Definition layer_ids.h:304
@ LAYER_VIA_HOLES
Draw via holes (pad holes do not use this layer).
Definition layer_ids.h:273
@ LAYER_FP_VALUES
Show footprints values (when texts are visible).
Definition layer_ids.h:262
@ LAYER_POINT_START
Virtual layers for points per board layer.
Definition layer_ids.h:352
@ LAYER_VIA_MICROVIA
Definition layer_ids.h:233
@ LAYER_SELECT_OVERLAY
Selected items overlay.
Definition layer_ids.h:279
@ LAYER_VIA_THROUGH
Draw blind/buried vias.
Definition layer_ids.h:235
@ LAYER_BITMAP_END
Definition layer_ids.h:349
@ LAYER_BITMAP_START
Virtual layers for background images per board layer.
Definition layer_ids.h:348
@ LAYER_DRC_ERROR
Layer for DRC markers with #SEVERITY_ERROR.
Definition layer_ids.h:276
@ LAYER_VIAS
Meta control for all vias opacity/visibility.
Definition layer_ids.h:232
@ LAYER_VIA_BBLIND
Draw micro vias.
Definition layer_ids.h:234
@ LAYER_PAD_HOLEWALLS
Definition layer_ids.h:296
SCH_LAYER_ID
Eeschema drawing layers.
Definition layer_ids.h:448
@ LAYER_DANGLING
Definition layer_ids.h:476
@ LAYER_SHAPES_BACKGROUND
Definition layer_ids.h:482
@ LAYER_SHEETNAME
Definition layer_ids.h:471
@ LAYER_ERC_WARN
Definition layer_ids.h:478
@ LAYER_SCHEMATIC_ANCHOR
Definition layer_ids.h:498
@ LAYER_SHEETLABEL
Definition layer_ids.h:474
@ LAYER_PINNUM
Definition layer_ids.h:457
@ LAYER_RULE_AREAS
Definition layer_ids.h:464
@ LAYER_DEVICE
Definition layer_ids.h:465
@ LAYER_SHEET_BACKGROUND
Definition layer_ids.h:484
@ LAYER_EXCLUDED_FROM_SIM
Definition layer_ids.h:481
@ LAYER_BRIGHTENED
Definition layer_ids.h:490
@ LAYER_ERC_EXCLUSION
Definition layer_ids.h:480
@ LAYER_HIDDEN
Definition layer_ids.h:491
@ LAYER_HIERLABEL
Definition layer_ids.h:456
@ LAYER_PINNAM
Definition layer_ids.h:458
@ LAYER_PRIVATE_NOTES
Definition layer_ids.h:467
@ LAYER_HOVERED
Definition layer_ids.h:489
@ LAYER_GLOBLABEL
Definition layer_ids.h:455
@ LAYER_WIRE
Definition layer_ids.h:451
@ LAYER_NOTES
Definition layer_ids.h:466
@ LAYER_NET_COLOR_HIGHLIGHT
Definition layer_ids.h:492
@ LAYER_ERC_ERR
Definition layer_ids.h:479
@ LAYER_PIN
Definition layer_ids.h:469
@ LAYER_VALUEPART
Definition layer_ids.h:460
@ LAYER_BUS
Definition layer_ids.h:452
@ LAYER_SCHEMATIC_CURSOR
Definition layer_ids.h:488
@ SCH_LAYER_ID_END
Definition layer_ids.h:502
@ LAYER_FIELDS
Definition layer_ids.h:461
@ LAYER_DEVICE_BACKGROUND
Definition layer_ids.h:483
@ SCH_LAYER_ID_START
Definition layer_ids.h:449
@ LAYER_SCHEMATIC_DRAWINGSHEET
Definition layer_ids.h:494
@ LAYER_LOCLABEL
Definition layer_ids.h:454
@ LAYER_JUNCTION
Definition layer_ids.h:453
@ LAYER_SHEETFIELDS
Definition layer_ids.h:473
@ LAYER_SCHEMATIC_GRID_AXES
Definition layer_ids.h:486
@ LAYER_REFERENCEPART
Definition layer_ids.h:459
@ LAYER_NETCLASS_REFS
Definition layer_ids.h:463
@ LAYER_NOTES_BACKGROUND
Definition layer_ids.h:468
@ LAYER_OP_CURRENTS
Definition layer_ids.h:500
@ LAYER_SCHEMATIC_PAGE_LIMITS
Definition layer_ids.h:495
@ LAYER_SHEET
Definition layer_ids.h:470
@ LAYER_SELECTION_SHADOWS
Definition layer_ids.h:493
@ LAYER_SCHEMATIC_BACKGROUND
Definition layer_ids.h:487
@ LAYER_SCHEMATIC_AUX_ITEMS
Definition layer_ids.h:497
@ LAYER_INTERSHEET_REFS
Definition layer_ids.h:462
@ LAYER_OP_VOLTAGES
Definition layer_ids.h:499
@ LAYER_SHEETFILENAME
Definition layer_ids.h:472
@ LAYER_BUS_JUNCTION
Definition layer_ids.h:496
@ LAYER_DNP_MARKER
Definition layer_ids.h:477
@ LAYER_NOCONNECT
Definition layer_ids.h:475
@ LAYER_SCHEMATIC_GRID
Definition layer_ids.h:485
size_t CopperLayerToOrdinal(PCB_LAYER_ID aLayer)
Converts KiCad copper layer enum to an ordinal between the front and back layers.
Definition layer_ids.h:909
bool IsViaCopperLayer(int aLayer)
Definition layer_ids.h:883
bool IsNetnameLayer(int aLayer)
Test whether a layer is a netname layer.
Definition layer_ids.h:865
KICOMMON_API PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition lset.cpp:737
bool IsHoleLayer(int aLayer)
Definition layer_ids.h:735
bool IsViaPadLayer(int aLayer)
Definition layer_ids.h:728
bool IsInnerCopperLayer(int aLayerId)
Test whether a layer is an inner (In1_Cu to In30_Cu) copper layer.
Definition layer_ids.h:696
bool IsExternalCopperLayer(int aLayerId)
Test whether a layer is an external (F_Cu or B_Cu) copper layer.
Definition layer_ids.h:685
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
@ UNSELECTED_LAYER
Definition layer_ids.h:62
@ 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
@ UNDEFINED_LAYER
Definition layer_ids.h:61
@ 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
@ Rescue
Definition layer_ids.h:121
@ 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
bool IsValidLayer(int aLayerId)
Test whether a given integer is a valid layer index, i.e.
Definition layer_ids.h:652
KICOMMON_API int MapPCBLayerTo3DLayer(PCB_LAYER_ID aLayer)
Definition layer_id.cpp:332
#define GERBER_DRAWLAYERS_COUNT
Number of draw layers in Gerbview.
Definition layer_ids.h:516
bool IsZoneFillLayer(int aLayer)
Definition layer_ids.h:871
STL namespace.