KiCad PCB EDA Suite
BOARD_PRINTOUT Class Referenceabstract

Class BOARD_PRINTOUT is a class derived from wxPrintout to handle the necessary information to control a printer when printing a board. More...

#include <board_printout.h>

Inheritance diagram for BOARD_PRINTOUT:
GERBVIEW_PRINTOUT PCBNEW_PRINTOUT

Public Member Functions

 BOARD_PRINTOUT (const BOARD_PRINTOUT_SETTINGS &aParams, const KIGFX::VIEW *aView, const wxString &aTitle)
 
virtual ~BOARD_PRINTOUT ()
 
void GetPageInfo (int *minPage, int *maxPage, int *selPageFrom, int *selPageTo) override
 
bool HasPage (int aPage) override
 
virtual void DrawPage (const wxString &aLayerName=wxEmptyString, int aPageNum=1, int aPageCount=1)
 Print a page (or a set of pages). More...
 

Protected Member Functions

virtual int milsToIU (double aMils) const =0
 

Convert mils to internal units

More...
 
virtual void setupViewLayers (const std::unique_ptr< KIGFX::VIEW > &aView, const LSET &aLayerSet)
 

Enables layers visibility for a printout

More...
 
virtual void setupPainter (const std::unique_ptr< KIGFX::PAINTER > &aPainter)
 

Configures PAINTER object for a printout

More...
 
virtual void setupGal (KIGFX::GAL *aGal)
 

Configures GAL object for a printout

More...
 
virtual EDA_RECT getBoundingBox ()=0
 

Returns bounding box of the printed objects (excluding worksheet frame)

More...
 
virtual std::unique_ptr< KIGFX::PAINTERgetPainter (KIGFX::GAL *aGal)=0
 

Returns a PAINTER instance used to draw the items.

More...
 

Protected Attributes

const KIGFX::VIEWm_view
 

Source VIEW object (note that actual printing only refers to this object)

More...
 
BOARD_PRINTOUT_SETTINGS m_settings
 

Printout parameters

More...
 

Detailed Description

Class BOARD_PRINTOUT is a class derived from wxPrintout to handle the necessary information to control a printer when printing a board.

Definition at line 64 of file board_printout.h.

Constructor & Destructor Documentation

BOARD_PRINTOUT::BOARD_PRINTOUT ( const BOARD_PRINTOUT_SETTINGS aParams,
const KIGFX::VIEW aView,
const wxString &  aTitle 
)

Definition at line 69 of file board_printout.cpp.

References m_view.

70  :
71  wxPrintout( aTitle ), m_settings( aParams )
72 {
73  m_view = aView;
74 }
const KIGFX::VIEW * m_view
Source VIEW object (note that actual printing only refers to this object)
BOARD_PRINTOUT_SETTINGS m_settings
Printout parameters
virtual BOARD_PRINTOUT::~BOARD_PRINTOUT ( )
inlinevirtual

Definition at line 70 of file board_printout.h.

70 {}

Member Function Documentation

void BOARD_PRINTOUT::DrawPage ( const wxString &  aLayerName = wxEmptyString,
int  aPageNum = 1,
int  aPageCount = 1 
)
virtual

Print a page (or a set of pages).

Note: this function prepare print parameters for the function which actually print the draw layers.

Parameters
aLayerName= a text which can be printed as layer name
aPageNum= the number of the current page (only used to print this value)
aPageCount= the number of pages to ptint (only used to print this value)

Definition at line 87 of file board_printout.cpp.

