KiCad PCB EDA Suite
board_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, jean-pierre.charras at wanadoo.fr
5 * Copyright (C) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors.
6 * Copyright (C) 2018 CERN
7 * Author: Maciej Suminski <[email protected]>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#include <board_printout.h>
28
29#include <view/view.h>
30#include <gal/gal_print.h>
31#include <painter.h>
32#include <pcbplot.h>
34
35
37 : PRINTOUT_SETTINGS( aPageInfo )
38{
39 m_LayerSet.set();
40 m_Mirror = false;
41}
42
43
45{
46 PRINTOUT_SETTINGS::Load( aConfig );
47
48 m_LayerSet.reset();
49
50 for( int layer : aConfig->m_Printing.layers )
51 m_LayerSet.set( layer, true );
52}
53
54
56{
57 PRINTOUT_SETTINGS::Save( aConfig );
58
59 aConfig->m_Printing.layers.clear();
60
61 for( unsigned layer = 0; layer < m_LayerSet.size(); ++layer )
62 if( m_LayerSet.test( layer ) )
63 aConfig->m_Printing.layers.push_back( layer );
64}
65
66
68 const KIGFX::VIEW* aView, const wxString& aTitle ) :
69 wxPrintout( aTitle ),
70 m_settings( aParams )
71{
72 m_view = aView;
73 m_gerbviewPrint = false;
74}
75
76
77void BOARD_PRINTOUT::GetPageInfo( int* minPage, int* maxPage, int* selPageFrom, int* selPageTo )
78{
79 *minPage = 1;
80 *selPageFrom = 1;
81
82 *maxPage = m_settings.m_pageCount;
83 *selPageTo = m_settings.m_pageCount;
84}
85
86
87void BOARD_PRINTOUT::DrawPage( const wxString& aLayerName, int aPageNum, int aPageCount )
88{
89 wxDC* dc = GetDC();
91 std::unique_ptr<KIGFX::GAL_PRINT> galPrint = KIGFX::GAL_PRINT::Create( options, dc );
92 KIGFX::GAL* gal = galPrint->GetGAL();
93 KIGFX::PRINT_CONTEXT* printCtx = galPrint->GetPrintCtx();
94 std::unique_ptr<KIGFX::PAINTER> painter = getPainter( gal );
95 std::unique_ptr<KIGFX::VIEW> view( m_view->DataReference() );
96
97 // Target paper size
98 wxRect pageSizePx = GetLogicalPageRect();
99 const VECTOR2D pageSizeIn( (double) pageSizePx.width / dc->GetPPI().x,
100 (double) pageSizePx.height / dc->GetPPI().y );
101 const VECTOR2D pageSizeIU( milsToIU( pageSizeIn.x * 1000 ), milsToIU( pageSizeIn.y * 1000 ) );
102
103 galPrint->SetSheetSize( pageSizeIn );
104
105 view->SetGAL( gal );
106 view->SetPainter( painter.get() );
107 view->SetScaleLimits( 10e9, 0.0001 );
108 view->SetScale( 1.0 );
109
110
111 // Set the color scheme
112 RENDER_SETTINGS* dstSettings = view->GetPainter()->GetSettings();
113 dstSettings->LoadColors( m_settings.m_colorSettings );
114
116 {
117 for( int i = 0; i < LAYER_ID_COUNT; ++i )
118 dstSettings->SetLayerColor( i, COLOR4D::BLACK );
119
120 // In B&W mode, draw the background only in wxhite, because any other color
121 // will be replaced by a black background
122 dstSettings->SetBackgroundColor( COLOR4D::WHITE );
123 }
124 else // color enabled
125 {
126 for( int i = 0; i < LAYER_ID_COUNT; ++i )
127 {
128 // Cairo does not support translucent colors on PostScript surfaces
129 // see 'Features support by the PostScript surface' on
130 // https://www.cairographics.org/documentation/using_the_postscript_surface/
131 dstSettings->SetLayerColor( i, dstSettings->GetLayerColor( i ).WithAlpha( 1.0 ) );
132 }
133 }
134
135 dstSettings->SetIsPrinting( true );
136
137 setupPainter( *painter );
139 dstSettings->SetPrintLayers( m_settings.m_LayerSet );
140
141 dstSettings->SetLayerName( aLayerName );
142
143 VECTOR2I sheetSizeMils = m_settings.m_pageInfo.GetSizeMils();
144 VECTOR2I sheetSizeIU( milsToIU( sheetSizeMils.x ),
145 milsToIU( sheetSizeMils.y ) );
146 BOX2I bBox;
147
148 // Determine printout bounding box
150 {
151 bBox = BOX2I( VECTOR2I( 0, 0 ), VECTOR2I( sheetSizeIU ) );
152 view->SetLayerVisible( LAYER_DRAWINGSHEET, true );
153 }
154 else
155 {
156 bBox = getBoundingBox();
157 view->SetLayerVisible( LAYER_DRAWINGSHEET, false );
158 }
159
160
161 // Fit to page
162 if( m_settings.m_scale <= 0.0 )
163 {
164 if( bBox.GetWidth() == 0 || bBox.GetHeight() == 0 )
165 {
166 // Nothing to print
167 m_settings.m_scale = 1.0;
168 }
169 else
170 {
171 double scaleX = (double) pageSizeIU.x / bBox.GetWidth();
172 double scaleY = (double) pageSizeIU.y / bBox.GetHeight();
173 m_settings.m_scale = std::min( scaleX, scaleY );
174 }
175 }
176
177 setupGal( gal );
178 galPrint->SetNativePaperSize( pageSizeIn, printCtx->HasNativeLandscapeRotation() );
179 gal->SetLookAtPoint( bBox.Centre() );
181
182 gal->SetClearColor( dstSettings->GetBackgroundColor() );
183 gal->ClearScreen();
184
185 if( m_gerbviewPrint )
186 // Mandatory in Gerbview to use the same order for printing as for screen redraw
187 // due to negative objects that need a specific order
188 view->UseDrawPriority( true );
189
190 {
192 view->Redraw();
193 }
194}
195
196
197void BOARD_PRINTOUT::setupViewLayers( KIGFX::VIEW& aView, const LSET& aLayerSet )
198{
199 // Disable all layers by default, let specific implementations enable required layers
200 for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; ++i )
201 {
202 aView.SetLayerVisible( i, false );
203 aView.SetTopLayer( i, false );
205 }
206}
207
208
210{
213}
214
215
217{
218 aGal->SetFlip( m_settings.m_Mirror, false );
219}
BOX2< VECTOR2I > BOX2I
Definition: box2.h:847
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:101
virtual void DrawPage(const wxString &aLayerName=wxEmptyString, int aPageNum=1, int aPageCount=1)
Print a page (or a set of pages).
bool m_gerbviewPrint
True if the caller is Gerbview, false for Pcbnew.
virtual void setupPainter(KIGFX::PAINTER &aPainter)
Configures GAL object for a printout.
virtual int milsToIU(double aMils) const =0
< Convert mils to internal units
virtual std::unique_ptr< KIGFX::PAINTER > getPainter(KIGFX::GAL *aGal)=0
Source VIEW object (note that actual printing only refers to this object)
const KIGFX::VIEW * m_view
Printout parameters.
virtual void setupViewLayers(KIGFX::VIEW &aView, const LSET &aLayerSet)
Configures PAINTER object for a printout.
BOARD_PRINTOUT(const BOARD_PRINTOUT_SETTINGS &aParams, const KIGFX::VIEW *aView, const wxString &aTitle)
void GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int *selPageTo) override
virtual void setupGal(KIGFX::GAL *aGal)
Returns bounding box of the printed objects (excluding drawing-sheet frame)
BOARD_PRINTOUT_SETTINGS m_settings
virtual BOX2I getBoundingBox()=0
Returns a PAINTER instance used to draw the items.
coord_type GetHeight() const
Definition: box2.h:188
coord_type GetWidth() const
Definition: box2.h:187
Vec Centre() const
Definition: box2.h:70
COLOR4D WithAlpha(double aAlpha) const
Return a color with the same color, but the given alpha.
Definition: color4d.h:321
Abstract interface for drawing on a 2D-surface.
void SetFlip(bool xAxis, bool yAxis)
Sets flipping of the screen.
void SetZoomFactor(double aZoomFactor)
void SetLookAtPoint(const VECTOR2D &aPoint)
Get/set the Point in world space to look at.
virtual void ClearScreen()
Clear the screen.
void SetClearColor(const COLOR4D &aColor)
Contains all the knowledge about how to draw graphical object onto any particular output device.
Definition: painter.h:58
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
virtual bool HasNativeLandscapeRotation() const =0
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.
virtual void LoadColors(const COLOR_SETTINGS *aSettings)
void SetPrintLayers(LSET aLayerSet)
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
virtual void SetBackgroundColor(const COLOR4D &aColor)=0
Set the background color.
void SetLayerName(const wxString &aLayerName)
virtual const COLOR4D & GetBackgroundColor() const =0
Return current background color settings.
void SetIsPrinting(bool isPrinting)
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:69
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Change the rendering target for a particular layer.
Definition: view.h:469
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition: view.h:393
static constexpr int VIEW_MAX_LAYERS
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:720
std::unique_ptr< VIEW > DataReference() const
Return a new VIEW object that shares the same set of VIEW_ITEMs and LAYERs.
Definition: view.cpp:1502
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:822
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:530
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:54
const VECTOR2I & GetSizeMils() const
Definition: page_info.h:135
@ WHITE
Definition: color4d.h:48
@ BLACK
Definition: color4d.h:44
#define LAYER_ID_COUNT
Must update this if you add any enums after GerbView!
Definition: layer_ids.h:449
@ LAYER_DRAWINGSHEET
drawingsheet frame and titleblock
Definition: layer_ids.h:217
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition: definitions.h:49
std::vector< int > layers
List of enabled layers for printing.
Definition: app_settings.h:142
void Load(APP_SETTINGS_BASE *aConfig) override
BOARD_PRINTOUT_SETTINGS(const PAGE_INFO &aPageInfo)
LSET m_LayerSet
Layers to print.
void Save(APP_SETTINGS_BASE *aConfig) override
bool m_Mirror
Print mirrored.
Handle the parameters used to print a board drawing.
Definition: printout.h:32
bool PrintBorderAndTitleBlock() const
Returns true if the drawing border and title block should be printed.
Definition: printout.h:55
COLOR_SETTINGS * m_colorSettings
The color settings to be used for printing.
Definition: printout.h:66
virtual void Save(APP_SETTINGS_BASE *aConfig)
Definition: printout.cpp:24
bool m_blackWhite
Print in B&W or Color.
Definition: printout.h:60
int m_pageCount
Number of pages to print.
Definition: printout.h:61
const PAGE_INFO & m_pageInfo
Definition: printout.h:63
bool m_background
Print background color.
Definition: printout.h:62
virtual void Load(APP_SETTINGS_BASE *aConfig)
Definition: printout.cpp:32
double m_scale
Printing scale.
Definition: printout.h:58
VECTOR2< int > VECTOR2I
Definition: vector2d.h:618