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 
35 #include <dialog_plot_schematic.h>
36 #include <wx_html_report_panel.h>
37 
50 };
51 
52 
53 static const wxChar* plot_sheet_list( int aSize )
54 {
55  switch( aSize )
56  {
57  default:
58  case PAGE_DEFAULT: return nullptr;
59  case HPGL_PAGE_SIZE_A4: return wxT( "A4" );
60  case HPGL_PAGE_SIZE_A3: return wxT( "A3" );
61  case HPGL_PAGE_SIZE_A2: return wxT( "A2" );
62  case HPGL_PAGE_SIZE_A1: return wxT( "A1" );
63  case HPGL_PAGE_SIZE_A0: return wxT( "A0" );
64  case HPGL_PAGE_SIZE_A: return wxT( "A" );
65  case HPGL_PAGE_SIZE_B: return wxT( "B" );
66  case HPGL_PAGE_SIZE_C: return wxT( "C" );
67  case HPGL_PAGE_SIZE_D: return wxT( "D" );
68  case HPGL_PAGE_SIZE_E: return wxT( "E" );
69  }
70 }
71 
72 
74 {
76 
77  if( m_HPGLPenSize > Millimeter2iu( 2 ) )
78  m_HPGLPenSize = Millimeter2iu( 2 );
79 
80  if( m_HPGLPenSize < Millimeter2iu( 0.01 ) )
81  m_HPGLPenSize = Millimeter2iu( 0.01 );
82 }
83 
84 
85 void DIALOG_PLOT_SCHEMATIC::createHPGLFile( bool aPlotAll, bool aPlotFrameRef )
86 {
87  SCH_SCREEN* screen = m_parent->GetScreen();
88  SCH_SHEET_PATH oldsheetpath = m_parent->GetCurrentSheet();
89 
90  /* When printing all pages, the printed page is not the current page.
91  * In complex hierarchies, we must setup references and other parameters
92  * in the printed SCH_SCREEN
93  * because in complex hierarchies a SCH_SCREEN (a schematic drawings)
94  * is shared between many sheets
95  */
96  SCH_SHEET_LIST sheetList;
97 
98  if( aPlotAll )
99  sheetList.BuildSheetList( g_RootSheet );
100  else
101  sheetList.push_back( m_parent->GetCurrentSheet() );
102 
103  REPORTER& reporter = m_MessagesBox->Reporter();
104 
105  SetHPGLPenWidth();
106 
107  for( unsigned i = 0; i < sheetList.size(); i++ )
108  {
109  m_parent->SetCurrentSheet( sheetList[i] );
112 
113  screen = m_parent->GetCurrentSheet().LastScreen();
114 
115  if( !screen ) // LastScreen() may return NULL
116  screen = m_parent->GetScreen();
117 
118  const PAGE_INFO& curPage = screen->GetPageSettings();
119 
120  PAGE_INFO plotPage = curPage;
121 
122  // if plotting on a page size other than curPage
123  if( m_paperSizeOption->GetSelection() != PAGE_DEFAULT )
124  plotPage.SetType( plot_sheet_list( m_paperSizeOption->GetSelection() ) );
125 
126  // Calculation of conversion scales.
127  double plot_scale = (double) plotPage.GetWidthMils() / curPage.GetWidthMils();
128 
129  // Calculate offsets
130  wxPoint plotOffset;
131  wxString msg;
132 
133  if( GetPlotOriginCenter() )
134  {
135  plotOffset.x = plotPage.GetWidthIU() / 2;
136  plotOffset.y = -plotPage.GetHeightIU() / 2;
137  }
138 
139  try
140  {
141  wxString fname = m_parent->GetUniqueFilenameForCurrentSheet();
142  wxString ext = HPGL_PLOTTER::GetDefaultFileExtension();
143  wxFileName plotFileName = createPlotFileName( m_outputDirectoryName, fname,
144  ext, &reporter );
145 
146  LOCALE_IO toggle;
147 
148  if( Plot_1_Page_HPGL( plotFileName.GetFullPath(), screen, plotPage, plotOffset,
149  plot_scale, aPlotFrameRef ) )
150  {
151  msg.Printf( _( "Plot: \"%s\" OK.\n" ), GetChars( plotFileName.GetFullPath() ) );
152  reporter.Report( msg, REPORTER::RPT_ACTION );
153  }
154  else
155  {
156  msg.Printf( _( "Unable to create file \"%s\".\n" ),
157  GetChars( plotFileName.GetFullPath() ) );
158  reporter.Report( msg, REPORTER::RPT_ERROR );
159  }
160  }
161  catch( IO_ERROR& e )
162  {
163  msg.Printf( wxT( "HPGL Plotter exception: %s"), GetChars( e.What() ) );
164  reporter.Report( msg, REPORTER::RPT_ERROR );
165  }
166 
167  }
168 
169  m_parent->SetCurrentSheet( oldsheetpath );
172 }
173 
174 
175 bool DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL( const wxString& aFileName,
176  SCH_SCREEN* aScreen,
177  const PAGE_INFO& aPageInfo,
178  wxPoint aPlot0ffset,
179  double aScale,
180  bool aPlotFrameRef )
181 {
182  HPGL_PLOTTER* plotter = new HPGL_PLOTTER();
183 
184  plotter->SetPageSettings( aPageInfo );
185  // Currently, plot units are in decimil
186  plotter->SetViewport( aPlot0ffset, IU_PER_MILS/10, aScale, false );
187 
188  // Init :
189  plotter->SetCreator( wxT( "Eeschema-HPGL" ) );
190 
191  if( ! plotter->OpenFile( aFileName ) )
192  {
193  delete plotter;
194  return false;
195  }
196 
197  LOCALE_IO toggle;
198 
199  // Pen num and pen speed are not initialized here.
200  // Default HPGL driver values are used
201  plotter->SetPenDiameter( m_HPGLPenSize );
202  plotter->StartPlot();
203 
204  plotter->SetColor( BLACK );
205 
206  if( getPlotFrameRef() )
207  PlotWorkSheet( plotter, m_parent->GetTitleBlock(),
209  aScreen->m_ScreenNumber, aScreen->m_NumberOfScreens,
211  aScreen->GetFileName() );
212 
213  aScreen->Plot( plotter );
214 
215  plotter->EndPlot();
216  delete plotter;
217 
218  return true;
219 }
void SetCurrentSheet(const SCH_SHEET_PATH &aSheet)
Class SCH_SHEET_LIST.
virtual bool EndPlot() override
HPGL end of plot: pen return and release.
virtual void SetColor(COLOR4D color) override
Definition: plotter.h:604
int m_ScreenNumber
Definition: base_screen.h:216
virtual void SetCreator(const wxString &aCreator)
Definition: plotter.h:161
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown...
Definition: common.h:179
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:79
const wxString & GetFileName() const
Definition: sch_screen.h:131
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)
SCH_SCREEN * LastScreen() const
Function LastScreen.
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
void UpdateAllScreenReferences()
Function UpdateAllScreenReferences updates the reference and the m_Multi parameter (part selection) f...
virtual void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: plotter.cpp:537
virtual bool StartPlot() override
At the start of the HPGL plot pen speed and number are requested.
void PlotWorkSheet(PLOTTER *plotter, const TITLE_BLOCK &aTitleBlock, const PAGE_INFO &aPageInfo, int aSheetNumber, int aNumberOfSheets, const wxString &aSheetDesc, const wxString &aFilename)
virtual void SetViewport(const wxPoint &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
Set the plot offset and scaling for the current plot.
virtual int GetValue()
Function GetValue Returns the current value in Internal Units.
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
virtual wxString GetScreenDesc() const override
void createHPGLFile(bool aPlotAll, bool aPlotFrameRef)
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:56
static const wxChar * plot_sheet_list(int aSize)
wxFileName createPlotFileName(wxTextCtrl *aOutputDirectoryName, wxString &aPlotFileName, wxString &aExtension, REPORTER *aReporter=NULL)
Create a file name with an absolute path name.
Class PAGE_INFO describes the page size and margins of a paper page on which to eventually print or p...
Definition: page_info.h:54
REPORTER & Reporter()
returns the reporter object that reports to this panel
SCH_SHEET_PATH & GetCurrentSheet()
Class SCH_SHEET_PATH.
void BuildSheetList(SCH_SHEET *aSheet)
Function BuildSheetList builds the list of sheets and their sheet path from aSheet.
int GetWidthMils() const
Definition: page_info.h:137
void Plot(PLOTTER *aPlotter)
Plot all the schematic objects to aPlotter.
Definition: sch_screen.cpp:533
const PAGE_INFO & GetPageSettings() const override
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
const TITLE_BLOCK & GetTitleBlock() const override
size_t i
Definition: json11.cpp:597
static wxString GetDefaultFileExtension()
Definition: plotter.h:586
#define IU_PER_MILS
Definition: plotter.cpp:134
wxString GetUniqueFilenameForCurrentSheet()
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
int m_NumberOfScreens
Definition: base_screen.h:217
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:126
bool Plot_1_Page_HPGL(const wxString &aFileName, SCH_SCREEN *aScreen, const PAGE_INFO &aPageInfo, wxPoint aPlot0ffset, double aScale, bool aPlotFrameRef)
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