sch_plotter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2018 Jean-Pierre Charras jp.charras at wanadoo.fr
 * Copyright (C) 1992-2010 Lorenzo Marcantonio
 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
 * 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/>.
 */
 
#ifndef SCH_PLOTTER_H
#define SCH_PLOTTER_H
 
#include <wx/filename.h>
#include <wx/string.h>
#include <wx/gdicmn.h>
#include <page_info.h>
#include <sch_render_settings.h>
#include <sch_sheet_path.h>
#include <optional>
#include <plotters/plotter.h>
#include <plotters/plotter_png.h>
 
class SCH_EDIT_FRAME;
class PLOTTER;
class SCHEMATIC;
class SCH_SCREEN;
using KIGFX::RENDER_SETTINGS;
class PDF_PLOTTER;
class REPORTER;
class LIB_SYMBOL;
 
enum PageFormatReq
{
    PAGE_SIZE_AUTO,
    PAGE_SIZE_A4,
    PAGE_SIZE_A
};
 
 
struct SCH_PLOT_OPTS
{
    bool                  m_plotAll;
    bool                  m_plotDrawingSheet;
    std::vector<wxString> m_plotPages;
 
    // Sheet to plot in single-sheet mode; unset plots the schematic's current sheet
    std::optional<SCH_SHEET_PATH> m_sheetPath;
 
    bool           m_plotHopOver;
    bool           m_blackAndWhite;
    int            m_pageSizeSelect;
    bool           m_useBackgroundColor;
    bool           m_PDFPropertyPopups;
    bool           m_PDFHierarchicalLinks;
    bool           m_PDFMetadata;
    wxString       m_theme;
 
    wxString       m_outputDirectory;
    wxString       m_outputFile;
    wxString       m_variant;
 
    // has meaning only with DXF plotter: set DXF units in DXF file
    DXF_UNITS      m_DXF_File_Unit;
 
    int            m_pngDPI;
    bool           m_pngAntialias;
 
    SCH_PLOT_OPTS() :
        m_plotAll( true ),
        m_plotDrawingSheet( true ),
        m_plotHopOver( false ),
        m_blackAndWhite( false ),
        m_pageSizeSelect( 0 ),
        m_useBackgroundColor( true ),
        m_PDFPropertyPopups( false ),
        m_PDFHierarchicalLinks( false ),
        m_PDFMetadata( false ),
        m_theme(),
        m_outputDirectory(),
        m_outputFile(),
        m_DXF_File_Unit( DXF_UNITS::INCH ),
        m_pngDPI( DEFAULT_PNG_DPI ),
        m_pngAntialias( true )
    {
 
    }
};
 

class SCH_PLOTTER
{
public:
    SCH_PLOTTER( SCH_EDIT_FRAME* aFrame );

    SCH_PLOTTER( SCHEMATIC* aSch );

    void Plot( PLOT_FORMAT aPlotFormat, const SCH_PLOT_OPTS& aPlotOpts,
               SCH_RENDER_SETTINGS* aRenderSettings, REPORTER* aReporter = nullptr );

    wxString GetLastOutputFilePath() const { return m_lastOutputFilePath; }

    const std::vector<wxString>& GetOutputFilePaths() const { return m_outputFilePaths; }
 
protected:
    wxFileName getOutputFilenameSingle( const SCH_PLOT_OPTS& aPlotOpts, REPORTER* aReporter,
                                        const wxString& ext );
 
    // PDF
    void createPDFFile( const SCH_PLOT_OPTS& aPlotOpts, SCH_RENDER_SETTINGS* aRenderSettings,
                        REPORTER* aReporter );
    void plotOneSheetPDF( PLOTTER* aPlotter, SCH_SCREEN* aScreen, const SCH_PLOT_OPTS& aPlotOpts );
    void setupPlotPagePDF( PLOTTER* aPlotter, SCH_SCREEN* aScreen, const SCH_PLOT_OPTS& aPlotOpts );
 
    // DXF
    void createDXFFiles( const SCH_PLOT_OPTS& aPlotOpts, SCH_RENDER_SETTINGS* aRenderSettings,
                         REPORTER* aReporter );
    bool plotOneSheetDXF( const wxString& aFileName, SCH_SCREEN* aScreen,
                          RENDER_SETTINGS* aRenderSettings, const VECTOR2I& aPlotOffset,
                          double aScale, const SCH_PLOT_OPTS& aPlotOpts );
 
 
    // PS
    void createPSFiles( const SCH_PLOT_OPTS& aPlotOpts, SCH_RENDER_SETTINGS* aRenderSettings,
                        REPORTER* aReporter );
    bool plotOneSheetPS( const wxString& aFileName, SCH_SCREEN* aScreen,
                         RENDER_SETTINGS* aRenderSettings, const PAGE_INFO& aPageInfo,
                         const VECTOR2I& aPlot0ffset, double aScale,
                         const SCH_PLOT_OPTS& aPlotOpts );
 
    // SVG
    void createSVGFiles( const SCH_PLOT_OPTS& aPlotOpts, SCH_RENDER_SETTINGS* aRenderSettings,
                         REPORTER* aReporter );
    bool plotOneSheetSVG( const wxString& aFileName, SCH_SCREEN* aScreen,
                          RENDER_SETTINGS* aRenderSettings, const SCH_PLOT_OPTS& aPlotOpts );
 
    // PNG
    void createPNGFiles( const SCH_PLOT_OPTS& aPlotOpts, SCH_RENDER_SETTINGS* aRenderSettings,
                         REPORTER* aReporter );
    bool plotOneSheetPNG( const wxString& aFileName, SCH_SCREEN* aScreen,
                          RENDER_SETTINGS* aRenderSettings, const SCH_PLOT_OPTS& aPlotOpts );

    wxFileName createPlotFileName( const SCH_PLOT_OPTS& aPlotOpts, const wxString& aPlotFileName,
                                   const wxString& aExtension, REPORTER* aReporter = nullptr );
 
private:
    SCHEMATIC*      m_schematic;
    COLOR_SETTINGS* m_colorSettings;
    wxString        m_lastOutputFilePath;
    std::vector<wxString> m_outputFilePaths;
};
 

BOX2I GetSymbolPlotBBox( const LIB_SYMBOL& aSymbol, int aUnit, int aBodyStyle, bool aIncludeHiddenFields );
 

bool PlotSymbolToSVG( LIB_SYMBOL& aDrawSymbol, LIB_SYMBOL& aFieldsSymbol, int aUnit, int aBodyStyle, const BOX2I& aBBox,
                      SCH_RENDER_SETTINGS& aRenderSettings, bool aBlackAndWhite, const wxString& aFileName,
                      REPORTER* aReporter = nullptr );
 
#endif