A tool that acts on a pair of lines. More...

#include <item_modification_routine.h>

Inheritance diagram for PAIRWISE_LINE_ROUTINE:

Public Member Functions
	PAIRWISE_LINE_ROUTINE (BOARD_ITEM *aBoard, CHANGE_HANDLER &aHandler)

virtual void	ProcessLinePair (PCB_SHAPE &aLineA, PCB_SHAPE &aLineB)=0
	Perform the action on the pair of lines given.

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
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
BOARD_ITEM *	m_board

CHANGE_HANDLER &	m_handler

unsigned	m_numSuccesses

unsigned	m_numFailures

Detailed Description

A tool that acts on a pair of lines.

For example, fillets, chamfers, extensions, etc

Definition at line 219 of file item_modification_routine.h.

Constructor & Destructor Documentation

◆ PAIRWISE_LINE_ROUTINE()

PAIRWISE_LINE_ROUTINE::PAIRWISE_LINE_ROUTINE	(	BOARD_ITEM *	aBoard,
		CHANGE_HANDLER &	aHandler
	)

inline

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

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 POLYGON_BOOLEAN_ROUTINE::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().

◆ 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().

◆ ProcessLinePair()

virtual void PAIRWISE_LINE_ROUTINE::ProcessLinePair	(	PCB_SHAPE &	aLineA,
		PCB_SHAPE &	aLineB
	)

pure virtual

Perform the action on the pair of lines given.

The routine will be called repeatedly with all possible pairs of lines in the selection. The tools should handle the ones it's interested in. This means that the same line can appear multiple times with different partners.

The routine can skip lines that it's not interested in by returning without adding to the success or failure count.

Parameters