#include <multichannel_tool.h>

Inheritance diagram for MULTICHANNEL_TOOL:

Classes
struct	TOPOLOGY_JOB

Public Types
enum	RESET_REASON { RUN , MODEL_RELOAD , SUPERMODEL_RELOAD , GAL_SWITCH , REDRAW , SHUTDOWN }
	Determine the reason of reset for a tool. More...

Public Member Functions
	MULTICHANNEL_TOOL ()

	~MULTICHANNEL_TOOL ()

int	RepeatLayout (const TOOL_EVENT &aEvent, ZONE *aRefZone)

int	RepeatLayout (const TOOL_EVENT &aEvent, RULE_AREA &aRefArea, RULE_AREA &aTargetArea, REPEAT_LAYOUT_OPTIONS &aOptions, BOARD_COMMIT aExternalCommit=nullptr, wxString aErrorOut=nullptr)

int	AutogenerateRuleAreas (const TOOL_EVENT &aEvent)

void	UpdatePickedPoint (const std::optional< VECTOR2I > &aPoint) override

void	UpdatePickedItem (const EDA_ITEM *aItem) override

void	ShowMismatchDetails (wxWindow *aParent, const wxString &aSummary, const std::vector< wxString > &aReasons) const

RULE_AREAS_DATA *	GetData ()

void	GeneratePotentialRuleAreas ()

void	FindExistingRuleAreas ()

int	CheckRACompatibility (ZONE *aRefZone)

bool	UpdateLinkedLayouts (ZONE *aSource)
	Copy aSource onto the other areas of its link set, as one undo step.

void	UnlinkAreas (const std::set< ZONE * > &aZones)
	Remove aZones from their link sets, and any area left alone in one, as one undo step.

void	StartRepeatFromSelection (const std::vector< EDA_ITEM * > &aItems)
	Use plain selected items as the reference and discover the channels that repeat them.

void	DiscoverRepeatCandidates (bool aLoose)

std::set< FOOTPRINT * >	ExpandToMatchingTopology (const std::set< FOOTPRINT * > &aSeed, bool aLargest)
	Grow aSeed with the parts next to it, keeping only sets that still have an exact twin elsewhere on the board.

void	RefreshRepeat ()
	Re-derive the channels after a tick or the anchor changed, then redraw the preview.

void	UpdateRepeatPreview ()

void	HighlightRepeatAreas (const RULE_AREA *aArea)
	Mark the reference parts, and the parts of aArea if given, on the board while the dialog is open.

int	ApplyRepeat ()
	Apply what the Repeat Layout dialog shows.

void	SetIsFootprintEditor (bool aEnabled)
	Toggle edit footprint mode.

bool	IsFootprintEditor () const

void	SetIsBoardEditor (bool aEnabled)

bool	IsBoardEditor () const

virtual bool	Is45Limited () const
	Should the tool use its 45° mode option?

virtual bool	Is90Limited () const
	Should the tool limit drawing to horizontal and vertical only?

LEADER_MODE	GetAngleSnapMode () const
	Get the current angle snapping mode.

bool	GetAutoConstraints () const
	Should drawing tools author constraints automatically?

void	Activate ()
	Run the tool.

TOOL_MENU &	GetToolMenu ()

