84#include <wx/wfstream.h>
85#include <wx/zipstrm.h>
117 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
124 wxCHECK( svgJob && editFrame,
false );
131 [](
JOB* job, wxWindow* aParent ) ->
bool
135 wxCHECK( renderJob,
false );
141 [](
JOB* job, wxWindow* aParent ) ->
bool
146 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
153 wxCHECK( svgJob && editFrame,
false );
160 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
167 wxCHECK( gencadJob && editFrame,
false );
173 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
180 wxCHECK( dxfJob && editFrame,
false );
186 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
193 wxCHECK( pdfJob && editFrame,
false );
199 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
206 wxCHECK( psJob && editFrame,
false );
213 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
220 wxCHECK( gJob && editFrame,
false );
227 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
234 wxCHECK( gJob && editFrame,
false );
242 m_reporter->Report(
_(
"Plotting to HPGL is no longer supported as of KiCad 10.0.\n" ),
246 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
251 wxCHECK( editFrame,
false );
254 _(
"Plotting to HPGL is no longer supported as of KiCad 10.0." ) );
259 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
266 wxCHECK( drillJob && editFrame,
false );
272 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
279 wxCHECK( posJob && editFrame,
false );
286 [](
JOB* job, wxWindow* aParent ) ->
bool
292 [](
JOB* job, wxWindow* aParent ) ->
bool
297 [](
JOB* job, wxWindow* aParent ) ->
bool
301 wxCHECK( drcJob,
false );
308 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
315 wxCHECK( ipcJob && editFrame,
false );
322 [](
JOB* job, wxWindow* aParent ) ->
bool
328 [aKiway](
JOB* job, wxWindow* aParent ) ->
bool
335 wxCHECK( odbJob && editFrame,
false );
376 BOARD* brd =
nullptr;
380 wxString pcbPath = aPath;
382 if( pcbPath.IsEmpty() )
387 pcbPath =
path.GetFullPath();
416 std::map<wxString, LSET> layerUserMasks;
417 std::map<wxString, LSET> layerMasks;
418 std::map<wxString, LSET> layerGuiMasks;
453 [&](
const LSET& layerSet )
456 layerMask.push_back( layer );
459 if( !aLayerString.IsEmpty() )
461 wxStringTokenizer layerTokens( aLayerString,
"," );
463 while( layerTokens.HasMoreTokens() )
465 std::string token =
TO_UTF8( layerTokens.GetNextToken().Trim(
true ).Trim(
false ) );
467 if( layerUserMasks.contains( token ) )
468 pushLayers( layerUserMasks.at( token ) );
469 else if( layerMasks.count( token ) )
470 pushLayers( layerMasks.at( token ) );
471 else if( layerGuiMasks.count( token ) )
472 pushLayers( layerGuiMasks.at( token ) );
474 m_reporter->Report( wxString::Format(
_(
"Invalid layer name '%s'\n" ), token ) );
486 if( aStepJob ==
nullptr )
501 fn.SetName( fn.GetName() );
569 m_reporter->Report( wxString::Format(
_(
"Successfully exported VRML to %s" ),
602 if( !stepExporter.
Export() )
614 if( aRenderJob ==
nullptr )
650 fn.SetName( wxString::Format(
"%s-%d", fn.GetName(),
static_cast<int>( aRenderJob->
m_side ) ) );
742 lightColor, lightColor, lightColor, lightColor,
743 lightColor, lightColor, lightColor, lightColor,
749 sideElevation, sideElevation, sideElevation, sideElevation,
750 -sideElevation, -sideElevation, -sideElevation, -sideElevation,
754 45, 135, 225, 315, 45, 135, 225, 315,
759 boardAdapter.
m_Cfg = &cfg;
771 static std::map<JOB_PCB_RENDER::SIDE, VIEW3D_TYPE> s_viewCmdMap = {
819 uint8_t* rgbaBuffer = raytrace.
GetBuffer();
821 bool success = !!rgbaBuffer;
825 const unsigned int wxh = realSize.x * realSize.y;
827 unsigned char* rgbBuffer = (
unsigned char*) malloc( wxh * 3 );
828 unsigned char* alphaBuffer = (
unsigned char*) malloc( wxh );
830 unsigned char* rgbaPtr = rgbaBuffer;
831 unsigned char* rgbPtr = rgbBuffer;
832 unsigned char* alphaPtr = alphaBuffer;
834 for(
int y = 0; y < realSize.y; y++ )
836 for(
int x = 0; x < realSize.x; x++ )
838 rgbPtr[0] = rgbaPtr[0];
839 rgbPtr[1] = rgbaPtr[1];
840 rgbPtr[2] = rgbaPtr[2];
841 alphaPtr[0] = rgbaPtr[3];
849 wxImage
image( realSize );
850 image.SetData( rgbBuffer );
851 image.SetAlpha( alphaBuffer );
854 image.SetOption( wxIMAGE_OPTION_QUALITY, 90 );
856 : wxBITMAP_TYPE_JPEG );
876 if( aSvgJob ==
nullptr )
892 fn.SetName( fn.GetName() );
936 std::optional<wxString> layerName;
937 std::optional<wxString> sheetName;
938 std::optional<wxString> sheetPath;
954 layerName, sheetName, sheetPath ) )
967 if( aDxfJob ==
nullptr )
1007 fn.SetName( fn.GetName() );
1027 std::optional<wxString> layerName;
1028 std::optional<wxString> sheetName;
1029 std::optional<wxString> sheetPath;
1045 layerName, sheetName, sheetPath ) )
1056 bool plotAllLayersOneFile =
false;
1059 if( pdfJob ==
nullptr )
1089 plotAllLayersOneFile =
true;
1100 fn.SetName( fn.GetName() );
1110 if( plotAllLayersOneFile )
1123 std::optional<wxString> layerName;
1124 std::optional<wxString> sheetName;
1125 std::optional<wxString> sheetPath;
1127 if( plotAllLayersOneFile )
1141 layerName, sheetName, sheetPath ) )
1154 if( psJob ==
nullptr )
1196 fn.SetName( fn.GetName() );
1216 std::optional<wxString> layerName;
1217 std::optional<wxString> sheetName;
1218 std::optional<wxString> sheetPath;
1233 layerName, sheetName, sheetPath ) )
1247 if( aGerberJob ==
nullptr )
1278 bool hasLayerListSpecified =
false;
1285 hasLayerListSpecified =
true;
1328 plotSequence.push_back( layer );
1334 if(
find( plotSequence.begin(), plotSequence.end(), layer_all ) != plotSequence.end() )
1337 plotSequence.push_back( layer_all );
1348 plotOpts = boardPlotOptions;
1358 wxString fullname = fn.GetFullName();
1366 jobfile_writer.
AddGbrFile( layer, fullname );
1380 fn.GetFullPath(), sheetName, sheetPath );
1384 m_reporter->Report( wxString::Format(
_(
"Plotted to '%s'.\n" ), fn.GetFullPath() ),
1392 m_reporter->Report( wxString::Format(
_(
"Failed to plot to '%s'.\n" ), fn.GetFullPath() ),
1417 if( aGencadJob ==
nullptr )
1422 if( brd ==
nullptr )
1441 fn.SetName( fn.GetName() );
1457 m_reporter->Report( wxString::Format(
_(
"Failed to create file '%s'.\n" ), outPath ),
1474 if( aGerberJob ==
nullptr )
1511 fn.SetName( fn.GetName() );
1557 m_reporter->Report( wxString::Format(
_(
"Failed to plot to '%s'.\n" ), outPath ),
1575 if( aDrillJob ==
nullptr )
1593 std::unique_ptr<GENDRILL_WRITER_BASE> drillWriter;
1596 drillWriter = std::make_unique<EXCELLON_WRITER>( brd );
1598 drillWriter = std::make_unique<GERBER_WRITER>( brd );
1648 if( excellonWriter ==
nullptr )
1669 if( gerberWriter ==
nullptr )
1694 if( aPosJob ==
nullptr )
1707 fn.SetName( fn.GetName() );
1730 wxFileName fn( outPath );
1731 wxString baseName = fn.GetName();
1733 auto exportPlaceFile =
1734 [&](
bool frontSide,
bool backSide,
const wxString& curr_outPath ) ->
bool
1736 FILE* file = wxFopen( curr_outPath, wxS(
"wt" ) );
1737 wxCHECK( file,
false );
1751 fputs( data.c_str(), file );
1764 if( exportPlaceFile(
true,
false, fn.GetFullPath() ) )
1766 m_reporter->Report( wxString::Format(
_(
"Wrote front position data to '%s'.\n" ),
1782 if( exportPlaceFile(
false,
true, fn.GetFullPath() ) )
1784 m_reporter->Report( wxString::Format(
_(
"Wrote back position data to '%s'.\n" ),
1811 if( exportPlaceFile( front, back, fn.GetFullPath() ) )
1813 m_reporter->Report( wxString::Format(
_(
"Wrote position data to '%s'.\n" ),
1829 wxString outPath_base = outPath;
1839 m_reporter->Report( wxString::Format(
_(
"Wrote front position data to '%s'.\n" ), outPath ),
1855 outPath = outPath_base;
1862 m_reporter->Report( wxString::Format(
_(
"Wrote back position data to '%s'.\n" ), outPath ),
1882 if( upgradeJob ==
nullptr )
1892 m_reporter->Report(
_(
"Output path must not conflict with existing path\n" ),
1899 m_reporter->Report(
_(
"Output path must be specified to convert legacy and non-KiCad libraries\n" ),
1909 m_reporter->Report(
_(
"Footprint library path does not exist or is not accessible\n" ),
1930 bool shouldSave = upgradeJob->
m_force;
1976 if( svgJob ==
nullptr )
2009 bool singleFpPlotted =
false;
2011 for(
const auto& [fpName, fpCacheEntry] : fpLib.
GetFootprints() )
2025 singleFpPlotted =
true;
2028 exitCode =
doFpExportSvg( svgJob, fpCacheEntry->GetFootprint().get() );
2034 if( !svgJob->
m_footprint.IsEmpty() && !singleFpPlotted )
2036 m_reporter->Report(
_(
"The given footprint could not be found to export." ) + wxS(
"\n" ),
2048 std::unique_ptr<BOARD> brd;
2051 brd->SynchronizeProperties();
2064 pad->SetLocalRatsnestVisible(
false );
2065 pad->SetNetCode( 0 );
2073 wxFileName outputFile;
2078 m_reporter->Report( wxString::Format(
_(
"Plotting footprint '%s' to '%s'\n" ),
2080 outputFile.GetFullPath() ),
2099 if( !plotter.
Plot( outputFile.GetFullPath(),
2104 wxEmptyString, wxEmptyString,
2119 if( drcJob ==
nullptr )
2134 fn.SetName( fn.GetName() + wxS(
"-drc" ) );
2163 std::unique_ptr<NETLIST>
netlist = std::make_unique<NETLIST>();
2171 bool checkParity = drcJob->
m_parity;
2172 std::string netlist_str;
2176 wxString annotateMsg =
_(
"Schematic parity tests require a fully annotated schematic." );
2177 netlist_str = annotateMsg;
2189 wxFileName schematicPath( drcJob->
m_filename );
2192 if( !schematicPath.Exists() )
2195 if( !schematicPath.Exists() )
2197 m_reporter->Report(
_(
"Failed to fetch schematic netlist for parity tests.\n" ),
2199 checkParity =
false;
2203 typedef bool ( *NETLIST_FN_PTR )(
const wxString&, std::string& );
2205 NETLIST_FN_PTR netlister =
2207 ( *netlister )( schematicPath.GetFullPath(), netlist_str );
2211 if( netlist_str == annotateMsg )
2214 checkParity =
false;
2223 _(
"Eeschema netlist" ) );
2230 m_reporter->Report(
_(
"Failed to fetch schematic netlist for parity tests.\n" ),
2232 checkParity =
false;
2235 drcEngine->SetSchematicNetlist(
netlist.get() );
2247 drcEngine->SetViolationHandler(
2248 [&](
const std::shared_ptr<DRC_ITEM>& aItem,
const VECTOR2I& aPos,
int aLayer,
2249 const std::vector<PCB_SHAPE>& aShapes )
2253 commit.
Add( marker );
2259 drcEngine->ClearViolationHandler();
2266 std::shared_ptr<DRC_ITEMS_PROVIDER> markersProvider = std::make_shared<DRC_ITEMS_PROVIDER>(
2269 std::shared_ptr<DRC_ITEMS_PROVIDER> ratsnestProvider =
2272 std::shared_ptr<DRC_ITEMS_PROVIDER> fpWarningsProvider =
2275 markersProvider->SetSeverities( drcJob->
m_severity );
2276 ratsnestProvider->SetSeverities( drcJob->
m_severity );
2277 fpWarningsProvider->SetSeverities( drcJob->
m_severity );
2279 m_reporter->Report( wxString::Format(
_(
"Found %d violations\n" ),
2280 markersProvider->GetCount() ),
2282 m_reporter->Report( wxString::Format(
_(
"Found %d unconnected items\n" ),
2283 ratsnestProvider->GetCount() ),
2288 m_reporter->Report( wxString::Format(
_(
"Found %d schematic parity issues\n" ),
2289 fpWarningsProvider->GetCount() ),
2293 DRC_REPORT reportWriter( brd, units, markersProvider, ratsnestProvider, fpWarningsProvider );
2295 bool wroteReport =
false;
2304 m_reporter->Report( wxString::Format(
_(
"Unable to save DRC report to %s\n" ), outPath ),
2309 m_reporter->Report( wxString::Format(
_(
"Saved DRC Report to %s\n" ), outPath ),
2328 if( markersProvider->GetCount() > 0 || ratsnestProvider->GetCount() > 0
2329 || fpWarningsProvider->GetCount() > 0 )
2343 if( job ==
nullptr )
2356 fn.SetName( fn.GetName() );
2370 std::map<std::string, UTF8> props;
2372 props[
"sigfig"] = wxString::Format(
"%d", job->
m_precision );
2380 wxString tempFile = wxFileName::CreateTempFileName( wxS(
"pcbnew_ipc" ) );
2385 pi->SaveBoard( tempFile, brd, &props );
2389 m_reporter->Report( wxString::Format(
_(
"Error generating IPC-2581 file '%s'.\n%s" ),
2394 wxRemoveFile( tempFile );
2401 wxFileName tempfn = outPath;
2403 wxFileName zipfn = tempFile;
2404 zipfn.SetExt(
"zip" );
2407 wxFFileOutputStream fnout( zipfn.GetFullPath() );
2408 wxZipOutputStream
zip( fnout );
2409 wxFFileInputStream fnin( tempFile );
2411 zip.PutNextEntry( tempfn.GetFullName() );
2415 wxRemoveFile( tempFile );
2416 tempFile = zipfn.GetFullPath();
2420 if( !wxRenameFile( tempFile, outPath ) )
2422 m_reporter->Report( wxString::Format(
_(
"Error generating IPC-2581 file '%s'.\n"
2423 "Failed to rename temporary file '%s." ),
2437 if( job ==
nullptr )
2450 fn.SetName( fn.GetName() );
2466 bool success = exporter.
Write( outPath );
2485 if( job ==
nullptr )
2507 fn.SetName( fn.GetName() + wxS(
"-odb" ) );
2534 if( job ==
nullptr )
2537 bool shouldSave = job->
m_force;
2559 wxString::Format(
_(
"Error saving board file '%s'.\n%s" ), job->
m_filename, ioe.
What().GetData() );
2581 return drawingSheet;
2588 if( aSheetPath.IsEmpty() )
2592 [&](
const wxString&
path ) ->
bool
2601 { aBrd->GetEmbeddedFiles() } );
2606 m_reporter->Report( wxString::Format(
_(
"Error loading drawing sheet '%s'." ),
2608 + wxS(
"\n" ) + msg + wxS(
"\n" ),
2616 if( loadSheet( aSheetPath ) )
constexpr EDA_IU_SCALE pcbIUScale
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
#define RANGE_SCALE_3D
This defines the range that all coord will have to be rendered.
static wxString m_DrawingSheetFileName
the name of the drawing sheet file, or empty to use the default drawing sheet
Helper class to handle information needed to display 3D board.
double BiuTo3dUnits() const noexcept
Board integer units To 3D units.
void SetBoard(BOARD *aBoard) noexcept
Set current board to be rendered.
EDA_3D_VIEWER_SETTINGS * m_Cfg
std::map< int, COLOR4D > m_ColorOverrides
allows to override color scheme colors
void Set3dCacheManager(S3D_CACHE *aCacheMgr) noexcept
Update the cache manager pointer.
virtual void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Execute the changes.
std::shared_ptr< DRC_ENGINE > m_DRCEngine
const VECTOR2I & GetAuxOrigin() const
Information pertinent to a Pcbnew printed circuit board.
const PAGE_INFO & GetPageSettings() const
void RecordDRCExclusions()
Scan existing markers and record data from any that are Excluded.
TITLE_BLOCK & GetTitleBlock()
BOX2I ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
const std::map< wxString, wxString > & GetProperties() const
const wxString & GetFileName() const
std::vector< PCB_MARKER * > ResolveDRCExclusions(bool aCreateMarkers)
Rebuild DRC markers from the serialized data in BOARD_DESIGN_SETTINGS.
int GetFileFormatVersionAtLoad() const
const PCB_PLOT_PARAMS & GetPlotOptions() const
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
PROJECT * GetProject() const
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
const LSET & GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
void SynchronizeProperties()
Copy the current project's text variables into the boards property cache.
void DeleteMARKERs()
Delete all MARKERS from the board.
constexpr const Vec GetCenter() const
void SetProjection(PROJECTION_TYPE aProjection)
void RotateY_T1(float aAngleInRadians)
bool Zoom_T1(float aFactor)
bool SetCurWindowSize(const wxSize &aSize)
Update the windows size of the camera.
bool ViewCommand_T1(VIEW3D_TYPE aRequestedView)
void RotateX_T1(float aAngleInRadians)
void SetLookAtPos_T1(const SFVEC3F &aLookAtPos)
const SFVEC3F & GetLookAtPos_T1() const
void RotateZ_T1(float aAngleInRadians)
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Add a new item to the model.
static void GenerateODBPPFiles(const JOB_EXPORT_PCB_ODB &aJob, BOARD *aBoard, PCB_EDIT_FRAME *aParentFrame=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr, REPORTER *aErrorReporter=nullptr)
A dialog to set the plot options and create plot files in various formats.
bool WriteJsonReport(const wxString &aFullFileName)
bool WriteTextReport(const wxString &aFullFileName)
Helper to handle drill precision format in excellon files.
static DS_DATA_MODEL & GetTheInstance()
Return the instance of DS_DATA_MODEL used in the application.
void SetSheetPath(const std::string &aSheetPath)
Set the sheet path displayed in the title block.
void SetSheetName(const std::string &aSheetName)
Set the sheet name displayed in the title block.
void SetIsFirstPage(bool aIsFirstPage)
Change if this is first page.
void SetFileName(const std::string &aFileName)
Set the file name displayed in the title block.
std::vector< LAYER_PRESET_3D > m_LayerPresets
void SetFlags(EDA_ITEM_FLAGS aMask)
virtual void SetParent(EDA_ITEM *aParent)
Create Excellon drill, drill map, and drill report files.
void SetFormat(bool aMetric, ZEROS_FMT aZerosFmt=DECIMAL_FORMAT, int aLeftDigits=0, int aRightDigits=0)
Initialize internal parameters to match the given format.
bool CreateDrillandMapFilesSet(const wxString &aPlotDirectory, bool aGenDrill, bool aGenMap, REPORTER *aReporter=nullptr)
Create the full set of Excellon drill file for the board.
void SetOptions(bool aMirror, bool aMinimalHeader, const VECTOR2I &aOffset, bool aMerge_PTH_NPTH)
Initialize internal parameters to match drill options.
void SetRouteModeForOvalHoles(bool aUseRouteModeForOvalHoles)
bool m_IncludeUnspecified
Wrapper to expose an API for writing VRML files, without exposing all the many structures used in the...
bool ExportVRML_File(PROJECT *aProject, wxString *aMessages, const wxString &aFullFileName, double aMMtoWRMLunit, bool aIncludeUnspecified, bool aIncludeDNP, bool aExport3DFiles, bool aUseRelativePaths, const wxString &a3D_Subdir, double aXRef, double aYRef)
Exports the board and its footprint shapes 3D (vrml files only) as a vrml file.
Provide an extensible class to resolve 3D model paths.
void SetPath(const wxString &aPath)
void Save(FOOTPRINT *aFootprintFilter=nullptr)
Save the footprint cache or a single footprint from it to disk.
boost::ptr_map< wxString, FP_CACHE_ENTRY > & GetFootprints()
Export board to GenCAD file format.
void UseIndividualShapes(bool aUnique)
Make pad shapes unique.
void UsePinNamesUnique(bool aUnique)
Make pin names unique.
void StoreOriginCoordsInFile(bool aStore)
Store origin coordinate in GenCAD file.
void FlipBottomPads(bool aFlip)
Flip pad shapes on the bottom side.
void SetPlotOffet(VECTOR2I aOffset)
Set the coordinates offset when exporting items.
bool WriteFile(const wxString &aFullFileName)
Export a GenCAD file.
void SetMapFileFormat(PLOT_FORMAT aMapFmt)
Initialize the format for the drill map file.
GERBER_JOBFILE_WRITER is a class used to create Gerber job file a Gerber job file stores info to make...
bool CreateJobFile(const wxString &aFullFilename)
Creates a Gerber job file.
void AddGbrFile(PCB_LAYER_ID aLayer, wxString &aFilename)
add a gerber file name and type in job file list
virtual bool EndPlot() override
Used to create Gerber drill files.
bool CreateDrillandMapFilesSet(const wxString &aPlotDirectory, bool aGenDrill, bool aGenMap, bool aGenTenting, REPORTER *aReporter=nullptr)
Create the full set of Excellon drill file for the board filenames are computed from the board name,...
void SetOptions(const VECTOR2I &aOffset)
Initialize internal parameters to match drill options.
void SetFormat(int aRightDigits=6)
Initialize internal parameters to match the given format.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
Wrapper to expose an API for writing IPC-D356 files.
bool Write(const wxString &aFilename)
Generates and writes the netlist to a given path.
void Register(const std::string &aJobTypeName, std::function< int(JOB *job)> aHandler, std::function< bool(JOB *job, wxWindow *aParent)> aConfigHandler)
JOB_DISPATCHER(KIWAY *aKiway)
PROGRESS_REPORTER * m_progressReporter
JOB_EXPORT_PCB_3D::FORMAT m_format
EXPORTER_STEP_PARAMS m_3dparams
Despite the name; also used for other formats.
ZEROS_FORMAT m_zeroFormat
bool m_excellonOvalDrillRoute
DRILL_ORIGIN m_drillOrigin
bool m_excellonCombinePTHNPTH
bool m_excellonMinimalHeader
wxString GetSettingsDialogTitle() const override
bool m_useIndividualShapes
bool m_useBoardPlotParams
IPC2581_VERSION m_version
ODB_COMPRESSION m_compressionMode
@ ALL_LAYERS_ONE_FILE
DEPRECATED MODE.
GEN_MODE m_pdfGenMode
The background color specified in a hex string.
LSEQ m_plotOnAllLayersSequence
Used by SVG & PDF.
bool m_checkZonesBeforePlot
std::optional< wxString > m_argLayers
std::optional< wxString > m_argCommonLayers
LSEQ m_plotLayerSequence
Layers to include on all individual layer prints.
bool m_useDrillPlaceFileOrigin
bool m_excludeFootprintsWithTh
wxString m_outputLibraryPath
bool m_reportAllTrackErrors
VECTOR3D m_lightBottomIntensity
VECTOR3D m_lightTopIntensity
VECTOR3D m_lightCameraIntensity
bool m_proceduralTextures
bool m_useBoardStackupColors
VECTOR3D m_lightSideIntensity
std::string m_appearancePreset
bool m_exitCodeViolations
An simple container class that lets us dispatch output jobs to kifaces.
void AddOutput(wxString aOutputPath)
wxString GetFullOutputPath(PROJECT *aProject) const
Returns the full output path for the job, taking into account the configured output path,...
wxString GetConfiguredOutputPath() const
Returns the configured output path for the job.
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
void SetWorkingOutputPath(const wxString &aPath)
Sets a transient output path for the job, it takes priority over the configured output path when GetF...
const std::map< wxString, wxString > & GetVarOverrides() const
Read the new s-expression based KiCad netlist format.
virtual void LoadNetlist() override
Load the contents of the netlist file into aNetlist.
A color representation with 4 components: red, green, blue, alpha.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
const UTF8 & GetLibItemName() const
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
LSET is a set of PCB_LAYER_IDs.
LSEQ UIOrder() const
Return the copper, technical and user layers in the order shown in layer widget.
LSEQ SeqStackupForPlotting() const
Return the sequence that is typical for a bottom-to-top stack-up.
static LSET AllNonCuMask()
Return a mask holding all layer minus CU layers.
static LSET AllCuMask(int aCuLayerCount)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
static const LSET & AllLayersMask()
static LSET AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
static const LSET & InternalCuMask()
Return a complete set of internal copper layers which is all Cu layers except F_Cu and B_Cu.
static wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
static bool EnsurePathExists(const wxString &aPath, bool aPathToFile=false)
Attempts to create a given path if it does not exist.
int JobExportStep(JOB *aJob)
int JobExportPs(JOB *aJob)
int JobExportPos(JOB *aJob)
int JobExportFpSvg(JOB *aJob)
int JobExportOdb(JOB *aJob)
int JobExportDrc(JOB *aJob)
int JobUpgrade(JOB *aJob)
int JobExportFpUpgrade(JOB *aJob)
int JobExportGerber(JOB *aJob)
DS_PROXY_VIEW_ITEM * getDrawingSheetProxyView(BOARD *aBrd)
int JobExportDxf(JOB *aJob)
int JobExportPdf(JOB *aJob)
int JobExportDrill(JOB *aJob)
int JobExportSvg(JOB *aJob)
void loadOverrideDrawingSheet(BOARD *brd, const wxString &aSheetPath)
PCBNEW_JOBS_HANDLER(KIWAY *aKiway)
TOOL_MANAGER * getToolManager(BOARD *aBrd)
int JobExportGerbers(JOB *aJob)
int JobExportGencad(JOB *aJob)
BOARD * getBoard(const wxString &aPath=wxEmptyString)
int JobExportIpc2581(JOB *aJob)
virtual ~PCBNEW_JOBS_HANDLER()
std::unique_ptr< TOOL_MANAGER > m_toolManager
LSEQ convertLayerArg(wxString &aLayerString, BOARD *aBoard) const
int JobExportRender(JOB *aJob)
int JobExportIpcD356(JOB *aJob)
int doFpExportSvg(JOB_FP_EXPORT_SVG *aSvgJob, const FOOTPRINT *aFootprint)
The main frame for Pcbnew.
A #PLUGIN derivation for saving and loading Pcbnew s-expression formatted files.
static PCB_IO * PluginFind(PCB_FILE_T aFileType)
Return a #PLUGIN which the caller can use to import, export, save, or load design documents.
PCB_FILE_T
The set of file types that the PCB_IO_MGR knows about, and for which there has been a plugin written,...
@ KICAD_SEXP
S-expression Pcbnew file format.
static bool ConvertLibrary(std::map< std::string, UTF8 > *aOldFileProps, const wxString &aOldFilePath, const wxString &aNewFilePath, REPORTER *aReporter)
Convert a schematic symbol library to the latest KiCad format.
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath, int aCtl=0)
Return a plugin type given a footprint library's libPath.
void SetShapes(const std::vector< PCB_SHAPE > &aShapes)
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)
static void PlotJobToPlotOpts(PCB_PLOT_PARAMS &aOpts, JOB_EXPORT_PCB_PLOT *aJob, REPORTER &aReporter)
Translate a JOB to PCB_PLOT_PARAMS.
Parameters and options when plotting/printing a board.
LSEQ GetPlotOnAllLayersSequence() const
void SetSkipPlotNPTH_Pads(bool aSkip)
void SetLayerSelection(const LSET &aSelection)
void SetPlotOnAllLayersSequence(LSEQ aSeq)
void SetPlotFrameRef(bool aFlag)
void SetPlotPadNumbers(bool aFlag)
LSET GetLayerSelection() const
void SetMirror(bool aFlag)
bool GetSketchPadsOnFabLayers() const
bool m_PDFSingle
Generate a single PDF file for all layers.
void SetSvgFitPageToBoard(int aSvgFitPageToBoard)
bool GetUseGerberProtelExtensions() const
virtual SETTINGS_MANAGER & GetSettingsManager() const
Used to create Gerber drill files.
const wxString GetPlaceFileName(const wxString &aFullBaseFilename, PCB_LAYER_ID aLayer) const
int CreatePlaceFile(const wxString &aFullFilename, PCB_LAYER_ID aLayer, bool aIncludeBrdEdges, bool aExcludeDNP)
Create an pnp gerber file.
The ASCII format of the kicad place file is:
static wxString DecorateFilename(const wxString &aBaseName, bool aFront, bool aBack)
std::string GenPositionData()
build a string filled with the position data
Base plotter engine class.
wxString m_BoardDrawingSheetFile
PcbNew params.
static S3D_CACHE * Get3DCacheManager(PROJECT *aProject, bool updateProjDir=false)
Return a pointer to an instance of the 3D cache manager.
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.
virtual const wxString GetProjectPath() const
Return the full path of the project.
virtual void ApplyTextVars(const std::map< wxString, wxString > &aVarsMap)
Applies the given var map, it will create or update existing vars.
virtual PROJECT_FILE & GetProjectFile() const
bool Redraw(bool aIsMoving, REPORTER *aStatusReporter, REPORTER *aWarningReporter) override
Redraw the view.
wxSize GetRealBufferSize()
void SetCurWindowSize(const wxSize &aSize) override
Before each render, the canvas will tell the render what is the size of its windows,...
PROJECT & Prj() const
A helper while we are not MDI-capable – return the one and only project.
Is a LINE_READER that reads from a multiline 8 bit wide std::string.
void Pan_T1(const SFVEC3F &aDeltaOffsetInc) override
void SetT0_and_T1_current_T() override
This will set T0 and T1 with the current values.
void Interpolate(float t) override
It will update the matrix to interpolate between T0 and T1 values.
wxString GetDefaultPlotExtension(PLOT_FORMAT aFormat)
Return the default plot extension for a format.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
static DRILL_PRECISION precisionListForInches(2, 4)
static DRILL_PRECISION precisionListForMetric(3, 3)
static constexpr EDA_ANGLE ANGLE_0
#define IS_NEW
New item, just created.
static FILENAME_RESOLVER * resolver
Classes used in drill files, map files and report files generation.
Classes used in drill files, map files and report files generation.
Classes used to generate a Gerber job file in JSON.
Classes used in place file generation.
static const std::string LegacySchematicFileExtension
static const std::string BrepFileExtension
static const std::string JpegFileExtension
static const std::string GerberJobFileExtension
static const std::string GerberFileExtension
static const std::string XaoFileExtension
static const std::string ReportFileExtension
static const std::string GltfBinaryFileExtension
static const std::string PngFileExtension
static const std::string FootprintPlaceFileExtension
static const std::string JsonFileExtension
static const std::string KiCadSchematicFileExtension
static const std::string CsvFileExtension
static const std::string U3DFileExtension
static const std::string PdfFileExtension
static const std::string Ipc2581FileExtension
static const std::string GencadFileExtension
static const std::string StlFileExtension
static const std::string IpcD356FileExtension
static const std::string PlyFileExtension
static const std::string StepFileExtension
static const std::string SVGFileExtension
static const std::string VrmlFileExtension
static const std::string ArchiveFileExtension
static const std::string KiCadPcbFileExtension
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
@ KIFACE_NETLIST_SCHEMATIC
wxString LayerName(int aLayer)
Returns the default display name for a given layer.
@ LAYER_3D_BACKGROUND_TOP
@ LAYER_3D_BACKGROUND_BOTTOM
PCB_LAYER_ID
A quick note on layer IDs:
This file contains miscellaneous commonly used macros and functions.
static const int ERR_ARGS
static const int ERR_RC_VIOLATIONS
Rules check violation count was greater than 0.
static const int ERR_INVALID_INPUT_FILE
static const int ERR_INVALID_OUTPUT_CONFLICT
static const int ERR_UNKNOWN
#define SEXPR_BOARD_FILE_VERSION
Current s-expression file format version. 2 was the last legacy format version.
#define CTL_FOR_LIBRARY
Format output for a footprint library instead of clipboard or BOARD.
static DRILL_PRECISION precisionListForInches(2, 4)
static DRILL_PRECISION precisionListForMetric(3, 3)
SETTINGS_MANAGER * GetSettingsManager()
BOARD * CreateEmptyBoard()
Construct a default BOARD with a temporary (no filename) project.
bool SaveBoard(wxString &aFileName, BOARD *aBoard, PCB_IO_MGR::PCB_FILE_T aFormat, bool aSkipSettings)
BOARD * LoadBoard(const wxString &aFileName, bool aSetActive)
Loads a board from file This function identifies the file type by extension and determines the correc...
const wxString GetGerberProtelExtension(int aLayer)
void BuildPlotFileName(wxFileName *aFilename, const wxString &aOutputDir, const wxString &aSuffix, const wxString &aExtension)
Complete a plot filename.
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 PlotBoardLayers(BOARD *aBoard, PLOTTER *aPlotter, const LSEQ &aLayerSequence, const PCB_PLOT_PARAMS &aPlotOptions)
Plot a sequence of board layer IDs.
PGM_BASE & Pgm()
The global program "get" accessor.
PLOT_FORMAT
The set of supported output plot formats.
Plotting engines similar to ps (PostScript, Gerber, svg)
T * GetAppSettings(const char *aFilename)
MODEL3D_FORMAT_TYPE fileType(const char *aFileName)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
std::vector< int > raytrace_lightElevation
bool show_footprints_normal
KIGFX::COLOR4D raytrace_lightColorCamera
bool raytrace_post_processing
std::vector< KIGFX::COLOR4D > raytrace_lightColor
KIGFX::COLOR4D raytrace_lightColorBottom
bool raytrace_reflections
bool show_footprints_virtual
bool differentiate_plated_copper
std::vector< int > raytrace_lightAzimuth
bool raytrace_refractions
bool show_footprints_not_in_posfile
bool raytrace_procedural_textures
bool show_footprints_insert
int raytrace_recursivelevel_refractions
KIGFX::COLOR4D raytrace_lightColorTop
bool raytrace_anti_aliasing
Implement a participant in the KIWAY alchemy.
Declaration for a track ball camera.
double DEG2RAD(double deg)
VECTOR2< int32_t > VECTOR2I
Definition of file extensions used in Kicad.