KiCad PCB EDA Suite
common_plot_functions.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) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors.
5 *
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 <eda_item.h>
26#include <font/font.h>
33#include <title_block.h>
34#include <wx/filename.h>
35
36
38{
39 switch( aFormat )
40 {
53 default:
54 wxASSERT( false );
55 return wxEmptyString;
56 }
57}
58
59
60void PlotDrawingSheet( PLOTTER* plotter, const PROJECT* aProject, const TITLE_BLOCK& aTitleBlock,
61 const PAGE_INFO& aPageInfo, const std::map<wxString, wxString>* aProperties,
62 const wxString& aSheetNumber, int aSheetCount, const wxString& aSheetName,
63 const wxString& aSheetPath, const wxString& aFilename, COLOR4D aColor,
64 bool aIsFirstPage )
65{
66 /* Note: Page sizes values are given in mils
67 */
68 double iusPerMil = plotter->GetIUsPerDecimil() * 10.0;
69 COLOR4D plotColor = plotter->GetColorMode() ? aColor : COLOR4D::BLACK;
70 RENDER_SETTINGS* settings = plotter->RenderSettings();
71 int defaultPenWidth = settings->GetDefaultPenWidth();
72
73 if( plotColor == COLOR4D::UNSPECIFIED )
74 plotColor = COLOR4D( RED );
75
76 plotter->SetColor( plotColor );
77 DS_DRAW_ITEM_LIST drawList;
78
79 // Print only a short filename, if aFilename is the full filename
80 wxFileName fn( aFilename );
81
82 // Prepare plot parameters
84 drawList.SetMilsToIUfactor( iusPerMil );
85 drawList.SetPageNumber( aSheetNumber );
86 drawList.SetSheetCount( aSheetCount );
87 drawList.SetFileName( fn.GetFullName() ); // Print only the short filename
88 drawList.SetSheetName( aSheetName );
89 drawList.SetSheetPath( aSheetPath );
90 drawList.SetSheetLayer( settings->GetLayerName() );
91 drawList.SetProject( aProject );
92 drawList.SetIsFirstPage( aIsFirstPage );
93 drawList.SetProperties( aProperties );
94
95 drawList.BuildDrawItemsList( aPageInfo, aTitleBlock );
96
97 // Draw item list
98 for( DS_DRAW_ITEM_BASE* item = drawList.GetFirst(); item; item = drawList.GetNext() )
99 {
101
102 switch( item->Type() )
103 {
104 case WSG_LINE_T:
105 {
106 DS_DRAW_ITEM_LINE* line = (DS_DRAW_ITEM_LINE*) item;
107 plotter->SetCurrentLineWidth( std::max( line->GetPenWidth(), defaultPenWidth ) );
108 plotter->MoveTo( line->GetStart() );
109 plotter->FinishTo( line->GetEnd() );
110 }
111 break;
112
113 case WSG_RECT_T:
114 {
115 DS_DRAW_ITEM_RECT* rect = (DS_DRAW_ITEM_RECT*) item;
116 plotter->SetCurrentLineWidth( std::max( rect->GetPenWidth(), defaultPenWidth ) );
117 plotter->MoveTo( rect->GetStart() );
118 plotter->LineTo( VECTOR2I( rect->GetEnd().x, rect->GetStart().y ) );
119 plotter->LineTo( VECTOR2I( rect->GetEnd().x, rect->GetEnd().y ) );
120 plotter->LineTo( VECTOR2I( rect->GetStart().x, rect->GetEnd().y ) );
121 plotter->FinishTo( rect->GetStart() );
122 }
123 break;
124
125 case WSG_TEXT_T:
126 {
128 KIFONT::FONT* font = text->GetFont();
129
130 if( !font )
131 {
132 font = KIFONT::FONT::GetFont( settings->GetDefaultFont(), text->IsBold(),
133 text->IsItalic() );
134 }
135
136 int penWidth = std::max( text->GetEffectiveTextPenWidth(), defaultPenWidth );
137
138 plotter->Text( text->GetTextPos(), plotColor, text->GetShownText(),
139 text->GetTextAngle(), text->GetTextSize(), text->GetHorizJustify(),
140 text->GetVertJustify(), penWidth, text->IsItalic(), text->IsBold(),
141 text->IsMultilineAllowed(), font );
142 }
143 break;
144
145 case WSG_POLY_T:
146 {
148 int penWidth = std::max( poly->GetPenWidth(), defaultPenWidth );
149 std::vector<VECTOR2I> points;
150
151 for( int idx = 0; idx < poly->GetPolygons().OutlineCount(); ++idx )
152 {
153 points.clear();
154 SHAPE_LINE_CHAIN& outline = poly->GetPolygons().Outline( idx );
155
156 for( int ii = 0; ii < outline.PointCount(); ii++ )
157 points.emplace_back( outline.CPoint( ii ).x, outline.CPoint( ii ).y );
158
159 plotter->PlotPoly( points, FILL_T::FILLED_SHAPE, penWidth );
160 }
161 }
162 break;
163
164 case WSG_BITMAP_T:
165 {
166 DS_DRAW_ITEM_BITMAP* drawItem = (DS_DRAW_ITEM_BITMAP*) item;
167 DS_DATA_ITEM_BITMAP* bitmap = (DS_DATA_ITEM_BITMAP*) drawItem->GetPeer();
168
169 if( bitmap->m_ImageBitmap == nullptr )
170 break;
171
172 bitmap->m_ImageBitmap->PlotImage( plotter, drawItem->GetPosition(), plotColor,
174 }
175 break;
176
177 default:
178 wxFAIL_MSG( "PlotDrawingSheet(): Unknown drawing sheet item." );
179 break;
180 }
181 }
182}
void PlotImage(PLOTTER *aPlotter, const VECTOR2I &aPos, const KIGFX::COLOR4D &aDefaultColor, int aDefaultPensize) const
Plot bitmap on plotter.
BITMAP_BASE * m_ImageBitmap
Definition: ds_data_item.h:370
Base class to handle basic graphic items.
Definition: ds_draw_item.h:59
virtual int GetPenWidth() const
Definition: ds_draw_item.h:70
DS_DATA_ITEM * GetPeer() const
Definition: ds_draw_item.h:63
VECTOR2I GetPosition() const override
Definition: ds_draw_item.h:357
const VECTOR2I & GetStart() const
Definition: ds_draw_item.h:133
const VECTOR2I & GetEnd() const
Definition: ds_draw_item.h:135
Store the list of graphic items: rect, lines, polygons and texts to draw/plot the title block and fra...
Definition: ds_draw_item.h:385
DS_DRAW_ITEM_BASE * GetFirst()
Definition: ds_draw_item.h:483
void BuildDrawItemsList(const PAGE_INFO &aPageInfo, const TITLE_BLOCK &aTitleBlock)
Drawing or plot the drawing sheet.
void SetSheetPath(const wxString &aSheetPath)
Set the sheet path to draw/plot.
Definition: ds_draw_item.h:437
void SetFileName(const wxString &aFileName)
Set the filename to draw/plot.
Definition: ds_draw_item.h:427
void SetDefaultPenSize(int aPenSize)
Definition: ds_draw_item.h:444
void SetSheetName(const wxString &aSheetName)
Set the sheet name to draw/plot.
Definition: ds_draw_item.h:432
void SetIsFirstPage(bool aIsFirstPage)
Set if the page is the first page.
Definition: ds_draw_item.h:465
void SetProperties(const std::map< wxString, wxString > *aProps)
Set properties used for text variable resolution.
Definition: ds_draw_item.h:417
void SetSheetLayer(const wxString &aSheetLayer)
Set the sheet layer to draw/plot.
Definition: ds_draw_item.h:442
void SetSheetCount(int aSheetCount)
Set the value of the count of sheets, for basic inscriptions.
Definition: ds_draw_item.h:470
void SetPageNumber(const wxString &aPageNumber)
Set the value of the sheet number.
Definition: ds_draw_item.h:460
DS_DRAW_ITEM_BASE * GetNext()
Definition: ds_draw_item.h:493
void SetMilsToIUfactor(double aMils2Iu)
Set the scalar to convert pages units (mils) to draw/plot units.
Definition: ds_draw_item.h:450
void SetProject(const PROJECT *aProject)
Definition: ds_draw_item.h:407
SHAPE_POLY_SET & GetPolygons()
Definition: ds_draw_item.h:171
Non filled rectangle with thick segment.
Definition: ds_draw_item.h:208
const VECTOR2I & GetEnd() const
Definition: ds_draw_item.h:223
const VECTOR2I & GetStart() const
Definition: ds_draw_item.h:221
A graphic text.
Definition: ds_draw_item.h:303
static wxString GetDefaultFileExtension()
Definition: plotter_dxf.h:47
static wxString GetDefaultFileExtension()
static wxString GetDefaultFileExtension()
Definition: plotter_hpgl.h:43
FONT is an abstract base class for both outline and stroke fonts.
Definition: font.h:105
static FONT * GetFont(const wxString &aFontName=wxEmptyString, bool aBold=false, bool aItalic=false)
Definition: font.cpp:65
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
int GetDefaultPenWidth() const
const wxString & GetDefaultFont() const
const wxString & GetLayerName() const
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:54
static wxString GetDefaultFileExtension()
Base plotter engine class.
Definition: plotter.h:110
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:114
void MoveTo(const VECTOR2I &pos)
Definition: plotter.h:247
void FinishTo(const VECTOR2I &pos)
Definition: plotter.h:257
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:141
double GetIUsPerDecimil() const
The IUs per decimil are an essential scaling factor when plotting; they are set and saved when establ...
Definition: plotter.h:210
virtual void Text(const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const EDA_ANGLE &aOrient, const VECTOR2I &aSize, enum GR_TEXT_H_ALIGN_T aH_justify, enum GR_TEXT_V_ALIGN_T aV_justify, int aPenWidth, bool aItalic, bool aBold, bool aMultilineAllowed, KIFONT::FONT *aFont, void *aData=nullptr)
Draw text with the plotter.
Definition: plotter.cpp:714
bool GetColorMode() const
Definition: plotter.h:138
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.
void LineTo(const VECTOR2I &pos)
Definition: plotter.h:252
virtual void PlotPoly(const std::vector< VECTOR2I > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr)=0
Draw a polygon ( filled or not ).
virtual void SetColor(const COLOR4D &color)=0
Container for project specific data.
Definition: project.h:64
static wxString GetDefaultFileExtension()
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
int PointCount() const
Return the number of points (vertices) in this line chain.
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
SHAPE_LINE_CHAIN & Outline(int aIndex)
static wxString GetDefaultFileExtension()
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition: title_block.h:41
@ BLACK
Definition: color4d.h:44
@ RED
Definition: color4d.h:59
wxString GetDefaultPlotExtension(PLOT_FORMAT aFormat)
Returns the default plot extension for a format.
void PlotDrawingSheet(PLOTTER *plotter, const PROJECT *aProject, const TITLE_BLOCK &aTitleBlock, const PAGE_INFO &aPageInfo, const std::map< wxString, wxString > *aProperties, const wxString &aSheetNumber, int aSheetCount, const wxString &aSheetName, const wxString &aSheetPath, const wxString &aFilename, COLOR4D aColor, bool aIsFirstPage)
@ FILLED_SHAPE
PLOT_FORMAT
The set of supported output plot formats.
Definition: plotter.h:70
Plotting engine (DXF)
Plotting engine (Gerber)
Plotting engine (HPGL)
Plotting engines similar to ps (PostScript, Gerber, svg)
@ WSG_POLY_T
Definition: typeinfo.h:222
@ WSG_LINE_T
Definition: typeinfo.h:220
@ WSG_TEXT_T
Definition: typeinfo.h:223
@ WSG_RECT_T
Definition: typeinfo.h:221
@ WSG_BITMAP_T
Definition: typeinfo.h:224
VECTOR2< int > VECTOR2I
Definition: vector2d.h:618