KiCad PCB EDA Suite
gerber_file_image.cpp
Go to the documentation of this file.
1 
6 /*
7  * This program source code file is part of KiCad, a free EDA CAD application.
8  *
9  * Copyright (C) 1992-2019 Jean-Pierre Charras jp.charras at wanadoo.fr
10  * Copyright (C) 1992-2019 KiCad Developers, see AUTHORS.txt for contributors.
11  *
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License
14  * as published by the Free Software Foundation; either version 2
15  * of the License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, you may find one here:
24  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
25  * or you may search the http://www.gnu.org website for the version 2 license,
26  * or you may write to the Free Software Foundation, Inc.,
27  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
28  */
29 
30 #include <fctsys.h>
31 #include <common.h>
32 #include <macros.h>
33 #include <convert_to_biu.h>
34 #include <gerbview.h>
35 #include <gerbview_frame.h>
36 #include <gerber_file_image.h>
37 #include <X2_gerber_attributes.h>
38 #include <algorithm>
39 #include <map>
40 
41 
46 extern int scaletoIU( double aCoord, bool isMetric ); // defined it rs274d_read_XY_and_IJ_coordiantes.cpp
47 
48 /* Format Gerber: NOTES:
49  * Tools and D_CODES
50  * tool number (identification of shapes)
51  * 1 to 999
52  *
53  * D_CODES:
54  * D01 ... D9 = action codes:
55  * D01 = activating light (lower pen) when di placement
56  * D02 = light extinction (lift pen) when di placement
57  * D03 Flash
58  * D09 = VAPE Flash
59  * D10 ... = Indentification Tool (Opening)
60  *
61  * For tools:
62  * DCode min = D10
63  * DCode max = 999
64  */
65 
66 
68 {
70 }
71 
72 
74 {
75 }
76 
77 
79 {
80  m_LayerName = wxT( "no name" ); // Layer name from the LN command
81  m_LayerNegative = false; // true = Negative Layer
82  m_StepForRepeat.x = m_StepForRepeat.y = 0; // X and Y offsets for Step and Repeat command
83  m_XRepeatCount = 1; // The repeat count on X axis
84  m_YRepeatCount = 1; // The repeat count on Y axis
85  m_StepForRepeatMetric = false; // false = Inches, true = metric
86 }
87 
88 
91 {
92  m_GraphicLayer = aLayer; // Graphic layer Number
93  m_IsVisible = true; // must be drawn
94  m_PositiveDrawColor = WHITE; // The color used to draw positive items for this image
95 
96  m_Selected_Tool = 0;
97  m_FileFunction = NULL; // file function parameters
98 
100 
101  for( unsigned ii = 0; ii < arrayDim( m_Aperture_List ); ii++ )
102  m_Aperture_List[ii] = 0;
103 }
104 
105 
107 {
108 
109  for( auto item : GetItems() )
110  delete item;
111 
112  m_drawings.clear();
113 
114  for( unsigned ii = 0; ii < arrayDim( m_Aperture_List ); ii++ )
115  {
116  delete m_Aperture_List[ii];
117  }
118 
119  delete m_FileFunction;
120 }
121 
122 
123 D_CODE* GERBER_FILE_IMAGE::GetDCODEOrCreate( int aDCODE, bool aCreateIfNoExist )
124 {
125  unsigned ndx = aDCODE - FIRST_DCODE;
126 
127  if( ndx < (unsigned) arrayDim( m_Aperture_List ) )
128  {
129  // lazily create the D_CODE if it does not exist.
130  if( aCreateIfNoExist )
131  {
132  if( m_Aperture_List[ndx] == NULL )
133  m_Aperture_List[ndx] = new D_CODE( ndx + FIRST_DCODE );
134  }
135 
136  return m_Aperture_List[ndx];
137  }
138 
139  return NULL;
140 }
141 
142 
144 {
145  unsigned ndx = aDCODE - FIRST_DCODE;
146 
147  if( ndx < (unsigned) arrayDim( m_Aperture_List ) )
148  {
149  return m_Aperture_List[ndx];
150  }
151 
152  return NULL;
153 }
154 
155 
157 {
158  APERTURE_MACRO_SET::iterator iter = m_aperture_macros.find( aLookup );
159 
160  if( iter != m_aperture_macros.end() )
161  {
162  APERTURE_MACRO* pam = (APERTURE_MACRO*) &(*iter);
163  return pam;
164  }
165 
166  return NULL; // not found
167 }
168 
169 
171 {
172  m_InUse = false;
174  m_FileName.Empty();
175  m_ImageName = wxT( "no name" ); // Image name from the IN command
176  m_ImageNegative = false; // true = Negative image
177  m_IsX2_file = false; // true only if a %TF, %TA or %TD command
178  delete m_FileFunction; // file function parameters
180  m_MD5_value.Empty(); // MD5 value found in a %TF.MD5 command
181  m_PartString.Empty(); // string found in a %TF.Part command
182  m_hasNegativeItems = -1; // set to uninitialized
183  m_ImageJustifyOffset = wxPoint(0,0); // Image justify Offset
184  m_ImageJustifyXCenter = false; // Image Justify Center on X axis (default = false)
185  m_ImageJustifyYCenter = false; // Image Justify Center on Y axis (default = false)
186  m_GerbMetric = false; // false = Inches (default), true = metric
187  m_Relative = false; // false = absolute Coord,
188  // true = relative Coord
189  m_NoTrailingZeros = false; // true: trailing zeros deleted
190  m_ImageOffset.x = m_ImageOffset.y = 0; // Coord Offset, from IO command
191  m_ImageRotation = 0; // Allowed 0, 90, 180, 270 (in degree)
192  m_LocalRotation = 0.0; // Layer totation from RO command (in 0.1 degree)
193  m_Offset.x = 0;
194  m_Offset.y = 0; // Coord Offset, from OF command
195  m_Scale.x = m_Scale.y = 1.0; // scale (A and B) this layer
196  m_MirrorA = false; // true: miror / axe A (default = X)
197  m_MirrorB = false; // true: miror / axe B (default = Y)
198  m_SwapAxis = false; // false if A = X, B = Y; true if A =Y, B = Y
199  m_Has_DCode = false; // true = DCodes in file
200  // false = no DCode-> perhaps deprecated RS274D file
201  m_Has_MissingDCode = false; // true = some D_Codes are used, but not defined
202  // perhaps deprecated RS274D file
203  m_FmtScale.x = m_FmtScale.y = 4; // Initialize default format to 3.4 => 4
204  m_FmtLen.x = m_FmtLen.y = 3 + 4; // Initialize default format len = 3+4
205 
206  m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // Linear, 90 arc, Circ.
207  m_360Arc_enbl = false; // 360 deg circular
208  // interpolation disable
209  m_AsArcG74G75Cmd = false; // false untile a G74 or G75 comand is found
210  m_Current_Tool = 0; // Current Dcode selected
211  m_CommandState = 0; // State of the current command
212  m_CurrentPos.x = m_CurrentPos.y = 0; // current specified coord
213  m_PreviousPos.x = m_PreviousPos.y = 0; // last specified coord
214  m_IJPos.x = m_IJPos.y = 0; // current centre coord for
215  // plot arcs & circles
216  m_LastCoordIsIJPos = false; // True only after a IJ coordinate is read
217  m_ArcRadius = 0; // radius of arcs in circular interpol (given by A## command).
218  // in command like X##Y##A##
219  m_LastArcDataType = ARC_INFO_TYPE_NONE; // Extra coordinate info type for arcs
220  // (radius or IJ center coord)
221  m_LineNum = 0; // line number in file being read
222  m_Current_File = NULL; // Gerber file to read
223  m_PolygonFillMode = false;
225  m_Selected_Tool = 0;
226  m_Last_Pen_Command = 0;
227  m_Exposure = false;
228 }
229 
230 
231 /* Function HasNegativeItems
232  * return true if at least one item must be drawn in background color
233  * used to optimize screen refresh
234  */
236 {
237  if( m_hasNegativeItems < 0 ) // negative items are not yet searched: find them if any
238  {
239  if( m_ImageNegative ) // A negative layer is expected having always negative objects.
240  m_hasNegativeItems = 1;
241  else
242  {
243  m_hasNegativeItems = 0;
244  for( GERBER_DRAW_ITEM* item : GetItems() )
245  {
246  if( item->GetLayer() != m_GraphicLayer )
247  continue;
248  if( item->HasNegativeItems() )
249  {
250  m_hasNegativeItems = 1;
251  break;
252  }
253  }
254  }
255  }
256  return m_hasNegativeItems == 1;
257 }
258 
260 {
261  int count = 0;
262 
263  for( unsigned ii = 0; ii < arrayDim( m_Aperture_List ); ii++ )
264  {
265  if( m_Aperture_List[ii] )
266  if( m_Aperture_List[ii]->m_InUse || m_Aperture_List[ii]->m_Defined )
267  ++count;
268  }
269 
270  return count;
271 }
272 
273 
275 {
276  for( int count = 0; count < TOOLS_MAX_COUNT; count++ )
277  {
278  if( m_Aperture_List[count] == NULL )
279  continue;
280 
281  m_Aperture_List[count]->m_Num_Dcode = count + FIRST_DCODE;
283  }
284 
285  m_aperture_macros.clear();
286 }
287 
288 
298 {
299  if( GetLayerParams().m_XRepeatCount < 2 &&
300  GetLayerParams().m_YRepeatCount < 2 )
301  return; // Nothing to repeat
302 
303  // Duplicate item:
304  for( int ii = 0; ii < GetLayerParams().m_XRepeatCount; ii++ )
305  {
306  for( int jj = 0; jj < GetLayerParams().m_YRepeatCount; jj++ )
307  {
308  // the first gerber item already exists (this is the template)
309  // create duplicate only if ii or jj > 0
310  if( jj == 0 && ii == 0 )
311  continue;
312 
313  GERBER_DRAW_ITEM* dupItem = new GERBER_DRAW_ITEM( aItem );
314  wxPoint move_vector;
315  move_vector.x = scaletoIU( ii * GetLayerParams().m_StepForRepeat.x,
316  GetLayerParams().m_StepForRepeatMetric );
317  move_vector.y = scaletoIU( jj * GetLayerParams().m_StepForRepeat.y,
318  GetLayerParams().m_StepForRepeatMetric );
319  dupItem->MoveXY( move_vector );
320  AddItemToList( dupItem );
321  }
322  }
323 }
324 
325 
335 {
336  wxString msg;
337 
338  aMainFrame->ClearMsgPanel();
339 
340  // Display Image name (Image specific)
341  aMainFrame->AppendMsgPanel( _( "Image name" ), m_ImageName, CYAN );
342 
343  // Display graphic layer number used to draw this Image
344  // (not a Gerber parameter but is also image specific)
345  msg.Printf( wxT( "%d" ), m_GraphicLayer + 1 );
346  aMainFrame->AppendMsgPanel( _( "Graphic layer" ), msg, BROWN );
347 
348  // Display Image rotation (Image specific)
349  msg.Printf( wxT( "%d" ), m_ImageRotation );
350  aMainFrame->AppendMsgPanel( _( "Img Rot." ), msg, CYAN );
351 
352  // Display Image polarity (Image specific)
353  msg = m_ImageNegative ? _("Negative") : _("Normal");
354  aMainFrame->AppendMsgPanel( _( "Polarity" ), msg, BROWN );
355 
356  // Display Image justification and offset for justification (Image specific)
357  msg = m_ImageJustifyXCenter ? _("Center") : _("Normal");
358  aMainFrame->AppendMsgPanel( _( "X Justify" ), msg, DARKRED );
359 
360  msg = m_ImageJustifyYCenter ? _("Center") : _("Normal");
361  aMainFrame->AppendMsgPanel( _( "Y Justify" ), msg, DARKRED );
362 
363  if( aMainFrame->GetUserUnits() == EDA_UNITS::INCHES )
364  msg.Printf( wxT( "X=%f Y=%f" ), Iu2Mils( m_ImageJustifyOffset.x ) / 1000.0,
365  Iu2Mils( m_ImageJustifyOffset.y ) / 1000.0 );
366  else
367  msg.Printf( wxT( "X=%f Y=%f" ), Iu2Millimeter( m_ImageJustifyOffset.x ),
368  Iu2Millimeter( m_ImageJustifyOffset.y ) );
369 
370  aMainFrame->AppendMsgPanel( _( "Image Justify Offset" ), msg, DARKRED );
371 }
372 
373 
375 {
376  /* Called when a %TD command is found
377  * Remove the attribute specified by the %TD command.
378  * is no attribute, all current attributes specified by the %TO and the %TA
379  * commands are cleared.
380  * if a attribute name is specified (for instance %TD.CN*%) is specified,
381  * only this attribute is cleared
382  */
383  wxString cmd = aAttribute.GetPrm( 0 );
385 
386  if( cmd.IsEmpty() || cmd == ".AperFunction" )
387  m_AperFunction.Clear();
388 }
389 
390 
391 SEARCH_RESULT GERBER_FILE_IMAGE::Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] )
392 {
393  KICAD_T stype;
395  const KICAD_T* p = scanTypes;
396  bool done = false;
397 
398  while( !done )
399  {
400  stype = *p;
401 
402  switch( stype )
403  {
404  case GERBER_IMAGE_T:
405  case GERBER_LAYOUT_T:
406  ++p;
407  break;
408 
409  case GERBER_DRAW_ITEM_T:
410  result = IterateForward( GetItems(), inspector, testData, p );
411  ++p;
412  break;
413 
414  case EOT:
415  default: // catch EOT or ANY OTHER type here and return.
416  done = true;
417  break;
418  }
419 
420  if( result == SEARCH_RESULT::QUIT )
421  break;
422  }
423 
424  return result;
425 }
APERTURE_MACRO_SET m_aperture_macros
a collection of APERTURE_MACROS, sorted by name
wxString m_LayerName
X2_ATTRIBUTE_FILEFUNCTION * m_FileFunction
bool HasNegativeItems()
Function HasNegativeItems.
X2_ATTRIBUTE The attribute value consists of a number of substrings separated by a comma.
GERBER_DRAW_ITEMS & GetItems()
wxRealPoint m_StepForRepeat
GERBER_FILE_IMAGE(int layer)
D_CODE * GetDCODE(int aDCODE) const
Function GetDCODE returns a pointer to the D_CODE within this GERBER for the given aDCODE.
Definition: color4d.h:61
int scaletoIU(double aCoord, bool isMetric)
Function scaletoIU converts a distance given in floating point to our internal units.
const wxString & GetPrm(int aIdx)
SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
This file contains miscellaneous commonly used macros and functions.
D_CODE * m_Aperture_List[TOOLS_MAX_COUNT]
Dcode (Aperture) List for this layer (max TOOLS_MAX_COUNT: see dcode.h)
GERBER_DRAW_ITEMS m_drawings
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:105
void DisplayImageInfo(GERBVIEW_FRAME *aMainFrame)
Function DisplayImageInfo has knowledge about the frame and how and where to put status information a...
void AddItemToList(GERBER_DRAW_ITEM *aItem)
Add a new GERBER_DRAW_ITEM item to the drawings list.
GERBER_LAYER m_GBRLayerParams
#define NULL
#define FIRST_DCODE
Definition: dcode.h:71
int m_Num_Dcode
D code value ( >= 10 )
Definition: dcode.h:96
Definition: color4d.h:58
APERTURE_MACRO * FindApertureMacro(const APERTURE_MACRO &aLookup)
Function FindApertureMacro looks up a previously read in aperture macro.
virtual void ClearMsgPanel()
Clear all messages from the message panel.
bool m_StepForRepeatMetric
void RemoveAttribute(X2_ATTRIBUTE &aAttribute)
Function RemoveAttribute.
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:160
Definition: color4d.h:48
void AppendMsgPanel(const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
Append a message to the message panel.
bool m_Exposure
whether an aperture macro tool is flashed on or off
LAST_EXTRA_ARC_DATA_TYPE m_LastArcDataType
D_CODE holds a gerber DCODE (also called Aperture) definition.
Definition: dcode.h:82
#define _(s)
Definition: 3d_actions.cpp:33
GBR_NETLIST_METADATA m_NetAttributeDict
#define TOOLS_MAX_COUNT
Definition: dcode.h:73
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:159
The common library.
void ClearAttribute(const wxString *aName)
remove the net attribute specified by aName If aName == NULL or empty, remove all attributes
static SEARCH_RESULT IterateForward(std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )
Definition: base_struct.h:384
Struct APERTURE_MACRO helps support the "aperture macro" defined within standard RS274X.
Definition: am_primitive.h:163
void InitToolTable()
Function InitToolTable.
SEARCH_RESULT
Definition: base_struct.h:51
void MoveXY(const wxPoint &aMoveVector)
Function MoveXY move this object.
void StepAndRepeatItem(const GERBER_DRAW_ITEM &aItem)
Function StepAndRepeatItem Gerber format has a command Step an Repeat This function must be called wh...
void Clear_D_CODE_Data()
Definition: dcode.cpp:77
D_CODE * GetDCODEOrCreate(int aDCODE, bool aCreateIfNoExist=true)
Function GetDCODEOrCreate returns a pointer to the D_CODE within this GERBER for the given aDCODE.
EDA_UNITS GetUserUnits() const
Return the user units currently in use.
GERBER_LAYER & GetLayerParams()
Function GetLayerParams.
virtual void ResetDefaultValues()