KiCad PCB EDA Suite
layers_id_colors_and_visibility.h File Reference

Board layer functions and definitions. More...

#include <vector>
#include <bitset>
#include <wx/string.h>
#include <macros.h>

Go to the source code of this file.

Classes

class  LSEQ
 Class LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs. More...
 
class  LSET
 Class LSET is a set of PCB_LAYER_IDs. More...
 

Macros

#define MAX_CU_LAYERS   (B_Cu - F_Cu + 1)
 
#define NETNAMES_LAYER_INDEX(layer)   ( NETNAMES_LAYER_ID_START + layer )
 Macro for obtaining netname layer for a given PCB layer. More...
 
#define GAL_LAYER_INDEX(x)   ( x - GAL_LAYER_ID_START )
 Use this macro to convert a GAL layer to a 0-indexed offset from LAYER_VIAS. More...
 
#define SCH_LAYER_ID_COUNT   ( SCH_LAYER_ID_END - SCH_LAYER_ID_START )
 
#define SCH_LAYER_INDEX(x)   ( x - SCH_LAYER_ID_START )
 
#define GERBER_DRAWLAYERS_COUNT   32
 
#define GERBER_DRAW_LAYER(x)   ( GERBVIEW_LAYER_ID_START + x )
 
#define GERBER_DCODE_LAYER(x)   ( GERBER_DRAWLAYERS_COUNT + x )
 
#define GERBER_DRAW_LAYER_INDEX(x)   ( x - GERBVIEW_LAYER_ID_START )
 
#define LAYER_ID_COUNT   GERBVIEW_LAYER_ID_END
 Must update this if you add any enums after GerbView! More...
 
#define MIN_VISIBILITY_MASK
 

Typedefs

typedef int LAYER_NUM
 Type LAYER_NUM can be replaced with int and removed. More...
 
typedef std::vector< PCB_LAYER_IDBASE_SEQ
 A sequence of layers, a sequence provides a certain order. More...
 
typedef std::bitset< PCB_LAYER_ID_COUNTBASE_SET
 

Enumerations

enum  PCB_LAYER_ID : int {
  UNDEFINED_LAYER = -1, UNSELECTED_LAYER = -2, PCBNEW_LAYER_ID_START = 0, F_Cu = PCBNEW_LAYER_ID_START,
  In1_Cu, In2_Cu, In3_Cu, In4_Cu,
  In5_Cu, In6_Cu, In7_Cu, In8_Cu,
  In9_Cu, In10_Cu, In11_Cu, In12_Cu,
  In13_Cu, In14_Cu, In15_Cu, In16_Cu,
  In17_Cu, In18_Cu, In19_Cu, In20_Cu,
  In21_Cu, In22_Cu, In23_Cu, In24_Cu,
  In25_Cu, In26_Cu, In27_Cu, In28_Cu,
  In29_Cu, In30_Cu, B_Cu, B_Adhes,
  F_Adhes, B_Paste, F_Paste, B_SilkS,
  F_SilkS, B_Mask, F_Mask, Dwgs_User,
  Cmts_User, Eco1_User, Eco2_User, Edge_Cuts,
  Margin, B_CrtYd, F_CrtYd, B_Fab,
  F_Fab, Rescue, PCB_LAYER_ID_COUNT
}
 A quick note on layer IDs: More...
 
enum  NETNAMES_LAYER_ID : int {
  NETNAMES_LAYER_ID_START = PCB_LAYER_ID_COUNT, NETNAMES_LAYER_ID_RESERVED = NETNAMES_LAYER_ID_START + PCB_LAYER_ID_COUNT, LAYER_PAD_FR_NETNAMES, LAYER_PAD_BK_NETNAMES,
  LAYER_PADS_NETNAMES, LAYER_VIAS_NETNAMES, NETNAMES_LAYER_ID_END
}
 Dedicated layers for net names used in Pcbnew. More...
 
enum  GAL_LAYER_ID : int {
  GAL_LAYER_ID_START = NETNAMES_LAYER_ID_END, LAYER_VIAS = GAL_LAYER_ID_START, LAYER_VIA_MICROVIA, LAYER_VIA_BBLIND,
  LAYER_VIA_THROUGH, LAYER_NON_PLATEDHOLES, LAYER_MOD_TEXT_FR, LAYER_MOD_TEXT_BK,
  LAYER_MOD_TEXT_INVISIBLE, LAYER_ANCHOR, LAYER_PAD_FR, LAYER_PAD_BK,
  LAYER_RATSNEST, LAYER_GRID, LAYER_GRID_AXES, LAYER_NO_CONNECTS,
  LAYER_MOD_FR, LAYER_MOD_BK, LAYER_MOD_VALUES, LAYER_MOD_REFERENCES,
  LAYER_TRACKS, LAYER_PADS_TH, LAYER_PADS_PLATEDHOLES, LAYER_VIAS_HOLES,
  LAYER_DRC, LAYER_WORKSHEET, LAYER_GP_OVERLAY, LAYER_SELECT_OVERLAY,
  LAYER_PCB_BACKGROUND, LAYER_CURSOR, LAYER_AUX_ITEMS, LAYER_DRAW_BITMAPS,
  GAL_LAYER_ID_BITMASK_END, GAL_LAYER_ID_END
}
 GAL layers are "virtual" layers, i.e. More...
 
