KiCad PCB EDA Suite
pcbplot.h File Reference

Board plot function definition file. More...

#include <layers_id_colors_and_visibility.h>
#include <math/util.h>
#include <pad_shapes.h>
#include <pcb_plot_params.h>
#include <pgm_base.h>
#include <settings/color_settings.h>
#include <settings/settings_manager.h>
#include <wx/filename.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 )
 

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 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 57 of file pcbplot.h.

◆ PLOT_MIN_SCALE

#define PLOT_MIN_SCALE   0.01

Definition at line 56 of file pcbplot.h.

◆ SMALL_DRILL

#define SMALL_DRILL   KiROUND( 0.35 * IU_PER_MM )

Definition at line 60 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 354 of file pcbplot.cpp.

356 {
357  AddGerberX2Header( aPlotter, aBoard, aUseX1CompatibilityMode );
358 
359  wxString text;
360 
361  // Add the TF.FileFunction
362  text = GetGerberFileFunctionAttribute( aBoard, aLayer );
363  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
364 
365  // Add the TF.FilePolarity (for layers which support that)
366  text = GetGerberFilePolarityAttribute( aLayer );
367 
368  if( !text.IsEmpty() )
369  aPlotter->AddLineToHeader( makeStringCompatX1( text, aUseX1CompatibilityMode ) );
370 }
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:282
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:169
static const wxString GetGerberFilePolarityAttribute(LAYER_NUM aLayer)
Definition: pcbplot.cpp:211
static wxString & makeStringCompatX1(wxString &aText, bool aUseX1CompatibilityMode)
Definition: pcbplot.cpp:270
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 282 of file pcbplot.cpp.

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

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

◆ 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 373 of file pcbplot.cpp.

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

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 = "OtherDrawing,Comment";
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  // This is actually a assembly layer
152  attrib = "AssemblyDrawing,Bot";
153  break;
154 
155  case F_Fab:
156  // This is actually a assembly layer
157  attrib = "AssemblyDrawing,Top";
158  break;
159 
160  case B_Cu:
161  attrib.Printf( wxT( "Copper,L%d,Bot" ), aBoard->GetCopperLayerCount() );
162  break;
163 
164  case F_Cu:
165  attrib = "Copper,L1,Top";
166  break;
167 
168  default:
169  if( IsCopperLayer( aLayer ) )
170  attrib.Printf( wxT( "Copper,L%d,Inr" ), aLayer+1 );
171  else
172  attrib.Printf( wxT( "Other,User" ), aLayer+1 );
173  break;
174  }
175 
176  // This code adds a optional parameter: the type of copper layers.
177  // Because it is not used by Pcbnew (it can be used only by external autorouters)
178  // user do not really set this parameter.
179  // Therefore do not add it.
180  // However, this code is left here, for perhaps a future usage.
181 #if 0
182  // Add the signal type of the layer, if relevant
183  if( IsCopperLayer( aLayer ) )
184  {
185  LAYER_T type = aBoard->GetLayerType( ToLAYER_ID( aLayer ) );
186 
187  switch( type )
188  {
189  case LT_SIGNAL:
190  attrib += ",Signal";
191  break;
192  case LT_POWER:
193  attrib += ",Plane";
194  break;
195  case LT_MIXED:
196  attrib += ",Mixed";
197  break;
198  default:
199  break; // do nothing (but avoid a warning for unhandled LAYER_T values from GCC)
200  }
201  }
202 #endif
203 
204  wxString fileFct;
205  fileFct.Printf( "%%TF.FileFunction,%s*%%", GetChars( attrib ) );
206 
207  return fileFct;
208 }
LAYER_T
Enum LAYER_T gives the allowed types of layers, same as Specctra DSN spec.
Definition: class_board.h:67
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:153
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:847

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 627 of file plot_board_layers.cpp.

