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 The KiCad Developers, see AUTHORS.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, see <https://www.gnu.org/licenses/>.
 */

 
#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;
 

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 (plot commands)
 * Revision I1 permits apertures up to 2^31-1.
 */
#define FIRST_DCODE     10
#define LAST_DCODE      0x7FFFFFFF
 
class APERTURE_MACRO;
 

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

    static bool IsValidDcodeValue( int aDcodeValue )
    {
        return aDcodeValue >= FIRST_DCODE;
    }
 
    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( const GERBER_DRAW_ITEM* aParent, wxDC* aDC,
                           const COLOR4D& aColor,
                           const VECTOR2I& aShapePos, bool aFilledShape );

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

    void ConvertShapeToPolygon( const GERBER_DRAW_ITEM* aParent );

    int GetShapeDim( GERBER_DRAW_ITEM* aParent );
 
public:
    VECTOR2I              m_Size;           
    APERTURE_T            m_ApertType;      
    int                   m_Num_Dcode;      
    VECTOR2I              m_Drill;          
    APERTURE_DEF_HOLETYPE m_DrillShape;     
    EDA_ANGLE             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_