enum  SCH_LAYER_ID : int {
  SCH_LAYER_ID_START = GAL_LAYER_ID_END, LAYER_WIRE = SCH_LAYER_ID_START, LAYER_BUS, LAYER_JUNCTION,
  LAYER_LOCLABEL, LAYER_GLOBLABEL, LAYER_HIERLABEL, LAYER_PINNUM,
  LAYER_PINNAM, LAYER_REFERENCEPART, LAYER_VALUEPART, LAYER_FIELDS,
  LAYER_DEVICE, LAYER_NOTES, LAYER_NETNAM, LAYER_PIN,
  LAYER_SHEET, LAYER_SHEETNAME, LAYER_SHEETFILENAME, LAYER_SHEETLABEL,
  LAYER_NOCONNECT, LAYER_ERC_WARN, LAYER_ERC_ERR, LAYER_DEVICE_BACKGROUND,
  LAYER_SHEET_BACKGROUND, LAYER_SCHEMATIC_GRID, LAYER_SCHEMATIC_BACKGROUND, LAYER_SCHEMATIC_CURSOR,
  LAYER_BRIGHTENED, LAYER_HIDDEN, SCH_LAYER_ID_END
}
 Eeschema drawing layers. More...
 
enum  GERBVIEW_LAYER_ID : int {
  GERBVIEW_LAYER_ID_START = SCH_LAYER_ID_END, GERBVIEW_LAYER_ID_RESERVED = GERBVIEW_LAYER_ID_START + ( 2 * GERBER_DRAWLAYERS_COUNT ), LAYER_DCODES, LAYER_NEGATIVE_OBJECTS,
  LAYER_GERBVIEW_GRID, LAYER_GERBVIEW_AXES, LAYER_GERBVIEW_BACKGROUND, GERBVIEW_LAYER_ID_END
}
 GerbView draw layers. More...
 

Functions

GAL_LAYER_ID operator++ (GAL_LAYER_ID &a)
 
GAL_LAYER_ID operator+ (const GAL_LAYER_ID &a, int b)
 Used for via types. More...
 
SCH_LAYER_ID operator++ (SCH_LAYER_ID &a)
 
bool IsValidLayer (LAYER_NUM aLayerId)
 Function IsValidLayer tests whether a given integer is a valid layer index, i.e. More...
 
bool IsPcbLayer (LAYER_NUM aLayer)
 Function IsPcbLayer tests whether a layer is a valid layer for pcbnew. More...
 
bool IsCopperLayer (LAYER_NUM aLayerId)
 Function IsCopperLayer tests whether a layer is a copper layer. More...
 
bool IsNonCopperLayer (LAYER_NUM aLayerId)
 Function IsNonCopperLayer tests whether a layer is a non copper layer. More...
 
bool IsUserLayer (PCB_LAYER_ID aLayerId)
 Function IsUserLayer tests whether a layer is a non copper and a non tech layer. More...
 
bool IsFrontLayer (PCB_LAYER_ID aLayerId)
 Layer classification: check if it's a front layer. More...
 
bool IsBackLayer (PCB_LAYER_ID aLayerId)
 Layer classification: check if it's a back layer. More...
 
PCB_LAYER_ID FlipLayer (PCB_LAYER_ID aLayerId, int aCopperLayersCount=0)
 Function FlippedLayerNumber. More...
 
LSET FlipLayerMask (LSET aMask, int aCopperLayersCount=0)
 Calculate the mask layer when flipping a footprint BACK and FRONT copper layers, mask, paste, solder layers are swapped internal layers are flipped only if the copper layers count is known. More...
 
int GetNetnameLayer (int aLayer)
 Returns a netname layer corresponding to the given layer. More...
 
bool IsNetnameLayer (LAYER_NUM aLayer)
 Function IsNetnameLayer tests whether a layer is a netname layer. More...
 
bool IsDCodeLayer (int aLayer)
 
PCB_LAYER_ID ToLAYER_ID (int aLayer)
 

Detailed Description

Board layer functions and definitions.

Definition in file layers_id_colors_and_visibility.h.

Macro Definition Documentation

#define GAL_LAYER_INDEX (   x)    ( x - GAL_LAYER_ID_START )
#define GERBER_DRAW_LAYER_INDEX (   x)    ( x - GERBVIEW_LAYER_ID_START )

Definition at line 303 of file layers_id_colors_and_visibility.h.

#define LAYER_ID_COUNT   GERBVIEW_LAYER_ID_END

Must update this if you add any enums after GerbView!

Definition at line 306 of file layers_id_colors_and_visibility.h.

Referenced by BOARD_PRINTOUT::DrawPage(), and KIGFX::RENDER_SETTINGS::update().

