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

#include <item_modification_routine.h>

Inheritance diagram for POLYGON_SUBTRACT_ROUTINE:
POLYGON_BOOLEAN_ROUTINE ITEM_MODIFICATION_ROUTINE

Public Member Functions

 POLYGON_SUBTRACT_ROUTINE (BOARD_ITEM *aBoard, CHANGE_HANDLER &aHandler)
 
bool IsCommutative () const override
 False if the order of the polygons matters.
 
wxString GetCommitDescription () const override
 
std::optional< wxString > GetStatusMessage () const override
 Get a status message to show when the routine is complete.
 
void ProcessShape (PCB_SHAPE &aPcbShape)
 
void Finalize ()
 Clear up any outstanding work.
 
unsigned GetSuccesses () const
 
unsigned GetFailures () const
 

Protected Member Functions

SHAPE_POLY_SET & GetWorkingPolygons ()
 
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 Member Functions

bool ProcessSubsequentPolygon (const SHAPE_POLY_SET &aPolygon) override
 

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

Definition at line 403 of file item_modification_routine.h.

Constructor & Destructor Documentation

◆ POLYGON_SUBTRACT_ROUTINE()

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

Definition at line 406 of file item_modification_routine.h.

References POLYGON_BOOLEAN_ROUTINE::POLYGON_BOOLEAN_ROUTINE().

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 m_numFailures.

Referenced by DOGBONE_CORNER_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), LINE_FILLET_ROUTINE::ProcessLinePair(), and POLYGON_BOOLEAN_ROUTINE::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 m_numSuccesses.

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

◆ Finalize()

void POLYGON_BOOLEAN_ROUTINE::Finalize ( )
inherited

Clear up any outstanding work.

Definition at line 607 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, and POLY.

◆ 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 m_board.

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

◆ GetCommitDescription()

wxString POLYGON_SUBTRACT_ROUTINE::GetCommitDescription ( ) const
overridevirtual

Implements ITEM_MODIFICATION_ROUTINE.

Definition at line 669 of file item_modification_routine.cpp.

References _.

◆ GetFailures()

unsigned ITEM_MODIFICATION_ROUTINE::GetFailures ( ) const
inlineinherited

Definition at line 167 of file item_modification_routine.h.

References m_numFailures.

Referenced by DOGBONE_CORNER_ROUTINE::GetStatusMessage(), LINE_CHAMFER_ROUTINE::GetStatusMessage(), LINE_EXTENSION_ROUTINE::GetStatusMessage(), LINE_FILLET_ROUTINE::GetStatusMessage(), OUTSET_ROUTINE::GetStatusMessage(), POLYGON_INTERSECT_ROUTINE::GetStatusMessage(), POLYGON_MERGE_ROUTINE::GetStatusMessage(), and POLYGON_SUBTRACT_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 m_handler.

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

◆ GetStatusMessage()

std::optional< wxString > POLYGON_SUBTRACT_ROUTINE::GetStatusMessage ( ) const
overridevirtual

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

Usually this will be an error or nothing.

Implements POLYGON_BOOLEAN_ROUTINE.

Definition at line 675 of file item_modification_routine.cpp.

References _, ITEM_MODIFICATION_ROUTINE::GetFailures(), and ITEM_MODIFICATION_ROUTINE::GetSuccesses().

◆ GetSuccesses()

unsigned ITEM_MODIFICATION_ROUTINE::GetSuccesses ( ) const
inlineinherited

Definition at line 165 of file item_modification_routine.h.

References m_numSuccesses.

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

◆ GetWorkingPolygons()

SHAPE_POLY_SET & POLYGON_BOOLEAN_ROUTINE::GetWorkingPolygons ( )
inlineprotectedinherited

Definition at line 371 of file item_modification_routine.h.

References m_workingPolygons.

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

◆ IsCommutative()

bool POLYGON_SUBTRACT_ROUTINE::IsCommutative ( ) const
inlineoverridevirtual

False if the order of the polygons matters.

Implements POLYGON_BOOLEAN_ROUTINE.

Definition at line 411 of file item_modification_routine.h.

◆ 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 81 of file item_modification_routine.cpp.

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

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

◆ ProcessShape()

void POLYGON_BOOLEAN_ROUTINE::ProcessShape ( PCB_SHAPE & aPcbShape)
inherited

Definition at line 529 of file item_modification_routine.cpp.

References ITEM_MODIFICATION_ROUTINE::AddFailure(), ITEM_MODIFICATION_ROUTINE::AddSuccess(), CIRCLE, ITEM_MODIFICATION_ROUTINE::CHANGE_HANDLER::DeleteItem(), FULL_CIRCLE, PCB_SHAPE::GetCenter(), EDA_SHAPE::GetFillMode(), ITEM_MODIFICATION_ROUTINE::GetHandler(), PCB_SHAPE::GetLayer(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetShape(), PCB_SHAPE::GetWidth(), m_fillMode, m_firstPolygon, m_layer, m_width, m_workingPolygons, POLY, ProcessSubsequentPolygon(), and RECTANGLE.

◆ ProcessSubsequentPolygon()

bool POLYGON_SUBTRACT_ROUTINE::ProcessSubsequentPolygon ( const SHAPE_POLY_SET & aPolygon)
overrideprivatevirtual

Implements POLYGON_BOOLEAN_ROUTINE.

Definition at line 686 of file item_modification_routine.cpp.

References SHAPE_POLY_SET::BooleanSubtract(), SHAPE_POLY_SET::ClearArcs(), and POLYGON_BOOLEAN_ROUTINE::GetWorkingPolygons().

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 GetBoard(), and ITEM_MODIFICATION_ROUTINE().

◆ m_fillMode

FILL_T POLYGON_BOOLEAN_ROUTINE::m_fillMode = FILL_T::NO_FILL
privateinherited

Definition at line 382 of file item_modification_routine.h.

Referenced by Finalize(), and ProcessShape().

◆ m_firstPolygon

bool POLYGON_BOOLEAN_ROUTINE::m_firstPolygon = true
privateinherited

Definition at line 379 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 GetHandler(), and ITEM_MODIFICATION_ROUTINE().

◆ m_layer

PCB_LAYER_ID POLYGON_BOOLEAN_ROUTINE::m_layer = PCB_LAYER_ID::UNDEFINED_LAYER
privateinherited

Definition at line 381 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 AddFailure(), GetFailures(), and ITEM_MODIFICATION_ROUTINE().

◆ m_numSuccesses

unsigned ITEM_MODIFICATION_ROUTINE::m_numSuccesses
privateinherited

Definition at line 205 of file item_modification_routine.h.

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

◆ m_width

int POLYGON_BOOLEAN_ROUTINE::m_width = 0
privateinherited

Definition at line 380 of file item_modification_routine.h.

Referenced by Finalize(), and ProcessShape().

◆ m_workingPolygons

SHAPE_POLY_SET POLYGON_BOOLEAN_ROUTINE::m_workingPolygons
privateinherited

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

Definition at line 377 of file item_modification_routine.h.

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

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