teardrop.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) 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_H
#define TEARDROP_H
 
#include <tool/tool_manager.h>
#include <board.h>
#include <footprint.h>
#include <pad.h>
#include <pcb_track.h>
#include <zone.h>
#include <drc/drc_rtree.h>
#include "teardrop_parameters.h"
 
#define MAGIC_TEARDROP_PADVIA_NAME "$teardrop_padvia$"
#define MAGIC_TEARDROP_TRACK_NAME "$teardrop_track$"
 
// A class to store tracks grouped by layer and netcode
class TRACK_BUFFER
{
public:
 TRACK_BUFFER() {}
 
 void AddTrack( PCB_TRACK* aTrack, int aLayer, int aNetcode );
 
 std::vector<PCB_TRACK*>* GetTrackList( int aLayer, int aNetcode ) const
 {
 return m_map_tracks.at( idxFromLayNet( aLayer, aNetcode ) );
 }
 
 const std::map< int, std::vector<PCB_TRACK*>* >& GetBuffer() const { return m_map_tracks; }
 
 static void GetNetcodeAndLayerFromIndex( int aIdx, int* aLayer, int* aNetcode )
 {
 *aLayer = aIdx & 0xFF;
 *aNetcode = aIdx >> 8;
 }
 
private:
 // Build an index from the layer id and the netcode, to store a track in buffer
 int idxFromLayNet( int aLayer, int aNetcode ) const
 {
 return ( aNetcode << 8 ) + ( aLayer & 0xFF );
 }
 
 // Track buffer, tracks are grouped by layer+netcode
 std::map< int, std::vector<PCB_TRACK*>* > m_map_tracks;
};
 
 
class TEARDROP_MANAGER
{
 friend class TEARDROP_PARAMETERS;
 
public:
 enum TEARDROP_VARIANT
 {
 TD_TYPE_PADVIA, // Specify a teardrop on a pad via
 TD_TYPE_TRACKEND // specify a teardrop on a rond end of a wide track
 };
 
 TEARDROP_MANAGER( BOARD* aBoard, TOOL_MANAGER* aToolManager );
 
 void RemoveTeardrops( BOARD_COMMIT& aCommit, const std::vector<BOARD_ITEM*>* dirtyPadsAndVias,
 const std::set<PCB_TRACK*>* dirtyTracks );
 void UpdateTeardrops( BOARD_COMMIT& aCommit, const std::vector<BOARD_ITEM*>* dirtyPadsAndVias,
 const std::set<PCB_TRACK*>* dirtyTracks, bool aForceFullUpdate = false );
 
 void AddTeardropsOnTracks( BOARD_COMMIT& aCommit, const std::set<PCB_TRACK*>* aTracks,
 bool aForceFullUpdate = false );
 
 void DeleteTrackToTrackTeardrops( BOARD_COMMIT& aCommit );
 
 static int GetWidth( BOARD_ITEM* aItem );
 static bool IsRound( BOARD_ITEM* aItem );
 
private:
 bool areItemsInSameZone( BOARD_ITEM* aPadOrVia, PCB_TRACK* aTrack) const;
 
 void computeCurvedForRoundShape( const TEARDROP_PARAMETERS& aParams,
 std::vector<VECTOR2I>& aPoly, int aTrackHalfWidth,
 const VECTOR2D& aTrackDir, BOARD_ITEM* aOther,
 const VECTOR2I& aOtherPos, std::vector<VECTOR2I>& aPts ) const;
 
 
 void computeCurvedForRectShape( const TEARDROP_PARAMETERS& aParams,
 std::vector<VECTOR2I>& aPoly, int aTdWidth,
 int aTrackHalfWidth, std::vector<VECTOR2I>& aPts ) const;
 
 bool computeTeardropPolygon( const TEARDROP_PARAMETERS& aParams,
 std::vector<VECTOR2I>& aCorners, PCB_TRACK* aTrack,
 BOARD_ITEM* aOther, const VECTOR2I& aOtherPos ) const;
 bool computeAnchorPoints( const TEARDROP_PARAMETERS& aParams, PCB_LAYER_ID aLayer,
 BOARD_ITEM* aItem, const VECTOR2I& aPos,
 std::vector<VECTOR2I>& aPts ) const;
 
 PCB_TRACK* findTouchingTrack( EDA_ITEM_FLAGS& aMatchType, PCB_TRACK* aTrackRef,
 const VECTOR2I& aEndPoint ) const;
 
 ZONE* createTeardrop( TEARDROP_VARIANT aTeardropVariant,
 std::vector<VECTOR2I>& aPoints, PCB_TRACK* aTrack ) const;
 
 void setTeardropPriorities();
 
 bool findAnchorPointsOnTrack( const TEARDROP_PARAMETERS& aParams, VECTOR2I& aStartPoint,
 VECTOR2I& aEndPoint, PCB_TRACK*& aTrack, BOARD_ITEM* aOther,
 const VECTOR2I& aOtherPos, int* aEffectiveTeardropLen ) const;
 
 void buildTrackCaches();
 
private:
 int m_tolerance; // max dist between track end point and pad/via
 // center to see them connected to ut a teardrop
 BOARD* m_board;
 TOOL_MANAGER* m_toolManager;
 TEARDROP_PARAMETERS_LIST* m_prmsList; // the teardrop parameters list, from the board design settings
 
 DRC_RTREE m_tracksRTree;
 TRACK_BUFFER m_trackLookupList;
 std::vector<ZONE*> m_createdTdList; // list of new created teardrops
};
 
#endif // ifndef TEARDROP_H