KiCad PCB EDA Suite
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
POLYGON_BOOLEAN_ROUTINE Class Referenceabstract

A routine that modifies polygons using boolean operations. More...

#include <item_modification_routine.h>

Inheritance diagram for POLYGON_BOOLEAN_ROUTINE:
ITEM_MODIFICATION_ROUTINE POLYGON_INTERSECT_ROUTINE POLYGON_MERGE_ROUTINE POLYGON_SUBTRACT_ROUTINE

Public Member Functions

 POLYGON_BOOLEAN_ROUTINE (BOARD_ITEM *aBoard, CHANGE_HANDLER &aHandler)
 
void ProcessShape (PCB_SHAPE &aPcbShape)
 
void Finalize ()
 Clear up any outstanding work.
 
virtual std::optional< wxString > GetStatusMessage () const =0
 Get a status message to show when the routine is complete.
 
unsigned GetSuccesses () const
 
unsigned GetFailures () const
 
virtual wxString GetCommitDescription () const =0
 

Protected Member Functions

SHAPE_POLY_SET & GetWorkingPolygons ()
 
virtual bool ProcessSubsequentPolygon (const SHAPE_POLY_SET &aPolygon)=0
 
BOARD_ITEM * GetBoard () const
 The BOARD used when creating new shapes.
 
void AddSuccess ()
 Mark that one of the actions succeeded.
 
void AddFailure ()
 Mark that one of the actions failed.
 
bool ModifyLineOrDeleteIfZeroLength (PCB_SHAPE &aItem, const std::optional< SEG > &aSeg)
 Helper function useful for multiple tools: modify a line or delete it if it has zero length.
 
CHANGE_HANDLER & GetHandler ()
 Access the handler for making changes to the board.
 

Private Attributes

SHAPE_POLY_SET m_workingPolygons
 This can be disjoint, which will be fixed at the end.
 
bool m_firstPolygon = true
 
int m_width = 0
 
PCB_LAYER_ID m_layer = PCB_LAYER_ID::UNDEFINED_LAYER
 
FILL_T m_fillMode = FILL_T::NO_FILL
 
BOARD_ITEM * m_board
 
CHANGE_HANDLER & m_handler
 
unsigned m_numSuccesses
 
unsigned m_numFailures
 

Detailed Description

A routine that modifies polygons using boolean operations.

Definition at line 338 of file item_modification_routine.h.

Constructor & Destructor Documentation

◆ POLYGON_BOOLEAN_ROUTINE()

POLYGON_BOOLEAN_ROUTINE::POLYGON_BOOLEAN_ROUTINE ( BOARD_ITEM *  aBoard,
CHANGE_HANDLER &  aHandler 
)
inline

Definition at line 341 of file item_modification_routine.h.

Member Function Documentation

◆ AddFailure()

void ITEM_MODIFICATION_ROUTINE::AddFailure ( )
inlineprotectedinherited

Mark that one of the actions failed.

Definition at line 185 of file item_modification_routine.h.

References ITEM_MODIFICATION_ROUTINE::m_numFailures.

Referenced by LINE_FILLET_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), DOGBONE_CORNER_ROUTINE::ProcessLinePair(), and ProcessShape().

◆ AddSuccess()

void ITEM_MODIFICATION_ROUTINE::AddSuccess ( )
inlineprotectedinherited

Mark that one of the actions succeeded.

Definition at line 180 of file item_modification_routine.h.

References ITEM_MODIFICATION_ROUTINE::m_numSuccesses.

Referenced by OUTSET_ROUTINE::ProcessItem(), LINE_FILLET_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), LINE_EXTENSION_ROUTINE::ProcessLinePair(), DOGBONE_CORNER_ROUTINE::ProcessLinePair(), and ProcessShape().

◆ Finalize()

void POLYGON_BOOLEAN_ROUTINE::Finalize ( )

Clear up any outstanding work.

Definition at line 520 of file item_modification_routine.cpp.

References ITEM_MODIFICATION_ROUTINE::CHANGE_HANDLER::AddNewItem(), ITEM_MODIFICATION_ROUTINE::GetBoard(), ITEM_MODIFICATION_ROUTINE::GetHandler(), m_fillMode, m_firstPolygon, m_layer, m_width, m_workingPolygons, SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), and SHAPE_LINE_CHAIN::SetWidth().

◆ GetBoard()

BOARD_ITEM * ITEM_MODIFICATION_ROUTINE::GetBoard ( ) const
inlineprotectedinherited