#define MIN_VISIBILITY_MASK
Value:
( 1 << GAL_LAYER_INDEX( LAYER_DRC ) ) +\
to draw via holes (pad holes do not use this layer)
#define GAL_LAYER_INDEX(x)
Use this macro to convert a GAL layer to a 0-indexed offset from LAYER_VIAS.
general purpose overlay
currently selected items overlay

Definition at line 313 of file layers_id_colors_and_visibility.h.

Referenced by PCB_PARSER::parseSetup().

#define NETNAMES_LAYER_INDEX (   layer)    ( NETNAMES_LAYER_ID_START + layer )

Macro for obtaining netname layer for a given PCB layer.

Definition at line 165 of file layers_id_colors_and_visibility.h.

Referenced by GetNetnameLayer(), IsNetnameLayer(), and PCB_DRAW_PANEL_GAL::SetTopLayer().

#define SCH_LAYER_ID_COUNT   ( SCH_LAYER_ID_END - SCH_LAYER_ID_START )

Definition at line 269 of file layers_id_colors_and_visibility.h.

Referenced by SCH_LEGACY_PLUGIN::Format().

#define SCH_LAYER_INDEX (   x)    ( x - SCH_LAYER_ID_START )

Definition at line 271 of file layers_id_colors_and_visibility.h.

Typedef Documentation

typedef std::vector<PCB_LAYER_ID> BASE_SEQ

A sequence of layers, a sequence provides a certain order.

Definition at line 321 of file layers_id_colors_and_visibility.h.

typedef std::bitset<PCB_LAYER_ID_COUNT> BASE_SET

Definition at line 371 of file layers_id_colors_and_visibility.h.

typedef int LAYER_NUM

Type LAYER_NUM can be replaced with int and removed.

Until then, it is something you can increment, and its meaning is only advisory but can extend beyond PCB layers into view layers and gerber layers.

Definition at line 39 of file layers_id_colors_and_visibility.h.

Enumeration Type Documentation

enum GAL_LAYER_ID : int

GAL layers are "virtual" layers, i.e.

not tied into design data. Some layers here are shared between applications.

Enumerator
GAL_LAYER_ID_START 
LAYER_VIAS 
LAYER_VIA_MICROVIA 

to draw micro vias

LAYER_VIA_BBLIND 

to draw blind/buried vias

LAYER_VIA_THROUGH 

to draw usual through hole vias

LAYER_NON_PLATEDHOLES 

handle color for not plated holes (holes, not pads)

LAYER_MOD_TEXT_FR 
LAYER_MOD_TEXT_BK 
LAYER_MOD_TEXT_INVISIBLE 

text marked as invisible

LAYER_ANCHOR 

anchor of items having an anchor point (texts, footprints)

LAYER_PAD_FR 

smd pads, front layer

LAYER_PAD_BK 

smd pads, back layer

LAYER_RATSNEST 
LAYER_GRID 
LAYER_GRID_AXES 
LAYER_NO_CONNECTS 

show a marker on pads with no nets

LAYER_MOD_FR 

show modules on front

LAYER_MOD_BK 

show modules on back

LAYER_MOD_VALUES 

show modules values (when texts are visibles)

LAYER_MOD_REFERENCES 

show modules references (when texts are visibles)

LAYER_TRACKS 
LAYER_PADS_TH 

multilayer pads, usually with holes

LAYER_PADS_PLATEDHOLES 

to draw pad holes (plated)

LAYER_VIAS_HOLES 

to draw via holes (pad holes do not use this layer)

LAYER_DRC 

drc markers

LAYER_WORKSHEET 

worksheet frame

LAYER_GP_OVERLAY 

general purpose overlay

LAYER_SELECT_OVERLAY 

currently selected items overlay

LAYER_PCB_BACKGROUND 

PCB background color.

LAYER_CURSOR 

PCB cursor.

LAYER_AUX_ITEMS 

Auxiliary items (guides, rule, etc)

LAYER_DRAW_BITMAPS 

to handle and draw images bitmaps

GAL_LAYER_ID_BITMASK_END 

This is the end of the layers used for visibility bitmasks in Pcbnew There can be at most 32 layers above here.

GAL_LAYER_ID_END 

Add new GAL layers here.

Definition at line 169 of file layers_id_colors_and_visibility.h.

169  : int
170 {
172 
181  LAYER_ANCHOR,
182  LAYER_PAD_FR,
183  LAYER_PAD_BK,
185  LAYER_GRID,
188  LAYER_MOD_FR,
189  LAYER_MOD_BK,
192  LAYER_TRACKS,
193  LAYER_PADS_TH,
196  LAYER_DRC,
201  LAYER_CURSOR,
204 
208 
210 
212 };
to draw blind/buried vias
show a marker on pads with no nets
multilayer pads, usually with holes
to handle and draw images bitmaps
handle color for not plated holes (holes, not pads)
anchor of items having an anchor point (texts, footprints)
show modules on back
to draw via holes (pad holes do not use this layer)
show modules values (when texts are visibles)
This is the end of the layers used for visibility bitmasks in Pcbnew There can be at most 32 layers a...
Add new GAL layers here.
smd pads, back layer
show modules on front
Auxiliary items (guides, rule, etc)
to draw usual through hole vias
general purpose overlay
smd pads, front layer
currently selected items overlay
show modules references (when texts are visibles)
enum GERBVIEW_LAYER_ID : int

GerbView draw layers.

Enumerator
GERBVIEW_LAYER_ID_START 
GERBVIEW_LAYER_ID_RESERVED 

GerbView draw layers and d-code layers.

LAYER_DCODES 
LAYER_NEGATIVE_OBJECTS 
LAYER_GERBVIEW_GRID 
LAYER_GERBVIEW_AXES 
LAYER_GERBVIEW_BACKGROUND 
GERBVIEW_LAYER_ID_END 

Definition at line 283 of file layers_id_colors_and_visibility.h.

enum NETNAMES_LAYER_ID : int

Dedicated layers for net names used in Pcbnew.

Enumerator
NETNAMES_LAYER_ID_START 
NETNAMES_LAYER_ID_RESERVED 

Reserved space for board layer netnames.

LAYER_PAD_FR_NETNAMES 

Additional netnames layers (not associated with a PCB layer)

LAYER_PAD_BK_NETNAMES 
LAYER_PADS_NETNAMES 
LAYER_VIAS_NETNAMES 
NETNAMES_LAYER_ID_END 

Definition at line 145 of file layers_id_colors_and_visibility.h.

enum PCB_LAYER_ID : int

A quick note on layer IDs:

The layers are stored in separate enums so that certain functions can take in the enums as datatypes and don't have to know about layers from other applications.

Layers that are shared between applications should be in the GAL_LAYER_ID enum.

The PCB_LAYER_ID struct must start at zero for compatibility with legacy board files.

Some functions accept any layer ID, so they start at zero (i.e. F_Cu) and go up to the LAYER_ID_COUNT, which needs to be kept up-to-date if new enums are added. Enum PCB_LAYER_ID This is the definition of all layers used in Pcbnew The PCB layer types are fixed at value 0 through LAYER_ID_COUNT, to ensure compatibility with legacy board files.

Enumerator
UNDEFINED_LAYER 
UNSELECTED_LAYER 
PCBNEW_LAYER_ID_START 
F_Cu 
In1_Cu 
In2_Cu 
In3_Cu 
In4_Cu 
In5_Cu 
In6_Cu 
In7_Cu 
In8_Cu 
In9_Cu 
In10_Cu 
In11_Cu 
In12_Cu 
In13_Cu 
In14_Cu 
In15_Cu 
In16_Cu 
In17_Cu 
In18_Cu 
In19_Cu 
In20_Cu 
In21_Cu 
In22_Cu 
In23_Cu 
In24_Cu 
In25_Cu 
In26_Cu 
In27_Cu 
In28_Cu 
In29_Cu 
In30_Cu 
B_Cu 
B_Adhes 
F_Adhes 
B_Paste 
F_Paste 
B_SilkS 
F_SilkS 
B_Mask 
F_Mask 
Dwgs_User 
Cmts_User 
Eco1_User 
Eco2_User 
Edge_Cuts 
Margin 
B_CrtYd 
F_CrtYd 
B_Fab 
F_Fab 
Rescue 
PCB_LAYER_ID_COUNT 

Definition at line 73 of file layers_id_colors_and_visibility.h.

73  : int
74 {
75  UNDEFINED_LAYER = -1,
76  UNSELECTED_LAYER = -2,
77 
80  In1_Cu,
81  In2_Cu,
82  In3_Cu,
83  In4_Cu,
84  In5_Cu,
85  In6_Cu,
86  In7_Cu,
87  In8_Cu,
88  In9_Cu,
89  In10_Cu,
90  In11_Cu,
91  In12_Cu,
92  In13_Cu,
93  In14_Cu,
94  In15_Cu,
95  In16_Cu,
96  In17_Cu,
97  In18_Cu,
98  In19_Cu,
99  In20_Cu,
100  In21_Cu,
101  In22_Cu,
102  In23_Cu,
103  In24_Cu,
104  In25_Cu,
105  In26_Cu,
106  In27_Cu,
107  In28_Cu,
108  In29_Cu,
109  In30_Cu,
110  B_Cu, // 31
111 
112  B_Adhes,
113  F_Adhes,
114 
115  B_Paste,
116  F_Paste,
117 
118  B_SilkS,
119  F_SilkS,
120 
121  B_Mask,
122  F_Mask,
123 
124  Dwgs_User,
125  Cmts_User,
126  Eco1_User,
127  Eco2_User,
128  Edge_Cuts,
129  Margin,
130 
131  B_CrtYd,
132  F_CrtYd,
133 
134  B_Fab,
135  F_Fab,
136 
137  Rescue,
138 
140 };
enum SCH_LAYER_ID : int

Eeschema drawing layers.

