layers_id_colors_and_visibility.h File Reference

Board layer functions and definitions. More...

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

Go to the source code of this file.

Classes
class	GAL_SET
	Helper for storing and iterating over GAL_LAYER_IDs. More...
class	LSEQ
	LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs. More...
class	LSET
	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	ZONE_LAYER_FOR(copperLayer)   ( LAYER_ZONE_START + copperLayer )
	Macro for getting the zone layer for a given copper layer. 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   PCB_LAYER_ID_COUNT
#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   LAYER_3D_END
	Must update this if you add any enums after GerbView! More...
#define	MIN_VISIBILITY_MASK

Typedefs
typedef int	LAYER_NUM
	This can be replaced with int and removed. More...
typedef std::bitset< GAL_LAYER_ID_COUNT >	GAL_BASE_SET
typedef std::vector< PCB_LAYER_ID >	BASE_SEQ
	A sequence of layers, a sequence provides a certain order. More...
typedef std::bitset< PCB_LAYER_ID_COUNT >	BASE_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, User_1, User_2, User_3,   User_4, User_5, User_6, User_7,   User_8, User_9, 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_ERROR, LAYER_DRC_WARNING, LAYER_DRC_EXCLUSION, LAYER_MARKER_SHADOWS,   LAYER_WORKSHEET, LAYER_GP_OVERLAY, LAYER_SELECT_OVERLAY, LAYER_PCB_BACKGROUND,   LAYER_CURSOR, LAYER_AUX_ITEMS, LAYER_DRAW_BITMAPS, GAL_LAYER_ID_BITMASK_END,   LAYER_WORKSHEET_PAGE1, LAYER_WORKSHEET_PAGEn, LAYER_PADS, LAYER_ZONES,   LAYER_ZONE_START, LAYER_ZONE_END = LAYER_ZONE_START + PCB_LAYER_ID_COUNT, 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_SHEETFIELDS,   LAYER_SHEETLABEL, LAYER_NOCONNECT, LAYER_ERC_WARN, LAYER_ERC_ERR,   LAYER_DEVICE_BACKGROUND, LAYER_SHEET_BACKGROUND, LAYER_SCHEMATIC_GRID, LAYER_SCHEMATIC_GRID_AXES,   LAYER_SCHEMATIC_BACKGROUND, LAYER_SCHEMATIC_CURSOR, LAYER_BRIGHTENED, LAYER_HIDDEN,   LAYER_SELECTION_SHADOWS, LAYER_SCHEMATIC_WORKSHEET, LAYER_BUS_JUNCTION, LAYER_SCHEMATIC_AUX_ITEMS,   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, LAYER_GERBVIEW_WORKSHEET,   GERBVIEW_LAYER_ID_END }
	GerbView draw layers. More...
enum	LAYER_3D_ID : int {   LAYER_3D_START = GERBVIEW_LAYER_ID_END, LAYER_3D_BACKGROUND_BOTTOM, LAYER_3D_BACKGROUND_TOP, LAYER_3D_BOARD,   LAYER_3D_COPPER, LAYER_3D_SILKSCREEN_BOTTOM, LAYER_3D_SILKSCREEN_TOP, LAYER_3D_SOLDERMASK,   LAYER_3D_SOLDERPASTE, LAYER_3D_END = LAYER_3D_SOLDERPASTE }
	3D Viewer virtual layers for color settings More...

Functions
GAL_LAYER_ID	operator++ (GAL_LAYER_ID &a)
GAL_LAYER_ID	ToGalLayer (int aInteger)
GAL_LAYER_ID	operator+ (const GAL_LAYER_ID &a, int b)
	Used for via types. More...
SCH_LAYER_ID	operator++ (SCH_LAYER_ID &a)
wxString	LayerName (int aLayer)
	Returns the string equivalent of a given layer. More...
bool	IsValidLayer (LAYER_NUM aLayerId)
	Test whether a given integer is a valid layer index, i.e. More...
bool	IsPcbLayer (LAYER_NUM aLayer)
	Test whether a layer is a valid layer for Pcbnew. More...
bool	IsCopperLayer (LAYER_NUM aLayerId)
	Tests whether a layer is a copper layer. More...
bool	IsNonCopperLayer (LAYER_NUM aLayerId)
	Test whether a layer is a non copper layer. More...
bool	IsUserLayer (PCB_LAYER_ID aLayerId)
	Test 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)
LSET	FlipLayerMask (LSET aMask, int aCopperLayersCount=0)
	Calculate the mask layer when flipping a footprint. More...
int	GetNetnameLayer (int aLayer)
	Returns a netname layer corresponding to the given layer. More...
bool	IsNetnameLayer (LAYER_NUM aLayer)
	Test whether a layer is a netname layer. More...
bool	IsZoneLayer (LAYER_NUM aLayer)
bool	IsDCodeLayer (int aLayer)
bool	IsNetCopperLayer (LAYER_NUM aLayer)
	Checks if the given layer is "net copper", meaning it is eligible for net coloring. More...
PCB_LAYER_ID	ToLAYER_ID (int aLayer)

Variables
constexpr int	GAL_LAYER_ID_COUNT = GAL_LAYER_ID_END - GAL_LAYER_ID_START

Detailed Description

Board layer functions and definitions.

Definition in file layers_id_colors_and_visibility.h.

Macro Definition Documentation

GAL_LAYER_INDEX

#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.

Definition at line 237 of file layers_id_colors_and_visibility.h.

GERBER_DCODE_LAYER

#define GERBER_DCODE_LAYER

(

x

)

( GERBER_DRAWLAYERS_COUNT + x )

Definition at line 388 of file layers_id_colors_and_visibility.h.