References BLACK, BOX2< Vec >::Centre(), KIGFX::VIEW::DataReference(), getBoundingBox(), BOX2< Vec >::GetHeight(), EDA_RECT::GetOrigin(), getPainter(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), EDA_RECT::GetSize(), PAGE_INFO::GetSizeMils(), BOX2< Vec >::GetWidth(), i, LAYER_ID_COUNT, LAYER_WORKSHEET, PRINTOUT_SETTINGS::m_blackWhite, BOARD_PRINTOUT_SETTINGS::m_layerSet, PRINTOUT_SETTINGS::m_pageInfo, PRINTOUT_SETTINGS::m_scale, m_settings, m_view, milsToIU(), min, PRINTOUT_SETTINGS::PrintBorderAndTitleBlock(), KIGFX::RENDER_SETTINGS::SetLayerColor(), setupGal(), setupPainter(), setupViewLayers(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GERBVIEW_PRINTOUT::OnPrintPage(), and PCBNEW_PRINTOUT::OnPrintPage().

88 {
89  auto dc = GetDC();
91  auto galPrint = KIGFX::GAL_PRINT::Create( options, dc );
92  auto gal = galPrint->GetGAL();
93  auto printCtx = galPrint->GetPrintCtx();
94  auto 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  galPrint->SetSheetSize( pageSizeIn );
102  const VECTOR2D pageSizeIU( milsToIU( pageSizeIn.x * 1000 ), milsToIU( pageSizeIn.y * 1000 ) );
103 
104  view->SetGAL( gal );
105  view->SetPainter( painter.get() );
106  view->SetScaleLimits( 10e9, 0.0001 );
107  view->SetScale( 1.0 );
108 
109 
110  // Set the color scheme
111  auto srcSettings = m_view->GetPainter()->GetSettings();
112  auto dstSettings = view->GetPainter()->GetSettings();
113 
115  {
116  for( int i = 0; i < LAYER_ID_COUNT; ++i )
117  dstSettings->SetLayerColor( i, COLOR4D::BLACK );
118  }
119  else // color enabled
120  {
121  for( int i = 0; i < LAYER_ID_COUNT; ++i )
122  {
123  // Cairo does not support translucent colors on PostScript surfaces
124  // see 'Features support by the PostScript surface' on
125  // ttps://www.cairographics.org/documentation/using_the_postscript_surface/
126  dstSettings->SetLayerColor( i, srcSettings->GetLayerColor( i ).WithAlpha( 1.0 ) );
127  }
128  }
129 
130 
132  setupPainter( painter );
133 
134  auto sheetSizeMils = m_settings.m_pageInfo.GetSizeMils();
135  VECTOR2I sheetSizeIU( milsToIU( sheetSizeMils.GetWidth() ), milsToIU( sheetSizeMils.GetHeight() ) );
136  BOX2I bBox;
137 
138  // Determine printout bounding box
140  {
141  bBox = BOX2I( VECTOR2I( 0, 0 ), VECTOR2I( sheetSizeIU ) );
142  view->SetLayerVisible( LAYER_WORKSHEET, true );
143  }
144  else
145  {
146  EDA_RECT targetBbox = getBoundingBox();
147  bBox = BOX2I( targetBbox.GetOrigin(), targetBbox.GetSize() );
148  view->SetLayerVisible( LAYER_WORKSHEET, false );
149  }
150 
151 
152  // Fit to page
153  if( m_settings.m_scale <= 0.0 )
154  {
155  if( bBox.GetWidth() == 0 || bBox.GetHeight() == 0 )
156  {
157  // Nothing to print
158  m_settings.m_scale = 1.0;
159  }
160  else
161  {
162  double scaleX = (double) pageSizeIU.x / bBox.GetWidth();
163  double scaleY = (double) pageSizeIU.y / bBox.GetHeight();
164  m_settings.m_scale = std::min( scaleX, scaleY );
165  }
166  }
167 
168  setupGal( gal );
169  galPrint->SetNativePaperSize( pageSizeIn, printCtx->HasNativeLandscapeRotation() );
170  gal->SetLookAtPoint( bBox.Centre() );
171  gal->SetZoomFactor( m_settings.m_scale );
172 
173  {
174  KIGFX::GAL_DRAWING_CONTEXT ctx( gal );
175  view->Redraw();
176  }
177 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:520
const PAGE_INFO & m_pageInfo
Definition: printout.h:48
const wxPoint GetOrigin() const
Definition: eda_rect.h:112
virtual std::unique_ptr< KIGFX::PAINTER > getPainter(KIGFX::GAL *aGal)=0
Returns a PAINTER instance used to draw the items.
const wxSize GetSize() const
Definition: eda_rect.h:101
const KIGFX::VIEW * m_view
Source VIEW object (note that actual printing only refers to this object)
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
BOARD_PRINTOUT_SETTINGS m_settings
Printout parameters
const wxSize & GetSizeMils() const
Definition: page_info.h:142
double m_scale
Printing scale.
Definition: printout.h:44
coord_type GetWidth() const
Definition: box2.h:195
bool PrintBorderAndTitleBlock() const
Returns true if the drawing border and title block should be printed.
Definition: printout.h:56
virtual int milsToIU(double aMils) const =0
Convert mils to internal units
virtual void setupGal(KIGFX::GAL *aGal)
Configures GAL object for a printout
void SetLayerColor(int aLayer, const COLOR4D &aColor)
Function SetLayerColor Changes the color used to draw a layer.
Definition: painter.h:230
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
virtual void setupPainter(const std::unique_ptr< KIGFX::PAINTER > &aPainter)
Configures PAINTER object for a printout
#define LAYER_ID_COUNT
Must update this if you add any enums after GerbView!
Vec Centre() const
Definition: box2.h:77
std::unique_ptr< VIEW > DataReference() const
Returns a new VIEW object that shares the same set of VIEW_ITEMs and LAYERs.
Definition: view.cpp:1457
bool m_blackWhite
Print in B&W or Color.
Definition: printout.h:46
coord_type GetHeight() const
Definition: box2.h:196
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
virtual void setupViewLayers(const std::unique_ptr< KIGFX::VIEW > &aView, const LSET &aLayerSet)
Enables layers visibility for a printout
size_t i
Definition: json11.cpp:597
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Definition: colors.h:45
virtual EDA_RECT getBoundingBox()=0
Returns bounding box of the printed objects (excluding worksheet frame)
LSET m_layerSet
Layers to print.
#define min(a, b)
Definition: auxiliary.h:85
virtual EDA_RECT BOARD_PRINTOUT::getBoundingBox ( )
protectedpure virtual

Returns bounding box of the printed objects (excluding worksheet frame)

Implemented in PCBNEW_PRINTOUT, and GERBVIEW_PRINTOUT.

Referenced by DrawPage().

void BOARD_PRINTOUT::GetPageInfo ( int *  minPage,
int *  maxPage,
int *  selPageFrom,
int *  selPageTo 
)
override

Definition at line 77 of file board_printout.cpp.

References PRINTOUT_SETTINGS::m_pageCount, and m_settings.

78 {
79  *minPage = 1;
80  *selPageFrom = 1;
81 
82  *maxPage = m_settings.m_pageCount;
83  *selPageTo = m_settings.m_pageCount;
84 }
BOARD_PRINTOUT_SETTINGS m_settings
Printout parameters
int m_pageCount
Number of pages to print.
Definition: printout.h:47
virtual std::unique_ptr<KIGFX::PAINTER> BOARD_PRINTOUT::getPainter ( KIGFX::GAL aGal)
protectedpure virtual

Returns a PAINTER instance used to draw the items.

Implemented in PCBNEW_PRINTOUT, and GERBVIEW_PRINTOUT.

Referenced by DrawPage().

bool BOARD_PRINTOUT::HasPage ( int  aPage)
inlineoverride

Definition at line 74 of file board_printout.h.

75  {
76  return aPage <= m_settings.m_pageCount;
77  }
BOARD_PRINTOUT_SETTINGS m_settings
Printout parameters
int m_pageCount
Number of pages to print.
Definition: printout.h:47
virtual int BOARD_PRINTOUT::milsToIU ( double  aMils) const
protectedpure virtual

Convert mils to internal units

Implemented in PCBNEW_PRINTOUT, and GERBVIEW_PRINTOUT.

Referenced by DrawPage().

void BOARD_PRINTOUT::setupGal ( KIGFX::GAL aGal)
protectedvirtual

Configures GAL object for a printout

Reimplemented in PCBNEW_PRINTOUT, and GERBVIEW_PRINTOUT.

Definition at line 199 of file board_printout.cpp.

References BOARD_PRINTOUT_SETTINGS::m_mirror, m_settings, and KIGFX::GAL::SetFlip().

Referenced by DrawPage(), GERBVIEW_PRINTOUT::setupGal(), and PCBNEW_PRINTOUT::setupGal().

200 {
201  aGal->SetFlip( m_settings.m_mirror, false );
202 }
void SetFlip(bool xAxis, bool yAxis)
Sets flipping of the screen.
BOARD_PRINTOUT_SETTINGS m_settings
Printout parameters
bool m_mirror
Print mirrored.
void BOARD_PRINTOUT::setupPainter ( const std::unique_ptr< KIGFX::PAINTER > &  aPainter)
protectedvirtual

Configures PAINTER object for a printout

Reimplemented in PCBNEW_PRINTOUT.

Definition at line 193 of file board_printout.cpp.

References WHITE.

Referenced by DrawPage(), and PCBNEW_PRINTOUT::setupPainter().

194 {
195  aPainter->GetSettings()->SetBackgroundColor( COLOR4D::WHITE );
196 }
Definition: colors.h:49
void BOARD_PRINTOUT::setupViewLayers ( const std::unique_ptr< KIGFX::VIEW > &  aView,
const LSET aLayerSet 
)
protectedvirtual

Enables layers visibility for a printout

Reimplemented in PCBNEW_PRINTOUT, and GERBVIEW_PRINTOUT.

Definition at line 180 of file board_printout.cpp.

References i, KIGFX::TARGET_NONCACHED, and KIGFX::VIEW::VIEW_MAX_LAYERS.

Referenced by DrawPage(), GERBVIEW_PRINTOUT::setupViewLayers(), and PCBNEW_PRINTOUT::setupViewLayers().

182 {
183  // Disable all layers by default, let specific implementions enable required layers
184  for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; ++i )
185  {
186  aView->SetLayerVisible( i, false );
187  aView->SetTopLayer( i, false );
188  aView->SetLayerTarget( i, KIGFX::TARGET_NONCACHED );
189  }
190 }
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:699
Auxiliary rendering target (noncached)
Definition: definitions.h:42
size_t i
Definition: json11.cpp:597

Member Data Documentation

const KIGFX::VIEW* BOARD_PRINTOUT::m_view
protected

Source VIEW object (note that actual printing only refers to this object)

Definition at line 110 of file board_printout.h.

Referenced by BOARD_PRINTOUT(), and DrawPage().


The documentation for this class was generated from the following files: