KiCad PCB EDA Suite
pcbplot.h File Reference

Board plot function definition file. More...

#include <wx/filename.h>
#include <pad_shapes.h>
#include <pcb_plot_params.h>
#include <layers_id_colors_and_visibility.h>

Go to the source code of this file.

Classes

class  BRDITEMS_PLOTTER
 

Macros

#define PLOT_MIN_SCALE   0.01
 
#define PLOT_MAX_SCALE   100.0
 
#define SMALL_DRILL   KiROUND( 0.35 * IU_PER_MM )
 
#define OPTKEY_LAYERBASE   wxT( "PlotLayer_%d" )
 
#define OPTKEY_PRINT_LINE_WIDTH   wxT( "PrintLineWidth" )
 
#define OPTKEY_PRINT_SCALE   wxT( "PrintScale" )
 
#define OPTKEY_PRINT_PAGE_FRAME   wxT( "PrintPageFrame" )
 
#define OPTKEY_PRINT_MONOCHROME_MODE   wxT( "PrintMonochrome" )
 
#define OPTKEY_PRINT_PAGE_PER_LAYER   wxT( "PrintSinglePage" )
 
#define OPTKEY_PRINT_PADS_DRILL   wxT( "PrintPadsDrillOpt" )
 
#define OPTKEY_PLOT_X_FINESCALE_ADJ   wxT( "PlotXFineScaleAdj" )
 
#define OPTKEY_PLOT_Y_FINESCALE_ADJ   wxT( "PlotYFineScaleAdj" )
 
#define CONFIG_PS_FINEWIDTH_ADJ   wxT( "PSPlotFineWidthAdj" )
 
#define OPTKEY_PLOT_CHECK_ZONES   wxT( "CheckZonesBeforePlotting" )
 

Functions

PLOTTERStartPlotBoard (BOARD *aBoard, PCB_PLOT_PARAMS *aPlotOpts, int aLayer, const wxString &aFullFileName, const wxString &aSheetDesc)
 Open a new plotfile using the options (and especially the format) specified in the options and prepare the page for plotting. More...
 
void PlotOneBoardLayer (BOARD *aBoard, PLOTTER *aPlotter, PCB_LAYER_ID aLayer, const PCB_PLOT_PARAMS &aPlotOpt)
 Function PlotOneBoardLayer main function to plot one copper or technical layer. More...
 
void PlotStandardLayer (BOARD *aBoard, PLOTTER *aPlotter, LSET aLayerMask, const PCB_PLOT_PARAMS &aPlotOpt)
 Function PlotStandardLayer plot copper or technical layers. More...
 
void PlotLayerOutlines (BOARD *aBoard, PLOTTER *aPlotter, LSET aLayerMask, const PCB_PLOT_PARAMS &aPlotOpt)
 Function PlotLayerOutlines plot copper outline of a copper layer. More...
 
void PlotSilkScreen (BOARD *aBoard, PLOTTER *aPlotter, LSET aLayerMask, const PCB_PLOT_PARAMS &aPlotOpt)
 Function PlotSilkScreen plot silkscreen layers which have specific requirements, mainly for pads. More...
 
void BuildPlotFileName (wxFileName *aFilename, const wxString &aOutputDir, const wxString &aSuffix, const wxString &aExtension)
 Function BuildPlotFileName (helper function) Complete a plot filename: forces the output directory, add a suffix to the name and sets the specified extension the suffix is usually the layer name replaces not allowed chars in suffix by '_'. More...
 
const wxString GetGerberProtelExtension (LAYER_NUM aLayer)
 Function GetGerberProtelExtension. More...
 
const wxString GetGerberFileFunctionAttribute (const BOARD *aBoard, LAYER_NUM aLayer)
 Function GetGerberFileFunctionAttribute Returns the "file function" attribute for aLayer, as defined in the Gerber file format specification J1 (chapter 5). More...
 
void AddGerberX2Header (PLOTTER *aPlotter, const BOARD *aBoard, bool aUseX1CompatibilityMode=false)
 Calculates some X2 attributes, as defined in the Gerber file format specification J4 (chapter 5) and add them the to the gerber file header: TF.GenerationSoftware TF.CreationDate TF.ProjectId file format attribute is not added. More...
 
void AddGerberX2Attribute (PLOTTER *aPlotter, const BOARD *aBoard, LAYER_NUM aLayer, bool aUseX1CompatibilityMode)
 Calculates some X2 attributes, as defined in the Gerber file format specification and add them to the gerber file header: TF.GenerationSoftware TF.CreationDate TF.ProjectId TF.FileFunction TF.FilePolarity. More...
 

Detailed Description

Board plot function definition file.

Definition in file pcbplot.h.

Macro Definition Documentation

◆ PLOT_MAX_SCALE

#define PLOT_MAX_SCALE   100.0

Definition at line 69 of file pcbplot.h.

◆ PLOT_MIN_SCALE

#define PLOT_MIN_SCALE   0.01

Definition at line 68 of file pcbplot.h.

◆ SMALL_DRILL

#define SMALL_DRILL   KiROUND( 0.35 * IU_PER_MM )

Definition at line 72 of file pcbplot.h.

Function Documentation

◆ AddGerberX2Attribute()

void AddGerberX2Attribute ( PLOTTER aPlotter,
const BOARD aBoard,
LAYER_NUM  aLayer,
bool  aUseX1CompatibilityMode 
)

Calculates some X2 attributes, as defined in the Gerber file format specification and add them to the gerber file header: TF.GenerationSoftware TF.CreationDate TF.ProjectId TF.FileFunction TF.FilePolarity.

