KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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-2022 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
29class FOOTPRINT;
30class BOARD_COMMIT;
31class CLEANUP_ITEM;
32class TOOL_MANAGER;
33
34
35// Helper class used to clean tracks and vias
37{
38public:
39 GRAPHICS_CLEANER( DRAWINGS& aDrawings, FOOTPRINT* aParentFootprint, BOARD_COMMIT& aCommit,
40 TOOL_MANAGER* aToolManager );
41
49 void CleanupBoard( bool aDryRun, std::vector<std::shared_ptr<CLEANUP_ITEM>>* aItemsList,
50 bool aMergeRects, bool aDeleteRedundant, bool aMergePads,
51 bool aFixBoardOutlines, int aTolerance );
52
53private:
54 bool isNullShape( PCB_SHAPE* aShape );
55 bool areEquivalent( PCB_SHAPE* aShape1, PCB_SHAPE* aShape2 );
56
57 void cleanupShapes();
58 void fixBoardOutlines();
59 void mergeRects();
60 void mergePads();
61
62private:
63 DRAWINGS& m_drawings;
64 FOOTPRINT* m_parentFootprint; // nullptr if not in Footprint Editor
70
71 std::vector<std::shared_ptr<CLEANUP_ITEM>>* m_itemsList;
72};
73
74
75#endif //KICAD_GRAPHICS_CLEANER_H
TOOL_MANAGER * m_toolMgr
DRAWINGS & m_drawings
BOARD_COMMIT & m_commit
std::vector< std::shared_ptr< CLEANUP_ITEM > > * m_itemsList
FOOTPRINT * m_parentFootprint
void CleanupBoard(bool aDryRun, std::vector< std::shared_ptr< CLEANUP_ITEM > > *aItemsList, bool aMergeRects, bool aDeleteRedundant, bool aMergePads, bool aFixBoardOutlines, int aTolerance)
the cleanup function.
bool isNullShape(PCB_SHAPE *aShape)
bool areEquivalent(PCB_SHAPE *aShape1, PCB_SHAPE *aShape2)
Master controller class:
Definition: tool_manager.h:57