Enumerator
SCH_LAYER_ID_START 
LAYER_WIRE 
LAYER_BUS 
LAYER_JUNCTION 
LAYER_LOCLABEL 
LAYER_GLOBLABEL 
LAYER_HIERLABEL 
LAYER_PINNUM 
LAYER_PINNAM 
LAYER_REFERENCEPART 
LAYER_VALUEPART 
LAYER_FIELDS 
LAYER_DEVICE 
LAYER_NOTES 
LAYER_NETNAM 
LAYER_PIN 
LAYER_SHEET 
LAYER_SHEETNAME 
LAYER_SHEETFILENAME 
LAYER_SHEETLABEL 
LAYER_NOCONNECT 
LAYER_ERC_WARN 
LAYER_ERC_ERR 
LAYER_DEVICE_BACKGROUND 
LAYER_SHEET_BACKGROUND 
LAYER_SCHEMATIC_GRID 
LAYER_SCHEMATIC_BACKGROUND 
LAYER_SCHEMATIC_CURSOR 
LAYER_BRIGHTENED 
LAYER_HIDDEN 
SCH_LAYER_ID_END 

Definition at line 232 of file layers_id_colors_and_visibility.h.

232  : int
233 {
235 
237  LAYER_BUS,
242  LAYER_PINNUM,
243  LAYER_PINNAM,
246  LAYER_FIELDS,
247  LAYER_DEVICE,
248  LAYER_NOTES,
249  LAYER_NETNAM,
250  LAYER_PIN,
251  LAYER_SHEET,
264  LAYER_HIDDEN,
265 
267 };
Add new GAL layers here.

Function Documentation

PCB_LAYER_ID FlipLayer ( PCB_LAYER_ID  aLayerId,
int  aCopperLayersCount = 0 
)

Function FlippedLayerNumber.

Returns
the layer number after flipping an item some (not all) layers: external copper, and paired layers( Mask, Paste, solder ... ) are swapped between front and back sides internal layers are flipped only if the copper layers count is known
Parameters
aLayerId= the PCB_LAYER_ID to flip
aCopperLayersCount= the number of copper layers. if 0 (in fact if < 4 ) internal layers will be not flipped because the layer count is not known

Definition at line 475 of file lset.cpp.

References B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, In1_Cu, and IsCopperLayer().

Referenced by PCAD2KICAD::PCB_MODULE::AddToBoard(), PCAD2KICAD::PCB_PAD::Flip(), PCAD2KICAD::PCB_LINE::Flip(), PCAD2KICAD::PCB_ARC::Flip(), PCAD2KICAD::PCB_POLYGON::Flip(), TEXTE_PCB::Flip(), PCB_TARGET::Flip(), EDGE_MODULE::Flip(), TEXTE_MODULE::Flip(), TRACK::Flip(), DIMENSION::Flip(), MODULE::Flip(), DRAWSEGMENT::Flip(), ZONE_CONTAINER::Flip(), VIA::Flip(), and IsBackLayer().

476 {
477  switch( aLayerId )
478  {
479  case B_Cu: return F_Cu;
480  case F_Cu: return B_Cu;
481 
482  case B_SilkS: return F_SilkS;
483  case F_SilkS: return B_SilkS;
484 
485  case B_Adhes: return F_Adhes;
486  case F_Adhes: return B_Adhes;
487 
488  case B_Mask: return F_Mask;
489  case F_Mask: return B_Mask;
490 
491  case B_Paste: return F_Paste;
492  case F_Paste: return B_Paste;
493 
494  case B_CrtYd: return F_CrtYd;
495  case F_CrtYd: return B_CrtYd;
496 
497  case B_Fab: return F_Fab;
498  case F_Fab: return B_Fab;
499 
500  default: // change internal layer if aCopperLayersCount is >= 4
501  if( IsCopperLayer( aLayerId ) && aCopperLayersCount >= 4 )
502  {
503  // internal copper layers count is aCopperLayersCount-2
504  PCB_LAYER_ID fliplayer = PCB_LAYER_ID(aCopperLayersCount - 2 - ( aLayerId - In1_Cu ) );
505  // Ensure fliplayer has a value which does not crash pcbnew:
506  if( fliplayer < F_Cu )
507  fliplayer = F_Cu;
508 
509  if( fliplayer > B_Cu )
510  fliplayer = B_Cu;
511 
512  return fliplayer;
513  }
514 
515  // No change for the other layers
516  return aLayerId;
517  }
518 }
PCB_LAYER_ID
A quick note on layer IDs:
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
LSET FlipLayerMask ( LSET  aMask,
int  aCopperLayersCount = 0 
)

Calculate the mask layer when flipping a footprint BACK and FRONT copper layers, mask, paste, solder layers are swapped internal layers are flipped only if the copper layers count is known.

Parameters
aMask= the LSET to flip
aCopperLayersCount= the number of copper layers. if 0 (in fact if < 4 ) internal layers will be not flipped because the layer count is not known

Definition at line 521 of file lset.cpp.

References B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, In1_Cu, and LSET::InternalCuMask().