GERBER_DRAW_LAYER

#define GERBER_DRAW_LAYER

(

x

)

( GERBVIEW_LAYER_ID_START + x )

Definition at line 386 of file layers_id_colors_and_visibility.h.

GERBER_DRAW_LAYER_INDEX

#define GERBER_DRAW_LAYER_INDEX

(

x

)

( x - GERBVIEW_LAYER_ID_START )

Definition at line 390 of file layers_id_colors_and_visibility.h.

GERBER_DRAWLAYERS_COUNT

#define GERBER_DRAWLAYERS_COUNT   PCB_LAYER_ID_COUNT

Definition at line 366 of file layers_id_colors_and_visibility.h.

LAYER_ID_COUNT

#define LAYER_ID_COUNT   LAYER_3D_END

Must update this if you add any enums after GerbView!

Definition at line 411 of file layers_id_colors_and_visibility.h.

MAX_CU_LAYERS

#define MAX_CU_LAYERS   (B_Cu - F_Cu + 1)

Definition at line 151 of file layers_id_colors_and_visibility.h.

MIN_VISIBILITY_MASK

#define MIN_VISIBILITY_MASK

Value:

int( ( 1 << GAL_LAYER_INDEX( LAYER_PADS_PLATEDHOLES ) ) +\
                 ( 1 << GAL_LAYER_INDEX( LAYER_VIAS_HOLES ) ) +\
                 ( 1 << GAL_LAYER_INDEX( LAYER_SELECT_OVERLAY ) ) +\
                 ( 1 << GAL_LAYER_INDEX( LAYER_GP_OVERLAY ) ) +\
                 ( 1 << GAL_LAYER_INDEX( LAYER_RATSNEST ) ) )

Definition at line 425 of file layers_id_colors_and_visibility.h.

NETNAMES_LAYER_INDEX

#define NETNAMES_LAYER_INDEX

(

layer

)

( NETNAMES_LAYER_ID_START + layer )

Macro for obtaining netname layer for a given PCB layer.

Definition at line 174 of file layers_id_colors_and_visibility.h.

SCH_LAYER_ID_COUNT

#define SCH_LAYER_ID_COUNT   ( SCH_LAYER_ID_END - SCH_LAYER_ID_START )

Definition at line 355 of file layers_id_colors_and_visibility.h.

SCH_LAYER_INDEX

#define SCH_LAYER_INDEX

(

x

)

( x - SCH_LAYER_ID_START )

Definition at line 357 of file layers_id_colors_and_visibility.h.

ZONE_LAYER_FOR

#define ZONE_LAYER_FOR

(

copperLayer

)

( LAYER_ZONE_START + copperLayer )

Macro for getting the zone layer for a given copper layer.

Definition at line 240 of file layers_id_colors_and_visibility.h.

Typedef Documentation

BASE_SEQ

typedef std::vector<PCB_LAYER_ID> BASE_SEQ

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

Definition at line 433 of file layers_id_colors_and_visibility.h.

BASE_SET

typedef std::bitset<PCB_LAYER_ID_COUNT> BASE_SET

Definition at line 482 of file layers_id_colors_and_visibility.h.

GAL_BASE_SET

typedef std::bitset<GAL_LAYER_ID_COUNT> GAL_BASE_SET

Definition at line 264 of file layers_id_colors_and_visibility.h.

LAYER_NUM

typedef int LAYER_NUM

This 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 45 of file layers_id_colors_and_visibility.h.

Enumeration Type Documentation

GAL_LAYER_ID

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	Meta control for all vias opacity/visibility.
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 footprints on front
LAYER_MOD_BK	show footprints on back
LAYER_MOD_VALUES	show footprints values (when texts are visibles)
LAYER_MOD_REFERENCES	show footprints 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_ERROR	layer for drc markers with SEVERITY_ERROR
LAYER_DRC_WARNING	layer for drc markers with SEVERITY_WARNING
LAYER_DRC_EXCLUSION	layer for drc markers which have been individually excluded
LAYER_MARKER_SHADOWS	shadows for 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 bit masks in Pcbnew There can be at most 32 layers above here.
LAYER_WORKSHEET_PAGE1	for pageLayout editor previewing
LAYER_WORKSHEET_PAGEn	for pageLayout editor previewing
LAYER_PADS	Meta control for all pads opacity/visibility (color ignored)
LAYER_ZONES	Control for copper zone opacity/visibility (color ignored)
LAYER_ZONE_START	Virtual layers for stacking zones and tracks on a given copper layer.
LAYER_ZONE_END
GAL_LAYER_ID_END	Add new GAL layers here.

Definition at line 178 of file layers_id_colors_and_visibility.h.

                 : 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_ERROR,            
    LAYER_DRC_WARNING,          
    LAYER_DRC_EXCLUSION,        
    LAYER_MARKER_SHADOWS,       
    LAYER_WORKSHEET,            
    LAYER_GP_OVERLAY,           
    LAYER_SELECT_OVERLAY,       
    LAYER_PCB_BACKGROUND,       
    LAYER_CURSOR,               
    LAYER_AUX_ITEMS,            
    LAYER_DRAW_BITMAPS,         

    GAL_LAYER_ID_BITMASK_END,

    LAYER_WORKSHEET_PAGE1,      
    LAYER_WORKSHEET_PAGEn,      

    LAYER_PADS,                 
    LAYER_ZONES,                

    LAYER_ZONE_START,
    LAYER_ZONE_END = LAYER_ZONE_START + PCB_LAYER_ID_COUNT,


    GAL_LAYER_ID_END
};

