KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
GRAPHICS_CLEANER Class Reference

#include <graphics_cleaner.h>

Public Member Functions

 GRAPHICS_CLEANER (const DRAWINGS &aDrawings, FOOTPRINT *aParentFootprint, BOARD_COMMIT &aCommit, TOOL_MANAGER *aToolManager)
 
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.
 

Private Member Functions

bool isNullShape (PCB_SHAPE *aShape)
 
bool areEquivalent (PCB_SHAPE *aShape1, PCB_SHAPE *aShape2)
 
void cleanupShapes ()
 
void fixBoardOutlines ()
 
void mergeRects ()
 
void mergePads ()
 

Private Attributes

const DRAWINGS & m_drawings
 
FOOTPRINT * m_parentFootprint
 
BOARD_COMMIT & m_commit
 
TOOL_MANAGER * m_toolMgr
 
bool m_dryRun
 
int m_epsilon
 
int m_maxError
 
int m_outlinesTolerance
 
std::vector< std::shared_ptr< CLEANUP_ITEM > > * m_itemsList
 

Detailed Description

Definition at line 32 of file graphics_cleaner.h.

Constructor & Destructor Documentation

◆ GRAPHICS_CLEANER()

GRAPHICS_CLEANER::GRAPHICS_CLEANER ( const DRAWINGS & aDrawings,
FOOTPRINT * aParentFootprint,
BOARD_COMMIT & aCommit,
TOOL_MANAGER * aToolManager )

Definition at line 35 of file graphics_cleaner.cpp.

References ARC_HIGH_DEF, m_commit, m_drawings, m_dryRun, m_epsilon, m_itemsList, m_maxError, m_outlinesTolerance, m_parentFootprint, and m_toolMgr.

Member Function Documentation

◆ areEquivalent()

bool GRAPHICS_CLEANER::areEquivalent ( PCB_SHAPE * aShape1,
PCB_SHAPE * aShape2 )
private

Definition at line 125 of file graphics_cleaner.cpp.

References ARC, BEZIER, CIRCLE, ELLIPSE, ELLIPSE_ARC, equivalent(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), PCB_SHAPE::GetCenter(), EDA_SHAPE::GetEllipseCenter(), EDA_SHAPE::GetEllipseEndAngle(), EDA_SHAPE::GetEllipseMajorRadius(), EDA_SHAPE::GetEllipseMinorRadius(), EDA_SHAPE::GetEllipseRotation(), EDA_SHAPE::GetEllipseStartAngle(), EDA_SHAPE::GetEnd(), PCB_SHAPE::GetLayer(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), PCB_SHAPE::GetWidth(), m_epsilon, POLY, RECTANGLE, SEGMENT, and EDA_SHAPE::SHAPE_T_asString().

Referenced by cleanupShapes().

◆ CleanupBoard()

void GRAPHICS_CLEANER::CleanupBoard ( bool aDryRun,
std::vector< std::shared_ptr< CLEANUP_ITEM > > * aItemsList,
bool aMergeRects,
bool aDeleteRedundant,
bool aMergePads,
bool aFixBoardOutlines,
int aTolerance )

the cleanup function.

Parameters
aDryRunperforms a dry run clean up if true.
aItemsListis the list of items cleaned up.
aMergeRects= merge for segments forming a rectangle into a rect
aDeleteRedundant= true to delete null graphics and duplicated graphics
aMergePads= true to apply Pad Editor's merge algorithm to all pads in footprint (it is assumed this will only be run on FPEditor boards)
aFixBoardOutlinesfixes board outlines one clean up if true.
aTolerance

Definition at line 50 of file graphics_cleaner.cpp.

References cleanupShapes(), fixBoardOutlines(), IS_DELETED, m_commit, m_drawings, m_dryRun, m_epsilon, m_itemsList, m_maxError, m_outlinesTolerance, mergePads(), and mergeRects().

Referenced by DIALOG_CLEANUP_GRAPHICS::doCleanup().

◆ cleanupShapes()

void GRAPHICS_CLEANER::cleanupShapes ( )
private

Definition at line 175 of file graphics_cleaner.cpp.

References areEquivalent(), CLEANUP_DUPLICATE_GRAPHIC, CLEANUP_NULL_GRAPHIC, EDA_ITEM::HasFlag(), IS_DELETED, isNullShape(), m_commit, m_drawings, m_dryRun, m_itemsList, and EDA_ITEM::SetFlags().

Referenced by CleanupBoard().

◆ fixBoardOutlines()

void GRAPHICS_CLEANER::fixBoardOutlines ( )
private

