teardrop_parameters.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2021 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2022-2023 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 TEARDROP_PARAMS_H
#define TEARDROP_PARAMS_H
 
#include <string>
#include <vector>
#include <base_units.h>
 
// IDs for targets when creating teardrops
enum TARGET_TD
{
 TARGET_UNKNOWN = -1,
 TARGET_ROUND = 0,
 TARGET_RECT = 1,
 TARGET_TRACK = 2,
 TARGET_COUNT = 3
};
 
class TEARDROP_PARAMETERS
{
public:
 TEARDROP_PARAMETERS():
 m_Enabled( false ),
 m_AllowUseTwoTracks( true ),
 m_TdMaxLen( pcbIUScale.mmToIU( 1.0 ) ),
 m_TdMaxWidth( pcbIUScale.mmToIU( 2.0 ) ),
 m_BestLengthRatio( 0.5),
 m_BestWidthRatio( 1.0 ),
 m_CurveSegCount( 0 ),
 m_WidthtoSizeFilterRatio( 0.9 ),
 m_TdOnPadsInZones( false )
 {
 }
 
 void SetTeardropMaxSize( int aMaxLen, int aMaxHeight )
 {
 m_TdMaxLen = aMaxLen;
 m_TdMaxWidth = aMaxHeight;
 }
 
 void SetTeardropSizeRatio( double aLenghtRatio = 0.5, double aHeightRatio = 1.0 )
 {
 m_BestLengthRatio = aLenghtRatio;
 m_BestWidthRatio = aHeightRatio;
 }
 
 void SetTeardropCurvedPrm( int aCurveSegCount = 0 )
 {
 m_CurveSegCount = aCurveSegCount;
 }
 
 bool IsCurved() const { return m_CurveSegCount > 2; }
 
 bool operator== ( const TEARDROP_PARAMETERS& aOther ) const
 {
 return m_Enabled == aOther.m_Enabled &&
 m_AllowUseTwoTracks == aOther.m_AllowUseTwoTracks &&
 m_TdMaxLen == aOther.m_TdMaxLen &&
 m_TdMaxWidth == aOther.m_TdMaxWidth &&
 m_BestLengthRatio == aOther.m_BestLengthRatio &&
 m_BestWidthRatio == aOther.m_BestWidthRatio &&
 m_CurveSegCount == aOther.m_CurveSegCount &&
 m_WidthtoSizeFilterRatio == aOther.m_WidthtoSizeFilterRatio &&
 m_TdOnPadsInZones == aOther.m_TdOnPadsInZones;
 }
 
 bool operator!= ( const TEARDROP_PARAMETERS& aOther ) const
 {
 return !( *this == aOther );
 }
 
public:
 bool m_Enabled;
 bool m_AllowUseTwoTracks;
 int m_TdMaxLen;
 int m_TdMaxWidth;
 double m_BestLengthRatio;
 double m_BestWidthRatio;
 int m_CurveSegCount;
 double m_WidthtoSizeFilterRatio;
 bool m_TdOnPadsInZones;
};
 
 
 
class TEARDROP_PARAMETERS_LIST
{
 std::vector<TEARDROP_PARAMETERS> m_params_list;
 
public:
 bool m_TargetViasPads;
 bool m_TargetPadsWithNoHole;
 bool m_TargetTrack2Track;
 bool m_UseRoundShapesOnly;
 
public:
 TEARDROP_PARAMETERS_LIST() :
 m_TargetViasPads( true ),
 m_TargetPadsWithNoHole( true ),
 m_TargetTrack2Track( false ),
 m_UseRoundShapesOnly( false )
 {
 m_params_list.emplace_back(); // parameters for TARGET_ROUND
 m_params_list.emplace_back(); // parameters for TARGET_RECT
 m_params_list.emplace_back(); // parameters for TARGET_TRACK
 }
 
 TEARDROP_PARAMETERS* GetParameters( TARGET_TD aTdType )
 {
 return &m_params_list.at( aTdType );
 }
 
 size_t GetParametersCount()
 {
 return m_params_list.size();
 }
};
 
 
std::string GetTeardropTargetCanonicalName( TARGET_TD aTdType );
 
TARGET_TD GetTeardropTargetTypeFromCanonicalName( const std::string& aTargetName );
 
#endif // ifndef TEARDROP_PARAMS_H