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
29
class
FOOTPRINT
;
30
class
BOARD_COMMIT
;
31
class
CLEANUP_ITEM
;
32
class
TOOL_MANAGER
;
33
34
35
// Helper class used to clean tracks and vias
36
class
GRAPHICS_CLEANER
37
{
38
public
:
39
GRAPHICS_CLEANER
(
const
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
53
private
:
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
62
private
:
63
const
DRAWINGS&
m_drawings
;
64
FOOTPRINT
*
m_parentFootprint
;
// nullptr if not in Footprint Editor
65
BOARD_COMMIT
&
m_commit
;
66
TOOL_MANAGER
*
m_toolMgr
;
67
bool
m_dryRun
;
68
int
m_epsilon
;
69
int
m_outlinesTolerance
;
70
71
std::vector<std::shared_ptr<CLEANUP_ITEM>>*
m_itemsList
;
72
};
73
74
75
#endif
//KICAD_GRAPHICS_CLEANER_H
board.h
BOARD_COMMIT
Definition:
board_commit.h:47
CLEANUP_ITEM
Definition:
cleanup_item.h:50
FOOTPRINT
Definition:
footprint.h:119
GRAPHICS_CLEANER
Definition:
graphics_cleaner.h:37
GRAPHICS_CLEANER::m_toolMgr
TOOL_MANAGER * m_toolMgr
Definition:
graphics_cleaner.h:66
GRAPHICS_CLEANER::m_epsilon
int m_epsilon
Definition:
graphics_cleaner.h:68
GRAPHICS_CLEANER::m_dryRun
bool m_dryRun
Definition:
graphics_cleaner.h:67
GRAPHICS_CLEANER::m_commit
BOARD_COMMIT & m_commit
Definition:
graphics_cleaner.h:65
GRAPHICS_CLEANER::m_outlinesTolerance
int m_outlinesTolerance
Definition:
graphics_cleaner.h:69
GRAPHICS_CLEANER::fixBoardOutlines
void fixBoardOutlines()
Definition:
graphics_cleaner.cpp:209
GRAPHICS_CLEANER::m_itemsList
std::vector< std::shared_ptr< CLEANUP_ITEM > > * m_itemsList
Definition:
graphics_cleaner.h:71
GRAPHICS_CLEANER::mergeRects
void mergeRects()
Definition:
graphics_cleaner.cpp:239
GRAPHICS_CLEANER::m_parentFootprint
FOOTPRINT * m_parentFootprint
Definition:
graphics_cleaner.h:64
GRAPHICS_CLEANER::mergePads
void mergePads()
Definition:
graphics_cleaner.cpp:383
GRAPHICS_CLEANER::CleanupBoard
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.
Definition:
graphics_cleaner.cpp:53
GRAPHICS_CLEANER::m_drawings
const DRAWINGS & m_drawings
Definition:
graphics_cleaner.h:63
GRAPHICS_CLEANER::isNullShape
bool isNullShape(PCB_SHAPE *aShape)
Definition:
graphics_cleaner.cpp:92
GRAPHICS_CLEANER::cleanupShapes
void cleanupShapes()
Definition:
graphics_cleaner.cpp:164
GRAPHICS_CLEANER::areEquivalent
bool areEquivalent(PCB_SHAPE *aShape1, PCB_SHAPE *aShape2)
Definition:
graphics_cleaner.cpp:124
PCB_SHAPE
Definition:
pcb_shape.h:38
TOOL_MANAGER
Master controller class:
Definition:
tool_manager.h:62
src
pcbnew
graphics_cleaner.h
Generated on Mon Nov 11 2024 00:04:43 for KiCad PCB EDA Suite by
1.9.6