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 (C) 1992-2023 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
43 BOARD_PRINTOUT_SETTINGS( aPageInfo )
44{
45 m_DrillMarks = DRILL_MARKS::SMALL_DRILL_SHAPE;
48 m_AsItemCheckboxes = false;
49}
50
51
53{
55
56 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aConfig ) )
57 {
58 m_DrillMarks = static_cast<DRILL_MARKS>( cfg->m_Plot.pads_drill_mode );
59 m_Pagination = static_cast<PAGINATION_T>( cfg->m_Plot.all_layers_on_one_page );
60 m_PrintEdgeCutsOnAllPages = cfg->m_Plot.edgecut_on_all_layers;
61 m_Mirror = cfg->m_Plot.mirror;
62 m_AsItemCheckboxes = cfg->m_Plot.as_item_checkboxes;
63 }
64}
65
66
68{
70
71 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aConfig ) )
72 {
73 cfg->m_Plot.pads_drill_mode = (int)m_DrillMarks;
74 cfg->m_Plot.all_layers_on_one_page = m_Pagination;
75 cfg->m_Plot.edgecut_on_all_layers = m_PrintEdgeCutsOnAllPages;
76 cfg->m_Plot.mirror = m_Mirror;
77 cfg->m_Plot.as_item_checkboxes = m_AsItemCheckboxes;
78 }
79}
80
81
83 const KIGFX::VIEW* aView, const wxString& aTitle ) :
84 BOARD_PRINTOUT( aParams, aView, aTitle ), m_pcbnewSettings( aParams )
85{
86 m_board = aBoard;
87}
88
89
91{
92 // Store the layerset, as it is going to be modified below and the original settings are
93 // needed.
95 int pageCount = lset.count();
96 wxString layerName;
97 PCB_LAYER_ID extractLayer;
98
99 // compute layer mask from page number if we want one page per layer
101 {
102 // This sequence is TBD, call a different sequencer if needed, such as Seq().
103 // Could not find documentation on page order.
104 LSEQ seq = lset.UIOrder();
105
106 // aPage starts at 1, not 0
107 if( unsigned( aPage - 1 ) < seq.size() )
108 m_settings.m_LayerSet = LSET( { seq[aPage - 1] } );
109 }
110
111 if( !m_settings.m_LayerSet.any() )
112 return false;
113
114 extractLayer = m_settings.m_LayerSet.ExtractLayer();
115
116 if( extractLayer == UNDEFINED_LAYER )
117 layerName = _( "Multiple Layers" );
118 else
119 layerName = m_board->GetLayerName( extractLayer );
120
121 // In Pcbnew we can want the layer EDGE always printed
124
125 DrawPage( layerName, aPage, pageCount );
126
127 // Restore the original layer set, so the next page can be printed
128 m_settings.m_LayerSet = lset;
129
130 return true;
131}
132
133
134int PCBNEW_PRINTOUT::milsToIU( double aMils ) const
135{
136 return KiROUND( pcbIUScale.IU_PER_MILS * aMils );
137}
138
139
140void PCBNEW_PRINTOUT::setupViewLayers( KIGFX::VIEW& aView, const LSET& aLayerSet )
141{
142 BOARD_PRINTOUT::setupViewLayers( aView, aLayerSet );
143
144 for( PCB_LAYER_ID layer : m_settings.m_LayerSet.Seq() )
145 {
146 aView.SetLayerVisible( PCBNEW_LAYER_ID_START + layer, true );
147
148 // Enable the corresponding zone layer (copper layers and other layers)
149 aView.SetLayerVisible( LAYER_ZONE_START + layer, true );
150 }
151
152 RENDER_SETTINGS* renderSettings = aView.GetPainter()->GetSettings();
153 // A color to do not print objects on some layers, when the layer must be enabled
154 // to print some other objects
155 COLOR4D invisible_color = COLOR4D::UNSPECIFIED;
156
158 {
159 auto setVisibility =
160 [&]( GAL_LAYER_ID aLayer )
161 {
162 if( m_board->IsElementVisible( aLayer ) )
163 aView.SetLayerVisible( aLayer, true );
164 else
165 renderSettings->SetLayerColor( aLayer, invisible_color );
166 };
167
168 setVisibility( LAYER_FOOTPRINTS_FR );
169 setVisibility( LAYER_FOOTPRINTS_BK );
170 setVisibility( LAYER_FP_VALUES );
171 setVisibility( LAYER_FP_REFERENCES );
172 setVisibility( LAYER_FP_TEXT );
173 setVisibility( LAYER_PADS );
174 setVisibility( LAYER_PADS_SMD_FR );
175 setVisibility( LAYER_PADS_SMD_BK );
176 setVisibility( LAYER_PADS_TH );
177
178 setVisibility( LAYER_TRACKS );
179 setVisibility( LAYER_VIAS );
180 setVisibility( LAYER_VIA_MICROVIA );
181 setVisibility( LAYER_VIA_BBLIND );
182 setVisibility( LAYER_VIA_THROUGH );
183 setVisibility( LAYER_ZONES );
184 setVisibility( LAYER_SHAPES );
185
186 setVisibility( LAYER_DRC_WARNING );
187 setVisibility( LAYER_DRC_ERROR );
188 setVisibility( LAYER_DRC_EXCLUSION );
189 setVisibility( LAYER_ANCHOR );
190 setVisibility( LAYER_DRAWINGSHEET );
191 setVisibility( LAYER_GRID );
192 }
193 else
194 {
195 // Draw layers that must be not visible on printing are set to an invisible layer
196 // LAYER_PADS_SMD_FR, LAYER_PADS_SMD_BK and LAYER_PADS_TH must be enabled to print pads on
197 // technical layers, but not the pad on copper layer(s) if they are not enabled
198
199 if( !aLayerSet.test( F_Cu ) )
200 renderSettings->SetLayerColor( LAYER_PADS_SMD_FR, invisible_color );
201
202 if( !aLayerSet.test( B_Cu ) )
203 renderSettings->SetLayerColor( LAYER_PADS_SMD_BK, invisible_color );
204
205 // Enable items on copper layers, but do not draw holes
207 {
208 if( ( aLayerSet & LSET::AllCuMask() ).any() ) // Items visible on any copper layer
209 aView.SetLayerVisible( layer, true );
210 else
211 renderSettings->SetLayerColor( layer, invisible_color );
212 }
213
214 // Keep certain items always enabled/disabled and just rely on the layer visibility
215 // Note LAYER_PADS_SMD_FR, LAYER_PADS_SMD_BK, LAYER_PADS_TH are enabled here because paths must
216 // be drawn on some other (technical) layers.
217 const int alwaysEnabled[] =
218 {
224 };
225
226 for( int layer : alwaysEnabled )
227 aView.SetLayerVisible( layer, true );
228 }
229
230 if( m_pcbnewSettings.m_DrillMarks != DRILL_MARKS::NO_DRILL_SHAPE )
231 {
232 // Enable hole layers to draw drill marks
234 {
235 aView.SetLayerVisible( layer, true );
236 aView.SetTopLayer( layer, true );
237 }
238
239 if( m_pcbnewSettings.m_DrillMarks == DRILL_MARKS::FULL_DRILL_SHAPE
241 {
242 for( int layer : { LAYER_PAD_HOLEWALLS, LAYER_VIA_HOLEWALLS } )
243 {
244 aView.SetLayerVisible( layer, true );
245 aView.SetTopLayer( layer, true );
246 }
247 }
248 }
249}
250
251
253{
255
256 KIGFX::PCB_PRINT_PAINTER& painter = dynamic_cast<KIGFX::PCB_PRINT_PAINTER&>( aPainter );
257
259 {
260 case DRILL_MARKS::NO_DRILL_SHAPE:
261 painter.SetDrillMarks( false, 0 );
262 break;
263
264 case DRILL_MARKS::SMALL_DRILL_SHAPE:
266
267 painter.GetSettings()->SetLayerColor( LAYER_PAD_PLATEDHOLES, COLOR4D::BLACK );
268 painter.GetSettings()->SetLayerColor( LAYER_NON_PLATEDHOLES, COLOR4D::BLACK );
269 painter.GetSettings()->SetLayerColor( LAYER_VIA_HOLES, COLOR4D::BLACK );
270 break;
271
272 case DRILL_MARKS::FULL_DRILL_SHAPE:
273 painter.SetDrillMarks( true );
274
275 painter.GetSettings()->SetLayerColor( LAYER_PAD_PLATEDHOLES, COLOR4D::BLACK );
276 painter.GetSettings()->SetLayerColor( LAYER_NON_PLATEDHOLES, COLOR4D::BLACK );
277 painter.GetSettings()->SetLayerColor( LAYER_VIA_HOLES, COLOR4D::BLACK );
278 break;
279 }
280}
281
282
284{
286 aGal->SetWorldUnitLength( 0.001/pcbIUScale.IU_PER_MM /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
287}
288
289
291{
292 return m_board->ComputeBoundingBox( false );
293}
294
295
296std::unique_ptr<KIGFX::PAINTER> PCBNEW_PRINTOUT::getPainter( KIGFX::GAL* aGal )
297{
298 return std::make_unique<KIGFX::PCB_PRINT_PAINTER>( aGal );
299}
300
301
304 m_drillMarkReal( false ),
305 m_drillMarkSize( 0 )
306{ }
307
308
310{
311 return m_drillMarkReal ? KIGFX::PCB_PAINTER::getDrillShape( aPad ) : PAD_DRILL_SHAPE::CIRCLE;
312}
313
314
316{
317 if( m_drillMarkReal )
319 else
320 return SHAPE_SEGMENT( aPad->GetPosition(), aPad->GetPosition(), m_drillMarkSize );
321}
322
323
325{
326 return m_drillMarkReal ? KIGFX::PCB_PAINTER::getViaDrillSize( aVia ) : m_drillMarkSize;
327}
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
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:92
BASE_SET & set(size_t pos)
Definition: base_set.h:115
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)
Configures GAL object for a printout.
virtual void setupViewLayers(KIGFX::VIEW &aView, const LSET &aLayerSet)
Configures PAINTER object for a printout.
virtual void setupGal(KIGFX::GAL *aGal)
Returns bounding box of the printed objects (excluding drawing-sheet frame)
BOARD_PRINTOUT_SETTINGS m_settings
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:290
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition: board.cpp:826
BOX2I ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
Definition: board.cpp:1655
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:577
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:173
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:178
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:68
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition: view.h:401
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:871
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:221
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:36
LSEQ UIOrder() const
Returns the copper, technical and user layers in the order shown in layer widget.
Definition: lset.cpp:799
PCB_LAYER_ID ExtractLayer() const
Find the first set PCB_LAYER_ID.
Definition: lset.cpp:630
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:676
LSEQ Seq(const LSEQ &aSequence) const
Return an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:410
Definition: pad.h:54
VECTOR2I GetPosition() const override
Definition: pad.h:210
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
Source VIEW object (note that actual printing only refers to this object)
void setupGal(KIGFX::GAL *aGal) override
Returns bounding box of the printed objects (excluding drawing-sheet frame)
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
Configures GAL object for a printout.
BOX2I getBoundingBox() override
Returns a PAINTER instance used to draw the items.
void setupViewLayers(KIGFX::VIEW &aView, const LSET &aLayerSet) override
Configures PAINTER object 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:138
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition: layer_ids.h:192
@ LAYER_GRID
Definition: layer_ids.h:207
@ LAYER_VIA_HOLEWALLS
Definition: layer_ids.h:236
@ LAYER_FOOTPRINTS_FR
show footprints on front
Definition: layer_ids.h:210
@ LAYER_NON_PLATEDHOLES
handle color for not plated holes (holes, not pads)
Definition: layer_ids.h:199
@ LAYER_DRAWINGSHEET
drawingsheet frame and titleblock
Definition: layer_ids.h:219
@ LAYER_FP_REFERENCES
show footprints references (when texts are visible)
Definition: layer_ids.h:213
@ LAYER_DRC_EXCLUSION
layer for drc markers which have been individually excluded
Definition: layer_ids.h:238
@ LAYER_ZONES
Control for copper zone opacity/visibility (color ignored)
Definition: layer_ids.h:233
@ LAYER_SHAPES
Copper graphic shape opacity/visibility (color ignored)
Definition: layer_ids.h:244
@ LAYER_PADS
Meta control for all pads opacity/visibility (color ignored)
Definition: layer_ids.h:232
@ LAYER_DRC_WARNING
layer for drc markers with SEVERITY_WARNING
Definition: layer_ids.h:237
@ LAYER_PAD_PLATEDHOLES
to draw pad holes (plated)
Definition: layer_ids.h:216
@ LAYER_TRACKS
Definition: layer_ids.h:214
@ LAYER_ZONE_START
Virtual layers for stacking zones and tracks on a given copper layer.
Definition: layer_ids.h:256
@ LAYER_FP_TEXT
Definition: layer_ids.h:200
@ LAYER_FOOTPRINTS_BK
show footprints on back
Definition: layer_ids.h:211
@ LAYER_ANCHOR
anchor of items having an anchor point (texts, footprints)
Definition: layer_ids.h:203
@ LAYER_PADS_SMD_BK
smd pads, back layer
Definition: layer_ids.h:205
@ LAYER_PADS_TH
multilayer pads, usually with holes
Definition: layer_ids.h:215
@ LAYER_PADS_SMD_FR
smd pads, front layer
Definition: layer_ids.h:204
@ LAYER_VIA_HOLES
to draw via holes (pad holes do not use this layer)
Definition: layer_ids.h:217
@ LAYER_FP_VALUES
show footprints values (when texts are visible)
Definition: layer_ids.h:212
@ LAYER_VIA_MICROVIA
to draw micro vias
Definition: layer_ids.h:196
@ LAYER_VIA_THROUGH
to draw usual through hole vias
Definition: layer_ids.h:198
@ LAYER_DRC_ERROR
layer for drc markers with SEVERITY_ERROR
Definition: layer_ids.h:218
@ LAYER_VIAS
Meta control for all vias opacity/visibility.
Definition: layer_ids.h:195
@ LAYER_VIA_BBLIND
to draw blind/buried vias
Definition: layer_ids.h:197
@ LAYER_PAD_HOLEWALLS
Definition: layer_ids.h:235
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ Edge_Cuts
Definition: layer_ids.h:112
@ B_Cu
Definition: layer_ids.h:65
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
@ F_Cu
Definition: layer_ids.h:64
PAD_DRILL_SHAPE
The set of pad drill shapes, used with PAD::{Set,Get}DrillShape()
Definition: padstack.h:63
DRILL_MARKS
Plots and prints can show holes in pads and vias 3 options are available:
void Load(APP_SETTINGS_BASE *aConfig) override
LSET m_LayerSet
Layers to print.
void Save(APP_SETTINGS_BASE *aConfig) override
bool m_Mirror
Print mirrored.
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:88
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