summaryrefslogtreecommitdiff
path: root/pcbnew/zones.h
diff options
context:
space:
mode:
authorsaurabhb172020-02-26 15:57:49 +0530
committersaurabhb172020-02-26 15:57:49 +0530
commitaa35045840b78d3f48212db45da59a2e5c69b223 (patch)
tree6acee185a4dc19113fcbf0f9a3d6941085dedaf7 /pcbnew/zones.h
parent0db48f6533517ecebfd9f0693f89deca28408b76 (diff)
downloadKiCad-eSim-aa35045840b78d3f48212db45da59a2e5c69b223.tar.gz
KiCad-eSim-aa35045840b78d3f48212db45da59a2e5c69b223.tar.bz2
KiCad-eSim-aa35045840b78d3f48212db45da59a2e5c69b223.zip
Added main execs
Diffstat (limited to 'pcbnew/zones.h')
-rw-r--r--pcbnew/zones.h102
1 files changed, 102 insertions, 0 deletions
diff --git a/pcbnew/zones.h b/pcbnew/zones.h
new file mode 100644
index 0000000..c08a300
--- /dev/null
+++ b/pcbnew/zones.h
@@ -0,0 +1,102 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2008-2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
+ * Copyright (C) 1992-2012 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 ZONES_H_
+#define ZONES_H_
+
+// keys used to store net sort option in config file :
+#define ZONE_NET_OUTLINES_HATCH_OPTION_KEY wxT( "Zone_Ouline_Hatch_Opt" )
+#define ZONE_NET_SORT_OPTION_KEY wxT( "Zone_NetSort_Opt" )
+#define ZONE_NET_FILTER_STRING_KEY wxT( "Zone_Filter_Opt" )
+#define ZONE_THERMAL_RELIEF_GAP_STRING_KEY wxT( "Zone_TH_Gap" )
+#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_STRING_KEY wxT( "Zone_TH_Copper_Width" )
+#define ZONE_CLEARANCE_WIDTH_STRING_KEY wxT( "Zone_Clearance" )
+#define ZONE_MIN_THICKNESS_WIDTH_STRING_KEY wxT( "Zone_Thickness" )
+
+// Default values in mils for parameters in ZONE_CONTAINER
+#define ZONE_THERMAL_RELIEF_GAP_MIL 20 // default value for ZONE_SETTINGS::m_ThermalReliefGap
+#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL 20 // default value for ZONE_SETTINGS::m_ThermalReliefCopperBridge
+#define ZONE_THICKNESS_MIL 10 // default value for ZONE_SETTINGS::m_ZoneMinThickness
+#define ZONE_THICKNESS_MIN_VALUE_MIL 1 // minimum acceptable value for ZONE_SETTINGS::m_ZoneMinThickness
+#define ZONE_CLEARANCE_MIL 20 // default value for ZONE_SETTINGS::m_ZoneClearance
+#define ZONE_CLEARANCE_MAX_VALUE_MIL 500 // maximum acceptable value for ZONE_SETTINGS::m_ZoneClearance
+
+
+/// Exit codes for zone editing dialogs
+enum ZONE_EDIT_T {
+ ZONE_ABORT, ///< if no change
+ ZONE_OK, ///< if new values were accepted
+ ZONE_EXPORT_VALUES ///< if values were exported to others zones
+};
+
+
+/// How pads are covered by copper in zone
+enum ZoneConnection {
+ PAD_ZONE_CONN_INHERITED = -1,
+ PAD_ZONE_CONN_NONE, ///< Pads are not covered
+ PAD_ZONE_CONN_THERMAL, ///< Use thermal relief for pads
+ PAD_ZONE_CONN_FULL, ///< pads are covered by copper
+ PAD_ZONE_CONN_THT_THERMAL ///< Thermal relief only for THT pads
+};
+
+class ZONE_CONTAINER;
+class ZONE_SETTINGS;
+class PCB_BASE_FRAME;
+
+/**
+ * Function InvokeNonCopperZonesEditor
+ * invokes up a modal dialog window for non-copper zone editing.
+ *
+ * @param aParent is the PCB_BASE_FRAME calling parent window for the modal dialog,
+ * and it gives access to the BOARD through PCB_BASE_FRAME::GetBoard().
+ * @param aZone is the ZONE_CONTAINER to edit.
+ * @param aSettings points to the ZONE_SETTINGS to edit.
+ * @return ZONE_EDIT_T - tells if user aborted, changed only one zone, or all of them.
+ */
+ZONE_EDIT_T InvokeNonCopperZonesEditor( PCB_BASE_FRAME* aParent, ZONE_CONTAINER* aZone,
+ ZONE_SETTINGS* aSettings );
+
+/**
+ * Function InvokeCopperZonesEditor
+ * invokes up a modal dialog window for copper zone editing.
+ *
+ * @param aCaller is the PCB_BASE_FRAME calling parent window for the modal dialog,
+ * and it gives access to the BOARD through PCB_BASE_FRAME::GetBoard().
+ * @param aSettings points to the ZONE_SETTINGS to edit.
+ * @return ZONE_EDIT_T - tells if user aborted, changed only one zone, or all of them.
+ */
+ZONE_EDIT_T InvokeCopperZonesEditor( PCB_BASE_FRAME* aCaller, ZONE_SETTINGS* aSettings );
+
+/**
+ * Function InvokeKeepoutAreaEditor
+ * invokes up a modal dialog window for copper zone editing.
+ *
+ * @param aCaller is the PCB_BASE_FRAME calling parent window for the modal dialog,
+ * and it gives access to the BOARD through PCB_BASE_FRAME::GetBoard().
+ * @param aSettings points to the ZONE_SETTINGS to edit.
+ * @return ZONE_EDIT_T - tells if user aborted, changed only one zone, or all of them.
+ */
+ZONE_EDIT_T InvokeKeepoutAreaEditor( PCB_BASE_FRAME* aCaller, ZONE_SETTINGS* aSettings );
+
+#endif // ZONES_H_