zones.h

Go to the documentation of this file.

/*
 * 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-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 ZONES_H_
#define ZONES_H_
 
#include <wx/translation.h>
 
struct CONVERT_SETTINGS;
 
// Default values in mils for parameters in ZONE
#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
#define ZONE_BORDER_HATCH_DIST_MIL 20 // default distance between hatches to draw hatched outlines
#define ZONE_BORDER_HATCH_MINDIST_MM 0.1 // min distance between hatches to draw hatched outlines
#define ZONE_BORDER_HATCH_MAXDIST_MM 2.0 // min distance between hatches to draw hatched outlines
 
 
#define ZONE_EXPORT_VALUES 1004 // Copper zone dialog reports wxID_OK, wxID_CANCEL or
 // ZONE_EXPORT_VALUES
 
 
enum class ZONE_CONNECTION
{
 INHERITED = -1,
 NONE, 
 THERMAL, 
 FULL, 
 THT_THERMAL 
};
 
 
inline wxString PrintZoneConnection( ZONE_CONNECTION aConnection )
{
 switch( aConnection )
 {
 default:
 case ZONE_CONNECTION::INHERITED: return _( "inherited" );
 case ZONE_CONNECTION::NONE: return _( "none" );
 case ZONE_CONNECTION::THERMAL: return _( "thermal reliefs" );
 case ZONE_CONNECTION::FULL: return _( "solid" );
 case ZONE_CONNECTION::THT_THERMAL: return _( "thermal reliefs for PTH" );
 }
}
 
 
class ZONE;
class ZONE_SETTINGS;
class PCB_BASE_FRAME;
 
int InvokeNonCopperZonesEditor( PCB_BASE_FRAME* aParent, ZONE_SETTINGS* aSettings,
 CONVERT_SETTINGS* aConvertSettings = nullptr );
 
int InvokeCopperZonesEditor( PCB_BASE_FRAME* aCaller, ZONE_SETTINGS* aSettings,
 CONVERT_SETTINGS* aConvertSettings = nullptr );
 
int InvokeRuleAreaEditor( PCB_BASE_FRAME* aCaller, ZONE_SETTINGS* aSettings,
 CONVERT_SETTINGS* aConvertSettings = nullptr );
 
#endif // ZONES_H_