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

#include <item_modification_routine.h>

Inheritance diagram for POLYGON_MERGE_ROUTINE:
POLYGON_BOOLEAN_ROUTINE ITEM_MODIFICATION_ROUTINE

Public Member Functions

 POLYGON_MERGE_ROUTINE (BOARD_ITEM *aBoard, CHANGE_HANDLER &aHandler)
 
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)
 
unsigned GetSuccesses () const
 
unsigned GetFailures () const
 

Protected Member Functions

PCB_SHAPE * GetWorkingPolygon () const
 
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 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

PCB_SHAPE * m_workingPolygon
 
BOARD_ITEM * m_board
 
CHANGE_HANDLER & m_handler
 
unsigned m_numSuccesses
 
unsigned m_numFailures
 

Detailed Description

Definition at line 327 of file item_modification_routine.h.

Constructor & Destructor Documentation

◆ POLYGON_MERGE_ROUTINE()

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

Definition at line 330 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 192 of file item_modification_routine.h.

References ITEM_MODIFICATION_ROUTINE::m_numFailures.

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

◆ AddSuccess()

void ITEM_MODIFICATION_ROUTINE::AddSuccess ( )
inlineprotectedinherited

Mark that one of the actions succeeded.

Definition at line 187 of file item_modification_routine.h.

References ITEM_MODIFICATION_ROUTINE::m_numSuccesses.

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

◆ GetBoard()

BOARD_ITEM * ITEM_MODIFICATION_ROUTINE::GetBoard ( ) const
inlineprotectedinherited

The BOARD used when creating new shapes.

Definition at line 182 of file item_modification_routine.h.

References ITEM_MODIFICATION_ROUTINE::m_board.

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

◆ GetCommitDescription()

wxString POLYGON_MERGE_ROUTINE::GetCommitDescription ( ) const
overridevirtual

Implements ITEM_MODIFICATION_ROUTINE.

Definition at line 385 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 ITEM_MODIFICATION_ROUTINE::m_numFailures.

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

◆ GetHandler()

CHANGE_HANDLER & ITEM_MODIFICATION_ROUTINE::GetHandler ( )
inlineprotectedinherited

Access the handler for making changes to the board.

Definition at line 206 of file item_modification_routine.h.

References ITEM_MODIFICATION_ROUTINE::m_handler.

Referenced by ITEM_MODIFICATION_ROUTINE::ModifyLineOrDeleteIfZeroLength(), LINE_FILLET_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), LINE_EXTENSION_ROUTINE::ProcessLinePair(), and POLYGON_BOOLEAN_ROUTINE::ProcessShape().

◆ GetStatusMessage()

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

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

Usually this will be an error or nothing.

Implements ITEM_MODIFICATION_ROUTINE.

Definition at line 391 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 ITEM_MODIFICATION_ROUTINE::m_numSuccesses.

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

◆ GetWorkingPolygon()

PCB_SHAPE * POLYGON_BOOLEAN_ROUTINE::GetWorkingPolygon ( ) const
inlineprotectedinherited

Definition at line 319 of file item_modification_routine.h.

References POLYGON_BOOLEAN_ROUTINE::m_workingPolygon.

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

◆ ModifyLineOrDeleteIfZeroLength()

bool ITEM_MODIFICATION_ROUTINE::ModifyLineOrDeleteIfZeroLength ( PCB_SHAPE &  aItem,
const 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 41 of file item_modification_routine.cpp.

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

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

◆ ProcessShape()

void POLYGON_BOOLEAN_ROUTINE::ProcessShape ( PCB_SHAPE &  aPcbShape)
inherited

Definition at line 313 of file item_modification_routine.cpp.

References ITEM_MODIFICATION_ROUTINE::AddFailure(), ITEM_MODIFICATION_ROUTINE::CHANGE_HANDLER::AddNewItem(), ITEM_MODIFICATION_ROUTINE::AddSuccess(), SHAPE_POLY_SET::Append(), ITEM_MODIFICATION_ROUTINE::CHANGE_HANDLER::DeleteItem(), ITEM_MODIFICATION_ROUTINE::GetBoard(), ITEM_MODIFICATION_ROUTINE::GetHandler(), PCB_SHAPE::GetLayer(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetShape(), PCB_SHAPE::GetWidth(), POLYGON_BOOLEAN_ROUTINE::m_workingPolygon, SHAPE_POLY_SET::NewOutline(), and POLYGON_BOOLEAN_ROUTINE::ProcessSubsequentPolygon().

◆ ProcessSubsequentPolygon()

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

Implements POLYGON_BOOLEAN_ROUTINE.

Definition at line 405 of file item_modification_routine.cpp.

References SHAPE_POLY_SET::BooleanAdd(), EDA_SHAPE::GetPolyShape(), POLYGON_BOOLEAN_ROUTINE::GetWorkingPolygon(), SHAPE_POLY_SET::OutlineCount(), SHAPE_POLY_SET::PM_FAST, and EDA_SHAPE::SetPolyShape().

Member Data Documentation

◆ m_board

BOARD_ITEM* ITEM_MODIFICATION_ROUTINE::m_board
privateinherited

Definition at line 209 of file item_modification_routine.h.

Referenced by ITEM_MODIFICATION_ROUTINE::GetBoard().

◆ m_handler

CHANGE_HANDLER& ITEM_MODIFICATION_ROUTINE::m_handler
privateinherited

Definition at line 210 of file item_modification_routine.h.

Referenced by ITEM_MODIFICATION_ROUTINE::GetHandler().

◆ m_numFailures

unsigned ITEM_MODIFICATION_ROUTINE::m_numFailures
privateinherited

Definition at line 213 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 212 of file item_modification_routine.h.

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

◆ m_workingPolygon

PCB_SHAPE* POLYGON_BOOLEAN_ROUTINE::m_workingPolygon
privateinherited

Definition at line 324 of file item_modification_routine.h.

Referenced by POLYGON_BOOLEAN_ROUTINE::GetWorkingPolygon(), and POLYGON_BOOLEAN_ROUTINE::ProcessShape().

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