KiCad PCB EDA Suite
lset.cpp File Reference
#include <stdarg.h>
#include <assert.h>
#include <layers_id_colors_and_visibility.h>
#include <class_board.h>

Go to the source code of this file.

Functions

PCB_LAYER_ID FlipLayer (PCB_LAYER_ID aLayerId, int aCopperLayersCount)
 Function FlippedLayerNumber. More...
 
LSET FlipLayerMask (LSET aMask, int aCopperLayersCount)
 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...
 
PCB_LAYER_ID ToLAYER_ID (int aLayer)
 

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 445 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_ARC::Flip(), PCAD2KICAD::PCB_PAD::Flip(), PCAD2KICAD::PCB_LINE::Flip(), PCAD2KICAD::PCB_MODULE::Flip(), TEXTE_PCB::Flip(), PCB_TARGET::Flip(), EDGE_MODULE::Flip(), TEXTE_MODULE::Flip(), TRACK::Flip(), DIMENSION::Flip(), MODULE::Flip(), DRAWSEGMENT::Flip(), VIA::Flip(), and ZONE_CONTAINER::Flip().

446 {
447  switch( aLayerId )
448  {
449  case B_Cu: return F_Cu;
450  case F_Cu: return B_Cu;
451 
452  case B_SilkS: return F_SilkS;
453  case F_SilkS: return B_SilkS;
454 
455  case B_Adhes: return F_Adhes;
456  case F_Adhes: return B_Adhes;
457 
458  case B_Mask: return F_Mask;
459  case F_Mask: return B_Mask;
460 
461  case B_Paste: return F_Paste;
462  case F_Paste: return B_Paste;
463 
464  case B_CrtYd: return F_CrtYd;
465  case F_CrtYd: return B_CrtYd;
466 
467  case B_Fab: return F_Fab;
468  case F_Fab: return B_Fab;
469 
470  default: // change internal layer if aCopperLayersCount is >= 4
471  if( IsCopperLayer( aLayerId ) && aCopperLayersCount >= 4 )
472  {
473  // internal copper layers count is aCopperLayersCount-2
474  PCB_LAYER_ID fliplayer = PCB_LAYER_ID(aCopperLayersCount - 2 - ( aLayerId - In1_Cu ) );
475  // Ensure fliplayer has a value which does not crash pcbnew:
476  if( fliplayer < F_Cu )
477  fliplayer = F_Cu;
478 
479  if( fliplayer > B_Cu )
480  fliplayer = B_Cu;
481 
482  return fliplayer;
483  }
484 
485  // No change for the other layers
486  return aLayerId;
487  }
488 }
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 491 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(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

492 {
493  // layers on physical outside of a board:
494  const static LSET and_mask( 16, // !! update count
495  B_Cu, F_Cu,
496  B_SilkS, F_SilkS,
497  B_Adhes, F_Adhes,
498  B_Mask, F_Mask,
499  B_Paste, F_Paste,
500  B_Adhes, F_Adhes,
501  B_CrtYd, F_CrtYd,
502  B_Fab, F_Fab
503  );
504 
505  LSET newMask = aMask & ~and_mask;
506 
507  if( aMask[B_Cu] )
508  newMask.set( F_Cu );
509 
510  if( aMask[F_Cu] )
511  newMask.set( B_Cu );
512 
513  if( aMask[B_SilkS] )
514  newMask.set( F_SilkS );
515 
516  if( aMask[F_SilkS] )
517  newMask.set( B_SilkS );
518 
519  if( aMask[B_Adhes] )
520  newMask.set( F_Adhes );
521 
522  if( aMask[F_Adhes] )
523  newMask.set( B_Adhes );
524 
525  if( aMask[B_Mask] )
526  newMask.set( F_Mask );
527 
528  if( aMask[F_Mask] )
529  newMask.set( B_Mask );
530 
531  if( aMask[B_Paste] )
532  newMask.set( F_Paste );
533 
534  if( aMask[F_Paste] )
535  newMask.set( B_Paste );
536 
537  if( aMask[B_Adhes] )
538  newMask.set( F_Adhes );
539 
540  if( aMask[F_Adhes] )
541  newMask.set( B_Adhes );
542 
543  if( aMask[B_CrtYd] )
544  newMask.set( F_CrtYd );
545 
546  if( aMask[F_CrtYd] )
547  newMask.set( B_CrtYd );
548 
549  if( aMask[B_Fab] )
550  newMask.set( F_Fab );
551 
552  if( aMask[F_Fab] )
553  newMask.set( B_Fab );
554 
555  if( aCopperLayersCount >= 4 ) // Internal layers exist
556  {
557  LSET internalMask = aMask & LSET::InternalCuMask();
558 
559  if( internalMask != LSET::InternalCuMask() )
560  {
561  // the mask does not include all internal layers. Therefore
562  // the flipped mask for internal copper layers must be built
563  int innerLayerCnt = aCopperLayersCount -2;
564 
565  // the flipped mask is the innerLayerCnt bits rewritten in reverse order
566  // ( bits innerLayerCnt to 1 rewritten in bits 1 to innerLayerCnt )
567  for( int ii = 0; ii < innerLayerCnt; ii++ )
568  {
569  if( internalMask[innerLayerCnt - ii] )
570  {
571  newMask.set( ii + In1_Cu );
572  }
573  else
574  {
575  newMask.reset( ii + In1_Cu );
576  }
577  }
578  }
579  }
580 
581  return newMask;
582 }
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:606
PCB_LAYER_ID ToLAYER_ID ( int  aLayer)

Definition at line 774 of file lset.cpp.

References PCB_LAYER_ID_COUNT.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), DXF2BRD_CONVERTER::addArc(), DXF2BRD_CONVERTER::addCircle(), PNS_KICAD_IFACE::AddItem(), DXF2BRD_CONVERTER::addLine(), DXF2BRD_CONVERTER::addMText(), DXF2BRD_CONVERTER::addText(), BOARD::BOARD(), DSN::SPECCTRA_DB::buildLayerMaps(), CINFO3D_VISU::createLayers(), PCB_BASE_FRAME::CreateNewModule(), DRAWING_TOOL::DrawVia(), EVT_COMMAND_RANGE(), GENDRILL_WRITER_BASE::GenDrillReportFile(), BRDITEMS_PLOTTER::getColor(), GetGerberFileFunctionAttribute(), PCB_LAYER_SELECTOR::GetLayerColor(), PCB_LAYER_BOX_SELECTOR::GetLayerColor(), BOARD::GetLayerID(), PCB_LAYER_SELECTOR::GetLayerName(), PCB_LAYER_BOX_SELECTOR::GetLayerName(), DXF2BRD_CONVERTER::insertArc(), DXF2BRD_CONVERTER::insertLine(), PCB_LAYER_BOX_SELECTOR::IsLayerEnabled(), PCBNEW_CONTROL::LayerNext(), PCBNEW_CONTROL::LayerPrev(), PCAD2KICAD::PCB::MapLayer(), PCB_EDIT_FRAME::OnHotKey(), PCB_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnLayerSelect(), DIALOG_DIMENSION_EDITOR::OnOKClick(), 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(), SWAP_LAYERS_DIALOG::Sel_Layer(), PCB_BASE_FRAME::SelectLayer(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), ROUTER_TOOL::switchLayerOnViaPlacement(), PCB_LAYER_WIDGET::SyncLayerVisibilities(), DialogEditModuleText::TransferDataFromWindow(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_MODEDIT_FP_BODY_ITEM_PROPERTIES::TransferDataFromWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

775 {
776  wxASSERT( unsigned( aLayer ) < PCB_LAYER_ID_COUNT );
777  return PCB_LAYER_ID( aLayer );
778 }
PCB_LAYER_ID
A quick note on layer IDs: