POLYGON_BOOLEAN_ROUTINE Class Reference

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

#include <item_modification_routine.h>

Inheritance diagram for POLYGON_BOOLEAN_ROUTINE:

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

Protected Member Functions
PCB_SHAPE *	GetWorkingPolygon () const
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 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
PCB_SHAPE *	m_workingPolygon
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 308 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 311 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 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 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 ProcessShape().

GetCommitDescription()

virtual wxString ITEM_MODIFICATION_ROUTINE::GetCommitDescription ( ) const

pure virtualinherited

Implemented in LINE_FILLET_ROUTINE, LINE_CHAMFER_ROUTINE, LINE_EXTENSION_ROUTINE, POLYGON_MERGE_ROUTINE, POLYGON_SUBTRACT_ROUTINE, and POLYGON_INTERSECT_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 LINE_FILLET_ROUTINE::GetStatusMessage(), LINE_CHAMFER_ROUTINE::GetStatusMessage(), LINE_EXTENSION_ROUTINE::GetStatusMessage(), POLYGON_MERGE_ROUTINE::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 ProcessShape().

GetStatusMessage()

virtual std::optional< wxString > ITEM_MODIFICATION_ROUTINE::GetStatusMessage ( ) const

pure virtualinherited

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

Usually this will be an error or nothing.

Implemented in LINE_FILLET_ROUTINE, LINE_CHAMFER_ROUTINE, LINE_EXTENSION_ROUTINE, 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 LINE_FILLET_ROUTINE::GetStatusMessage(), LINE_CHAMFER_ROUTINE::GetStatusMessage(), LINE_EXTENSION_ROUTINE::GetStatusMessage(), POLYGON_MERGE_ROUTINE::GetStatusMessage(), POLYGON_SUBTRACT_ROUTINE::GetStatusMessage(), and POLYGON_INTERSECT_ROUTINE::GetStatusMessage().

GetWorkingPolygon()

PCB_SHAPE * POLYGON_BOOLEAN_ROUTINE::GetWorkingPolygon ( ) const

inlineprotected

Definition at line 319 of file item_modification_routine.h.

References m_workingPolygon.

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

)

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(), m_workingPolygon, 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 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

private

Definition at line 324 of file item_modification_routine.h.

Referenced by GetWorkingPolygon(), and ProcessShape().

---

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

• item_modification_routine.h
• item_modification_routine.cpp