GERBVIEW_LAYER_ID

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
LAYER_GERBVIEW_WORKSHEET
GERBVIEW_LAYER_ID_END

Definition at line 369 of file layers_id_colors_and_visibility.h.

                      : 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,
    LAYER_GERBVIEW_WORKSHEET,

    GERBVIEW_LAYER_ID_END
};

LAYER_3D_ID

enum LAYER_3D_ID : int

3D Viewer virtual layers for color settings

Enumerator
LAYER_3D_START
LAYER_3D_BACKGROUND_BOTTOM
LAYER_3D_BACKGROUND_TOP
LAYER_3D_BOARD
LAYER_3D_COPPER
LAYER_3D_SILKSCREEN_BOTTOM
LAYER_3D_SILKSCREEN_TOP
LAYER_3D_SOLDERMASK
LAYER_3D_SOLDERPASTE
LAYER_3D_END

Definition at line 394 of file layers_id_colors_and_visibility.h.

                 : int
{
        LAYER_3D_START = GERBVIEW_LAYER_ID_END,

        LAYER_3D_BACKGROUND_BOTTOM,
        LAYER_3D_BACKGROUND_TOP,
        LAYER_3D_BOARD,
        LAYER_3D_COPPER,
        LAYER_3D_SILKSCREEN_BOTTOM,
        LAYER_3D_SILKSCREEN_TOP,
        LAYER_3D_SOLDERMASK,
        LAYER_3D_SOLDERPASTE,

        LAYER_3D_END = LAYER_3D_SOLDERPASTE
};

NETNAMES_LAYER_ID

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 154 of file layers_id_colors_and_visibility.h.

                      : 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
};

PCB_LAYER_ID

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 data types 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.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
User_1
User_2
User_3
User_4
User_5
User_6
User_7
User_8
User_9
Rescue
PCB_LAYER_ID_COUNT

Definition at line 69 of file layers_id_colors_and_visibility.h.

                 : 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,           // 31

    B_Adhes,
    F_Adhes,

    B_Paste,
    F_Paste,

    B_SilkS,
    F_SilkS,

    B_Mask,
    F_Mask,         // 39

    Dwgs_User,
    Cmts_User,
    Eco1_User,
    Eco2_User,
    Edge_Cuts,
    Margin,         // 45

    B_CrtYd,
    F_CrtYd,

    B_Fab,
    F_Fab,          // 49

    // User definable layers.
    User_1,
    User_2,
    User_3,
    User_4,
    User_5,
    User_6,
    User_7,
    User_8,
    User_9,

    Rescue,         // 59

    // Four reserved layers (60 - 63) for future expansion within the 64 bit integer limit.

    PCB_LAYER_ID_COUNT
};

SCH_LAYER_ID

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_SHEETFIELDS
LAYER_SHEETLABEL
LAYER_NOCONNECT
LAYER_ERC_WARN
LAYER_ERC_ERR
LAYER_DEVICE_BACKGROUND
LAYER_SHEET_BACKGROUND
LAYER_SCHEMATIC_GRID
LAYER_SCHEMATIC_GRID_AXES
LAYER_SCHEMATIC_BACKGROUND
LAYER_SCHEMATIC_CURSOR
LAYER_BRIGHTENED
LAYER_HIDDEN
LAYER_SELECTION_SHADOWS
LAYER_SCHEMATIC_WORKSHEET
LAYER_BUS_JUNCTION
LAYER_SCHEMATIC_AUX_ITEMS
SCH_LAYER_ID_END

Definition at line 312 of file layers_id_colors_and_visibility.h.

                 : 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_SHEETFIELDS,
    LAYER_SHEETLABEL,
    LAYER_NOCONNECT,
    LAYER_ERC_WARN,
    LAYER_ERC_ERR,
    LAYER_DEVICE_BACKGROUND,
    LAYER_SHEET_BACKGROUND,
    LAYER_SCHEMATIC_GRID,
    LAYER_SCHEMATIC_GRID_AXES,
    LAYER_SCHEMATIC_BACKGROUND,
    LAYER_SCHEMATIC_CURSOR,
    LAYER_BRIGHTENED,
    LAYER_HIDDEN,
    LAYER_SELECTION_SHADOWS,
    LAYER_SCHEMATIC_WORKSHEET,
    LAYER_BUS_JUNCTION,
    LAYER_SCHEMATIC_AUX_ITEMS,

    SCH_LAYER_ID_END
};

Function Documentation

FlipLayer()

PCB_LAYER_ID FlipLayer	(	PCB_LAYER_ID	aLayerId,
		int	aCopperLayersCount = 0
	)

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 521 of file lset.cpp.

{
    switch( aLayerId )
    {
    case B_Cu:              return F_Cu;
    case F_Cu:              return B_Cu;

    case B_SilkS:           return F_SilkS;
    case F_SilkS:           return B_SilkS;

    case B_Adhes:           return F_Adhes;
    case F_Adhes:           return B_Adhes;

    case B_Mask:            return F_Mask;
    case F_Mask:            return B_Mask;

    case B_Paste:           return F_Paste;
    case F_Paste:           return B_Paste;

    case B_CrtYd:           return F_CrtYd;
    case F_CrtYd:           return B_CrtYd;

    case B_Fab:             return F_Fab;
    case F_Fab:             return B_Fab;

    default:    // change internal layer if aCopperLayersCount is >= 4
        if( IsCopperLayer( aLayerId ) && aCopperLayersCount >= 4 )
        {
            // internal copper layers count is aCopperLayersCount-2
            PCB_LAYER_ID fliplayer = PCB_LAYER_ID(aCopperLayersCount - 2 - ( aLayerId - In1_Cu ) );
            // Ensure fliplayer has a value which does not crash Pcbnew:
            if( fliplayer < F_Cu )
                fliplayer = F_Cu;

            if( fliplayer > B_Cu )
                fliplayer = B_Cu;

            return fliplayer;
        }

        // No change for the other layers
        return aLayerId;
    }
}

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_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_PAD::Flip(), PCAD2KICAD::PCB_ARC::Flip(), PCAD2KICAD::PCB_LINE::Flip(), PCAD2KICAD::PCB_POLYGON::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), FP_SHAPE::Flip(), TRACK::Flip(), FP_TEXT::Flip(), DIMENSION_BASE::Flip(), FOOTPRINT::Flip(), ARC::Flip(), PCB_SHAPE::Flip(), VIA::Flip(), and ZONE::Flip().

