201 lines
7.9 KiB
C++
201 lines
7.9 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2008-2018 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.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
|
|
*/
|
|
|
|
/**
|
|
* @file class_zone_settings.h
|
|
* @brief Class ZONE_SETTINGS used to handle zones parameters in dialogs.
|
|
*/
|
|
|
|
#ifndef ZONE_SETTINGS_H_
|
|
#define ZONE_SETTINGS_H_
|
|
|
|
#include <layer_ids.h>
|
|
#include <zones.h>
|
|
#include <geometry/eda_angle.h>
|
|
#include <teardrop/teardrop_types.h>
|
|
|
|
class wxDataViewListCtrl;
|
|
|
|
enum class ZONE_FILL_MODE
|
|
{
|
|
POLYGONS = 0, // fill zone with polygons
|
|
HATCH_PATTERN = 1 // fill zone using a grid pattern
|
|
};
|
|
|
|
|
|
/// Zone border styles
|
|
enum class ZONE_BORDER_DISPLAY_STYLE
|
|
{
|
|
NO_HATCH,
|
|
DIAGONAL_FULL,
|
|
DIAGONAL_EDGE
|
|
};
|
|
|
|
/// Whether or not to remove isolated islands from a zone
|
|
enum class ISLAND_REMOVAL_MODE
|
|
{
|
|
ALWAYS = 0,
|
|
NEVER,
|
|
AREA
|
|
};
|
|
|
|
/**
|
|
* ZONE_SETTINGS
|
|
* handles zones parameters.
|
|
* Because a zone can be on copper or non copper layers, and can be also
|
|
* a keepout area, some parameters are irrelevant depending on the type of zone
|
|
*/
|
|
class ZONE_SETTINGS
|
|
{
|
|
public:
|
|
// the actual zone outline shape can be slightly modified (smoothed):
|
|
enum {
|
|
SMOOTHING_UNDEFINED = -1,
|
|
SMOOTHING_NONE = 0, // Zone outline is used without change
|
|
SMOOTHING_CHAMFER, // Zone outline is used after chamfering corners
|
|
SMOOTHING_FILLET, // Zone outline is used after rounding corners
|
|
SMOOTHING_LAST // sentinel
|
|
};
|
|
|
|
unsigned m_ZonePriority; // Priority (0 ... N) of the zone
|
|
|
|
ZONE_FILL_MODE m_FillMode;
|
|
int m_ZoneClearance; // Minimal clearance value
|
|
int m_ZoneMinThickness; // Min thickness value in filled areas
|
|
int m_HatchThickness; // HatchBorder thickness of lines (if 0 -> solid shape)
|
|
int m_HatchGap; // HatchBorder clearance between lines (0 -> solid shape)
|
|
EDA_ANGLE m_HatchOrientation; // HatchBorder orientation of grid lines
|
|
int m_HatchSmoothingLevel; // HatchBorder smoothing type, similar to corner smoothing type
|
|
// 0 = no smoothing, 1 = fillet, >= 2 = arc
|
|
double m_HatchSmoothingValue; // HatchBorder chamfer/fillet size as a ratio of hole size
|
|
double m_HatchHoleMinArea; // min size before holes are dropped (ratio)
|
|
int m_HatchBorderAlgorithm; // 0 = use min zone thickness
|
|
|
|
int m_NetcodeSelection; // Net code selection for the current zone
|
|
|
|
wxString m_Name; // Unique name for the current zone (can be blank)
|
|
|
|
LSET m_Layers; // Layers that this zone exists on
|
|
|
|
/// Option to show the zone area (outlines only, short hatches or full hatches
|
|
ZONE_BORDER_DISPLAY_STYLE m_ZoneBorderDisplayStyle;
|
|
int m_BorderHatchPitch; // for hatched outlines: dist between 2 hatches
|
|
|
|
long m_ThermalReliefGap; // thickness of the gap in thermal reliefs
|
|
long m_ThermalReliefSpokeWidth; // thickness of the copper bridge in thermal reliefs
|
|
|
|
bool m_Locked;
|
|
|
|
/* A zone outline can be a teardrop zone with different rules
|
|
* priority, smoothed corners, thermal relief...
|
|
*/
|
|
TEARDROP_TYPE m_TeardropType;
|
|
|
|
private:
|
|
int m_cornerSmoothingType; // Corner smoothing type
|
|
unsigned int m_cornerRadius; // Corner chamfer distance / fillet radius
|
|
ZONE_CONNECTION m_padConnection;
|
|
|
|
/*
|
|
* Keepout zones and keepout flags.
|
|
* Note that DRC rules can set keepouts on zones whether they're a keepout or not.
|
|
*/
|
|
bool m_isRuleArea;
|
|
|
|
bool m_keepoutDoNotAllowCopperPour;
|
|
bool m_keepoutDoNotAllowVias;
|
|
bool m_keepoutDoNotAllowTracks;
|
|
bool m_keepoutDoNotAllowPads;
|
|
bool m_keepoutDoNotAllowFootprints;
|
|
|
|
ISLAND_REMOVAL_MODE m_removeIslands;
|
|
long long int m_minIslandArea;
|
|
|
|
public:
|
|
ZONE_SETTINGS();
|
|
|
|
/**
|
|
* operator << ( const ZONE& )
|
|
* was Function ImportSetting
|
|
* copies settings from a given zone into this object.
|
|
* @param aSource: the given zone
|
|
*/
|
|
ZONE_SETTINGS& operator << ( const ZONE& aSource );
|
|
|
|
/**
|
|
* A helper routine for the various zone dialogs (copper, non-copper, keepout).
|
|
* @param aList the wxDataViewListCtrl to populate
|
|
* @param aFrame the parent editor frame
|
|
* @param aFpEditorMode true to show a single "Inner Layers" item for all inner copper layers
|
|
*/
|
|
void SetupLayersList( wxDataViewListCtrl* aList, PCB_BASE_FRAME* aFrame, LSET aLayers,
|
|
bool aFpEditorMode );
|
|
|
|
/**
|
|
* Function ExportSetting
|
|
* copy settings to a given zone
|
|
* @param aTarget: the given zone
|
|
* @param aFullExport: if false: some parameters are NOT exported
|
|
* because they must not be exported when export settings from a zone to others zones
|
|
* Currently:
|
|
* m_NetcodeSelection
|
|
*/
|
|
void ExportSetting( ZONE& aTarget, bool aFullExport = true ) const;
|
|
|
|
void SetCornerSmoothingType( int aType) { m_cornerSmoothingType = aType; }
|
|
int GetCornerSmoothingType() const { return m_cornerSmoothingType; }
|
|
|
|
void SetCornerRadius( int aRadius );
|
|
unsigned int GetCornerRadius() const { return m_cornerRadius; }
|
|
|
|
ZONE_CONNECTION GetPadConnection() const { return m_padConnection; }
|
|
void SetPadConnection( ZONE_CONNECTION aPadConnection ) { m_padConnection = aPadConnection; }
|
|
|
|
/**
|
|
* Accessors to parameters used in Rule Area zones:
|
|
*/
|
|
const bool GetIsRuleArea() const { return m_isRuleArea; }
|
|
const bool GetDoNotAllowCopperPour() const { return m_keepoutDoNotAllowCopperPour; }
|
|
const bool GetDoNotAllowVias() const { return m_keepoutDoNotAllowVias; }
|
|
const bool GetDoNotAllowTracks() const { return m_keepoutDoNotAllowTracks; }
|
|
const bool GetDoNotAllowPads() const { return m_keepoutDoNotAllowPads; }
|
|
const bool GetDoNotAllowFootprints() const { return m_keepoutDoNotAllowFootprints; }
|
|
|
|
void SetIsRuleArea( bool aEnable ) { m_isRuleArea = aEnable; }
|
|
void SetDoNotAllowCopperPour( bool aEnable ) { m_keepoutDoNotAllowCopperPour = aEnable; }
|
|
void SetDoNotAllowVias( bool aEnable ) { m_keepoutDoNotAllowVias = aEnable; }
|
|
void SetDoNotAllowTracks( bool aEnable ) { m_keepoutDoNotAllowTracks = aEnable; }
|
|
void SetDoNotAllowPads( bool aEnable ) { m_keepoutDoNotAllowPads = aEnable; }
|
|
void SetDoNotAllowFootprints( bool aEnable ) { m_keepoutDoNotAllowFootprints = aEnable; }
|
|
|
|
const ISLAND_REMOVAL_MODE GetIslandRemovalMode() const { return m_removeIslands; }
|
|
void SetIslandRemovalMode( ISLAND_REMOVAL_MODE aRemove ) { m_removeIslands = aRemove; }
|
|
|
|
long long int GetMinIslandArea() const { return m_minIslandArea; }
|
|
void SetMinIslandArea( long long int aArea ) { m_minIslandArea = aArea; }
|
|
};
|
|
|
|
|
|
#endif // ZONE_SETTINGS_H_
|