kicad/include/pad_shapes.h

109 lines
3.7 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2022 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 PAD_SHAPES_H_
#define PAD_SHAPES_H_
#include <string>
/**
* The set of pad shapes, used with PAD::{Set,Get}Shape()
*
* --> DO NOT REORDER, legacy_plugin is dependent on the integer values <--
*/
enum class PAD_SHAPE : int
{
CIRCLE,
RECTANGLE, // do not use just RECT: it collides in a header on MSYS2
OVAL,
TRAPEZOID,
ROUNDRECT,
// Rectangle with a chamfered corner ( and with rounded other corners).
CHAMFERED_RECT,
CUSTOM // A shape defined by user, using a set of basic shapes
// (thick segments, circles, arcs, polygons).
};
static inline std::string PAD_SHAPE_T_asString( PAD_SHAPE a )
{
switch( a )
{
case PAD_SHAPE::CIRCLE: return "PAD_SHAPE::CIRCLE";
case PAD_SHAPE::RECTANGLE: return "PAD_SHAPE::RECT";
case PAD_SHAPE::OVAL: return "PAD_SHAPE::OVAL";
case PAD_SHAPE::TRAPEZOID: return "PAD_SHAPE::TRAPEZOID";
case PAD_SHAPE::ROUNDRECT: return "PAD_SHAPE::ROUNDRECT";
case PAD_SHAPE::CHAMFERED_RECT: return "PAD_SHAPE::CHAMFERED_RECT";
case PAD_SHAPE::CUSTOM: return "PAD_SHAPE::CUSTOM";
}
return ""; // Just to quiet GCC.
};
/**
* The set of pad drill shapes, used with PAD::{Set,Get}DrillShape()
*/
enum PAD_DRILL_SHAPE_T
{
PAD_DRILL_SHAPE_CIRCLE,
PAD_DRILL_SHAPE_OBLONG,
};
/**
* The set of pad shapes, used with PAD::{Set,Get}Attribute().
*
* The double name is for convenience of Python devs
*/
enum class PAD_ATTRIB
{
PTH, ///< Plated through hole pad
SMD, ///< Smd pad, appears on the solder paste layer (default)
CONN, ///< Like smd, does not appear on the solder paste layer (default)
///< note also has a special attribute in Gerber X files
///< Used for edgecard connectors for instance
NPTH, ///< like PAD_PTH, but not plated
///< mechanical use only, no connection allowed
};
/**
* The set of pad properties used in Gerber files (Draw files, and P&P files)
* to define some properties in fabrication or test files.
*/
enum class PAD_PROP
{
NONE, ///< no special fabrication property
BGA, ///< Smd pad, used in BGA footprints
FIDUCIAL_GLBL, ///< a fiducial (usually a smd) for the full board
FIDUCIAL_LOCAL, ///< a fiducial (usually a smd) local to the parent footprint
TESTPOINT, ///< a test point pad
HEATSINK, ///< a pad used as heat sink, usually in SMD footprints
CASTELLATED ///< a pad with a castellated through hole
};
#endif // PAD_SHAPES_H_