KiCad PCB EDA Suite
dcode.h
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-2010 Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
5  * Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 1992-2021 KiCad Developers, see change_log.txt for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
30 #ifndef _DCODE_H_
31 #define _DCODE_H_
32 
33 #include <vector>
34 
35 #include <gal/color4d.h>
37 
38 using KIGFX::COLOR4D;
39 
40 class wxDC;
41 class GERBER_DRAW_ITEM;
42 class EDA_RECT;
43 
44 
49 enum APERTURE_T {
50  APT_CIRCLE = 'C', // Flashed shape: Circle with or without hole
51  APT_RECT = 'R', // Flashed shape: Rectangle with or without hole
52  APT_OVAL = '0', // Flashed shape: Oval with or without hole
53  APT_POLYGON = 'P', // Flashed shape: Regular polygon (3 to 12 edges)
54  // with or without hole. Can be rotated
55  APT_MACRO = 'M' // Complex shape given by a macro definition (see AM_PRIMITIVE_ID)
56 };
57 
58 // In aperture definition, round, oval and rectangular flashed shapes
59 // can have a hole (round or rectangular)
60 // this option is stored in .m_DrillShape D_CODE member
65 };
66 
67 /* define min and max values for D Codes values.
68  * note: values >= 0 and < FIRST_DCODE can be used for special purposes
69  */
70 #define FIRST_DCODE 10
71 #define LAST_DCODE 10000
72 #define TOOLS_MAX_COUNT (LAST_DCODE + 1)
73 
74 struct APERTURE_MACRO;
75 
76 
80 class D_CODE
81 {
82 public:
83  D_CODE( int num_dcode );
84  ~D_CODE();
85  void Clear_D_CODE_Data();
86 
92  void AppendParam( double aValue )
93  {
94  m_am_params.push_back( aValue );
95  }
96 
100  unsigned GetParamCount() const
101  {
102  return m_am_params.size();
103  }
104 
110  double GetParam( unsigned aIdx ) const
111  {
112  wxASSERT( aIdx <= m_am_params.size() );
113 
114  if( aIdx <= m_am_params.size() )
115  return m_am_params[aIdx - 1];
116  else
117  return 0;
118  }
119 
120  void SetMacro( APERTURE_MACRO* aMacro )
121  {
122  m_Macro = aMacro;
123  }
124 
125  APERTURE_MACRO* GetMacro() const { return m_Macro; }
126 
132  static const wxChar* ShowApertureType( APERTURE_T aType );
133 
146  void DrawFlashedShape( GERBER_DRAW_ITEM* aParent, EDA_RECT* aClipBox, wxDC* aDC,
147  const COLOR4D& aColor, const wxPoint& aShapePos, bool aFilledShape );
148 
163  void DrawFlashedPolygon( GERBER_DRAW_ITEM* aParent, EDA_RECT* aClipBox, wxDC* aDC,
164  const COLOR4D& aColor, bool aFilled, const wxPoint& aPosition );
165 
172  void ConvertShapeToPolygon();
173 
185  int GetShapeDim( GERBER_DRAW_ITEM* aParent );
186 
187 public:
188  wxSize m_Size;
191  wxSize m_Drill;
193  double m_Rotation;
196  bool m_InUse;
198  bool m_Defined;
200  wxString m_AperFunction;
201  SHAPE_POLY_SET m_Polygon; /* Polygon used to draw APT_POLYGON shape and some other
204  * complex shapes which are converted to polygon
205  * (shapes with hole )
206  */
207 
208 private:
210 
215  std::vector<double> m_am_params;
216 };
217 
218 
219 #endif // ifndef _DCODE_H_
unsigned GetParamCount() const
Return the number of parameters stored in parameter list.
Definition: dcode.h:100
wxSize m_Size
Horizontal and vertical dimensions.
Definition: dcode.h:188
Definition: dcode.h:52
bool m_InUse
false if the aperture (previously defined) is not used to draw something
Definition: dcode.h:197
APERTURE_T m_Shape
shape ( Line, rectangle, circle , oval .. )
Definition: dcode.h:189
double m_Rotation
shape rotation in degrees
Definition: dcode.h:194
APERTURE_MACRO * m_Macro
no ownership, points to GERBER.m_aperture_macros element.
Definition: dcode.h:209
wxSize m_Drill
dimension of the hole (if any) (drill file)
Definition: dcode.h:191
Definition: dcode.h:51
APERTURE_DEF_HOLETYPE
Definition: dcode.h:61
bool m_Defined
false if the aperture is not defined in the header
Definition: dcode.h:199
D_CODE(int num_dcode)
Definition: dcode.cpp:59
void AppendParam(double aValue)
Add a parameter to the D_CODE parameter list.
Definition: dcode.h:92
void DrawFlashedPolygon(GERBER_DRAW_ITEM *aParent, EDA_RECT *aClipBox, wxDC *aDC, const COLOR4D &aColor, bool aFilled, const wxPoint &aPosition)
A helper function used to draw the polygon stored in m_PolyCorners.
Definition: dcode.cpp:266
Represent a set of closed polygons.
APERTURE_T
The set of all gerber aperture types allowed, according to page 16 of http://gerbv....
Definition: dcode.h:49
int m_Num_Dcode
D code value ( >= 10 )
Definition: dcode.h:190
static const wxChar * ShowApertureType(APERTURE_T aType)
Return a character string telling what type of aperture type aType is.
Definition: dcode.cpp:87
double GetParam(unsigned aIdx) const
Return a parameter stored in parameter list.
Definition: dcode.h:110
wxString m_AperFunction
the aperture attribute (created by a TA.AperFunction command).
Definition: dcode.h:200
APERTURE_DEF_HOLETYPE m_DrillShape
shape of the hole (0 = no hole, round = 1, rect = 2).
Definition: dcode.h:192
A gerber DCODE (also called Aperture) definition.
Definition: dcode.h:80
std::vector< double > m_am_params
parameters used only when this D_CODE holds a reference to an aperture macro, and these parameters wo...
Definition: dcode.h:215
Handle the component boundary box.
Definition: eda_rect.h:42
void SetMacro(APERTURE_MACRO *aMacro)
Definition: dcode.h:120
SHAPE_POLY_SET m_Polygon
Definition: dcode.h:203
int m_EdgesCount
in aperture definition Polygon only: number of edges for the polygon
Definition: dcode.h:195
APERTURE_MACRO * GetMacro() const
Definition: dcode.h:125
void ConvertShapeToPolygon()
Convert a shape to an equivalent polygon.
Definition: dcode.cpp:298
void DrawFlashedShape(GERBER_DRAW_ITEM *aParent, EDA_RECT *aClipBox, wxDC *aDC, const COLOR4D &aColor, const wxPoint &aShapePos, bool aFilledShape)
Draw the dcode shape for flashed items.
Definition: dcode.cpp:148
Support the "aperture macro" defined within standard RS274X.
Definition: am_primitive.h:167
int GetShapeDim(GERBER_DRAW_ITEM *aParent)
Calculate a value that can be used to evaluate the size of text when displaying the D-Code of an item...
Definition: dcode.cpp:116
~D_CODE()
Definition: dcode.cpp:66
void Clear_D_CODE_Data()
Definition: dcode.cpp:71
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103