aperture_macro.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 <jp.charras at wanadoo.fr>
 * Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 1992-2023 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, 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 APERTURE_MACRO_H
#define APERTURE_MACRO_H
 
 
#include <vector>
#include <set>
 
#include <am_param.h>
#include <am_primitive.h>
 
class SHAPE_POLY_SET;
 
/*
 * An aperture macro defines a complex shape and is a list of aperture primitives.
 * Each aperture primitive defines a simple shape (circle, rect, regular polygon...)
 * Inside a given aperture primitive, a fixed list of parameters defines info
 * about the shape: size, thickness, number of vertex ...
 *
 * Each parameter can be an immediate value or a deferred value.
 * When value is deferred, it is defined when the aperture macro is instanced by
 * an ADD macro command
 * Note also a deferred parameter can be defined in aperture macro,
 * but outside aperture primitives. Example
 * %AMRECTHERM*
 * $4=$3/2* parameter $4 is half value of parameter $3
 * 21,1,$1-$3,$2-$3,0-$1/2-$4,0-$2/2-$4,0*
 * For the aperture primitive, parameters $1 to $3 will be defined in ADD command,
 * and $4 is defined inside the macro
 *
 * Each basic shape can be a positive shape or a negative shape.
 * a negative shape is "local" to the whole shape.
 * It must be seen like a hole in the shape, and not like a standard negative object.
 */
 
 
class APERTURE_MACRO
{
public:
 APERTURE_MACRO() :
 m_paramLevelEval( 0 )
 {}
 double GetLocalParam( const D_CODE* aDcode, unsigned aParamId ) const;
 
 void InitLocalParams( const D_CODE* aDcode );
 
 void EvalLocalParams( const AM_PRIMITIVE& aPrimitive );
 
 double GetLocalParamValue( int aIndex );
 
 SHAPE_POLY_SET* GetApertureMacroShape( const GERBER_DRAW_ITEM* aParent,
 const VECTOR2I& aShapePos );
 
 wxString m_AmName;
 
 void AddPrimitiveToList( AM_PRIMITIVE& aPrimitive );
 
 void AddLocalParamDefToStack();
 AM_PARAM& GetLastLocalParamDefFromStack();
 
private:
 std::vector<AM_PRIMITIVE> m_primitivesList;
 
 AM_PARAMS m_localParamStack;
 
 std::map<int, double> m_localParamValues;
 
 int m_paramLevelEval;
 
 SHAPE_POLY_SET m_shape; 
};
 
 
struct APERTURE_MACRO_less_than
{
 // a "less than" test on two APERTURE_MACROs (.name wxStrings)
 bool operator()( const APERTURE_MACRO& am1, const APERTURE_MACRO& am2 ) const
 {
 return am1.m_AmName.Cmp( am2.m_AmName ) < 0; // case specific wxString compare
 }
};
 
 
typedef std::set<APERTURE_MACRO, APERTURE_MACRO_less_than> APERTURE_MACRO_SET;
typedef std::pair<APERTURE_MACRO_SET::iterator, bool> APERTURE_MACRO_SET_PAIR;
 
 
#endif // ifndef APERTURE_MACRO_H