KiCad PCB EDA Suite
gerbview_printout.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #include <fctsys.h>
26 #include <pgm_base.h>
27 #include <gr_basic.h>
28 #include <base_units.h>
29 #include <base_screen.h>
30 #include <gerbview_frame.h>
31 #include <gerber_file_image.h>
32 #include <gerber_file_image_list.h>
33 #include "gerbview_printout.h"
34 #include <gal/gal_print.h>
35 #include <view/view.h>
36 #include <gerbview_painter.h>
37 #include <math/util.h> // for KiROUND
38 
39 
41  const KIGFX::VIEW* aView, const wxString& aTitle ) :
42  BOARD_PRINTOUT( aParams, aView, aTitle )
43 {
44  m_layout = aLayout;
45 }
46 
47 
49 {
50  // Store the layerset, as it is going to be modified below and the original settings are needed
51  LSET lset = m_settings.m_layerSet;
52 
53  // The gerber filename of the page to print will be printed to the worksheet.
54  // Find this filename:
55  // Find the graphic layer number for the page to print
56  LSEQ seq = lset.UIOrder();
57  wxCHECK( unsigned( aPage - 1 ) < seq.size(), false );
58  auto layerId = seq[aPage - 1];
59 
60  // In gerbview, draw layers are always printed on separate pages
61  // because handling negative objects when using only one page is tricky
62 
63  // Enable only one layer to create a printout
64  m_settings.m_layerSet = LSET( layerId );
65 
67  GERBER_FILE_IMAGE* gbrImage = gbrImgList.GetGbrImage( layerId );
68  wxString gbr_filename;
69 
70  if( gbrImage )
71  gbr_filename = gbrImage->m_FileName;
72 
73  DrawPage( gbr_filename, aPage, m_settings.m_pageCount );
74 
75  // Restore the original layer set, so the next page can be printed
76  m_settings.m_layerSet = lset;
77 
78  return true;
79 }
80 
81 
82 int GERBVIEW_PRINTOUT::milsToIU( double aMils ) const
83 {
84  return KiROUND( IU_PER_MILS * aMils );
85 }
86 
87 
88 void GERBVIEW_PRINTOUT::setupViewLayers( const std::unique_ptr<KIGFX::VIEW>& aView,
89  const LSET& aLayerSet )
90 {
91  BOARD_PRINTOUT::setupViewLayers( aView, aLayerSet );
92 
93  for( LSEQ layerSeq = m_settings.m_layerSet.Seq(); layerSeq; ++layerSeq )
94  aView->SetLayerVisible( GERBVIEW_LAYER_ID_START + *layerSeq, true );
95 }
96 
97 
99 {
100  BOARD_PRINTOUT::setupGal( aGal );
101  aGal->SetWorldUnitLength( 1.0/IU_PER_MM /* 10 nm */ / 25.4 /* 1 inch in mm */ );
102 }
103 
104 
106 {
107  return m_layout->ComputeBoundingBox();
108 }
109 
110 
111 std::unique_ptr<KIGFX::PAINTER> GERBVIEW_PRINTOUT::getPainter( KIGFX::GAL* aGal )
112 {
113  return std::unique_ptr<KIGFX::PAINTER>( new KIGFX::GERBVIEW_PAINTER( aGal ) );
114 }
void setupGal(KIGFX::GAL *aGal) override
Configures GAL object for a printout
GBR_LAYOUT holds list of GERBER_DRAW_ITEM currently loaded.
Definition: gbr_layout.h:48
Implementation of conversion functions that require both schematic and board internal units.
GBR_LAYOUT * m_layout
GERBER_FILE_IMAGE holds the Image data and parameters for one gerber file and layer parameters (TODO:...
virtual void DrawPage(const wxString &aLayerName=wxEmptyString, int aPageNum=1, int aPageCount=1)
Print a page (or a set of pages).
GERBER_FILE_IMAGE_LIST is a helper class to handle a list of GERBER_FILE_IMAGE files which are loaded...
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Function Seq returns an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:377
BOARD_PRINTOUT_SETTINGS m_settings
Printout parameters
std::unique_ptr< KIGFX::PAINTER > getPainter(KIGFX::GAL *aGal) override
Returns a PAINTER instance used to draw the items.
LSET is a set of PCB_LAYER_IDs.
GERBER_FILE_IMAGE * GetGbrImage(int aIdx)
GERBVIEW_PAINTER Contains methods for drawing GerbView-specific items.
bool OnPrintPage(int aPage) override
virtual void setupGal(KIGFX::GAL *aGal)
Configures GAL object for a printout
static GERBER_FILE_IMAGE_LIST & GetImagesList()
EDA_RECT ComputeBoundingBox() const
Function ComputeBoundingBox calculates the bounding box containing all Gerber items.
Definition: gbr_layout.cpp:50
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
void setupViewLayers(const std::unique_ptr< KIGFX::VIEW > &aView, const LSET &aLayerSet) override
Enables layers visibility for a printout
GERBVIEW_PRINTOUT(GBR_LAYOUT *aLayout, const BOARD_PRINTOUT_SETTINGS &aParams, const KIGFX::VIEW *aView, const wxString &aTitle)
see class PGM_BASE
virtual void setupViewLayers(const std::unique_ptr< KIGFX::VIEW > &aView, const LSET &aLayerSet)
Enables layers visibility for a printout
BOARD_PRINTOUT is a class derived from wxPrintout to handle the necessary information to control a pr...
int m_pageCount
Number of pages to print.
Definition: printout.h:47
int milsToIU(double aMils) const override
Convert mils to internal units
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
#define IU_PER_MILS
Definition: plotter.cpp:137
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61
EDA_RECT getBoundingBox() override
Returns bounding box of the printed objects (excluding worksheet frame)
VIEW.
Definition: view.h:61
BASE_SCREEN class implementation.
LSEQ UIOrder() const
Definition: lset.cpp:813
LSET m_layerSet
Layers to print.
Class GAL is the abstract interface for drawing on a 2D-surface.