An object that has the ability to modify items on a board. More...

#include <item_modification_routine.h>

Inheritance diagram for ITEM_MODIFICATION_ROUTINE:

Classes
class	CALLABLE_BASED_HANDLER
	A handler that is based on a set of callbacks provided by the user of the ITEM_MODIFICATION_ROUTINE. More...

class	CHANGE_HANDLER
	Handlers for receiving changes from the tool. More...

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

virtual	~ITEM_MODIFICATION_ROUTINE ()=default

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

An object that has the ability to modify items on a board.

For example, such an object could take pairs of lines and fillet them, or produce other modification to items.

Deliberately not called a "tool" to distinguish it from true tools that are used interactively by the user.

Definition at line 43 of file item_modification_routine.h.

Constructor & Destructor Documentation

◆ ITEM_MODIFICATION_ROUTINE()

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

inline

Definition at line 152 of file item_modification_routine.h.

References m_board, m_handler, m_numFailures, and m_numSuccesses.

Referenced by OUTSET_ROUTINE::OUTSET_ROUTINE(), PAIRWISE_LINE_ROUTINE::PAIRWISE_LINE_ROUTINE(), and POLYGON_BOOLEAN_ROUTINE::POLYGON_BOOLEAN_ROUTINE().

◆ ~ITEM_MODIFICATION_ROUTINE()

virtual ITEM_MODIFICATION_ROUTINE::~ITEM_MODIFICATION_ROUTINE ( )

virtualdefault

Member Function Documentation

◆ AddFailure()

void ITEM_MODIFICATION_ROUTINE::AddFailure ( )

inlineprotected

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

inlineprotected

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

inlineprotected

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 virtual

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

inline

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

inlineprotected

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

◆ GetSuccesses()

unsigned ITEM_MODIFICATION_ROUTINE::GetSuccesses ( ) const

inline

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 )

protected

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

◆ SplitCornerConstraint()

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