haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Honour LAYER, SHEETNAME and SHEETPATH variable overrides on CLI. 

Also allows the LAYER variable to work automatically
if you're plotting/exporting a single layer.

Fixes https://gitlab.com/kicad/code/kicad/-/issues/17680

(cherry picked from commit 3e0c598500)
This commit is contained in:
Jeff Young 2024-05-13 20:03:45 +01:00
parent ba6fd2716e
commit 33715143e3
6 changed files with 119 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
pcbnew/dialogs/dialog_plot.cpp
View File

@ -1201,6 +1201,11 @@ void DIALOG_PLOT::Plot( wxCommandEvent& event )
}
PCB_LAYER_ID layer = *seq;
wxString layerName = board->GetLayerName( layer );
//@todo allow controlling the sheet name and path that will be displayed in the title block
// Leave blank for now
wxString sheetName;
wxString sheetPath;
// All copper layers that are disabled are actually selected
// This is due to wonkyness in automatically selecting copper layers
@ -1219,16 +1224,14 @@ void DIALOG_PLOT::Plot( wxCommandEvent& event )
if( m_plotOpts.GetFormat() == PLOT_FORMAT::GERBER && m_useGerberExtensions->GetValue() )
file_ext = GetGerberProtelExtension( layer );
BuildPlotFileName( &fn, outputDir.GetPath(), board->GetLayerName( layer ), file_ext );
BuildPlotFileName( &fn, outputDir.GetPath(), layerName, file_ext );
wxString fullname = fn.GetFullName();
jobfile_writer.AddGbrFile( layer, fullname );
LOCALE_IO toggle;
//@todo allow controlling the sheet name and path that will be displayed in the title block
// Leave blank for now
PLOTTER* plotter = StartPlotBoard( board, &m_plotOpts, layer, fn.GetFullPath(),
wxEmptyString, wxEmptyString );
PLOTTER* plotter = StartPlotBoard( board, &m_plotOpts, layer, layerName, fn.GetFullPath(),
sheetName, sheetPath );
// Print diags in messages box:
wxString msg;

18
pcbnew/exporters/export_svg.cpp
View File

