Pairwise line tool that adds a chamfer between the lines. More...

#include <item_modification_routine.h>

Inheritance diagram for LINE_CHAMFER_ROUTINE:

Public Member Functions
	LINE_CHAMFER_ROUTINE (BOARD_ITEM *aBoard, CHANGE_HANDLER &aHandler, CHAMFER_PARAMS aChamferParams)

wxString	GetCommitDescription () const override

std::optional< wxString >	GetStatusMessage () const override
	Get a status message to show when the routine is complete.

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

unsigned	GetSuccesses () const

unsigned	GetFailures () const

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
const CHAMFER_PARAMS	m_chamferParams

BOARD_ITEM *	m_board

CHANGE_HANDLER &	m_handler

unsigned	m_numSuccesses

unsigned	m_numFailures

Detailed Description

Pairwise line tool that adds a chamfer between the lines.

Definition at line 268 of file item_modification_routine.h.

Constructor & Destructor Documentation

◆ LINE_CHAMFER_ROUTINE()

LINE_CHAMFER_ROUTINE::LINE_CHAMFER_ROUTINE	(	BOARD_ITEM *	aBoard,
		CHANGE_HANDLER &	aHandler,
		CHAMFER_PARAMS	aChamferParams
	)

inline

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

◆ GetCommitDescription()

wxString LINE_CHAMFER_ROUTINE::GetCommitDescription ( ) const

overridevirtual

Implements ITEM_MODIFICATION_ROUTINE.

Definition at line 174 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(), 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(), ProcessLinePair(), LINE_EXTENSION_ROUTINE::ProcessLinePair(), and POLYGON_BOOLEAN_ROUTINE::ProcessShape().

◆ GetStatusMessage()

std::optional< wxString > LINE_CHAMFER_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 180 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(), 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 ProcessLinePair().

◆ ProcessLinePair()

void LINE_CHAMFER_ROUTINE::ProcessLinePair	(	PCB_SHAPE &	aLineA,
		PCB_SHAPE &	aLineB
	)

overridevirtual

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