Schematic plotting class. More...

#include <sch_plotter.h>

Public Member Functions
	SCH_PLOTTER (SCH_EDIT_FRAME *aFrame)
	Constructor for usage with a frame having the schematic we want to print loaded.

	SCH_PLOTTER (SCHEMATIC *aSch)
	Constructor for usage with a schematic that can be headless.

void	Plot (PLOT_FORMAT aPlotFormat, const SCH_PLOT_OPTS &aPlotOpts, SCH_RENDER_SETTINGS aRenderSettings, REPORTER aReporter=nullptr)
	Perform the plotting of the schematic using the given aPlotFormat and a\ aPlotSettings.

wxString	GetLastOutputFilePath () const
	Get the last output file path, this is mainly intended for PDFs with the open after plot GUI option.

Protected Member Functions
wxFileName	getOutputFilenameSingle (const SCH_PLOT_OPTS &aPlotOpts, REPORTER *aReporter, const wxString &ext)
	Return the output filename for formats where the output is a single file.

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)

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)

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)

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)

void	restoreEnvironment (PDF_PLOTTER *aPlotter, SCH_SHEET_PATH &aOldsheetpath)
	Everything done, close the plot and restore the environment.

wxFileName	createPlotFileName (const SCH_PLOT_OPTS &aPlotOpts, const wxString &aPlotFileName, const wxString &aExtension, REPORTER *aReporter=nullptr)
	Create a file name with an absolute path name.

Private Attributes
SCHEMATIC *	m_schematic

COLOR_SETTINGS *	m_colorSettings

wxString	m_lastOutputFilePath

Detailed Description

Schematic plotting class.

Definition at line 94 of file sch_plotter.h.

Constructor & Destructor Documentation

◆ SCH_PLOTTER() [1/2]

SCH_PLOTTER::SCH_PLOTTER ( SCH_EDIT_FRAME * aFrame )

Constructor for usage with a frame having the schematic we want to print loaded.

Definition at line 58 of file sch_plotter.cpp.

References m_colorSettings.

◆ SCH_PLOTTER() [2/2]

SCH_PLOTTER::SCH_PLOTTER ( SCHEMATIC * aSch )

Constructor for usage with a schematic that can be headless.

Definition at line 51 of file sch_plotter.cpp.

References m_colorSettings.

Member Function Documentation

◆ createDXFFiles()

void SCH_PLOTTER::createDXFFiles	(	const SCH_PLOT_OPTS &	aPlotOpts,
		SCH_RENDER_SETTINGS *	aRenderSettings,
		REPORTER *	aReporter
	)

protected

◆ createPDFFile()

void SCH_PLOTTER::createPDFFile	(	const SCH_PLOT_OPTS &	aPlotOpts,
		SCH_RENDER_SETTINGS *	aRenderSettings,
		REPORTER *	aReporter
	)

protected

Definition at line 88 of file sch_plotter.cpp.