@ -87,12 +87,22 @@ bool EXPORT_SVG::Plot( BOARD* aBoard, const PCB_PLOT_SVG_OPTIONS& aSvgPlotOption
plot_opts.SetColorSettings( mgr.GetColorSettings( aSvgPlotOptions.m_colorTheme ) );
LOCALE_IO toggle;
LOCALE_IO toggle;
PCB_LAYER_ID layer = UNDEFINED_LAYER;
wxString layerName;
//@todo allow controlling the sheet name and path that will be displayed in the title block
// Leave blank for now
SVG_PLOTTER* plotter = (SVG_PLOTTER*) StartPlotBoard( aBoard, &plot_opts, UNDEFINED_LAYER, outputFile,
wxEmptyString, wxEmptyString );
wxString sheetName;
wxString sheetPath;
if( aSvgPlotOptions.m_printMaskLayer.size() == 1 )
{
layer = aSvgPlotOptions.m_printMaskLayer.front();
layerName = aBoard->GetLayerName( layer );
}
SVG_PLOTTER* plotter = (SVG_PLOTTER*) StartPlotBoard( aBoard, &plot_opts, layer, layerName,
outputFile, sheetName, sheetPath );
if( plotter )
{

99
pcbnew/pcbnew_jobs_handler.cpp
View File

@ -289,8 +289,29 @@ int PCBNEW_JOBS_HANDLER::JobExportDxf( JOB* aJob )
plotOpts.SetPlotReference( aDxfJob->m_plotRefDes );
plotOpts.SetLayerSelection( aDxfJob->m_printMaskLayer );
DXF_PLOTTER* plotter = (DXF_PLOTTER*) StartPlotBoard(
brd, &plotOpts, UNDEFINED_LAYER, aDxfJob->m_outputFile, wxEmptyString, wxEmptyString );
PCB_LAYER_ID layer = UNDEFINED_LAYER;
wxString layerName;
wxString sheetName;
wxString sheetPath;
if( aDxfJob->m_printMaskLayer.size() == 1 )
{
layer = aDxfJob->m_printMaskLayer.front();
layerName = brd->GetLayerName( layer );
}
if( aJob->GetVarOverrides().contains( wxT( "LAYER" ) ) )
layerName = aJob->GetVarOverrides().at( wxT( "LAYER" ) );
if( aJob->GetVarOverrides().contains( wxT( "SHEETNAME" ) ) )
sheetName = aJob->GetVarOverrides().at( wxT( "SHEETNAME" ) );
if( aJob->GetVarOverrides().contains( wxT( "SHEETPATH" ) ) )
sheetPath = aJob->GetVarOverrides().at( wxT( "SHEETPATH" ) );
DXF_PLOTTER* plotter = (DXF_PLOTTER*) StartPlotBoard( brd, &plotOpts, layer, layerName,
aDxfJob->m_outputFile, sheetName,
sheetPath );
if( plotter )
{
@ -358,8 +379,29 @@ int PCBNEW_JOBS_HANDLER::JobExportPdf( JOB* aJob )
break;
}
PDF_PLOTTER* plotter = (PDF_PLOTTER*) StartPlotBoard(
brd, &plotOpts, UNDEFINED_LAYER, aPdfJob->m_outputFile, wxEmptyString, wxEmptyString );
PCB_LAYER_ID layer = UNDEFINED_LAYER;
wxString layerName;
wxString sheetName;
wxString sheetPath;
if( aPdfJob->m_printMaskLayer.size() == 1 )
{
layer = aPdfJob->m_printMaskLayer.front();
layerName = brd->GetLayerName( layer );
}
if( aPdfJob->GetVarOverrides().contains( wxT( "LAYER" ) ) )
layerName = aPdfJob->GetVarOverrides().at( wxT( "LAYER" ) );
if( aPdfJob->GetVarOverrides().contains( wxT( "SHEETNAME" ) ) )
sheetName = aPdfJob->GetVarOverrides().at( wxT( "SHEETNAME" ) );
if( aPdfJob->GetVarOverrides().contains( wxT( "SHEETPATH" ) ) )
sheetPath = aPdfJob->GetVarOverrides().at( wxT( "SHEETPATH" ) );
PDF_PLOTTER* plotter = (PDF_PLOTTER*) StartPlotBoard( brd, &plotOpts, layer, layerName,
aPdfJob->m_outputFile, sheetName,
sheetPath );
if( plotter )
{
@ -434,8 +476,11 @@ int PCBNEW_JOBS_HANDLER::JobExportGerbers( JOB* aJob )
}
// Pick the basename from the board file
wxFileName fn( brd->GetFileName() );
PCB_LAYER_ID layer = *seq;
wxFileName fn( brd->GetFileName() );
PCB_LAYER_ID layer = *seq;
wxString layerName = brd->GetLayerName( layer );
wxString sheetName;
wxString sheetPath;
PCB_PLOT_PARAMS plotOpts;
if( aGerberJob->m_useBoardPlotParams )
@ -448,14 +493,24 @@ int PCBNEW_JOBS_HANDLER::JobExportGerbers( JOB* aJob )
else
fileExt = FILEEXT::GerberFileExtension;
BuildPlotFileName( &fn, aGerberJob->m_outputFile, brd->GetLayerName( layer ), fileExt );
BuildPlotFileName( &fn, aGerberJob->m_outputFile, layerName, fileExt );
wxString fullname = fn.GetFullName();
jobfile_writer.AddGbrFile( layer, fullname );
if( aJob->GetVarOverrides().contains( wxT( "LAYER" ) ) )
layerName = aJob->GetVarOverrides().at( wxT( "LAYER" ) );
if( aJob->GetVarOverrides().contains( wxT( "SHEETNAME" ) ) )
sheetName = aJob->GetVarOverrides().at( wxT( "SHEETNAME" ) );
if( aJob->GetVarOverrides().contains( wxT( "SHEETPATH" ) ) )
sheetPath = aJob->GetVarOverrides().at( wxT( "SHEETPATH" ) );
// We are feeding it one layer at the start here to silence a logic check
GERBER_PLOTTER* plotter = (GERBER_PLOTTER*) StartPlotBoard(
brd, &plotOpts, layer, fn.GetFullPath(), wxEmptyString, wxEmptyString );
GERBER_PLOTTER* plotter = (GERBER_PLOTTER*) StartPlotBoard( brd, &plotOpts, layer,
layerName, fn.GetFullPath(),
sheetName, sheetPath );
if( plotter )
{
@ -536,10 +591,30 @@ int PCBNEW_JOBS_HANDLER::JobExportGerber( JOB* aJob )
populateGerberPlotOptionsFromJob( plotOpts, aGerberJob );
plotOpts.SetLayerSelection( aGerberJob->m_printMaskLayer );
PCB_LAYER_ID layer = UNDEFINED_LAYER;
wxString layerName;
wxString sheetName;
wxString sheetPath;
if( aGerberJob->m_printMaskLayer.size() == 1 )
{
layer = aGerberJob->m_printMaskLayer.front();
layerName = brd->GetLayerName( layer );
}
if( aJob->GetVarOverrides().contains( wxT( "LAYER" ) ) )
layerName = aJob->GetVarOverrides().at( wxT( "LAYER" ) );
if( aJob->GetVarOverrides().contains( wxT( "SHEETNAME" ) ) )
sheetName = aJob->GetVarOverrides().at( wxT( "SHEETNAME" ) );
if( aJob->GetVarOverrides().contains( wxT( "SHEETPATH" ) ) )
sheetPath = aJob->GetVarOverrides().at( wxT( "SHEETPATH" ) );
// We are feeding it one layer at the start here to silence a logic check
GERBER_PLOTTER* plotter = (GERBER_PLOTTER*) StartPlotBoard(
brd, &plotOpts, aGerberJob->m_printMaskLayer.front(), aGerberJob->m_outputFile,
wxEmptyString, wxEmptyString );
GERBER_PLOTTER* plotter = (GERBER_PLOTTER*) StartPlotBoard( brd, &plotOpts, layer, layerName,
aGerberJob->m_outputFile,
sheetName, sheetPath );
if( plotter )
{

8
pcbnew/pcbplot.cpp
View File

@ -450,8 +450,10 @@ bool PLOT_CONTROLLER::OpenPlotfile( const wxString& aSuffix, PLOT_FORMAT aFormat
outputDirName = ExpandTextVars( outputDirName, &textResolver );
outputDirName = ExpandEnvVarSubstitutions( outputDirName, nullptr );
wxFileName outputDir = wxFileName::DirName( outputDirName );
wxString boardFilename = m_board->GetFileName();
wxFileName outputDir = wxFileName::DirName( outputDirName );
wxString boardFilename = m_board->GetFileName();
PCB_LAYER_ID layer = ToLAYER_ID( GetLayer() );
wxString layerName = m_board->GetLayerName( layer );
if( EnsureFileDirectoryExists( &outputDir, boardFilename ) )
{
@ -471,7 +473,7 @@ bool PLOT_CONTROLLER::OpenPlotfile( const wxString& aSuffix, PLOT_FORMAT aFormat
// Build plot filenames from the board name and layer names:
BuildPlotFileName( &m_plotFile, outputDir.GetPath(), aSuffix, fileExt );
m_plotter = StartPlotBoard( m_board, &GetPlotOptions(), ToLAYER_ID( GetLayer() ),
m_plotter = StartPlotBoard( m_board, &GetPlotOptions(), layer, layerName,
m_plotFile.GetFullPath(), aSheetName, aSheetPath );
}

4
pcbnew/pcbplot.h
View File

@ -140,8 +140,8 @@ private:
PLOTTER* StartPlotBoard( BOARD* aBoard, const PCB_PLOT_PARAMS* aPlotOpts, int aLayer,
const wxString& aFullFileName, const wxString& aSheetName,
const wxString& aSheetPath );
const wxString& aLayerName, const wxString& aFullFileName,
const wxString& aSheetName, const wxString& aSheetPath );
/**
* Plot a sequence of board layer IDs.

8
pcbnew/plot_board_layers.cpp
View File

@ -1151,8 +1151,8 @@ static void ConfigureHPGLPenSizes( HPGL_PLOTTER *aPlotter, const PCB_PLOT_PARAMS
* @return the plotter object if OK, NULL if the file is not created (or has a problem).
*/
PLOTTER* StartPlotBoard( BOARD *aBoard, const PCB_PLOT_PARAMS *aPlotOpts, int aLayer,
const wxString& aFullFileName, const wxString& aSheetName,
const wxString& aSheetPath )
const wxString& aLayerName, const wxString& aFullFileName,
const wxString& aSheetName, const wxString& aSheetPath )
{
// Create the plotter driver and set the few plotter specific options
PLOTTER* plotter = nullptr;
@ -1213,9 +1213,7 @@ PLOTTER* StartPlotBoard( BOARD *aBoard, const PCB_PLOT_PARAMS *aPlotOpts, int aL
KIGFX::PCB_RENDER_SETTINGS* renderSettings = new KIGFX::PCB_RENDER_SETTINGS();
renderSettings->LoadColors( aPlotOpts->ColorSettings() );
renderSettings->SetDefaultPenWidth( pcbIUScale.mmToIU( 0.0212 ) ); // Hairline at 1200dpi
if( aLayer >= 0 && aLayer < GAL_LAYER_ID_END )
renderSettings->SetLayerName( aBoard->GetLayerName( ToLAYER_ID( aLayer ) ) );
renderSettings->SetLayerName( aLayerName );
plotter->SetRenderSettings( renderSettings );