pcb_plotter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <pcb_plot_params.h>
#include <map>
#include <vector>
 
class BOARD;
class FOOTPRINT;
class PROJECT;
class REPORTER;
class wxFileName;
class JOB_EXPORT_PCB_PLOT;
 
class PCB_PLOTTER
{
public:
    PCB_PLOTTER( BOARD* aBoard, REPORTER* aReporter, PCB_PLOT_PARAMS& aParams );
 
    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 );

    static void BuildPlotFileName( wxFileName* aFilename, const wxString& aOutputDir, const wxString& aSuffix,
                                   const wxString& aExtension );


    static void PlotJobToPlotOpts( PCB_PLOT_PARAMS& aOpts, JOB_EXPORT_PCB_PLOT* aJob,
                                   REPORTER& aReporter );
 
protected:
    BOARD*          m_board;
    PCB_PLOT_PARAMS m_plotOpts;
    REPORTER*       m_reporter;
 
private:
    LSEQ getPlotSequence( PCB_LAYER_ID aLayerToPlot, LSEQ aPlotWithAllLayersSeq );
 
};
 

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 = nullptr );