629 {
630 
631  BRDITEMS_PLOTTER itemplotter( aPlotter, aBoard, aPlotOpt );
632  itemplotter.SetLayerSet( aLayerMask );
633 
634  SHAPE_POLY_SET outlines;
635 
636  for( LSEQ seq = aLayerMask.Seq( plot_seq, arrayDim( plot_seq ) ); seq; ++seq )
637  {
638  PCB_LAYER_ID layer = *seq;
639 
640  outlines.RemoveAllContours();
641  aBoard->ConvertBrdLayerToPolygonalContours( layer, outlines );
642 
643  outlines.Simplify( SHAPE_POLY_SET::PM_FAST );
644 
645  // Plot outlines
646  std::vector< wxPoint > cornerList;
647 
648  // Now we have one or more basic polygons: plot each polygon
649  for( int ii = 0; ii < outlines.OutlineCount(); ii++ )
650  {
651  for(int kk = 0; kk <= outlines.HoleCount (ii); kk++ )
652  {
653  cornerList.clear();
654  const SHAPE_LINE_CHAIN& path = (kk == 0) ? outlines.COutline( ii ) : outlines.CHole( ii, kk - 1 );
655 
656  for( int jj = 0; jj < path.PointCount(); jj++ )
657  cornerList.emplace_back( (wxPoint) path.CPoint( jj ) );
658 
659  // Ensure the polygon is closed
660  if( cornerList[0] != cornerList[cornerList.size() - 1] )
661  cornerList.push_back( cornerList[0] );
662 
663  aPlotter->PlotPoly( cornerList, NO_FILL );
664  }
665  }
666 
667  // Plot pad holes
669  {
670  int smallDrill = (aPlotOpt.GetDrillMarksType() == PCB_PLOT_PARAMS::SMALL_DRILL_SHAPE)
671  ? SMALL_DRILL : INT_MAX;
672 
673  for( auto module : aBoard->Modules() )
674  {
675  for( auto pad : module->Pads() )
676  {
677  wxSize hole = pad->GetDrillSize();
678 
679  if( hole.x == 0 || hole.y == 0 )
680  continue;
681 
682  if( hole.x == hole.y )
683  {
684  hole.x = std::min( smallDrill, hole.x );
685  aPlotter->Circle( pad->GetPosition(), hole.x, NO_FILL );
686  }
687  else
688  {
689  // Note: small drill marks have no significance when applied to slots
690  wxPoint drl_start, drl_end;
691  int width;
692 
693  pad->GetOblongGeometry( pad->GetDrillSize(), &drl_start, &drl_end, &width );
694  aPlotter->ThickSegment( pad->GetPosition() + drl_start,
695  pad->GetPosition() + drl_end, width, SKETCH, NULL );
696  }
697  }
698  }
699  }
700 
701  // Plot vias holes
702  for( auto track : aBoard->Tracks() )
703  {
704  const VIA* via = dyn_cast<const VIA*>( track );
705 
706  if( via && via->IsOnLayer( layer ) ) // via holes can be not through holes
707  {
708  aPlotter->Circle( via->GetPosition(), via->GetDrillValue(), NO_FILL );
709  }
710  }
711  }
712 }
#define SMALL_DRILL
Definition: pcbplot.h:60
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:377
const VECTOR2I & CPoint(int aIndex) const
Function Point()
PCB_LAYER_ID
A quick note on layer IDs:
#define NULL
int GetDrillValue() const
Function GetDrillValue "calculates" the drill value for vias (m-Drill if > 0, or default drill value ...
MODULES & Modules()
Definition: class_board.h:256
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:408
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:160
SHAPE_LINE_CHAIN.
virtual void ThickSegment(const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData)
Definition: plotter.cpp:507
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Function IsOnLayer tests to see if this object is on the given layer.
DrillMarksType GetDrillMarksType() const
TRACKS & Tracks()
Definition: class_board.h:247
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0

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::Modules(), PCB_PLOT_PARAMS::NO_DRILL_SHAPE, NO_FILL, NULL, 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(), and BOARD::Tracks().

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 65 of file plot_board_layers.cpp.

67 {
68  PCB_PLOT_PARAMS plotOpt = aPlotOpt;
69  int soldermask_min_thickness = aBoard->GetDesignSettings().m_SolderMaskMinWidth;
70 
71  // Set a default color and the text mode for this layer
72  aPlotter->SetColor( aPlotOpt.GetColor() );
73  aPlotter->SetTextMode( aPlotOpt.GetTextMode() );
74 
75  // Specify that the contents of the "Edges Pcb" layer are to be plotted in addition to the
76  // contents of the currently specified layer.
77  LSET layer_mask( aLayer );
78 
79  if( !aPlotOpt.GetExcludeEdgeLayer() )
80  layer_mask.set( Edge_Cuts );
81 
82  if( IsCopperLayer( aLayer ) )
83  {
84  // Skip NPTH pads on copper layers ( only if hole size == pad size ):
85  // Drill mark will be plotted if drill mark is SMALL_DRILL_SHAPE or FULL_DRILL_SHAPE
86  if( plotOpt.GetFormat() == PLOT_FORMAT::DXF )
87  {
88  plotOpt.SetSkipPlotNPTH_Pads( false );
89  PlotLayerOutlines( aBoard, aPlotter, layer_mask, plotOpt );
90  }
91  else
92  {
93  plotOpt.SetSkipPlotNPTH_Pads( true );
94  PlotStandardLayer( aBoard, aPlotter, layer_mask, plotOpt );
95  }
96  }
97  else
98  {
99  switch( aLayer )
100  {
101  case B_Mask:
102  case F_Mask:
103  plotOpt.SetSkipPlotNPTH_Pads( false );
104  // Disable plot pad holes
106 
107  // Plot solder mask:
108  if( soldermask_min_thickness == 0 )
109  {
110  if( plotOpt.GetFormat() == PLOT_FORMAT::DXF )
111  PlotLayerOutlines( aBoard, aPlotter, layer_mask, plotOpt );
112  else
113  PlotStandardLayer( aBoard, aPlotter, layer_mask, plotOpt );
114  }
115  else
116  PlotSolderMaskLayer( aBoard, aPlotter, layer_mask, plotOpt,
117  soldermask_min_thickness );
118 
119  break;
120 
121  case B_Adhes:
122  case F_Adhes:
123  case B_Paste:
124  case F_Paste:
125  plotOpt.SetSkipPlotNPTH_Pads( false );
126  // Disable plot pad holes
128 
129  if( plotOpt.GetFormat() == PLOT_FORMAT::DXF )
130  PlotLayerOutlines( aBoard, aPlotter, layer_mask, plotOpt );
131  else
132  PlotStandardLayer( aBoard, aPlotter, layer_mask, plotOpt );
133  break;
134 
135  case F_SilkS:
136  case B_SilkS:
137  if( plotOpt.GetFormat() == PLOT_FORMAT::DXF && plotOpt.GetDXFPlotPolygonMode() )
138  // PlotLayerOutlines() is designed only for DXF plotters.
139  // and must not be used for other plot formats
140  PlotLayerOutlines( aBoard, aPlotter, layer_mask, plotOpt );
141  else
142  PlotStandardLayer( aBoard, aPlotter, layer_mask, plotOpt );
143 
144  // Gerber: Subtract soldermask from silkscreen if enabled
145  if( aPlotter->GetPlotterType() == PLOT_FORMAT::GERBER
146  && plotOpt.GetSubtractMaskFromSilk() )
147  {
148  if( aLayer == F_SilkS )
149  layer_mask = LSET( F_Mask );
150  else
151  layer_mask = LSET( B_Mask );
152 
153  // Create the mask to subtract by creating a negative layer polarity
154  aPlotter->SetLayerPolarity( false );
155 
156  // Disable plot pad holes
158 
159  // Plot the mask
160  PlotStandardLayer( aBoard, aPlotter, layer_mask, plotOpt );
161  }
162  break;
163 
164  // These layers are plotted like silk screen layers.
165  // Mainly, pads on these layers are not filled.
166  // This is not necessary the best choice.
167  case Dwgs_User:
168  case Cmts_User:
169  case Eco1_User:
170  case Eco2_User:
171  case Edge_Cuts:
172  case Margin:
173  case F_CrtYd:
174  case B_CrtYd:
175  case F_Fab:
176  case B_Fab:
177  plotOpt.SetSkipPlotNPTH_Pads( false );
179 
180  if( plotOpt.GetFormat() == PLOT_FORMAT::DXF && plotOpt.GetDXFPlotPolygonMode() )
181  // PlotLayerOutlines() is designed only for DXF plotters.
182  // and must not be used for other plot formats
183  PlotLayerOutlines( aBoard, aPlotter, layer_mask, plotOpt );
184  else
185  PlotStandardLayer( aBoard, aPlotter, layer_mask, plotOpt );
186  break;
187 
188  default:
189  plotOpt.SetSkipPlotNPTH_Pads( false );
191 
192  if( plotOpt.GetFormat() == PLOT_FORMAT::DXF && plotOpt.GetDXFPlotPolygonMode() )
193  // PlotLayerOutlines() is designed only for DXF plotters.
194  // and must not be used for other plot formats
195  PlotLayerOutlines( aBoard, aPlotter, layer_mask, plotOpt );
196  else
197  PlotStandardLayer( aBoard, aPlotter, layer_mask, plotOpt );
198  break;
199  }
200  }
201 }
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:436
void PlotStandardLayer(BOARD *aBoard, PLOTTER *aPlotter, LSET aLayerMask, const PCB_PLOT_PARAMS &aPlotOpt)
Function PlotStandardLayer plot copper or technical layers.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:542
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.
LSET is a set of PCB_LAYER_IDs.
PLOT_FORMAT GetFormat() const
virtual PLOT_FORMAT GetPlotterType() const =0
Returns the effective plot engine in use.
COLOR4D GetColor() const
virtual void SetTextMode(PLOT_TEXT_MODE mode)
Change the current text mode.
Definition: plotter.h:445
void SetSkipPlotNPTH_Pads(bool aSkip)
PLOT_TEXT_MODE GetTextMode() const
PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board.
bool GetSubtractMaskFromSilk() 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, DXF, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_CrtYd, F_Fab, F_Mask, F_Paste, F_SilkS, GERBER, 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, PlotLayerOutlines(), 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().

◆ 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 207 of file plot_board_layers.cpp.

209 {
210  BRDITEMS_PLOTTER itemplotter( aPlotter, aBoard, aPlotOpt );
211 
212  itemplotter.SetLayerSet( aLayerMask );
213 
214  EDA_DRAW_MODE_T plotMode = aPlotOpt.GetPlotMode();
215  bool onCopperLayer = ( LSET::AllCuMask() & aLayerMask ).any();
216  bool onSolderMaskLayer = ( LSET( 2, F_Mask, B_Mask ) & aLayerMask ).any();
217  bool onSolderPasteLayer = ( LSET( 2, F_Paste, B_Paste ) & aLayerMask ).any();
218  bool onFabLayer = ( LSET( 2, F_Fab, B_Fab ) & aLayerMask ).any();
219  bool sketchPads = onFabLayer && aPlotOpt.GetSketchPadsOnFabLayers();
220 
221  // Plot edge layer and graphic items
222  itemplotter.PlotBoardGraphicItems();
223 
224  // Draw footprint texts:
225  for( MODULE* module : aBoard->Modules() )
226  itemplotter.PlotFootprintTextItems( module );
227 
228  // Draw footprint other graphic items:
229  for( MODULE* module : aBoard->Modules() )
230  itemplotter.PlotFootprintGraphicItems( module );
231 
232  // Plot footprint pads
233  for( MODULE* module : aBoard->Modules() )
234  {
235  aPlotter->StartBlock( NULL );
236 
237  for( D_PAD* pad : module->Pads() )
238  {
239  EDA_DRAW_MODE_T padPlotMode = plotMode;
240 
241  if( !( pad->GetLayerSet() & aLayerMask ).any() )
242  {
243  if( sketchPads )
244  padPlotMode = SKETCH;
245  else
246  continue;
247  }
248 
249  wxSize margin;
250  double width_adj = 0;
251 
252  if( onCopperLayer )
253  width_adj = itemplotter.getFineWidthAdj();
254 
255  if( onSolderMaskLayer )
256  margin.x = margin.y = pad->GetSolderMaskMargin();
257 
258  if( onSolderPasteLayer )
259  margin = pad->GetSolderPasteMargin();
260 
261  // Now offset the pad size by margin + width_adj
262  // this is easy for most shapes, but not for a trapezoid or a custom shape
263  wxSize padPlotsSize;
264  wxSize extraSize = margin * 2;
265  extraSize.x += width_adj;
266  extraSize.y += width_adj;
267 
268  // Store these parameters that can be modified to plot inflated/deflated pads shape
269  wxSize deltaSize = pad->GetDelta(); // has meaning only for trapezoidal pads
270  PAD_SHAPE_T padShape = pad->GetShape();
271  double padCornerRadius = pad->GetRoundRectCornerRadius();
272 
273  if( pad->GetShape() == PAD_SHAPE_TRAPEZOID )
274  { // The easy way is to use BuildPadPolygon to calculate
275  // size and delta of the trapezoidal pad after offseting:
276  wxPoint coord[4];
277  pad->BuildPadPolygon( coord, extraSize/2, 0.0 );
278  // Calculate the size and delta from polygon corners coordinates:
279  // coord[0] is the lower left
280  // coord[1] is the upper left
281  // coord[2] is the upper right
282  // coord[3] is the lower right
283 
284  // the size is the distance between middle of segments
285  // (left/right or top/bottom)
286  // size X is the dist between left and right middle points:
287  padPlotsSize.x = ( ( -coord[0].x + coord[3].x ) // the lower segment X length
288  + ( -coord[1].x + coord[2].x ) ) // the upper segment X length
289  / 2; // the Y size is the half sum
290  // size Y is the dist between top and bottom middle points:
291  padPlotsSize.y = ( ( coord[0].y - coord[1].y ) // the left segment Y lenght
292  + ( coord[3].y - coord[2].y ) ) // the right segment Y lenght
293  / 2; // the Y size is the half sum
294 
295  // calculate the delta ( difference of lenght between 2 opposite edges )
296  // The delta.x is the delta along the X axis, therefore the delta of Y lenghts
297  wxSize delta;
298 
299  if( coord[0].y != coord[3].y )
300  delta.x = coord[0].y - coord[3].y;
301  else
302  delta.y = coord[1].x - coord[0].x;
303 
304  pad->SetDelta( delta );
305  }
306  else
307  padPlotsSize = pad->GetSize() + extraSize;
308 
309  // Don't draw a null size item :
310  if( padPlotsSize.x <= 0 || padPlotsSize.y <= 0 )
311  continue;
312 
314 
315  if( pad->GetLayerSet()[B_Cu] )
316  color = aPlotOpt.ColorSettings()->GetColor( LAYER_PAD_BK );
317 
318  if( pad->GetLayerSet()[F_Cu] )
319  color = color.LegacyMix( aPlotOpt.ColorSettings()->GetColor( LAYER_PAD_FR ) );
320 
321  if( sketchPads && aLayerMask[F_Fab] )
322  color = aPlotOpt.ColorSettings()->GetColor( F_Fab );
323  else if( sketchPads && aLayerMask[B_Fab] )
324  color = aPlotOpt.ColorSettings()->GetColor( B_Fab );
325 
326  // Temporary set the pad size to the required plot size:
327  wxSize tmppadsize = pad->GetSize();
328 
329  switch( pad->GetShape() )
330  {
331  case PAD_SHAPE_CIRCLE:
332  case PAD_SHAPE_OVAL:
333  pad->SetSize( padPlotsSize );
334 
335  if( aPlotOpt.GetSkipPlotNPTH_Pads() &&
337  ( pad->GetSize() == pad->GetDrillSize() ) &&
338  ( pad->GetAttribute() == PAD_ATTRIB_HOLE_NOT_PLATED ) )
339  break;
340 
341  itemplotter.PlotPad( pad, color, padPlotMode );
342  break;
343 
344  case PAD_SHAPE_RECT:
345  if( margin.x > 0 )
346  {
347  pad->SetShape( PAD_SHAPE_ROUNDRECT );
348  pad->SetSize( padPlotsSize );
349  pad->SetRoundRectCornerRadius( margin.x );
350  }
352 
353  case PAD_SHAPE_TRAPEZOID:
354  case PAD_SHAPE_ROUNDRECT:
356  pad->SetSize( padPlotsSize );
357  itemplotter.PlotPad( pad, color, padPlotMode );
358  break;
359 
360  case PAD_SHAPE_CUSTOM:
361  {
362  // inflate/deflate a custom shape is a bit complex.
363  // so build a similar pad shape, and inflate/deflate the polygonal shape
364  D_PAD dummy( *pad );
365  SHAPE_POLY_SET shape;
366  pad->MergePrimitivesAsPolygon( &shape );
367  // Shape polygon can have holes so use InflateWithLinkedHoles(), not Inflate()
368  // which can create bad shapes if margin.x is < 0
369  int maxError = aBoard->GetDesignSettings().m_MaxError;
370  int numSegs = std::max( GetArcToSegmentCount( margin.x, maxError, 360.0 ), 6 );
371  shape.InflateWithLinkedHoles( margin.x, numSegs, SHAPE_POLY_SET::PM_FAST );
372  dummy.DeletePrimitivesList();
373  dummy.AddPrimitivePoly( shape, 0, false );
374  dummy.MergePrimitivesAsPolygon();
375 
376  // Be sure the anchor pad is not bigger than the deflated shape because this
377  // anchor will be added to the pad shape when plotting the pad. So now the
378  // polygonal shape is built, we can clamp the anchor size
379  if( margin.x < 0 ) // we expect margin.x = margin.y for custom pads
380  dummy.SetSize( padPlotsSize );
381 
382  itemplotter.PlotPad( &dummy, color, padPlotMode );
383  }
384  break;
385  }
386 
387  // Restore the pad parameters modified by the plot code
388  pad->SetSize( tmppadsize );
389  pad->SetDelta( deltaSize );
390  pad->SetShape( padShape );
391  pad->SetRoundRectCornerRadius( padCornerRadius );
392  }
393 
394  aPlotter->EndBlock( NULL );
395  }
396 
397  // Plot vias on copper layers, and if aPlotOpt.GetPlotViaOnMaskLayer() is true,
398  // plot them on solder mask
399 
400  GBR_METADATA gbr_metadata;
401 
402  bool isOnCopperLayer = ( aLayerMask & LSET::AllCuMask() ).any();
403 
404  if( isOnCopperLayer )
405  {
408  }
409 
410  aPlotter->StartBlock( NULL );
411 
412  for( auto track : aBoard->Tracks() )
413  {
414  const VIA* Via = dyn_cast<const VIA*>( track );
415 
416  if( !Via )
417  continue;
418 
419  // vias are not plotted if not on selected layer, but if layer is SOLDERMASK_LAYER_BACK
420  // or SOLDERMASK_LAYER_FRONT, vias are drawn only if they are on the corresponding
421  // external copper layer
422  LSET via_mask_layer = Via->GetLayerSet();
423 
424  if( aPlotOpt.GetPlotViaOnMaskLayer() )
425  {
426  if( via_mask_layer[B_Cu] )
427  via_mask_layer.set( B_Mask );
428 
429  if( via_mask_layer[F_Cu] )
430  via_mask_layer.set( F_Mask );
431  }
432 
433  if( !( via_mask_layer & aLayerMask ).any() )
434  continue;
435 
436  int via_margin = 0;
437  double width_adj = 0;
438 
439  // If the current layer is a solder mask, use the global mask clearance for vias
440  if( aLayerMask[B_Mask] || aLayerMask[F_Mask] )
441  via_margin = aBoard->GetDesignSettings().m_SolderMaskMargin;
442 
443  if( ( aLayerMask & LSET::AllCuMask() ).any() )
444  width_adj = itemplotter.getFineWidthAdj();
445 
446  int diameter = Via->GetWidth() + 2 * via_margin + width_adj;
447 
448  // Don't draw a null size item :
449  if( diameter <= 0 )
450  continue;
451 
452  // Some vias can be not connected (no net).
453  // Set the m_NotInNet for these vias to force a empty net name in gerber file
454  gbr_metadata.m_NetlistMetadata.m_NotInNet = Via->GetNetname().IsEmpty();
455 
456  gbr_metadata.SetNetName( Via->GetNetname() );
457 
458  COLOR4D color = aPlotOpt.ColorSettings()->GetColor(
459  LAYER_VIAS + static_cast<int>( Via->GetViaType() ) );
460  // Set plot color (change WHITE to LIGHTGRAY because the white items are not seen on a
461  // white paper or screen
462  aPlotter->SetColor( color != WHITE ? color : LIGHTGRAY );
463  aPlotter->FlashPadCircle( Via->GetStart(), diameter, plotMode, &gbr_metadata );
464  }
465 
466  aPlotter->EndBlock( NULL );
467  aPlotter->StartBlock( NULL );
469 
470  // Plot tracks (not vias) :
471  for( auto track : aBoard->Tracks() )
472  {
473  if( track->Type() == PCB_VIA_T )
474  continue;
475 
476  if( !aLayerMask[track->GetLayer()] )
477  continue;
478 
479  // Some track segments can be not connected (no net).
480  // Set the m_NotInNet for these segments to force a empty net name in gerber file
481  gbr_metadata.m_NetlistMetadata.m_NotInNet = track->GetNetname().IsEmpty();
482 
483  gbr_metadata.SetNetName( track->GetNetname() );
484  int width = track->GetWidth() + itemplotter.getFineWidthAdj();
485  aPlotter->SetColor( itemplotter.getColor( track->GetLayer() ) );
486 
487  if( track->Type() == PCB_ARC_T )
488  {
489  ARC* arc = static_cast<ARC*>( track );
490  VECTOR2D center( arc->GetCenter() );
491  auto radius = arc->GetRadius();
492  auto start_angle = arc->GetArcAngleStart();
493  auto end_angle = start_angle + arc->GetAngle();
494 
495  aPlotter->ThickArc( wxPoint( center.x, center.y ), -end_angle, -start_angle,
496  radius, width, plotMode, &gbr_metadata );
497  }
498  else
499  aPlotter->ThickSegment( track->GetStart(), track->GetEnd(), width, plotMode, &gbr_metadata );
500  }
501 
502  aPlotter->EndBlock( NULL );
503 
504  // Plot filled ares
505  aPlotter->StartBlock( NULL );
506 
507  // Plot all zones of the same layer & net together so we don't end up with divots where
508  // zones touch each other.
509  std::set<ZONE_CONTAINER*> plotted;
510 
511  for( ZONE_CONTAINER* zone : aBoard->Zones() )
512  {
513  if( !aLayerMask[ zone->GetLayer() ] || plotted.count( zone ) )
514  continue;
515 
516  plotted.insert( zone );
517 
518  SHAPE_POLY_SET aggregateArea = zone->GetFilledPolysList();
519  bool needFracture = false; // If 2 or more filled areas are combined, resulting
520  // aggregateArea will be simplified and fractured
521  // (Long calculation time)
522 
523  for( ZONE_CONTAINER* candidate : aBoard->Zones() )
524  {
525  if( !aLayerMask[ candidate->GetLayer() ] || plotted.count( candidate ) )
526  continue;
527 
528  if( candidate->GetNetCode() != zone->GetNetCode() )
529  continue;
530 
531  // Merging zones of the same net can be done only for areas
532  // having compatible settings for drawings:
533  // use or not outline thickness, and if using outline thickness,
534  // having the same thickness
535  // because after merging only one outline thickness is used
536  if( candidate->GetFilledPolysUseThickness() != zone->GetFilledPolysUseThickness() )
537  // Should not happens, because usually the same option is used for filling
538  continue;
539 
540  if( zone->GetFilledPolysUseThickness() &&
541  ( candidate->GetMinThickness() != zone->GetMinThickness() ) )
542  continue;
543 
544  plotted.insert( candidate );
545  aggregateArea.Append( candidate->GetFilledPolysList() );
546  needFracture = true;
547  }
548 
549  if( needFracture )
550  {
553  }
554 
555  itemplotter.PlotFilledAreas( zone, aggregateArea );
556  }
557  aPlotter->EndBlock( NULL );
558 
559  // Adding drill marks, if required and if the plotter is able to plot them:
561  itemplotter.PlotDrillMarks();
562 }
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:710
int m_SolderMaskMargin
Solder mask margin.
ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
#define KI_FALLTHROUGH
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:476
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
virtual void SetColor(COLOR4D color)=0
const wxPoint & GetStart() const
Definition: class_track.h:118
void SetNetAttribType(int aNetAttribType)
Definition: gbr_metadata.h:170
int color
Definition: DXF_plotter.cpp:61
virtual void StartBlock(void *aData)
calling this function allows one to define the beginning of a group of drawing items,...
Definition: plotter.h:467
class ARC, an arc track segment on a copper layer
Definition: typeinfo.h:98
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:542
PAD_SHAPE_T
Enum PAD_SHAPE_T is the set of pad shapes, used with D_PAD::{Set,Get}Shape()
Definition: pad_shapes.h:31
virtual void ThickArc(const wxPoint &centre, double StAngle, double EndAngle, int rayon, int width, EDA_DRAW_MODE_T tracemode, void *aData)
Definition: plotter.cpp:531
virtual void FlashPadCircle(const wxPoint &aPadPos, int aDiameter, EDA_DRAW_MODE_T aTraceMode, void *aData)=0
virtual function FlashPadCircle
LSET is a set of PCB_LAYER_IDs.
#define NULL
MODULES & Modules()
Definition: class_board.h:256
SHAPE_POLY_SET.
EDA_DRAW_MODE_T
Definition: eda_text.h:62
bool GetSkipPlotNPTH_Pads() const
double GetRadius() const
const wxString & GetNetname() const
Function GetNetname.
void Fracture(POLYGON_MODE aFastMode)
Converts a set of polygons with holes to a singe outline with "slits"/"fractures" connecting the oute...
aperture used for connected items like tracks (not vias)
Definition: gbr_metadata.h:84
double GetAngle() const
void SetNetName(const wxString &aNetname)
Definition: gbr_metadata.h:180
COLOR4D GetColor(int aLayer) const
bool GetSketchPadsOnFabLayers() const
ZONE_CONTAINERS & Zones()
Definition: class_board.h:270
bool GetPlotViaOnMaskLayer() const
smd pads, front layer
int GetWidth() const
Definition: class_track.h:112
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
virtual void ThickSegment(const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData)
Definition: plotter.cpp:507
VIATYPE GetViaType() const
Definition: class_track.h:370
void InflateWithLinkedHoles(int aFactor, int aCircleSegmentsCount, POLYGON_MODE aFastMode)
Performs outline inflation/deflation, using round corners.
Definition: colors.h:49
virtual const wxPoint GetCenter() const
Function GetCenter()
void SetApertureAttrib(GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB aApertAttribute)
Definition: gbr_metadata.h:160
COLOR_SETTINGS * ColorSettings() const
double GetArcAngleStart() const
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:97
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:212
Definition: colors.h:45
DrillMarksType GetDrillMarksType() const
print info associated to a net (TO.N attribute)
int GetArcToSegmentCount(int aRadius, int aErrorMax, double aArcAngleDegree)
TRACKS & Tracks()
Definition: class_board.h:247
EDA_DRAW_MODE_T GetPlotMode() const
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline)
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:40
void Unfracture(POLYGON_MODE aFastMode)
Converts a single outline slitted ("fractured") polygon into a set ouf outlines with holes.