FlipLayerMask()

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 567 of file lset.cpp.

{
    // layers on physical outside of a board:
    const static LSET and_mask( 16,     // !! update count
                B_Cu,       F_Cu,
                B_SilkS,    F_SilkS,
                B_Adhes,    F_Adhes,
                B_Mask,     F_Mask,
                B_Paste,    F_Paste,
                B_Adhes,    F_Adhes,
                B_CrtYd,    F_CrtYd,
                B_Fab,      F_Fab
                );

    LSET newMask = aMask & ~and_mask;

    if( aMask[B_Cu] )
        newMask.set( F_Cu );

    if( aMask[F_Cu] )
        newMask.set( B_Cu );

    if( aMask[B_SilkS] )
        newMask.set( F_SilkS );

    if( aMask[F_SilkS] )
        newMask.set( B_SilkS );

    if( aMask[B_Adhes] )
        newMask.set( F_Adhes );

    if( aMask[F_Adhes] )
        newMask.set( B_Adhes );

    if( aMask[B_Mask] )
        newMask.set( F_Mask );

    if( aMask[F_Mask] )
        newMask.set( B_Mask );

    if( aMask[B_Paste] )
        newMask.set( F_Paste );

    if( aMask[F_Paste] )
        newMask.set( B_Paste );

    if( aMask[B_Adhes] )
        newMask.set( F_Adhes );

    if( aMask[F_Adhes] )
        newMask.set( B_Adhes );

    if( aMask[B_CrtYd] )
        newMask.set( F_CrtYd );

    if( aMask[F_CrtYd] )
        newMask.set( B_CrtYd );

    if( aMask[B_Fab] )
        newMask.set( F_Fab );

    if( aMask[F_Fab] )
        newMask.set( B_Fab );

    if( aCopperLayersCount >= 4 )   // Internal layers exist
    {
        LSET internalMask = aMask & LSET::InternalCuMask();

        if( internalMask != LSET::InternalCuMask() )
        {
            // the mask does not include all internal layers. Therefore
            // the flipped mask for internal copper layers must be built
            int innerLayerCnt = aCopperLayersCount -2;

            // the flipped mask is the innerLayerCnt bits rewritten in reverse order
            // ( bits innerLayerCnt to 1 rewritten in bits 1 to innerLayerCnt )
            for( int ii = 0; ii < innerLayerCnt; ii++ )
            {
                if( internalMask[innerLayerCnt - ii] )
                {
                    newMask.set( ii + In1_Cu );
                }
                else
                {
                    newMask.reset( ii + In1_Cu );
                }
            }
        }
    }

    return newMask;
}

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 PAD::Flip(), ZONE::Flip(), and ALTIUM_PCB::ParsePads6Data().

GetNetnameLayer()

int GetNetnameLayer ( int  aLayer )

inline

Returns a netname layer corresponding to the given layer.

Definition at line 883 of file layers_id_colors_and_visibility.h.

{
    if( IsCopperLayer( aLayer ) )
        return NETNAMES_LAYER_INDEX( aLayer );
    else if( aLayer == LAYER_PADS_TH )
        return LAYER_PADS_NETNAMES;
    else if( aLayer == LAYER_PAD_FR )
        return LAYER_PAD_FR_NETNAMES;
    else if( aLayer == LAYER_PAD_BK )
        return LAYER_PAD_BK_NETNAMES;
    else if( aLayer >= LAYER_VIA_MICROVIA && aLayer <= LAYER_VIA_THROUGH )
        return LAYER_VIAS_NETNAMES;

    // Fallback
    return Cmts_User;
}

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::LoadColors(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), and TRACK::ViewGetLayers().

IsBackLayer()

bool IsBackLayer ( PCB_LAYER_ID  aLayerId )

inline

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

Definition at line 837 of file layers_id_colors_and_visibility.h.

{
    switch( aLayerId )
    {
    case B_Cu:
    case B_Adhes:
    case B_Paste:
    case B_SilkS:
    case B_Mask:
    case B_CrtYd:
    case B_Fab:
        return true;
    default:
        ;
    }

    return false;
}

References B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, and B_SilkS.

