33#include <wx/filename.h>
52 if(
scale == 0.0 ) selection = 0;
53 else if(
scale == 1.5 ) selection = 2;
54 else if(
scale == 2.0 ) selection = 3;
55 else if(
scale == 3.0 ) selection = 4;
70 const LSEQ& aCommonLayers,
bool aUseGerberFileExtensions,
71 bool aOutputPathIsSingle, std::optional<wxString> aLayerName,
72 std::optional<wxString> aSheetName, std::optional<wxString> aSheetPath,
73 std::vector<wxString>* aOutputFiles )
75 std::function<bool( wxString* )> textResolver =
76 [&]( wxString* token ) ->
bool
79 return m_board->ResolveTextVar( token, 0 );
83 if( aLayersToPlot.size() < 1 )
93 LSET plotted( { aLayersToPlot } );
94 plotted |=
LSET( { aCommonLayers } );
99 VECTOR2I existingAuxOrigin =
m_board->GetDesignSettings().GetAuxOrigin();
103 BOX2I bbox =
m_board->ComputeBoundingBox(
false,
false );
107 if(
m_board->GetBoardPolygonOutlines( boardOutlines,
false ) && boardOutlines.
OutlineCount() > 0 )
108 bbox = boardOutlines.
BBox();
115 m_board->SetPageSettings( currPageInfo );
129 if( aOutputPathIsSingle && !
m_plotOpts.GetDXFMultiLayeredExportOption() && !isPdfMultiPage )
131 layersToPlot.push_back( aLayersToPlot[0] );
133 if( aLayersToPlot.size() > 1 )
134 commonLayers.insert( commonLayers.end(), aLayersToPlot.begin() + 1, aLayersToPlot.end() );
138 layersToPlot = aLayersToPlot;
139 commonLayers = aCommonLayers;
142 int finalPageCount = 0;
143 std::vector<std::pair<PCB_LAYER_ID, wxString>> layersToExport;
153 layersToExport.emplace_back( layer,
m_board->GetLayerName( layer ) );
156 std::unique_ptr<GERBER_JOBFILE_WRITER> jobfile_writer;
169 for(
size_t i = 0; i < layersToPlot.size(); i++ )
177 wxString layerName =
m_board->GetLayerName( layer );
180 if( aOutputPathIsSingle )
182 fn = wxFileName( aOutputPath );
186 wxFileName brdFn =
m_board->GetFileName();
187 fn.Assign( aOutputPath, brdFn.GetName(), fileExt );
204 wxString fullname = fn.GetFullName();
205 jobfile_writer->AddGbrFile( layer, fullname );
215 wxString pageNumber = wxString::Format(
"%d", pageNum );
216 wxString pageName = layerName;
217 wxString sheetName = layerName;
219 if( aLayerName.has_value() )
221 layerName = aLayerName.value();
222 pageName = aLayerName.value();
225 if( aSheetName.has_value() )
226 sheetName = aSheetName.value();
228 if( aSheetPath.has_value() )
229 sheetPath = aSheetPath.value();
231 m_plotOpts.SetLayersToExport( layersToExport );
233 sheetName, sheetPath, pageName, pageNumber, finalPageCount );
243 msg = wxS(
"AUTHOR" );
245 if(
m_board->ResolveTextVar( &msg, 0 ) )
248 msg = wxS(
"SUBJECT" );
250 if(
m_board->ResolveTextVar( &msg, 0 ) )
270 wxString pageNumber = wxString::Format(
"%d", pageNum + 1 );
271 size_t nextI = i + 1;
277 nextLayer = layersToPlot[nextI];
280 layerName =
m_board->GetLayerName( nextLayer );
282 wxString pageName = layerName;
283 wxString sheetName = layerName;
286 static_cast<PDF_PLOTTER*
>( plotter )->StartPage( pageNumber, pageName );
288 sheetPath, pageNumber, finalPageCount );
294 || i == aLayersToPlot.size() - 1
295 || pageNum == finalPageCount )
312 m_reporter->Report( wxString::Format(
_(
"Plotted to '%s'." ), fn.GetFullPath() ),
317 aOutputFiles->push_back( fn.GetFullPath() );
324 m_reporter->Report( wxString::Format(
_(
"Failed to create file '%s'." ), fn.GetFullPath() ),
336 if( jobfile_writer &&
m_plotOpts.GetCreateGerberJobFile() )
339 wxFileName fn(
m_board->GetFileName() );
343 jobfile_writer->CreateJobFile( fn.GetFullPath() );
346 aOutputFiles->push_back( fn.GetFullPath() );
355 m_board->SetPageSettings( existingPageInfo );
356 m_board->GetDesignSettings().SetAuxOrigin( existingAuxOrigin );
370 const wxString& aSuffix,
const wxString& aExtension )
375 aFilename->SetPath( aOutputDir );
378 aFilename->SetExt( aExtension );
386 wxString suffix = aSuffix;
388 suffix.Trim(
false );
390 wxString badchars = wxFileName::GetForbiddenChars( wxPATH_DOS );
391 badchars.Append(
"%." );
393 for(
unsigned ii = 0; ii < badchars.Len(); ii++ )
394 suffix.Replace( badchars[ii], wxT(
"_" ) );
396 if( !suffix.IsEmpty() )
397 aFilename->SetName( aFilename->GetName() + wxT(
"-" ) + suffix );
406 plotSequence.push_back( aLayerToPlot );
411 if(
find( plotSequence.begin(), plotSequence.end(), layer ) != plotSequence.end() )
414 plotSequence.push_back( layer );
493 if( theme.IsEmpty() )
496 theme = pcbSettings->m_ColorTheme;
503 aReporter.
Report( wxString::Format(
_(
"Color theme '%s' not found, will use theme from PCB Editor.\n" ),
554 const std::map<wxString, wxString>* aVarOverrides,
PCB_PLOT_PARAMS& aPlotOpts,
555 const LSEQ& aLayersToPlot,
const LSEQ& aLayersOnAll,
const wxString& aFileName,
567 brd->GetProject()->ApplyTextVars( *aVarOverrides );
569 brd->SynchronizeProperties();
582 pad->SetLocalRatsnestVisible(
false );
583 pad->SetNetCode( 0 );
597 PCB_PLOTTER plotter( brd.get(), aReporter, aPlotOpts );
599 return plotter.
Plot( aFileName, aLayersToPlot, aLayersOnAll,
false,
true, wxEmptyString, wxEmptyString,
constexpr EDA_IU_SCALE pcbIUScale
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
static std::unique_ptr< BOARD > CreateEmptyBoard(PROJECT *aProject)
Information pertinent to a Pcbnew printed circuit board.
constexpr size_type GetWidth() const
constexpr size_type GetHeight() const
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)
virtual void SetParent(EDA_ITEM *aParent)
bool m_plotGraphicItemsUsingContours
bool m_useProtelFileExtension
bool m_includeNetlistAttributes
bool m_disableApertureMacros
bool m_pdfFrontFPPropertyPopups
wxString m_pdfBackgroundColor
The background color specified in a hex string.
bool m_pdfBackFPPropertyPopups
bool m_sketchDNPFPsOnFabLayers
bool m_useDrillOrigin
Used by SVG/DXF/PDF/Gerbers.
bool m_plotFootprintValues
LSEQ m_plotOnAllLayersSequence
Layers to include on all individual layer prints.
bool m_sketchPadsOnFabLayers
DRILL_MARKS m_drillShapeOption
Used by SVG & PDF.
bool m_crossoutDNPFPsOnFabLayers
bool m_hideDNPFPsOnFabLayers
bool m_mirror
Common Options.
bool m_subtractSolderMaskFromSilk
bool m_useBackgroundColor
double m_trackWidthCorrection
wxString GetConfiguredOutputPath() const
Returns the configured output path for the job.
wxString GetFilename() const
A color representation with 4 components: red, green, blue, alpha.
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
LSET is a set of PCB_LAYER_IDs.
static LSET AllCuMask(int aCuLayerCount)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Describe the page size and margins of a paper page on which to eventually print or plot.
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.
static void PlotJobToPlotOpts(PCB_PLOT_PARAMS &aOpts, JOB_EXPORT_PCB_PLOT *aJob, REPORTER &aReporter)
True when the board's out-of-date-chart policy regenerated charts during the last Plot().
PCB_PLOTTER(BOARD *aBoard, REPORTER *aReporter, PCB_PLOT_PARAMS &aParams)
PCB_PLOT_PARAMS m_plotOpts
bool Plot(const wxString &aOutputPath, const LSEQ &aLayersToPlot, const LSEQ &aCommonLayers, bool aUseGerberFileExtensions, bool aOutputPathIsSingle=false, std::optional< wxString > aLayerName=std::nullopt, std::optional< wxString > aSheetName=std::nullopt, std::optional< wxString > aSheetPath=std::nullopt, std::vector< wxString > *aOutputFiles=nullptr)
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.
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 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.
virtual void SetAuthor(const wxString &aAuthor)
void SetLayer(PCB_LAYER_ID aLayer)
Sets the ID of the current layer.
virtual void SetTitle(const wxString &aTitle)
RENDER_SETTINGS * RenderSettings()
virtual void SetSubject(const wxString &aSubject)
Container for project specific data.
A pure virtual class used to derive REPORTER objects from.
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Report a string with a given severity.
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)
wxString GetDefaultPlotExtension(PLOT_FORMAT aFormat)
Return the default plot extension for a format.
static constexpr EDA_ANGLE ANGLE_0
#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
@ LAYER_PCB_BACKGROUND
PCB background color.
PCB_LAYER_ID
A quick note on layer IDs:
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)
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.
PLOT_FORMAT
The set of supported output plot formats.
Plotting engines similar to ps (PostScript, Gerber, svg)
COLOR_SETTINGS * GetColorSettings(const wxString &aName)
T * GetAppSettings(const char *aFilename)
VECTOR2< int32_t > VECTOR2I