References LSET::AllCuMask(), SHAPE_POLY_SET::Append(), B_Cu, B_Fab, B_Mask, B_Paste, BLACK, color, PCB_PLOT_PARAMS::ColorSettings(), dummy(), PLOTTER::EndBlock(), F_Cu, F_Fab, F_Mask, F_Paste, PLOTTER::FlashPadCircle(), SHAPE_POLY_SET::Fracture(), GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB_CONDUCTOR, GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB_VIAPAD, GBR_NETLIST_METADATA::GBR_NETINFO_NET, ARC::GetAngle(), ARC::GetArcAngleStart(), GetArcToSegmentCount(), BOARD_ITEM::GetCenter(), COLOR_SETTINGS::GetColor(), BRDITEMS_PLOTTER::getColor(), BOARD::GetDesignSettings(), PCB_PLOT_PARAMS::GetDrillMarksType(), BRDITEMS_PLOTTER::getFineWidthAdj(), VIA::GetLayerSet(), BOARD_CONNECTED_ITEM::GetNetname(), PCB_PLOT_PARAMS::GetPlotMode(), PCB_PLOT_PARAMS::GetPlotViaOnMaskLayer(), ARC::GetRadius(), PCB_PLOT_PARAMS::GetSketchPadsOnFabLayers(), PCB_PLOT_PARAMS::GetSkipPlotNPTH_Pads(), TRACK::GetStart(), VIA::GetViaType(), TRACK::GetWidth(), SHAPE_POLY_SET::InflateWithLinkedHoles(), KI_FALLTHROUGH, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_VIAS, LIGHTGRAY, BOARD_DESIGN_SETTINGS::m_MaxError, GBR_METADATA::m_NetlistMetadata, GBR_NETLIST_METADATA::m_NotInNet, BOARD_DESIGN_SETTINGS::m_SolderMaskMargin, BOARD::Modules(), PCB_PLOT_PARAMS::NO_DRILL_SHAPE, NULL, 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_ARC_T, PCB_VIA_T, BRDITEMS_PLOTTER::PlotBoardGraphicItems(), BRDITEMS_PLOTTER::PlotDrillMarks(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BRDITEMS_PLOTTER::PlotPad(), SHAPE_POLY_SET::PM_FAST, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, GBR_METADATA::SetApertureAttrib(), PLOTTER::SetColor(), BRDITEMS_PLOTTER::SetLayerSet(), GBR_METADATA::SetNetAttribType(), GBR_METADATA::SetNetName(), SKETCH, PLOTTER::StartBlock(), PLOTTER::ThickArc(), PLOTTER::ThickSegment(), BOARD::Tracks(), SHAPE_POLY_SET::Unfracture(), WHITE, wxPoint::x, wxPoint::y, and BOARD::Zones().

Referenced by PlotOneBoardLayer(), and PlotSolderMaskLayer().

◆ 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 1073 of file plot_board_layers.cpp.

1075 {
1076  // Create the plotter driver and set the few plotter specific options
1077  PLOTTER* plotter = NULL;
1078 
1079  switch( aPlotOpts->GetFormat() )
1080  {
1081  case PLOT_FORMAT::DXF:
1082  DXF_PLOTTER* DXF_plotter;
1083  DXF_plotter = new DXF_PLOTTER();
1084  DXF_plotter->SetUnits(
1085  static_cast<DXF_PLOTTER::DXF_UNITS>( aPlotOpts->GetDXFPlotUnits() ) );
1086 
1087  plotter = DXF_plotter;
1088  break;
1089 
1090  case PLOT_FORMAT::POST:
1091  PS_PLOTTER* PS_plotter;
1092  PS_plotter = new PS_PLOTTER();
1093  PS_plotter->SetScaleAdjust( aPlotOpts->GetFineScaleAdjustX(),
1094  aPlotOpts->GetFineScaleAdjustY() );
1095  plotter = PS_plotter;
1096  break;
1097 
1098  case PLOT_FORMAT::PDF:
1099  plotter = new PDF_PLOTTER();
1100  break;
1101 
1102  case PLOT_FORMAT::HPGL:
1103  HPGL_PLOTTER* HPGL_plotter;
1104  HPGL_plotter = new HPGL_PLOTTER();
1105 
1106  // HPGL options are a little more convoluted to compute, so they get their own function
1107  ConfigureHPGLPenSizes( HPGL_plotter, aPlotOpts );
1108  plotter = HPGL_plotter;
1109  break;
1110 
1111  case PLOT_FORMAT::GERBER:
1112  plotter = new GERBER_PLOTTER();
1113  break;
1114 
1115  case PLOT_FORMAT::SVG:
1116  plotter = new SVG_PLOTTER();
1117  break;
1118 
1119  default:
1120  wxASSERT( false );
1121  return NULL;
1122  }
1123 
1125  renderSettings->LoadColors( aPlotOpts->ColorSettings() );
1126  plotter->SetRenderSettings( renderSettings );
1127 
1128  // Compute the viewport and set the other options
1129 
1130  // page layout is not mirrored, so temporarily change mirror option for the page layout
1131  PCB_PLOT_PARAMS plotOpts = *aPlotOpts;
1132 
1133  if( plotOpts.GetPlotFrameRef() && plotOpts.GetMirror() )
1134  plotOpts.SetMirror( false );
1135 
1136  initializePlotter( plotter, aBoard, &plotOpts );
1137 
1138  if( plotter->OpenFile( aFullFileName ) )
1139  {
1140  plotter->ClearHeaderLinesList();
1141 
1142  // For the Gerber "file function" attribute, set the layer number
1143  if( plotter->GetPlotterType() == PLOT_FORMAT::GERBER )
1144  {
1145  bool useX2mode = plotOpts.GetUseGerberX2format();
1146 
1147  GERBER_PLOTTER* gbrplotter = static_cast <GERBER_PLOTTER*> ( plotter );
1148  gbrplotter->UseX2format( useX2mode );
1149  gbrplotter->UseX2NetAttributes( plotOpts.GetIncludeGerberNetlistInfo() );
1150 
1151  // Attributes can be added using X2 format or as comment (X1 format)
1152  AddGerberX2Attribute( plotter, aBoard, aLayer, not useX2mode );
1153  }
1154 
1155  plotter->StartPlot();
1156 
1157  // Plot the frame reference if requested
1158  if( aPlotOpts->GetPlotFrameRef() )
1159  {
1160  PlotWorkSheet( plotter, aBoard->GetProject(), aBoard->GetTitleBlock(),
1161  aBoard->GetPageSettings(), 1, 1, aSheetDesc, aBoard->GetFileName() );
1162 
1163  if( aPlotOpts->GetMirror() )
1164  initializePlotter( plotter, aBoard, aPlotOpts );
1165  }
1166 
1167  // When plotting a negative board: draw a black rectangle (background for plot board
1168  // in white) and switch the current color to WHITE; note the color inversion is actually
1169  // done in the driver (if supported)
1170  if( aPlotOpts->GetNegative() )
1171  {
1172  EDA_RECT bbox = aBoard->ComputeBoundingBox();
1173  FillNegativeKnockout( plotter, bbox );
1174  }
1175 
1176  return plotter;
1177  }
1178 
1179  delete plotter->RenderSettings();
1180  delete plotter;
1181  return NULL;
1182 }
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:557
virtual void LoadColors(const COLOR_SETTINGS *aSettings) override
Definition: pcb_painter.cpp:76
void UseX2NetAttributes(bool aEnable)
Definition: plotter.h:1292
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:77
void SetScaleAdjust(double scaleX, double scaleY)
Set the 'fine' scaling for the postscript engine.
Definition: plotter.h:706
void SetRenderSettings(RENDER_SETTINGS *aSettings)
Definition: plotter.h:136
PROJECT * GetProject() const
Definition: class_board.h:356
void SetMirror(bool aFlag)
void UseX2format(bool aEnable)
Definition: plotter.h:1291
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:354
void SetUnits(DXF_UNITS aUnit)
Set the units to use for plotting the DXF file.
const wxString & GetFileName() const
Definition: class_board.h:245
bool GetUseGerberX2format() const
bool GetMirror() const
PCB_RENDER_SETTINGS Stores PCB specific render settings.
Definition: pcb_painter.h:60
PLOT_FORMAT GetFormat() const
#define NULL
void PlotWorkSheet(PLOTTER *plotter, const PROJECT *aProject, const TITLE_BLOCK &aTitleBlock, const PAGE_INFO &aPageInfo, int aSheetNumber, int aNumberOfSheets, const wxString &aSheetDesc, const wxString &aFilename, COLOR4D aColor)
virtual PLOT_FORMAT GetPlotterType() const =0
Returns the effective plot engine in use.
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.
PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board.
double GetFineScaleAdjustX() const
Base plotter engine class.
Definition: plotter.h:104
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:137
TITLE_BLOCK & GetTitleBlock()
Definition: class_board.h:563
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:178
EDA_RECT ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Function ComputeBoundingBox calculates the bounding box containing all board items (or board edge seg...
double GetFineScaleAdjustY() const
COLOR_SETTINGS * ColorSettings() const
bool GetNegative() const
DXF_PLOTTER::DXF_UNITS GetDXFPlotUnits() const

References AddGerberX2Attribute(), PLOTTER::ClearHeaderLinesList(), PCB_PLOT_PARAMS::ColorSettings(), BOARD::ComputeBoundingBox(), ConfigureHPGLPenSizes(), DXF, FillNegativeKnockout(), GERBER, PCB_PLOT_PARAMS::GetDXFPlotUnits(), 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::GetProject(), BOARD::GetTitleBlock(), PCB_PLOT_PARAMS::GetUseGerberX2format(), HPGL, initializePlotter(), KIGFX::PCB_RENDER_SETTINGS::LoadColors(), NULL, PLOTTER::OpenFile(), PDF, PlotWorkSheet(), POST, PLOTTER::RenderSettings(), PCB_PLOT_PARAMS::SetMirror(), PLOTTER::SetRenderSettings(), PSLIKE_PLOTTER::SetScaleAdjust(), DXF_PLOTTER::SetUnits(), PLOTTER::StartPlot(), SVG, GERBER_PLOTTER::UseX2format(), and GERBER_PLOTTER::UseX2NetAttributes().

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