KiCad PCB EDA Suite
graphics_cleaner.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2019 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #ifndef KICAD_GRAPHICS_CLEANER_H
25 #define KICAD_GRAPHICS_CLEANER_H
26 
27 #include <board.h>
28 
29 class FOOTPRINT;
30 class BOARD_COMMIT;
31 class CLEANUP_ITEM;
32 
33 
34 // Helper class used to clean tracks and vias
36 {
37 public:
38  GRAPHICS_CLEANER( DRAWINGS& aDrawings, FOOTPRINT* aParentFootprint, BOARD_COMMIT& aCommit );
39 
45  void CleanupBoard( bool aDryRun, std::vector<std::shared_ptr<CLEANUP_ITEM> >* aItemsList,
46  bool aMergeRects, bool aDeleteRedundant );
47 
48 private:
49  bool isNullSegment( PCB_SHAPE* aShape );
50  bool areEquivalent( PCB_SHAPE* aShape1, PCB_SHAPE* aShape2 );
51 
52  void cleanupSegments();
53  void mergeRects();
54 
55 private:
56  DRAWINGS& m_drawings;
57  FOOTPRINT* m_parentFootprint; // nullptr if not in Footprint Editor
59  bool m_dryRun;
60  std::vector<std::shared_ptr<CLEANUP_ITEM> >* m_itemsList;
61 };
62 
63 
64 #endif //KICAD_GRAPHICS_CLEANER_H
bool isNullSegment(PCB_SHAPE *aShape)
BOARD_COMMIT & m_commit
std::vector< std::shared_ptr< CLEANUP_ITEM > > * m_itemsList
GRAPHICS_CLEANER(DRAWINGS &aDrawings, FOOTPRINT *aParentFootprint, BOARD_COMMIT &aCommit)
void CleanupBoard(bool aDryRun, std::vector< std::shared_ptr< CLEANUP_ITEM > > *aItemsList, bool aMergeRects, bool aDeleteRedundant)
the cleanup function.
bool areEquivalent(PCB_SHAPE *aShape1, PCB_SHAPE *aShape2)
DRAWINGS & m_drawings
FOOTPRINT * m_parentFootprint