References _, SCH_SHEET_LIST::BuildSheetList(), PDF_PLOTTER::ClosePage(), SCHEMATIC::CurrentSheet(), ExpandTextVars(), PDF_PLOTTER::GetDefaultFileExtension(), SCH_SHEET::GetField(), getOutputFilenameSingle(), SCH_SHEET_PATH::GetPageNumber(), SCH_FIELD::GetShownText(), TITLE_BLOCK::GetTitle(), SCH_SCREEN::GetTitleBlock(), SCH_SHEET_PATH::Last(), SCH_SHEET_PATH::LastScreen(), SCH_PLOT_OPTS::m_blackAndWhite, m_lastOutputFilePath, SCH_PLOT_OPTS::m_PDFMetadata, SCH_PLOT_OPTS::m_plotAll, SCH_PLOT_OPTS::m_plotPages, m_schematic, PDF_PLOTTER::OpenFile(), plotOneSheetPDF(), SCH_SHEET_PATH::pop_back(), SCHEMATIC::Project(), REPORTER::Report(), REPORTER::ReportTail(), SCHEMATIC::ResolveTextVar(), restoreEnvironment(), SCHEMATIC::Root(), SCHEMATIC::RootScreen(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, PLOTTER::SetAuthor(), PLOTTER::SetColorMode(), PLOTTER::SetCreator(), SCHEMATIC::SetCurrentSheet(), PLOTTER::SetRenderSettings(), SCHEMATIC::SetSheetNumberAndCount(), PLOTTER::SetSubject(), PLOTTER::SetTitle(), setupPlotPagePDF(), SCH_SHEET_PATH::size(), SCH_SHEET_LIST::SortByHierarchicalPageNumbers(), PDF_PLOTTER::StartPage(), PDF_PLOTTER::StartPlot(), SCH_SHEET_LIST::TrimToPageNumbers(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and IO_ERROR::What().

Referenced by Plot().

◆ createPlotFileName()

wxFileName SCH_PLOTTER::createPlotFileName	(	const SCH_PLOT_OPTS &	aPlotOpts,
		const wxString &	aPlotFileName,
		const wxString &	aExtension,
		REPORTER *	aReporter = `nullptr`
	)

protected

Create a file name with an absolute path name.

Parameters

aPlotFileName	the name for the file to plot without a path.
aExtension	the extension for the file to plot.
aReporter	a point to a REPORTER object use to show messages (can be NULL).

Returns: the created file name.

Exceptions

IO_ERROR on file I/O errors.

Definition at line 839 of file sch_plotter.cpp.

References _, REPORTER::Clear(), EnsureFileDirectoryExists(), SCH_PLOT_OPTS::m_outputDirectory, SCHEMATIC_SETTINGS::m_PlotDirectoryName, m_schematic, REPORTER::Report(), RPT_SEVERITY_ERROR, SCHEMATIC::Settings(), and tracePathsAndFiles.

Referenced by createDXFFiles(), createPSFiles(), createSVGFiles(), and getOutputFilenameSingle().

◆ createPSFiles()

void SCH_PLOTTER::createPSFiles	(	const SCH_PLOT_OPTS &	aPlotOpts,
		SCH_RENDER_SETTINGS *	aRenderSettings,
		REPORTER *	aReporter
	)

protected

Definition at line 312 of file sch_plotter.cpp.

References _, SCH_SHEET_LIST::BuildSheetList(), createPlotFileName(), SCHEMATIC::CurrentSheet(), PS_PLOTTER::GetDefaultFileExtension(), PAGE_INFO::GetHeightMils(), SCH_SCREEN::GetPageSettings(), SCHEMATIC::GetUniqueFilenameForCurrentSheet(), PAGE_INFO::GetWidthMils(), PAGE_INFO::IsPortrait(), SCH_SHEET_PATH::LastScreen(), m_lastOutputFilePath, SCH_PLOT_OPTS::m_pageSizeSelect, SCH_PLOT_OPTS::m_plotAll, SCH_PLOT_OPTS::m_plotPages, m_schematic, PAGE_SIZE_A, PAGE_SIZE_A4, PAGE_SIZE_AUTO, plotOneSheetPS(), REPORTER::Report(), REPORTER::ReportTail(), restoreEnvironment(), SCHEMATIC::Root(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, scale, SCHEMATIC::SetCurrentSheet(), PAGE_INFO::SetPortrait(), SCHEMATIC::SetSheetNumberAndCount(), PAGE_INFO::SetType(), SCH_SHEET_LIST::SortByPageNumbers(), SCH_SHEET_LIST::TrimToPageNumbers(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and IO_ERROR::What().

Referenced by Plot().

◆ createSVGFiles()

void SCH_PLOTTER::createSVGFiles	(	const SCH_PLOT_OPTS &	aPlotOpts,
		SCH_RENDER_SETTINGS *	aRenderSettings,
		REPORTER *	aReporter
	)

protected

◆ GetLastOutputFilePath()

wxString SCH_PLOTTER::GetLastOutputFilePath ( ) const

inline

Get the last output file path, this is mainly intended for PDFs with the open after plot GUI option.

Definition at line 122 of file sch_plotter.h.

References m_lastOutputFilePath.

◆ getOutputFilenameSingle()

wxFileName SCH_PLOTTER::getOutputFilenameSingle	(	const SCH_PLOT_OPTS &	aPlotOpts,
		REPORTER *	aReporter,
		const wxString &	ext
	)

protected

Return the output filename for formats where the output is a single file.

Definition at line 65 of file sch_plotter.cpp.

References createPlotFileName(), SCHEMATIC::GetUniqueFilenameForCurrentSheet(), SCH_PLOT_OPTS::m_outputFile, and m_schematic.

Referenced by createPDFFile().

◆ Plot()

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

Perform the plotting of the schematic using the given aPlotFormat and a\ aPlotSettings.

Parameters

aPlotFormat	The resulting output plot format (PDF, SVG, DXF, etc)
aPlotSettings	The configuration for the plotting operation
aRenderSettings	Mandatory object containing render settings for lower level classes
aReporter	Optional reporter to print messages to

Definition at line 881 of file sch_plotter.cpp.

References createDXFFiles(), createPDFFile(), createPSFiles(), createSVGFiles(), GetColorSettings(), m_colorSettings, and SCH_PLOT_OPTS::m_theme.

◆ plotOneSheetDXF()

bool SCH_PLOTTER::plotOneSheetDXF	(	const wxString &	aFileName,
		SCH_SCREEN *	aScreen,
		RENDER_SETTINGS *	aRenderSettings,
		const VECTOR2I &	aPlotOffset,
		double	aScale,
		const SCH_PLOT_OPTS &	aPlotOpts
	)

protected

Definition at line 769 of file sch_plotter.cpp.

References color, SCHEMATIC::CurrentSheet(), DXF_PLOTTER::EndPlot(), PLOTTER::GetColorMode(), SCH_SCREEN::GetFileName(), KIGFX::RENDER_SETTINGS::GetLayerColor(), SCH_SHEET::GetName(), BASE_SCREEN::GetPageCount(), SCH_SHEET_PATH::GetPageNumber(), BASE_SCREEN::GetPageNumber(), SCH_SCREEN::GetPageSettings(), SCHEMATIC::GetProperties(), SCH_SCREEN::GetTitleBlock(), BASE_SCREEN::GetVirtualPageNumber(), EDA_IU_SCALE::IU_PER_MILS, SCH_SHEET_PATH::Last(), LAYER_SCHEMATIC_DRAWINGSHEET, KIGFX::RENDER_SETTINGS::LoadColors(), SCH_PLOT_OPTS::m_blackAndWhite, m_colorSettings, SCH_PLOT_OPTS::m_plotDrawingSheet, m_schematic, PLOTTER::OpenFile(), SCH_SHEET_PATH::PathHumanReadable(), SCH_SCREEN::Plot(), PlotDrawingSheet(), SCHEMATIC::Project(), PLOTTER::RenderSettings(), SCH_SCREEN::Schematic(), schIUScale, PLOTTER::SetColorMode(), PLOTTER::SetCreator(), KIGFX::RENDER_SETTINGS::SetDefaultPenWidth(), PLOTTER::SetPageSettings(), PLOTTER::SetRenderSettings(), DXF_PLOTTER::SetViewport(), and DXF_PLOTTER::StartPlot().

Referenced by createDXFFiles().

◆ plotOneSheetPDF()

void SCH_PLOTTER::plotOneSheetPDF	(	PLOTTER *	aPlotter,
		SCH_SCREEN *	aScreen,
		const SCH_PLOT_OPTS &	aPlotOpts
	)

protected

Definition at line 238 of file sch_plotter.cpp.

References color, SCHEMATIC::CurrentSheet(), end, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), PLOTTER::GetColorMode(), SCH_SCREEN::GetFileName(), PAGE_INFO::GetHeightIU(), KIGFX::RENDER_SETTINGS::GetLayerColor(), SCH_SHEET::GetName(), BASE_SCREEN::GetPageCount(), BASE_SCREEN::GetPageNumber(), SCH_SCREEN::GetPageSettings(), SCHEMATIC::GetProperties(), SCH_SCREEN::GetTitleBlock(), BASE_SCREEN::GetVirtualPageNumber(), PAGE_INFO::GetWidthIU(), EDA_IU_SCALE::IU_PER_MILS, SCH_SHEET_PATH::Last(), LAYER_SCHEMATIC_DRAWINGSHEET, SCH_PLOT_OPTS::m_plotDrawingSheet, m_schematic, SCH_PLOT_OPTS::m_useBackgroundColor, SCH_SHEET_PATH::PathHumanReadable(), SCH_SCREEN::Plot(), PlotDrawingSheet(), SCHEMATIC::Project(), PLOTTER::Rect(), PLOTTER::RenderSettings(), SCH_SCREEN::Schematic(), schIUScale, and PLOTTER::SetColor().

Referenced by createPDFFile().

◆ plotOneSheetPS()

bool SCH_PLOTTER::plotOneSheetPS	(	const wxString &	aFileName,
		SCH_SCREEN *	aScreen,
		RENDER_SETTINGS *	aRenderSettings,
		const PAGE_INFO &	aPageInfo,
		const VECTOR2I &	aPlot0ffset,
		double	aScale,
		const SCH_PLOT_OPTS &	aPlotOpts
	)

protected

Definition at line 434 of file sch_plotter.cpp.

References color, SCHEMATIC::CurrentSheet(), end, PS_PLOTTER::EndPlot(), PLOTTER::GetColorMode(), SCH_SCREEN::GetFileName(), PAGE_INFO::GetHeightIU(), KIGFX::RENDER_SETTINGS::GetLayerColor(), SCH_SHEET::GetName(), BASE_SCREEN::GetPageCount(), SCH_SHEET_PATH::GetPageNumber(), BASE_SCREEN::GetPageNumber(), SCH_SCREEN::GetPageSettings(), SCHEMATIC::GetProperties(), SCH_SCREEN::GetTitleBlock(), BASE_SCREEN::GetVirtualPageNumber(), PAGE_INFO::GetWidthIU(), EDA_IU_SCALE::IU_PER_MILS, SCH_SHEET_PATH::Last(), LAYER_SCHEMATIC_BACKGROUND, LAYER_SCHEMATIC_DRAWINGSHEET, SCH_PLOT_OPTS::m_blackAndWhite, SCH_PLOT_OPTS::m_plotDrawingSheet, m_schematic, SCH_PLOT_OPTS::m_useBackgroundColor, PLOTTER::OpenFile(), SCH_SHEET_PATH::PathHumanReadable(), SCH_SCREEN::Plot(), PlotDrawingSheet(), SCHEMATIC::Project(), PS_PLOTTER::Rect(), PLOTTER::RenderSettings(), SCH_SCREEN::Schematic(), schIUScale, PSLIKE_PLOTTER::SetColor(), PLOTTER::SetColorMode(), PLOTTER::SetCreator(), PLOTTER::SetPageSettings(), PLOTTER::SetRenderSettings(), PS_PLOTTER::SetViewport(), and PS_PLOTTER::StartPlot().

Referenced by createPSFiles().

◆ plotOneSheetSVG()

bool SCH_PLOTTER::plotOneSheetSVG	(	const wxString &	aFileName,
		SCH_SCREEN *	aScreen,
		RENDER_SETTINGS *	aRenderSettings,
		const SCH_PLOT_OPTS &	aPlotOpts
	)

protected

Definition at line 587 of file sch_plotter.cpp.

References color, SCHEMATIC::CurrentSheet(), end, SVG_PLOTTER::EndPlot(), PLOTTER::GetColorMode(), SCH_SCREEN::GetFileName(), PAGE_INFO::GetHeightIU(), PAGE_INFO::GetHeightMils(), KIGFX::RENDER_SETTINGS::GetLayerColor(), SCH_SHEET::GetName(), BASE_SCREEN::GetPageCount(), SCH_SHEET_PATH::GetPageNumber(), BASE_SCREEN::GetPageNumber(), SCH_SCREEN::GetPageSettings(), SCHEMATIC::GetProperties(), SCH_SCREEN::GetTitleBlock(), BASE_SCREEN::GetVirtualPageNumber(), PAGE_INFO::GetWidthIU(), PAGE_INFO::GetWidthMils(), PAGE_INFO::IsPortrait(), EDA_IU_SCALE::IU_PER_MILS, SCH_SHEET_PATH::Last(), LAYER_SCHEMATIC_BACKGROUND, LAYER_SCHEMATIC_DRAWINGSHEET, SCH_PLOT_OPTS::m_blackAndWhite, SCH_PLOT_OPTS::m_pageSizeSelect, SCH_PLOT_OPTS::m_plotDrawingSheet, m_schematic, SCH_PLOT_OPTS::m_useBackgroundColor, PLOTTER::OpenFile(), PAGE_SIZE_A, PAGE_SIZE_A4, PAGE_SIZE_AUTO, SCH_SHEET_PATH::PathHumanReadable(), SCH_SCREEN::Plot(), PlotDrawingSheet(), SCHEMATIC::Project(), SVG_PLOTTER::Rect(), PLOTTER::RenderSettings(), scale, SCH_SCREEN::Schematic(), schIUScale, PSLIKE_PLOTTER::SetColor(), PLOTTER::SetColorMode(), PLOTTER::SetCreator(), PLOTTER::SetPageSettings(), PAGE_INFO::SetPortrait(), PLOTTER::SetRenderSettings(), PAGE_INFO::SetType(), SVG_PLOTTER::SetViewport(), and SVG_PLOTTER::StartPlot().

Referenced by createSVGFiles().

◆ restoreEnvironment()

void SCH_PLOTTER::restoreEnvironment	(	PDF_PLOTTER *	aPlotter,
		SCH_SHEET_PATH &	aOldsheetpath
	)

protected

Everything done, close the plot and restore the environment.

Parameters

aPlotter	the plotter to close and destroy (can be null if no current active plotter)
aOldsheetpath	the stored old sheet path for the current sheet before the plot started

Definition at line 824 of file sch_plotter.cpp.

References SCHEMATIC::CurrentSheet(), PDF_PLOTTER::EndPlot(), m_schematic, SCHEMATIC::SetCurrentSheet(), SCHEMATIC::SetSheetNumberAndCount(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

Referenced by createDXFFiles(), createPDFFile(), createPSFiles(), and createSVGFiles().

◆ setupPlotPagePDF()

void SCH_PLOTTER::setupPlotPagePDF	(	PLOTTER *	aPlotter,
		SCH_SCREEN *	aScreen,
		const SCH_PLOT_OPTS &	aPlotOpts
	)

protected

Definition at line 276 of file sch_plotter.cpp.

References PAGE_INFO::GetHeightMils(), SCH_SCREEN::GetPageSettings(), PAGE_INFO::GetWidthMils(), PAGE_INFO::IsPortrait(), EDA_IU_SCALE::IU_PER_MILS, SCH_PLOT_OPTS::m_pageSizeSelect, PAGE_SIZE_A, PAGE_SIZE_A4, PAGE_SIZE_AUTO, scale, schIUScale, PLOTTER::SetPageSettings(), PAGE_INFO::SetPortrait(), PAGE_INFO::SetType(), and PLOTTER::SetViewport().

Referenced by createPDFFile().

Member Data Documentation

◆ m_colorSettings

COLOR_SETTINGS* SCH_PLOTTER::m_colorSettings

private

Definition at line 182 of file sch_plotter.h.

Referenced by Plot(), plotOneSheetDXF(), and SCH_PLOTTER().

◆ m_lastOutputFilePath

wxString SCH_PLOTTER::m_lastOutputFilePath

private

Definition at line 183 of file sch_plotter.h.

Referenced by createDXFFiles(), createPDFFile(), createPSFiles(), createSVGFiles(), and GetLastOutputFilePath().

◆ m_schematic

SCHEMATIC* SCH_PLOTTER::m_schematic

private

Definition at line 181 of file sch_plotter.h.

Referenced by createDXFFiles(), createPDFFile(), createPlotFileName(), createPSFiles(), createSVGFiles(), getOutputFilenameSingle(), plotOneSheetDXF(), plotOneSheetPDF(), plotOneSheetPS(), plotOneSheetSVG(), and restoreEnvironment().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCH_PLOTTER() [1/2]

◆ SCH_PLOTTER() [2/2]

Member Function Documentation

◆ createDXFFiles()

◆ createPDFFile()

◆ createPlotFileName()

◆ createPSFiles()

◆ createSVGFiles()

◆ GetLastOutputFilePath()

◆ getOutputFilenameSingle()

◆ Plot()

◆ plotOneSheetDXF()

◆ plotOneSheetPDF()

◆ plotOneSheetPS()

◆ plotOneSheetSVG()

◆ restoreEnvironment()

◆ setupPlotPagePDF()

Member Data Documentation

◆ m_colorSettings

◆ m_lastOutputFilePath

◆ m_schematic