KiCad PCB EDA Suite
plot_schematic_HPGL.cpp
Go to the documentation of this file.
1 
4 /*
5  * This program source code file is part of KiCad, a free EDA CAD application.
6  *
7  * Copyright (C) 1992-2010 Jean-Pierre Charras jp.charras at wanadoo.fr
8  * Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, you may find one here:
22  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23  * or you may search the http://www.gnu.org website for the version 2 license,
24  * or you may write to the Free Software Foundation, Inc.,
25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26  */
27 
28 #include <fctsys.h>
29 #include <plotter.h>
30 #include <sch_edit_frame.h>
31 #include <base_units.h>
32 #include <sch_sheet_path.h>
33 #include <project.h>
34 #include <pgm_base.h>
36 
37 #include <dialog_plot_schematic.h>
38 #include <wx_html_report_panel.h>
39 
52 };
53 
54 
55 static const wxChar* plot_sheet_list( int aSize )
56 {
57  switch( aSize )
58  {
59  default:
60  case PAGE_DEFAULT: return nullptr;
61  case HPGL_PAGE_SIZE_A4: return wxT( "A4" );
62  case HPGL_PAGE_SIZE_A3: return wxT( "A3" );
63  case HPGL_PAGE_SIZE_A2: return wxT( "A2" );
64  case HPGL_PAGE_SIZE_A1: return wxT( "A1" );
65  case HPGL_PAGE_SIZE_A0: return wxT( "A0" );
66  case HPGL_PAGE_SIZE_A: return wxT( "A" );
67  case HPGL_PAGE_SIZE_B: return wxT( "B" );
68  case HPGL_PAGE_SIZE_C: return wxT( "C" );
69  case HPGL_PAGE_SIZE_D: return wxT( "D" );
70  case HPGL_PAGE_SIZE_E: return wxT( "E" );
71  }
72 }
73 
74 
76 {
78 
79  if( m_HPGLPenSize > Millimeter2iu( 2 ) )
80  m_HPGLPenSize = Millimeter2iu( 2 );
81 
82  if( m_HPGLPenSize < Millimeter2iu( 0.01 ) )
83  m_HPGLPenSize = Millimeter2iu( 0.01 );
84 }
85 
86 
87 void DIALOG_PLOT_SCHEMATIC::createHPGLFile( bool aPlotAll, bool aPlotFrameRef )
88 {
89  SCH_SCREEN* screen = m_parent->GetScreen();
90  SCH_SHEET_PATH oldsheetpath = m_parent->GetCurrentSheet();
91 
92  /* When printing all pages, the printed page is not the current page.
93  * In complex hierarchies, we must setup references and other parameters
94  * in the printed SCH_SCREEN
95  * because in complex hierarchies a SCH_SCREEN (a schematic drawings)
96  * is shared between many sheets
97  */
98  SCH_SHEET_LIST sheetList;
99 
100  if( aPlotAll )
101  sheetList.BuildSheetList( g_RootSheet );
102  else
103  sheetList.push_back( m_parent->GetCurrentSheet() );
104 
105  REPORTER& reporter = m_MessagesBox->Reporter();
106 
107  SetHPGLPenWidth();
108 
109  for( unsigned i = 0; i < sheetList.size(); i++ )
110  {
111  m_parent->SetCurrentSheet( sheetList[i] );
114 
115  screen = m_parent->GetCurrentSheet().LastScreen();
116 
117  if( !screen ) // LastScreen() may return NULL
118  screen = m_parent->GetScreen();
119 
120  const PAGE_INFO& curPage = screen->GetPageSettings();
121 
122  PAGE_INFO plotPage = curPage;
123 
124  // if plotting on a page size other than curPage
125  if( m_paperSizeOption->GetSelection() != PAGE_DEFAULT )
126  plotPage.SetType( plot_sheet_list( m_paperSizeOption->GetSelection() ) );
127 
128  // Calculation of conversion scales.
129  double plot_scale = (double) plotPage.GetWidthMils() / curPage.GetWidthMils();
130 
131  // Calculate offsets
132  wxPoint plotOffset;
133  wxString msg;
134 
135  if( GetPlotOriginCenter() )
136  {
137  plotOffset.x = plotPage.GetWidthIU() / 2;
138  plotOffset.y = -plotPage.GetHeightIU() / 2;
139  }
140 
141  try
142  {
143  wxString fname = m_parent->GetUniqueFilenameForCurrentSheet();
144  wxString ext = HPGL_PLOTTER::GetDefaultFileExtension();
145  wxFileName plotFileName = createPlotFileName( m_outputDirectoryName, fname,
146  ext, &reporter );
147 
148  LOCALE_IO toggle;
149 
150  if( Plot_1_Page_HPGL( plotFileName.GetFullPath(), screen, plotPage, plotOffset,
151  plot_scale, aPlotFrameRef ) )
152  {
153  msg.Printf( _( "Plot: \"%s\" OK.\n" ), plotFileName.GetFullPath() );
154  reporter.Report( msg, RPT_SEVERITY_ACTION );
155  }
156  else
157  {
158  msg.Printf( _( "Unable to create file \"%s\".\n" ), plotFileName.GetFullPath() );
159  reporter.Report( msg, RPT_SEVERITY_ERROR );
160  }
161  }
162  catch( IO_ERROR& e )
163  {
164  msg.Printf( wxT( "HPGL Plotter exception: %s"), e.What() );
165  reporter.Report( msg, RPT_SEVERITY_ERROR );
166  }
167 
168  }
169 
170  m_parent->SetCurrentSheet( oldsheetpath );
173 }
174 
175 
176 bool DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL( const wxString& aFileName,
177  SCH_SCREEN* aScreen,
178  const PAGE_INFO& aPageInfo,
179  wxPoint aPlot0ffset,
180  double aScale,
181  bool aPlotFrameRef )
182 {
183  HPGL_PLOTTER* plotter = new HPGL_PLOTTER();
184 
185  plotter->SetPageSettings( aPageInfo );
186  // Currently, plot units are in decimil
187  plotter->SetViewport( aPlot0ffset, IU_PER_MILS/10, aScale, false );
188 
189  // Init :
190  plotter->SetCreator( wxT( "Eeschema-HPGL" ) );
191 
192  if( ! plotter->OpenFile( aFileName ) )
193  {
194  delete plotter;
195  return false;
196  }
197 
198  LOCALE_IO toggle;
199 
200  // Pen num and pen speed are not initialized here.
201  // Default HPGL driver values are used
202  plotter->SetPenDiameter( m_HPGLPenSize );
203  plotter->StartPlot();
204 
205  if( getPlotFrameRef() )
206  PlotWorkSheet( plotter, m_parent->GetTitleBlock(),
208  aScreen->m_ScreenNumber, aScreen->m_NumberOfScreens,
210  aScreen->GetFileName(),
211  COLOR4D::BLACK );
212 
213  aScreen->Plot( plotter );
214 
215  plotter->EndPlot();
216  delete plotter;
217 
218  return true;
219 }
void SetCurrentSheet(const SCH_SHEET_PATH &aSheet)
SCH_SHEET_LIST.
virtual bool EndPlot() override
HPGL end of plot: pen return and release.
const wxString & GetFileName() const
Definition: sch_screen.h:157
int m_ScreenNumber
Definition: base_screen.h:135
virtual void SetCreator(const wxString &aCreator)
Definition: plotter.h:180
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:202
Implementation of conversion functions that require both schematic and board internal units.
virtual bool OpenFile(const wxString &aFullFilename)
Open or create the plot file aFullFilename.
Definition: plotter.cpp:82
bool SetType(const wxString &aStandardPageDescriptionName, bool aIsPortrait=false)
Function SetType sets the name of the page type and also the sizes and margins commonly associated wi...
Definition: page_info.cpp:117
virtual void SetPenDiameter(double diameter)
REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:62
void UpdateAllScreenReferences()
Function UpdateAllScreenReferences updates the reference and the m_Multi parameter (part selection) f...
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:152
virtual bool StartPlot() override
At the start of the HPGL plot pen speed and number are requested.
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
virtual void SetViewport(const wxPoint &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
Set the plot offset and scaling for the current plot.
void PlotWorkSheet(PLOTTER *plotter, const TITLE_BLOCK &aTitleBlock, const PAGE_INFO &aPageInfo, int aSheetNumber, int aNumberOfSheets, const wxString &aSheetDesc, const wxString &aFilename, const COLOR4D aColor)
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
wxString GetScreenDesc() const override
Return a human-readable description of the current screen.
void createHPGLFile(bool aPlotAll, bool aPlotFrameRef)
static const wxChar * plot_sheet_list(int aSize)
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
wxFileName createPlotFileName(wxTextCtrl *aOutputDirectoryName, wxString &aPlotFileName, wxString &aExtension, REPORTER *aReporter=NULL)
Create a file name with an absolute path name.
PAGE_INFO describes the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:54
REPORTER & Reporter()
returns the reporter object that reports to this panel
SCH_SHEET_PATH & GetCurrentSheet()
SCH_SHEET_PATH.
void BuildSheetList(SCH_SHEET *aSheet)
Function BuildSheetList builds the list of sheets and their sheet path from aSheet.
void Plot(PLOTTER *aPlotter)
Plot all the schematic objects to aPlotter.
Definition: sch_screen.cpp:573
const PAGE_INFO & GetPageSettings() const override
see class PGM_BASE
SCH_SCREEN * LastScreen()
Function LastScreen.
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
#define _(s)
Definition: 3d_actions.cpp:33
const TITLE_BLOCK & GetTitleBlock() const override
static wxString GetDefaultFileExtension()
Definition: plotter.h:632
#define IU_PER_MILS
Definition: plotter.cpp:137
wxString GetUniqueFilenameForCurrentSheet()
virtual long long int GetValue()
Function GetValue Returns the current value in Internal Units.
int m_NumberOfScreens
Definition: base_screen.h:136
bool Plot_1_Page_HPGL(const wxString &aFileName, SCH_SCREEN *aScreen, const PAGE_INFO &aPageInfo, wxPoint aPlot0ffset, double aScale, bool aPlotFrameRef)
SCH_SHEET * g_RootSheet
Definition: colors.h:45
WX_HTML_REPORT_PANEL * m_MessagesBox
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
int GetWidthMils() const
Definition: page_info.h:137
virtual void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: plotter.h:147