116 lines
4.5 KiB
C++
116 lines
4.5 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 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 KICAD_TRACKS_CLEANER_H
|
|
#define KICAD_TRACKS_CLEANER_H
|
|
|
|
#include <pcb_track.h>
|
|
#include <board.h>
|
|
|
|
class BOARD_COMMIT;
|
|
class CLEANUP_ITEM;
|
|
class REPORTER;
|
|
|
|
|
|
// Helper class used to clean tracks and vias
|
|
class TRACKS_CLEANER
|
|
{
|
|
public:
|
|
TRACKS_CLEANER( BOARD* aPcb, BOARD_COMMIT& aCommit );
|
|
|
|
/**
|
|
* the cleanup function.
|
|
* @param aDryRun = true to build changes list, false to modify the board
|
|
* @param aItemsList = list of modified items
|
|
* @param aCleanVias = true to remove superimposed vias
|
|
* @param aRemoveMisConnected = true to remove segments connecting 2 different nets
|
|
* (short circuits)
|
|
* @param aMergeSegments = true to merge collinear segmenst and remove 0 len segm
|
|
* @param aDeleteUnconnected = true to remove dangling tracks
|
|
* @param aDeleteTracksinPad = true to remove tracks fully inside pads
|
|
* @param aDeleteDanglingVias = true to remove a via that is only connected to a single layer
|
|
* @param aReporter is a REPORTER to print activity and info
|
|
*/
|
|
void CleanupBoard( bool aDryRun, std::vector<std::shared_ptr<CLEANUP_ITEM> >* aItemsList,
|
|
bool aCleanVias, bool aRemoveMisConnected, bool aMergeSegments,
|
|
bool aDeleteUnconnected, bool aDeleteTracksinPad, bool aDeleteDanglingVias,
|
|
REPORTER* aReporter = nullptr );
|
|
|
|
private:
|
|
/*
|
|
* Removes track segments which are connected to more than one net (short circuits).
|
|
*/
|
|
void removeShortingTrackSegments();
|
|
|
|
/**
|
|
* Removes tracks or vias only connected on one end
|
|
* @param aTrack if true, clean dangling tracks
|
|
* @param aVia if true, clean dangling vias
|
|
* @return true if any items were deleted
|
|
*/
|
|
bool deleteDanglingTracks( bool aTrack, bool aVia );
|
|
|
|
void deleteTracksInPads();
|
|
|
|
/**
|
|
* Geometry-based cleanup: duplicate items, null items, colinear items.
|
|
*/
|
|
void cleanup( bool aDeleteDuplicateVias, bool aDeleteNullSegments,
|
|
bool aDeleteDuplicateSegments, bool aMergeSegments );
|
|
|
|
/**
|
|
* helper function
|
|
* merge aTrackRef and aCandidate, when possible,
|
|
* i.e. when they are colinear, same width, and obviously same layer
|
|
* @return true if the segments are merged, false if not
|
|
* @param aSeg1 is the reference
|
|
* @param aSeg2 is the candidate, and after merging, the removed segment
|
|
*/
|
|
bool mergeCollinearSegments( PCB_TRACK* aSeg1, PCB_TRACK* aSeg2 );
|
|
|
|
/**
|
|
* @return true if a track end position is a node, i.e. a end connected
|
|
* to more than one item.
|
|
* @param aTrack is the track to test.
|
|
* @param aTstStart = true ot test the start point of the track or false for end point
|
|
*/
|
|
bool testTrackEndpointIsNode( PCB_TRACK* aTrack, bool aTstStart );
|
|
|
|
void removeItems( std::set<BOARD_ITEM*>& aItems );
|
|
|
|
const std::vector<BOARD_CONNECTED_ITEM*>& getConnectedItems( PCB_TRACK* aTrack );
|
|
|
|
private:
|
|
BOARD* m_brd;
|
|
BOARD_COMMIT& m_commit; // caller owns
|
|
bool m_dryRun;
|
|
std::vector<std::shared_ptr<CLEANUP_ITEM>>* m_itemsList; // caller owns
|
|
REPORTER* m_reporter;
|
|
|
|
// Cache connections. O(n^2) is awful, but it beats O(2n^3).
|
|
std::map<PCB_TRACK*, std::vector<BOARD_CONNECTED_ITEM*>> m_connectedItemsCache;
|
|
};
|
|
|
|
|
|
#endif //KICAD_TRACKS_CLEANER_H
|