KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_plotter.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20#include <pcb_plotter.h>
21#include <common.h>
22#include <plotters/plotter.h>
24#include <board.h>
25#include <board_loader.h>
26#include <footprint.h>
27#include <pad.h>
28#include <project.h>
30#include <reporter.h>
31#include <pcbplot.h>
32#include <wx/filename.h>
41#include <pgm_base.h>
42#include <pcbnew_settings.h>
44#include <math/util.h> // for KiROUND
45
46
47static int scaleToSelection( double scale )
48{
49 int selection = 1;
50
51 if( scale == 0.0 ) selection = 0;
52 else if( scale == 1.5 ) selection = 2;
53 else if( scale == 2.0 ) selection = 3;
54 else if( scale == 3.0 ) selection = 4;
55
56 return selection;
57}
58
59
60PCB_PLOTTER::PCB_PLOTTER( BOARD* aBoard, REPORTER* aReporter, PCB_PLOT_PARAMS& aParams ) :
61 m_board( aBoard ),
62 m_plotOpts( aParams ),
63 m_reporter( aReporter )
64{
65}
66
67
68bool PCB_PLOTTER::Plot( const wxString& aOutputPath, const LSEQ& aLayersToPlot,
69 const LSEQ& aCommonLayers, bool aUseGerberFileExtensions,
70 bool aPlotAllLayersToSingleFile, bool aForceAllLayersToSinglePage,
71 std::optional<wxString> aLayerName, std::optional<wxString> aSheetName,
72 std::optional<wxString> aSheetPath,
73 std::vector<wxString>* aOutputFiles )
74{
75 std::function<bool( wxString* )> textResolver =
76 [&]( wxString* token ) -> bool
77 {
78 // Handles board->GetTitleBlock() *and* board->GetProject()
79 return m_board->ResolveTextVar( token, 0 );
80 };
81
82 // sanity, ensure one layer to print
83 if( aLayersToPlot.size() < 1 )
84 {
85 if( m_reporter )
86 m_reporter->Report( _( "No layers selected for plotting." ), RPT_SEVERITY_ERROR );
87
88 return false;
89 }
90
92
93 PAGE_INFO existingPageInfo = m_board->GetPageSettings();
94 VECTOR2I existingAuxOrigin = m_board->GetDesignSettings().GetAuxOrigin();
95
96 if( m_plotOpts.GetSvgFitPagetoBoard() ) // Page is board boundary size
97 {
98 BOX2I bbox = m_board->ComputeBoundingBox( false, false );
99 SHAPE_POLY_SET boardOutlines;
100
101 // Board outline geometry is better if it exists so that origin is not influenced by Edge.Cuts line width
102 if( m_board->GetBoardPolygonOutlines( boardOutlines, false ) && boardOutlines.OutlineCount() > 0 )
103 bbox = boardOutlines.BBox();
104
105 PAGE_INFO currPageInfo = m_board->GetPageSettings();
106
107 currPageInfo.SetWidthMils( bbox.GetWidth() / pcbIUScale.IU_PER_MILS );
108 currPageInfo.SetHeightMils( bbox.GetHeight() / pcbIUScale.IU_PER_MILS );
109
110 m_board->SetPageSettings( currPageInfo );
111 m_plotOpts.SetUseAuxOrigin( true );
112
113 // Keep the origin at the board origin so it lands on the SVG origin. The SVG
114 // plotter was given the bounding box to build its viewBox from elsewhere.
115 m_board->GetDesignSettings().SetAuxOrigin( VECTOR2I( 0, 0 ) );
116 }
117
118 // To reuse logic, in single plot mode, we want to kick any extra layers from the main list to commonLayers
119 LSEQ layersToPlot;
120 LSEQ commonLayers;
121
122 if( aPlotAllLayersToSingleFile && aForceAllLayersToSinglePage )
123 {
124 layersToPlot.push_back( aLayersToPlot[0] );
125
126 if( aLayersToPlot.size() > 1 )
127 commonLayers.insert( commonLayers.end(), aLayersToPlot.begin() + 1, aLayersToPlot.end() );
128 }
129 else
130 {
131 layersToPlot = aLayersToPlot;
132 commonLayers = aCommonLayers;
133 }
134
135 int finalPageCount = 0;
136 std::vector<std::pair<PCB_LAYER_ID, wxString>> layersToExport;
137
138 // Skip the disabled copper layers and build the layer ID -> layer name mapping for plotter
139 // DXF plotter will use this information to name its layers
140 for( PCB_LAYER_ID layer : layersToPlot )
141 {
142 if( copperLayerShouldBeSkipped( layer ) )
143 continue;
144
145 finalPageCount++;
146 layersToExport.emplace_back( layer, m_board->GetLayerName( layer ) );
147 }
148
149 std::unique_ptr<GERBER_JOBFILE_WRITER> jobfile_writer;
150
151 if( m_plotOpts.GetFormat() == PLOT_FORMAT::GERBER && !aPlotAllLayersToSingleFile )
152 jobfile_writer = std::make_unique<GERBER_JOBFILE_WRITER>( m_board, m_reporter );
153
154 PLOT_FORMAT plot_format = m_plotOpts.GetFormat();
155 wxString fileExt( GetDefaultPlotExtension( m_plotOpts.GetFormat() ) );
156 wxString sheetPath;
157 wxString msg;
158 bool success = true;
159 PLOTTER* plotter = nullptr;
160 int pageNum = 1;
161
162 for( size_t i = 0; i < layersToPlot.size(); i++ )
163 {
164 PCB_LAYER_ID layer = layersToPlot[i];
165
166 if( copperLayerShouldBeSkipped( layer ) )
167 continue;
168
169 LSEQ plotSequence = getPlotSequence( layer, commonLayers );
170 wxString layerName = m_board->GetLayerName( layer );
171 wxFileName fn;
172
173 if( aPlotAllLayersToSingleFile )
174 {
175 fn = wxFileName( aOutputPath );
176 }
177 else
178 {
179 wxFileName brdFn = m_board->GetFileName();
180 fn.Assign( aOutputPath, brdFn.GetName(), fileExt );
181
182 // Use Gerber Extensions based on layer number
183 // (See http://en.wikipedia.org/wiki/Gerber_File)
184 if( m_plotOpts.GetFormat() == PLOT_FORMAT::GERBER && aUseGerberFileExtensions )
185 fileExt = GetGerberProtelExtension( layer );
186
187 if( plot_format == PLOT_FORMAT::PDF && aPlotAllLayersToSingleFile )
189 else if ( plot_format == PLOT_FORMAT::DXF && aPlotAllLayersToSingleFile )
191 else
192 BuildPlotFileName( &fn, aOutputPath, layerName, fileExt );
193 }
194
195 if( jobfile_writer )
196 {
197 wxString fullname = fn.GetFullName();
198 jobfile_writer->AddGbrFile( layer, fullname );
199 }
200
201 if( !aPlotAllLayersToSingleFile || pageNum == 1 )
202 {
203 wxString pageNumber = wxString::Format( "%d", pageNum ); // this will only be used by pdf
204 wxString pageName = layerName;
205 wxString sheetName = layerName;
206
207 if( aLayerName.has_value() )
208 {
209 layerName = aLayerName.value();
210 pageName = aLayerName.value();
211 }
212
213 if( aSheetName.has_value() )
214 sheetName = aSheetName.value();
215
216 if( aSheetPath.has_value() )
217 sheetPath = aSheetPath.value();
218
219 m_plotOpts.SetLayersToExport( layersToExport );
220 plotter = StartPlotBoard( m_board, &m_plotOpts, layer, layerName, fn.GetFullPath(),
221 sheetName, sheetPath, pageName, pageNumber, finalPageCount );
222 }
223
224 if( plotter )
225 {
226 plotter->SetLayer( layer );
227 plotter->SetTitle( ExpandTextVars( m_board->GetTitleBlock().GetTitle(), &textResolver, FOR_GUI ) );
228
229 if( m_plotOpts.m_PDFMetadata )
230 {
231 msg = wxS( "AUTHOR" );
232
233 if( m_board->ResolveTextVar( &msg, 0 ) )
234 plotter->SetAuthor( msg );
235
236 msg = wxS( "SUBJECT" );
237
238 if( m_board->ResolveTextVar( &msg, 0 ) )
239 plotter->SetSubject( msg );
240 }
241
242 try
243 {
244 PlotBoardLayers( m_board, plotter, plotSequence, m_plotOpts );
246 }
247 catch( ... )
248 {
249 success = false;
250 delete plotter->RenderSettings();
251 delete plotter;
252 plotter = nullptr;
253 break;
254 }
255
256 if( m_plotOpts.GetFormat() == PLOT_FORMAT::PDF
257 && aPlotAllLayersToSingleFile && !aForceAllLayersToSinglePage && pageNum != finalPageCount )
258 {
259 wxString pageNumber = wxString::Format( "%d", pageNum + 1 );
260 size_t nextI = i + 1;
261 PCB_LAYER_ID nextLayer = layersToPlot[nextI];
262
263 while( copperLayerShouldBeSkipped( nextLayer ) && nextI < layersToPlot.size() - 1 )
264 {
265 ++nextI;
266 nextLayer = layersToPlot[nextI];
267 }
268
269 layerName = m_board->GetLayerName( nextLayer );
270
271 wxString pageName = layerName;
272 wxString sheetName = layerName;
273
274 static_cast<PDF_PLOTTER*>( plotter )->ClosePage();
275 static_cast<PDF_PLOTTER*>( plotter )->StartPage( pageNumber, pageName );
276 setupPlotterNewPDFPage( plotter, m_board, &m_plotOpts, layerName, sheetName,
277 sheetPath, pageNumber, finalPageCount );
278 }
279
280 if( !aPlotAllLayersToSingleFile || i == aLayersToPlot.size() - 1 || pageNum == finalPageCount )
281 {
282 try
283 {
284 success &= plotter->EndPlot();
285 }
286 catch( ... )
287 {
288 success = false;
289 }
290
291 delete plotter->RenderSettings();
292 delete plotter;
293 plotter = nullptr;
294
295 if( m_reporter )
296 {
297 m_reporter->Report( wxString::Format( _( "Plotted to '%s'." ), fn.GetFullPath() ),
299 }
300
301 if( aOutputFiles )
302 aOutputFiles->push_back( fn.GetFullPath() );
303 }
304 }
305 else
306 {
307 if( m_reporter )
308 {
309 m_reporter->Report( wxString::Format( _( "Failed to create file '%s'." ), fn.GetFullPath() ),
311 }
312
313 success = false;
314 }
315
316 pageNum++;
317
318 wxSafeYield(); // displays report message.
319 }
320
321 if( jobfile_writer && m_plotOpts.GetCreateGerberJobFile() )
322 {
323 // Pick the basename from the board file
324 wxFileName fn( m_board->GetFileName() );
325
326 // Build gerber job file from basename
327 BuildPlotFileName( &fn, aOutputPath, wxT( "job" ), FILEEXT::GerberJobFileExtension );
328 jobfile_writer->CreateJobFile( fn.GetFullPath() );
329
330 if( aOutputFiles )
331 aOutputFiles->push_back( fn.GetFullPath() );
332 }
333
334 if( m_reporter )
335 m_reporter->ReportTail( _( "Done." ), RPT_SEVERITY_INFO );
336
337 if( m_plotOpts.GetFormat() == PLOT_FORMAT::SVG && m_plotOpts.GetSvgFitPagetoBoard() )
338 {
339 // restore the original page and aux origin
340 m_board->SetPageSettings( existingPageInfo );
341 m_board->GetDesignSettings().SetAuxOrigin( existingAuxOrigin );
342 }
343
344 return success;
345}
346
347
349{
350 return ( LSET::AllCuMask() & ~m_board->GetEnabledLayers() )[aLayerToPlot];
351}
352
353
354LSET PCB_PLOTTER::DialogLayerSelection( const LSET& aChecked, const LSET& aEnabledLayers, bool aForJob )
355{
356 LSET shown = aChecked & aEnabledLayers;
357
358 if( aForJob )
359 return shown;
360
361 return shown | ( LSET::AllCuMask() & ~aEnabledLayers );
362}
363
364
365void PCB_PLOTTER::BuildPlotFileName( wxFileName* aFilename, const wxString& aOutputDir,
366 const wxString& aSuffix, const wxString& aExtension )
367{
368 // aFilename contains the base filename only (without path and extension)
369 // when calling this function.
370 // It is expected to be a valid filename (this is usually the board filename)
371 aFilename->SetPath( aOutputDir );
372
373 // Set the file extension
374 aFilename->SetExt( aExtension );
375
376 // remove leading and trailing spaces if any from the suffix, if
377 // something survives add it to the name;
378 // also the suffix can contain some not allowed chars in filename (/ \ . : and some others),
379 // so change them to underscore
380 // Remember it can be called from a python script, so the illegal chars
381 // have to be filtered here.
382 wxString suffix = aSuffix;
383 suffix.Trim( true );
384 suffix.Trim( false );
385
386 wxString badchars = wxFileName::GetForbiddenChars( wxPATH_DOS );
387 badchars.Append( "%." );
388
389 for( unsigned ii = 0; ii < badchars.Len(); ii++ )
390 suffix.Replace( badchars[ii], wxT( "_" ) );
391
392 if( !suffix.IsEmpty() )
393 aFilename->SetName( aFilename->GetName() + wxT( "-" ) + suffix );
394}
395
396
397LSEQ PCB_PLOTTER::getPlotSequence( PCB_LAYER_ID aLayerToPlot, LSEQ aPlotWithAllLayersSeq )
398{
399 LSEQ plotSequence;
400
401 // Base layer always gets plotted first.
402 plotSequence.push_back( aLayerToPlot );
403
404 for( PCB_LAYER_ID layer : aPlotWithAllLayersSeq )
405 {
406 // Don't plot the same layer more than once;
407 if( find( plotSequence.begin(), plotSequence.end(), layer ) != plotSequence.end() )
408 continue;
409
410 plotSequence.push_back( layer );
411 }
412
413 return plotSequence;
414}
415
416
418 REPORTER& aReporter )
419{
421 {
422 JOB_EXPORT_PCB_GERBERS* gJob = static_cast<JOB_EXPORT_PCB_GERBERS*>( aJob );
425 aOpts.SetUseGerberX2format( gJob->m_useX2Format );
428 aOpts.SetGerberPrecision( gJob->m_precision );
429 // Always disable plot pad holes
431 }
432 else
433 {
434 // Scale, doesn't apply to GERBER
435 aOpts.SetScale( aJob->m_scale );
436 aOpts.SetAutoScale( !aJob->m_scale );
438 // Drill marks doesn't apply to GERBER
439 switch( aJob->m_drillShapeOption )
440 {
443 default:
445 }
446 }
447
449 {
450 JOB_EXPORT_PCB_SVG* svgJob = static_cast<JOB_EXPORT_PCB_SVG*>( aJob );
451 aOpts.SetSvgPrecision( svgJob->m_precision );
452 aOpts.SetSvgFitPageToBoard( svgJob->m_fitPageToBoard );
453 }
454
456 {
457 JOB_EXPORT_PCB_DXF* dxfJob = static_cast<JOB_EXPORT_PCB_DXF*>( aJob );
459 : DXF_UNITS::MM );
462 aOpts.SetDXFPlotPolygonMode( dxfJob->m_polygonMode );
465 }
466
468 {
469 JOB_EXPORT_PCB_PDF* pdfJob = static_cast<JOB_EXPORT_PCB_PDF*>( aJob );
472 aOpts.m_PDFMetadata = pdfJob->m_pdfMetadata;
473 aOpts.m_PDFSingle = pdfJob->m_pdfSingle;
475 }
476
478 {
479 JOB_EXPORT_PCB_PS* psJob = static_cast<JOB_EXPORT_PCB_PS*>( aJob );
480 aOpts.SetWidthAdjust( KiROUND( psJob->m_trackWidthCorrection * pcbIUScale.IU_PER_MM ) );
481 aOpts.SetFineScaleAdjustX( psJob->m_XScaleAdjust );
482 aOpts.SetFineScaleAdjustY( psJob->m_YScaleAdjust );
483 aOpts.SetA4Output( psJob->m_forceA4 );
484 }
485
486 wxString theme = aJob->m_colorTheme;
487
488 // Theme may be empty when running from a job in GUI context, so use the GUI settings.
489 if( theme.IsEmpty() )
490 {
491 if( PCBNEW_SETTINGS* pcbSettings = GetAppSettings<PCBNEW_SETTINGS>( "pcbnew" ) )
492 theme = pcbSettings->m_ColorTheme;
493 }
494
495 COLOR_SETTINGS* colors = ::GetColorSettings( theme );
496
497 if( colors->GetFilename() != theme && !aOpts.GetBlackAndWhite() )
498 {
499 aReporter.Report( wxString::Format( _( "Color theme '%s' not found, will use theme from PCB Editor.\n" ),
500 theme ),
502 }
503
505 {
506 JOB_EXPORT_PCB_PNG* pngJob = static_cast<JOB_EXPORT_PCB_PNG*>( aJob );
507 aOpts.SetPngDPI( pngJob->m_dpi );
508 aOpts.SetPngAntialias( pngJob->m_antialias );
509
510 if( pngJob->m_useBackgroundColor )
512 }
513
514 aOpts.SetUseAuxOrigin( aJob->m_useDrillOrigin );
515 aOpts.SetPlotFrameRef( aJob->m_plotDrawingSheet );
517 aOpts.SetPlotReference( aJob->m_plotRefDes );
518 aOpts.SetPlotValue( aJob->m_plotFootprintValues );
523 aOpts.SetPlotPadNumbers( aJob->m_plotPadNumbers );
524
525 aOpts.SetBlackAndWhite( aJob->m_blackAndWhite );
526 aOpts.SetMirror( aJob->m_mirror );
527 aOpts.SetNegative( aJob->m_negative );
528
531
532 switch( aJob->m_plotFormat )
533 {
534 default:
539 case JOB_EXPORT_PCB_PLOT::PLOT_FORMAT::HPGL: /* no longer supported */ break;
542 }
543
544 aOpts.SetColorSettings( colors );
546}
547
548
549bool PlotFootprintToSVG( const FOOTPRINT& aFootprint, PROJECT& aProject,
550 const std::map<wxString, wxString>* aVarOverrides, PCB_PLOT_PARAMS& aPlotOpts,
551 const LSEQ& aLayersToPlot, const LSEQ& aLayersOnAll, const wxString& aFileName,
552 REPORTER* aReporter )
553{
554 // Plot the footprint by placing it at the origin of a temporary board; the SVG
555 // fit-to-board options make the footprint origin land on the SVG origin and size the
556 // page/viewBox to the footprint's bounding box.
557
558 // The hack for now is we create fake boards containing the footprint and plot the board
559 // until we refactor better plot api later
560 std::unique_ptr<BOARD> brd = BOARD_LOADER::CreateEmptyBoard( &aProject );
561
562 if( aVarOverrides )
563 brd->GetProject()->ApplyTextVars( *aVarOverrides );
564
565 brd->SynchronizeProperties();
566
567 FOOTPRINT* fp = dynamic_cast<FOOTPRINT*>( aFootprint.Clone() );
568
569 if( fp == nullptr )
570 return false;
571
572 fp->SetLink( niluuid );
573 fp->SetFlags( IS_NEW );
574 fp->SetParent( brd.get() );
575
576 for( PAD* pad : fp->Pads() )
577 {
578 pad->SetLocalRatsnestVisible( false );
579 pad->SetNetCode( 0 );
580 }
581
582 fp->SetOrientation( ANGLE_0 );
583 fp->SetPosition( VECTOR2I( 0, 0 ) );
584
585 brd->Add( fp, ADD_MODE::INSERT, true );
586
587 aPlotOpts.SetFormat( PLOT_FORMAT::SVG );
588 aPlotOpts.SetPlotFrameRef( false );
589 aPlotOpts.SetSvgFitPageToBoard( true );
590 aPlotOpts.SetMirror( false );
591 aPlotOpts.SetSkipPlotNPTH_Pads( false );
592
593 PCB_PLOTTER plotter( brd.get(), aReporter, aPlotOpts );
594 bool useGerberFileExtensions = false;
595 bool singleFile = true;
596 bool forceAllLayersToOnePage = false;
597
598 return plotter.Plot( aFileName, aLayersToPlot, aLayersOnAll, useGerberFileExtensions, singleFile,
599 forceAllLayersToOnePage, wxEmptyString, wxEmptyString, wxEmptyString );
600}
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:128
BOX2< VECTOR2I > BOX2I
Definition box2.h:917
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition box2.h:985
static std::unique_ptr< BOARD > CreateEmptyBoard(PROJECT *aProject)
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:411
constexpr size_type GetWidth() const
Definition box2.h:217
constexpr size_type GetHeight() const
Definition box2.h:218
Color settings are a bit different than most of the settings objects in that there can be more than o...
COLOR4D GetColor(int aLayer) const
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition eda_item.h:158
virtual void SetParent(EDA_ITEM *aParent)
Definition eda_item.cpp:153
void SetPosition(const VECTOR2I &aPos) override
void SetLink(const KIID &aLink)
Definition footprint.h:1157
void SetOrientation(const EDA_ANGLE &aNewAngle)
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
std::deque< PAD * > & Pads()
Definition footprint.h:355
wxString m_pdfBackgroundColor
The background color specified in a hex string.
bool m_useDrillOrigin
Used by SVG/DXF/PDF/Gerbers.
LSEQ m_plotOnAllLayersSequence
Layers to include on all individual layer prints.
DRILL_MARKS m_drillShapeOption
Used by SVG & PDF.
bool m_mirror
Common Options.
wxString GetConfiguredOutputPath() const
Returns the configured output path for the job.
Definition job.h:235
wxString GetFilename() const
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:101
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
Definition lseq.h:47
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
static const LSET & AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition lset.cpp:604
static LSET AllCuMask(int aCuLayerCount)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition lset.cpp:595
Definition pad.h:61
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition page_info.h:75
void SetHeightMils(double aHeightInMils)
void SetWidthMils(double aWidthInMils)
LSEQ getPlotSequence(PCB_LAYER_ID aLayerToPlot, LSEQ aPlotWithAllLayersSeq)
Generates a final LSEQ for plotting by removing duplicates.
BOARD * m_board
Definition pcb_plotter.h:87
bool Plot(const wxString &aOutputPath, const LSEQ &aLayersToPlot, const LSEQ &aCommonLayers, bool aUseGerberFileExtensions, bool aPlotAllLayersToSingleFile, bool aForceAllLayersToSinglePage, std::optional< wxString > aLayerName=std::nullopt, std::optional< wxString > aSheetName=std::nullopt, std::optional< wxString > aSheetPath=std::nullopt, std::vector< wxString > *aOutputFiles=nullptr)
static void PlotJobToPlotOpts(PCB_PLOT_PARAMS &aOpts, JOB_EXPORT_PCB_PLOT *aJob, REPORTER &aReporter)
Translate a JOB to PCB_PLOT_PARAMS.
PCB_PLOTTER(BOARD *aBoard, REPORTER *aReporter, PCB_PLOT_PARAMS &aParams)
PCB_PLOT_PARAMS m_plotOpts
Definition pcb_plotter.h:88
REPORTER * m_reporter
Definition pcb_plotter.h:89
bool copperLayerShouldBeSkipped(PCB_LAYER_ID aLayerToPlot)
All copper layers that are disabled are actually selected This is due to wonkyness in automatically s...
static void BuildPlotFileName(wxFileName *aFilename, const wxString &aOutputDir, const wxString &aSuffix, const wxString &aExtension)
Complete a plot filename.
static LSET DialogLayerSelection(const LSET &aChecked, const LSET &aEnabledLayers, bool aForJob)
Return the layers a plot dialog stores when aChecked are ticked.
Parameters and options when plotting/printing a board.
void SetDrillMarksType(DRILL_MARKS aVal)
void SetSkipPlotNPTH_Pads(bool aSkip)
void SetLayerSelection(const LSET &aSelection)
void SetOutputDirectory(const wxString &aDir)
void SetPlotReference(bool aFlag)
void SetSketchPadsOnFabLayers(bool aFlag)
void SetUseGerberX2format(bool aUse)
void SetA4Output(int aForce)
void SetPlotOnAllLayersSequence(LSEQ aSeq)
void SetDXFPlotPolygonMode(bool aFlag)
void SetAutoScale(bool aFlag)
void SetPlotFrameRef(bool aFlag)
void SetSketchDNPFPsOnFabLayers(bool aFlag)
bool m_PDFMetadata
Generate PDF metadata for SUBJECT and AUTHOR.
void SetPlotPadNumbers(bool aFlag)
COLOR4D m_backgroundColor
Background color to use for PNG and PDF plotting.
bool m_PDFFrontFPPropertyPopups
Generate PDF property popup menus for footprints.
void SetScale(double aVal)
void SetDisableGerberMacros(bool aDisable)
void SetDXFMultiLayeredExportOption(bool aFlag)
void SetScaleSelection(int aSelection)
void SetFineScaleAdjustX(double aVal)
void SetMirror(bool aFlag)
void SetBlackAndWhite(bool blackAndWhite)
void SetGerberPrecision(int aPrecision)
void SetSubtractMaskFromSilk(bool aSubtract)
void SetHideDNPFPsOnFabLayers(bool aFlag)
void SetPlotValue(bool aFlag)
void SetPngDPI(int aDPI)
void SetUseGerberProtelExtensions(bool aUse)
void SetDXFPlotUnits(DXF_UNITS aUnit)
void SetPngAntialias(bool aFlag)
void SetColorSettings(COLOR_SETTINGS *aSettings)
void SetIncludeGerberNetlistInfo(bool aUse)
void SetCreateGerberJobFile(bool aCreate)
bool m_PDFSingle
Generate a single PDF file for all layers.
void SetNegative(bool aFlag)
bool GetBlackAndWhite() const
void SetUseAuxOrigin(bool aAux)
bool m_PDFBackFPPropertyPopups
on front and/or back of board
void SetDXFPlotMode(DXF_OUTLINE_MODE aPlotMode)
void SetTextMode(PLOT_TEXT_MODE aVal)
void SetSvgFitPageToBoard(int aSvgFitPageToBoard)
void SetSvgPrecision(unsigned aPrecision)
void SetCrossoutDNPFPsOnFabLayers(bool aFlag)
void SetFormat(PLOT_FORMAT aFormat)
void SetBackgroundColor(const COLOR4D &aColor)
void SetFineScaleAdjustY(double aVal)
void SetWidthAdjust(int aVal)
Base plotter engine class.
Definition plotter.h:138
virtual void SetAuthor(const wxString &aAuthor)
Definition plotter.h:192
void SetLayer(PCB_LAYER_ID aLayer)
Sets the ID of the current layer.
Definition plotter.h:257
virtual void SetTitle(const wxString &aTitle)
Definition plotter.h:191
virtual bool EndPlot()=0
RENDER_SETTINGS * RenderSettings()
Definition plotter.h:169
virtual void SetSubject(const wxString &aSubject)
Definition plotter.h:193
Container for project specific data.
Definition project.h:63
A pure virtual class used to derive REPORTER objects from.
Definition reporter.h:73
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Report a string with a given severity.
Definition reporter.h:102
Represent a set of closed polygons.
int OutlineCount() const
Return the number of outlines in the set.
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
wxString ExpandTextVars(const wxString &aSource, const PROJECT *aProject, RESOLUTION_CONTEXT aContext)
Definition common.cpp:60
@ FOR_GUI
Definition common.h:93
wxString GetDefaultPlotExtension(PLOT_FORMAT aFormat)
Return the default plot extension for a format.
#define _(s)
static constexpr EDA_ANGLE ANGLE_0
Definition eda_angle.h:472
#define IS_NEW
New item, just created.
int RefreshGeneratedTables(BOARD &aBoard)
Bring every generated table on the board up to date and return how many were rebuilt.
Classes used to generate a Gerber job file in JSON.
static const std::string GerberJobFileExtension
KIID niluuid(0)
@ LAYER_PCB_BACKGROUND
PCB background color.
Definition layer_ids.h:277
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:56
static int scaleToSelection(double scale)
bool PlotFootprintToSVG(const FOOTPRINT &aFootprint, PROJECT &aProject, const std::map< wxString, wxString > *aVarOverrides, PCB_PLOT_PARAMS &aPlotOpts, const LSEQ &aLayersToPlot, const LSEQ &aLayersOnAll, const wxString &aFileName, REPORTER *aReporter)
Plot a footprint to an SVG file, with the footprint origin at the SVG origin and the page/viewBox siz...
const wxString GetGerberProtelExtension(int aLayer)
Definition pcbplot.cpp:39
PLOTTER * StartPlotBoard(BOARD *aBoard, const PCB_PLOT_PARAMS *aPlotOpts, int aLayer, const wxString &aLayerName, const wxString &aFullFileName, const wxString &aSheetName, const wxString &aSheetPath, const wxString &aPageName=wxT("1"), const wxString &aPageNumber=wxEmptyString, const int aPageCount=1)
Open a new plotfile using the options (and especially the format) specified in the options and prepar...
void setupPlotterNewPDFPage(PLOTTER *aPlotter, BOARD *aBoard, PCB_PLOT_PARAMS *aPlotOpts, const wxString &aLayerName, const wxString &aSheetName, const wxString &aSheetPath, const wxString &aPageNumber, int aPageCount)
void PlotBoardLayers(BOARD *aBoard, PLOTTER *aPlotter, const LSEQ &aLayerSequence, const PCB_PLOT_PARAMS &aPlotOptions)
Plot a sequence of board layer IDs.
void PlotInteractiveLayer(BOARD *aBoard, PLOTTER *aPlotter, const PCB_PLOT_PARAMS &aPlotOpt)
Plot interactive items (hypertext links, properties, etc.) for the footprints the page drew.
see class PGM_BASE
@ SKETCH
Definition plotter.h:83
@ FILLED
Definition plotter.h:84
PLOT_FORMAT
The set of supported output plot formats.
Definition plotter.h:65
Plotting engines similar to ps (PostScript, Gerber, svg)
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_INFO
@ RPT_SEVERITY_ACTION
COLOR_SETTINGS * GetColorSettings(const wxString &aName)
T * GetAppSettings(const char *aFilename)
const int scale
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:708