void	SetContextMenu (ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
	Assign a context menu and tells when it should be activated.

void	RunMainStack (std::function< void()> aFunc)
	Call a function using the main stack.

template<class T>
void	Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
	Define which state (aStateFunc) to go when a certain event arrives (aConditions).

TOOL_EVENT *	Wait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
	Suspend execution of the tool until an event specified in aEventList arrives.

TOOL_TYPE	GetType () const
	Return the type of the tool.

TOOL_ID	GetId () const
	Return the unique identifier of the tool.

const std::string &	GetName () const
	Return the name of the tool.

TOOL_MANAGER *	GetManager () const
	Return the instance of TOOL_MANAGER that takes care of the tool.

bool	IsToolActive () const

Static Public Member Functions
static ZONE *	ChannelZone (const PCB_GROUP *aGroup)
	The rule area zone that makes aGroup a repeated channel, or null for any other group.

static wxString	JoinReferences (const std::set< FOOTPRINT * > &aFootprints)

static std::vector< NETINFO_ITEM * >	IsolateDesignBlockAutoNets (BOARD aBoard, const std::set< FOOTPRINT > &aFootprints, const std::unordered_set< EDA_ITEM * > &aItems)
	Remap auto-generated nets (Net-(...), unconnected-...) of a design block that was appended for layout matching onto fresh private nets, so they cannot fuse by name with same-named nets that belong to different parts on the board (issue 24767).

Protected Types
enum	INTERACTIVE_PLACEMENT_OPTIONS { IPO_ROTATE = 0x01 , IPO_FLIP = 0x02 , IPO_SINGLE_CLICK = 0x04 , IPO_REPEAT = 0x08 }
	Options for placing items interactively. More...

Protected Member Functions
void	doInteractiveItemPlacement (const TOOL_EVENT &aTool, INTERACTIVE_PLACER_BASE *aPlacer, const wxString &aCommitMessage, int aOptions=IPO_ROTATE\|IPO_FLIP\|IPO_REPEAT)
	Helper function for performing a common interactive idiom: wait for a left click, place an item there (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc.

KIGFX::PCB_VIEW *	view () const

KIGFX::VIEW_CONTROLS *	controls () const

template<class T = PCB_BASE_EDIT_FRAME>
T *	frame () const

BOARD *	board () const

FOOTPRINT *	footprint () const

PCBNEW_SETTINGS::DISPLAY_OPTIONS &	displayOptions () const

PCB_DRAW_PANEL_GAL *	canvas () const

const PCB_SELECTION &	selection () const

PCB_SELECTION &	selection ()

void	attachManager (TOOL_MANAGER *aManager)
	Set the TOOL_MANAGER the tool will belong to.

KIGFX::VIEW *	getView () const
	Return the instance of KIGFX::VIEW object used in the application.

KIGFX::VIEW_CONTROLS *	getViewControls () const
	Return the instance of VIEW_CONTROLS object used in the application.

template<typename T>
T *	getEditFrame () const
	Return the application window object, casted to requested user type.

template<typename T>
T *	getModel () const
	Return the model object if it matches the requested type.

Protected Attributes
bool	m_isFootprintEditor

bool	m_isBoardEditor

std::unique_ptr< TOOL_MENU >	m_menu
	The functions below are not yet implemented - their interface may change.

TOOL_TYPE	m_type

TOOL_ID	m_toolId
	Unique id, assigned by a TOOL_MANAGER instance.

std::string	m_toolName
	Names are expected to obey the format application.ToolName (eg.

TOOL_MANAGER *	m_toolMgr

Private Member Functions
bool	Init () override
	Init() is called once upon a registration of the tool.

void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state.

void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events.

int	repeatLayout (const TOOL_EVENT &aEvent)

int	updateLinkedLayouts (const TOOL_EVENT &aEvent)

int	unlinkLayout (const TOOL_EVENT &aEvent)

int	expandToMatchingTopology (const TOOL_EVENT &aEvent)

int	expandToLargestTopology (const TOOL_EVENT &aEvent)

int	expandSelection (bool aLargest)

bool	routerBusy () const

void	linkAreas (BOARD_COMMIT &aCommit, ZONE aRefZone, const std::vector< RULE_AREA > &aTargets)
	Link aTargets and aRefZone into one set with their own copies of the options.

void	detachArea (BOARD_COMMIT &aCommit, ZONE *aZone)

void	dropLoneLinks (BOARD_COMMIT &aCommit, const std::set< KIID > &aSets)

std::vector< RULE_AREA_COMPAT_DATA >	findMatches (const std::set< FOOTPRINT * > &aSelected, bool aLoose)
	The channels elsewhere on the board that repeat the topology of aSelected.

bool	updateSelectionCore ()

int	applySelectionRepeat ()

void	clearRepeatPreview ()

std::set< BOARD_CONNECTED_ITEM * >	findRepeatRouting (RULE_AREA *aArea, const std::set< int > &aNets, const REPEAT_LAYOUT_OPTIONS &aOpts)
	The routing of aArea on aNets, the only nets a repeat ever carries.

void	hideMovedRatsnest ()

void	setPreviewHidden (bool aHide)

void	closeRepeatDialog ()

void	onRepeatDialogClosed (wxCloseEvent &aEvent)

int	applyRepeat (BOARD_COMMIT &aCommit)

bool	findComponentsInRuleArea (RULE_AREA aRuleArea, std::set< FOOTPRINT > &aComponents)

bool	findOtherItemsInRuleArea (RULE_AREA aRuleArea, std::set< BOARD_ITEM > &aItems)

int	findRoutingInRuleArea (RULE_AREA aRuleArea, std::set< BOARD_CONNECTED_ITEM > &aOutput) const

void	copyRuleAreaContents (RULE_AREA aRefArea, RULE_AREA aTargetArea, BOARD_COMMIT *aCommit, REPEAT_LAYOUT_OPTIONS aOpts, RULE_AREA_COMPAT_DATA &aCompatData)

const SHAPE_LINE_CHAIN	buildRAOutline (std::set< FOOTPRINT * > &aFootprints, int aMargin)

const SHAPE_LINE_CHAIN	buildRAOutline (const std::set< BOARD_ITEM * > &aItems, int aMargin)

std::set< FOOTPRINT * >	queryComponentsInSheet (wxString aSheetName) const

std::set< FOOTPRINT * >	queryComponentsInComponentClass (const wxString &aComponentClassName) const

std::set< FOOTPRINT * >	queryComponentsInGroup (const wxString &aGroupName) const

std::set< BOARD_ITEM * >	queryBoardItemsInGroup (const wxString &aGroupName) const

PCB_GROUP *	findPlacementGroup (const wxString &aGroupName) const

bool	resolveConnectionTopology (RULE_AREA aRefArea, RULE_AREA aTargetArea, RULE_AREA_COMPAT_DATA &aMatches, const TMATCH::ISOMORPHISM_PARAMS &aParams={}, const std::unordered_set< int > &aExtraGlobalNets={})

bool	resolveTopologies (const wxString &aTitle, const std::vector< TOPOLOGY_JOB > &aJobs)
	Resolve the topology of each job in turn on a worker thread.

void	fixupNet (BOARD_CONNECTED_ITEM aRef, BOARD_CONNECTED_ITEM aTarget, bool aHasMatches, const std::map< int, int > &aNetMap)
	Attempts to make sure copied items are assigned the right net.

bool	pruneExistingGroups (COMMIT &aCommit, const std::unordered_set< BOARD_ITEM * > &aItemsToCheck)

void	resetTransitions ()
	Clear the current transition map and restores the default one created by setTransitions().

void	goInternal (TOOL_STATE_FUNC &aState, const TOOL_EVENT_LIST &aConditions)

EDA_ITEM *	getModelInternal () const

TOOLS_HOLDER *	getToolHolderInternal () const

Private Attributes
std::unique_ptr< REPORTER >	m_reporter

RULE_AREAS_DATA	m_areas

DIALOG_MULTICHANNEL_REPEAT_LAYOUT *	m_dialog = nullptr

std::vector< KIID >	m_previewHidden

std::shared_ptr< KIGFX::VIEW_OVERLAY >	m_highlight

const RULE_AREA *	m_focusArea = nullptr

std::map< FOOTPRINT *, BOX2I >	m_previewBoxes

std::vector< SEG >	m_previewRatsnest

Detailed Description

Definition at line 109 of file multichannel_tool.h.

Member Enumeration Documentation

◆ INTERACTIVE_PLACEMENT_OPTIONS

enum PCB_TOOL_BASE::INTERACTIVE_PLACEMENT_OPTIONS

protectedinherited

Options for placing items interactively.

Enumerator
IPO_ROTATE	Handle the rotate action in the loop by calling the item's rotate method.
IPO_FLIP	Handle flip action in the loop by calling the item's flip method.
IPO_SINGLE_CLICK	Create an item immediately on placement starting, otherwise show the pencil cursor until the item is created.
IPO_REPEAT	Allow repeat placement of the item.

Definition at line 135 of file pcb_tool_base.h.

◆ RESET_REASON

enum TOOL_BASE::RESET_REASON

inherited

Determine the reason of reset for a tool.

Enumerator
RUN	Tool is invoked after being inactive.
MODEL_RELOAD	Model changes (the sheet for a schematic)
SUPERMODEL_RELOAD	For schematics, the entire schematic changed, not just the sheet.
GAL_SWITCH	Rendering engine changes.
REDRAW	Full drawing refresh.
SHUTDOWN	Tool is being shut down.

Definition at line 73 of file tool_base.h.

Constructor & Destructor Documentation

◆ MULTICHANNEL_TOOL()

MULTICHANNEL_TOOL::MULTICHANNEL_TOOL ( )

Definition at line 205 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::PCB_TOOL_BASE().

◆ ~MULTICHANNEL_TOOL()

MULTICHANNEL_TOOL::~MULTICHANNEL_TOOL ( )

Definition at line 210 of file multichannel_tool.cpp.

Member Function Documentation

◆ Activate()

void TOOL_INTERACTIVE::Activate ( )

inherited

Run the tool.

After activation, the tool starts receiving events until it is finished.

Definition at line 61 of file tool_interactive.cpp.

References TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

Referenced by CONSTRAINT_EDIT_TOOL::AddPointConstraint(), AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::copyToClipboard(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawEllipseArc(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridPlaceOrigin(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), PCB_CONTROL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), SCH_TOOL_BASE< T >::InteractiveDelete(), POSITION_RELATIVE_TOOL::InteractiveOffset(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PCB_PICKER_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::OptimizeSelected(), CONSTRAINT_EDIT_TOOL::pickLinearConstraint(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), CONSTRAINT_EDIT_TOOL::pickShapeConstraint(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), GRAPHIC_EDIT_TOOL::runInteractive(), MATCH_PROPERTIES_TOOL::runInteractive(), DRAWING_TOOL::runSimpleShapeDraw(), PCB_PICKER_TOOL::SelectItemInteractively(), PCB_PICKER_TOOL::SelectPointInteractively(), DRAWING_TOOL::SetAnchor(), DRC_TOOL::ShowDesignRuleEditorDialog(), DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew(), DRC_TOOL::ShowDRCDialog(), and DRC_RULE_EDITOR_TOOL::ShowDRCRuleEditorDialog().

◆ ApplyRepeat()

int MULTICHANNEL_TOOL::ApplyRepeat ( )

Apply what the Repeat Layout dialog shows.

Definition at line 1992 of file multichannel_tool.cpp.

References applySelectionRepeat(), clearRepeatPreview(), m_areas, and RepeatLayout().

◆ applyRepeat()

int MULTICHANNEL_TOOL::applyRepeat ( BOARD_COMMIT & aCommit )

private

Definition at line 2557 of file multichannel_tool.cpp.

References COMMIT::Add(), PCB_TOOL_BASE::board(), copyRuleAreaContents(), group, GROUP_PLACEMENT, m_areas, COMMIT::Modify(), NO_RECURSE, pruneExistingGroups(), stageAddToGroup(), and traceMultichannelTool.

Referenced by applySelectionRepeat(), RepeatLayout(), UpdateLinkedLayouts(), and UpdateRepeatPreview().

◆ applySelectionRepeat()

int MULTICHANNEL_TOOL::applySelectionRepeat ( )

private

◆ attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER * aManager )

protectedinherited

Set the TOOL_MANAGER the tool will belong to.

Called by TOOL_MANAGER::RegisterTool()

Definition at line 58 of file tool_base.cpp.

References m_toolMgr, and TOOL_MANAGER.

Referenced by TOOL_MANAGER::RegisterTool().

◆ AutogenerateRuleAreas()

int MULTICHANNEL_TOOL::AutogenerateRuleAreas ( const TOOL_EVENT & aEvent )

Definition at line 4163 of file multichannel_tool.cpp.

References _, COMMIT::Add(), EDA_GROUP::AsEdaItem(), PCB_TOOL_BASE::board(), buildRAOutline(), channelNets(), closeRepeatDialog(), collectGroupBoardItems(), COMPONENT_CLASS, PCB_TOOL_BASE::frame(), GeneratePotentialRuleAreas(), TOOL_BASE::GetManager(), EDA_ITEM::GetParentGroup(), group, GROUP_PLACEMENT, m_areas, RULE_AREA::m_componentClass, RULE_AREA::m_components, RULE_AREA::m_generateEnabled, RULE_AREA::m_groupName, RULE_AREA::m_sheetPath, RULE_AREA::m_sourceType, RULE_AREA::m_zone, makePlacementArea(), COMMIT::Modify(), pad, FOOTPRINT::Pads(), Pgm(), pruneExistingGroups(), BOARD_COMMIT::Push(), queryBoardItemsInGroup(), COMMIT::Remove(), SHEETNAME, DIALOG_SHIM::ShowModal(), source, and traceMultichannelTool.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), checkGroupChannelRepeatLayout(), and setTransitions().

◆ board()

BOARD * PCB_TOOL_BASE::board ( ) const

inlineprotectedinherited

Definition at line 187 of file pcb_tool_base.h.

References TOOL_BASE::getModel().

◆ buildRAOutline() [1/2]

const SHAPE_LINE_CHAIN MULTICHANNEL_TOOL::buildRAOutline	(	const std::set< BOARD_ITEM * > &	aItems,
		int	aMargin )

private

Definition at line 794 of file multichannel_tool.cpp.

References BuildConvexHull(), KIGEOM::CollectBoxCorners(), BOX2< Vec >::GetInflated(), PCB_FOOTPRINT_T, and KIGEOM::RectifyPolygon().

◆ buildRAOutline() [2/2]

const SHAPE_LINE_CHAIN MULTICHANNEL_TOOL::buildRAOutline	(	std::set< FOOTPRINT * > &	aFootprints,
		int	aMargin )

private

Definition at line 774 of file multichannel_tool.cpp.

References BuildConvexHull(), KIGEOM::CollectBoxCorners(), and KIGEOM::RectifyPolygon().

Referenced by AutogenerateRuleAreas(), and DiscoverRepeatCandidates().

◆ canvas()

PCB_DRAW_PANEL_GAL * PCB_TOOL_BASE::canvas ( ) const

protectedinherited

Definition at line 347 of file pcb_tool_base.cpp.

References frame().

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), MULTICHANNEL_TOOL::clearRepeatPreview(), FOOTPRINT_EDITOR_CONTROL::CreateFootprintFromWizard(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), PAD_TOOL::enterPadEditMode(), PAD_TOOL::EnumeratePads(), PAD_TOOL::ExitPadEditMode(), ZONE_FILLER_TOOL::FillAllZones(), MULTICHANNEL_TOOL::hideMovedRatsnest(), MULTICHANNEL_TOOL::HighlightRepeatAreas(), EDIT_TOOL::Init(), POSITION_RELATIVE_TOOL::InteractiveOffset(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), EDIT_TOOL::pickReferencePoint(), PCB_CONTROL::RatsnestModeCycle(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::refresh(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), MATCH_PROPERTIES_TOOL::runInteractive(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), PCB_PICKER_TOOL::SelectItemInteractively(), PCB_PICKER_TOOL::SelectPointInteractively(), ZONE_FILLER_TOOL::singleShotRefocus(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), MULTICHANNEL_TOOL::UpdateRepeatPreview(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), and ZONE_FILLER_TOOL::ZoneFillDirty().

◆ ChannelZone()

ZONE * MULTICHANNEL_TOOL::ChannelZone ( const PCB_GROUP * aGroup )

static

The rule area zone that makes aGroup a repeated channel, or null for any other group.

Definition at line 335 of file multichannel_tool.cpp.

References ZONE::GetIsRuleArea(), EDA_GROUP::GetItems(), ZONE::GetPlacementAreaEnabled(), and PCB_ZONE_T.

Referenced by MULTICHANNEL_CONTEXT_MENU::MULTICHANNEL_CONTEXT_MENU(), and EDIT_TOOL::Properties().

◆ CheckRACompatibility()

int MULTICHANNEL_TOOL::CheckRACompatibility ( ZONE * aRefZone )

Definition at line 2313 of file multichannel_tool.cpp.

References _, m_areas, RULE_AREA::m_zone, and resolveTopologies().

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), checkGroupChannelRepeatLayout(), and repeatLayout().

◆ clearRepeatPreview()

void MULTICHANNEL_TOOL::clearRepeatPreview ( )

private

Definition at line 2245 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board(), PCB_TOOL_BASE::canvas(), CONNECTIVITY_DATA::ClearLocalRatsnest(), BOARD::GetConnectivity(), TOOL_BASE::getView(), m_highlight, m_previewBoxes, m_previewHidden, m_previewRatsnest, PCB_DRAW_PANEL_GAL::RedrawRatsnest(), EDA_DRAW_PANEL_GAL::Refresh(), setPreviewHidden(), and PCB_TOOL_BASE::view().

Referenced by ApplyRepeat(), onRepeatDialogClosed(), and UpdateRepeatPreview().

◆ closeRepeatDialog()

void MULTICHANNEL_TOOL::closeRepeatDialog ( )

private

Definition at line 2293 of file multichannel_tool.cpp.

References m_dialog.

Referenced by AutogenerateRuleAreas(), repeatLayout(), Reset(), and UpdateLinkedLayouts().

◆ controls()

KIGFX::VIEW_CONTROLS * PCB_TOOL_BASE::controls ( ) const

inlineprotectedinherited

Definition at line 176 of file pcb_tool_base.h.

References TOOL_BASE::getViewControls().

Referenced by doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawZone(), ROUTER_TOOL::finishInteractive(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::HighlightNetChain(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), POSITION_RELATIVE_TOOL::InteractiveOffset(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), ROUTER_TOOL::performRouting(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceTuningPattern(), ROUTER_TOOL::prepareInteractive(), ROUTER_TOOL::RouteSelected(), PCB_PICKER_TOOL::setControls(), PCB_POINT_EDITOR::setEditedPoint(), DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

◆ copyRuleAreaContents()

void MULTICHANNEL_TOOL::copyRuleAreaContents	(	RULE_AREA *	aRefArea,
		RULE_AREA *	aTargetArea,
		BOARD_COMMIT *	aCommit,
		REPEAT_LAYOUT_OPTIONS	aOpts,
		RULE_AREA_COMPAT_DATA &	aCompatData )

private

Definition at line 3121 of file multichannel_tool.cpp.

References COMMIT::Add(), SHAPE_POLY_SET::AddOutline(), ZONE::AddPolygon(), EDA_GROUP::AsEdaItem(), PCB_TOOL_BASE::board(), SHAPE_POLY_SET::CacheTriangulation(), EDA_ITEM::ClearFlags(), collectGroupBoardItems(), LSET::Contains(), LSET::ContainsAll(), EDA_GROUP::ContainsItem(), copied, SHAPE_POLY_SET::COutline(), PCB_GENERATOR::DeepClone(), DESIGN_BLOCK, findOtherItemsInRuleArea(), findRepeatRouting(), findRoutingInRuleArea(), fixupNet(), EDA_TEXT::GetAttributes(), BOARD::GetConnectivity(), EDA_GROUP::GetItems(), BOARD_ITEM::GetLayer(), ZONE::GetLayerSet(), EDA_ITEM::GetParentGroup(), PCB_TEXT::GetPosition(), COMMIT::GetStatus(), EDA_TEXT::GetText(), PCB_TEXT::GetTextAngle(), GROUP_PLACEMENT, ZONE::HatchBorder(), isChannelNet(), BOARD_ITEM::IsKnockout(), EDA_TEXT::IsVisible(), linkedChannelGroup(), RULE_AREA_COMPAT_DATA::m_affectedItems, REPEAT_LAYOUT_OPTIONS::m_anchor, RULE_AREA::m_components, REPEAT_LAYOUT_OPTIONS::m_connectedRoutingOnly, REPEAT_LAYOUT_OPTIONS::m_copyOtherItems, REPEAT_LAYOUT_OPTIONS::m_copyPlacement, REPEAT_LAYOUT_OPTIONS::m_copyRouting, RULE_AREA::m_designBlockItems, RULE_AREA::m_fromSelection, RULE_AREA::m_group, RULE_AREA_COMPAT_DATA::m_groupableItems, REPEAT_LAYOUT_OPTIONS::m_groupItems, REPEAT_LAYOUT_OPTIONS::m_includeLockedItems, RULE_AREA_COMPAT_DATA::m_matchingComponents, RULE_AREA::m_sourceType, RULE_AREA::m_zone, COMMIT::Modify(), PCB_GENERATOR::Move(), PCB_GROUP::Move(), PCB_TEXT::Move(), ZONE::Outline(), pad, FOOTPRINT::Pads(), PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_PAD_T, PCB_TEXT_T, PCB_ZONE_T, RECURSE, COMMIT::Remove(), ZONE::RemoveAllContours(), repeatedOutline(), BOARD_ITEM::ResetUuid(), BOARD_ITEM::ResetUuidDirect(), PCB_GENERATOR::Rotate(), PCB_GROUP::Rotate(), PCB_TEXT::Rotate(), PCB_GROUP::RunOnChildren(), RULE_AREA::ScansContents(), EDA_TEXT::SetAttributes(), BOARD_ITEM::SetIsKnockout(), BOARD_ITEM::SetLayer(), BOARD_ITEM::SetLayerSet(), EDA_ITEM::SetParentGroup(), PCB_TEXT::SetPosition(), PCB_TEXT::SetTextAngle(), EDA_TEXT::SetVisible(), traceMultichannelTool, EDA_ITEM::Type(), and ZONE::UnHatchBorder().

Referenced by applyRepeat(), and RepeatLayout().

◆ detachArea()

void MULTICHANNEL_TOOL::detachArea	(	BOARD_COMMIT &	aCommit,
		ZONE *	aZone )

private

Definition at line 2636 of file multichannel_tool.cpp.

References BOARD_ITEM::GetBoard(), COMMIT::Modify(), niluuid, ZONE::SetLinkSet(), and ZONE::SetRepeatOptions().

Referenced by dropLoneLinks(), and UnlinkAreas().

◆ DiscoverRepeatCandidates()

void MULTICHANNEL_TOOL::DiscoverRepeatCandidates ( bool aLoose )

Definition at line 1509 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board(), buildRAOutline(), SHAPE::Centre(), DESIGN_BLOCK, findMatches(), group, GROUP_PLACEMENT, m_areas, RULE_AREA::m_center, RULE_AREA::m_components, m_focusArea, RULE_AREA::m_fromSelection, RULE_AREA::m_group, RULE_AREA::m_sourceType, RULE_AREA::m_zone, makePlacementArea(), PROF_TIMER::to_string(), traceMultichannelTool, and updateSelectionCore().

Referenced by StartRepeatFromSelection().

◆ displayOptions()

PCBNEW_SETTINGS::DISPLAY_OPTIONS & PCB_TOOL_BASE::displayOptions ( ) const

protectedinherited

Definition at line 342 of file pcb_tool_base.cpp.

References frame().

Referenced by PCB_CONTROL::AppendBoard(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::InlineDrag(), POSITION_RELATIVE_TOOL::InteractiveOffset(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PCB_CONTROL::RatsnestModeCycle(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), and PCB_CONTROL::ViaDisplayMode().

◆ doInteractiveItemPlacement()

void PCB_TOOL_BASE::doInteractiveItemPlacement	(	const TOOL_EVENT &	aTool,
		INTERACTIVE_PLACER_BASE *	aPlacer,
		const wxString &	aCommitMessage,
		int	aOptions = IPO_ROTATE \| IPO_FLIP \| IPO_REPEAT )

protectedinherited

Helper function for performing a common interactive idiom: wait for a left click, place an item there (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc.

More complex interactive processes are not supported here, you should implement a customised event loop for those.

Parameters

aTool
aPlacer
aCommitMessage	the message used on a successful commit
aOptions

Definition at line 39 of file pcb_tool_base.cpp.

References TOOL_INTERACTIVE::Activate(), KIGFX::PCB_VIEW::Add(), KIGFX::VIEW_GROUP::Add(), SELECTION::Add(), PCB_ACTIONS::angleSnapModeChanged, ARROW, board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), EDA_ITEM::ClearFlags(), controls(), INTERACTIVE_PLACER_BASE::CreateItem(), ACTIONS::cursorClick, ACTIONS::cursorDblClick, DIRECT, PCB_ACTIONS::flip, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), frame(), FRAME_FOOTPRINT_EDITOR, FRAME_PCB_EDITOR, GetAppSettings(), TOOL_EVT_UTILS::GetEventRotationAngle(), EDA_ITEM::GetFlags(), TOOL_BASE::GetManager(), KIGFX::VIEW_CONTROLS::GetMousePosition(), TOOL_BASE::getView(), grid, IPO_FLIP, IPO_REPEAT, IPO_ROTATE, IPO_SINGLE_CLICK, TOOL_EVT_UTILS::IsRotateToolEvt(), PCB_VIEWERS_SETTINGS_BASE::VIEWERS_DISPLAY_OPTIONS::m_AngleSnapMode, INTERACTIVE_PLACER_BASE::m_board, INTERACTIVE_PLACER_BASE::m_frame, TOOL_INTERACTIVE::m_menu, INTERACTIVE_PLACER_BASE::m_modifiers, TOOL_BASE::m_toolMgr, PCB_VIEWERS_SETTINGS_BASE::m_ViewersDisplay, NO_RECURSE, PENCIL, PLACE, INTERACTIVE_PLACER_BASE::PlaceItem(), PCB_ACTIONS::properties, BOARD_COMMIT::Push(), ACTIONS::refreshPreview, KIGFX::PCB_VIEW::Remove(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, selection(), ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_ITEM::SetFlags(), KIGFX::VIEW_CONTROLS::ShowCursor(), INTERACTIVE_PLACER_BASE::SnapItem(), TC_COMMAND, PCB_ACTIONS::trackViaSizeChanged, KIGFX::PCB_VIEW::Update(), view(), and TOOL_INTERACTIVE::Wait().

Referenced by MICROWAVE_TOOL::addMicrowaveFootprint(), DRAWING_TOOL::DrawVia(), PAD_TOOL::PlacePad(), and DRAWING_TOOL::PlacePoint().

◆ dropLoneLinks()

void MULTICHANNEL_TOOL::dropLoneLinks	(	BOARD_COMMIT &	aCommit,
		const std::set< KIID > &	aSets )

private

Definition at line 2687 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board(), and detachArea().

Referenced by linkAreas(), and UnlinkAreas().

◆ expandSelection()

int MULTICHANNEL_TOOL::expandSelection ( bool aLargest )

private

Definition at line 1701 of file multichannel_tool.cpp.

References _, collectGroupFootprints(), ExpandToMatchingTopology(), PCB_TOOL_BASE::frame(), TOOL_BASE::m_toolMgr, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_TOOL_BASE::selection(), ACTIONS::selectionClear, and ACTIONS::selectItems.

Referenced by expandToLargestTopology(), and expandToMatchingTopology().

◆ expandToLargestTopology()

int MULTICHANNEL_TOOL::expandToLargestTopology ( const TOOL_EVENT & aEvent )

private

Definition at line 1695 of file multichannel_tool.cpp.

References expandSelection().

Referenced by setTransitions().

◆ ExpandToMatchingTopology()

std::set< FOOTPRINT * > MULTICHANNEL_TOOL::ExpandToMatchingTopology	(	const std::set< FOOTPRINT * > &	aSeed,
		bool	aLargest )

Grow aSeed with the parts next to it, keeping only sets that still have an exact twin elsewhere on the board.

One step adds a layer of neighbours. The largest form repeats that until nothing more fits, after first trying the whole sheet instance.

Definition at line 1586 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board(), buildNetOwners(), findMatches(), RULE_AREA_COMPAT_DATA::m_searchLimit, path, and result.

Referenced by expandSelection().

◆ expandToMatchingTopology()

int MULTICHANNEL_TOOL::expandToMatchingTopology ( const TOOL_EVENT & aEvent )

private

Definition at line 1689 of file multichannel_tool.cpp.

References expandSelection().

Referenced by setTransitions().

◆ findComponentsInRuleArea()

bool MULTICHANNEL_TOOL::findComponentsInRuleArea	(	RULE_AREA *	aRuleArea,
		std::set< FOOTPRINT * > &	aComponents )

private

◆ FindExistingRuleAreas()

void MULTICHANNEL_TOOL::FindExistingRuleAreas ( )

Definition at line 938 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board(), COMPONENT_CLASS, DESIGN_BLOCK, findComponentsInRuleArea(), findPlacementGroup(), GROUP_PLACEMENT, m_areas, RULE_AREA::m_center, RULE_AREA::m_componentClass, RULE_AREA::m_components, RULE_AREA::m_group, RULE_AREA::m_groupName, RULE_AREA::m_ruleName, RULE_AREA::m_sheetPath, RULE_AREA::m_sourceType, RULE_AREA::m_zone, SHEETNAME, and traceMultichannelTool.

◆ findMatches()

std::vector< RULE_AREA_COMPAT_DATA > MULTICHANNEL_TOOL::findMatches	(	const std::set< FOOTPRINT * > &	aSelected,
		bool	aLoose )

private

The channels elsewhere on the board that repeat the topology of aSelected.

Definition at line 1377 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board(), buildNetOwners(), channelNets(), FOOTPRINT::GetFPID(), isChannelNet(), RULE_AREA::m_components, RULE_AREA_COMPAT_DATA::m_discovered, RULE_AREA_COMPAT_DATA::m_searchLimit, matchSheetInstances(), pad, padNets(), and resolveConnectionTopology().

Referenced by DiscoverRepeatCandidates(), and ExpandToMatchingTopology().

◆ findOtherItemsInRuleArea()

bool MULTICHANNEL_TOOL::findOtherItemsInRuleArea	(	RULE_AREA *	aRuleArea,
		std::set< BOARD_ITEM * > &	aItems )

private

◆ findPlacementGroup()

PCB_GROUP * MULTICHANNEL_TOOL::findPlacementGroup ( const wxString & aGroupName ) const

private

Definition at line 735 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board(), and group.

Referenced by FindExistingRuleAreas().

◆ findRepeatRouting()

std::set< BOARD_CONNECTED_ITEM * > MULTICHANNEL_TOOL::findRepeatRouting	(	RULE_AREA *	aArea,
		const std::set< int > &	aNets,
		const REPEAT_LAYOUT_OPTIONS &	aOpts )

private

The routing of aArea on aNets, the only nets a repeat ever carries.

Unless the options restrict it to the area, each run of routing continues to the first segment outside of it.

Definition at line 2144 of file multichannel_tool.cpp.

References EDA_GROUP::AsEdaItem(), PCB_TOOL_BASE::board(), CN_ITEM::ConnectedItems(), findRoutingInRuleArea(), BOARD::GetConnectivity(), linkedChannelGroup(), REPEAT_LAYOUT_OPTIONS::m_connectedRoutingOnly, next(), PCB_ARC_T, PCB_GENERATOR_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, and EDA_ITEM::Type().

Referenced by applySelectionRepeat(), and copyRuleAreaContents().

◆ findRoutingInRuleArea()

int MULTICHANNEL_TOOL::findRoutingInRuleArea	(	RULE_AREA *	aRuleArea,
		std::set< BOARD_CONNECTED_ITEM * > &	aOutput ) const

private

Definition at line 2914 of file multichannel_tool.cpp.

References LIBEVAL::VALUE::AsDouble(), KIID::AsString(), SHAPE_POLY_SET::BBox(), PCB_TOOL_BASE::board(), SHAPE_POLY_SET::BooleanSubtract(), collectGroupBoardItems(), LIBEVAL::COMPILER::Compile(), BOX2< Vec >::Contains(), DESIGN_BLOCK, ERROR_OUTSIDE, BOARD::GetDesignSettings(), ZONE::GetLayerSet(), EDA_ITEM::GetParentGroup(), group, GROUP_PLACEMENT, BOX2< Vec >::Intersects(), BOARD_CONNECTED_ITEM::IsConnected(), SHAPE_POLY_SET::IsEmpty(), linkedChannelGroup(), RULE_AREA::m_designBlockItems, RULE_AREA::m_fromSelection, BOARD_DESIGN_SETTINGS::m_MaxError, RULE_AREA::m_sourceType, EDA_ITEM::m_Uuid, RULE_AREA::m_zone, ZONE::Outline(), PCB_GENERATOR_T, PCB_PAD_T, PCB_ZONE_T, LIBEVAL::UCODE::Run(), LIBEVAL::COMPILER::SetErrorCallback(), LIBEVAL::CONTEXT::SetErrorCallback(), PCBEXPR_CONTEXT::SetItems(), traceMultichannelTool, and EDA_ITEM::Type().

Referenced by copyRuleAreaContents(), and findRepeatRouting().

◆ fixupNet()

void MULTICHANNEL_TOOL::fixupNet	(	BOARD_CONNECTED_ITEM *	aRef,
		BOARD_CONNECTED_ITEM *	aTarget,
		bool	aHasMatches,
		const std::map< int, int > &	aNetMap )

private

Attempts to make sure copied items are assigned the right net.

Definition at line 3811 of file multichannel_tool.cpp.

References BOARD_CONNECTED_ITEM::GetNetCode(), and BOARD_CONNECTED_ITEM::SetNetCode().

Referenced by copyRuleAreaContents().

◆ footprint()

FOOTPRINT * PCB_TOOL_BASE::footprint ( ) const

inlineprotectedinherited

Definition at line 189 of file pcb_tool_base.h.

References board(), and BOARD::GetFirstFootprint().

◆ frame()

template<class T = PCB_BASE_EDIT_FRAME>

T * PCB_TOOL_BASE::frame ( ) const

inlineprotectedinherited

Definition at line 182 of file pcb_tool_base.h.

References TOOL_BASE::getEditFrame(), and T.

◆ GeneratePotentialRuleAreas()

void MULTICHANNEL_TOOL::GeneratePotentialRuleAreas ( )

Definition at line 857 of file multichannel_tool.cpp.

References EDA_GROUP::AsEdaItem(), PCB_TOOL_BASE::board(), COMPONENT_CLASS, COMPONENT_CLASS::GetConstituentClasses(), EDA_ITEM::GetParentGroup(), getParentSheetPaths(), GROUP_PLACEMENT, m_areas, RULE_AREA::m_componentClass, RULE_AREA::m_components, RULE_AREA::m_generateEnabled, RULE_AREA::m_groupName, RULE_AREA::m_sheetName, RULE_AREA::m_sheetPath, RULE_AREA::m_sourceType, queryComponentsInComponentClass(), queryComponentsInGroup(), queryComponentsInSheet(), SHEETNAME, and traceMultichannelTool.

Referenced by AutogenerateRuleAreas(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and checkGroupChannelRepeatLayout().

◆ GetAngleSnapMode()

LEADER_MODE PCB_TOOL_BASE::GetAngleSnapMode ( ) const

inherited

Get the current angle snapping mode.

Definition at line 379 of file pcb_tool_base.cpp.

References frame(), FRAME_PCB_EDITOR, and GetAppSettings().

Referenced by EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::drawManagedShape(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), Is45Limited(), Is90Limited(), DRAWING_TOOL::PlaceMicroviaStack(), and DRAWING_TOOL::UpdateStatusBar().

◆ GetAutoConstraints()

bool PCB_TOOL_BASE::GetAutoConstraints ( ) const

inherited

Should drawing tools author constraints automatically?

Definition at line 388 of file pcb_tool_base.cpp.

References frame(), FRAME_PCB_EDITOR, and GetAppSettings().

Referenced by DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawEllipseArc(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::drawShape(), and DRAWING_TOOL::runSimpleShapeDraw().

◆ GetData()

RULE_AREAS_DATA * MULTICHANNEL_TOOL::GetData ( )

inline

◆ getEditFrame()

template<typename T>

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

Return the application window object, casted to requested user type.

Definition at line 182 of file tool_base.h.

References getToolHolderInternal(), and T.

◆ GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Return the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns: Identifier of the tool.

Definition at line 119 of file tool_base.h.

References m_toolId.

Referenced by TOOL_MANAGER::finishTool(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::isActive(), TOOL_MANAGER::RegisterTool(), ACTION_MANAGER::RunHotKey(), TOOL_MANAGER::runTool(), and TOOL_MANAGER::saveViewControls().

◆ GetManager()

TOOL_MANAGER * TOOL_BASE::GetManager ( ) const

inlineinherited

Return the instance of TOOL_MANAGER that takes care of the tool.

Returns: Instance of the TOOL_MANAGER or NULL if there is no associated tool manager.

Definition at line 142 of file tool_base.h.

References m_toolMgr, and TOOL_MANAGER.

Referenced by MULTICHANNEL_TOOL::applySelectionRepeat(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), PCB_TOOL_BASE::doInteractiveItemPlacement(), PCB_TUNING_PATTERN::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_TUNING_PATTERN::EditStart(), makeShapeModificationMenu(), PAD_TOOL::PlacePad(), MULTICHANNEL_TOOL::RepeatLayout(), MULTICHANNEL_TOOL::RepeatLayout(), SCH_COMMIT::SCH_COMMIT(), MULTICHANNEL_TOOL::UnlinkAreas(), PCB_TUNING_PATTERN::Update(), MULTICHANNEL_TOOL::UpdateLinkedLayouts(), MULTICHANNEL_TOOL::UpdateRepeatPreview(), and GLOBAL_EDIT_TOOL::ZonesManager().

◆ getModel()

template<typename T>

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Definition at line 195 of file tool_base.h.

References getModelInternal(), and T.

◆ getModelInternal()

EDA_ITEM * TOOL_BASE::getModelInternal ( ) const

privateinherited

Definition at line 52 of file tool_base.cpp.

References m_toolMgr.

Referenced by getModel().

◆ GetName()

const std::string & TOOL_BASE::GetName ( ) const

inlineinherited

Return the name of the tool.

Tool names are expected to obey the format: application.ToolName (eg. pcbnew.InteractiveSelection).

Returns: The name of the tool.

Definition at line 132 of file tool_base.h.

References m_toolName.

Referenced by PCB_CONTROL::AppendBoard(), TOOL_MANAGER::dispatchInternal(), COMMON_TOOLS::GridProperties(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::invokeTool(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::runTool(), SCH_TOOL_BASE< SCH_BASE_FRAME >::SetContextMenu(), and TOOL_MANAGER::ShutdownTool().

◆ getToolHolderInternal()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInternal ( ) const

privateinherited

Definition at line 46 of file tool_base.cpp.

References m_toolMgr.

Referenced by getEditFrame().

◆ GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inherited

Definition at line 108 of file tool_interactive.cpp.

References m_menu.

Referenced by BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), FOOTPRINT_CHOOSER_SELECTION_TOOL::Init(), GENERATOR_TOOL::Init(), MULTICHANNEL_TOOL::Init(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), SCH_EDIT_TOOL::Init(), and SYMBOL_EDITOR_EDIT_TOOL::Init().

◆ GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns: The type of the tool.

Definition at line 107 of file tool_base.h.

References m_type.

Referenced by TOOL_MANAGER::InvokeTool(), TOOL_MANAGER::InvokeTool(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::runTool(), TOOL_MANAGER::ShutdownTool(), and TOOL_MANAGER::ShutdownTool().

◆ getView()

KIGFX::VIEW * TOOL_BASE::getView ( ) const

protectedinherited

Return the instance of KIGFX::VIEW object used in the application.

It allows tools to draw.

Returns: The instance of KIGFX::VIEW.

Definition at line 34 of file tool_base.cpp.

References m_toolMgr.

◆ getViewControls()

KIGFX::VIEW_CONTROLS * TOOL_BASE::getViewControls ( ) const

protectedinherited

Return the instance of VIEW_CONTROLS object used in the application.

It allows tools to read & modify user input and its settings (eg. show cursor, enable snapping to grid, etc.).

Returns: The instance of VIEW_CONTROLS.

Definition at line 40 of file tool_base.cpp.

References m_toolMgr.

Referenced by PCB_POINT_EDITOR::addCorner(), SCH_SELECTION_TOOL::autostartEvent(), PCB_POINT_EDITOR::chamferCorner(), PCB_SELECTION_TOOL::controls(), PCB_TEST_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), EDIT_TOOL::copyToClipboard(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), COMMON_TOOLS::doZoomToPreset(), PCB_SELECTION_TOOL::DragSelectionArea(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNetChain(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_TOOL_BASE< T >::Increment(), EDIT_TOOL::Init(), POSITION_RELATIVE_TOOL::InteractiveOffset(), PCB_PICKER_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_POINT_EDITOR::makePoints(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), CONSTRAINT_EDIT_TOOL::onHoverMotion(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceTuningPattern(), EDIT_TOOL::Properties(), PL_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), DIFF_PHASE_SKEW_TOOL::Reset(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), MATCH_PROPERTIES_TOOL::runInteractive(), DRAWING_TOOL::runSimpleShapeDraw(), PCB_SELECTION_TOOL::selectCursor(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::SelectNode(), PCB_SELECTION_TOOL::SelectPolyArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PCB_PICKER_TOOL::setControls(), PICKER_TOOL::setControls(), PCB_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew(), PCB_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PL_EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

◆ Go()

template<class T>

void TOOL_INTERACTIVE::Go	(	int(T::*	aStateFunc )(const TOOL_EVENT &),
		const TOOL_EVENT_LIST &	aConditions = TOOL_EVENT( TC_ANY, TA_ANY ) )

inherited

Define which state (aStateFunc) to go when a certain event arrives (aConditions).

No conditions means any event.

Definition at line 143 of file tool_interactive.h.

References goInternal(), and T.

◆ goInternal()

void TOOL_INTERACTIVE::goInternal	(	TOOL_STATE_FUNC &	aState,
		const TOOL_EVENT_LIST &	aConditions )

privateinherited

Definition at line 80 of file tool_interactive.cpp.

Referenced by Go().

◆ hideMovedRatsnest()

void MULTICHANNEL_TOOL::hideMovedRatsnest ( )

private

Definition at line 2128 of file multichannel_tool.cpp.

References CONNECTIVITY_DATA::BlockRatsnestItems(), PCB_TOOL_BASE::board(), PCB_TOOL_BASE::canvas(), BOARD::GetConnectivity(), m_previewBoxes, moved, and PCB_DRAW_PANEL_GAL::RedrawRatsnest().

Referenced by UpdateRepeatPreview().

◆ HighlightRepeatAreas()

void MULTICHANNEL_TOOL::HighlightRepeatAreas ( const RULE_AREA * aArea )

Mark the reference parts, and the parts of aArea if given, on the board while the dialog is open.

Definition at line 2195 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::canvas(), FOOTPRINT::GetBoundingBox(), BOX2< Vec >::GetEnd(), BOX2< Vec >::GetOrigin(), TOOL_BASE::getView(), m_areas, RULE_AREA::m_components, m_focusArea, m_highlight, m_previewBoxes, m_previewRatsnest, moved, pcbIUScale, EDA_DRAW_PANEL_GAL::Refresh(), and PCB_TOOL_BASE::view().

Referenced by UpdateRepeatPreview().

◆ Init()

bool MULTICHANNEL_TOOL::Init ( )

overrideprivatevirtual

Init() is called once upon a registration of the tool.

Returns: True if the initialization went fine, false - otherwise.

Reimplemented from PCB_TOOL_BASE.

Definition at line 398 of file multichannel_tool.cpp.

References CONDITIONAL_MENU::AddMenu(), TOOL_MENU::GetMenu(), TOOL_INTERACTIVE::GetToolMenu(), SELECTION_CONDITIONS::HasTypes(), TOOL_BASE::m_toolMgr, and TOOL_MENU::RegisterSubMenu().

◆ Is45Limited()

bool PCB_TOOL_BASE::Is45Limited ( ) const

virtualinherited

Should the tool use its 45° mode option?

Returns: True if set to use 45°

Definition at line 369 of file pcb_tool_base.cpp.

References DIRECT, and GetAngleSnapMode().

Referenced by PCB_POINT_EDITOR::OnSelectionChange().

◆ Is90Limited()

bool PCB_TOOL_BASE::Is90Limited ( ) const

virtualinherited

Should the tool limit drawing to horizontal and vertical only?

Definition at line 374 of file pcb_tool_base.cpp.

References DEG90, and GetAngleSnapMode().

Referenced by PCB_POINT_EDITOR::OnSelectionChange(), and PCB_POINT_EDITOR::setAltConstraint().

◆ IsBoardEditor()

bool PCB_TOOL_BASE::IsBoardEditor ( ) const

inlineinherited

Definition at line 108 of file pcb_tool_base.h.

References m_isBoardEditor.

Referenced by makeMirrorRotateMenu().

◆ IsFootprintEditor()

bool PCB_TOOL_BASE::IsFootprintEditor ( ) const

inlineinherited

Definition at line 105 of file pcb_tool_base.h.

References m_isFootprintEditor.

Referenced by CONSTRAINT_EDIT_TOOL::constraintParent(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), CONSTRAINT_EDIT_TOOL::Init(), CONVERT_TOOL::OutsetItems(), and CONSTRAINT_EDIT_TOOL::RemoveConstraints().

◆ IsolateDesignBlockAutoNets()

std::vector< NETINFO_ITEM * > MULTICHANNEL_TOOL::IsolateDesignBlockAutoNets	(	BOARD *	aBoard,
		const std::set< FOOTPRINT * > &	aFootprints,
		const std::unordered_set< EDA_ITEM * > &	aItems )

static

Remap auto-generated nets (Net-(...), unconnected-...) of a design block that was appended for layout matching onto fresh private nets, so they cannot fuse by name with same-named nets that belong to different parts on the board (issue 24767).

Returns the created nets so the caller can remove them after the temporary block is reverted.

Definition at line 3829 of file multichannel_tool.cpp.

References BOARD::Add(), BOARD::FindNet(), NETINFO_ITEM::GetNetname(), name, and pad.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), and BOOST_FIXTURE_TEST_CASE().

◆ IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 28 of file tool_base.cpp.

References m_toolId, and m_toolMgr.

Referenced by EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::Drag(), ROUTER_TOOL::handleLayerSwitch(), EDIT_TOOL::invokeInlineRouter(), PCB_SELECTION_TOOL::Main(), ROUTER_TOOL::onViaStackCommand(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

◆ JoinReferences()

wxString MULTICHANNEL_TOOL::JoinReferences ( const std::set< FOOTPRINT * > & aFootprints )

static

Definition at line 1971 of file multichannel_tool.cpp.

Referenced by DIALOG_MULTICHANNEL_REPEAT_LAYOUT::TransferDataToWindow(), and updateSelectionCore().

◆ linkAreas()

void MULTICHANNEL_TOOL::linkAreas	(	BOARD_COMMIT &	aCommit,
		ZONE *	aRefZone,
		const std::vector< RULE_AREA * > &	aTargets )

private

Link aTargets and aRefZone into one set with their own copies of the options.

Definition at line 2646 of file multichannel_tool.cpp.

References anchor, anchorPair(), dropLoneLinks(), BOARD_ITEM::GetBoard(), ZONE::GetLinkSet(), REPEAT_LAYOUT_OPTIONS::m_anchor, m_areas, COMMIT::Modify(), niluuid, ZONE::SetLinkSet(), and ZONE::SetRepeatOptions().

Referenced by applySelectionRepeat(), and RepeatLayout().

◆ onRepeatDialogClosed()

void MULTICHANNEL_TOOL::onRepeatDialogClosed ( wxCloseEvent & aEvent )

private

Definition at line 2300 of file multichannel_tool.cpp.

References clearRepeatPreview(), m_areas, m_dialog, m_focusArea, and onRepeatDialogClosed().

Referenced by onRepeatDialogClosed(), and repeatLayout().

◆ pruneExistingGroups()

bool MULTICHANNEL_TOOL::pruneExistingGroups	(	COMMIT &	aCommit,
		const std::unordered_set< BOARD_ITEM * > &	aItemsToCheck )

private

Definition at line 4129 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board(), group, COMMIT::Modify(), and COMMIT::Remove().

Referenced by applyRepeat(), and AutogenerateRuleAreas().

◆ queryBoardItemsInGroup()

std::set< BOARD_ITEM * > MULTICHANNEL_TOOL::queryBoardItemsInGroup ( const wxString & aGroupName ) const

private

Definition at line 754 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board(), and group.

Referenced by AutogenerateRuleAreas().

◆ queryComponentsInComponentClass()

std::set< FOOTPRINT * > MULTICHANNEL_TOOL::queryComponentsInComponentClass ( const wxString & aComponentClassName ) const

private

Definition at line 707 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board().

Referenced by GeneratePotentialRuleAreas().

◆ queryComponentsInGroup()

std::set< FOOTPRINT * > MULTICHANNEL_TOOL::queryComponentsInGroup ( const wxString & aGroupName ) const

private

Definition at line 721 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board(), collectGroupFootprints(), and group.

Referenced by GeneratePotentialRuleAreas().

◆ queryComponentsInSheet()

std::set< FOOTPRINT * > MULTICHANNEL_TOOL::queryComponentsInSheet ( wxString aSheetName ) const

private

Definition at line 682 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board().

Referenced by applySelectionRepeat(), and GeneratePotentialRuleAreas().

◆ RefreshRepeat()

void MULTICHANNEL_TOOL::RefreshRepeat ( )

Re-derive the channels after a tick or the anchor changed, then redraw the preview.

Definition at line 1983 of file multichannel_tool.cpp.

References m_areas, UpdateRepeatPreview(), and updateSelectionCore().

◆ RepeatLayout() [1/2]

int MULTICHANNEL_TOOL::RepeatLayout	(	const TOOL_EVENT &	aEvent,
		RULE_AREA &	aRefArea,
		RULE_AREA &	aTargetArea,
		REPEAT_LAYOUT_OPTIONS &	aOptions,
		BOARD_COMMIT *	aExternalCommit = nullptr,
		wxString *	aErrorOut = nullptr )

◆ RepeatLayout() [2/2]

int MULTICHANNEL_TOOL::RepeatLayout	(	const TOOL_EVENT &	aEvent,
		ZONE *	aRefZone )

Definition at line 2609 of file multichannel_tool.cpp.

References _, applyRepeat(), PCB_TOOL_BASE::frame(), TOOL_BASE::GetManager(), linkAreas(), m_areas, Pgm(), and BOARD_COMMIT::Push().

◆ repeatLayout()

int MULTICHANNEL_TOOL::repeatLayout ( const TOOL_EVENT & aEvent )

private

◆ Reset()

void MULTICHANNEL_TOOL::Reset ( RESET_REASON aReason )

overrideprivatevirtual

Bring the tool to a known, initial state.

If the tool claimed anything from the model or the view, it must release it when its reset.

Parameters

aReason contains information about the reason of tool reset.

Reimplemented from PCB_TOOL_BASE.

Definition at line 216 of file multichannel_tool.cpp.

References closeRepeatDialog(), TOOL_BASE::MODEL_RELOAD, PCB_TOOL_BASE::Reset(), TOOL_BASE::SHUTDOWN, and TOOL_BASE::SUPERMODEL_RELOAD.

◆ resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

Clear the current transition map and restores the default one created by setTransitions().

Definition at line 73 of file tool_interactive.cpp.

◆ resolveConnectionTopology()

bool MULTICHANNEL_TOOL::resolveConnectionTopology	(	RULE_AREA *	aRefArea,
		RULE_AREA *	aTargetArea,
		RULE_AREA_COMPAT_DATA &	aMatches,
		const TMATCH::ISOMORPHISM_PARAMS &	aParams = {},
		const std::unordered_set< int > &	aExtraGlobalNets = {} )

private

◆ resolveTopologies()

bool MULTICHANNEL_TOOL::resolveTopologies	(	const wxString &	aTitle,
		const std::vector< TOPOLOGY_JOB > &	aJobs )

private

Resolve the topology of each job in turn on a worker thread.

In the GUI a progress dialog titled aTitle shows how far the matching got, and the board and the Repeat dialog are disabled until it closes. Jobs not finished when the user cancels are marked as not OK.

Returns: false if the user cancelled.

Definition at line 2351 of file multichannel_tool.cpp.

References _, PCB_TOOL_BASE::frame(), TMATCH::ISOMORPHISM_PARAMS::m_cancelled, m_dialog, TMATCH::ISOMORPHISM_PARAMS::m_matchedComponents, TMATCH::ISOMORPHISM_PARAMS::m_totalComponents, Pgm(), PR_CAN_ABORT, reporter, and resolveConnectionTopology().

Referenced by CheckRACompatibility(), UpdateLinkedLayouts(), and updateSelectionCore().

◆ routerBusy()

bool MULTICHANNEL_TOOL::routerBusy ( ) const

private

Definition at line 2705 of file multichannel_tool.cpp.

References TOOL_BASE::m_toolMgr, and ROUTER_TOOL::RoutingInProgress().

Referenced by updateLinkedLayouts().

◆ RunMainStack()

void TOOL_INTERACTIVE::RunMainStack ( std::function< void()> aFunc )

inherited

Call a function using the main stack.

Parameters

aFunc is the function to be calls.

Definition at line 102 of file tool_interactive.cpp.

Referenced by DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawTable(), KICAD_MANAGER_CONTROL::NewProject(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceText(), BOARD_EDITOR_CONTROL::ShowEeschema(), and BOARD_EDITOR_CONTROL::UpdatePCBFromSchematic().

◆ selection() [1/2]

PCB_SELECTION & PCB_TOOL_BASE::selection ( )

protectedinherited

Definition at line 361 of file pcb_tool_base.cpp.

References PCB_SELECTION_TOOL::GetSelection(), and TOOL_BASE::m_toolMgr.

◆ selection() [2/2]

const PCB_SELECTION & PCB_TOOL_BASE::selection ( ) const

protectedinherited

Definition at line 353 of file pcb_tool_base.cpp.

References PCB_SELECTION_TOOL::GetSelection(), and TOOL_BASE::m_toolMgr.

◆ SetContextMenu()

void TOOL_INTERACTIVE::SetContextMenu	(	ACTION_MENU *	aMenu,
		CONTEXT_MENU_TRIGGER	aTrigger = CMENU_BUTTON )

inherited

Assign a context menu and tells when it should be activated.

Parameters

aMenu	is the menu to be assigned.
aTrigger	determines conditions upon which the context menu is activated.

Definition at line 91 of file tool_interactive.cpp.

References CMENU_OFF, TOOL_BASE::m_toolMgr, and ACTION_MENU::SetTool().

Referenced by SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::DrawVia(), and PCB_SELECTION_TOOL::Main().

◆ SetIsBoardEditor()

void PCB_TOOL_BASE::SetIsBoardEditor ( bool aEnabled )

inlineinherited

Definition at line 107 of file pcb_tool_base.h.

References m_isBoardEditor.

◆ SetIsFootprintEditor()

void PCB_TOOL_BASE::SetIsFootprintEditor ( bool aEnabled )

inlineinherited

Toggle edit footprint mode.

When enabled, one may select parts of footprints individually (graphics, pads, etc.), so they can be modified.

Parameters

aEnabled decides if the mode should be enabled.

Definition at line 104 of file pcb_tool_base.h.

References m_isFootprintEditor.

◆ setPreviewHidden()

void MULTICHANNEL_TOOL::setPreviewHidden ( bool aHide )

private

Definition at line 2275 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::board(), TOOL_BASE::getView(), m_previewHidden, NO_RECURSE, BOARD::ResolveItem(), BOARD_ITEM::RunOnChildren(), and PCB_TOOL_BASE::view().

Referenced by clearRepeatPreview(), and UpdateRepeatPreview().

◆ setTransitions()

void MULTICHANNEL_TOOL::setTransitions ( )

overrideprivatevirtual

This method is meant to be overridden in order to specify handlers for events.

It is called every time tool is reset or finished.

Reimplemented from PCB_TOOL_BASE.

Definition at line 416 of file multichannel_tool.cpp.

References AutogenerateRuleAreas(), expandToLargestTopology(), PCB_ACTIONS::expandToLargestTopology, expandToMatchingTopology(), PCB_ACTIONS::expandToMatchingTopology, PCB_ACTIONS::generatePlacementRuleAreas, TOOL_INTERACTIVE::Go(), repeatLayout(), PCB_ACTIONS::repeatLayout, unlinkLayout(), PCB_ACTIONS::unlinkLayout, updateLinkedLayouts(), and PCB_ACTIONS::updateLinkedLayouts.

◆ ShowMismatchDetails()

void MULTICHANNEL_TOOL::ShowMismatchDetails	(	wxWindow *	aParent,
		const wxString &	aSummary,
		const std::vector< wxString > &	aReasons ) const

Definition at line 390 of file multichannel_tool.cpp.

References PCB_TOOL_BASE::frame(), and ShowTopologyMismatchReasons().

◆ StartRepeatFromSelection()

void MULTICHANNEL_TOOL::StartRepeatFromSelection ( const std::vector< EDA_ITEM * > & aItems )

Use plain selected items as the reference and discover the channels that repeat them.

Definition at line 1328 of file multichannel_tool.cpp.

References collectGroupBoardItems(), DiscoverRepeatCandidates(), BOARD_ITEM::GetParentFootprint(), m_areas, PCB_FOOTPRINT_T, PCB_GROUP_T, and EDA_ITEM::Type().

Referenced by repeatLayout().

◆ UnlinkAreas()

void MULTICHANNEL_TOOL::UnlinkAreas ( const std::set< ZONE * > & aZones )

Remove aZones from their link sets, and any area left alone in one, as one undo step.

Definition at line 2753 of file multichannel_tool.cpp.

References _, detachArea(), dropLoneLinks(), TOOL_BASE::GetManager(), niluuid, and BOARD_COMMIT::Push().

Referenced by BOOST_FIXTURE_TEST_CASE(), and unlinkLayout().

◆ unlinkLayout()

int MULTICHANNEL_TOOL::unlinkLayout ( const TOOL_EVENT & aEvent )

private

Definition at line 2740 of file multichannel_tool.cpp.

References _, PCB_TOOL_BASE::frame(), linkedAreasIn(), PCB_TOOL_BASE::selection(), and UnlinkAreas().

Referenced by setTransitions().

◆ UpdateLinkedLayouts()

bool MULTICHANNEL_TOOL::UpdateLinkedLayouts ( ZONE * aSource )

Copy aSource onto the other areas of its link set, as one undo step.

Returns true if anything was copied.

Definition at line 2771 of file multichannel_tool.cpp.

References _, applyRepeat(), PCB_TOOL_BASE::board(), closeRepeatDialog(), copied, FindExistingRuleAreas(), PCB_TOOL_BASE::frame(), ZONE::GetLinkSet(), TOOL_BASE::GetManager(), ZONE::GetRepeatOptions(), JoinMismatchReasons(), linkedChannelGroup(), m_areas, RULE_AREA::m_components, RULE_AREA_COMPAT_DATA::m_doCopy, RULE_AREA_COMPAT_DATA::m_errorMsg, RULE_AREA_COMPAT_DATA::m_isOk, RULE_AREA_COMPAT_DATA::m_matchingComponents, RULE_AREA::m_ruleName, RULE_AREA::m_zone, niluuid, ZONE::Outline(), outlinesOverlap(), Pgm(), BOARD_COMMIT::Push(), repeatedOutline(), resolveTopologies(), and SKIP_ENTERED_GROUP.

Referenced by BOOST_FIXTURE_TEST_CASE(), and updateLinkedLayouts().

◆ updateLinkedLayouts()

int MULTICHANNEL_TOOL::updateLinkedLayouts ( const TOOL_EVENT & aEvent )

private

Definition at line 2716 of file multichannel_tool.cpp.

References _, PCB_TOOL_BASE::frame(), linkedAreasIn(), routerBusy(), PCB_TOOL_BASE::selection(), and UpdateLinkedLayouts().

Referenced by setTransitions().

◆ UpdatePickedItem()

void MULTICHANNEL_TOOL::UpdatePickedItem ( const EDA_ITEM * aItem )

overridevirtual

Implements PCB_PICKER_TOOL::RECEIVER.

Definition at line 983 of file multichannel_tool.cpp.

References TOOL_BASE::m_toolMgr, and PCB_ACTIONS::repeatLayout.

◆ UpdatePickedPoint()

void MULTICHANNEL_TOOL::UpdatePickedPoint ( const std::optional< VECTOR2I > & aPoint )

inlineoverridevirtual

Implements PCB_PICKER_TOOL::RECEIVER.

Definition at line 121 of file multichannel_tool.h.

◆ UpdateRepeatPreview()

void MULTICHANNEL_TOOL::UpdateRepeatPreview ( )

◆ updateSelectionCore()

bool MULTICHANNEL_TOOL::updateSelectionCore ( )

private

Returns: false if the user cancelled the topology check.

Definition at line 1738 of file multichannel_tool.cpp.

References _, ZONE::AddPolygon(), BOX2< Vec >::GetArea(), FOOTPRINT::GetBoundingBox(), JoinReferences(), m_areas, RULE_AREA::m_components, RULE_AREA::m_designBlockItems, RULE_AREA_COMPAT_DATA::m_errorMsg, RULE_AREA_COMPAT_DATA::m_isOk, RULE_AREA_COMPAT_DATA::m_matchingComponents, RULE_AREA_COMPAT_DATA::m_unmatched, EDA_ITEM::m_Uuid, RULE_AREA::m_zone, niluuid, PCB_FOOTPRINT_T, ZONE::RemoveAllContours(), repeatedOutline(), resolveTopologies(), and EDA_ITEM::Type().

Referenced by DiscoverRepeatCandidates(), and RefreshRepeat().

◆ view()

KIGFX::PCB_VIEW * PCB_TOOL_BASE::view ( ) const

inlineprotectedinherited

Definition at line 171 of file pcb_tool_base.h.

References TOOL_BASE::getView().

Referenced by AUTOPLACE_TOOL::autoplace(), MULTICHANNEL_TOOL::clearRepeatPreview(), BOARD_INSPECTION_TOOL::CompareBoardWithHistory(), doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), MICROWAVE_TOOL::drawMicrowaveInductor(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PAD_TOOL::ExitPadEditMode(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::highlightNet(), MULTICHANNEL_TOOL::HighlightRepeatAreas(), ROUTER_TOOL::InlineDrag(), POSITION_RELATIVE_TOOL::InteractiveOffset(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), PAD_TOOL::OnUndoRedo(), ROUTER_TOOL::performDragging(), DRAWING_TOOL::PlaceSubGrid(), PCB_CONTROL::RehatchShapes(), PCB_POINT_EDITOR::Reset(), GRAPHIC_EDIT_TOOL::runInteractive(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), MULTICHANNEL_TOOL::setPreviewHidden(), BOARD_INSPECTION_TOOL::showBoardComparison(), PCB_CONTROL::TrackDisplayMode(), PCB_POINT_EDITOR::updateItem(), MULTICHANNEL_TOOL::UpdateRepeatPreview(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), and GLOBAL_EDIT_TOOL::ZonesManager().

◆ Wait()

TOOL_EVENT * TOOL_INTERACTIVE::Wait ( const TOOL_EVENT_LIST & aEventList = TOOL_EVENT( TC_ANY, TA_ANY ) )

inherited

Suspend execution of the tool until an event specified in aEventList arrives.

No parameters means waiting for any event.

Definition at line 67 of file tool_interactive.cpp.

References TOOL_BASE::m_toolMgr.

Referenced by CONSTRAINT_EDIT_TOOL::AddPointConstraint(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::DragSelectionArea(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawManagedShape(), MICROWAVE_TOOL::drawMicrowaveInductor(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), POSITION_RELATIVE_TOOL::InteractiveOffset(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), GERBVIEW_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PCB_TEST_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), ZOOM_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), BOARD_INSPECTION_TOOL::pickItemForInspection(), CONSTRAINT_EDIT_TOOL::pickLinearConstraint(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), CONSTRAINT_EDIT_TOOL::pickShapeConstraint(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), GRAPHIC_EDIT_TOOL::runInteractive(), MATCH_PROPERTIES_TOOL::runInteractive(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), and DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew().

Member Data Documentation

◆ m_areas

RULE_AREAS_DATA MULTICHANNEL_TOOL::m_areas

private

◆ m_dialog

DIALOG_MULTICHANNEL_REPEAT_LAYOUT* MULTICHANNEL_TOOL::m_dialog = nullptr

private

Definition at line 263 of file multichannel_tool.h.

Referenced by closeRepeatDialog(), onRepeatDialogClosed(), repeatLayout(), and resolveTopologies().

◆ m_focusArea

const RULE_AREA* MULTICHANNEL_TOOL::m_focusArea = nullptr

private

Definition at line 266 of file multichannel_tool.h.

Referenced by DiscoverRepeatCandidates(), HighlightRepeatAreas(), onRepeatDialogClosed(), and UpdateRepeatPreview().

◆ m_highlight

std::shared_ptr<KIGFX::VIEW_OVERLAY> MULTICHANNEL_TOOL::m_highlight

private

Definition at line 265 of file multichannel_tool.h.

Referenced by clearRepeatPreview(), and HighlightRepeatAreas().

◆ m_isBoardEditor

bool PCB_TOOL_BASE::m_isBoardEditor

protectedinherited

Definition at line 204 of file pcb_tool_base.h.

Referenced by IsBoardEditor(), PCB_TOOL_BASE(), PCB_TOOL_BASE(), PCB_CONTROL::placeBoardItems(), SetIsBoardEditor(), and PCB_CONTROL::UpdateMessagePanel().

◆ m_isFootprintEditor

bool PCB_TOOL_BASE::m_isFootprintEditor

protectedinherited

Definition at line 203 of file pcb_tool_base.h.

◆ m_menu

std::unique_ptr<TOOL_MENU> TOOL_INTERACTIVE::m_menu

protectedinherited

The functions below are not yet implemented - their interface may change.

Definition at line 121 of file tool_interactive.h.

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawManagedShape(), MICROWAVE_TOOL::drawMicrowaveInductor(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), GetToolMenu(), BOARD_EDITOR_CONTROL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), DRAWING_TOOL::Init(), EDA_3D_CONTROLLER::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), GERBVIEW_SELECTION_TOOL::Init(), PAD_TOOL::Init(), PCB_DESIGN_BLOCK_CONTROL::Init(), PCB_PICKER_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_TOOL_BASE::Init(), PCB_VIEWER_TOOLS::Init(), PICKER_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), ROUTER_TOOL::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SCH_SELECTION_TOOL::Init(), ZOOM_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), GERBVIEW_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), ZOOM_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE(), and TOOL_INTERACTIVE().

◆ m_previewBoxes

std::map<FOOTPRINT*, BOX2I> MULTICHANNEL_TOOL::m_previewBoxes

private

Definition at line 267 of file multichannel_tool.h.

Referenced by clearRepeatPreview(), hideMovedRatsnest(), HighlightRepeatAreas(), and UpdateRepeatPreview().

◆ m_previewHidden

std::vector<KIID> MULTICHANNEL_TOOL::m_previewHidden

private

Definition at line 264 of file multichannel_tool.h.

Referenced by clearRepeatPreview(), setPreviewHidden(), and UpdateRepeatPreview().

◆ m_previewRatsnest

std::vector<SEG> MULTICHANNEL_TOOL::m_previewRatsnest

private

Definition at line 268 of file multichannel_tool.h.

Referenced by clearRepeatPreview(), HighlightRepeatAreas(), and UpdateRepeatPreview().

◆ m_reporter

std::unique_ptr<REPORTER> MULTICHANNEL_TOOL::m_reporter

private

Definition at line 261 of file multichannel_tool.h.

◆ m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Unique id, assigned by a TOOL_MANAGER instance.

Definition at line 215 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), GetId(), IsToolActive(), and TOOL_BASE().

◆ m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 220 of file tool_base.h.

◆ m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Names are expected to obey the format application.ToolName (eg.

pcbnew.InteractiveSelection).

Definition at line 219 of file tool_base.h.

Referenced by GetName(), and TOOL_BASE().

◆ m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

Definition at line 214 of file tool_base.h.

Referenced by GetType(), and TOOL_BASE().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ INTERACTIVE_PLACEMENT_OPTIONS

◆ RESET_REASON

Constructor & Destructor Documentation

◆ MULTICHANNEL_TOOL()

◆ ~MULTICHANNEL_TOOL()

Member Function Documentation

◆ Activate()

◆ ApplyRepeat()

◆ applyRepeat()

◆ applySelectionRepeat()

◆ attachManager()

◆ AutogenerateRuleAreas()

◆ board()

◆ buildRAOutline() [1/2]

◆ buildRAOutline() [2/2]

◆ canvas()

◆ ChannelZone()

◆ CheckRACompatibility()

◆ clearRepeatPreview()

◆ closeRepeatDialog()

◆ controls()

◆ copyRuleAreaContents()

◆ detachArea()

◆ DiscoverRepeatCandidates()

◆ displayOptions()

◆ doInteractiveItemPlacement()

◆ dropLoneLinks()

◆ expandSelection()

◆ expandToLargestTopology()

◆ ExpandToMatchingTopology()

◆ expandToMatchingTopology()

◆ findComponentsInRuleArea()

◆ FindExistingRuleAreas()

◆ findMatches()

◆ findOtherItemsInRuleArea()

◆ findPlacementGroup()

◆ findRepeatRouting()

◆ findRoutingInRuleArea()

◆ fixupNet()

◆ footprint()

◆ frame()

◆ GeneratePotentialRuleAreas()

◆ GetAngleSnapMode()

◆ GetAutoConstraints()

◆ GetData()

◆ getEditFrame()

◆ GetId()

◆ GetManager()

◆ getModel()

◆ getModelInternal()

◆ GetName()

◆ getToolHolderInternal()

◆ GetToolMenu()

◆ GetType()

◆ getView()

◆ getViewControls()

◆ Go()

◆ goInternal()

◆ hideMovedRatsnest()

◆ HighlightRepeatAreas()

◆ Init()

◆ Is45Limited()

◆ Is90Limited()

◆ IsBoardEditor()

◆ IsFootprintEditor()

◆ IsolateDesignBlockAutoNets()

◆ IsToolActive()

◆ JoinReferences()

◆ linkAreas()