dcode.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2010 Jean-Pierre Charras <[email protected]>
 * Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 1992-2021 KiCad Developers, see change_log.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */

#ifndef _DCODE_H_
#define _DCODE_H_

#include <vector>

#include <gal/color4d.h>
#include <geometry/shape_poly_set.h>

using KIGFX::COLOR4D;

class wxDC;
class GERBER_DRAW_ITEM;
class EDA_RECT;


enum APERTURE_T {
 APT_CIRCLE = 'C', // Flashed shape: Circle with or without hole
 APT_RECT = 'R', // Flashed shape: Rectangle with or without hole
 APT_OVAL = '0', // Flashed shape: Oval with or without hole
 APT_POLYGON = 'P', // Flashed shape: Regular polygon (3 to 12 edges)
 // with or without hole. Can be rotated
 APT_MACRO = 'M' // Complex shape given by a macro definition (see AM_PRIMITIVE_ID)
};

// In aperture definition, round, oval and rectangular flashed shapes
// can have a hole (round or rectangular)
// this option is stored in .m_DrillShape D_CODE member
enum APERTURE_DEF_HOLETYPE {
 APT_DEF_NO_HOLE = 0,
 APT_DEF_ROUND_HOLE,
 APT_DEF_RECT_HOLE
};

/* define min and max values for D Codes values.
 * note: values >= 0 and < FIRST_DCODE can be used for special purposes
 */
#define FIRST_DCODE 10
#define LAST_DCODE 10000
#define TOOLS_MAX_COUNT (LAST_DCODE + 1)

struct APERTURE_MACRO;


class D_CODE
{
public:
 D_CODE( int num_dcode );
 ~D_CODE();
 void Clear_D_CODE_Data();

 void AppendParam( double aValue )
 {
 m_am_params.push_back( aValue );
 }

 unsigned GetParamCount() const
 {
 return m_am_params.size();
 }

 double GetParam( unsigned aIdx ) const
 {
 wxASSERT( aIdx <= m_am_params.size() );

 if( aIdx <= m_am_params.size() )
 return m_am_params[aIdx - 1];
 else
 return 0;
 }

 void SetMacro( APERTURE_MACRO* aMacro )
 {
 m_Macro = aMacro;
 }

 APERTURE_MACRO* GetMacro() const { return m_Macro; }

 static const wxChar* ShowApertureType( APERTURE_T aType );

 void DrawFlashedShape( GERBER_DRAW_ITEM* aParent, EDA_RECT* aClipBox, wxDC* aDC,
 const COLOR4D& aColor, const wxPoint& aShapePos, bool aFilledShape );

 void DrawFlashedPolygon( GERBER_DRAW_ITEM* aParent, EDA_RECT* aClipBox, wxDC* aDC,
 const COLOR4D& aColor, bool aFilled, const wxPoint& aPosition );

 void ConvertShapeToPolygon();

 int GetShapeDim( GERBER_DRAW_ITEM* aParent );

public:
 wxSize m_Size; 
 APERTURE_T m_Shape; 
 int m_Num_Dcode; 
 wxSize m_Drill; 
 APERTURE_DEF_HOLETYPE m_DrillShape; 
 double m_Rotation; 
 int m_EdgesCount; 
 bool m_InUse; 
 bool m_Defined; 
 wxString m_AperFunction; 
 SHAPE_POLY_SET m_Polygon; /* Polygon used to draw APT_POLYGON shape and some other
 * complex shapes which are converted to polygon
 * (shapes with hole )
  */

private:
 APERTURE_MACRO* m_Macro; 

 std::vector<double> m_am_params;
};


#endif // ifndef _DCODE_H_