Definition at line 220 of file graphics_cleaner.cpp.

References ConnectBoardShapes(), Edge_Cuts, PCB_SHAPE::IsOnLayer(), m_commit, m_drawings, m_dryRun, and m_outlinesTolerance.

Referenced by CleanupBoard().

◆ isNullShape()

bool GRAPHICS_CLEANER::isNullShape ( PCB_SHAPE * aShape)
private

Definition at line 90 of file graphics_cleaner.cpp.

References ARC, BEZIER, CIRCLE, ELLIPSE, ELLIPSE_ARC, equivalent(), EDA_SHAPE::GetBezierPoints(), EDA_SHAPE::GetEllipseMajorRadius(), EDA_SHAPE::GetEllipseMinorRadius(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetPointCount(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), m_epsilon, m_maxError, POLY, EDA_SHAPE::RebuildBezierToSegmentsPointsList(), RECTANGLE, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by cleanupShapes(), and mergeRects().

◆ mergePads()

void GRAPHICS_CLEANER::mergePads ( )
private

Definition at line 390 of file graphics_cleaner.cpp.

References CLEANUP_MERGE_PAD, m_commit, m_dryRun, m_itemsList, m_parentFootprint, m_toolMgr, pad, and PAD_TOOL::RecombinePad().

Referenced by CleanupBoard().

◆ mergeRects()

void GRAPHICS_CLEANER::mergeRects ( )
private

Definition at line 246 of file graphics_cleaner.cpp.

References CLEANUP_LINES_TO_RECT, end, EDA_SHAPE::GetEnd(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), IS_DELETED, isNullShape(), left, m_commit, m_drawings, m_dryRun, m_itemsList, m_parentFootprint, RECTANGLE, right, SEGMENT, PCB_SHAPE::SetEnd(), EDA_SHAPE::SetFilled(), PCB_SHAPE::SetLayer(), PCB_SHAPE::SetShape(), PCB_SHAPE::SetStart(), PCB_SHAPE::SetStroke(), top(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by CleanupBoard().

Member Data Documentation

◆ m_commit

BOARD_COMMIT& GRAPHICS_CLEANER::m_commit
private

Definition at line 66 of file graphics_cleaner.h.

Referenced by CleanupBoard(), cleanupShapes(), fixBoardOutlines(), GRAPHICS_CLEANER(), mergePads(), and mergeRects().

◆ m_drawings

const DRAWINGS& GRAPHICS_CLEANER::m_drawings
private

Definition at line 64 of file graphics_cleaner.h.

Referenced by CleanupBoard(), cleanupShapes(), fixBoardOutlines(), GRAPHICS_CLEANER(), and mergeRects().

◆ m_dryRun

bool GRAPHICS_CLEANER::m_dryRun
private

Definition at line 68 of file graphics_cleaner.h.

Referenced by CleanupBoard(), cleanupShapes(), fixBoardOutlines(), GRAPHICS_CLEANER(), mergePads(), and mergeRects().

◆ m_epsilon

int GRAPHICS_CLEANER::m_epsilon
private

Definition at line 69 of file graphics_cleaner.h.

Referenced by areEquivalent(), CleanupBoard(), GRAPHICS_CLEANER(), and isNullShape().

◆ m_itemsList

std::vector<std::shared_ptr<CLEANUP_ITEM> >* GRAPHICS_CLEANER::m_itemsList
private

Definition at line 73 of file graphics_cleaner.h.

Referenced by CleanupBoard(), cleanupShapes(), GRAPHICS_CLEANER(), mergePads(), and mergeRects().

◆ m_maxError

int GRAPHICS_CLEANER::m_maxError
private

Definition at line 70 of file graphics_cleaner.h.

Referenced by CleanupBoard(), GRAPHICS_CLEANER(), and isNullShape().

◆ m_outlinesTolerance

int GRAPHICS_CLEANER::m_outlinesTolerance
private

Definition at line 71 of file graphics_cleaner.h.

Referenced by CleanupBoard(), fixBoardOutlines(), and GRAPHICS_CLEANER().

◆ m_parentFootprint

FOOTPRINT* GRAPHICS_CLEANER::m_parentFootprint
private

Definition at line 65 of file graphics_cleaner.h.

Referenced by GRAPHICS_CLEANER(), mergePads(), and mergeRects().

◆ m_toolMgr

TOOL_MANAGER* GRAPHICS_CLEANER::m_toolMgr
private

Definition at line 67 of file graphics_cleaner.h.

Referenced by GRAPHICS_CLEANER(), and mergePads().

The documentation for this class was generated from the following files: