/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2009-2019 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 1992-2020 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 BOARD_DESIGN_SETTINGS_H_ #define BOARD_DESIGN_SETTINGS_H_ #include #include #include #include #include #include #include #include #define DEFAULT_SILK_LINE_WIDTH 0.12 #define DEFAULT_COPPER_LINE_WIDTH 0.20 #define DEFAULT_EDGE_WIDTH 0.05 #define DEFAULT_COURTYARD_WIDTH 0.05 #define DEFAULT_LINE_WIDTH 0.10 #define DEFAULT_SILK_TEXT_SIZE 1.0 #define DEFAULT_COPPER_TEXT_SIZE 1.5 #define DEFAULT_TEXT_SIZE 1.0 #define DEFAULT_SILK_TEXT_WIDTH 0.15 #define DEFAULT_COPPER_TEXT_WIDTH 0.30 #define DEFAULT_TEXT_WIDTH 0.15 #define DEFAULT_DIMENSION_ARROW_LENGTH 50 // mils, for legacy purposes #define DEFAULT_DIMENSION_EXTENSION_OFFSET 0.5 // Board thickness, mainly for 3D view: #define DEFAULT_BOARD_THICKNESS_MM 1.6 #define DEFAULT_PCB_EDGE_THICKNESS 0.15 // soldermask to pad clearance. The default is 0 because usually board houses // create a clearance depending on their fab process: // mask material, color, price ... #define DEFAULT_SOLDERMASK_CLEARANCE 0.0 // DEFAULT_SOLDERMASK_MIN_WIDTH is only used in Gerber files: soldermask minimum size. // Set to 0, because using non 0 value creates an annoying issue in Gerber files: // pads are no longer identified as pads (Flashed items or regions) // Therefore solder mask min width must be used only in specific cases // for instance for home made boards #define DEFAULT_SOLDERMASK_MIN_WIDTH 0.0 #define DEFAULT_SOLDERPASTE_CLEARANCE 0.0 #define DEFAULT_SOLDERPASTE_RATIO 0.0 #define DEFAULT_CUSTOMTRACKWIDTH 0.2 #define DEFAULT_CUSTOMDPAIRWIDTH 0.125 #define DEFAULT_CUSTOMDPAIRGAP 0.18 #define DEFAULT_CUSTOMDPAIRVIAGAP 0.18 #define DEFAULT_MINCLEARANCE 0.0 // overall min clearance #define DEFAULT_TRACKMINWIDTH 0.2 // track width min value #define DEFAULT_VIASMINSIZE 0.4 // vias (not micro vias) min diameter #define DEFAULT_MINTHROUGHDRILL 0.3 // through holes (not micro vias) min drill diameter #define DEFAULT_MICROVIASMINSIZE 0.2 // micro vias (not vias) min diameter #define DEFAULT_MICROVIASMINDRILL 0.1 // micro vias (not vias) min drill diameter #define DEFAULT_HOLETOHOLEMIN 0.25 // separation between drilled hole edges #define DEFAULT_COPPEREDGECLEARANCE 0.01 // clearance between copper items and edge cuts #define LEGACY_COPPEREDGECLEARANCE -0.01 // A flag to indicate the legacy method (based // on edge cut line thicknesses) should be used. #define DEFAULT_SILKCLEARANCE 0.0 #define MINIMUM_ERROR_SIZE_MM 0.001 #define MAXIMUM_ERROR_SIZE_MM 0.1 /** * Struct VIA_DIMENSION * is a small helper container to handle a stock of specific vias each with * unique diameter and drill sizes in the BOARD class. */ struct VIA_DIMENSION { int m_Diameter; // <= 0 means use Netclass via diameter int m_Drill; // <= 0 means use Netclass via drill VIA_DIMENSION() { m_Diameter = 0; m_Drill = 0; } VIA_DIMENSION( int aDiameter, int aDrill ) { m_Diameter = aDiameter; m_Drill = aDrill; } bool operator==( const VIA_DIMENSION& aOther ) const { return ( m_Diameter == aOther.m_Diameter ) && ( m_Drill == aOther.m_Drill ); } bool operator<( const VIA_DIMENSION& aOther ) const { if( m_Diameter != aOther.m_Diameter ) return m_Diameter < aOther.m_Diameter; return m_Drill < aOther.m_Drill; } }; /** * Struct DIFF_PAIR_DIMENSION * is a small helper container to handle a stock of specific differential pairs each with * unique track width, gap and via gap. */ struct DIFF_PAIR_DIMENSION { int m_Width; // <= 0 means use Netclass differential pair width int m_Gap; // <= 0 means use Netclass differential pair gap int m_ViaGap; // <= 0 means use Netclass differential pair via gap DIFF_PAIR_DIMENSION() { m_Width = 0; m_Gap = 0; m_ViaGap = 0; } DIFF_PAIR_DIMENSION( int aWidth, int aGap, int aViaGap ) { m_Width = aWidth; m_Gap = aGap; m_ViaGap = aViaGap; } bool operator==( const DIFF_PAIR_DIMENSION& aOther ) const { return ( m_Width == aOther.m_Width ) && ( m_Gap == aOther.m_Gap ) && ( m_ViaGap == aOther.m_ViaGap ); } bool operator<( const DIFF_PAIR_DIMENSION& aOther ) const { if( m_Width != aOther.m_Width ) return m_Width < aOther.m_Width; if( m_Gap != aOther.m_Gap ) return m_Gap < aOther.m_Gap; return m_ViaGap < aOther.m_ViaGap; } }; enum { LAYER_CLASS_SILK = 0, LAYER_CLASS_COPPER, LAYER_CLASS_EDGES, LAYER_CLASS_COURTYARD, LAYER_CLASS_FAB, LAYER_CLASS_OTHERS, LAYER_CLASS_COUNT }; struct TEXT_ITEM_INFO { wxString m_Text; bool m_Visible; int m_Layer; TEXT_ITEM_INFO( const wxString& aText, bool aVisible, int aLayer ) { m_Text = aText; m_Visible = aVisible; m_Layer = aLayer; } }; // forward declaration from class_track.h enum class VIATYPE : int; // forward declarations from class_dimension.h enum class DIM_UNITS_FORMAT : int; enum class DIM_TEXT_POSITION : int; enum class DIM_UNITS_MODE : int; /** * BOARD_DESIGN_SETTINGS * contains design settings for a BOARD object. */ class BOARD_DESIGN_SETTINGS : public NESTED_SETTINGS { public: // Note: the first value in each dimensions list is the current netclass value std::vector m_TrackWidthList; std::vector m_ViasDimensionsList; std::vector m_DiffPairDimensionsList; bool m_MicroViasAllowed; ///< true to allow micro vias bool m_BlindBuriedViaAllowed; ///< true to allow blind/buried vias VIATYPE m_CurrentViaType; ///< (VIA_BLIND_BURIED, VIA_THROUGH, VIA_MICROVIA) bool m_UseConnectedTrackWidth; // use width of existing track when creating a new, // connected track int m_MinClearance; // overall min clearance int m_TrackMinWidth; // overall min track width int m_ViasMinAnnulus; // overall minimum width of the via copper ring int m_ViasMinSize; // overall vias (not micro vias) min diameter int m_MinThroughDrill; // through hole (not micro vias) min drill diameter int m_MicroViasMinSize; // micro vias min diameter int m_MicroViasMinDrill; // micro vias min drill diameter int m_CopperEdgeClearance; int m_HoleToHoleMin; // Min width of peninsula between two drilled holes int m_SilkClearance; std::shared_ptr m_DRCEngine; std::map m_DRCSeverities; // Map from DRCErrorCode to SEVERITY std::set m_DrcExclusions; /* * Option to select different fill algorithms. * There are currenly two supported values: * 5: * - Use thick outlines around filled polygons (gives smoothest shape but at the expense * of processing time and slight infidelity when exporting) * - Use zone outline when knocking out higher-priority zones (just wrong, but mimics * legacy behaviour. * 6: * - No thick outline. * - Use filled areas when knocking out higher-priority zones. */ int m_ZoneFillVersion; // When smoothing the zone's outline there's the question of external fillets (that is, those // applied to concave corners). While it seems safer to never have copper extend outside the // zone outline, 5.1.x and prior did indeed fill them so we leave the mode available. bool m_ZoneKeepExternalFillets; // Maximum error allowed when approximating circles and arcs to segments int m_MaxError; // Global mask margins: int m_SolderMaskMargin; // Solder mask margin int m_SolderMaskMinWidth; // Solder mask min width (2 areas closer than this // width are merged) int m_SolderPasteMargin; // Solder paste margin absolute value double m_SolderPasteMarginRatio; // Solder pask margin ratio value of pad size // The final margin is the sum of these 2 values // Variables used in footprint editing (default value in item/footprint creation) std::vector m_DefaultFPTextItems; // Arrays of default values for the various layer classes. int m_LineThickness[ LAYER_CLASS_COUNT ]; wxSize m_TextSize[ LAYER_CLASS_COUNT ]; int m_TextThickness[ LAYER_CLASS_COUNT ]; bool m_TextItalic[ LAYER_CLASS_COUNT ]; bool m_TextUpright[ LAYER_CLASS_COUNT ]; // Default values for dimension objects DIM_UNITS_MODE m_DimensionUnitsMode; int m_DimensionPrecision; ///< Number of digits after the decimal DIM_UNITS_FORMAT m_DimensionUnitsFormat; bool m_DimensionSuppressZeroes; DIM_TEXT_POSITION m_DimensionTextPosition; bool m_DimensionKeepTextAligned; int m_DimensionArrowLength; int m_DimensionExtensionOffset; // Miscellaneous wxPoint m_AuxOrigin; ///< origin for plot exports wxPoint m_GridOrigin; ///< origin for grid offsets D_PAD m_Pad_Master; // A dummy pad to store all default parameters // when importing values or creating a new pad // Set to true if the board has a stackup management. // If not set a default basic stackup witll be used to generate the ;gbrjob file. // Could be removed later, or at least always set to true bool m_HasStackup; private: // Indicies into the trackWidth, viaSizes and diffPairDimensions lists. // The 0 index is always the current netclass value(s) unsigned m_trackWidthIndex; unsigned m_viaSizeIndex; unsigned m_diffPairIndex; // Custom values for track/via sizes (specified via dialog instead of netclass or lists) bool m_useCustomTrackVia; int m_customTrackWidth; VIA_DIMENSION m_customViaSize; // Custom values for differential pairs (specified via dialog instead of netclass/lists) bool m_useCustomDiffPair; DIFF_PAIR_DIMENSION m_customDiffPair; int m_copperLayerCount; ///< Number of copper layers for this design LSET m_enabledLayers; ///< Bit-mask for layer enabling int m_boardThickness; ///< Board thickness for 3D viewer /// Current net class name used to display netclass info. /// This is also the last used netclass after starting a track. wxString m_currentNetClassName; /** the description of layers stackup, for board fabrication * only physical layers are in layers stackup. * It includes not only layers enabled for the board edition, but also dielectic layers */ BOARD_STACKUP m_stackup; /// Net classes that are loaded from the board file before these were stored in the project NETCLASSES m_internalNetClasses; /// This will point to m_internalNetClasses until it is repointed to the project after load NETCLASSES* m_netClasses; /// The defualt settings that will be used for new zones ZONE_SETTINGS m_defaultZoneSettings; void initFromOther( const BOARD_DESIGN_SETTINGS& aOther ); bool migrateSchema0to1(); public: BOARD_DESIGN_SETTINGS( JSON_SETTINGS* aParent, const std::string& aPath ); virtual ~BOARD_DESIGN_SETTINGS(); BOARD_DESIGN_SETTINGS( const BOARD_DESIGN_SETTINGS& aOther); BOARD_DESIGN_SETTINGS& operator=( const BOARD_DESIGN_SETTINGS& aOther ); bool LoadFromFile( const wxString& aDirectory = "" ) override; BOARD_STACKUP& GetStackupDescriptor() { return m_stackup; } int GetSeverity( int aDRCErrorCode ); /** * returns true if the DRC error code's severity is SEVERITY_IGNORE */ bool Ignore( int aDRCErrorCode ); NETCLASSES& GetNetClasses() const { return *m_netClasses; } void SetNetClasses( NETCLASSES* aNetClasses ) { if( aNetClasses ) m_netClasses = aNetClasses; else m_netClasses = &m_internalNetClasses; } ZONE_SETTINGS& GetDefaultZoneSettings() { return m_defaultZoneSettings; } void SetDefaultZoneSettings( const ZONE_SETTINGS& aSettings ) { m_defaultZoneSettings = aSettings; } /** * Function GetDefault * @return the default netclass. */ inline NETCLASS* GetDefault() const { return GetNetClasses().GetDefaultPtr(); } /** * Function GetCurrentNetClassName * @return the current net class name. */ inline const wxString& GetCurrentNetClassName() const { return m_currentNetClassName; } /** * Function UseNetClassTrack * returns true if netclass values should be used to obtain appropriate track width. */ inline bool UseNetClassTrack() const { return ( m_trackWidthIndex == 0 && !m_useCustomTrackVia ); } /** * Function UseNetClassVia * returns true if netclass values should be used to obtain appropriate via size. */ inline bool UseNetClassVia() const { return ( m_viaSizeIndex == 0 && !m_useCustomTrackVia ); } /** * Function UseNetClassDiffPair * returns true if netclass values should be used to obtain appropriate diff pair dimensions. */ inline bool UseNetClassDiffPair() const { return ( m_diffPairIndex == 0 && !m_useCustomDiffPair ); } /** * Function GetBiggestClearanceValue * @return the biggest clearance value found in NetClasses list */ int GetBiggestClearanceValue(); /** * Function GetSmallestClearanceValue * @return the smallest clearance value found in NetClasses list */ int GetSmallestClearanceValue(); /** * Function GetCurrentMicroViaSize * @return the current micro via size, * that is the current netclass value */ int GetCurrentMicroViaSize(); /** * Function GetCurrentMicroViaDrill * @return the current micro via drill, * that is the current netclass value */ int GetCurrentMicroViaDrill(); /** * Function GetTrackWidthIndex * @return the current track width list index. */ inline unsigned GetTrackWidthIndex() const { return m_trackWidthIndex; } /** * Function SetTrackWidthIndex * sets the current track width list index to \a aIndex. * * @param aIndex is the track width list index. */ void SetTrackWidthIndex( unsigned aIndex ); /** * Function GetCurrentTrackWidth * @return the current track width, according to the selected options * ( using the default netclass value or a preset/custom value ) * the default netclass is always in m_TrackWidthList[0] */ int GetCurrentTrackWidth() const; /** * Function SetCustomTrackWidth * Sets custom width for track (i.e. not available in netclasses or preset list). To have * it returned with GetCurrentTrackWidth() you need to enable custom track & via sizes * (UseCustomTrackViaSize()). * @param aWidth is the new track width. */ inline void SetCustomTrackWidth( int aWidth ) { m_customTrackWidth = aWidth; } /** * Function GetCustomTrackWidth * @return Current custom width for a track. */ inline int GetCustomTrackWidth() const { return m_customTrackWidth; } /** * Function GetViaSizeIndex * @return the current via size list index. */ inline unsigned GetViaSizeIndex() const { return m_viaSizeIndex; } /** * Function SetViaSizeIndex * sets the current via size list index to \a aIndex. * * @param aIndex is the via size list index. */ void SetViaSizeIndex( unsigned aIndex ); /** * Function GetCurrentViaSize * @return the current via size, according to the selected options * ( using the default netclass value or a preset/custom value ) * the default netclass is always in m_TrackWidthList[0] */ int GetCurrentViaSize() const; /** * Function SetCustomViaSize * Sets custom size for via diameter (i.e. not available in netclasses or preset list). To have * it returned with GetCurrentViaSize() you need to enable custom track & via sizes * (UseCustomTrackViaSize()). * @param aSize is the new drill diameter. */ inline void SetCustomViaSize( int aSize ) { m_customViaSize.m_Diameter = aSize; } /** * Function GetCustomViaSize * @return Current custom size for the via diameter. */ inline int GetCustomViaSize() const { return m_customViaSize.m_Diameter; } /** * Function GetCurrentViaDrill * @return the current via size, according to the selected options * ( using the default netclass value or a preset/custom value ) * the default netclass is always in m_TrackWidthList[0] */ int GetCurrentViaDrill() const; /** * Function SetCustomViaDrill * Sets custom size for via drill (i.e. not available in netclasses or preset list). To have * it returned with GetCurrentViaDrill() you need to enable custom track & via sizes * (UseCustomTrackViaSize()). * @param aDrill is the new drill size. */ inline void SetCustomViaDrill( int aDrill ) { m_customViaSize.m_Drill = aDrill; } /** * Function GetCustomViaDrill * @return Current custom size for the via drill. */ inline int GetCustomViaDrill() const { return m_customViaSize.m_Drill; } /** * Function UseCustomTrackViaSize * Enables/disables custom track/via size settings. If enabled, values set with * SetCustomTrackWidth()/SetCustomViaSize()/SetCustomViaDrill() are used for newly created * tracks and vias. * @param aEnabled decides if custom settings should be used for new tracks/vias. */ inline void UseCustomTrackViaSize( bool aEnabled ) { m_useCustomTrackVia = aEnabled; } /** * Function UseCustomTrackViaSize * @return True if custom sizes of tracks & vias are enabled, false otherwise. */ inline bool UseCustomTrackViaSize() const { return m_useCustomTrackVia; } /** * Function GetDiffPairIndex * @return the current diff pair dimension list index. */ inline unsigned GetDiffPairIndex() const { return m_diffPairIndex; } /** * Function SetDiffPairIndex * @param aIndex is the diff pair dimensions list index to set. */ void SetDiffPairIndex( unsigned aIndex ); /** * Function SetCustomDiffPairWidth * Sets custom track width for differential pairs (i.e. not available in netclasses or * preset list). * @param aDrill is the new track wdith. */ inline void SetCustomDiffPairWidth( int aWidth ) { m_customDiffPair.m_Width = aWidth; } /** * Function GetCustomDiffPairWidth * @return Current custom track width for differential pairs. */ inline int GetCustomDiffPairWidth() { return m_customDiffPair.m_Width; } /** * Function SetCustomDiffPairGap * Sets custom gap for differential pairs (i.e. not available in netclasses or preset * list). * @param aGap is the new gap. */ inline void SetCustomDiffPairGap( int aGap ) { m_customDiffPair.m_Gap = aGap; } /** * Function GetCustomDiffPairGap * @return Current custom gap width for differential pairs. */ inline int GetCustomDiffPairGap() { return m_customDiffPair.m_Gap; } /** * Function SetCustomDiffPairViaGap * Sets custom via gap for differential pairs (i.e. not available in netclasses or * preset list). * @param aGap is the new gap. Specify 0 to use the DiffPairGap for vias as well. */ inline void SetCustomDiffPairViaGap( int aGap ) { m_customDiffPair.m_ViaGap = aGap; } /** * Function GetCustomDiffPairViaGap * @return Current custom via gap width for differential pairs. */ inline int GetCustomDiffPairViaGap() { return m_customDiffPair.m_ViaGap > 0 ? m_customDiffPair.m_ViaGap : m_customDiffPair.m_Gap; } /** * Function UseCustomDiffPairDimensions * Enables/disables custom differential pair dimensions. * @param aEnabled decides if custom settings should be used for new differential pairs. */ inline void UseCustomDiffPairDimensions( bool aEnabled ) { m_useCustomDiffPair = aEnabled; } /** * Function UseCustomDiffPairDimensions * @return True if custom sizes of diff pairs are enabled, false otherwise. */ inline bool UseCustomDiffPairDimensions() const { return m_useCustomDiffPair; } /** * Function GetCurrentDiffPairWidth * @return the current diff pair track width, according to the selected options * ( using the default netclass value or a preset/custom value ) * the default netclass is always in m_DiffPairDimensionsList[0] */ inline int GetCurrentDiffPairWidth() const { if( m_useCustomDiffPair ) return m_customDiffPair.m_Width; else return m_DiffPairDimensionsList[m_diffPairIndex].m_Width; } /** * Function GetCurrentDiffPairGap * @return the current diff pair gap, according to the selected options * ( using the default netclass value or a preset/custom value ) * the default netclass is always in m_DiffPairDimensionsList[0] */ inline int GetCurrentDiffPairGap() const { if( m_useCustomDiffPair ) return m_customDiffPair.m_Gap; else return m_DiffPairDimensionsList[m_diffPairIndex].m_Gap; } /** * Function GetCurrentDiffPairViaGap * @return the current diff pair via gap, according to the selected options * ( using the default netclass value or a preset/custom value ) * the default netclass is always in m_DiffPairDimensionsList[0] */ inline int GetCurrentDiffPairViaGap() const { if( m_useCustomDiffPair ) return m_customDiffPair.m_ViaGap; else return m_DiffPairDimensionsList[m_diffPairIndex].m_ViaGap; } /** * Function SetMinHoleSeparation * @param aValue The minimum distance between the edges of two holes or 0 to disable * hole-to-hole separation checking. */ void SetMinHoleSeparation( int aDistance ); /** * Function SetCopperEdgeClearance * @param aValue The minimum distance between copper items and board edges. */ void SetCopperEdgeClearance( int aDistance ); /** * Function SetSilkEdgeClearance * @param aValue The minimum distance between silk items. Note that compound graphics * within a single footprint or on the board are not checked, but distances between text * and between graphics from different footprints are. */ void SetSilkClearance( int aDistance ); /** * Function GetEnabledLayers * returns a bit-mask of all the layers that are enabled * @return int - the enabled layers in bit-mapped form. */ inline LSET GetEnabledLayers() const { return m_enabledLayers; } /** * Function SetEnabledLayers * changes the bit-mask of enabled layers * @param aMask = The new bit-mask of enabled layers */ void SetEnabledLayers( LSET aMask ); /** * Function IsLayerEnabled * tests whether a given layer is enabled * @param aLayerId = The layer to be tested * @return bool - true if the layer is enabled */ inline bool IsLayerEnabled( PCB_LAYER_ID aLayerId ) const { return m_enabledLayers[aLayerId]; } /** * Function GetCopperLayerCount * @return int - the number of neabled copper layers */ inline int GetCopperLayerCount() const { return m_copperLayerCount; } /** * Function SetCopperLayerCount * do what its name says... * @param aNewLayerCount = The new number of enabled copper layers */ void SetCopperLayerCount( int aNewLayerCount ); inline int GetBoardThickness() const { return m_boardThickness; } inline void SetBoardThickness( int aThickness ) { m_boardThickness = aThickness; } /* * Function GetDRCEpsilon * an epsilon which accounts for rounding errors, etc. While currently an advanced cfg, * going through this API allows us to easily change it to board-specific if so desired. */ int GetDRCEpsilon() const; /** * Pad & via drills are finish size. Adding the hole plating thickness gives you the * acutal hole size. */ int GetHolePlatingThickness() const; /** * Function GetLineThickness * Returns the default graphic segment thickness from the layer class for the given layer. */ int GetLineThickness( PCB_LAYER_ID aLayer ) const; /** * Function GetTextSize * Returns the default text size from the layer class for the given layer. */ wxSize GetTextSize( PCB_LAYER_ID aLayer ) const; /** * Function GetTextThickness * Returns the default text thickness from the layer class for the given layer. */ int GetTextThickness( PCB_LAYER_ID aLayer ) const; bool GetTextItalic( PCB_LAYER_ID aLayer ) const; bool GetTextUpright( PCB_LAYER_ID aLayer ) const; int GetLayerClass( PCB_LAYER_ID aLayer ) const; }; #endif // BOARD_DESIGN_SETTINGS_H_