The BOARD used when creating new shapes.

Definition at line 175 of file item_modification_routine.h.

References ITEM_MODIFICATION_ROUTINE::m_board.

Referenced by Finalize(), OUTSET_ROUTINE::ProcessItem(), LINE_FILLET_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), and DOGBONE_CORNER_ROUTINE::ProcessLinePair().

◆ GetCommitDescription()

virtual wxString ITEM_MODIFICATION_ROUTINE::GetCommitDescription ( ) const
pure virtualinherited

Implemented in LINE_FILLET_ROUTINE, LINE_CHAMFER_ROUTINE, LINE_EXTENSION_ROUTINE, DOGBONE_CORNER_ROUTINE, POLYGON_MERGE_ROUTINE, POLYGON_SUBTRACT_ROUTINE, POLYGON_INTERSECT_ROUTINE, and OUTSET_ROUTINE.

◆ GetFailures()

unsigned ITEM_MODIFICATION_ROUTINE::GetFailures ( ) const
inlineinherited

Definition at line 167 of file item_modification_routine.h.

References ITEM_MODIFICATION_ROUTINE::m_numFailures.

Referenced by OUTSET_ROUTINE::GetStatusMessage(), POLYGON_MERGE_ROUTINE::GetStatusMessage(), POLYGON_SUBTRACT_ROUTINE::GetStatusMessage(), POLYGON_INTERSECT_ROUTINE::GetStatusMessage(), LINE_FILLET_ROUTINE::GetStatusMessage(), LINE_CHAMFER_ROUTINE::GetStatusMessage(), LINE_EXTENSION_ROUTINE::GetStatusMessage(), and DOGBONE_CORNER_ROUTINE::GetStatusMessage().

◆ GetHandler()

CHANGE_HANDLER & ITEM_MODIFICATION_ROUTINE::GetHandler ( )
inlineprotectedinherited

Access the handler for making changes to the board.

Definition at line 199 of file item_modification_routine.h.

References ITEM_MODIFICATION_ROUTINE::m_handler.

Referenced by Finalize(), ITEM_MODIFICATION_ROUTINE::ModifyLineOrDeleteIfZeroLength(), OUTSET_ROUTINE::ProcessItem(), LINE_FILLET_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), LINE_EXTENSION_ROUTINE::ProcessLinePair(), DOGBONE_CORNER_ROUTINE::ProcessLinePair(), and ProcessShape().

◆ GetStatusMessage()

virtual std::optional< wxString > POLYGON_BOOLEAN_ROUTINE::GetStatusMessage ( ) const
pure virtual

Get a status message to show when the routine is complete.

Usually this will be an error or nothing.

Implemented in POLYGON_MERGE_ROUTINE, POLYGON_SUBTRACT_ROUTINE, and POLYGON_INTERSECT_ROUTINE.

◆ GetSuccesses()

unsigned ITEM_MODIFICATION_ROUTINE::GetSuccesses ( ) const
inlineinherited

Definition at line 165 of file item_modification_routine.h.

References ITEM_MODIFICATION_ROUTINE::m_numSuccesses.

Referenced by OUTSET_ROUTINE::GetStatusMessage(), POLYGON_MERGE_ROUTINE::GetStatusMessage(), POLYGON_SUBTRACT_ROUTINE::GetStatusMessage(), POLYGON_INTERSECT_ROUTINE::GetStatusMessage(), LINE_FILLET_ROUTINE::GetStatusMessage(), LINE_CHAMFER_ROUTINE::GetStatusMessage(), LINE_EXTENSION_ROUTINE::GetStatusMessage(), and DOGBONE_CORNER_ROUTINE::GetStatusMessage().

◆ GetWorkingPolygons()

SHAPE_POLY_SET & POLYGON_BOOLEAN_ROUTINE::GetWorkingPolygons ( )
inlineprotected

Definition at line 361 of file item_modification_routine.h.

References m_workingPolygons.

Referenced by POLYGON_MERGE_ROUTINE::ProcessSubsequentPolygon(), POLYGON_SUBTRACT_ROUTINE::ProcessSubsequentPolygon(), and POLYGON_INTERSECT_ROUTINE::ProcessSubsequentPolygon().

◆ ModifyLineOrDeleteIfZeroLength()

bool ITEM_MODIFICATION_ROUTINE::ModifyLineOrDeleteIfZeroLength ( PCB_SHAPE &  aItem,
const std::optional< SEG > &  aSeg 
)
protectedinherited