Referenced by D_PAD::Flip(), ZONE_CONTAINER::Flip(), DIALOG_PAD_PROPERTIES::initValues(), IsBackLayer(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

522 {
523  // layers on physical outside of a board:
524  const static LSET and_mask( 16, // !! update count
525  B_Cu, F_Cu,
526  B_SilkS, F_SilkS,
527  B_Adhes, F_Adhes,
528  B_Mask, F_Mask,
529  B_Paste, F_Paste,
530  B_Adhes, F_Adhes,
531  B_CrtYd, F_CrtYd,
532  B_Fab, F_Fab
533  );
534 
535  LSET newMask = aMask & ~and_mask;
536 
537  if( aMask[B_Cu] )
538  newMask.set( F_Cu );
539 
540  if( aMask[F_Cu] )
541  newMask.set( B_Cu );
542 
543  if( aMask[B_SilkS] )
544  newMask.set( F_SilkS );
545 
546  if( aMask[F_SilkS] )
547  newMask.set( B_SilkS );
548 
549  if( aMask[B_Adhes] )
550  newMask.set( F_Adhes );
551 
552  if( aMask[F_Adhes] )
553  newMask.set( B_Adhes );
554 
555  if( aMask[B_Mask] )
556  newMask.set( F_Mask );
557 
558  if( aMask[F_Mask] )
559  newMask.set( B_Mask );
560 
561  if( aMask[B_Paste] )
562  newMask.set( F_Paste );
563 
564  if( aMask[F_Paste] )
565  newMask.set( B_Paste );
566 
567  if( aMask[B_Adhes] )
568  newMask.set( F_Adhes );
569 
570  if( aMask[F_Adhes] )
571  newMask.set( B_Adhes );
572 
573  if( aMask[B_CrtYd] )
574  newMask.set( F_CrtYd );
575 
576  if( aMask[F_CrtYd] )
577  newMask.set( B_CrtYd );
578 
579  if( aMask[B_Fab] )
580  newMask.set( F_Fab );
581 
582  if( aMask[F_Fab] )
583  newMask.set( B_Fab );
584 
585  if( aCopperLayersCount >= 4 ) // Internal layers exist
586  {
587  LSET internalMask = aMask & LSET::InternalCuMask();
588 
589  if( internalMask != LSET::InternalCuMask() )
590  {
591  // the mask does not include all internal layers. Therefore
592  // the flipped mask for internal copper layers must be built
593  int innerLayerCnt = aCopperLayersCount -2;
594 
595  // the flipped mask is the innerLayerCnt bits rewritten in reverse order
596  // ( bits innerLayerCnt to 1 rewritten in bits 1 to innerLayerCnt )
597  for( int ii = 0; ii < innerLayerCnt; ii++ )
598  {
599  if( internalMask[innerLayerCnt - ii] )
600  {
601  newMask.set( ii + In1_Cu );
602  }
603  else
604  {
605  newMask.reset( ii + In1_Cu );
606  }
607  }
608  }
609  }
610 
611  return newMask;
612 }
Class LSET is a set of PCB_LAYER_IDs.
static LSET InternalCuMask()
Function InternalCuMask() returns a complete set of internal copper layers, which is all Cu layers ex...
Definition: lset.cpp:636
int GetNetnameLayer ( int  aLayer)
inline

Returns a netname layer corresponding to the given layer.

Definition at line 776 of file layers_id_colors_and_visibility.h.

References Cmts_User, IsCopperLayer(), LAYER_PAD_BK, LAYER_PAD_BK_NETNAMES, LAYER_PAD_FR, LAYER_PAD_FR_NETNAMES, LAYER_PADS_NETNAMES, LAYER_PADS_TH, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, LAYER_VIAS_NETNAMES, and NETNAMES_LAYER_INDEX.

Referenced by KIGFX::PCB_RENDER_SETTINGS::ImportLegacyColors(), PCB_LAYER_WIDGET::OnLayerColorChange(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), and TRACK::ViewGetLayers().

777 {
778  if( IsCopperLayer( aLayer ) )
779  return NETNAMES_LAYER_INDEX( aLayer );
780  else if( aLayer == LAYER_PADS_TH )
781  return LAYER_PADS_NETNAMES;
782  else if( aLayer == LAYER_PAD_FR )
783  return LAYER_PAD_FR_NETNAMES;
784  else if( aLayer == LAYER_PAD_BK )
785  return LAYER_PAD_BK_NETNAMES;
786  else if( aLayer >= LAYER_VIA_MICROVIA && aLayer <= LAYER_VIA_THROUGH )
787  return LAYER_VIAS_NETNAMES;
788 
789  // Fallback
790  return Cmts_User;
791 }
multilayer pads, usually with holes
smd pads, back layer
to draw usual through hole vias
smd pads, front layer
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
#define NETNAMES_LAYER_INDEX(layer)
Macro for obtaining netname layer for a given PCB layer.
Additional netnames layers (not associated with a PCB layer)
bool IsCopperLayer ( LAYER_NUM  aLayerId)
inline

Function IsCopperLayer tests whether a layer is a copper layer.

Parameters
aLayerId= Layer to test
Returns
true if aLayer is a valid copper layer

Definition at line 667 of file layers_id_colors_and_visibility.h.

References B_Cu, and F_Cu.

Referenced by CN_CONNECTIVITY_ALGO::Add(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCB_EDIT_FRAME::Begin_Zone(), BOARD::BOARD(), PCB_ONE_LAYER_SELECTOR::buildList(), SELECT_COPPER_LAYERS_PAIR_DIALOG::buildList(), ZONE_CREATE_HELPER::createNewZone(), PCB_EDIT_FRAME::Delete_Drawings_All_Layer(), EDGE_MODULE::Draw(), KIGFX::PCB_PAINTER::draw(), D_PAD::Draw(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Layer(), PCB_EDIT_FRAME::Edit_Zone_Params(), FlipLayer(), DSN::SPECCTRA_DB::FromBOARD(), GenCADLayerName(), DRAWING_TOOL::getDrawingLayer(), GetGerberFileFunctionAttribute(), GetGerberFilePolarityAttribute(), GetGerberProtelExtension(), BOARD_DESIGN_SETTINGS::GetLayerClass(), BOARD::GetLayerID(), BOARD::GetLayerName(), BOARD::GetLayerType(), GetNetnameLayer(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), DIALOG_EXPORT_SVG::initDialog(), ZONE_CONTAINER::IsOnCopperLayer(), MARKER_PCB::IsOnLayer(), PCBNEW_CONTROL::LayerNext(), PCBNEW_CONTROL::LayerPrev(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadPolygon(), EAGLE_PLUGIN::loadSignals(), PCB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyBeginRoute(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnLeftClick(), DIALOG_PLOT::OnPopUpLayers(), PCB_LAYER_WIDGET::onPopupSelection(), PCB_EDIT_FRAME::OnRightClick(), EAGLE_PLUGIN::packageSMD(), PNS::TOOL_BASE::pickSingleItem(), PlotOneBoardLayer(), BRDITEMS_PLOTTER::PlotTextePcb(), ROUTER_TOOL::prepareInteractive(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), BOARD::SetLayerName(), BOARD::SetLayerType(), PCB_DRAW_PANEL_GAL::SetTopLayer(), ShowClearance(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), PNS_KICAD_IFACE::syncGraphicalItem(), PNS_KICAD_IFACE::syncTextItem(), DRC::testCopperTextAndGraphics(), and DIALOG_PRINT_PCBNEW::TransferDataToWindow().

668 {
669  return aLayerId >= F_Cu && aLayerId <= B_Cu;
670 }
bool IsFrontLayer ( PCB_LAYER_ID  aLayerId)
inline

Layer classification: check if it's a front layer.

Definition at line 707 of file layers_id_colors_and_visibility.h.

References F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, and F_SilkS.

Referenced by TEXTE_MODULE::Draw(), GENERAL_COLLECTOR::Inspect(), PCB_DRAW_PANEL_GAL::SetTopLayer(), TEXTE_MODULE::ViewGetLOD(), and D_PAD::ViewGetLOD().

708 {
709  switch( aLayerId )
710  {
711  case F_Cu:
712  case F_Adhes:
713  case F_Paste:
714  case F_SilkS:
715  case F_Mask:
716  case F_CrtYd:
717  case F_Fab:
718  return true;
719  default:
720  ;
721  }
722 
723  return false;
724 }
bool IsNetnameLayer ( LAYER_NUM  aLayer)
inline

Function IsNetnameLayer tests whether a layer is a netname layer.

Parameters
aLayer= Layer to test
Returns
true if aLayer is a valid netname layer

Definition at line 799 of file layers_id_colors_and_visibility.h.

References F_Cu, NETNAMES_LAYER_ID_END, and NETNAMES_LAYER_INDEX.

Referenced by KIGFX::PCB_PAINTER::draw(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), TRACK::ViewGetLOD(), VIA::ViewGetLOD(), and D_PAD::ViewGetLOD().

800 {
801  return aLayer >= NETNAMES_LAYER_INDEX( F_Cu ) &&
802  aLayer < NETNAMES_LAYER_ID_END;
803 }
#define NETNAMES_LAYER_INDEX(layer)
Macro for obtaining netname layer for a given PCB layer.
bool IsNonCopperLayer ( LAYER_NUM  aLayerId)
inline

Function IsNonCopperLayer tests whether a layer is a non copper layer.

Parameters
aLayerId= Layer to test
Returns
true if aLayer is a non copper layer

Definition at line 678 of file layers_id_colors_and_visibility.h.

References B_Cu, and PCB_LAYER_ID_COUNT.

Referenced by PCAD2KICAD::PCB_LINE::AddToModule(), PCAD2KICAD::PCB_ARC::AddToModule(), and PCAD2KICAD::PCB_POLYGON::AddToModule().

679 {
680  return aLayerId > B_Cu && aLayerId <= PCB_LAYER_ID_COUNT;
681 }
bool IsPcbLayer ( LAYER_NUM  aLayer)
inline

Function IsPcbLayer tests whether a layer is a valid layer for pcbnew.

Parameters
aLayer= Layer to test
Returns
true if aLayer is a layer valid in pcbnew

Definition at line 656 of file layers_id_colors_and_visibility.h.

References F_Cu, and PCB_LAYER_ID_COUNT.

Referenced by GBR_TO_PCB_EXPORTER::ExportPcb().

657 {
658  return aLayer >= F_Cu && aLayer < PCB_LAYER_ID_COUNT;
659 }
bool IsUserLayer ( PCB_LAYER_ID  aLayerId)
inline

Function IsUserLayer tests whether a layer is a non copper and a non tech layer.

Parameters
aLayerId= Layer to test
Returns
true if aLayer is a user layer

Definition at line 689 of file layers_id_colors_and_visibility.h.

References Dwgs_User, and Eco2_User.

690 {
691  return aLayerId >= Dwgs_User && aLayerId <= Eco2_User;
692 }
bool IsValidLayer ( LAYER_NUM  aLayerId)
inline

Function IsValidLayer tests whether a given integer is a valid layer index, i.e.

can be safely put in a PCB_LAYER_ID

Parameters
aLayerId= Layer index to test. It can be an int, so its useful during I/O
Returns
true if aLayerIndex is a valid layer index

Definition at line 645 of file layers_id_colors_and_visibility.h.

References PCB_LAYER_ID_COUNT.

Referenced by LAYERS_MAP_DIALOG::OnSelectLayer().

646 {
647  return unsigned( aLayerId ) < PCB_LAYER_ID_COUNT;
648 }
GAL_LAYER_ID operator+ ( const GAL_LAYER_ID a,
int  b 
)
inline

Used for via types.

Definition at line 224 of file layers_id_colors_and_visibility.h.

References GAL_LAYER_ID_END.

Referenced by VECTOR2< unsigned int >::operator wxPoint().

225 {
226  GAL_LAYER_ID t = GAL_LAYER_ID( int( a ) + b );
227  wxASSERT( t <= GAL_LAYER_ID_END );
228  return t;
229 }
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Add new GAL layers here.
GAL_LAYER_ID operator++ ( GAL_LAYER_ID a)
inline

Definition at line 217 of file layers_id_colors_and_visibility.h.

218 {
219  a = GAL_LAYER_ID( int( a ) + 1 );
220  return a;
221 }
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
SCH_LAYER_ID operator++ ( SCH_LAYER_ID a)
inline

Definition at line 273 of file layers_id_colors_and_visibility.h.

274 {
275  a = SCH_LAYER_ID( int( a ) + 1 );
276  return a;
277 }
SCH_LAYER_ID
Eeschema drawing layers.
PCB_LAYER_ID ToLAYER_ID ( int  aLayer)

Definition at line 813 of file lset.cpp.

References GAL_LAYER_ID_END.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), PNS_KICAD_IFACE::AddItem(), GRID_CELL_LAYER_SELECTOR::BeginEdit(), BOARD::BOARD(), DSN::SPECCTRA_DB::buildLayerMaps(), CINFO3D_VISU::createLayers(), PCB_BASE_FRAME::CreateNewModule(), GRID_CELL_LAYER_RENDERER::Draw(), DRAWING_TOOL::DrawVia(), GENDRILL_WRITER_BASE::GenDrillReportFile(), GetGerberFileFunctionAttribute(), BOARD::GetLayerID(), PCB_LAYER_SELECTOR::GetLayerName(), PCB_LAYER_BOX_SELECTOR::GetLayerName(), GRID_CELL_LAYER_SELECTOR::GetValue(), IsDCodeLayer(), PCB_LAYER_BOX_SELECTOR::IsLayerEnabled(), PCBNEW_CONTROL::LayerNext(), PCBNEW_CONTROL::LayerPrev(), PCAD2KICAD::PCB::MapLayer(), PCB_EDIT_FRAME::OnHotKey(), PCB_LAYER_WIDGET::OnLayerSelect(), DIALOG_KEEPOUT_AREA_PROPERTIES::OnLayerSelection(), DIALOG_NON_COPPER_ZONES_EDITOR::OnLayerSelection(), DIALOG_COPPER_ZONE::OnLayerSelection(), PCB_LAYER_WIDGET::onPopupSelection(), PLOT_CONTROLLER::OpenPlotfile(), PCB_EDIT_FRAME::Other_Layer_Route(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), PLOT_CONTROLLER::PlotLayer(), ROUTER_TOOL::prepareInteractive(), PCB_EDIT_FRAME::Process_Special_Functions(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PCB_BASE_FRAME::SelectLayer(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), ROUTER_TOOL::switchLayerOnViaPlacement(), PCB_LAYER_WIDGET::SyncLayerAlphaIndicators(), PCB_LAYER_WIDGET::SyncLayerVisibilities(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

814 {
815  wxASSERT( aLayer < GAL_LAYER_ID_END );
816  return PCB_LAYER_ID( aLayer );
817 }
Add new GAL layers here.
PCB_LAYER_ID
A quick note on layer IDs: