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.

virtual std::optional< wxString >	GetStatusMessage (int aSegmentCount) const =0
	Get a status message to show when the routine is complete.

unsigned	GetSuccesses () const

unsigned	GetFailures () const

virtual wxString	GetCommitDescription () const =0

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 std::optional< SEG > &aSeg)
	Helper function useful for multiple tools: modify a line or delete it if it has zero length.

void	SplitCornerConstraint (const CONSTRAINT_MEMBER &aCornerA, const CONSTRAINT_MEMBER &aCornerB, const CONSTRAINT_MEMBER &aInsertedForA, const CONSTRAINT_MEMBER &aInsertedForB)
	Hold each line to a shape just inserted at their shared corner, in place of the coincident constraint that held the two lines to each other.

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 217 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 220 of file item_modification_routine.h.

References ITEM_MODIFICATION_ROUTINE::ITEM_MODIFICATION_ROUTINE().

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

Member Function Documentation

◆ AddFailure()

void ITEM_MODIFICATION_ROUTINE::AddFailure ( )

inlineprotectedinherited

Mark that one of the actions failed.

Definition at line 182 of file item_modification_routine.h.

References m_numFailures.

Referenced by OUTSET_ROUTINE::ProcessItem(), 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 177 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().

◆ GetBoard()

BOARD_ITEM * ITEM_MODIFICATION_ROUTINE::GetBoard ( ) const

inlineprotectedinherited

The BOARD used when creating new shapes.

Definition at line 172 of file item_modification_routine.h.

References m_board.

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

◆ GetCommitDescription()

virtual wxString ITEM_MODIFICATION_ROUTINE::GetCommitDescription ( ) const

pure virtualinherited

Implemented in DOGBONE_CORNER_ROUTINE, LINE_CHAMFER_ROUTINE, LINE_EXTENSION_ROUTINE, LINE_FILLET_ROUTINE, OUTSET_ROUTINE, POLYGON_INTERSECT_ROUTINE, POLYGON_MERGE_ROUTINE, and POLYGON_SUBTRACT_ROUTINE.

◆ GetFailures()

unsigned ITEM_MODIFICATION_ROUTINE::GetFailures ( ) const

inlineinherited

Definition at line 164 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(), POLYGON_SUBTRACT_ROUTINE::GetStatusMessage(), and OUTSET_ROUTINE::ProcessItem().

◆ GetHandler()

CHANGE_HANDLER & ITEM_MODIFICATION_ROUTINE::GetHandler ( )

inlineprotectedinherited

Access the handler for making changes to the board.

Definition at line 204 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(), POLYGON_BOOLEAN_ROUTINE::ProcessShape(), and SplitCornerConstraint().

◆ GetStatusMessage()

virtual std::optional< wxString > PAIRWISE_LINE_ROUTINE::GetStatusMessage ( int aSegmentCount ) const

pure virtual

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

Usually this will be an error or nothing.

Implemented in DOGBONE_CORNER_ROUTINE, LINE_CHAMFER_ROUTINE, LINE_EXTENSION_ROUTINE, and LINE_FILLET_ROUTINE.

◆ GetSuccesses()

unsigned ITEM_MODIFICATION_ROUTINE::GetSuccesses ( ) const

inlineinherited

Definition at line 162 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(), POLYGON_SUBTRACT_ROUTINE::GetStatusMessage(), and OUTSET_ROUTINE::ProcessItem().

◆ 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(), GetHandler(), EDA_SHAPE::GetShape(), ITEM_MODIFICATION_ROUTINE::CHANGE_HANDLER::MarkItemModified(), SEGMENT, PCB_SHAPE::SetEnd(), and PCB_SHAPE::SetStart().

Referenced by DOGBONE_CORNER_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), and LINE_FILLET_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

aLineA	the first line
aLineB	the second line

Implemented in DOGBONE_CORNER_ROUTINE, LINE_CHAMFER_ROUTINE, LINE_EXTENSION_ROUTINE, and LINE_FILLET_ROUTINE.

◆ SplitCornerConstraint()

void ITEM_MODIFICATION_ROUTINE::SplitCornerConstraint	(	const CONSTRAINT_MEMBER &	aCornerA,
		const CONSTRAINT_MEMBER &	aCornerB,
		const CONSTRAINT_MEMBER &	aInsertedForA,
		const CONSTRAINT_MEMBER &	aInsertedForB )