KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcbnew_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) 2009 Jean-Pierre Charras, [email protected]
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 * Copyright (C) 2018 CERN
7 * Author: Maciej Suminski <[email protected]>
8 * Author: Tomasz Wlostowski <[email protected]>
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 "pcbnew_printout.h"
29#include <board.h>
30#include <math/util.h> // for KiROUND
32#include <lset.h>
33#include <pcb_painter.h>
34#include <pcbnew_settings.h>
35#include <view/view.h>
36#include <pcbplot.h>
38#include <pad.h>
39
40#include <advanced_config.h>
41#include <pgm_base.h>
42
44 BOARD_PRINTOUT_SETTINGS( aPageInfo )
45{
46 m_DrillMarks = DRILL_MARKS::SMALL_DRILL_SHAPE;
49 m_AsItemCheckboxes = false;
50}
51
52
54{
56}
57
58
60{
62}
63
64
66 const KIGFX::VIEW* aView, const wxString& aTitle ) :
67 BOARD_PRINTOUT( aParams, aView, aTitle ), m_pcbnewSettings( aParams )
68{
69 m_board = aBoard;
70}
71
72
74{
75 // Store the layerset, as it is going to be modified below and the original settings are
76 // needed.
78 int pageCount = lset.count();
79 wxString layerName;
80 PCB_LAYER_ID extractLayer;
81
82 // compute layer mask from page number if we want one page per layer
84 {
85 // This sequence is TBD, call a different sequencer if needed, such as Seq().
86 // Could not find documentation on page order.
87 LSEQ seq = lset.UIOrder();
88
89 // aPage starts at 1, not 0
90 if( unsigned( aPage - 1 ) < seq.size() )
91 m_settings.m_LayerSet = LSET( { seq[aPage - 1] } );
92 }
93
94 if( !m_settings.m_LayerSet.any() )
95 return false;
96
97 extractLayer = m_settings.m_LayerSet.ExtractLayer();
98
99 if( extractLayer == UNDEFINED_LAYER )
100 layerName = _( "Multiple Layers" );
101 else
102 layerName = m_board->GetLayerName( extractLayer );
103
104 // In Pcbnew we can want the layer EDGE always printed
107
108 DrawPage( layerName, aPage, pageCount );
109
110 // Restore the original layer set, so the next page can be printed
111 m_settings.m_LayerSet = lset;
112
113 return true;
114}
115
116
117int PCBNEW_PRINTOUT::milsToIU( double aMils ) const
118{
119 return KiROUND( pcbIUScale.IU_PER_MILS * aMils );
120}
121
122
123void PCBNEW_PRINTOUT::setupViewLayers( KIGFX::VIEW& aView, const LSET& aLayerSet )
124{
125 BOARD_PRINTOUT::setupViewLayers( aView, aLayerSet );
126
127 for( PCB_LAYER_ID layer : m_settings.m_LayerSet )
128 {
129 aView.SetLayerVisible( PCBNEW_LAYER_ID_START + layer, true );
130
131 // Enable the corresponding zone layer (copper layers and other layers)
132 aView.SetLayerVisible( LAYER_ZONE_START + layer, true );
133 aView.SetLayerVisible( LAYER_PAD_COPPER_START + layer, true );
134 aView.SetLayerVisible( LAYER_VIA_COPPER_START + layer, true );
135 }
136
137 RENDER_SETTINGS* renderSettings = aView.GetPainter()->GetSettings();
138 // A color to do not print objects on some layers, when the layer must be enabled
139 // to print some other objects
140 COLOR4D invisible_color = COLOR4D::UNSPECIFIED;
141
143 {
144 auto setVisibility =
145 [&]( GAL_LAYER_ID aLayer )
146 {
147 if( m_board->IsElementVisible( aLayer ) )
148 aView.SetLayerVisible( aLayer, true );
149 else
150 renderSettings->SetLayerColor( aLayer, invisible_color );
151 };
152
153 setVisibility( LAYER_FOOTPRINTS_FR );
154 setVisibility( LAYER_FOOTPRINTS_BK );
155 setVisibility( LAYER_FP_VALUES );
156 setVisibility( LAYER_FP_REFERENCES );
157 setVisibility( LAYER_FP_TEXT );
158 setVisibility( LAYER_PADS );
159
160 setVisibility( LAYER_TRACKS );
161 setVisibility( LAYER_VIAS );
162 setVisibility( LAYER_VIA_MICROVIA );
163 setVisibility( LAYER_VIA_BBLIND );
164 setVisibility( LAYER_VIA_THROUGH );
165 setVisibility( LAYER_ZONES );
166 setVisibility( LAYER_FILLED_SHAPES );
167
168 setVisibility( LAYER_DRC_WARNING );
169 setVisibility( LAYER_DRC_ERROR );
170 setVisibility( LAYER_DRC_SHAPE1 );
171 setVisibility( LAYER_DRC_SHAPE2 );
172 setVisibility( LAYER_DRC_EXCLUSION );
173 setVisibility( LAYER_ANCHOR );
174 setVisibility( LAYER_DRAWINGSHEET );
175 setVisibility( LAYER_GRID );
176 }
177 else
178 {
179 // Enable items on copper layers, but do not draw holes
181 {
182 if( ( aLayerSet & LSET::AllCuMask() ).any() ) // Items visible on any copper layer
183 aView.SetLayerVisible( layer, true );
184 else
185 renderSettings->SetLayerColor( layer, invisible_color );
186 }
187
188 // Keep certain items always enabled/disabled and just rely on the layer visibility
189 // Note LAYER_PADS_SMD_FR, LAYER_PADS_SMD_BK, LAYER_PADS_TH are enabled here because paths must
190 // be drawn on some other (technical) layers.
191 const int alwaysEnabled[] =
192 {
198 };
199
200 for( int layer : alwaysEnabled )
201 aView.SetLayerVisible( layer, true );
202 }
203
204 if( m_pcbnewSettings.m_DrillMarks != DRILL_MARKS::NO_DRILL_SHAPE )
205 {
206 // Enable hole layers to draw drill marks
208 {
209 aView.SetLayerVisible( layer, true );
210 aView.SetTopLayer( layer, true );
211 }
212
213 if( m_pcbnewSettings.m_DrillMarks == DRILL_MARKS::FULL_DRILL_SHAPE
215 {
216 for( int layer : { LAYER_PAD_HOLEWALLS, LAYER_VIA_HOLEWALLS } )
217 {
218 aView.SetLayerVisible( layer, true );
219 aView.SetTopLayer( layer, true );
220 }
221 }
222 }
223}
224
225
227{
229
230 KIGFX::PCB_PRINT_PAINTER& painter = dynamic_cast<KIGFX::PCB_PRINT_PAINTER&>( aPainter );
231
233 {
234 case DRILL_MARKS::NO_DRILL_SHAPE:
235 painter.SetDrillMarks( false, 0 );
236 break;
237
238 case DRILL_MARKS::SMALL_DRILL_SHAPE:
240
241 painter.GetSettings()->SetLayerColor( LAYER_PAD_PLATEDHOLES, COLOR4D::BLACK );
242 painter.GetSettings()->SetLayerColor( LAYER_NON_PLATEDHOLES, COLOR4D::BLACK );
243 painter.GetSettings()->SetLayerColor( LAYER_VIA_HOLES, COLOR4D::BLACK );
244 break;
245
246 case DRILL_MARKS::FULL_DRILL_SHAPE:
247 painter.SetDrillMarks( true );
248
249 painter.GetSettings()->SetLayerColor( LAYER_PAD_PLATEDHOLES, COLOR4D::BLACK );
250 painter.GetSettings()->SetLayerColor( LAYER_NON_PLATEDHOLES, COLOR4D::BLACK );
251 painter.GetSettings()->SetLayerColor( LAYER_VIA_HOLES, COLOR4D::BLACK );
252 break;
253 }
254}
255
256
258{
260 aGal->SetWorldUnitLength( 0.001/pcbIUScale.IU_PER_MM /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
261}
262
263
265{
266 return m_board->ComputeBoundingBox( false );
267}
268
269
270std::unique_ptr<KIGFX::PAINTER> PCBNEW_PRINTOUT::getPainter( KIGFX::GAL* aGal )
271{
272 return std::make_unique<KIGFX::PCB_PRINT_PAINTER>( aGal );
273}
274
275
278 m_drillMarkReal( false ),
279 m_drillMarkSize( 0 )
280{ }
281
282
284{
285 return m_drillMarkReal ? KIGFX::PCB_PAINTER::getDrillShape( aPad ) : PAD_DRILL_SHAPE::CIRCLE;
286}
287
288
290{
291 if( m_drillMarkReal )
293 else
294 return SHAPE_SEGMENT( aPad->GetPosition(), aPad->GetPosition(), m_drillMarkSize );
295}
296
297
299{
300 return m_drillMarkReal ? KIGFX::PCB_PAINTER::getViaDrillSize( aVia ) : m_drillMarkSize;
301}
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:112
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition: box2.h:990
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:108
BASE_SET & set(size_t pos)
Definition: base_set.h:116
An object derived from wxPrintout to handle the necessary information to control a printer when print...
virtual void DrawPage(const wxString &aLayerName=wxEmptyString, int aPageNum=1, int aPageCount=1)
Print a page (or a set of pages).
virtual void setupPainter(KIGFX::PAINTER &aPainter)
Configure #PAINTER object for a printout.
virtual void setupViewLayers(KIGFX::VIEW &aView, const LSET &aLayerSet)
Enable layers visibility for a printout.
virtual void setupGal(KIGFX::GAL *aGal)
Configure #GAL object for a printout.
BOARD_PRINTOUT_SETTINGS m_settings
Printout parameters.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:317
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition: board.cpp:973
BOX2I ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
Definition: board.cpp:1851
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:680
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Abstract interface for drawing on a 2D-surface.
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.
Contains all the knowledge about how to draw graphical object onto any particular output device.
Definition: painter.h:59
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
Contains methods for drawing PCB-specific items.
Definition: pcb_painter.h:182
virtual SHAPE_SEGMENT getPadHoleShape(const PAD *aPad) const
Return hole shape for a pad (internal units).
virtual PCB_RENDER_SETTINGS * GetSettings() override
Return a pointer to current settings that are going to be used when drawing items.
Definition: pcb_painter.h:187
virtual PAD_DRILL_SHAPE getDrillShape(const PAD *aPad) const
Return drill shape of a pad.
virtual int getViaDrillSize(const PCB_VIA *aVia) const
Return drill diameter for a via (internal units).
Special flavor of PCB_PAINTER that contains modifications to handle printing options.
void SetDrillMarks(bool aRealSize, unsigned int aSize=0)
Set drill marks visibility and options.
SHAPE_SEGMENT getPadHoleShape(const PAD *aPad) const override
Return hole shape for a pad (internal units).
int getViaDrillSize(const PCB_VIA *aVia) const override
Return drill diameter for a via (internal units).
PAD_DRILL_SHAPE getDrillShape(const PAD *aPad) const override
Return drill shape of a pad.
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
void SetLayerColor(int aLayer, const COLOR4D &aColor)
Change the color used to draw a layer.
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:66
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition: view.h:400
virtual void SetTopLayer(int aLayer, bool aEnabled=true)
Set given layer to be displayed on the top or sets back the default order of layers.
Definition: view.cpp:839
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:220
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
Definition: lseq.h:47
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:37
LSEQ UIOrder() const
Return the copper, technical and user layers in the order shown in layer widget.
Definition: lset.cpp:733
PCB_LAYER_ID ExtractLayer() const
Find the first set PCB_LAYER_ID.
Definition: lset.cpp:525
static LSET AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition: lset.cpp:591
Definition: pad.h:54
VECTOR2I GetPosition() const override
Definition: pad.h:208
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:59
int milsToIU(double aMils) const override
Convert mils to internal units.
bool OnPrintPage(int aPage) override
std::unique_ptr< KIGFX::PAINTER > getPainter(KIGFX::GAL *aGal) override
Return the #PAINTER instance used to draw the items.
void setupGal(KIGFX::GAL *aGal) override
Configure #GAL object for a printout.
PCBNEW_PRINTOUT(BOARD *aBoard, const PCBNEW_PRINTOUT_SETTINGS &aParams, const KIGFX::VIEW *aView, const wxString &aTitle)
PCBNEW_PRINTOUT_SETTINGS m_pcbnewSettings
void setupPainter(KIGFX::PAINTER &aPainter) override
Configure #PAINTER object for a printout.
BOX2I getBoundingBox() override
Return bounding box of the printed objects (excluding drawing-sheet frame).
void setupViewLayers(KIGFX::VIEW &aView, const LSET &aLayerSet) override
Enable layers visibility for a printout.
#define _(s)
@ FRAME_PCB_EDITOR
Definition: frame_type.h:42
double m_SmallDrillMarkSize
The diameter of the drill marks on print and plot outputs (in mm) when the "Drill marks" option is se...
constexpr PCB_LAYER_ID PCBNEW_LAYER_ID_START
Definition: layer_ids.h:174
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition: layer_ids.h:228
@ LAYER_GRID
Definition: layer_ids.h:253
@ LAYER_PAD_COPPER_START
Virtual layers for pad copper on a given copper layer.
Definition: layer_ids.h:332
@ LAYER_VIA_HOLEWALLS
Definition: layer_ids.h:297
@ LAYER_FILLED_SHAPES
Copper graphic shape opacity/visibility (color ignored).
Definition: layer_ids.h:312
@ LAYER_FOOTPRINTS_FR
Show footprints on front.
Definition: layer_ids.h:258
@ LAYER_DRC_SHAPE1
Custom shape for DRC marker.
Definition: layer_ids.h:314
@ LAYER_NON_PLATEDHOLES
Draw usual through hole vias.
Definition: layer_ids.h:238
@ LAYER_DRAWINGSHEET
Sheet frame and title block.
Definition: layer_ids.h:277
@ LAYER_FP_REFERENCES
Show footprints references (when texts are visible).
Definition: layer_ids.h:265
@ LAYER_DRC_EXCLUSION
Layer for DRC markers which have been individually excluded.
Definition: layer_ids.h:303
@ LAYER_ZONES
Control for copper zone opacity/visibility (color ignored).
Definition: layer_ids.h:294
@ LAYER_PADS
Meta control for all pads opacity/visibility (color ignored).
Definition: layer_ids.h:291
@ LAYER_DRC_WARNING
Layer for DRC markers with #SEVERITY_WARNING.
Definition: layer_ids.h:300
@ LAYER_PAD_PLATEDHOLES
to draw pad holes (plated)
Definition: layer_ids.h:270
@ LAYER_VIA_COPPER_START
Virtual layers for via copper on a given copper layer.
Definition: layer_ids.h:336
@ LAYER_TRACKS
Definition: layer_ids.h:266
@ LAYER_DRC_SHAPE2
Custom shape for DRC marker.
Definition: layer_ids.h:315
@ LAYER_ZONE_START
Virtual layers for stacking zones and tracks on a given copper layer.
Definition: layer_ids.h:328
@ LAYER_FP_TEXT
Definition: layer_ids.h:239
@ LAYER_FOOTPRINTS_BK
Show footprints on back.
Definition: layer_ids.h:259
@ LAYER_ANCHOR
Anchor of items having an anchor point (texts, footprints).
Definition: layer_ids.h:247
@ LAYER_VIA_HOLES
Draw via holes (pad holes do not use this layer).
Definition: layer_ids.h:273
@ LAYER_FP_VALUES
Show footprints values (when texts are visible).
Definition: layer_ids.h:262
@ LAYER_VIA_MICROVIA
Definition: layer_ids.h:233
@ LAYER_VIA_THROUGH
Draw blind/buried vias.
Definition: layer_ids.h:235
@ LAYER_DRC_ERROR
Layer for DRC markers with #SEVERITY_ERROR.
Definition: layer_ids.h:276
@ LAYER_VIAS
Meta control for all vias opacity/visibility.
Definition: layer_ids.h:232
@ LAYER_VIA_BBLIND
Draw micro vias.
Definition: layer_ids.h:234
@ LAYER_PAD_HOLEWALLS
Definition: layer_ids.h:296
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ Edge_Cuts
Definition: layer_ids.h:112
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
PAD_DRILL_SHAPE
The set of pad drill shapes, used with PAD::{Set,Get}DrillShape()
Definition: padstack.h:69
see class PGM_BASE
void Load(APP_SETTINGS_BASE *aConfig) override
LSET m_LayerSet
Layers to print.
void Save(APP_SETTINGS_BASE *aConfig) override
const double IU_PER_MM
Definition: base_units.h:76
const double IU_PER_MILS
Definition: base_units.h:77
constexpr int mmToIU(double mm) const
Definition: base_units.h:92
enum PCBNEW_PRINTOUT_SETTINGS::PAGINATION_T m_Pagination
bool m_PrintEdgeCutsOnAllPages
Print board outline on each page.
enum DRILL_MARKS m_DrillMarks
bool m_AsItemCheckboxes
Honor checkboxes in the Items tab of the Layers Manager.
void Load(APP_SETTINGS_BASE *aConfig) override
void Save(APP_SETTINGS_BASE *aConfig) override
PCBNEW_PRINTOUT_SETTINGS(const PAGE_INFO &aPageInfo)
bool m_blackWhite
Print in B&W or Color.
Definition: printout.h:60