Helper function useful for multiple tools: modify a line or delete it if it has zero length.

Parameters
aItemthe line to modify
aSegthe new line geometry

Definition at line 78 of file item_modification_routine.cpp.

References ITEM_MODIFICATION_ROUTINE::CHANGE_HANDLER::DeleteItem(), ITEM_MODIFICATION_ROUTINE::GetHandler(), EDA_SHAPE::GetShape(), ITEM_MODIFICATION_ROUTINE::CHANGE_HANDLER::MarkItemModified(), EDA_SHAPE::SetEnd(), and EDA_SHAPE::SetStart().

Referenced by LINE_FILLET_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), and DOGBONE_CORNER_ROUTINE::ProcessLinePair().

◆ ProcessShape()

void POLYGON_BOOLEAN_ROUTINE::ProcessShape ( PCB_SHAPE &  aPcbShape)

Definition at line 455 of file item_modification_routine.cpp.

References ITEM_MODIFICATION_ROUTINE::AddFailure(), ITEM_MODIFICATION_ROUTINE::AddSuccess(), SHAPE_POLY_SET::Append(), ITEM_MODIFICATION_ROUTINE::CHANGE_HANDLER::DeleteItem(), EDA_SHAPE::GetFillMode(), ITEM_MODIFICATION_ROUTINE::GetHandler(), PCB_SHAPE::GetLayer(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetShape(), PCB_SHAPE::GetWidth(), m_fillMode, m_firstPolygon, m_layer, m_width, m_workingPolygons, SHAPE_POLY_SET::NewOutline(), and ProcessSubsequentPolygon().

◆ ProcessSubsequentPolygon()

virtual bool POLYGON_BOOLEAN_ROUTINE::ProcessSubsequentPolygon ( const SHAPE_POLY_SET &  aPolygon)
protectedpure virtual

Implemented in POLYGON_MERGE_ROUTINE, POLYGON_SUBTRACT_ROUTINE, and POLYGON_INTERSECT_ROUTINE.

Referenced by ProcessShape().

Member Data Documentation

◆ m_board

BOARD_ITEM* ITEM_MODIFICATION_ROUTINE::m_board
privateinherited

Definition at line 202 of file item_modification_routine.h.

Referenced by ITEM_MODIFICATION_ROUTINE::GetBoard().

◆ m_fillMode

FILL_T POLYGON_BOOLEAN_ROUTINE::m_fillMode = FILL_T::NO_FILL
private

Definition at line 372 of file item_modification_routine.h.

Referenced by Finalize(), and ProcessShape().

◆ m_firstPolygon

bool POLYGON_BOOLEAN_ROUTINE::m_firstPolygon = true
private

Definition at line 369 of file item_modification_routine.h.

Referenced by Finalize(), and ProcessShape().

◆ m_handler

CHANGE_HANDLER& ITEM_MODIFICATION_ROUTINE::m_handler
privateinherited

Definition at line 203 of file item_modification_routine.h.

Referenced by ITEM_MODIFICATION_ROUTINE::GetHandler().

◆ m_layer

PCB_LAYER_ID POLYGON_BOOLEAN_ROUTINE::m_layer = PCB_LAYER_ID::UNDEFINED_LAYER
private

Definition at line 371 of file item_modification_routine.h.

Referenced by Finalize(), and ProcessShape().

◆ m_numFailures

unsigned ITEM_MODIFICATION_ROUTINE::m_numFailures
privateinherited

Definition at line 206 of file item_modification_routine.h.

Referenced by ITEM_MODIFICATION_ROUTINE::AddFailure(), and ITEM_MODIFICATION_ROUTINE::GetFailures().

◆ m_numSuccesses

unsigned ITEM_MODIFICATION_ROUTINE::m_numSuccesses
privateinherited

Definition at line 205 of file item_modification_routine.h.

Referenced by ITEM_MODIFICATION_ROUTINE::AddSuccess(), and ITEM_MODIFICATION_ROUTINE::GetSuccesses().

◆ m_width

int POLYGON_BOOLEAN_ROUTINE::m_width = 0
private

Definition at line 370 of file item_modification_routine.h.

Referenced by Finalize(), and ProcessShape().

◆ m_workingPolygons

SHAPE_POLY_SET POLYGON_BOOLEAN_ROUTINE::m_workingPolygons
private

This can be disjoint, which will be fixed at the end.

Definition at line 367 of file item_modification_routine.h.

Referenced by Finalize(), GetWorkingPolygons(), and ProcessShape().

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