POLYGON_MERGE_ROUTINE Class Reference

#include <item_modification_routine.h>

Inheritance diagram for POLYGON_MERGE_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)
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
bool	m_filled = false
BOARD_ITEM *	m_board
CHANGE_HANDLER &	m_handler
unsigned	m_numSuccesses
unsigned	m_numFailures

Detailed Description

Definition at line 366 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 369 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(), DOGBONE_CORNER_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 OUTSET_ROUTINE::ProcessItem(), LINE_FILLET_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), LINE_EXTENSION_ROUTINE::ProcessLinePair(), DOGBONE_CORNER_ROUTINE::ProcessLinePair(), and POLYGON_BOOLEAN_ROUTINE::ProcessShape().

Finalize()

void POLYGON_BOOLEAN_ROUTINE::Finalize ( )

inherited

Clear up any outstanding work.

Definition at line 518 of file item_modification_routine.cpp.

References ITEM_MODIFICATION_ROUTINE::CHANGE_HANDLER::AddNewItem(), ITEM_MODIFICATION_ROUTINE::GetBoard(), ITEM_MODIFICATION_ROUTINE::GetHandler(), POLYGON_BOOLEAN_ROUTINE::m_filled, POLYGON_BOOLEAN_ROUTINE::m_firstPolygon, POLYGON_BOOLEAN_ROUTINE::m_layer, POLYGON_BOOLEAN_ROUTINE::m_width, POLYGON_BOOLEAN_ROUTINE::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 182 of file item_modification_routine.h.

References ITEM_MODIFICATION_ROUTINE::m_board.

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

GetCommitDescription()

wxString POLYGON_MERGE_ROUTINE::GetCommitDescription ( ) const

overridevirtual

Implements ITEM_MODIFICATION_ROUTINE.

Definition at line 552 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(), DOGBONE_CORNER_ROUTINE::GetStatusMessage(), GetStatusMessage(), POLYGON_SUBTRACT_ROUTINE::GetStatusMessage(), POLYGON_INTERSECT_ROUTINE::GetStatusMessage(), and OUTSET_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 POLYGON_BOOLEAN_ROUTINE::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 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 558 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(), DOGBONE_CORNER_ROUTINE::GetStatusMessage(), GetStatusMessage(), POLYGON_SUBTRACT_ROUTINE::GetStatusMessage(), POLYGON_INTERSECT_ROUTINE::GetStatusMessage(), and OUTSET_ROUTINE::GetStatusMessage().

GetWorkingPolygons()

SHAPE_POLY_SET & POLYGON_BOOLEAN_ROUTINE::GetWorkingPolygons ( )

inlineprotectedinherited

Definition at line 352 of file item_modification_routine.h.

References POLYGON_BOOLEAN_ROUTINE::m_workingPolygons.

Referenced by 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

aItem	the line to modify
aSeg	the new line geometry

Definition at line 76 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 )

inherited

Definition at line 453 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(), ITEM_MODIFICATION_ROUTINE::GetHandler(), PCB_SHAPE::GetLayer(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetShape(), PCB_SHAPE::GetWidth(), EDA_SHAPE::IsFilled(), POLYGON_BOOLEAN_ROUTINE::m_filled, POLYGON_BOOLEAN_ROUTINE::m_firstPolygon, POLYGON_BOOLEAN_ROUTINE::m_layer, POLYGON_BOOLEAN_ROUTINE::m_width, POLYGON_BOOLEAN_ROUTINE::m_workingPolygons, 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 572 of file item_modification_routine.cpp.

References SHAPE_POLY_SET::BooleanAdd(), POLYGON_BOOLEAN_ROUTINE::GetWorkingPolygons(), and SHAPE_POLY_SET::PM_FAST.

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_filled

bool POLYGON_BOOLEAN_ROUTINE::m_filled = false

privateinherited

Definition at line 363 of file item_modification_routine.h.

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

m_firstPolygon

bool POLYGON_BOOLEAN_ROUTINE::m_firstPolygon = true

privateinherited

Definition at line 360 of file item_modification_routine.h.

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

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_layer

PCB_LAYER_ID POLYGON_BOOLEAN_ROUTINE::m_layer = PCB_LAYER_ID::UNDEFINED_LAYER

privateinherited

Definition at line 362 of file item_modification_routine.h.

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

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_width

int POLYGON_BOOLEAN_ROUTINE::m_width = 0

privateinherited

Definition at line 361 of file item_modification_routine.h.

Referenced by POLYGON_BOOLEAN_ROUTINE::Finalize(), and POLYGON_BOOLEAN_ROUTINE::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 358 of file item_modification_routine.h.

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

---

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

• item_modification_routine.h
• item_modification_routine.cpp