74 m_schematic( aSchematic )
81 m_schematic( &aFrame->Schematic() )
88 REPORTER* aReporter,
const wxString& aExt )
101 fname.Replace(
"/",
"_" );
102 fname.Replace(
"\\",
"_" );
146 wxFileName plotFileName;
149 for(
unsigned i = 0; i < sheetList.size(); i++ )
156 wxString sheetName = sheetList[i].Last()->GetFields()[
SHEETNAME].GetShownText(
false );
160 msg = wxS(
"AUTHOR" );
165 msg = wxS(
"SUBJECT" );
180 if( !plotFileName.IsOk() )
183 if( !plotter->
OpenFile( plotFileName.GetFullPath() ) )
187 msg.Printf(
_(
"Failed to create file '%s'." ),
188 plotFileName.GetFullPath() );
198 plotter->
StartPlot( sheetList[i].GetPageNumber(), sheetName );
205 msg.Printf( wxT(
"PDF Plotter exception: %s" ), e.
What() );
219 plotter->
StartPage( sheetList[i].GetPageNumber(), sheetName );
228 msg.Printf(
_(
"Plotted to '%s'.\n" ), plotFileName.GetFullPath() );
245 aPlotter->
Rect(
VECTOR2I( 0, 0 ), end, FILL_T::FILLED_SHAPE, 1.0 );
267 aScreen->
Plot( aPlotter, aPlotOpts );
282 plotPage.
SetType( wxT(
"A" ) );
287 plotPage.
SetType( wxT(
"A4" ) );
293 plotPage = actualPage;
299 double scale = std::min( scalex, scaley );
338 for(
unsigned i = 0; i < sheetList.size(); i++ )
350 plotPage.
SetType( wxT(
"A" ) );
355 plotPage.
SetType( wxT(
"A4" ) );
360 default: plotPage = actualPage;
break;
365 double scale = std::min( scalex, scaley );
375 fname.Replace(
"/",
"_" );
376 fname.Replace(
"\\",
"_" );
382 if( !plotFileName.IsOk() )
385 if(
plotOneSheetPS( plotFileName.GetFullPath(), screen, aRenderSettings, actualPage,
386 plot_offset,
scale, aPlotOpts ) )
390 msg.Printf(
_(
"Plotted to '%s'." ), plotFileName.GetFullPath() );
399 msg.Printf(
_(
"Failed to create file '%s'." ), plotFileName.GetFullPath() );
408 msg.Printf( wxT(
"PS Plotter exception: %s" ), e.
What() );
425 const VECTOR2I& aPlot0ffset,
double aScale,
439 if( !plotter->
OpenFile( aFileName ) )
455 plotter->
Rect(
VECTOR2I( 0, 0 ), end, FILL_T::FILLED_SHAPE, 1.0 );
472 aScreen->
Plot( plotter, aPlotOpts );
505 for(
unsigned i = 0; i < sheetList.size(); i++ )
522 fname.Replace(
"/",
"_" );
523 fname.Replace(
"\\",
"_" );
529 if( !plotFileName.IsOk() )
532 bool success =
plotOneSheetSVG( plotFileName.GetFullPath(), screen, aRenderSettings,
539 msg.Printf(
_(
"Failed to create file '%s'." ), plotFileName.GetFullPath() );
547 msg.Printf(
_(
"Plotted to '%s'." ), plotFileName.GetFullPath() );
557 msg.Printf( wxT(
"SVG Plotter exception: %s" ), e.
What() );
584 plotPage.
SetType( wxT(
"A" ) );
589 plotPage.
SetType( wxT(
"A4" ) );
595 plotPage = actualPage;
607 double scale = std::min( scalex, scaley );
615 if( !plotter->
OpenFile( aFileName ) )
630 plotter->
Rect(
VECTOR2I( 0, 0 ), end, FILL_T::FILLED_SHAPE, 1.0 );
647 aScreen->
Plot( plotter, aPlotOpts );
686 for(
unsigned i = 0; i < sheetList.size(); i++ )
711 if( aPlotOpts.
m_HPGLPlotOrigin == HPGL_PLOT_ORIGIN_AND_UNITS::PLOTTER_CENTER )
723 fname.Replace(
"/",
"_" );
724 fname.Replace(
"\\",
"_" );
728 if( !plotFileName.IsOk() )
733 if(
plotOneSheetHpgl( plotFileName.GetFullPath(), screen, curPage, aRenderSettings,
734 plotOffset, plot_scale, aPlotOpts ) )
738 msg.Printf(
_(
"Plotted to '%s'." ), plotFileName.GetFullPath() );
746 msg.Printf(
_(
"Failed to create file '%s'." ), plotFileName.GetFullPath() );
755 msg.Printf( wxT(
"HPGL Plotter exception: %s" ), e.
What() );
772 const VECTOR2I& aPlot0ffset,
double aScale,
788 case HPGL_PLOT_ORIGIN_AND_UNITS::PLOTTER_BOT_LEFT:
789 case HPGL_PLOT_ORIGIN_AND_UNITS::PLOTTER_CENTER:
793 case HPGL_PLOT_ORIGIN_AND_UNITS::USER_FIT_PAGE:
797 case HPGL_PLOT_ORIGIN_AND_UNITS::USER_FIT_CONTENT:
804 plotter->
SetCreator( wxT(
"Eeschema-HPGL" ) );
806 if( !plotter->
OpenFile( aFileName ) )
832 aScreen->
Plot( plotter, aPlotOpts );
869 for(
unsigned i = 0; i < sheetList.size(); i++ )
886 fname.Replace(
"/",
"_" );
887 fname.Replace(
"\\",
"_" );
893 if( !plotFileName.IsOk() )
896 if(
plotOneSheetDXF( plotFileName.GetFullPath(), screen, aRenderSettings, plot_offset,
901 msg.Printf(
_(
"Plotted to '%s'." ), plotFileName.GetFullPath() );
909 msg.Printf(
_(
"Failed to create file '%s'." ), plotFileName.GetFullPath() );
918 msg.Printf( wxT(
"DXF Plotter exception: %s" ), e.
What() );
956 if( !plotter->
OpenFile( aFileName ) )
981 aScreen->
Plot( plotter, aPlotOpts );
1007 const wxString& aPlotFileName,
1008 const wxString& aExtension,
REPORTER* aReporter )
1014 retv.SetPath( tmp.GetPath() );
1016 if( !aPlotFileName.IsEmpty() )
1017 retv.SetName( aPlotFileName );
1019 retv.SetName(
_(
"Schematic" ) );
1021 retv.SetExt( aExtension );
1027 wxString msg = wxString::Format(
_(
"Failed to write plot files to folder '%s'." ),
1038 retv.SetPath( tmp.GetPath() );
1054 switch( aPlotFormat )
1057 case PLOT_FORMAT::POST:
createPSFiles( aPlotOpts, aRenderSettings, aReporter );
break;
1058 case PLOT_FORMAT::DXF:
createDXFFiles( aPlotOpts, aRenderSettings, aReporter );
break;
1059 case PLOT_FORMAT::PDF:
createPDFFile( aPlotOpts, aRenderSettings, aReporter );
break;
1060 case PLOT_FORMAT::SVG:
createSVGFiles( aPlotOpts, aRenderSettings, aReporter );
break;
1061 case PLOT_FORMAT::HPGL:
createHPGLFiles( aPlotOpts, aRenderSettings, aReporter );
break;
constexpr EDA_IU_SCALE schIUScale
int GetVirtualPageNumber() const
const wxString & GetPageNumber() const
static wxString GetDefaultFileExtension()
virtual void SetViewport(const VECTOR2I &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
Set the scale/position for the DXF plot.
virtual bool StartPlot(const wxString &aPageNumber) override
Open the DXF plot with a skeleton header.
virtual bool EndPlot() override
void SetUserCoordsFit(bool user_coords_fit)
Set whether the user coordinate system is fit to content.
void SetTargetChordLength(double chord_len)
Set the target length of chords used to draw approximated circles and arcs.
static wxString GetDefaultFileExtension()
void SetUserCoords(bool user_coords)
Switch to the user coordinate system.
virtual bool StartPlot(const wxString &aPageNumber) override
At the start of the HPGL plot pen speed and number are requested.
virtual void SetViewport(const VECTOR2I &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
Set the plot offset and scaling for the current plot.
virtual void SetPenDiameter(double diameter)
virtual bool EndPlot() override
HPGL end of plot: sort and emit graphics, pen return and release.
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()
A color representation with 4 components: red, green, blue, alpha.
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
void SetDefaultPenWidth(int aWidth)
virtual void LoadColors(const COLOR_SETTINGS *aSettings)
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
virtual const COLOR4D & GetBackgroundColor() const =0
Return current background color settings.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Describe the page size and margins of a paper page on which to eventually print or plot.
void SetPortrait(bool aIsPortrait)
Rotate the paper page 90 degrees.
int GetHeightIU(double aIUScale) const
Gets the page height in IU.
double GetHeightMils() const
int GetWidthIU(double aIUScale) const
Gets the page width in IU.
double GetWidthMils() const
bool SetType(const wxString &aStandardPageDescriptionName, bool aIsPortrait=false)
Set the name of the page type and also the sizes and margins commonly associated with that type name.
virtual void StartPage(const wxString &aPageNumber, const wxString &aPageName=wxEmptyString)
Start a new page in the PDF document.
virtual void ClosePage()
Close the current page in the PDF document (and emit its compressed stream).
virtual bool EndPlot() override
virtual bool OpenFile(const wxString &aFullFilename) override
Open or create the plot file aFullFilename.
virtual bool StartPlot(const wxString &aPageNumber) override
The PDF engine supports multiple pages; the first one is opened 'for free' the following are to be cl...
static wxString GetDefaultFileExtension()
virtual SETTINGS_MANAGER & GetSettingsManager() const
Base plotter engine class.
virtual bool OpenFile(const wxString &aFullFilename)
Open or create the plot file aFullFilename.
virtual void SetAuthor(const wxString &aAuthor)
virtual void SetPageSettings(const PAGE_INFO &aPageSettings)
void SetRenderSettings(RENDER_SETTINGS *aSettings)
virtual void SetTitle(const wxString &aTitle)
RENDER_SETTINGS * RenderSettings()
virtual void SetCreator(const wxString &aCreator)
bool GetColorMode() const
PAGE_INFO & PageSettings()
virtual void SetViewport(const VECTOR2I &aOffset, double aIusPerDecimil, double aScale, bool aMirror)=0
Set the plot offset and scaling for the current plot.
virtual void SetColorMode(bool aColorMode)
Plot in B/W or color.
virtual void SetSubject(const wxString &aSubject)
virtual void Rect(const VECTOR2I &p1, const VECTOR2I &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
virtual void SetColor(const COLOR4D &color)=0
virtual void SetColor(const COLOR4D &color) override
The SetColor implementation is split with the subclasses: the PSLIKE computes the rgb values,...
virtual bool EndPlot() override
virtual void SetViewport(const VECTOR2I &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
Set the plot offset and scaling for the current plot.
virtual void Rect(const VECTOR2I &p1, const VECTOR2I &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
virtual bool StartPlot(const wxString &aPageNumber) override
The code within this function (and the CloseFilePS function) creates postscript files whose contents ...
static wxString GetDefaultFileExtension()
A pure virtual class used to derive REPORTER objects from.
virtual REPORTER & ReportTail(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Places the report at the end of the list, for objects that support report ordering.
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
These settings were stored in SCH_BASE_FRAME previously.
wxString m_PlotDirectoryName
Holds all the data relating to one schematic.
SCH_SHEET_PATH & CurrentSheet() const override
SCHEMATIC_SETTINGS & Settings() const
void SetCurrentSheet(const SCH_SHEET_PATH &aPath) override
SCH_SCREEN * RootScreen() const
Helper to retrieve the screen of the root sheet.
bool ResolveTextVar(const SCH_SHEET_PATH *aSheetPath, wxString *token, int aDepth) const
const std::map< wxString, wxString > * GetProperties()
wxString GetUniqueFilenameForCurrentSheet()
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Schematic editor (Eeschema) main window.
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 aPlotSettings.
wxFileName getOutputFilenameSingle(const SCH_PLOT_OPTS &aPlotOpts, REPORTER *aReporter, const wxString &ext)
Returns the output filename for formats where the output is a single file.
void createSVGFiles(const SCH_PLOT_OPTS &aPlotOpts, SCH_RENDER_SETTINGS *aRenderSettings, REPORTER *aReporter)
void createPSFiles(const SCH_PLOT_OPTS &aPlotOpts, SCH_RENDER_SETTINGS *aRenderSettings, REPORTER *aReporter)
void plotOneSheetPDF(PLOTTER *aPlotter, SCH_SCREEN *aScreen, const SCH_PLOT_OPTS &aPlotOpts)
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.
SCH_PLOTTER(SCH_EDIT_FRAME *aFrame)
Constructor for usage with a frame having the schematic we want to print loaded.
bool plotOneSheetDXF(const wxString &aFileName, SCH_SCREEN *aScreen, RENDER_SETTINGS *aRenderSettings, const VECTOR2I &aPlotOffset, double aScale, const SCH_PLOT_OPTS &aPlotOpts)
void createDXFFiles(const SCH_PLOT_OPTS &aPlotOpts, SCH_RENDER_SETTINGS *aRenderSettings, REPORTER *aReporter)
void createHPGLFiles(const SCH_PLOT_OPTS &aPlotOpts, SCH_RENDER_SETTINGS *aRenderSettings, REPORTER *aReporter)
wxString m_lastOutputFilePath
void restoreEnvironment(PDF_PLOTTER *aPlotter, SCH_SHEET_PATH &aOldsheetpath)
Everything done, close the plot and restore the environment.
bool plotOneSheetSVG(const wxString &aFileName, SCH_SCREEN *aScreen, RENDER_SETTINGS *aRenderSettings, const SCH_PLOT_OPTS &aPlotOpts)
void setupPlotPagePDF(PLOTTER *aPlotter, SCH_SCREEN *aScreen, const SCH_PLOT_OPTS &aPlotOpts)
bool plotOneSheetHpgl(const wxString &aFileName, SCH_SCREEN *aScreen, const PAGE_INFO &aPageInfo, RENDER_SETTINGS *aRenderSettings, const VECTOR2I &aPlot0ffset, double aScale, const SCH_PLOT_OPTS &aPlotOpts)
void createPDFFile(const SCH_PLOT_OPTS &aPlotOpts, SCH_RENDER_SETTINGS *aRenderSettings, REPORTER *aReporter)
COLOR_SETTINGS * m_colorSettings
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)
const PAGE_INFO & GetPageSettings() const
const wxString & GetFileName() const
SCHEMATIC * Schematic() const
const TITLE_BLOCK & GetTitleBlock() const
void Plot(PLOTTER *aPlotter, const SCH_PLOT_OPTS &aPlotOpts) const
Plot all the schematic objects to aPlotter.
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
void TrimToPageNumbers(const std::vector< wxString > &aPageInclusions)
Truncates the list by removing sheet's with page numbers not in the given list.
void SortByPageNumbers(bool aUpdateVirtualPageNums=true)
Sort the list of sheets by page number.
void BuildSheetList(SCH_SHEET *aSheet, bool aCheckIntegrity)
Build the list of sheets and their sheet path from aSheet.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
wxString PathHumanReadable(bool aUseShortRootName=true, bool aStripTrailingSeparator=false) const
Return the sheet path in a human readable form made from the sheet names.
void UpdateAllScreenReferences() const
Update all the symbol references for this sheet path.
SCH_SCREEN * LastScreen()
wxString GetPageNumber() const
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
virtual bool StartPlot(const wxString &aPageNumber) override
Create SVG file header.
virtual void SetViewport(const VECTOR2I &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
Set the plot offset and scaling for the current plot.
virtual void Rect(const VECTOR2I &p1, const VECTOR2I &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
virtual bool EndPlot() override
static wxString GetDefaultFileExtension()
const wxString & GetTitle() const
bool EnsureFileDirectoryExists(wxFileName *aTargetFullFileName, const wxString &aBaseFilename, REPORTER *aReporter)
Make aTargetFullFileName absolute and create the path of this file if it doesn't yet exist.
wxString ExpandTextVars(const wxString &aSource, const PROJECT *aProject)
void PlotDrawingSheet(PLOTTER *plotter, const PROJECT *aProject, const TITLE_BLOCK &aTitleBlock, const PAGE_INFO &aPageInfo, const std::map< wxString, wxString > *aProperties, const wxString &aSheetNumber, int aSheetCount, const wxString &aSheetName, const wxString &aSheetPath, const wxString &aFilename, COLOR4D aColor, bool aIsFirstPage)
const wxChar *const tracePathsAndFiles
Flag to enable path and file name debug output.
@ LAYER_SCHEMATIC_DRAWINGSHEET
@ LAYER_SCHEMATIC_BACKGROUND
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)
static const wxChar * plot_sheet_list(HPGL_PAGE_SIZE aSize)
constexpr int mmToIU(double mm) const
std::vector< wxString > m_plotPages
wxString m_outputDirectory
HPGL_PLOT_ORIGIN_AND_UNITS m_HPGLPlotOrigin
HPGL_PAGE_SIZE m_HPGLPaperSizeSelect
bool m_useBackgroundColor
wxLogTrace helper definitions.