Referenced by FP_TEXT::Flip(), FP_TEXT::FP_TEXT(), BOARD::GetFootprint(), GENERAL_COLLECTOR::Inspect(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DRAWING_TOOL::PlaceText(), PCB_DRAW_PANEL_GAL::SetTopLayer(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), FP_TEXT::ViewGetLOD(), and PAD::ViewGetLOD().

IsCopperLayer()

bool IsCopperLayer ( LAYER_NUM  aLayerId )

inline

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 770 of file layers_id_colors_and_visibility.h.

{
    return aLayerId >= F_Cu && aLayerId <= B_Cu;
}

References B_Cu, and F_Cu.

Referenced by BOARD::Add(), BOARD_ADAPTER::AddPadsWithClearanceToContainer(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), BOARD::BOARD(), PCB_ONE_LAYER_SELECTOR::buildList(), SELECT_COPPER_LAYERS_PAIR_DIALOG::buildList(), BOARD_ADAPTER::createLayers(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::Edit_Zone_Params(), FlipLayer(), DSN::SPECCTRA_DB::FromBOARD(), GenCADLayerName(), GetGerberFileFunctionAttribute(), GetGerberFilePolarityAttribute(), GetGerberProtelExtension(), BOARD_DESIGN_SETTINGS::GetLayerClass(), BOARD::GetLayerType(), GetNetnameLayer(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), DIALOG_EXPORT_SVG::initDialog(), IsNetCopperLayer(), BOARD_ITEM::IsOnCopperLayer(), PCBNEW_CONTROL::LayerNext(), PCBNEW_CONTROL::LayerPrev(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadPolygon(), EAGLE_PLUGIN::loadSignals(), DIALOG_PLOT::OnPopUpLayers(), EAGLE_PLUGIN::packageSMD(), ALTIUM_PCB::ParseVias6Data(), PNS::TOOL_BASE::pickSingleItem(), PlotOneBoardLayer(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbText(), CONVERT_TOOL::PolyToLines(), ROUTER_TOOL::prepareInteractive(), C3D_RENDER_RAYTRACING::Reload(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), BOARD::SetLayerType(), PCB_DRAW_PANEL_GAL::SetTopLayer(), PCBNEW_PRINTOUT::setupViewLayers(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncTextItem(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and FOOTPRINT::TransformPadsWithClearanceToPolygon().

IsDCodeLayer()

bool IsDCodeLayer ( int  aLayer )

inline

Definition at line 919 of file layers_id_colors_and_visibility.h.

{
    return aLayer >= (GERBVIEW_LAYER_ID_START + GERBER_DRAWLAYERS_COUNT) &&
           aLayer < (GERBVIEW_LAYER_ID_START + (2 * GERBER_DRAWLAYERS_COUNT));
}

References GERBER_DRAWLAYERS_COUNT, and GERBVIEW_LAYER_ID_START.

Referenced by KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), and GERBER_DRAW_ITEM::ViewGetLOD().

IsFrontLayer()

bool IsFrontLayer ( PCB_LAYER_ID  aLayerId )

inline

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

Definition at line 814 of file layers_id_colors_and_visibility.h.

{
    switch( aLayerId )
    {
    case F_Cu:
    case F_Adhes:
    case F_Paste:
    case F_SilkS:
    case F_Mask:
    case F_CrtYd:
    case F_Fab:
        return true;
    default:
        ;
    }

    return false;
}

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

Referenced by GENERAL_COLLECTOR::Inspect(), PCB_DRAW_PANEL_GAL::SetTopLayer(), FP_TEXT::ViewGetLOD(), and PAD::ViewGetLOD().

IsNetCopperLayer()

bool IsNetCopperLayer ( LAYER_NUM  aLayer )

inline

Checks if the given layer is "net copper", meaning it is eligible for net coloring.

Parameters

aLayer

is the layer to test

Returns

true if the layer is one that participates in net coloring

Definition at line 932 of file layers_id_colors_and_visibility.h.

{
    static std::set<LAYER_NUM> netCopperLayers =
            {
                LAYER_PAD_FR,
                LAYER_PAD_BK,
                LAYER_PADS_TH,
                LAYER_VIA_THROUGH,
                LAYER_VIA_BBLIND,
                LAYER_VIA_MICROVIA
            };

    return IsCopperLayer( aLayer ) || netCopperLayers.count( aLayer );
}

References IsCopperLayer(), LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_TH, LAYER_VIA_BBLIND, LAYER_VIA_MICROVIA, and LAYER_VIA_THROUGH.

Referenced by KIGFX::PCB_RENDER_SETTINGS::GetColor().

IsNetnameLayer()

bool IsNetnameLayer ( LAYER_NUM  aLayer )

inline

Test whether a layer is a netname layer.

Parameters

aLayer

= Layer to test

Returns

true if aLayer is a valid netname layer

Definition at line 906 of file layers_id_colors_and_visibility.h.

{
    return aLayer >= NETNAMES_LAYER_INDEX( F_Cu ) &&
           aLayer < NETNAMES_LAYER_ID_END;
}

References F_Cu, NETNAMES_LAYER_ID_END, and NETNAMES_LAYER_INDEX.

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

IsNonCopperLayer()

bool IsNonCopperLayer ( LAYER_NUM  aLayerId )

inline

Test 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 781 of file layers_id_colors_and_visibility.h.

{
    return aLayerId > B_Cu && aLayerId <= PCB_LAYER_ID_COUNT;
}

References B_Cu, and PCB_LAYER_ID_COUNT.

Referenced by PCAD2KICAD::PCB_ARC::AddToFootprint(), PCAD2KICAD::PCB_LINE::AddToFootprint(), PCAD2KICAD::PCB_POLYGON::AddToFootprint(), and PCB_DRAW_PANEL_GAL::setDefaultLayerDeps().

IsPcbLayer()

bool IsPcbLayer ( LAYER_NUM  aLayer )

inline

Test 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 759 of file layers_id_colors_and_visibility.h.

{
    return aLayer >= F_Cu && aLayer < PCB_LAYER_ID_COUNT;
}

References F_Cu, and PCB_LAYER_ID_COUNT.

Referenced by GBR_TO_PCB_EXPORTER::ExportPcb().

IsUserLayer()

bool IsUserLayer ( PCB_LAYER_ID  aLayerId )

inline

Test 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 792 of file layers_id_colors_and_visibility.h.

{
    return aLayerId >= Dwgs_User && aLayerId <= Eco2_User;
}

References Dwgs_User, and Eco2_User.

IsValidLayer()

bool IsValidLayer ( LAYER_NUM  aLayerId )

inline

Test 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 748 of file layers_id_colors_and_visibility.h.

{
    return unsigned( aLayerId ) < PCB_LAYER_ID_COUNT;
}

References PCB_LAYER_ID_COUNT.

Referenced by LAYERS_MAP_DIALOG::OnSelectLayer().

IsZoneLayer()

bool IsZoneLayer ( LAYER_NUM  aLayer )

inline

Definition at line 913 of file layers_id_colors_and_visibility.h.

{
    return aLayer >= LAYER_ZONE_START && aLayer <= LAYER_ZONE_END;
}

References LAYER_ZONE_END, and LAYER_ZONE_START.

Referenced by KIGFX::PCB_PAINTER::draw(), and KIGFX::PCB_RENDER_SETTINGS::GetColor().

LayerName()

wxString LayerName

(

int

aLayer

)

Returns the string equivalent of a given layer.

Parameters

aLayer

is a valid layer ID

Returns the string equivalent of a given layer.

These are not the same as the canonical name in LSET::Name(), which is used in board files and cannot be translated or changed.

Definition at line 27 of file layer_id.cpp.

{
    switch( aLayer )
    {
    // PCB_LAYER_ID
    case F_Cu:              return _( "F.Cu" );
    case In1_Cu:            return _( "In1.Cu" );
    case In2_Cu:            return _( "In2.Cu" );
    case In3_Cu:            return _( "In3.Cu" );
    case In4_Cu:            return _( "In4.Cu" );
    case In5_Cu:            return _( "In5.Cu" );
    case In6_Cu:            return _( "In6.Cu" );
    case In7_Cu:            return _( "In7.Cu" );
    case In8_Cu:            return _( "In8.Cu" );
    case In9_Cu:            return _( "In9.Cu" );
    case In10_Cu:           return _( "In10.Cu" );
    case In11_Cu:           return _( "In11.Cu" );
    case In12_Cu:           return _( "In12.Cu" );
    case In13_Cu:           return _( "In13.Cu" );
    case In14_Cu:           return _( "In14.Cu" );
    case In15_Cu:           return _( "In15.Cu" );
    case In16_Cu:           return _( "In16.Cu" );
    case In17_Cu:           return _( "In17.Cu" );
    case In18_Cu:           return _( "In18.Cu" );
    case In19_Cu:           return _( "In19.Cu" );
    case In20_Cu:           return _( "In20.Cu" );
    case In21_Cu:           return _( "In21.Cu" );
    case In22_Cu:           return _( "In22.Cu" );
    case In23_Cu:           return _( "In23.Cu" );
    case In24_Cu:           return _( "In24.Cu" );
    case In25_Cu:           return _( "In25.Cu" );
    case In26_Cu:           return _( "In26.Cu" );
    case In27_Cu:           return _( "In27.Cu" );
    case In28_Cu:           return _( "In28.Cu" );
    case In29_Cu:           return _( "In29.Cu" );
    case In30_Cu:           return _( "In30.Cu" );
    case B_Cu:              return _( "B.Cu" );

    // Technicals
    case B_Adhes:           return _( "B.Adhesive" );
    case F_Adhes:           return _( "F.Adhesive" );
    case B_Paste:           return _( "B.Paste" );
    case F_Paste:           return _( "F.Paste" );
    case B_SilkS:           return _( "B.Silkscreen" );
    case F_SilkS:           return _( "F.Silkscreen" );
    case B_Mask:            return _( "B.Mask" );
    case F_Mask:            return _( "F.Mask" );

    // Users
    case Dwgs_User:         return _( "User.Drawings" );
    case Cmts_User:         return _( "User.Comments" );
    case Eco1_User:         return _( "User.Eco1" );
    case Eco2_User:         return _( "User.Eco2" );
    case Edge_Cuts:         return _( "Edge.Cuts" );
    case Margin:            return _( "Margin" );

    // Footprint
    case F_CrtYd:           return _( "F.Courtyard" );
    case B_CrtYd:           return _( "B.Courtyard" );
    case F_Fab:             return _( "F.Fab" );
    case B_Fab:             return _( "B.Fab" );

    // User definable layers.
    case User_1:            return _( "User.1" );
    case User_2:            return _( "User.2" );
    case User_3:            return _( "User.3" );
    case User_4:            return _( "User.4" );
    case User_5:            return _( "User.5" );
    case User_6:            return _( "User.6" );
    case User_7:            return _( "User.7" );
    case User_8:            return _( "User.8" );
    case User_9:            return _( "User.9" );

    // Rescue
    case Rescue:            return _( "Rescue" );

    // SCH_LAYER_ID

    case LAYER_WIRE:                    return _( "Wires" );
    case LAYER_BUS:                     return _( "Buses" );
    case LAYER_BUS_JUNCTION:            return _( "Bus junctions" );
    case LAYER_JUNCTION:                return _( "Junctions" );
    case LAYER_LOCLABEL:                return _( "Labels" );
    case LAYER_GLOBLABEL:               return _( "Global labels" );
    case LAYER_HIERLABEL:               return _( "Hierarchical labels" );
    case LAYER_PINNUM:                  return _( "Pin numbers" );
    case LAYER_PINNAM:                  return _( "Pin names" );
    case LAYER_REFERENCEPART:           return _( "Symbol references" );
    case LAYER_VALUEPART:               return _( "Symbol values" );
    case LAYER_FIELDS:                  return _( "Symbol fields" );
    case LAYER_DEVICE:                  return _( "Symbol body outlines" );
    case LAYER_DEVICE_BACKGROUND:       return _( "Symbol body fills" );
    case LAYER_NOTES:                   return _( "Notes" );
    case LAYER_NETNAM:                  return _( "Net names" );
    case LAYER_PIN:                     return _( "Pins" );
    case LAYER_SHEET:                   return _( "Sheet borders" );
    case LAYER_SHEET_BACKGROUND:        return _( "Sheet backgrounds" );
    case LAYER_SHEETNAME:               return _( "Sheet names" );
    case LAYER_SHEETFIELDS:             return _( "Sheet fields" );
    case LAYER_SHEETFILENAME:           return _( "Sheet file names" );
    case LAYER_SHEETLABEL:              return _( "Sheet labels" );
    case LAYER_NOCONNECT:               return _( "No-connect symbols" );
    case LAYER_ERC_WARN:                return _( "ERC warnings" );
    case LAYER_ERC_ERR:                 return _( "ERC errors" );
    case LAYER_SCHEMATIC_AUX_ITEMS:     return _( "Helper items" );
    case LAYER_SCHEMATIC_GRID:          return _( "Grid" );
    case LAYER_SCHEMATIC_GRID_AXES:     return _( "Axes" );
    case LAYER_SCHEMATIC_BACKGROUND:    return _( "Background" );
    case LAYER_SCHEMATIC_CURSOR:        return _( "Cursor" );
    case LAYER_BRIGHTENED:              return _( "Highlighted items" );
    case LAYER_HIDDEN:                  return _( "Hidden items" );
    case LAYER_SELECTION_SHADOWS:       return _( "Selection highlight" );
    case LAYER_SCHEMATIC_WORKSHEET:     return _( "Worksheet" );

    // GAL_LAYER_ID

    case LAYER_MOD_FR:                  return _( "Footprints front" );
    case LAYER_MOD_BK:                  return _( "Footprints back" );
    case LAYER_MOD_VALUES:              return _( "Values" );
    case LAYER_MOD_REFERENCES:          return _( "Reference designators" );
    case LAYER_MOD_TEXT_FR:             return _( "Footprint text front" );
    case LAYER_MOD_TEXT_BK:             return _( "Footprint text back" );
    case LAYER_MOD_TEXT_INVISIBLE:      return _( "Hidden text" );
    case LAYER_PAD_FR:                  return _( "Pads front" );
    case LAYER_PAD_BK:                  return _( "Pads back" );
    case LAYER_PADS_TH:                 return _( "Through-hole pads" );
    case LAYER_TRACKS:                  return _( "Tracks" );
    case LAYER_VIA_THROUGH:             return _( "Through vias" );
    case LAYER_VIA_BBLIND:              return _( "Bl/Buried vias" );
    case LAYER_VIA_MICROVIA:            return _( "Micro-vias" );
    case LAYER_VIAS_HOLES:              return _( "Via holes" );
    case LAYER_NON_PLATEDHOLES:         return _( "Non-plated holes" );
    case LAYER_RATSNEST:                return _( "Ratsnest" );
    case LAYER_NO_CONNECTS:             return _( "No-connects" );
    case LAYER_DRC_WARNING:             return _( "DRC warnings" );
    case LAYER_DRC_ERROR:               return _( "DRC errors" );
    case LAYER_DRC_EXCLUSION:           return _( "DRC exclusions" );
    case LAYER_MARKER_SHADOWS:          return _( "DRC marker shadows" );
    case LAYER_ANCHOR:                  return _( "Anchors" );
    case LAYER_WORKSHEET:               return _( "Worksheet" );
    case LAYER_CURSOR:                  return _( "Cursor" );
    case LAYER_AUX_ITEMS:               return _( "Helper items" );
    case LAYER_GRID:                    return _( "Grid" );
    case LAYER_GRID_AXES:               return _( "Grid axes" );
    case LAYER_PCB_BACKGROUND:          return _( "Background" );
    case LAYER_SELECT_OVERLAY:          return _( "Selection highlight" );

    default:
        wxCHECK_MSG( false, wxEmptyString, wxString::Format( "Unknown layer ID %d", aLayer ) );
    }
}

References _, B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, Format(), In10_Cu, In11_Cu, In12_Cu, In13_Cu, In14_Cu, In15_Cu, In16_Cu, In17_Cu, In18_Cu, In19_Cu, In1_Cu, In20_Cu, In21_Cu, In22_Cu, In23_Cu, In24_Cu, In25_Cu, In26_Cu, In27_Cu, In28_Cu, In29_Cu, In2_Cu, In30_Cu, In3_Cu, In4_Cu, In5_Cu, In6_Cu, In7_Cu, In8_Cu, In9_Cu, LAYER_ANCHOR, LAYER_AUX_ITEMS, LAYER_BRIGHTENED, LAYER_BUS, LAYER_BUS_JUNCTION, LAYER_CURSOR, LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_ERC_ERR, LAYER_ERC_WARN, LAYER_FIELDS, LAYER_GLOBLABEL, LAYER_GRID, LAYER_GRID_AXES, LAYER_HIDDEN, LAYER_HIERLABEL, LAYER_JUNCTION, LAYER_LOCLABEL, LAYER_MARKER_SHADOWS, LAYER_MOD_BK, LAYER_MOD_FR, LAYER_MOD_REFERENCES, LAYER_MOD_TEXT_BK, LAYER_MOD_TEXT_FR, LAYER_MOD_TEXT_INVISIBLE, LAYER_MOD_VALUES, LAYER_NETNAM, LAYER_NO_CONNECTS, LAYER_NOCONNECT, LAYER_NON_PLATEDHOLES, LAYER_NOTES, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_TH, LAYER_PCB_BACKGROUND, LAYER_PIN, LAYER_PINNAM, LAYER_PINNUM, LAYER_RATSNEST, LAYER_REFERENCEPART, LAYER_SCHEMATIC_AUX_ITEMS, LAYER_SCHEMATIC_BACKGROUND, LAYER_SCHEMATIC_CURSOR, LAYER_SCHEMATIC_GRID, LAYER_SCHEMATIC_GRID_AXES, LAYER_SCHEMATIC_WORKSHEET, LAYER_SELECT_OVERLAY, LAYER_SELECTION_SHADOWS, LAYER_SHEET, LAYER_SHEET_BACKGROUND, LAYER_SHEETFIELDS, LAYER_SHEETFILENAME, LAYER_SHEETLABEL, LAYER_SHEETNAME, LAYER_TRACKS, LAYER_VALUEPART, LAYER_VIA_BBLIND, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, LAYER_VIAS_HOLES, LAYER_WIRE, LAYER_WORKSHEET, Margin, Rescue, User_1, User_2, User_3, User_4, User_5, User_6, User_7, User_8, and User_9.

Referenced by DIALOG_IMPORTED_LAYERS::AddMappings(), PANEL_SETUP_LAYERS::addUserDefinedLayer(), AUTOPLACE_TOOL::autoplace(), PANEL_FP_EDITOR_COLOR_SETTINGS::createSwatches(), PANEL_PCBNEW_COLOR_SETTINGS::createSwatches(), PANEL_EESCHEMA_COLOR_SETTINGS::createSwatches(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), PANEL_SETUP_LAYERS::getAvailableUserDefinedLayers(), DIALOG_IMPORTED_LAYERS::GetSelectedLayerID(), BOARD::GetStandardLayerName(), and DIALOG_IMPORTED_LAYERS::OnAutoMatchLayersClicked().

operator+()

GAL_LAYER_ID operator+ ( const GAL_LAYER_ID &  a, int  b  )

inline

Used for via types.

Definition at line 257 of file layers_id_colors_and_visibility.h.

{
    GAL_LAYER_ID t = GAL_LAYER_ID( int( a ) + b );
    wxASSERT( t <= GAL_LAYER_ID_END );
    return t;
}

References GAL_LAYER_ID_END.

operator++() [1/2]

GAL_LAYER_ID operator++ ( GAL_LAYER_ID &  a )

inline

Definition at line 244 of file layers_id_colors_and_visibility.h.

{
    a = GAL_LAYER_ID( int( a ) + 1 );
    return a;
}

operator++() [2/2]

SCH_LAYER_ID operator++ ( SCH_LAYER_ID &  a )

inline

Definition at line 359 of file layers_id_colors_and_visibility.h.

{
    a = SCH_LAYER_ID( int( a ) + 1 );
    return a;
}

ToGalLayer()

GAL_LAYER_ID ToGalLayer ( int  aInteger )

inline

Definition at line 250 of file layers_id_colors_and_visibility.h.

{
    wxASSERT( aInteger >= GAL_LAYER_ID_START && aInteger <= GAL_LAYER_ID_END );
    return static_cast<GAL_LAYER_ID>( aInteger );
}

References GAL_LAYER_ID_END, and GAL_LAYER_ID_START.

Referenced by APPEARANCE_CONTROLS::rebuildObjects(), and APPEARANCE_CONTROLS::syncObjectSettings().

ToLAYER_ID()

PCB_LAYER_ID ToLAYER_ID

(

int

aLayer

)

Definition at line 898 of file lset.cpp.

{
    wxASSERT( aLayer < GAL_LAYER_ID_END );
    return PCB_LAYER_ID( aLayer );
}

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(), BOARD_ADAPTER::createLayers(), GRID_CELL_LAYER_RENDERER::Draw(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), PCB_LAYER_VALUE::EqualTo(), existsOnLayer(), GENDRILL_WRITER_BASE::GenDrillReportFile(), GetGerberFileFunctionAttribute(), BOARD::GetLayerID(), PCB_LAYER_SELECTOR::getLayerName(), PCB_LAYER_BOX_SELECTOR::getLayerName(), DIALOG_IMPORTED_LAYERS::GetSelectedLayerID(), GRID_CELL_LAYER_SELECTOR::GetValue(), PCB_LAYER_BOX_SELECTOR::isLayerEnabled(), PCBNEW_CONTROL::LayerNext(), PCBNEW_CONTROL::LayerPrev(), PCAD2KICAD::PCB::MapLayer(), APPEARANCE_CONTROLS::onLayerClick(), DIALOG_RULE_AREA_PROPERTIES::OnLayerSelection(), DIALOG_NON_COPPER_ZONES_EDITOR::OnLayerSelection(), DIALOG_COPPER_ZONE::OnLayerSelection(), PLOT_CONTROLLER::OpenPlotfile(), DRC_RULES_PARSER::parseLayer(), 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(), SELECTION_TOOL::Selectable(), FOOTPRINT_EDIT_FRAME::SelectLayer(), PCB_BASE_FRAME::SelectLayer(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), APPEARANCE_CONTROLS::SetLayerVisible(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), ROUTER_TOOL::switchLayerOnViaPlacement(), PNS_KICAD_IFACE_BASE::syncZone(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

Variable Documentation

GAL_LAYER_ID_COUNT

constexpr int GAL_LAYER_ID_COUNT = GAL_LAYER_ID_END - GAL_LAYER_ID_START

Definition at line 242 of file layers_id_colors_and_visibility.h.