Parameters
aPlotter= the current plotter.
aBoard= the board, needed to extract some info
aLayer= the layer number to create the attribute for
aUseX1CompatibilityMode= false to generate X2 attributes, true to use X1 compatibility (X2 attributes added as structured comments, starting by "G04 #@! " followed by the X2 attribute

Definition at line 352 of file pcbplot.cpp.

354 {
355  AddGerberX2Header( aPlotter, aBoard, aUseX1CompatibilityMode );
356 
357  wxString text;
358 
359  // Add the TF.FileFunction
360  text = GetGerberFileFunctionAttribute( aBoard, aLayer );
361  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
362 
363  // Add the TF.FilePolarity (for layers which support that)
364  text = GetGerberFilePolarityAttribute( aLayer );
365 
366  if( !text.IsEmpty() )
367  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
368 }
void AddGerberX2Header(PLOTTER *aPlotter, const BOARD *aBoard, bool aUseX1CompatibilityMode)
Calculates some X2 attributes, as defined in the Gerber file format specification J4 (chapter 5) and ...
Definition: pcbplot.cpp:280
void AddLineToHeader(const wxString &aExtraString)
Function AddLineToHeader Add a line to the list of free lines to print at the beginning of the file.
Definition: plotter.h:176
static const wxString GetGerberFilePolarityAttribute(LAYER_NUM aLayer)
Definition: pcbplot.cpp:209
static wxString & makeStringCompatX1(wxString &aText, bool aUseX1CompatibilityMode)
Definition: pcbplot.cpp:268
const wxString GetGerberFileFunctionAttribute(const BOARD *aBoard, LAYER_NUM aLayer)
Function GetGerberFileFunctionAttribute Returns the "file function" attribute for aLayer,...
Definition: pcbplot.cpp:89

References AddGerberX2Header(), PLOTTER::AddLineToHeader(), GetGerberFileFunctionAttribute(), GetGerberFilePolarityAttribute(), and makeStringCompatX1().

Referenced by StartPlotBoard().

◆ AddGerberX2Header()

void AddGerberX2Header ( PLOTTER aPlotter,
const BOARD aBoard,
bool  aUseX1CompatibilityMode = false 
)

Calculates some X2 attributes, as defined in the Gerber file format specification J4 (chapter 5) and add them the to the gerber file header: TF.GenerationSoftware TF.CreationDate TF.ProjectId file format attribute is not added.

Parameters
aPlotter= the current plotter.
aBoard= the board, needed to extract some info
aUseX1CompatibilityMode= false to generate X2 attributes, true to use X1 compatibility (X2 attributes added as structured comments, starting by "G04 #@! " followed by the X2 attribute

Definition at line 280 of file pcbplot.cpp.

282 {
283  wxString text;
284 
285  // Creates the TF,.GenerationSoftware. Format is:
286  // %TF,.GenerationSoftware,<vendor>,<application name>[,<application version>]*%
287  text.Printf( wxT( "%%TF.GenerationSoftware,KiCad,Pcbnew,%s*%%" ), GetBuildVersion() );
288  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
289 
290  // creates the TF.CreationDate attribute:
291  text = GbrMakeCreationDateAttributeString( aUseX1CompatibilityMode ?
294  aPlotter->AddLineToHeader( text );
295 
296  // Creates the TF,.ProjectId. Format is (from Gerber file format doc):
297  // %TF.ProjectId,<project id>,<project GUID>,<revision id>*%
298  // <project id> is the name of the project, restricted to basic ASCII symbols only,
299  // Rem: <project id> accepts only ASCII 7 code (only basic ASCII codes are allowed in gerber files).
300  // and comma not accepted
301  // All illegal chars will be replaced by underscore
302  //
303  // <project GUID> is a string which is an unique id of a project.
304  // However Kicad does not handle such a project GUID, so it is built from the board name
305  wxFileName fn = aBoard->GetFileName();
306  wxString msg = fn.GetFullName();
307 
308  // Build a <project GUID>, from the board name
309  wxString guid = GbrMakeProjectGUIDfromString( msg );
310 
311  // build the <project id> string: this is the board short filename (without ext)
312  // and all non ASCII chars and comma are replaced by '_'
313  msg = fn.GetName();
314  msg.Replace( wxT( "," ), wxT( "_" ) );
315 
316  // build the <rec> string. All non ASCII chars and comma are replaced by '_'
317  wxString rev = ((BOARD*)aBoard)->GetTitleBlock().GetRevision();
318  rev.Replace( wxT( "," ), wxT( "_" ) );
319 
320  if( rev.IsEmpty() )
321  rev = wxT( "rev?" );
322 
323  text.Printf( wxT( "%%TF.ProjectId,%s,%s,%s*%%" ), msg.ToAscii(), GetChars( guid ), rev.ToAscii() );
324  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
325 
326  // Add the TF.SameCoordinates, that specify all gerber files uses the same
327  // origin and orientation, and the registration between files is OK.
328  // The parameter of TF.SameCoordinates is a string that is common
329  // to all files using the same registration and has no special meaning:
330  // this is just a key
331  // Because there is no mirroring/rotation in Kicad, only the plot offset origin
332  // can create incorrect registration.
333  // So we create a key from plot offset options.
334  // and therefore for a given board, all Gerber files having the same key have the same
335  // plot origin and use the same registration
336  //
337  // Currently the key is "Original" when using absolute Pcbnew coordinates,
338  // and te PY ans PY position od auxiliary axis, when using it.
339  // Please, if absolute Pcbnew coordinates, one day, are set by user, change the way
340  // the key is built to ensure file only using the *same* axis have the same key.
341  wxString registration_id = "Original";
342  wxPoint auxOrigin = aBoard->GetAuxOrigin();
343 
344  if( aBoard->GetPlotOptions().GetUseAuxOrigin() && auxOrigin.x && auxOrigin.y )
345  registration_id.Printf( "PX%xPY%x", auxOrigin.x, auxOrigin.y );
346 
347  text.Printf( "%%TF.SameCoordinates,%s*%%", registration_id.GetData() );
348  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
349 }
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: class_board.h:552
wxString GbrMakeCreationDateAttributeString(GBR_NC_STRING_FORMAT aFormat)
void AddLineToHeader(const wxString &aExtraString)
Function AddLineToHeader Add a line to the list of free lines to print at the beginning of the file.
Definition: plotter.h:176
const wxString & GetFileName() const
Definition: class_board.h:237
wxString GetBuildVersion()
Function GetBuildVersion Return the build version string.
wxString GbrMakeProjectGUIDfromString(wxString &aText)
A helper function to build a project GUID using format RFC4122 Version 1 or 4 from the project name,...
const wxPoint & GetAuxOrigin() const
Definition: class_board.h:345
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:100
static wxString & makeStringCompatX1(wxString &aText, bool aUseX1CompatibilityMode)
Definition: pcbplot.cpp:268
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
bool GetUseAuxOrigin() const

References PLOTTER::AddLineToHeader(), GBR_NC_STRING_FORMAT_X1, GBR_NC_STRING_FORMAT_X2, GbrMakeCreationDateAttributeString(), GbrMakeProjectGUIDfromString(), BOARD::GetAuxOrigin(), GetBuildVersion(), GetChars(), BOARD::GetFileName(), BOARD::GetPlotOptions(), PCB_PLOT_PARAMS::GetUseAuxOrigin(), and makeStringCompatX1().

Referenced by AddGerberX2Attribute(), and GERBER_WRITER::createDrillFile().

◆ BuildPlotFileName()

void BuildPlotFileName ( wxFileName *  aFilename,
const wxString &  aOutputDir,
const wxString &  aSuffix,
const wxString &  aExtension 
)

Function BuildPlotFileName (helper function) Complete a plot filename: forces the output directory, add a suffix to the name and sets the specified extension the suffix is usually the layer name replaces not allowed chars in suffix by '_'.

Parameters
aFilename= the wxFileName to initialize Contains the base filename
aOutputDir= the path
aSuffix= the suffix to add to the base filename
aExtension= the file extension

Definition at line 371 of file pcbplot.cpp.

373 {
374  // aFilename contains the base filename only (without path and extension)
375  // when calling this function.
376  // It is expected to be a valid filename (this is usually the board filename)
377  aFilename->SetPath( aOutputDir );
378 
379  // Set the file extension
380  aFilename->SetExt( aExtension );
381 
382  // remove leading and trailing spaces if any from the suffix, if
383  // something survives add it to the name;
384  // also the suffix can contain some not allowed chars in filename (/ \ . : and some others),
385  // so change them to underscore
386  // Remember it can be called from a python script, so the illegal chars
387  // have to be filtered here.
388  wxString suffix = aSuffix;
389  suffix.Trim( true );
390  suffix.Trim( false );
391 
392  wxString badchars = wxFileName::GetForbiddenChars(wxPATH_DOS);
393  badchars.Append( "%." );
394 
395  for( unsigned ii = 0; ii < badchars.Len(); ii++ )
396  suffix.Replace( badchars[ii], wxT("_") );
397 
398  if( !suffix.IsEmpty() )
399  aFilename->SetName( aFilename->GetName() + wxT( "-" ) + suffix );
400 }

Referenced by DIALOG_EXPORT_SVG::ExportSVGFile(), PLOT_CONTROLLER::OpenPlotfile(), and DIALOG_PLOT::Plot().

◆ GetGerberFileFunctionAttribute()

const wxString GetGerberFileFunctionAttribute ( const BOARD aBoard,
LAYER_NUM  aLayer 
)

Function GetGerberFileFunctionAttribute Returns the "file function" attribute for aLayer, as defined in the Gerber file format specification J1 (chapter 5).

The returned string includes the "%TF.FileFunction" attribute prefix and the "*%" suffix.

Parameters
aBoard= the board, needed to get the total count of copper layers
aLayer= the layer number to create the attribute for
Returns
The attribute, as a text string

Definition at line 89 of file pcbplot.cpp.

90 {
91  wxString attrib;
92 
93  switch( aLayer )
94  {
95  case F_Adhes:
96  attrib = "Glue,Top";
97  break;
98 
99  case B_Adhes:
100  attrib = "Glue,Bot";
101  break;
102 
103  case F_SilkS:
104  attrib = "Legend,Top";
105  break;
106 
107  case B_SilkS:
108  attrib = "Legend,Bot";
109  break;
110 
111  case F_Mask:
112  attrib = "Soldermask,Top";
113  break;
114 
115  case B_Mask:
116  attrib = "Soldermask,Bot";
117  break;
118 
119  case F_Paste:
120  attrib = "Paste,Top";
121  break;
122 
123  case B_Paste:
124  attrib = "Paste,Bot";
125  break;
126 
127  case Edge_Cuts:
128  // Board outline.
129  // Can be "Profile,NP" (Not Plated: usual) or "Profile,P"
130  // This last is the exception (Plated)
131  attrib = "Profile,NP";
132  break;
133 
134  case Dwgs_User:
135  attrib = "Drawing";
136  break;
137 
138  case Cmts_User:
139  attrib = "Other,Comment";
140  break;
141 
142  case Eco1_User:
143  attrib = "Other,ECO1";
144  break;
145 
146  case Eco2_User:
147  attrib = "Other,ECO2";
148  break;
149 
150  case B_Fab:
151  attrib = "Other,Fab,Bot";
152  break;
153 
154  case F_Fab:
155  attrib = "Other,Fab,Top";
156  break;
157 
158  case B_Cu:
159  attrib.Printf( wxT( "Copper,L%d,Bot" ), aBoard->GetCopperLayerCount() );
160  break;
161 
162  case F_Cu:
163  attrib = "Copper,L1,Top";
164  break;
165 
166  default:
167  if( IsCopperLayer( aLayer ) )
168  attrib.Printf( wxT( "Copper,L%d,Inr" ), aLayer+1 );
169  else
170  attrib.Printf( wxT( "Other,User" ), aLayer+1 );
171  break;
172  }
173 
174  // This code adds a optional parameter: the type of copper layers.
175  // Because it is not used by Pcbnew (it can be used only by external autorouters)
176  // user do not really set this parameter.
177  // Therefore do not add it.
178  // However, this code is left here, for perhaps a future usage.
179 #if 0
180  // Add the signal type of the layer, if relevant
181  if( IsCopperLayer( aLayer ) )
182  {
183  LAYER_T type = aBoard->GetLayerType( ToLAYER_ID( aLayer ) );
184 
185  switch( type )
186  {
187  case LT_SIGNAL:
188  attrib += ",Signal";
189  break;
190  case LT_POWER:
191  attrib += ",Plane";
192  break;
193  case LT_MIXED:
194  attrib += ",Mixed";
195  break;
196  default:
197  break; // do nothing (but avoid a warning for unhandled LAYER_T values from GCC)
198  }
199  }
200 #endif
201 
202  wxString fileFct;
203  fileFct.Printf( "%%TF.FileFunction,%s*%%", GetChars( attrib ) );
204 
205  return fileFct;
206 }
LAYER_T
Enum LAYER_T gives the allowed types of layers, same as Specctra DSN spec.
Definition: class_board.h:72
LAYER_T GetLayerType(PCB_LAYER_ID aLayer) const
Function GetLayerType returns the type of the copper layer given by aLayer.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:100
int GetCopperLayerCount() const
Function GetCopperLayerCount.
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:813

References B_Adhes, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, GetChars(), BOARD::GetCopperLayerCount(), BOARD::GetLayerType(), IsCopperLayer(), LT_MIXED, LT_POWER, LT_SIGNAL, and ToLAYER_ID().

Referenced by AddGerberX2Attribute().

◆ GetGerberProtelExtension()

const wxString GetGerberProtelExtension ( LAYER_NUM  aLayer)

Function GetGerberProtelExtension.

Returns
the appropriate Gerber file extension for aLayer used by Protel, and still sometimes in use (although the official Gerber Ext is now .gbr)

Definition at line 48 of file pcbplot.cpp.

49 {
50  if( IsCopperLayer( aLayer ) )
51  {
52  if( aLayer == F_Cu )
53  return wxT( "gtl" );
54  else if( aLayer == B_Cu )
55  return wxT( "gbl" );
56  else
57  {
58  return wxString::Format( wxT( "g%d" ), aLayer+1 );
59  }
60  }
61  else
62  {
63  switch( aLayer )
64  {
65  case B_Adhes: return wxT( "gba" );
66  case F_Adhes: return wxT( "gta" );
67 
68  case B_Paste: return wxT( "gbp" );
69  case F_Paste: return wxT( "gtp" );
70 
71  case B_SilkS: return wxT( "gbo" );
72  case F_SilkS: return wxT( "gto" );
73 
74  case B_Mask: return wxT( "gbs" );
75  case F_Mask: return wxT( "gts" );
76 
77  case Edge_Cuts: return wxT( "gm1" );
78 
79  case Dwgs_User:
80  case Cmts_User:
81  case Eco1_User:
82  case Eco2_User:
83  default: return wxT( "gbr" );
84  }
85  }
86 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.

References B_Adhes, B_Cu, B_Mask, B_Paste, B_SilkS, Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_Cu, F_Mask, F_Paste, F_SilkS, Format(), and IsCopperLayer().

Referenced by PLOT_CONTROLLER::OpenPlotfile(), and DIALOG_PLOT::Plot().

◆ PlotLayerOutlines()

void PlotLayerOutlines ( BOARD aBoard,
PLOTTER aPlotter,
LSET  aLayerMask,
const PCB_PLOT_PARAMS aPlotOpt 
)

Function PlotLayerOutlines plot copper outline of a copper layer.

Parameters
aBoard= the board to plot
aPlotter= the plotter to use
aLayerMask= the mask to define the layers to plot
aPlotOpt= the plot options. Has meaning for some formats only

Definition at line 649 of file plot_board_layers.cpp.

651 {
652 
653  BRDITEMS_PLOTTER itemplotter( aPlotter, aBoard, aPlotOpt );
654  itemplotter.SetLayerSet( aLayerMask );
655 
656  SHAPE_POLY_SET outlines;
657 
658  for( LSEQ seq = aLayerMask.Seq( plot_seq, arrayDim( plot_seq ) ); seq; ++seq )
659  {
660  PCB_LAYER_ID layer = *seq;
661 
662  outlines.RemoveAllContours();
663  aBoard->ConvertBrdLayerToPolygonalContours( layer, outlines );
664 
665  outlines.Simplify( SHAPE_POLY_SET::PM_FAST );
666 
667  // Plot outlines
668  std::vector< wxPoint > cornerList;
669 
670  // Now we have one or more basic polygons: plot each polygon
671  for( int ii = 0; ii < outlines.OutlineCount(); ii++ )
672  {
673  for(int kk = 0; kk <= outlines.HoleCount (ii); kk++ )
674  {
675  cornerList.clear();
676  const SHAPE_LINE_CHAIN& path = (kk == 0) ? outlines.COutline( ii ) : outlines.CHole( ii, kk - 1 );
677 
678  for( int jj = 0; jj < path.PointCount(); jj++ )
679  cornerList.push_back( wxPoint( path.CPoint( jj ).x , path.CPoint( jj ).y ) );
680 
681 
682  // Ensure the polygon is closed
683  if( cornerList[0] != cornerList[cornerList.size() - 1] )
684  cornerList.push_back( cornerList[0] );
685 
686  aPlotter->PlotPoly( cornerList, NO_FILL );
687  }
688  }
689 
690  // Plot pad holes
692  {
693  int smallDrill = (aPlotOpt.GetDrillMarksType() == PCB_PLOT_PARAMS::SMALL_DRILL_SHAPE)
694  ? SMALL_DRILL : INT_MAX;
695 
696  for( MODULE* module = aBoard->m_Modules; module; module = module->Next() )
697  {
698  for( D_PAD* pad = module->PadsList(); pad; pad = pad->Next() )
699  {
700  wxSize hole = pad->GetDrillSize();
701 
702  if( hole.x == 0 || hole.y == 0 )
703  continue;
704 
705  if( hole.x == hole.y )
706  {
707  hole.x = std::min( smallDrill, hole.x );
708  aPlotter->Circle( pad->GetPosition(), hole.x, NO_FILL );
709  }
710  else
711  {
712  // Note: small drill marks have no significance when applied to slots
713  wxPoint drl_start, drl_end;
714  int width;
715  pad->GetOblongDrillGeometry( drl_start, drl_end, width );
716  aPlotter->ThickSegment( pad->GetPosition() + drl_start,
717  pad->GetPosition() + drl_end, width, SKETCH, NULL );
718  }
719  }
720  }
721  }
722 
723  // Plot vias holes
724  for( TRACK* track = aBoard->m_Track; track; track = track->Next() )
725  {
726  const VIA* via = dyn_cast<const VIA*>( track );
727 
728  if( via && via->IsOnLayer( layer ) ) // via holes can be not through holes
729  {
730  aPlotter->Circle( via->GetPosition(), via->GetDrillValue(), NO_FILL );
731  }
732  }
733  }
734 }
D_PAD * Next() const
Definition: class_pad.h:162
#define SMALL_DRILL
Definition: pcbplot.h:72
int OutlineCount() const
Returns the number of outlines in the set
static const PCB_LAYER_ID plot_seq[]
const SHAPE_LINE_CHAIN & CHole(int aOutline, int aHole) const
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
int PointCount() const
Function PointCount()
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Function Seq returns an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:367
const VECTOR2I & CPoint(int aIndex) const
Function CPoint()
PCB_LAYER_ID
A quick note on layer IDs:
int GetDrillValue() const
Function GetDrillValue "calculates" the drill value for vias (m-Drill if > 0, or default drill value ...
Class SHAPE_POLY_SET.
void ConvertBrdLayerToPolygonalContours(PCB_LAYER_ID aLayer, SHAPE_POLY_SET &aOutlines)
Function ConvertBrdLayerToPolygonalContours Build a set of polygons which are the outlines of copper ...
void Simplify(POLYGON_MODE aFastMode)
Simplifies the polyset (merges overlapping polys, eliminates degeneracy/self-intersections) For aFast...
int HoleCount(int aOutline) const
Returns the number of holes in a given outline
const wxPoint GetPosition() const override
Definition: class_track.h:410
Class LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:107
DLIST< MODULE > m_Modules
Definition: class_board.h:248
Class SHAPE_LINE_CHAIN.
virtual void ThickSegment(const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData)
Definition: plotter.cpp:456
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
DLIST< TRACK > m_Track
Definition: class_board.h:249
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Function IsOnLayer tests to see if this object is on the given layer.
DrillMarksType GetDrillMarksType() const
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
#define min(a, b)
Definition: auxiliary.h:85

References arrayDim(), SHAPE_POLY_SET::CHole(), PLOTTER::Circle(), BOARD::ConvertBrdLayerToPolygonalContours(), SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CPoint(), PCB_PLOT_PARAMS::GetDrillMarksType(), VIA::GetDrillValue(), VIA::GetPosition(), SHAPE_POLY_SET::HoleCount(), VIA::IsOnLayer(), BOARD::m_Modules, BOARD::m_Track, min, D_PAD::Next(), PCB_PLOT_PARAMS::NO_DRILL_SHAPE, NO_FILL, SHAPE_POLY_SET::OutlineCount(), plot_seq, PLOTTER::PlotPoly(), SHAPE_POLY_SET::PM_FAST, SHAPE_LINE_CHAIN::PointCount(), SHAPE_POLY_SET::RemoveAllContours(), LSET::Seq(), BRDITEMS_PLOTTER::SetLayerSet(), SHAPE_POLY_SET::Simplify(), SKETCH, SMALL_DRILL, PCB_PLOT_PARAMS::SMALL_DRILL_SHAPE, PLOTTER::ThickSegment(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PlotOneBoardLayer().

◆ PlotOneBoardLayer()

void PlotOneBoardLayer ( BOARD aBoard,
PLOTTER aPlotter,
PCB_LAYER_ID  aLayer,
const PCB_PLOT_PARAMS aPlotOpt 
)

Function PlotOneBoardLayer main function to plot one copper or technical layer.

It prepare options and calls the specialized plot function, according to the layer type

Parameters
aBoard= the board to plot
aPlotter= the plotter to use
aLayer= the layer id to plot
aPlotOpt= the plot options (files, sketch). Has meaning for some formats only

Definition at line 143 of file plot_board_layers.cpp.

145 {
146  PCB_PLOT_PARAMS plotOpt = aPlotOpt;
147  int soldermask_min_thickness = aBoard->GetDesignSettings().m_SolderMaskMinWidth;
148 
149  // Set a default color and the text mode for this layer
150  aPlotter->SetColor( aPlotOpt.GetColor() );
151  aPlotter->SetTextMode( aPlotOpt.GetTextMode() );
152 
153  // Specify that the contents of the "Edges Pcb" layer are to be plotted
154  // in addition to the contents of the currently specified layer.
155  LSET layer_mask( aLayer );
156 
157  if( !aPlotOpt.GetExcludeEdgeLayer() )
158  layer_mask.set( Edge_Cuts );
159 
160  if( IsCopperLayer( aLayer ) )
161  {
162  // Skip NPTH pads on copper layers ( only if hole size == pad size ):
163  // Drill mark will be plotted,
164  // if drill mark is SMALL_DRILL_SHAPE or FULL_DRILL_SHAPE
165  if( plotOpt.GetFormat() == PLOT_FORMAT_DXF )
166  {
167  plotOpt.SetSkipPlotNPTH_Pads( false );
168  PlotLayerOutlines( aBoard, aPlotter, layer_mask, plotOpt );
169  }
170  else
171  {
172  plotOpt.SetSkipPlotNPTH_Pads( true );
173  PlotStandardLayer( aBoard, aPlotter, layer_mask, plotOpt );
174  }
175  }
176  else
177  {
178  switch( aLayer )
179  {
180  case B_Mask:
181  case F_Mask:
182  plotOpt.SetSkipPlotNPTH_Pads( false );
183  // Disable plot pad holes
185 
186  // Plot solder mask:
187  if( soldermask_min_thickness == 0 )
188  {
189  if( plotOpt.GetFormat() == PLOT_FORMAT_DXF )
190  PlotLayerOutlines( aBoard, aPlotter, layer_mask, plotOpt );
191  else
192  PlotStandardLayer( aBoard, aPlotter, layer_mask, plotOpt );
193  }
194  else
195  PlotSolderMaskLayer( aBoard, aPlotter, layer_mask, plotOpt,
196  soldermask_min_thickness );
197 
198  break;
199 
200  case B_Adhes:
201  case F_Adhes:
202  case B_Paste:
203  case F_Paste:
204  plotOpt.SetSkipPlotNPTH_Pads( false );
205  // Disable plot pad holes
207 
208  if( plotOpt.GetFormat() == PLOT_FORMAT_DXF )
209  PlotLayerOutlines( aBoard, aPlotter, layer_mask, plotOpt );
210  else
211  PlotStandardLayer( aBoard, aPlotter, layer_mask, plotOpt );
212  break;
213 
214  case F_SilkS:
215  case B_SilkS:
216  if( plotOpt.GetFormat() == PLOT_FORMAT_DXF && plotOpt.GetDXFPlotPolygonMode() )
217  // PlotLayerOutlines() is designed only for DXF plotters.
218  // and must not be used for other plot formats
219  PlotLayerOutlines( aBoard, aPlotter, layer_mask, plotOpt );
220  else
221  PlotSilkScreen( aBoard, aPlotter, layer_mask, plotOpt );
222 
223  // Gerber: Subtract soldermask from silkscreen if enabled
224  if( aPlotter->GetPlotterType() == PLOT_FORMAT_GERBER
225  && plotOpt.GetSubtractMaskFromSilk() )
226  {
227  if( aLayer == F_SilkS )
228  layer_mask = LSET( F_Mask );
229  else
230  layer_mask = LSET( B_Mask );
231 
232  // Create the mask to subtract by creating a negative layer polarity
233  aPlotter->SetLayerPolarity( false );
234 
235  // Disable plot pad holes
237 
238  // Plot the mask
239  PlotStandardLayer( aBoard, aPlotter, layer_mask, plotOpt );
240  }
241  break;
242 
243  // These layers are plotted like silk screen layers.
244  // Mainly, pads on these layers are not filled.
245  // This is not necessary the best choice.
246  case Dwgs_User:
247  case Cmts_User:
248  case Eco1_User:
249  case Eco2_User:
250  case Edge_Cuts:
251  case Margin:
252  case F_CrtYd:
253  case B_CrtYd:
254  case F_Fab:
255  case B_Fab:
256  plotOpt.SetSkipPlotNPTH_Pads( false );
258 
259  if( plotOpt.GetFormat() == PLOT_FORMAT_DXF && plotOpt.GetDXFPlotPolygonMode() )
260  // PlotLayerOutlines() is designed only for DXF plotters.
261  // and must not be used for other plot formats
262  PlotLayerOutlines( aBoard, aPlotter, layer_mask, plotOpt );
263  else
264  PlotSilkScreen( aBoard, aPlotter, layer_mask, plotOpt );
265  break;
266 
267  default:
268  plotOpt.SetSkipPlotNPTH_Pads( false );
270 
271  if( plotOpt.GetFormat() == PLOT_FORMAT_DXF && plotOpt.GetDXFPlotPolygonMode() )
272  // PlotLayerOutlines() is designed only for DXF plotters.
273  // and must not be used for other plot formats
274  PlotLayerOutlines( aBoard, aPlotter, layer_mask, plotOpt );
275  else
276  PlotStandardLayer( aBoard, aPlotter, layer_mask, plotOpt );
277  break;
278  }
279  }
280 }
bool GetDXFPlotPolygonMode() const
virtual void SetColor(COLOR4D color)=0
virtual void SetLayerPolarity(bool aPositive)
Function SetLayerPolarity sets current Gerber layer polarity to positive or negative by writing %LPD*...
Definition: plotter.h:419
void PlotStandardLayer(BOARD *aBoard, PLOTTER *aPlotter, LSET aLayerMask, const PCB_PLOT_PARAMS &aPlotOpt)
Function PlotStandardLayer plot copper or technical layers.
PlotFormat GetFormat() const
void PlotSilkScreen(BOARD *aBoard, PLOTTER *aPlotter, LSET aLayerMask, const PCB_PLOT_PARAMS &aPlotOpt)
Function PlotSilkScreen plot silkscreen layers which have specific requirements, mainly for pads.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:534
void SetDrillMarksType(DrillMarksType aVal)
static void PlotSolderMaskLayer(BOARD *aBoard, PLOTTER *aPlotter, LSET aLayerMask, const PCB_PLOT_PARAMS &aPlotOpt, int aMinThickness)
void PlotLayerOutlines(BOARD *aBoard, PLOTTER *aPlotter, LSET aLayerMask, const PCB_PLOT_PARAMS &aPlotOpt)
Function PlotLayerOutlines plot copper outline of a copper layer.
Class LSET is a set of PCB_LAYER_IDs.
virtual void SetTextMode(PlotTextMode mode)
Change the current text mode.
Definition: plotter.h:428
COLOR4D GetColor() const
void SetSkipPlotNPTH_Pads(bool aSkip)
Class PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board.
bool GetSubtractMaskFromSilk() const
virtual PlotFormat GetPlotterType() const =0
Returns the effective plot engine in use.
PlotTextMode GetTextMode() const
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
bool GetExcludeEdgeLayer() const
int m_SolderMaskMinWidth
Solder mask min width.

References B_Adhes, B_CrtYd, B_Fab, B_Mask, B_Paste, B_SilkS, Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_CrtYd, F_Fab, F_Mask, F_Paste, F_SilkS, PCB_PLOT_PARAMS::GetColor(), BOARD::GetDesignSettings(), PCB_PLOT_PARAMS::GetDXFPlotPolygonMode(), PCB_PLOT_PARAMS::GetExcludeEdgeLayer(), PCB_PLOT_PARAMS::GetFormat(), PLOTTER::GetPlotterType(), PCB_PLOT_PARAMS::GetSubtractMaskFromSilk(), PCB_PLOT_PARAMS::GetTextMode(), IsCopperLayer(), BOARD_DESIGN_SETTINGS::m_SolderMaskMinWidth, Margin, PCB_PLOT_PARAMS::NO_DRILL_SHAPE, PLOT_FORMAT_DXF, PLOT_FORMAT_GERBER, PlotLayerOutlines(), PlotSilkScreen(), PlotSolderMaskLayer(), PlotStandardLayer(), PLOTTER::SetColor(), PCB_PLOT_PARAMS::SetDrillMarksType(), PLOTTER::SetLayerPolarity(), PCB_PLOT_PARAMS::SetSkipPlotNPTH_Pads(), and PLOTTER::SetTextMode().

Referenced by DIALOG_EXPORT_SVG::CreateSVGFile(), DIALOG_PLOT::Plot(), and PLOT_CONTROLLER::PlotLayer().

◆ PlotSilkScreen()

void PlotSilkScreen ( BOARD aBoard,
PLOTTER aPlotter,
LSET  aLayerMask,
const PCB_PLOT_PARAMS aPlotOpt 
)

Function PlotSilkScreen plot silkscreen layers which have specific requirements, mainly for pads.

Should not be used for other layers

Parameters
aBoard= the board to plot
aPlotter= the plotter to use
aLayerMask= the mask to define the layers to plot (silkscreen Front and/or Back)
aPlotOpt= the plot options (files, sketch). Has meaning for some formats only

Definition at line 69 of file plot_board_layers.cpp.

71 {
72  BRDITEMS_PLOTTER itemplotter( aPlotter, aBoard, aPlotOpt );
73  itemplotter.SetLayerSet( aLayerMask );
74 
75  // Plot edge layer and graphic items
76  itemplotter.PlotBoardGraphicItems();
77 
78  // Plot footprint outlines :
79  itemplotter.Plot_Edges_Modules();
80 
81  // Plot pads (creates pads outlines, for pads on silkscreen layers)
82  LSET layersmask_plotpads = aLayerMask;
83 
84  // Calculate the mask layers of allowed layers for pads
85 
86  if( !aPlotOpt.GetPlotPadsOnSilkLayer() ) // Do not plot pads on silk screen layers
87  layersmask_plotpads.set( B_SilkS, false ).set( F_SilkS, false );
88 
89  if( layersmask_plotpads.any() )
90  {
91  for( MODULE* Module = aBoard->m_Modules; Module; Module = Module->Next() )
92  {
93  aPlotter->StartBlock( NULL );
94 
95  for( D_PAD* pad = Module->PadsList(); pad; pad = pad->Next() )
96  {
97  // See if the pad is on this layer
98  LSET masklayer = pad->GetLayerSet();
99  if( !( masklayer & layersmask_plotpads ).any() )
100  continue;
101 
103 
104  if( layersmask_plotpads[B_SilkS] )
105  color = aBoard->Colors().GetLayerColor( B_SilkS );
106 
107  if( layersmask_plotpads[F_SilkS] )
108  color = ( color == COLOR4D::BLACK) ? aBoard->Colors().GetLayerColor( F_SilkS ) : color;
109 
110  itemplotter.PlotPad( pad, color, SKETCH );
111  }
112 
113  aPlotter->EndBlock( NULL );
114  }
115  }
116 
117  // Plot footprints fields (ref, value ...)
118  for( MODULE* module = aBoard->m_Modules; module; module = module->Next() )
119  {
120  if( ! itemplotter.PlotAllTextsModule( module ) )
121  {
122  wxLogMessage( _( "Your BOARD has a bad layer number for footprint %s" ),
123  GetChars( module->GetReference() ) );
124  }
125  }
126 
127  // Plot filled areas
128  aPlotter->StartBlock( NULL );
129 
130  for( int ii = 0; ii < aBoard->GetAreaCount(); ii++ )
131  {
132  ZONE_CONTAINER* edge_zone = aBoard->GetArea( ii );
133 
134  if( !aLayerMask[ edge_zone->GetLayer() ] )
135  continue;
136 
137  itemplotter.PlotFilledAreas( edge_zone );
138  }
139 
140  aPlotter->EndBlock( NULL );
141 }
D_PAD * Next() const
Definition: class_pad.h:162
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
virtual void EndBlock(void *aData)
calling this function allows one to define the end of a group of drawing items for instance in SVG or...
Definition: plotter.h:454
int color
Definition: DXF_plotter.cpp:62
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:185
virtual void StartBlock(void *aData)
calling this function allows one to define the beginning of a group of drawing items,...
Definition: plotter.h:445
COLOR4D GetLayerColor(LAYER_NUM aLayer) const
Function GetLayerColor.
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:981
Class LSET is a set of PCB_LAYER_IDs.
const COLORS_DESIGN_SETTINGS & Colors() const
Function GetColorSettings.
Definition: class_board.h:567
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:100
DLIST< MODULE > m_Modules
Definition: class_board.h:248
bool GetPlotPadsOnSilkLayer() const
Definition: colors.h:45
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:952
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References B_SilkS, BLACK, color, BOARD::Colors(), PLOTTER::EndBlock(), F_SilkS, BOARD::GetArea(), BOARD::GetAreaCount(), GetChars(), ZONE_CONTAINER::GetLayer(), COLORS_DESIGN_SETTINGS::GetLayerColor(), PCB_PLOT_PARAMS::GetPlotPadsOnSilkLayer(), BOARD::m_Modules, D_PAD::Next(), BRDITEMS_PLOTTER::Plot_Edges_Modules(), BRDITEMS_PLOTTER::PlotAllTextsModule(), BRDITEMS_PLOTTER::PlotBoardGraphicItems(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::SetLayerSet(), SKETCH, and PLOTTER::StartBlock().

Referenced by PlotOneBoardLayer().

◆ PlotStandardLayer()

void PlotStandardLayer ( BOARD aBoard,
PLOTTER aPlotter,
LSET  aLayerMask,
const PCB_PLOT_PARAMS aPlotOpt 
)

Function PlotStandardLayer plot copper or technical layers.

not used for silk screen layers, because these layers have specific requirements, mainly for pads

Parameters
aBoard= the board to plot
aPlotter= the plotter to use
aLayerMask= the mask to define the layers to plot
aPlotOpt= the plot options (files, sketch). Has meaning for some formats only

aPlotOpt has 3 important options to control this plot, which are set, depending on the layer type to plot SetEnablePlotVia( bool aEnable ) aEnable = true to plot vias, false to skip vias (has meaning only for solder mask layers). SetSkipPlotNPTH_Pads( bool aSkip ) aSkip = true to skip NPTH Pads, when the pad size and the pad hole have the same size. Used in GERBER format only. SetDrillMarksType( DrillMarksType aVal ) controle the actual hole: no hole, small hole, actual hole

Definition at line 286 of file plot_board_layers.cpp.

288 {
289  BRDITEMS_PLOTTER itemplotter( aPlotter, aBoard, aPlotOpt );
290 
291  itemplotter.SetLayerSet( aLayerMask );
292 
293  EDA_DRAW_MODE_T plotMode = aPlotOpt.GetPlotMode();
294 
295  // Plot edge layer and graphic items
296  itemplotter.PlotBoardGraphicItems();
297 
298  // Draw footprint shapes without pads (pads will plotted later)
299  // We plot here module texts, but they are usually on silkscreen layer,
300  // so they are not plot here but plot by PlotSilkScreen()
301  // Plot footprints fields (ref, value ...)
302  for( MODULE* module = aBoard->m_Modules; module; module = module->Next() )
303  {
304  if( ! itemplotter.PlotAllTextsModule( module ) )
305  {
306  wxLogMessage( _( "Your BOARD has a bad layer number for footprint %s" ),
307  GetChars( module->GetReference() ) );
308  }
309  }
310 
311  for( MODULE* module = aBoard->m_Modules; module; module = module->Next() )
312  {
313  for( BOARD_ITEM* item = module->GraphicalItemsList(); item; item = item->Next() )
314  {
315  if( !aLayerMask[ item->GetLayer() ] )
316  continue;
317 
318  switch( item->Type() )
319  {
320  case PCB_MODULE_EDGE_T:
321  itemplotter.Plot_1_EdgeModule( (EDGE_MODULE*) item );
322  break;
323 
324  default:
325  break;
326  }
327  }
328  }
329 
330  // Plot footprint pads
331  for( MODULE* module = aBoard->m_Modules; module; module = module->Next() )
332  {
333  aPlotter->StartBlock( NULL );
334 
335  for( D_PAD* pad = module->PadsList(); pad; pad = pad->Next() )
336  {
337  if( (pad->GetLayerSet() & aLayerMask) == 0 )
338  continue;
339 
340  wxSize margin;
341  double width_adj = 0;
342 
343  if( ( aLayerMask & LSET::AllCuMask() ).any() )
344  width_adj = itemplotter.getFineWidthAdj();
345 
346  static const LSET speed( 4, B_Mask, F_Mask, B_Paste, F_Paste );
347 
348  LSET anded = ( speed & aLayerMask );
349 
350  if( anded == LSET( F_Mask ) || anded == LSET( B_Mask ) )
351  {
352  margin.x = margin.y = pad->GetSolderMaskMargin();
353  }
354  else if( anded == LSET( F_Paste ) || anded == LSET( B_Paste ) )
355  {
356  margin = pad->GetSolderPasteMargin();
357  }
358 
359  // Now offset the pad size by margin + width_adj
360  // this is easy for most shapes, but not for a trapezoid or a custom shape
361  wxSize padPlotsSize;
362  wxSize extraSize = margin * 2;
363  extraSize.x += width_adj;
364  extraSize.y += width_adj;
365  wxSize deltaSize = pad->GetDelta(); // has meaning only for trapezoidal pads
366 
367  if( pad->GetShape() == PAD_SHAPE_TRAPEZOID )
368  { // The easy way is to use BuildPadPolygon to calculate
369  // size and delta of the trapezoidal pad after offseting:
370  wxPoint coord[4];
371  pad->BuildPadPolygon( coord, extraSize/2, 0.0 );
372  // Calculate the size and delta from polygon corners coordinates:
373  // coord[0] is the lower left
374  // coord[1] is the upper left
375  // coord[2] is the upper right
376  // coord[3] is the lower right
377 
378  // the size is the distance between middle of segments
379  // (left/right or top/bottom)
380  // size X is the dist between left and right middle points:
381  padPlotsSize.x = ( ( -coord[0].x + coord[3].x ) // the lower segment X length
382  + ( -coord[1].x + coord[2].x ) ) // the upper segment X length
383  / 2; // the Y size is the half sum
384  // size Y is the dist between top and bottom middle points:
385  padPlotsSize.y = ( ( coord[0].y - coord[1].y ) // the left segment Y lenght
386  + ( coord[3].y - coord[2].y ) ) // the right segment Y lenght
387  / 2; // the Y size is the half sum
388 
389  // calculate the delta ( difference of lenght between 2 opposite edges )
390  // The delta.x is the delta along the X axis, therefore the delta of Y lenghts
391  wxSize delta;
392 
393  if( coord[0].y != coord[3].y )
394  delta.x = coord[0].y - coord[3].y;
395  else
396  delta.y = coord[1].x - coord[0].x;
397 
398  pad->SetDelta( delta );
399  }
400  else
401  padPlotsSize = pad->GetSize() + extraSize;
402 
403  // Don't draw a null size item :
404  if( padPlotsSize.x <= 0 || padPlotsSize.y <= 0 )
405  continue;
406 
408 
409  if( pad->GetLayerSet()[B_Cu] )
410  color = aBoard->Colors().GetItemColor( LAYER_PAD_BK );
411 
412  if( pad->GetLayerSet()[F_Cu] )
413  color = color.LegacyMix( aBoard->Colors().GetItemColor( LAYER_PAD_FR ) );
414 
415  // Temporary set the pad size to the required plot size:
416  wxSize tmppadsize = pad->GetSize();
417 
418  switch( pad->GetShape() )
419  {
420  case PAD_SHAPE_CIRCLE:
421  case PAD_SHAPE_OVAL:
422  pad->SetSize( padPlotsSize );
423 
424  if( aPlotOpt.GetSkipPlotNPTH_Pads() &&
425  ( pad->GetSize() == pad->GetDrillSize() ) &&
426  ( pad->GetAttribute() == PAD_ATTRIB_HOLE_NOT_PLATED ) )
427  break;
428 
429  itemplotter.PlotPad( pad, color, plotMode );
430  break;
431 
432  case PAD_SHAPE_TRAPEZOID:
433  case PAD_SHAPE_RECT:
434  case PAD_SHAPE_ROUNDRECT:
436  pad->SetSize( padPlotsSize );
437  itemplotter.PlotPad( pad, color, plotMode );
438  break;
439 
440  case PAD_SHAPE_CUSTOM:
441  // inflate/deflate a custom shape is a bit complex.
442  // so build a similar pad shape, and inflate/deflate the polygonal shape
443  {
444  // we expect margin.x = margin.y for custom pads
445  if( margin.x < 0 )
446  // be sure the anchor pad is not bigger than the deflated shape
447  // because this anchor will be added to the pad shape when plotting
448  // the pad
449  pad->SetSize( padPlotsSize );
450 
451  D_PAD dummy( *pad );
452  SHAPE_POLY_SET shape;
453  pad->MergePrimitivesAsPolygon( &shape, 64 );
454  // shape polygon can have holes linked to the main outline.
455  // So use InflateWithLinkedHoles(), not Inflate() that can create
456  // bad shapes if margin.x is < 0
459  dummy.DeletePrimitivesList();
460  dummy.AddPrimitive( shape, 0 );
461  dummy.MergePrimitivesAsPolygon();
462 
463  itemplotter.PlotPad( &dummy, color, plotMode );
464  }
465  break;
466  }
467 
468  pad->SetSize( tmppadsize ); // Restore the pad size
469  pad->SetDelta( deltaSize );
470  }
471 
472  aPlotter->EndBlock( NULL );
473  }
474 
475  // Plot vias on copper layers, and if aPlotOpt.GetPlotViaOnMaskLayer() is true,
476  // plot them on solder mask
477 
478  GBR_METADATA gbr_metadata;
479 
480  bool isOnCopperLayer = ( aLayerMask & LSET::AllCuMask() ).any();
481 
482  if( isOnCopperLayer )
483  {
486  }
487 
488  aPlotter->StartBlock( NULL );
489 
490  for( TRACK* track = aBoard->m_Track; track; track = track->Next() )
491  {
492  const VIA* Via = dyn_cast<const VIA*>( track );
493 
494  if( !Via )
495  continue;
496 
497  // vias are not plotted if not on selected layer, but if layer
498  // is SOLDERMASK_LAYER_BACK or SOLDERMASK_LAYER_FRONT,vias are drawn,
499  // only if they are on the corresponding external copper layer
500  LSET via_mask_layer = Via->GetLayerSet();
501 
502  if( aPlotOpt.GetPlotViaOnMaskLayer() )
503  {
504  if( via_mask_layer[B_Cu] )
505  via_mask_layer.set( B_Mask );
506 
507  if( via_mask_layer[F_Cu] )
508  via_mask_layer.set( F_Mask );
509  }
510 
511  if( !( via_mask_layer & aLayerMask ).any() )
512  continue;
513 
514  int via_margin = 0;
515  double width_adj = 0;
516 
517  // If the current layer is a solder mask, use the global mask
518  // clearance for vias
519  if( aLayerMask[B_Mask] || aLayerMask[F_Mask] )
520  via_margin = aBoard->GetDesignSettings().m_SolderMaskMargin;
521 
522  if( ( aLayerMask & LSET::AllCuMask() ).any() )
523  width_adj = itemplotter.getFineWidthAdj();
524 
525  int diameter = Via->GetWidth() + 2 * via_margin + width_adj;
526 
527  // Don't draw a null size item :
528  if( diameter <= 0 )
529  continue;
530 
531  // Some vias can be not connected (no net).
532  // Set the m_NotInNet for these vias to force a empty net name in gerber file
533  gbr_metadata.m_NetlistMetadata.m_NotInNet = Via->GetNetname().IsEmpty();
534 
535  gbr_metadata.SetNetName( Via->GetNetname() );
536 
537  COLOR4D color = aBoard->Colors().GetItemColor( LAYER_VIAS + Via->GetViaType() );
538  // Set plot color (change WHITE to LIGHTGRAY because
539  // the white items are not seen on a white paper or screen
540  aPlotter->SetColor( color != WHITE ? color : LIGHTGRAY);
541  aPlotter->FlashPadCircle( Via->GetStart(), diameter, plotMode, &gbr_metadata );
542  }
543 
544  aPlotter->EndBlock( NULL );
545  aPlotter->StartBlock( NULL );
547 
548  // Plot tracks (not vias) :
549  for( TRACK* track = aBoard->m_Track; track; track = track->Next() )
550  {
551  if( track->Type() == PCB_VIA_T )
552  continue;
553 
554  if( !aLayerMask[track->GetLayer()] )
555  continue;
556 
557  // Some track segments can be not connected (no net).
558  // Set the m_NotInNet for these segments to force a empty net name in gerber file
559  gbr_metadata.m_NetlistMetadata.m_NotInNet = track->GetNetname().IsEmpty();
560 
561  gbr_metadata.SetNetName( track->GetNetname() );
562  int width = track->GetWidth() + itemplotter.getFineWidthAdj();
563  aPlotter->SetColor( itemplotter.getColor( track->GetLayer() ) );
564  aPlotter->ThickSegment( track->GetStart(), track->GetEnd(), width, plotMode, &gbr_metadata );
565  }
566 
567  aPlotter->EndBlock( NULL );
568 
569  // Plot filled ares
570  aPlotter->StartBlock( NULL );
571  for( int ii = 0; ii < aBoard->GetAreaCount(); ii++ )
572  {
573  ZONE_CONTAINER* zone = aBoard->GetArea( ii );
574 
575  if( !aLayerMask[zone->GetLayer()] )
576  continue;
577 
578  itemplotter.PlotFilledAreas( zone );
579  }
580  aPlotter->EndBlock( NULL );
581 
582  // Adding drill marks, if required and if the plotter is able to plot them:
584  itemplotter.PlotDrillMarks();
585 }
D_PAD * Next() const
Definition: class_pad.h:162
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:676
int m_SolderMaskMargin
Solder mask margin.
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
virtual void EndBlock(void *aData)
calling this function allows one to define the end of a group of drawing items for instance in SVG or...
Definition: plotter.h:454
virtual LSET GetLayerSet() const override
Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segme...
like PAD_STANDARD, but not plated mechanical use only, no connection allowed
Definition: pad_shapes.h:66
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
virtual void SetColor(COLOR4D color)=0
const wxPoint & GetStart() const
Definition: class_track.h:133
void SetNetAttribType(int aNetAttribType)
Definition: gbr_metadata.h:152
int color
Definition: DXF_plotter.cpp:62
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:185
virtual void StartBlock(void *aData)
calling this function allows one to define the beginning of a group of drawing items,...
Definition: plotter.h:445
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:534
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
static const int delta[8][2]
Definition: solve.cpp:112
COLOR4D GetItemColor(int aItemIdx) const
Function GetItemColor.
virtual void FlashPadCircle(const wxPoint &aPadPos, int aDiameter, EDA_DRAW_MODE_T aTraceMode, void *aData)=0
virtual function FlashPadCircle
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:981
Class LSET is a set of PCB_LAYER_IDs.
Class SHAPE_POLY_SET.
EDA_DRAW_MODE_T
Definition: eda_text.h:78
VIATYPE_T GetViaType() const
Definition: class_track.h:437
bool GetSkipPlotNPTH_Pads() const
const wxString & GetNetname() const
Function GetNetname.
aperture used for connected items like tracks (not vias)
Definition: gbr_metadata.h:84
void SetNetName(const wxString &aNetname)
Definition: gbr_metadata.h:162
const COLORS_DESIGN_SETTINGS & Colors() const
Function GetColorSettings.
Definition: class_board.h:567
bool GetPlotViaOnMaskLayer() const
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:100
smd pads, front layer
BOARD_ITEM * Next() const
int GetWidth() const
Definition: class_track.h:127
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
DLIST< MODULE > m_Modules
Definition: class_board.h:248
virtual void ThickSegment(const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData)
Definition: plotter.cpp:456
void InflateWithLinkedHoles(int aFactor, int aCircleSegmentsCount, POLYGON_MODE aFastMode)
Performs outline inflation/deflation, using round corners.
Definition: colors.h:49
void SetApertureAttrib(GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB aApertAttribute)
Definition: gbr_metadata.h:142
bool m_NotInNet
true if a pad of a footprint cannot be connected (for instance a mechanical NPTH, ot a not named pad)...
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
DLIST< TRACK > m_Track
Definition: class_board.h:249
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:181
Definition: colors.h:45
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:952
DrillMarksType GetDrillMarksType() const
#define ARC_APPROX_SEGMENTS_COUNT_HIGH_DEF
Definition: pcbnew.h:42
print info associated to a net (TO.N attribute)
EDA_DRAW_MODE_T GetPlotMode() const
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References LSET::AllCuMask(), ARC_APPROX_SEGMENTS_COUNT_HIGH_DEF, B_Cu, B_Mask, B_Paste, BLACK, color, BOARD::Colors(), delta, dummy(), PLOTTER::EndBlock(), F_Cu, F_Mask, F_Paste, PLOTTER::FlashPadCircle(), GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB_CONDUCTOR, GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB_VIAPAD, GBR_NETLIST_METADATA::GBR_NETINFO_NET, BOARD::GetArea(), BOARD::GetAreaCount(), GetChars(), BRDITEMS_PLOTTER::getColor(), BOARD::GetDesignSettings(), PCB_PLOT_PARAMS::GetDrillMarksType(), BRDITEMS_PLOTTER::getFineWidthAdj(), COLORS_DESIGN_SETTINGS::GetItemColor(), ZONE_CONTAINER::GetLayer(), VIA::GetLayerSet(), BOARD_CONNECTED_ITEM::GetNetname(), PCB_PLOT_PARAMS::GetPlotMode(), PCB_PLOT_PARAMS::GetPlotViaOnMaskLayer(), PCB_PLOT_PARAMS::GetSkipPlotNPTH_Pads(), TRACK::GetStart(), VIA::GetViaType(), TRACK::GetWidth(), SHAPE_POLY_SET::InflateWithLinkedHoles(), LAYER_PAD_BK, LAYER_PAD_FR, LAYER_VIAS, LIGHTGRAY, BOARD::m_Modules, GBR_METADATA::m_NetlistMetadata, GBR_NETLIST_METADATA::m_NotInNet, BOARD_DESIGN_SETTINGS::m_SolderMaskMargin, BOARD::m_Track, BOARD_ITEM::Next(), D_PAD::Next(), PCB_PLOT_PARAMS::NO_DRILL_SHAPE, PAD_ATTRIB_HOLE_NOT_PLATED, PAD_SHAPE_CHAMFERED_RECT, PAD_SHAPE_CIRCLE, PAD_SHAPE_CUSTOM, PAD_SHAPE_OVAL, PAD_SHAPE_RECT, PAD_SHAPE_ROUNDRECT, PAD_SHAPE_TRAPEZOID, PCB_MODULE_EDGE_T, PCB_VIA_T, BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::PlotAllTextsModule(), BRDITEMS_PLOTTER::PlotBoardGraphicItems(), BRDITEMS_PLOTTER::PlotDrillMarks(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotPad(), SHAPE_POLY_SET::PM_FAST, GBR_METADATA::SetApertureAttrib(), PLOTTER::SetColor(), BRDITEMS_PLOTTER::SetLayerSet(), GBR_METADATA::SetNetAttribType(), GBR_METADATA::SetNetName(), PLOTTER::StartBlock(), PLOTTER::ThickSegment(), and WHITE.

Referenced by PlotOneBoardLayer().

◆ StartPlotBoard()

PLOTTER* StartPlotBoard ( BOARD aBoard,
PCB_PLOT_PARAMS aPlotOpts,
int  aLayer,
const wxString &  aFullFileName,
const wxString &  aSheetDesc 
)

Open a new plotfile using the options (and especially the format) specified in the options and prepare the page for plotting.

Return the plotter object if OK, NULL if the file is not created (or has a problem)

Definition at line 1029 of file plot_board_layers.cpp.

1033 {
1034  // Create the plotter driver and set the few plotter specific
1035  // options
1036  PLOTTER* plotter = NULL;
1037 
1038  switch( aPlotOpts->GetFormat() )
1039  {
1040  case PLOT_FORMAT_DXF:
1041  plotter = new DXF_PLOTTER();
1042  break;
1043 
1044  case PLOT_FORMAT_POST:
1045  PS_PLOTTER* PS_plotter;
1046  PS_plotter = new PS_PLOTTER();
1047  PS_plotter->SetScaleAdjust( aPlotOpts->GetFineScaleAdjustX(),
1048  aPlotOpts->GetFineScaleAdjustY() );
1049  plotter = PS_plotter;
1050  break;
1051 
1052  case PLOT_FORMAT_PDF:
1053  plotter = new PDF_PLOTTER();
1054  break;
1055 
1056  case PLOT_FORMAT_HPGL:
1057  HPGL_PLOTTER* HPGL_plotter;
1058  HPGL_plotter = new HPGL_PLOTTER();
1059 
1060  /* HPGL options are a little more convoluted to compute, so
1061  they're split in another function */
1062  ConfigureHPGLPenSizes( HPGL_plotter, aPlotOpts );
1063  plotter = HPGL_plotter;
1064  break;
1065 
1066  case PLOT_FORMAT_GERBER:
1067  plotter = new GERBER_PLOTTER();
1068  break;
1069 
1070  case PLOT_FORMAT_SVG:
1071  plotter = new SVG_PLOTTER();
1072  break;
1073 
1074  default:
1075  wxASSERT( false );
1076  return NULL;
1077  }
1078 
1079  // Compute the viewport and set the other options
1080 
1081  // page layout is not mirrored, so temporary change mirror option
1082  // just to plot the page layout
1083  PCB_PLOT_PARAMS plotOpts = *aPlotOpts;
1084 
1085  if( plotOpts.GetPlotFrameRef() && plotOpts.GetMirror() )
1086  plotOpts.SetMirror( false );
1087 
1088  initializePlotter( plotter, aBoard, &plotOpts );
1089 
1090  if( plotter->OpenFile( aFullFileName ) )
1091  {
1092  plotter->ClearHeaderLinesList();
1093 
1094  // For the Gerber "file function" attribute, set the layer number
1095  if( plotter->GetPlotterType() == PLOT_FORMAT_GERBER )
1096  {
1097  bool useX2mode = plotOpts.GetUseGerberX2format();
1098 
1099  GERBER_PLOTTER* gbrplotter = static_cast <GERBER_PLOTTER*> ( plotter );
1100  gbrplotter->UseX2format( useX2mode );
1101  gbrplotter->UseX2NetAttributes( plotOpts.GetIncludeGerberNetlistInfo() );
1102 
1103  // Attributes can be added using X2 format or as comment (X1 format)
1104  AddGerberX2Attribute( plotter, aBoard, aLayer, not useX2mode );
1105  }
1106 
1107  plotter->StartPlot();
1108 
1109  // Plot the frame reference if requested
1110  if( aPlotOpts->GetPlotFrameRef() )
1111  {
1112  PlotWorkSheet( plotter, aBoard->GetTitleBlock(),
1113  aBoard->GetPageSettings(),
1114  1, 1, // Only one page
1115  aSheetDesc, aBoard->GetFileName() );
1116 
1117  if( aPlotOpts->GetMirror() )
1118  initializePlotter( plotter, aBoard, aPlotOpts );
1119  }
1120 
1121  /* When plotting a negative board: draw a black rectangle
1122  * (background for plot board in white) and switch the current
1123  * color to WHITE; note the color inversion is actually done
1124  * in the driver (if supported) */
1125  if( aPlotOpts->GetNegative() )
1126  {
1127  EDA_RECT bbox = aBoard->ComputeBoundingBox();
1128  FillNegativeKnockout( plotter, bbox );
1129  }
1130 
1131  return plotter;
1132  }
1133 
1134  delete plotter;
1135  return NULL;
1136 }
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:549
void UseX2NetAttributes(bool aEnable)
Definition: plotter.h:1157
bool GetPlotFrameRef() const
static void initializePlotter(PLOTTER *aPlotter, BOARD *aBoard, PCB_PLOT_PARAMS *aPlotOpts)
Set up most plot options for plotting a board (especially the viewport) Important thing: page size is...
virtual bool StartPlot()=0
static void FillNegativeKnockout(PLOTTER *aPlotter, const EDA_RECT &aBbbox)
Prefill in black an area a little bigger than the board to prepare for the negative plot.
virtual bool OpenFile(const wxString &aFullFilename)
Open or create the plot file aFullFilename.
Definition: plotter.cpp:79
void SetScaleAdjust(double scaleX, double scaleY)
Set the 'fine' scaling for the postscript engine.
Definition: plotter.h:684
PlotFormat GetFormat() const
void SetMirror(bool aFlag)
void UseX2format(bool aEnable)
Definition: plotter.h:1156
void AddGerberX2Attribute(PLOTTER *aPlotter, const BOARD *aBoard, LAYER_NUM aLayer, bool aUseX1CompatibilityMode)
Calculates some X2 attributes, as defined in the Gerber file format specification and add them to the...
Definition: pcbplot.cpp:352
const wxString & GetFileName() const
Definition: class_board.h:237
bool GetUseGerberX2format() const
void PlotWorkSheet(PLOTTER *plotter, const TITLE_BLOCK &aTitleBlock, const PAGE_INFO &aPageInfo, int aSheetNumber, int aNumberOfSheets, const wxString &aSheetDesc, const wxString &aFilename)
bool GetMirror() const
bool GetIncludeGerberNetlistInfo() const
static void ConfigureHPGLPenSizes(HPGL_PLOTTER *aPlotter, PCB_PLOT_PARAMS *aPlotOpts)
Calculate the effective size of HPGL pens and set them in the plotter object.
Class PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board.
double GetFineScaleAdjustX() const
Base plotter engine class.
Definition: plotter.h:97
TITLE_BLOCK & GetTitleBlock()
Definition: class_board.h:555
virtual PlotFormat GetPlotterType() const =0
Returns the effective plot engine in use.
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void ClearHeaderLinesList()
Function ClearHeaderLinesList remove all lines from the list of free lines to print at the beginning ...
Definition: plotter.h:185
EDA_RECT ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Function ComputeBoundingBox calculates the bounding box containing all board items (or board edge seg...
double GetFineScaleAdjustY() const
bool GetNegative() const

References AddGerberX2Attribute(), PLOTTER::ClearHeaderLinesList(), BOARD::ComputeBoundingBox(), ConfigureHPGLPenSizes(), FillNegativeKnockout(), BOARD::GetFileName(), PCB_PLOT_PARAMS::GetFineScaleAdjustX(), PCB_PLOT_PARAMS::GetFineScaleAdjustY(), PCB_PLOT_PARAMS::GetFormat(), PCB_PLOT_PARAMS::GetIncludeGerberNetlistInfo(), PCB_PLOT_PARAMS::GetMirror(), PCB_PLOT_PARAMS::GetNegative(), BOARD::GetPageSettings(), PCB_PLOT_PARAMS::GetPlotFrameRef(), PLOTTER::GetPlotterType(), BOARD::GetTitleBlock(), PCB_PLOT_PARAMS::GetUseGerberX2format(), initializePlotter(), PLOTTER::OpenFile(), PLOT_FORMAT_DXF, PLOT_FORMAT_GERBER, PLOT_FORMAT_HPGL, PLOT_FORMAT_PDF, PLOT_FORMAT_POST, PLOT_FORMAT_SVG, PlotWorkSheet(), PCB_PLOT_PARAMS::SetMirror(), PSLIKE_PLOTTER::SetScaleAdjust(), PLOTTER::StartPlot(), GERBER_PLOTTER::UseX2format(), and GERBER_PLOTTER::UseX2NetAttributes().

Referenced by DIALOG_EXPORT_SVG::CreateSVGFile(), PLOT_CONTROLLER::OpenPlotfile(), and DIALOG_PLOT::Plot().