The selection tool: currently supports: More...

#include <pcb_selection_tool.h>

Inheritance diagram for PCB_SELECTION_TOOL:

Classes
class	PRIV
	Private implementation of firewalled private data. More...

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

Public Member Functions
	PCB_SELECTION_TOOL ()

	~PCB_SELECTION_TOOL ()

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

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

void	OnIdle (wxIdleEvent &aEvent)

bool	IsFootprintEditor ()

int	Main (const TOOL_EVENT &aEvent)
	The main loop. More...

PCB_SELECTION &	GetSelection ()

PCB_SELECTION &	RequestSelection (CLIENT_SELECTION_FILTER aClientFilter, bool aConfirmLockedItems=false)
	Return the current selection, filtered according to aClientFilter. More...

int	CursorSelection (const TOOL_EVENT &aEvent)
	Clear current selection event handler. More...

int	ClearSelection (const TOOL_EVENT &aEvent)

void	ClearSelection (bool aQuietMode=false)
	Select all items on the board. More...

int	SelectAll (const TOOL_EVENT &aEvent)

void	FindItem (BOARD_ITEM *aItem)
	Take necessary actions to mark an item as found. More...

void	select (EDA_ITEM *aItem) override
	Take necessary action mark an item as selected. More...

bool	Selectable (const BOARD_ITEM *aItem, bool checkVisibilityOnly=false) const

void	SelectAllItemsOnNet (int aNetCode, bool aSelect=true)
	Select all items with the given net code. More...

void	GuessSelectionCandidates (GENERAL_COLLECTOR &aCollector, const VECTOR2I &aWhere) const
	Try to guess best selection candidates in case multiple items are clicked, by doing some brain-dead heuristics. More...

void	RebuildSelection ()
	Rebuild the selection from the EDA_ITEMs' selection flags. More...

SELECTION_FILTER_OPTIONS &	GetFilter ()
	Set up handlers for various events. More...

void	setTransitions () override
	Zoom the screen to center and fit the current selection. More...

void	zoomFitSelection ()
	Zoom the screen to fit the bounding box for cross probing/selection sync. More...

void	ZoomFitCrossProbeBBox (const BOX2I &bbox)

void	EnterGroup ()
	Enter the group at the head of the current selection. More...

void	ExitGroup (bool aSelectGroup=false)
	Leave the currently-entered group. More...

PCB_GROUP *	GetEnteredGroup ()

PCB_LAYER_ID	GetActiveLayer ()

void	FilterCollectorForHierarchy (GENERAL_COLLECTOR &aCollector, bool aMultiselect) const
	In general we don't want to select both a parent and any of it's children. More...

void	FilterCollectorForFreePads (GENERAL_COLLECTOR &aCollector) const
	Check the "allow free pads" setting and if disabled, replace any pads in the collector with their parent footprints. More...

void	FilterCollectorForMarkers (GENERAL_COLLECTOR &aCollector) const
	Drop any PCB_MARKERs from the collector. More...

void	FilterCollectedItems (GENERAL_COLLECTOR &aCollector, bool aMultiSelect)
	Apply the SELECTION_FITLER_OPTIONS to the collector. More...

int	UpdateMenu (const TOOL_EVENT &aEvent)
	Update a menu's state based on the current selection. More...

int	AddItemToSel (const TOOL_EVENT &aEvent)

void	AddItemToSel (EDA_ITEM *aItem, bool aQuietMode=false)

int	AddItemsToSel (const TOOL_EVENT &aEvent)

void	AddItemsToSel (EDA_ITEMS *aList, bool aQuietMode=false)

int	RemoveItemFromSel (const TOOL_EVENT &aEvent)

void	RemoveItemFromSel (EDA_ITEM *aItem, bool aQuietMode=false)

int	RemoveItemsFromSel (const TOOL_EVENT &aEvent)

void	RemoveItemsFromSel (EDA_ITEMS *aList, bool aQuietMode=false)

void	RemoveItemsFromSel (std::vector< KIID > *aList, bool aQuietMode=false)
	A safer version of RemoveItemsFromSel( EDA_ITEMS ) which doesn't require the items to still exist. More...

void	BrightenItem (EDA_ITEM *aItem)

void	UnbrightenItem (EDA_ITEM *aItem)

int	SelectionMenu (const TOOL_EVENT &aEvent)
	Show a popup menu to trim the COLLECTOR passed as aEvent's parameter down to a single item. More...

void	Activate ()
	Run the tool. More...

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. More...

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

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

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. More...

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

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

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

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

bool	IsToolActive () const

Protected Member Functions
KIGFX::PCB_VIEW *	view () const

KIGFX::VIEW_CONTROLS *	controls () const

PCB_BASE_EDIT_FRAME *	frame () const

BOARD *	board () const

PCB_DRAW_PANEL_GAL *	canvas () const

virtual bool	ctrlClickHighlights () override
	Determines if ctrl-click is highlight net or XOR selection. More...

SELECTION &	selection () override
	Return a reference to the selection. More...

void	onDisambiguationExpire (wxTimerEvent &aEvent)
	Start the process to show our disambiguation menu once the user has kept the mouse down for the minimum time. More...

void	setModifiersState (bool aShiftState, bool aCtrlState, bool aAltState)
	Set the configuration of m_additive, m_subtractive, m_exclusive_or, m_skip_heuristics from the state of modifier keys SHIFT, CTRL, ALT and depending on the OS. More...

bool	hasModifier ()
	True if a selection modifier is enabled, false otherwise. More...

bool	doSelectionMenu (COLLECTOR *aCollector)

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

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

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

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

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

Protected Attributes
bool	m_additive

bool	m_subtractive

bool	m_exclusive_or

bool	m_multiple

bool	m_skip_heuristics

bool	m_highlight_modifier

bool	m_drag_additive

bool	m_drag_subtractive

bool	m_canceledMenu

wxTimer	m_disambiguateTimer

VECTOR2I	m_originalCursor

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

TOOL_TYPE	m_type
	Unique identifier for the tool, assigned by a TOOL_MANAGER instance. More...

TOOL_ID	m_toolId
	Name of the tool. More...

std::string	m_toolName

TOOL_MANAGER *	m_toolMgr

Private Types
enum	STOP_CONDITION { STOP_AT_JUNCTION , STOP_AT_PAD , STOP_NEVER }

Private Member Functions
bool	selectPoint (const VECTOR2I &aWhere, bool aOnDrag=false, bool *aSelectionCancelledFlag=nullptr, CLIENT_SELECTION_FILTER aClientFilter=nullptr)
	Select an item pointed by the parameter aWhere. More...

bool	selectCursor (bool aForceSelect=false, CLIENT_SELECTION_FILTER aClientFilter=nullptr)
	Select an item under the cursor unless there is something already selected. More...

bool	selectMultiple ()
	Handle drawing a selection box that allows one to select many items at the same time. More...

int	disambiguateCursor (const TOOL_EVENT &aEvent)
	Handle disambiguation actions including displaying the menu. More...

int	expandConnection (const TOOL_EVENT &aEvent)
	Expand the current connected-item selection to the next boundary (junctions, pads, or all) More...

int	unrouteSelected (const TOOL_EVENT &aEvent)
	Unroute the selected board connected items. More...

int	selectNet (const TOOL_EVENT &aEvent)
	Select all copper connections belonging to the same net(s) as the items in the selection. More...

int	selectUnconnected (const TOOL_EVENT &aEvent)
	Select nearest unconnected footprints on same net as selected items. More...

int	grabUnconnected (const TOOL_EVENT &aEvent)
	Select and move other nearest footprint unconnected on same net as selected items. More...

void	selectAllConnectedTracks (const std::vector< BOARD_CONNECTED_ITEM * > &aStartItems, STOP_CONDITION aStopCondition)
	Select connected tracks and vias. More...

void	selectConnections (const std::vector< BOARD_ITEM * > &aItems)

void	selectAllItemsOnSheet (wxString &aSheetPath)
	Select all items with the given sheet timestamp/UUID name (the sheet path). More...

int	selectSheetContents (const TOOL_EVENT &aEvent)
	Select all footprints belonging to same hierarchical sheet as the selected footprint (same sheet path). More...

int	selectSameSheet (const TOOL_EVENT &aEvent)
	Set selection to items passed by parameter and connected nets (optionally). More...

int	syncSelection (const TOOL_EVENT &aEvent)

int	syncSelectionWithNets (const TOOL_EVENT &aEvent)

void	doSyncSelection (const std::vector< BOARD_ITEM * > &aItems, bool aWithNets)
	Invoke filter dialog and modify current selection. More...

int	filterSelection (const TOOL_EVENT &aEvent)
	Return true if the given item passes the current SELECTION_FILTER_OPTIONS. More...

bool	itemPassesFilter (BOARD_ITEM *aItem, bool aMultiSelect)

void	unselect (EDA_ITEM *aItem) override
	Take necessary action mark an item as unselected. More...

void	highlight (EDA_ITEM aItem, int aHighlightMode, SELECTION aGroup=nullptr) override
	Highlight the item visually. More...

void	unhighlight (EDA_ITEM aItem, int aHighlightMode, SELECTION aGroup=nullptr) override
	Unhighlight the item visually. More...

bool	selectionContains (const VECTOR2I &aPoint) const

int	hitTestDistance (const VECTOR2I &aWhere, BOARD_ITEM *aItem, int aMaxDistance) const

int	updateSelection (const TOOL_EVENT &aEvent)
	Event handler to update the selection VIEW_ITEM. More...

const GENERAL_COLLECTORS_GUIDE	getCollectorsGuide () const

void	highlightInternal (EDA_ITEM *aItem, int aHighlightMode, bool aUsingOverlay)

void	unhighlightInternal (EDA_ITEM *aItem, int aHighlightMode, bool aUsingOverlay)

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

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

EDA_ITEM *	getModelInt () const

TOOLS_HOLDER *	getToolHolderInt () const

Private Attributes
PCB_BASE_FRAME *	m_frame

bool	m_isFootprintEditor

PCB_SELECTION	m_selection

SELECTION_FILTER_OPTIONS	m_filter

KICURSOR	m_nonModifiedCursor

PCB_GROUP *	m_enteredGroup

KIGFX::VIEW_GROUP	m_enteredGroupOverlay

std::unique_ptr< PRIV >	m_priv

Detailed Description

The selection tool: currently supports:

pick single objects (click LMB)
add objects to existing selection (Shift+LMB)
draw selection box (drag LMB)
handles FOOTPRINTs properly (i.e. selects either FOOTPRINT or its PADs, TEXTs, etc.)
takes into account high-contrast & layer visibility settings
invokes InteractiveEdit tool when user starts to drag selected items

Definition at line 64 of file pcb_selection_tool.h.

Member Enumeration Documentation

◆ 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 (required full reload)
GAL_SWITCH	Rendering engine changes.
REDRAW	Full drawing refresh.

Definition at line 77 of file tool_base.h.

 {
 RUN, 
 MODEL_RELOAD, 
 GAL_SWITCH, 
 REDRAW 
 };

◆ STOP_CONDITION

enum PCB_SELECTION_TOOL::STOP_CONDITION

private

Enumerator

STOP_AT_JUNCTION

Stop at any place where more than two traces meet.

Because vias are also traces, this makes selection stop at a via if there is a trace on another layer as well, but a via with only one connection will be selected.

STOP_AT_PAD

Stop when reaching a pad.

STOP_NEVER

Select the entire net.

Definition at line 311 of file pcb_selection_tool.h.

 {
 STOP_AT_JUNCTION,
 STOP_AT_PAD,
 STOP_NEVER
 };

Constructor & Destructor Documentation

◆ PCB_SELECTION_TOOL()

PCB_SELECTION_TOOL::PCB_SELECTION_TOOL ( )

Definition at line 115 of file pcb_selection_tool.cpp.

 :
 SELECTION_TOOL( "pcbnew.InteractiveSelection" ),
 m_frame( nullptr ),
 m_isFootprintEditor( false ),
 m_nonModifiedCursor( KICURSOR::ARROW ),
 m_enteredGroup( nullptr ),
 m_priv( std::make_unique<PRIV>() )
{
 m_filter.lockedItems = false;
 m_filter.footprints = true;
 m_filter.text = true;
 m_filter.tracks = true;
 m_filter.vias = true;
 m_filter.pads = true;
 m_filter.graphics = true;
 m_filter.zones = true;
 m_filter.keepouts = true;
 m_filter.dimensions = true;
 m_filter.otherItems = true;
}

References ARROW, SELECTION_FILTER_OPTIONS::dimensions, SELECTION_FILTER_OPTIONS::footprints, SELECTION_FILTER_OPTIONS::graphics, SELECTION_FILTER_OPTIONS::keepouts, SELECTION_FILTER_OPTIONS::lockedItems, m_filter, SELECTION_FILTER_OPTIONS::otherItems, SELECTION_FILTER_OPTIONS::pads, SELECTION_FILTER_OPTIONS::text, SELECTION_FILTER_OPTIONS::tracks, SELECTION_FILTER_OPTIONS::vias, and SELECTION_FILTER_OPTIONS::zones.

◆ ~PCB_SELECTION_TOOL()

PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL ( )

Definition at line 137 of file pcb_selection_tool.cpp.

{
 getView()->Remove( &m_selection );
 getView()->Remove( &m_enteredGroupOverlay );
 
 Disconnect( wxEVT_TIMER, wxTimerEventHandler( PCB_SELECTION_TOOL::onDisambiguationExpire ), nullptr, this );
}

References TOOL_BASE::getView(), m_enteredGroupOverlay, m_selection, SELECTION_TOOL::onDisambiguationExpire(), and KIGFX::VIEW::Remove().

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 51 of file tool_interactive.cpp.

{
 m_toolMgr->InvokeTool( m_toolId );
}

References TOOL_MANAGER::InvokeTool(), TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

Referenced by AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::copyToClipboard(), SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridSetOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), GROUP_TOOL::PickNewMember(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), DRAWING_TOOL::SetAnchor(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ AddItemsToSel() [1/2]

int SELECTION_TOOL::AddItemsToSel ( const TOOL_EVENT & aEvent )

inherited

Definition at line 128 of file selection_tool.cpp.

{
 AddItemsToSel( aEvent.Parameter<EDA_ITEMS*>(), false );
 selection().SetIsHover( false );
 return 0;
}

References SELECTION_TOOL::AddItemsToSel(), TOOL_EVENT::Parameter(), SELECTION_TOOL::selection(), and SELECTION::SetIsHover().

Referenced by SELECTION_TOOL::AddItemsToSel(), PCB_EDIT_FRAME::RebuildAndRefresh(), EE_SELECTION_TOOL::setTransitions(), PL_SELECTION_TOOL::setTransitions(), and setTransitions().

◆ AddItemsToSel() [2/2]

void SELECTION_TOOL::AddItemsToSel	(	EDA_ITEMS *	aList,
		bool	aQuietMode = `false`
	)

inherited

Definition at line 136 of file selection_tool.cpp.

{
 if( aList )
 {
 for( EDA_ITEM* item : *aList )
 select( item );
 
 // Inform other potentially interested tools
 if( !aQuietMode )
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 }
}

References TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::select(), and EVENTS::SelectedEvent.

◆ AddItemToSel() [1/2]

int SELECTION_TOOL::AddItemToSel ( const TOOL_EVENT & aEvent )

inherited

Definition at line 107 of file selection_tool.cpp.

{
 AddItemToSel( aEvent.Parameter<EDA_ITEM*>() );
 selection().SetIsHover( false );
 return 0;
}

References SELECTION_TOOL::AddItemToSel(), TOOL_EVENT::Parameter(), SELECTION_TOOL::selection(), and SELECTION::SetIsHover().

Referenced by SELECTION_TOOL::AddItemToSel(), SCH_EDIT_TOOL::BreakWire(), SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EDIT_TOOL::doMoveSelection(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), EDIT_TOOL::FilletTracks(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), DIALOG_INSPECTOR::onCellClicked(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), EE_SELECTION_TOOL::setTransitions(), PL_SELECTION_TOOL::setTransitions(), setTransitions(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ AddItemToSel() [2/2]

void SELECTION_TOOL::AddItemToSel	(	EDA_ITEM *	aItem,
		bool	aQuietMode = `false`
	)

inherited

Definition at line 115 of file selection_tool.cpp.

{
 if( aItem )
 {
 select( aItem );
 
 // Inform other potentially interested tools
 if( !aQuietMode )
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 }
}

References TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::select(), and EVENTS::SelectedEvent.

◆ 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 60 of file tool_base.cpp.

{
 m_toolMgr = aManager;
}

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

◆ board()

BOARD * PCB_SELECTION_TOOL::board ( ) const

inlineprotected

Definition at line 230 of file pcb_selection_tool.h.

 {
 return getModel<BOARD>();
 }

Referenced by filterSelection(), getCollectorsGuide(), grabUnconnected(), RebuildSelection(), Selectable(), selectAllConnectedTracks(), SelectAllItemsOnNet(), selectAllItemsOnSheet(), selectConnections(), selectMultiple(), selectPoint(), and selectUnconnected().

◆ BrightenItem()

void SELECTION_TOOL::BrightenItem ( EDA_ITEM * aItem )

inherited

Definition at line 207 of file selection_tool.cpp.

{
 highlight( aItem, BRIGHTENED );
}

References BRIGHTENED, and SELECTION_TOOL::highlight().

Referenced by SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_FIND_REPLACE_TOOL::FindNext(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ canvas()

PCB_DRAW_PANEL_GAL * PCB_SELECTION_TOOL::canvas ( ) const

inlineprotected

Definition at line 235 of file pcb_selection_tool.h.

 {
 return static_cast<PCB_DRAW_PANEL_GAL*>( frame()->GetCanvas() );
 }

References frame(), and PCB_BASE_FRAME::GetCanvas().

Referenced by FindItem().

◆ ClearSelection() [1/2]

void PCB_SELECTION_TOOL::ClearSelection ( bool aQuietMode = false )

Select all items on the board.

Definition at line 2307 of file pcb_selection_tool.cpp.

{
 if( m_selection.Empty() )
 return;
 
 while( m_selection.GetSize() )
 unhighlight( m_selection.Front(), SELECTED, &m_selection );
 
 view()->Update( &m_selection );
 
 m_selection.SetIsHover( false );
 m_selection.ClearReferencePoint();
 
 // Inform other potentially interested tools
 if( !aQuietMode )
 {
 m_toolMgr->ProcessEvent( EVENTS::ClearedEvent );
 m_toolMgr->RunAction( PCB_ACTIONS::hideLocalRatsnest, true );
 }
}

References EVENTS::ClearedEvent, SELECTION::ClearReferencePoint(), SELECTION::Empty(), SELECTION::Front(), SELECTION::GetSize(), PCB_ACTIONS::hideLocalRatsnest, m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), TOOL_MANAGER::RunAction(), SELECTED, SELECTION::SetIsHover(), unhighlight(), KIGFX::PCB_VIEW::Update(), and view().

◆ ClearSelection() [2/2]

int PCB_SELECTION_TOOL::ClearSelection ( const TOOL_EVENT & aEvent )

Definition at line 1071 of file pcb_selection_tool.cpp.

{
 ClearSelection();
 
 return 0;
}

References ClearSelection().

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), ClearSelection(), EDIT_TOOL::copyToClipboard(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::doMoveSelection(), doSyncSelection(), EnterGroup(), ExitGroup(), filterSelection(), FindItem(), grabUnconnected(), GROUP_TOOL::Group(), Main(), RequestSelection(), Reset(), selectCursor(), selectMultiple(), selectPoint(), selectSameSheet(), selectSheetContents(), setTransitions(), and unrouteSelected().

◆ controls()

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

inlineprotected

Definition at line 220 of file pcb_selection_tool.h.

 {
 return getViewControls();
 }

References TOOL_BASE::getViewControls().

◆ ctrlClickHighlights()

bool PCB_SELECTION_TOOL::ctrlClickHighlights ( )

overrideprotectedvirtual

Determines if ctrl-click is highlight net or XOR selection.

Reimplemented from SELECTION_TOOL.

Definition at line 706 of file pcb_selection_tool.cpp.

{
 return m_frame && m_frame->GetPcbNewSettings()->m_CtrlClickHighlight && !m_isFootprintEditor;
}

References PCB_BASE_FRAME::GetPcbNewSettings(), PCBNEW_SETTINGS::m_CtrlClickHighlight, m_frame, and m_isFootprintEditor.

◆ CursorSelection()

int PCB_SELECTION_TOOL::CursorSelection ( const TOOL_EVENT & aEvent )

Clear current selection event handler.

Definition at line 1061 of file pcb_selection_tool.cpp.

{
 CLIENT_SELECTION_FILTER aClientFilter = aEvent.Parameter<CLIENT_SELECTION_FILTER>();
 
 selectCursor( false, aClientFilter );
 
 return 0;
}

References TOOL_EVENT::Parameter(), and selectCursor().

Referenced by setTransitions().

◆ disambiguateCursor()

int PCB_SELECTION_TOOL::disambiguateCursor ( const TOOL_EVENT & aEvent )

private

Handle disambiguation actions including displaying the menu.

Definition at line 1045 of file pcb_selection_tool.cpp.

{
 wxMouseState keyboardState = wxGetMouseState();
 
 setModifiersState( keyboardState.ShiftDown(), keyboardState.ControlDown(),
 keyboardState.AltDown() );
 
 m_skip_heuristics = true;
 selectPoint( m_originalCursor, false, &m_canceledMenu );
 m_skip_heuristics = false;
 
 return 0;
}

References SELECTION_TOOL::m_canceledMenu, SELECTION_TOOL::m_originalCursor, SELECTION_TOOL::m_skip_heuristics, selectPoint(), and SELECTION_TOOL::setModifiersState().

Referenced by setTransitions().

◆ doSelectionMenu()

bool SELECTION_TOOL::doSelectionMenu ( COLLECTOR * aCollector )

protectedinherited

The user has requested the full, non-limited list of selection items

Definition at line 245 of file selection_tool.cpp.

{
 UNITS_PROVIDER* unitsProvider = getEditFrame<EDA_DRAW_FRAME>();
 EDA_ITEM* current = nullptr;
 SELECTION highlightGroup;
 bool selectAll = false;
 bool expandSelection = false;
 
 highlightGroup.SetLayer( LAYER_SELECT_OVERLAY );
 getView()->Add( &highlightGroup );
 
 do
 {
 if( expandSelection )
 aCollector->Combine();
 
 expandSelection = false;
 
 int limit = std::min( 100, aCollector->GetCount() );
 ACTION_MENU menu( true );
 
 for( int i = 0; i < limit; ++i )
 {
 EDA_ITEM* item = ( *aCollector )[i];
 wxString menuText;
 
 if( i < 9 )
 {
#ifdef __WXMAC__
 menuText = wxString::Format( "%s\t%d",
 item->GetItemDescription( unitsProvider ),
 i + 1 );
#else
 menuText = wxString::Format( "&%d %s\t%d",
 i + 1,
 item->GetItemDescription( unitsProvider ),
 i + 1 );
#endif
 }
 else
 {
 menuText = item->GetItemDescription( unitsProvider );
 }
 
 menu.Add( menuText, i + 1, item->GetMenuImage() );
 }
 
 menu.AppendSeparator();
 menu.Add( _( "Select &All\tA" ), limit + 1, BITMAPS::INVALID_BITMAP );
 
 if( !expandSelection && aCollector->HasAdditionalItems() )
 menu.Add( _( "&Expand Selection\tE" ), limit + 2, BITMAPS::INVALID_BITMAP );
 
 if( aCollector->m_MenuTitle.Length() )
 {
 menu.SetTitle( aCollector->m_MenuTitle );
 menu.SetIcon( BITMAPS::info );
 menu.DisplayTitle( true );
 }
 else
 {
 menu.DisplayTitle( false );
 }
 
 SetContextMenu( &menu, CMENU_NOW );
 
 while( TOOL_EVENT* evt = Wait() )
 {
 if( evt->Action() == TA_CHOICE_MENU_UPDATE )
 {
 if( selectAll )
 {
 for( int i = 0; i < aCollector->GetCount(); ++i )
 unhighlight( ( *aCollector )[i], BRIGHTENED, &highlightGroup );
 }
 else if( current )
 {
 unhighlight( current, BRIGHTENED, &highlightGroup );
 }
 
 int id = *evt->GetCommandId();
 
 // User has pointed an item, so show it in a different way
 if( id > 0 && id <= limit )
 {
 current = ( *aCollector )[id - 1];
 highlight( current, BRIGHTENED, &highlightGroup );
 }
 else
 {
 current = nullptr;
 }
 
 // User has pointed on the "Select All" option
 if( id == limit + 1 )
 {
 for( int i = 0; i < aCollector->GetCount(); ++i )
 highlight( ( *aCollector )[i], BRIGHTENED, &highlightGroup );
 
 selectAll = true;
 }
 else
 {
 selectAll = false;
 }
 }
 else if( evt->Action() == TA_CHOICE_MENU_CHOICE )
 {
 if( selectAll )
 {
 for( int i = 0; i < aCollector->GetCount(); ++i )
 unhighlight( ( *aCollector )[i], BRIGHTENED, &highlightGroup );
 }
 else if( current )
 {
 unhighlight( current, BRIGHTENED, &highlightGroup );
 }
 
 std::optional<int> id = evt->GetCommandId();
 
 // User has selected the "Select All" option
 if( id == limit + 1 )
 {
 selectAll = true;
 current = nullptr;
 }
 // User has selected the "Expand Selection" option
 else if( id == limit + 2 )
 {
 selectAll = false;
 current = nullptr;
 expandSelection = true;
 }
 // User has selected an item, so this one will be returned
 else if( id && ( *id > 0 ) && ( *id <= limit ) )
 {
 selectAll = false;
 current = ( *aCollector )[*id - 1];
 }
 // User has cancelled the menu (either by <esc> or clicking out of it)
 else
 {
 selectAll = false;
 current = nullptr;
 }
 }
 else if( evt->Action() == TA_CHOICE_MENU_CLOSED )
 {
 break;
 }
 
 getView()->UpdateItems();
 getEditFrame<EDA_DRAW_FRAME>()->GetCanvas()->Refresh();
 }
 } while( expandSelection );
 
 getView()->Remove( &highlightGroup );
 
 if( selectAll )
 {
 return true;
 }
 else if( current )
 {
 aCollector->Empty();
 aCollector->Append( current );
 return true;
 }
 
 return false;
}

References _, ACTION_MENU::Add(), KIGFX::VIEW::Add(), COLLECTOR::Append(), BRIGHTENED, CMENU_NOW, COLLECTOR::Combine(), ACTION_MENU::DisplayTitle(), COLLECTOR::Empty(), Format(), COLLECTOR::GetCount(), EDA_ITEM::GetItemDescription(), EDA_ITEM::GetMenuImage(), TOOL_BASE::getView(), COLLECTOR::HasAdditionalItems(), SELECTION_TOOL::highlight(), info, INVALID_BITMAP, LAYER_SELECT_OVERLAY, COLLECTOR::m_MenuTitle, KIGFX::VIEW::Remove(), TOOL_INTERACTIVE::SetContextMenu(), ACTION_MENU::SetIcon(), KIGFX::VIEW_GROUP::SetLayer(), ACTION_MENU::SetTitle(), TA_CHOICE_MENU_CHOICE, TA_CHOICE_MENU_CLOSED, TA_CHOICE_MENU_UPDATE, SELECTION_TOOL::unhighlight(), KIGFX::VIEW::UpdateItems(), and TOOL_INTERACTIVE::Wait().

Referenced by SELECTION_TOOL::SelectionMenu(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), selectPoint(), and EE_SELECTION_TOOL::selectPoint().

◆ doSyncSelection()

void PCB_SELECTION_TOOL::doSyncSelection	(	const std::vector< BOARD_ITEM * > &	aItems,
		bool	aWithNets
	)

private

Invoke filter dialog and modify current selection.

Definition at line 1752 of file pcb_selection_tool.cpp.

{
 ClearSelection( true /*quiet mode*/ );
 
 // Perform individual selection of each item before processing the event.
 for( BOARD_ITEM* item : aItems )
 select( item );
 
 if( aWithNets )
 selectConnections( aItems );
 
 BOX2I bbox = m_selection.GetBoundingBox();
 
 if( bbox.GetWidth() != 0 && bbox.GetHeight() != 0 )
 {
 if( m_frame->GetPcbNewSettings()->m_CrossProbing.center_on_items )
 {
 if( m_frame->GetPcbNewSettings()->m_CrossProbing.zoom_to_fit )
 ZoomFitCrossProbeBBox( bbox );
 
 m_frame->FocusOnLocation( bbox.Centre() );
 }
 }
 
 view()->UpdateAllLayersColor();
 
 m_frame->GetCanvas()->ForceRefresh();
 
 if( m_selection.Size() > 0 )
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
}

References CROSS_PROBING_SETTINGS::center_on_items, BOX2< Vec >::Centre(), ClearSelection(), EDA_DRAW_FRAME::FocusOnLocation(), EDA_DRAW_PANEL_GAL::ForceRefresh(), SELECTION::GetBoundingBox(), PCB_BASE_FRAME::GetCanvas(), BOX2< Vec >::GetHeight(), PCB_BASE_FRAME::GetPcbNewSettings(), BOX2< Vec >::GetWidth(), APP_SETTINGS_BASE::m_CrossProbing, m_frame, m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), select(), selectConnections(), EVENTS::SelectedEvent, SELECTION::Size(), KIGFX::VIEW::UpdateAllLayersColor(), view(), CROSS_PROBING_SETTINGS::zoom_to_fit, and ZoomFitCrossProbeBBox().

Referenced by syncSelection(), and syncSelectionWithNets().

◆ EnterGroup()

void PCB_SELECTION_TOOL::EnterGroup ( )

Enter the group at the head of the current selection.

Definition at line 502 of file pcb_selection_tool.cpp.

{
 wxCHECK_RET( m_selection.GetSize() == 1 && m_selection[0]->Type() == PCB_GROUP_T,
 wxT( "EnterGroup called when selection is not a single group" ) );
 PCB_GROUP* aGroup = static_cast<PCB_GROUP*>( m_selection[0] );
 
 if( m_enteredGroup != nullptr )
 ExitGroup();
 
 ClearSelection();
 m_enteredGroup = aGroup;
 m_enteredGroup->SetFlags( ENTERED );
 m_enteredGroup->RunOnChildren( [&]( BOARD_ITEM* titem )
 {
 select( titem );
 } );
 
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 
 view()->Hide( m_enteredGroup, true );
 m_enteredGroupOverlay.Add( m_enteredGroup );
 view()->Update( &m_enteredGroupOverlay );
}

References KIGFX::VIEW_GROUP::Add(), ClearSelection(), ENTERED, ExitGroup(), SELECTION::GetSize(), KIGFX::VIEW::Hide(), m_enteredGroup, m_enteredGroupOverlay, m_selection, TOOL_BASE::m_toolMgr, PCB_GROUP_T, TOOL_MANAGER::ProcessEvent(), PCB_GROUP::RunOnChildren(), select(), EVENTS::SelectedEvent, EDA_ITEM::SetFlags(), KIGFX::PCB_VIEW::Update(), and view().

Referenced by GROUP_TOOL::EnterGroup(), and Main().

◆ ExitGroup()

void PCB_SELECTION_TOOL::ExitGroup ( bool aSelectGroup = false )

Leave the currently-entered group.

Parameters

aSelectGroup [optional] Select the group after leaving.

Definition at line 527 of file pcb_selection_tool.cpp.

{
 // Only continue if there is a group entered
 if( m_enteredGroup == nullptr )
 return;
 
 m_enteredGroup->ClearFlags( ENTERED );
 view()->Hide( m_enteredGroup, false );
 ClearSelection();
 
 if( aSelectGroup )
 {
 select( m_enteredGroup );
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 }
 
 m_enteredGroupOverlay.Clear();
 m_enteredGroup = nullptr;
 view()->Update( &m_enteredGroupOverlay );
}

References KIGFX::VIEW_GROUP::Clear(), EDA_ITEM::ClearFlags(), ClearSelection(), ENTERED, KIGFX::VIEW::Hide(), m_enteredGroup, m_enteredGroupOverlay, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), select(), EVENTS::SelectedEvent, KIGFX::PCB_VIEW::Update(), and view().

Referenced by EDIT_TOOL::DeleteItems(), EnterGroup(), Main(), Reset(), select(), and selectPoint().

◆ expandConnection()

int PCB_SELECTION_TOOL::expandConnection ( const TOOL_EVENT & aEvent )

private

Expand the current connected-item selection to the next boundary (junctions, pads, or all)

Definition at line 1177 of file pcb_selection_tool.cpp.

{
 unsigned initialCount = 0;
 
 for( const EDA_ITEM* item : m_selection.GetItems() )
 {
 if( item->Type() == PCB_FOOTPRINT_T || BOARD_CONNECTED_ITEM::ClassOf( item ) )
 initialCount++;
 }
 
 if( initialCount == 0 )
 selectCursor( true, connectedItemFilter );
 
 m_frame->SetStatusText( _( "Select/Expand Connection..." ) );
 
 for( STOP_CONDITION stopCondition : { STOP_AT_JUNCTION, STOP_AT_PAD, STOP_NEVER } )
 {
 std::deque<EDA_ITEM*> selectedItems = m_selection.GetItems();
 
 for( EDA_ITEM* item : selectedItems )
 item->ClearTempFlags();
 
 std::vector<BOARD_CONNECTED_ITEM*> startItems;
 
 for( EDA_ITEM* item : selectedItems )
 {
 if( item->Type() == PCB_FOOTPRINT_T )
 {
 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( item );
 
 for( PAD* pad : footprint->Pads() )
 startItems.push_back( pad );
 }
 else if( BOARD_CONNECTED_ITEM::ClassOf( item ) )
 {
 startItems.push_back( static_cast<BOARD_CONNECTED_ITEM*>( item ) );
 }
 }
 
 selectAllConnectedTracks( startItems, stopCondition );
 
 if( m_selection.GetItems().size() > initialCount )
 break;
 }
 
 m_frame->SetStatusText( wxEmptyString );
 
 // Inform other potentially interested tools
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 
 return 0;
}

References _, BOARD_CONNECTED_ITEM::ClassOf(), connectedItemFilter(), SELECTION::GetItems(), m_frame, m_selection, TOOL_BASE::m_toolMgr, pad, FOOTPRINT::Pads(), PCB_FOOTPRINT_T, TOOL_MANAGER::ProcessEvent(), selectAllConnectedTracks(), selectCursor(), EVENTS::SelectedEvent, STOP_AT_JUNCTION, STOP_AT_PAD, and STOP_NEVER.

Referenced by setTransitions().

◆ FilterCollectedItems()

void PCB_SELECTION_TOOL::FilterCollectedItems	(	GENERAL_COLLECTOR &	aCollector,
		bool	aMultiSelect
	)

Apply the SELECTION_FITLER_OPTIONS to the collector.

Definition at line 2173 of file pcb_selection_tool.cpp.

{
 if( aCollector.GetCount() == 0 )
 return;
 
 std::set<BOARD_ITEM*> rejected;
 
 for( EDA_ITEM* i : aCollector )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( i );
 
 if( !itemPassesFilter( item, aMultiSelect ) )
 rejected.insert( item );
 }
 
 for( BOARD_ITEM* item : rejected )
 aCollector.Remove( item );
}

References COLLECTOR::GetCount(), itemPassesFilter(), and COLLECTOR::Remove().

Referenced by BOARD_INSPECTION_TOOL::highlightNet(), selectMultiple(), and selectPoint().

◆ FilterCollectorForFreePads()

void PCB_SELECTION_TOOL::FilterCollectorForFreePads ( GENERAL_COLLECTOR & aCollector ) const

Check the "allow free pads" setting and if disabled, replace any pads in the collector with their parent footprints.

Definition at line 3160 of file pcb_selection_tool.cpp.

{
 std::set<BOARD_ITEM*> to_add;
 
 // Iterate from the back so we don't have to worry about removals.
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 if( !m_isFootprintEditor && item->Type() == PCB_PAD_T
 && !frame()->GetPcbNewSettings()->m_AllowFreePads )
 {
 if( !aCollector.HasItem( item->GetParent() ) )
 to_add.insert( item->GetParent() );
 
 aCollector.Remove( item );
 }
 }
 
 for( BOARD_ITEM* item : to_add )
 aCollector.Append( item );
}

References COLLECTOR::Append(), frame(), COLLECTOR::GetCount(), BOARD_ITEM::GetParent(), COLLECTOR::HasItem(), m_isFootprintEditor, PCB_PAD_T, COLLECTOR::Remove(), and EDA_ITEM::Type().

Referenced by EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::Flip(), EDIT_TOOL::Mirror(), EDIT_TOOL::PackAndMoveFootprints(), EDIT_TOOL::Remove(), EDIT_TOOL::Rotate(), and EDIT_TOOL::Swap().

◆ FilterCollectorForHierarchy()

void PCB_SELECTION_TOOL::FilterCollectorForHierarchy	(	GENERAL_COLLECTOR &	aCollector,
		bool	aMultiselect
	)		const

In general we don't want to select both a parent and any of it's children.

This includes both footprints and their items, and groups and their members.

Definition at line 3092 of file pcb_selection_tool.cpp.

{
 std::unordered_set<BOARD_ITEM*> toAdd;
 
 // Set CANDIDATE on all parents which are included in the GENERAL_COLLECTOR. This
 // algorithm is O(3n), whereas checking for the parent inclusion could potentially be O(n^2).
 for( int j = 0; j < aCollector.GetCount(); j++ )
 {
 if( aCollector[j]->GetParent() )
 aCollector[j]->GetParent()->ClearFlags( CANDIDATE );
 }
 
 if( aMultiselect )
 {
 for( int j = 0; j < aCollector.GetCount(); j++ )
 aCollector[j]->SetFlags( CANDIDATE );
 }
 
 for( int j = 0; j < aCollector.GetCount(); )
 {
 BOARD_ITEM* item = aCollector[j];
 BOARD_ITEM* parent = item->GetParent();
 BOARD_ITEM* start = item;
 
 if( !m_isFootprintEditor && parent && parent->Type() == PCB_FOOTPRINT_T )
 start = parent;
 
 // If a group is entered, disallow selections of objects outside the group.
 if( m_enteredGroup && !PCB_GROUP::WithinScope( item, m_enteredGroup, m_isFootprintEditor ) )
 {
 aCollector.Remove( item );
 continue;
 }
 
 // If any element is a member of a group, replace those elements with the top containing
 // group.
 if( PCB_GROUP* top = PCB_GROUP::TopLevelGroup( start, m_enteredGroup, m_isFootprintEditor ) )
 {
 if( top != item )
 {
 toAdd.insert( top );
 top->SetFlags(CANDIDATE );
 
 aCollector.Remove( item );
 continue;
 }
 }
 
 // Footprints are a bit easier as they can't be nested.
 if( parent && ( parent->GetFlags() & CANDIDATE ) )
 {
 // Remove children of selected items
 aCollector.Remove( item );
 continue;
 }
 
 ++j;
 }
 
 for( BOARD_ITEM* item : toAdd )
 {
 if( !aCollector.HasItem( item ) )
 aCollector.Append( item );
 }
}

References COLLECTOR::Append(), CANDIDATE, COLLECTOR::GetCount(), EDA_ITEM::GetFlags(), BOARD_ITEM::GetParent(), COLLECTOR::HasItem(), m_enteredGroup, m_isFootprintEditor, PCB_FOOTPRINT_T, COLLECTOR::Remove(), PCB_GROUP::TopLevelGroup(), EDA_ITEM::Type(), and PCB_GROUP::WithinScope().

Referenced by EDIT_TOOL::CreateArray(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::Duplicate(), EDIT_TOOL::Flip(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), EDIT_TOOL::PackAndMoveFootprints(), POSITION_RELATIVE_TOOL::PositionRelative(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), EDIT_TOOL::Rotate(), SelectAll(), selectMultiple(), selectPoint(), and EDIT_TOOL::Swap().

◆ FilterCollectorForMarkers()

void PCB_SELECTION_TOOL::FilterCollectorForMarkers ( GENERAL_COLLECTOR & aCollector ) const

Drop any PCB_MARKERs from the collector.

Definition at line 3184 of file pcb_selection_tool.cpp.

{
 // Iterate from the back so we don't have to worry about removals.
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 if( item->Type() == PCB_MARKER_T )
 aCollector.Remove( item );
 }
}

References COLLECTOR::GetCount(), PCB_MARKER_T, COLLECTOR::Remove(), and EDA_ITEM::Type().

Referenced by EDIT_TOOL::CreateArray(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Duplicate(), EDIT_TOOL::Flip(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), EDIT_TOOL::PackAndMoveFootprints(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Rotate(), and EDIT_TOOL::Swap().

◆ filterSelection()

int PCB_SELECTION_TOOL::filterSelection ( const TOOL_EVENT & aEvent )

private

Return true if the given item passes the current SELECTION_FILTER_OPTIONS.

Definition at line 2141 of file pcb_selection_tool.cpp.

{
 const BOARD& board = *getModel<BOARD>();
 DIALOG_FILTER_SELECTION::OPTIONS& opts = m_priv->m_filterOpts;
 DIALOG_FILTER_SELECTION dlg( m_frame, opts );
 
 const int cmd = dlg.ShowModal();
 
 if( cmd != wxID_OK )
 return 0;
 
 // copy current selection
 std::deque<EDA_ITEM*> selection = m_selection.GetItems();
 
 ClearSelection( true /*quiet mode*/ );
 
 // re-select items from the saved selection according to the dialog options
 for( EDA_ITEM* i : selection )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( i );
 bool include = itemIsIncludedByFilter( *item, board, opts );
 
 if( include )
 select( item );
 }
 
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 
 return 0;
}

References board(), ClearSelection(), SELECTION::GetItems(), itemIsIncludedByFilter(), m_frame, m_priv, m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), select(), EVENTS::SelectedEvent, and selection().

Referenced by setTransitions().

◆ FindItem()

void PCB_SELECTION_TOOL::FindItem ( BOARD_ITEM * aItem )

Take necessary actions to mark an item as found.

Parameters

aItem The item that was found and needs to be highlighted/focused/etc.

Definition at line 1990 of file pcb_selection_tool.cpp.

{
 bool cleared = false;
 
 if( m_selection.GetSize() > 0 )
 {
 // Don't fire an event now; most of the time it will be redundant as we're about to
 // fire a SelectedEvent.
 cleared = true;
 ClearSelection( true /*quiet mode*/ );
 }
 
 if( aItem )
 {
 switch( aItem->Type() )
 {
 case PCB_NETINFO_T:
 {
 int netCode = static_cast<NETINFO_ITEM*>( aItem )->GetNetCode();
 
 if( netCode > 0 )
 {
 SelectAllItemsOnNet( netCode, true );
 m_frame->FocusOnLocation( aItem->GetCenter() );
 }
 break;
 }
 
 default:
 select( aItem );
 m_frame->FocusOnLocation( aItem->GetPosition() );
 }
 
 // If the item has a bounding box, then zoom out if needed
 if( aItem->GetBoundingBox().GetHeight() > 0 && aItem->GetBoundingBox().GetWidth() > 0 )
 {
 // This adds some margin
 double marginFactor = 2;
 
 KIGFX::PCB_VIEW* pcbView = canvas()->GetView();
 BOX2D screenBox = pcbView->GetViewport();
 VECTOR2I screenSize = screenBox.GetSize();
 BOX2I screenRect( screenBox.GetOrigin(), screenSize / marginFactor );
 
 if( !screenRect.Contains( aItem->GetBoundingBox() ) )
 {
 double scaleX = screenSize.x / static_cast<double>( aItem->GetBoundingBox().GetWidth() );
 double scaleY = screenSize.y / static_cast<double>( aItem->GetBoundingBox().GetHeight() );
 
 scaleX /= marginFactor;
 scaleY /= marginFactor;
 
 double scale = scaleX > scaleY ? scaleY : scaleX;
 
 if( scale < 1 ) // Don't zoom in, only zoom out
 {
 pcbView->SetScale( pcbView->GetScale() * ( scale ) );
 
 //Let's refocus because there is an algorithm to avoid dialogs in there.
 m_frame->FocusOnLocation( aItem->GetCenter() );
 }
 }
 }
 // Inform other potentially interested tools
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 }
 else if( cleared )
 {
 m_toolMgr->ProcessEvent( EVENTS::ClearedEvent );
 }
 
 m_frame->GetCanvas()->ForceRefresh();
}

References canvas(), EVENTS::ClearedEvent, ClearSelection(), BOX2< Vec >::Contains(), EDA_DRAW_FRAME::FocusOnLocation(), EDA_DRAW_PANEL_GAL::ForceRefresh(), EDA_ITEM::GetBoundingBox(), PCB_BASE_FRAME::GetCanvas(), BOARD_ITEM::GetCenter(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetOrigin(), EDA_ITEM::GetPosition(), KIGFX::VIEW::GetScale(), BOX2< Vec >::GetSize(), SELECTION::GetSize(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), m_frame, m_selection, TOOL_BASE::m_toolMgr, PCB_NETINFO_T, TOOL_MANAGER::ProcessEvent(), scale, select(), SelectAllItemsOnNet(), EVENTS::SelectedEvent, KIGFX::VIEW::SetScale(), EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_EDIT_FRAME::ShowFindDialog().

◆ frame()

PCB_BASE_EDIT_FRAME * PCB_SELECTION_TOOL::frame ( ) const

inlineprotected

Definition at line 225 of file pcb_selection_tool.h.

 {
 return getEditFrame<PCB_BASE_EDIT_FRAME>();
 }

Referenced by canvas(), FilterCollectorForFreePads(), Init(), Main(), and RequestSelection().

◆ GetActiveLayer()

PCB_LAYER_ID PCB_SELECTION_TOOL::GetActiveLayer ( )

inline

Definition at line 190 of file pcb_selection_tool.h.

190{ return m_frame->GetActiveLayer(); }

PCB_BASE_FRAME::GetActiveLayer

virtual PCB_LAYER_ID GetActiveLayer() const

Definition: pcb_base_frame.h:357

References PCB_BASE_FRAME::GetActiveLayer(), and m_frame.

◆ getCollectorsGuide()

const GENERAL_COLLECTORS_GUIDE PCB_SELECTION_TOOL::getCollectorsGuide ( ) const

private

Definition at line 679 of file pcb_selection_tool.cpp.

{
 GENERAL_COLLECTORS_GUIDE guide( board()->GetVisibleLayers(),
 (PCB_LAYER_ID) view()->GetTopLayer(), view() );
 
 bool padsDisabled = !board()->IsElementVisible( LAYER_PADS );
 
 // account for the globals
 guide.SetIgnoreMTextsMarkedNoShow( ! board()->IsElementVisible( LAYER_MOD_TEXT_INVISIBLE ) );
 guide.SetIgnoreMTextsOnBack( ! board()->IsElementVisible( LAYER_MOD_TEXT ) );
 guide.SetIgnoreMTextsOnFront( ! board()->IsElementVisible( LAYER_MOD_TEXT ) );
 guide.SetIgnoreModulesOnBack( ! board()->IsElementVisible( LAYER_MOD_BK ) );
 guide.SetIgnoreModulesOnFront( ! board()->IsElementVisible( LAYER_MOD_FR ) );
 guide.SetIgnorePadsOnBack( padsDisabled || ! board()->IsElementVisible( LAYER_PAD_BK ) );
 guide.SetIgnorePadsOnFront( padsDisabled || ! board()->IsElementVisible( LAYER_PAD_FR ) );
 guide.SetIgnoreThroughHolePads( padsDisabled || ! board()->IsElementVisible( LAYER_PADS_TH ) );
 guide.SetIgnoreModulesVals( ! board()->IsElementVisible( LAYER_MOD_VALUES ) );
 guide.SetIgnoreModulesRefs( ! board()->IsElementVisible( LAYER_MOD_REFERENCES ) );
 guide.SetIgnoreThroughVias( ! board()->IsElementVisible( LAYER_VIAS ) );
 guide.SetIgnoreBlindBuriedVias( ! board()->IsElementVisible( LAYER_VIAS ) );
 guide.SetIgnoreMicroVias( ! board()->IsElementVisible( LAYER_VIAS ) );
 guide.SetIgnoreTracks( ! board()->IsElementVisible( LAYER_TRACKS ) );
 
 return guide;
}

Referenced by RequestSelection(), and selectPoint().

◆ getEditFrame()

template<typename T >

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 185 of file tool_base.h.

 {
#if !defined( QA_TEST ) // Dynamic casts give the linker a seizure in the test framework
 wxASSERT( dynamic_cast<T*>( getToolHolderInt() ) );
#endif
 return static_cast<T*>( getToolHolderInt() );
 }

References TOOL_BASE::getToolHolderInt().

Referenced by ZONE_CREATE_HELPER::createNewZone(), and ZONE_CREATE_HELPER::setUniquePriority().

◆ GetEnteredGroup()

PCB_GROUP * PCB_SELECTION_TOOL::GetEnteredGroup ( )

inline

Returns: the currently-entered group.

Definition at line 188 of file pcb_selection_tool.h.

188{ return m_enteredGroup; }

References m_enteredGroup.

Referenced by EDIT_TOOL::DeleteItems(), PCB_CONTROL::placeBoardItems(), and BOARD_COMMIT::Push().

◆ GetFilter()

SELECTION_FILTER_OPTIONS & PCB_SELECTION_TOOL::GetFilter ( )

inline

Set up handlers for various events.

Definition at line 159 of file pcb_selection_tool.h.

References m_filter.

Referenced by EDIT_TOOL::doMoveSelection(), BOARD_INSPECTION_TOOL::highlightNet(), PCB_EDIT_FRAME::LoadProjectSettings(), PANEL_SELECTION_FILTER::OnFilterChanged(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), and PCB_EDIT_FRAME::saveProjectSettings().

◆ 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 121 of file tool_base.h.

 {
 return m_toolId;
 }

References TOOL_BASE::m_toolId.

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

◆ 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 144 of file tool_base.h.

 {
 return m_toolMgr;
 }

References TOOL_BASE::m_toolMgr.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), PNS_KICAD_IFACE::DisplayItem(), PCB_TOOL_BASE::doInteractiveItemPlacement(), ACTION_MENU::getToolManager(), PNS_KICAD_IFACE::GetUnits(), ZONE_CREATE_HELPER::OnFirstPoint(), ACTION_MENU::OnMenuEvent(), and ZONE_CREATE_HELPER::performZoneCutout().

◆ getModel()

template<typename T >

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Store the type of the tool.

Definition at line 197 of file tool_base.h.

References TOOL_BASE::getModelInt().

Referenced by ZONE_CREATE_HELPER::commitZone(), and ZONE_CREATE_HELPER::createZoneFromExisting().

◆ getModelInt()

EDA_ITEM * TOOL_BASE::getModelInt ( ) const

privateinherited

Definition at line 54 of file tool_base.cpp.

{
 return m_toolMgr->GetModel();
}

References TOOL_MANAGER::GetModel(), and TOOL_BASE::m_toolMgr.

Referenced by TOOL_BASE::getModel().

◆ GetName()

const std::string & TOOL_BASE::GetName ( void ) 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 134 of file tool_base.h.

 {
 return m_toolName;
 }

References TOOL_BASE::m_toolName.

Referenced by TOOL_MANAGER::dispatchInternal(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::invokeTool(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::runTool(), and TOOL_MANAGER::ShutdownTool().

◆ GetSelection()

PCB_SELECTION & PCB_SELECTION_TOOL::GetSelection ( )

Returns: the set of currently selected items.

Definition at line 549 of file pcb_selection_tool.cpp.

{
 return m_selection;
}

References m_selection.

Referenced by PCB_PROPERTIES_PANEL::AfterCommit(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), PAD_TOOL::copyPadSettings(), ZONE_CREATE_HELPER::createNewZone(), DRC_TOOL::CrossProbe(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), EDIT_TOOL::DragArcTrack(), GROUP_TOOL::EnterGroup(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), EDIT_TOOL::GetAndPlace(), PCB_PROPERTIES_PANEL::getPropertyFromEvent(), DRAWING_TOOL::getSourceZoneForAction(), BOARD_INSPECTION_TOOL::highlightNet(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), Main(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_POINT_EDITOR::OnSelectionChange(), PAD_TOOL::pastePadProperties(), PCB_CONTROL::placeBoardItems(), DRAWING_TOOL::PlaceImage(), PAD_TOOL::pushPadSettings(), BOARD_REANNOTATE_TOOL::ReannotateDuplicatesInSelection(), EDIT_TOOL::Remove(), GROUP_TOOL::RemoveFromGroup(), PCB_TOOL_BASE::selection(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), GROUP_CONTEXT_MENU::update(), PCB_PROPERTIES_PANEL::UpdateData(), PCB_CONTROL::UpdateMessagePanel(), PCB_PROPERTIES_PANEL::valueChanged(), PCB_PROPERTIES_PANEL::valueChanging(), and BOARD_EDITOR_CONTROL::ZoneDuplicate().

◆ getToolHolderInt()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInt ( ) const

privateinherited

Definition at line 48 of file tool_base.cpp.

{
 return m_toolMgr->GetToolHolder();
}

References TOOL_MANAGER::GetToolHolder(), and TOOL_BASE::m_toolMgr.

Referenced by TOOL_BASE::getEditFrame().

◆ GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inlineinherited

Definition at line 77 of file tool_interactive.h.

77{ return m_menu; }

TOOL_INTERACTIVE::m_menu

TOOL_MENU m_menu

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

Definition: tool_interactive.h:125

References TOOL_INTERACTIVE::m_menu.

Referenced by EE_INSPECTION_TOOL::Init(), EE_POINT_EDITOR::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_MOVE_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), CONVERT_TOOL::Init(), EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_POINT_EDITOR::Init(), and ALIGN_DISTRIBUTE_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 109 of file tool_base.h.

 {
 return m_type;
 }

References TOOL_BASE::m_type.

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

◆ getView()

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

protectedinherited

Returns the instance of #VIEW object used in the application.

It allows tools to draw.

Returns: The instance of VIEW.

Definition at line 36 of file tool_base.cpp.

{
 return m_toolMgr->GetView();
}

References TOOL_MANAGER::GetView(), and TOOL_BASE::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 42 of file tool_base.cpp.

{
 return m_toolMgr->GetViewControls();
}

References TOOL_MANAGER::GetViewControls(), and TOOL_BASE::m_toolMgr.

Referenced by EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), controls(), PCB_TOOL_BASE::controls(), EDIT_TOOL::copyToClipboard(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EDIT_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), LENGTH_TUNER_TOOL::performTuning(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDIT_TOOL::RepeatDrawItem(), PL_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), selectCursor(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), selectMultiple(), EE_SELECTION_TOOL::SelectNode(), ZOOM_TOOL::selectRegion(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), PCB_PICKER_TOOL::setControls(), EE_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), PCB_POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateItem(), PL_EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

◆ Go()

template<class T >

void TOOL_INTERACTIVE::Go	(	int(T::*)(const TOOL_EVENT &)	aStateFunc,
		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 147 of file tool_interactive.h.

{
 TOOL_STATE_FUNC sptr = std::bind( aStateFunc, static_cast<T*>( this ), std::placeholders::_1 );
 
 goInternal( sptr, aConditions );
}

References TOOL_INTERACTIVE::goInternal().

◆ goInternal()

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

privateinherited

Definition at line 70 of file tool_interactive.cpp.

{
 m_toolMgr->ScheduleNextState( this, aState, aConditions );
}

References TOOL_BASE::m_toolMgr, and TOOL_MANAGER::ScheduleNextState().

Referenced by TOOL_INTERACTIVE::Go().

◆ grabUnconnected()

int PCB_SELECTION_TOOL::grabUnconnected ( const TOOL_EVENT & aEvent )

private

Select and move other nearest footprint unconnected on same net as selected items.

Definition at line 1495 of file pcb_selection_tool.cpp.

{
 PCB_SELECTION originalSelection = m_selection;
 
 // Get all pads
 std::vector<PAD*> pads;
 
 for( EDA_ITEM* item : m_selection.GetItems() )
 {
 if( item->Type() == PCB_FOOTPRINT_T )
 {
 for( PAD* pad : static_cast<FOOTPRINT*>( item )->Pads() )
 pads.push_back( pad );
 }
 else if( item->Type() == PCB_PAD_T )
 {
 pads.push_back( static_cast<PAD*>( item ) );
 }
 }
 
 ClearSelection();
 
 // Select every footprint on the end of the ratsnest for each pad in our selection
 std::shared_ptr<CONNECTIVITY_DATA> conn = board()->GetConnectivity();
 
 for( PAD* pad : pads )
 {
 const std::vector<CN_EDGE> edges = conn->GetRatsnestForPad( pad );
 
 // Need to have something unconnected to grab
 if( edges.size() == 0 )
 continue;
 
 double currentDistance = DBL_MAX;
 FOOTPRINT* nearest = nullptr;
 
 // Check every ratsnest line for the nearest one
 for( const CN_EDGE& edge : edges )
 {
 // Figure out if we are the source or the target node on the ratnest
 const CN_ANCHOR* other = edge.GetSourceNode()->Parent() == pad ? edge.GetTargetNode().get()
 : edge.GetSourceNode().get();
 
 // We only want to grab footprints, so the ratnest has to point to a pad
 if( other->Parent()->Type() != PCB_PAD_T )
 continue;
 
 if( edge.GetLength() < currentDistance )
 {
 currentDistance = edge.GetLength();
 nearest = static_cast<PAD*>( other->Parent() )->GetParent();
 }
 }
 
 if( nearest != nullptr )
 select( nearest );
 }
 
 m_toolMgr->RunAction( PCB_ACTIONS::moveIndividually, true );
 
 return 0;
}

References board(), ClearSelection(), BOARD::GetConnectivity(), SELECTION::GetItems(), m_selection, TOOL_BASE::m_toolMgr, PCB_ACTIONS::moveIndividually, pad, CN_ANCHOR::Parent(), PCB_FOOTPRINT_T, PCB_PAD_T, TOOL_MANAGER::RunAction(), select(), and EDA_ITEM::Type().

Referenced by setTransitions().

◆ GuessSelectionCandidates()

void PCB_SELECTION_TOOL::GuessSelectionCandidates	(	GENERAL_COLLECTOR &	aCollector,
		const VECTOR2I &	aWhere
	)		const

Try to guess best selection candidates in case multiple items are clicked, by doing some brain-dead heuristics.

Parameters

aCollector	[in, out] The collector that has a list of items to be narrowed.
aWhere	The selection point to consider.

Definition at line 2909 of file pcb_selection_tool.cpp.

{
 static const LSET silkLayers( 2, B_SilkS, F_SilkS );
 static const LSET courtyardLayers( 2, B_CrtYd, F_CrtYd );
 
 std::set<BOARD_ITEM*> preferred;
 std::set<BOARD_ITEM*> rejected;
 VECTOR2I where( aWhere.x, aWhere.y );
 const RENDER_SETTINGS* settings = getView()->GetPainter()->GetSettings();
 PCB_LAYER_ID activeLayer = m_frame->GetActiveLayer();
 
 if( silkLayers[activeLayer] )
 {
 for( int i = 0; i < aCollector.GetCount(); ++i )
 {
 BOARD_ITEM* item = aCollector[i];
 KICAD_T type = item->Type();
 
 if( ( type == PCB_TEXT_T || type == PCB_TEXTBOX_T || type == PCB_SHAPE_T )
 && silkLayers[item->GetLayer()] )
 {
 preferred.insert( item );
 }
 }
 }
 else if( courtyardLayers[activeLayer] && settings->GetHighContrast() )
 {
 for( int i = 0; i < aCollector.GetCount(); ++i )
 {
 BOARD_ITEM* item = aCollector[i];
 KICAD_T type = item->Type();
 
 if( type == PCB_FOOTPRINT_T )
 preferred.insert( item );
 }
 }
 
 if( preferred.size() > 0 )
 {
 aCollector.Empty();
 
 for( BOARD_ITEM* item : preferred )
 aCollector.Append( item );
 
 return;
 }
 
 // Prefer exact hits to sloppy ones
 constexpr int MAX_SLOP = 5;
 
 int singlePixel = KiROUND( aCollector.GetGuide()->OnePixelInIU() );
 int maxSlop = KiROUND( MAX_SLOP * aCollector.GetGuide()->OnePixelInIU() );
 int minSlop = INT_MAX;
 
 std::map<BOARD_ITEM*, int> itemsBySloppiness;
 
 for( int i = 0; i < aCollector.GetCount(); ++i )
 {
 BOARD_ITEM* item = aCollector[i];
 int itemSlop = hitTestDistance( where, item, maxSlop );
 
 itemsBySloppiness[ item ] = itemSlop;
 
 if( itemSlop < minSlop )
 minSlop = itemSlop;
 }
 
 // Prune sloppier items
 if( minSlop < INT_MAX )
 {
 for( std::pair<BOARD_ITEM*, int> pair : itemsBySloppiness )
 {
 if( pair.second > minSlop + singlePixel )
 aCollector.Transfer( pair.first );
 }
 }
 
 // If the user clicked on a small item within a much larger one then it's pretty clear
 // they're trying to select the smaller one.
 constexpr double sizeRatio = 1.5;
 
 std::vector<std::pair<BOARD_ITEM*, double>> itemsByArea;
 
 for( int i = 0; i < aCollector.GetCount(); ++i )
 {
 BOARD_ITEM* item = aCollector[i];
 double area = 0.0;
 
 if( ( item->Type() == PCB_ZONE_T || item->Type() == PCB_FP_ZONE_T )
 && static_cast<ZONE*>( item )->HitTestForEdge( where, maxSlop / 2 ) )
 {
 // Zone borders are very specific, so make them "small"
 area = (double) SEG::Square( singlePixel ) * MAX_SLOP;
 }
 else if( item->Type() == PCB_VIA_T )
 {
 // Vias rarely hide other things, and we don't want them deferring to short track
 // segments underneath them -- so artificially reduce their size from πr² to 1.5r².
 area = (double) SEG::Square( static_cast<PCB_VIA*>( item )->GetDrill() / 2 ) * 1.5;
 }
 else if( item->Type() == PCB_BITMAP_T )
 {
 VECTOR2D size = static_cast<const PCB_BITMAP*>( item )->GetSize();
 area = size.x * size.y;
 }
 else
 {
 try
 {
 area = FOOTPRINT::GetCoverageArea( item, aCollector );
 }
 catch( const ClipperLib::clipperException& e )
 {
 wxLogError( wxT( "A clipper exception %s was detected." ), e.what() );
 }
 }
 
 itemsByArea.emplace_back( item, area );
 }
 
 std::sort( itemsByArea.begin(), itemsByArea.end(),
 []( const std::pair<BOARD_ITEM*, double>& lhs,
 const std::pair<BOARD_ITEM*, double>& rhs ) -> bool
 {
 return lhs.second < rhs.second;
 } );
 
 bool rejecting = false;
 
 for( int i = 1; i < (int) itemsByArea.size(); ++i )
 {
 if( itemsByArea[i].second > itemsByArea[i-1].second * sizeRatio )
 rejecting = true;
 
 if( rejecting )
 rejected.insert( itemsByArea[i].first );
 }
 
 // Special case: if a footprint is completely covered with other features then there's no
 // way to select it -- so we need to leave it in the list for user disambiguation.
 constexpr double maxCoverRatio = 0.70;
 
 for( int i = 0; i < aCollector.GetCount(); ++i )
 {
 if( FOOTPRINT* footprint = dynamic_cast<FOOTPRINT*>( aCollector[i] ) )
 {
 if( footprint->CoverageRatio( aCollector ) > maxCoverRatio )
 rejected.erase( footprint );
 }
 }
 
 // Hopefully we've now got what the user wanted.
 if( (unsigned) aCollector.GetCount() > rejected.size() ) // do not remove everything
 {
 for( BOARD_ITEM* item : rejected )
 aCollector.Transfer( item );
 }
 
 // Finally, what we are left with is a set of items of similar coverage area. We now reject
 // any that are not on the active layer, to reduce the number of disambiguation menus shown.
 // If the user wants to force-disambiguate, they can either switch layers or use the modifier
 // key to force the menu.
 if( aCollector.GetCount() > 1 )
 {
 bool haveItemOnActive = false;
 rejected.clear();
 
 for( int i = 0; i < aCollector.GetCount(); ++i )
 {
 if( !aCollector[i]->IsOnLayer( activeLayer ) )
 rejected.insert( aCollector[i] );
 else
 haveItemOnActive = true;
 }
 
 if( haveItemOnActive )
 for( BOARD_ITEM* item : rejected )
 aCollector.Transfer( item );
 }
}

References COLLECTOR::Append(), B_CrtYd, B_SilkS, COLLECTOR::Empty(), F_CrtYd, F_SilkS, PCB_BASE_FRAME::GetActiveLayer(), COLLECTOR::GetCount(), FOOTPRINT::GetCoverageArea(), PCB_VIA::GetDrill(), GENERAL_COLLECTOR::GetGuide(), KIGFX::RENDER_SETTINGS::GetHighContrast(), BOARD_ITEM::GetLayer(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), TOOL_BASE::getView(), hitTestDistance(), ZONE::HitTestForEdge(), KiROUND(), m_frame, COLLECTORS_GUIDE::OnePixelInIU(), PCB_BITMAP_T, PCB_FOOTPRINT_T, PCB_FP_ZONE_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_VIA_T, PCB_ZONE_T, SEG::Square(), COLLECTOR::Transfer(), EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::Drag(), and selectPoint().

◆ hasModifier()

bool SELECTION_TOOL::hasModifier ( )

protectedinherited

True if a selection modifier is enabled, false otherwise.

Definition at line 86 of file selection_tool.cpp.

{
 return m_subtractive || m_additive || m_exclusive_or;
}

References SELECTION_TOOL::m_additive, SELECTION_TOOL::m_exclusive_or, and SELECTION_TOOL::m_subtractive.

Referenced by EE_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), Main(), and SELECTION_TOOL::onDisambiguationExpire().

◆ highlight()

void PCB_SELECTION_TOOL::highlight	(	EDA_ITEM *	aItem,
		int	aHighlightMode,
		SELECTION *	aGroup = `nullptr`
	)

overrideprivatevirtual

Highlight the item visually.

Parameters

aItem	The item to be highlighted.
aHighlightMode	Either SELECTED or BRIGHTENED
aGroup	[optional A group to add the item to.

Implements SELECTION_TOOL.

Definition at line 2658 of file pcb_selection_tool.cpp.

{
 if( aGroup )
 aGroup->Add( aItem );
 
 highlightInternal( aItem, aMode, aGroup != nullptr );
 view()->Update( aItem, KIGFX::REPAINT );
 
 // Many selections are very temporal and updating the display each time just
 // creates noise.
 if( aMode == BRIGHTENED )
 getView()->MarkTargetDirty( KIGFX::TARGET_OVERLAY );
}

References SELECTION::Add(), BRIGHTENED, TOOL_BASE::getView(), highlightInternal(), KIGFX::VIEW::MarkTargetDirty(), KIGFX::REPAINT, KIGFX::TARGET_OVERLAY, KIGFX::PCB_VIEW::Update(), and view().

Referenced by RebuildSelection(), RequestSelection(), and select().

◆ highlightInternal()

void PCB_SELECTION_TOOL::highlightInternal	(	EDA_ITEM *	aItem,
		int	aHighlightMode,
		bool	aUsingOverlay
	)

private

Definition at line 2673 of file pcb_selection_tool.cpp.

{
 if( aMode == SELECTED )
 aItem->SetSelected();
 else if( aMode == BRIGHTENED )
 aItem->SetBrightened();
 
 if( aUsingOverlay && aMode != BRIGHTENED )
 view()->Hide( aItem, true ); // Hide the original item, so it is shown only on overlay
 
 if( aItem->Type() == PCB_FOOTPRINT_T )
 {
 static_cast<FOOTPRINT*>( aItem )->RunOnChildren(
 [&]( BOARD_ITEM* aChild )
 {
 highlightInternal( aChild, aMode, aUsingOverlay );
 } );
 }
 else if( aItem->Type() == PCB_GROUP_T )
 {
 static_cast<PCB_GROUP*>( aItem )->RunOnChildren(
 [&]( BOARD_ITEM* aChild )
 {
 highlightInternal( aChild, aMode, aUsingOverlay );
 } );
 }
}

References BRIGHTENED, KIGFX::VIEW::Hide(), highlightInternal(), PCB_FOOTPRINT_T, PCB_GROUP_T, SELECTED, EDA_ITEM::SetBrightened(), EDA_ITEM::SetSelected(), EDA_ITEM::Type(), and view().

Referenced by highlight(), and highlightInternal().

◆ hitTestDistance()

int PCB_SELECTION_TOOL::hitTestDistance	(	const VECTOR2I &	aWhere,
		BOARD_ITEM *	aItem,
		int	aMaxDistance
	)		const

private

Returns: the distance from wWhere to aItem, up to and including aMaxDistance.

Definition at line 2790 of file pcb_selection_tool.cpp.

{
 BOX2D viewportD = getView()->GetViewport();
 BOX2I viewport( VECTOR2I( viewportD.GetPosition() ), VECTOR2I( viewportD.GetSize() ) );
 int distance = INT_MAX;
 SEG loc( aWhere, aWhere );
 
 switch( aItem->Type() )
 {
 case PCB_TEXT_T:
 {
 PCB_TEXT* text = static_cast<PCB_TEXT*>( aItem );
 text->GetEffectiveTextShape()->Collide( loc, aMaxDistance, &distance );
 break;
 }
 
 case PCB_TEXTBOX_T:
 {
 PCB_TEXTBOX* textbox = static_cast<PCB_TEXTBOX*>( aItem );
 textbox->GetEffectiveTextShape()->Collide( loc, aMaxDistance, &distance );
 break;
 }
 
 case PCB_FP_TEXT_T:
 {
 FP_TEXT* text = static_cast<FP_TEXT*>( aItem );
 text->GetEffectiveTextShape()->Collide( loc, aMaxDistance, &distance );
 break;
 }
 
 case PCB_FP_TEXTBOX_T:
 {
 FP_TEXTBOX* textbox = static_cast<FP_TEXTBOX*>( aItem );
 textbox->GetEffectiveTextShape()->Collide( loc, aMaxDistance, &distance );
 break;
 }
 
 case PCB_ZONE_T:
 {
 ZONE* zone = static_cast<ZONE*>( aItem );
 
 // Zone borders are very specific
 if( zone->HitTestForEdge( aWhere, aMaxDistance / 2 ) )
 distance = 0;
 else if( zone->HitTestForEdge( aWhere, aMaxDistance ) )
 distance = aMaxDistance / 2;
 else
 aItem->GetEffectiveShape()->Collide( loc, aMaxDistance, &distance );
 
 break;
 }
 
 case PCB_FOOTPRINT_T:
 {
 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( aItem );
 BOX2I bbox = footprint->GetBoundingBox( false, false );
 
 try
 {
 footprint->GetBoundingHull().Collide( loc, aMaxDistance, &distance );
 }
 catch( const ClipperLib::clipperException& exc )
 {
 // This may be overkill and could be an assertion but we are more likely to find
 // any clipper errors this way.
 wxLogError( wxT( "Clipper library exception '%s' occurred." ), exc.what() );
 }
 
 // Consider footprints larger than the viewport only as a last resort
 if( bbox.GetHeight() > viewport.GetHeight() || bbox.GetWidth() > viewport.GetWidth() )
 distance = INT_MAX / 2;
 
 break;
 }
 
 case PCB_MARKER_T:
 {
 PCB_MARKER* marker = static_cast<PCB_MARKER*>( aItem );
 SHAPE_LINE_CHAIN polygon;
 
 marker->ShapeToPolygon( polygon );
 polygon.Move( marker->GetPos() );
 polygon.Collide( loc, aMaxDistance, &distance );
 break;
 }
 
 case PCB_GROUP_T:
 {
 PCB_GROUP* group = static_cast<PCB_GROUP*>( aItem );
 
 for( BOARD_ITEM* member : group->GetItems() )
 distance = std::min( distance, hitTestDistance( aWhere, member, aMaxDistance ) );
 
 break;
 }
 
 default:
 aItem->GetEffectiveShape()->Collide( loc, aMaxDistance, &distance );
 break;
 }
 
 return distance;
}

References SHAPE_POLY_SET::Collide(), SHAPE_LINE_CHAIN::Collide(), distance(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), BOARD_ITEM::GetEffectiveShape(), EDA_TEXT::GetEffectiveTextShape(), BOX2< Vec >::GetHeight(), MARKER_BASE::GetPos(), BOX2< Vec >::GetPosition(), BOX2< Vec >::GetSize(), TOOL_BASE::getView(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), group, hitTestDistance(), ZONE::HitTestForEdge(), SHAPE_LINE_CHAIN::Move(), PCB_FOOTPRINT_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, PCB_GROUP_T, PCB_MARKER_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_ZONE_T, MARKER_BASE::ShapeToPolygon(), text, and EDA_ITEM::Type().

Referenced by GuessSelectionCandidates(), and hitTestDistance().

◆ Init()

bool PCB_SELECTION_TOOL::Init ( )

overridevirtual

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

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

Reimplemented from TOOL_BASE.

Definition at line 146 of file pcb_selection_tool.cpp.

{
 PCB_BASE_FRAME* frame = getEditFrame<PCB_BASE_FRAME>();
 
 if( frame && ( frame->IsType( FRAME_FOOTPRINT_VIEWER )
 || frame->IsType( FRAME_FOOTPRINT_VIEWER_MODAL ) ) )
 {
 frame->AddStandardSubMenus( m_menu );
 return true;
 }
 
 std::shared_ptr<SELECT_MENU> selectMenu = std::make_shared<SELECT_MENU>();
 selectMenu->SetTool( this );
 m_menu.RegisterSubMenu( selectMenu );
 
 auto& menu = m_menu.GetMenu();
 
 auto activeToolCondition =
 [ frame ] ( const SELECTION& aSel )
 {
 return !frame->ToolStackIsEmpty();
 };
 
 auto haveHighlight =
 [&]( const SELECTION& sel )
 {
 KIGFX::RENDER_SETTINGS* cfg = m_toolMgr->GetView()->GetPainter()->GetSettings();
 
 return !cfg->GetHighlightNetCodes().empty();
 };
 
 auto groupEnterCondition =
 SELECTION_CONDITIONS::Count( 1 ) && SELECTION_CONDITIONS::HasType( PCB_GROUP_T );
 
 auto inGroupCondition =
 [this] ( const SELECTION& )
 {
 return m_enteredGroup != nullptr;
 };
 
 if( frame && frame->IsType( FRAME_PCB_EDITOR ) )
 {
 menu.AddMenu( selectMenu.get(), SELECTION_CONDITIONS::NotEmpty );
 menu.AddSeparator( 1000 );
 }
 
 // "Cancel" goes at the top of the context menu when a tool is active
 menu.AddItem( ACTIONS::cancelInteractive, activeToolCondition, 1 );
 menu.AddItem( PCB_ACTIONS::groupEnter, groupEnterCondition, 1 );
 menu.AddItem( PCB_ACTIONS::groupLeave, inGroupCondition, 1 );
 menu.AddItem( PCB_ACTIONS::clearHighlight, haveHighlight, 1 );
 
 menu.AddSeparator( 1 );
 
 if( frame )
 frame->AddStandardSubMenus( m_menu );
 
 m_disambiguateTimer.SetOwner( this );
 Connect( wxEVT_TIMER, wxTimerEventHandler( PCB_SELECTION_TOOL::onDisambiguationExpire ), nullptr, this );
 
 return true;
}

References PCB_GROUP::AddItem(), EDA_DRAW_FRAME::AddStandardSubMenus(), ACTIONS::cancelInteractive, PCB_ACTIONS::clearHighlight, SELECTION_CONDITIONS::Count(), frame(), FRAME_FOOTPRINT_VIEWER, FRAME_FOOTPRINT_VIEWER_MODAL, FRAME_PCB_EDITOR, KIGFX::RENDER_SETTINGS::GetHighlightNetCodes(), TOOL_MENU::GetMenu(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), TOOL_MANAGER::GetView(), PCB_ACTIONS::groupEnter, PCB_ACTIONS::groupLeave, SELECTION_CONDITIONS::HasType(), EDA_BASE_FRAME::IsType(), SELECTION_TOOL::m_disambiguateTimer, m_enteredGroup, TOOL_INTERACTIVE::m_menu, TOOL_BASE::m_toolMgr, SELECTION_CONDITIONS::NotEmpty(), SELECTION_TOOL::onDisambiguationExpire(), PCB_GROUP_T, TOOL_MENU::RegisterSubMenu(), and TOOLS_HOLDER::ToolStackIsEmpty().

◆ IsFootprintEditor()

bool PCB_SELECTION_TOOL::IsFootprintEditor ( )

inline

Definition at line 78 of file pcb_selection_tool.h.

 {
 return m_isFootprintEditor;
 }

References m_isFootprintEditor.

◆ IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 31 of file tool_base.cpp.

{
 return m_toolMgr->IsToolActive( m_toolId );
}

References TOOL_MANAGER::IsToolActive(), TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

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

◆ itemPassesFilter()

bool PCB_SELECTION_TOOL::itemPassesFilter	(	BOARD_ITEM *	aItem,
		bool	aMultiSelect
	)

private

Definition at line 2193 of file pcb_selection_tool.cpp.

{
 if( !m_filter.lockedItems )
 {
 if( aItem->IsLocked() || ( aItem->GetParent() && aItem->GetParent()->IsLocked() ) )
 {
 if( aItem->Type() == PCB_PAD_T && !aMultiSelect )
 {
 // allow a single pad to be selected -- there are a lot of operations that
 // require this so we allow this one inconsistency
 }
 else
 {
 return false;
 }
 }
 }
 
 switch( aItem->Type() )
 {
 case PCB_FOOTPRINT_T:
 if( !m_filter.footprints )
 return false;
 
 break;
 
 case PCB_PAD_T:
 if( !m_filter.pads )
 return false;
 
 break;
 
 case PCB_TRACE_T:
 case PCB_ARC_T:
 if( !m_filter.tracks )
 return false;
 
 break;
 
 case PCB_VIA_T:
 if( !m_filter.vias )
 return false;
 
 break;
 
 case PCB_FP_ZONE_T:
 case PCB_ZONE_T:
 {
 ZONE* zone = static_cast<ZONE*>( aItem );
 
 if( ( !m_filter.zones && !zone->GetIsRuleArea() )
 || ( !m_filter.keepouts && zone->GetIsRuleArea() ) )
 {
 return false;
 }
 
 break;
 }
 
 case PCB_FP_SHAPE_T:
 case PCB_SHAPE_T:
 case PCB_TARGET_T:
 if( !m_filter.graphics )
 return false;
 
 break;
 
 case PCB_BITMAP_T:
 // a bitmap living in a footprint must not be selected inside the board editor
 if( !m_filter.graphics )
 return false;
 
 if( !m_isFootprintEditor )
 {
 if( dynamic_cast<FOOTPRINT*>( aItem->GetParent() ) )
 return false;
 }
 
 
 break;
 
 case PCB_FP_TEXT_T:
 case PCB_FP_TEXTBOX_T:
 case PCB_TEXT_T:
 case PCB_TEXTBOX_T:
 if( !m_filter.text )
 return false;
 
 break;
 
 case PCB_DIM_ALIGNED_T:
 case PCB_DIM_CENTER_T:
 case PCB_DIM_RADIAL_T:
 case PCB_DIM_ORTHOGONAL_T:
 case PCB_DIM_LEADER_T:
 case PCB_FP_DIM_ALIGNED_T:
 case PCB_FP_DIM_CENTER_T:
 case PCB_FP_DIM_RADIAL_T:
 case PCB_FP_DIM_ORTHOGONAL_T:
 case PCB_FP_DIM_LEADER_T:
 if( !m_filter.dimensions )
 return false;
 
 break;
 
 default:
 if( !m_filter.otherItems )
 return false;
 }
 
 return true;
}

Referenced by FilterCollectedItems(), SelectAll(), and SelectAllItemsOnNet().

◆ Main()

int PCB_SELECTION_TOOL::Main ( const TOOL_EVENT & aEvent )

The main loop.

Definition at line 264 of file pcb_selection_tool.cpp.

{
 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 MOUSE_DRAG_ACTION dragAction = m_frame->GetDragAction();
 TRACK_DRAG_ACTION trackDragAction = m_frame->GetPcbNewSettings()->m_TrackDragAction;
 
 // on left click, a selection is made, depending on modifiers ALT, SHIFT, CTRL:
 setModifiersState( evt->Modifier( MD_SHIFT ), evt->Modifier( MD_CTRL ),
 evt->Modifier( MD_ALT ) );
 
 PCB_BASE_FRAME* frame = getEditFrame<PCB_BASE_FRAME>();
 bool brd_editor = frame && frame->IsType( FRAME_PCB_EDITOR );
 ROUTER_TOOL* router = m_toolMgr->GetTool<ROUTER_TOOL>();
 
 // If the router tool is active, don't override
 if( router && router->IsToolActive() && router->RoutingInProgress() )
 {
 evt->SetPassEvent();
 }
 else if( evt->IsMouseDown( BUT_LEFT ) )
 {
 // Avoid triggering when running under other tools
 PCB_POINT_EDITOR *pt_tool = m_toolMgr->GetTool<PCB_POINT_EDITOR>();
 
 if( m_frame->ToolStackIsEmpty() && pt_tool && !pt_tool->HasPoint() )
 {
 m_originalCursor = m_toolMgr->GetMousePosition();
 m_disambiguateTimer.StartOnce( 500 );
 }
 }
 else if( evt->IsClick( BUT_LEFT ) )
 {
 // If there is no disambiguation, this routine is still running and will
 // register a `click` event when released
 if( m_disambiguateTimer.IsRunning() )
 {
 m_disambiguateTimer.Stop();
 
 // Single click? Select single object
 if( m_highlight_modifier && brd_editor )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::highlightNet, true );
 }
 else
 {
 m_frame->FocusOnItem( nullptr );
 selectPoint( evt->Position() );
 }
 }
 
 m_canceledMenu = false;
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_disambiguateTimer.Stop();
 
 // Right click? if there is any object - show the context menu
 bool selectionCancelled = false;
 
 if( m_selection.Empty() )
 {
 selectPoint( evt->Position(), false, &selectionCancelled );
 m_selection.SetIsHover( true );
 }
 
 if( !selectionCancelled )
 m_menu.ShowContextMenu( m_selection );
 }
 else if( evt->IsDblClick( BUT_LEFT ) )
 {
 m_disambiguateTimer.Stop();
 
 // Double click? Display the properties window
 m_frame->FocusOnItem( nullptr );
 
 if( m_selection.Empty() )
 selectPoint( evt->Position() );
 
 if( m_selection.GetSize() == 1 && m_selection[0]->Type() == PCB_GROUP_T )
 EnterGroup();
 else
 m_toolMgr->RunAction( PCB_ACTIONS::properties, true );
 }
 else if( evt->IsDblClick( BUT_MIDDLE ) )
 {
 // Middle double click? Do zoom to fit or zoom to objects
 if( evt->Modifier( MD_CTRL ) ) // Is CTRL key down?
 m_toolMgr->RunAction( ACTIONS::zoomFitObjects, true );
 else
 m_toolMgr->RunAction( ACTIONS::zoomFitScreen, true );
 }
 else if( evt->IsDrag( BUT_LEFT ) )
 {
 m_disambiguateTimer.Stop();
 
 // Is another tool already moving a new object? Don't allow a drag start
 if( !m_selection.Empty() && m_selection[0]->HasFlag( IS_NEW | IS_MOVING ) )
 {
 evt->SetPassEvent();
 continue;
 }
 
 // Drag with LMB? Select multiple objects (or at least draw a selection box)
 // or drag them
 m_frame->FocusOnItem( nullptr );
 m_toolMgr->ProcessEvent( EVENTS::InhibitSelectionEditing );
 
 if( hasModifier() || dragAction == MOUSE_DRAG_ACTION::SELECT )
 {
 selectMultiple();
 }
 else if( m_selection.Empty() && dragAction != MOUSE_DRAG_ACTION::DRAG_ANY )
 {
 selectMultiple();
 }
 else
 {
 // Don't allow starting a drag from a zone filled area that isn't already selected
 auto zoneFilledAreaFilter =
 []( const VECTOR2I& aWhere, GENERAL_COLLECTOR& aCollector,
 PCB_SELECTION_TOOL* aTool )
 {
 int accuracy = KiROUND( 5 * aCollector.GetGuide()->OnePixelInIU() );
 std::set<EDA_ITEM*> remove;
 
 for( EDA_ITEM* item : aCollector )
 {
 if( item->Type() == PCB_ZONE_T || item->Type() == PCB_FP_ZONE_T )
 {
 ZONE* zone = static_cast<ZONE*>( item );
 
 if( !zone->HitTestForCorner( aWhere, accuracy * 2 )
 && !zone->HitTestForEdge( aWhere, accuracy ) )
 {
 remove.insert( zone );
 }
 }
 }
 
 for( EDA_ITEM* item : remove )
 aCollector.Remove( item );
 };
 
 // See if we can drag before falling back to selectMultiple()
 bool doDrag = false;
 
 if( evt->HasPosition() )
 {
 if( m_selection.Empty()
 && selectPoint( evt->DragOrigin(), false, nullptr, zoneFilledAreaFilter ) )
 {
 m_selection.SetIsHover( true );
 doDrag = true;
 }
 // Check if dragging has started within any of selected items bounding box.
 else if( selectionContains( evt->DragOrigin() ) )
 {
 doDrag = true;
 }
 }
 
 if( doDrag )
 {
 bool haveTrack = m_selection.GetSize() == 1
 && dynamic_cast<PCB_TRACK*>( m_selection.GetItem( 0 ) );
 
 if( haveTrack && trackDragAction == TRACK_DRAG_ACTION::DRAG )
 m_toolMgr->RunAction( PCB_ACTIONS::drag45Degree, true );
 else if( haveTrack && trackDragAction == TRACK_DRAG_ACTION::DRAG_FREE_ANGLE )
 m_toolMgr->RunAction( PCB_ACTIONS::dragFreeAngle, true );
 else
 m_toolMgr->RunAction( PCB_ACTIONS::move, true );
 }
 else
 {
 // Otherwise drag a selection box
 selectMultiple();
 }
 }
 }
 else if( evt->IsCancel() )
 {
 m_disambiguateTimer.Stop();
 m_frame->FocusOnItem( nullptr );
 
 if( !GetSelection().Empty() )
 {
 ClearSelection();
 }
 else if( evt->FirstResponder() == this && evt->GetCommandId() == (int) WXK_ESCAPE )
 {
 if( m_enteredGroup )
 {
 ExitGroup();
 }
 else
 {
 BOARD_INSPECTION_TOOL* controller = m_toolMgr->GetTool<BOARD_INSPECTION_TOOL>();
 
 if( controller && m_frame->GetPcbNewSettings()->m_ESCClearsNetHighlight )
 controller->ClearHighlight( *evt );
 }
 }
 }
 else
 {
 evt->SetPassEvent();
 }
 
 
 if( m_frame->ToolStackIsEmpty() )
 {
 // move cursor prediction
 if( !hasModifier()
 && dragAction == MOUSE_DRAG_ACTION::DRAG_SELECTED
 && !m_selection.Empty()
 && evt->HasPosition()
 && selectionContains( evt->Position() ) )
 {
 m_nonModifiedCursor = KICURSOR::MOVING;
 }
 else
 {
 m_nonModifiedCursor = KICURSOR::ARROW;
 }
 }
 }
 
 // Shutting down; clear the selection
 m_selection.Clear();
 m_disambiguateTimer.Stop();
 
 return 0;
}

References ARROW, BUT_LEFT, BUT_MIDDLE, BUT_RIGHT, SELECTION::Clear(), BOARD_INSPECTION_TOOL::ClearHighlight(), ClearSelection(), DRAG, PCB_ACTIONS::drag45Degree, DRAG_ANY, DRAG_FREE_ANGLE, DRAG_SELECTED, PCB_ACTIONS::dragFreeAngle, SELECTION::Empty(), EnterGroup(), ExitGroup(), PCB_BASE_FRAME::FocusOnItem(), frame(), FRAME_PCB_EDITOR, TOOLS_HOLDER::GetDragAction(), SELECTION::GetItem(), TOOL_MANAGER::GetMousePosition(), PCB_BASE_FRAME::GetPcbNewSettings(), GetSelection(), SELECTION::GetSize(), TOOL_MANAGER::GetTool(), SELECTION_TOOL::hasModifier(), PCB_POINT_EDITOR::HasPoint(), PCB_ACTIONS::highlightNet, ZONE::HitTestForCorner(), ZONE::HitTestForEdge(), EVENTS::InhibitSelectionEditing, IS_MOVING, IS_NEW, TOOL_BASE::IsToolActive(), EDA_BASE_FRAME::IsType(), KiROUND(), SELECTION_TOOL::m_canceledMenu, SELECTION_TOOL::m_disambiguateTimer, m_enteredGroup, PCBNEW_SETTINGS::m_ESCClearsNetHighlight, m_frame, SELECTION_TOOL::m_highlight_modifier, TOOL_INTERACTIVE::m_menu, m_nonModifiedCursor, SELECTION_TOOL::m_originalCursor, m_selection, TOOL_BASE::m_toolMgr, PCBNEW_SETTINGS::m_TrackDragAction, MD_ALT, MD_CTRL, MD_SHIFT, PCB_ACTIONS::move, MOVING, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_ZONE_T, TOOL_MANAGER::ProcessEvent(), PCB_ACTIONS::properties, ROUTER_TOOL::RoutingInProgress(), TOOL_MANAGER::RunAction(), SELECT, selectionContains(), selectMultiple(), selectPoint(), SELECTION::SetIsHover(), SELECTION_TOOL::setModifiersState(), TOOL_MENU::ShowContextMenu(), TOOLS_HOLDER::ToolStackIsEmpty(), TOOL_INTERACTIVE::Wait(), ACTIONS::zoomFitObjects, and ACTIONS::zoomFitScreen.

Referenced by setTransitions().

◆ onDisambiguationExpire()

void SELECTION_TOOL::onDisambiguationExpire ( wxTimerEvent & aEvent )

protectedinherited

Start the process to show our disambiguation menu once the user has kept the mouse down for the minimum time.

Parameters

aEvent

Definition at line 219 of file selection_tool.cpp.

{
 // If there is a multiple selection then it's more likely that we're seeing a paused drag
 // than a long-click.
 if( selection().GetSize() >= 2 && !hasModifier() )
 return;
 
 // If another tool has since started running then we don't want to interrupt
 if( !getEditFrame<EDA_DRAW_FRAME>()->ToolStackIsEmpty() )
 return;
 
 m_toolMgr->ProcessEvent( EVENTS::DisambiguatePoint );
}

References EVENTS::DisambiguatePoint, SELECTION_TOOL::hasModifier(), TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), and SELECTION_TOOL::selection().

Referenced by EE_SELECTION_TOOL::Init(), PL_SELECTION_TOOL::Init(), Init(), and ~PCB_SELECTION_TOOL().

◆ OnIdle()

void PCB_SELECTION_TOOL::OnIdle ( wxIdleEvent & aEvent )

Definition at line 243 of file pcb_selection_tool.cpp.

{
 if( m_frame->ToolStackIsEmpty() && !m_multiple )
 {
 wxMouseState keyboardState = wxGetMouseState();
 
 setModifiersState( keyboardState.ShiftDown(), keyboardState.ControlDown(),
 keyboardState.AltDown() );
 
 if( m_additive )
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ADD );
 else if( m_subtractive )
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::SUBTRACT );
 else if( m_exclusive_or )
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::XOR );
 else
 m_frame->GetCanvas()->SetCurrentCursor( m_nonModifiedCursor );
 }
}

References ADD, PCB_BASE_FRAME::GetCanvas(), SELECTION_TOOL::m_additive, SELECTION_TOOL::m_exclusive_or, m_frame, SELECTION_TOOL::m_multiple, m_nonModifiedCursor, SELECTION_TOOL::m_subtractive, EDA_DRAW_PANEL_GAL::SetCurrentCursor(), SELECTION_TOOL::setModifiersState(), SUBTRACT, TOOLS_HOLDER::ToolStackIsEmpty(), and XOR.

Referenced by PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME().

◆ RebuildSelection()

void PCB_SELECTION_TOOL::RebuildSelection ( )

Rebuild the selection from the EDA_ITEMs' selection flags.

Commonly called after rolling back an undo state to make sure there aren't any stale pointers.

Definition at line 2329 of file pcb_selection_tool.cpp.

{
 m_selection.Clear();
 
 bool enteredGroupFound = false;
 
 INSPECTOR_FUNC inspector =
 [&]( EDA_ITEM* item, void* testData )
 {
 if( item->IsSelected() )
 {
 EDA_ITEM* parent = item->GetParent();
 
 // Let selected parents handle their children.
 if( parent && parent->IsSelected() )
 return INSPECT_RESULT::CONTINUE;
 
 highlight( item, SELECTED, &m_selection );
 }
 
 if( item == m_enteredGroup )
 {
 item->SetFlags( ENTERED );
 enteredGroupFound = true;
 }
 else
 {
 item->ClearFlags( ENTERED );
 }
 
 return INSPECT_RESULT::CONTINUE;
 };
 
 board()->Visit( inspector, nullptr, m_isFootprintEditor ? GENERAL_COLLECTOR::FootprintItems
 : GENERAL_COLLECTOR::AllBoardItems );
 
 if( !enteredGroupFound )
 {
 m_enteredGroupOverlay.Clear();
 m_enteredGroup = nullptr;
 }
}

References GENERAL_COLLECTOR::AllBoardItems, board(), KIGFX::VIEW_GROUP::Clear(), SELECTION::Clear(), EDA_ITEM::ClearFlags(), CONTINUE, ENTERED, GENERAL_COLLECTOR::FootprintItems, EDA_ITEM::GetParent(), highlight(), EDA_ITEM::IsSelected(), m_enteredGroup, m_enteredGroupOverlay, m_isFootprintEditor, m_selection, SELECTED, EDA_ITEM::SetFlags(), and BOARD::Visit().

Referenced by EDIT_TOOL::doMoveSelection(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), and BOARD_COMMIT::Revert().

◆ RemoveItemFromSel() [1/2]

int SELECTION_TOOL::RemoveItemFromSel ( const TOOL_EVENT & aEvent )

inherited

Definition at line 150 of file selection_tool.cpp.

{
 RemoveItemFromSel( aEvent.Parameter<EDA_ITEM*>() );
 selection().SetIsHover( false );
 return 0;
}

References TOOL_EVENT::Parameter(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::selection(), and SELECTION::SetIsHover().

Referenced by PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), SELECTION_TOOL::RemoveItemFromSel(), EE_SELECTION_TOOL::setTransitions(), PL_SELECTION_TOOL::setTransitions(), setTransitions(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow().

◆ RemoveItemFromSel() [2/2]

void SELECTION_TOOL::RemoveItemFromSel	(	EDA_ITEM *	aItem,
		bool	aQuietMode = `false`
	)

inherited

Definition at line 158 of file selection_tool.cpp.

{
 if( aItem )
 {
 unselect( aItem );
 
 // Inform other potentially interested tools
 if( !aQuietMode )
 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
 }
}

References TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::unselect(), and EVENTS::UnselectedEvent.

◆ RemoveItemsFromSel() [1/3]

int SELECTION_TOOL::RemoveItemsFromSel ( const TOOL_EVENT & aEvent )

inherited

Definition at line 171 of file selection_tool.cpp.

{
 RemoveItemsFromSel( aEvent.Parameter<EDA_ITEMS*>(), false );
 selection().SetIsHover( false );
 return 0;
}

References TOOL_EVENT::Parameter(), SELECTION_TOOL::RemoveItemsFromSel(), SELECTION_TOOL::selection(), and SELECTION::SetIsHover().

Referenced by SCH_MOVE_TOOL::Main(), PCB_EDIT_FRAME::RebuildAndRefresh(), SELECTION_TOOL::RemoveItemsFromSel(), EE_SELECTION_TOOL::setTransitions(), PL_SELECTION_TOOL::setTransitions(), and setTransitions().

◆ RemoveItemsFromSel() [2/3]

void SELECTION_TOOL::RemoveItemsFromSel	(	EDA_ITEMS *	aList,
		bool	aQuietMode = `false`
	)

inherited

Definition at line 179 of file selection_tool.cpp.

{
 if( aList )
 {
 for( EDA_ITEM* item : *aList )
 unselect( item );
 
 // Inform other potentially interested tools
 if( !aQuietMode )
 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
 }
}

References TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::unselect(), and EVENTS::UnselectedEvent.

◆ RemoveItemsFromSel() [3/3]

void SELECTION_TOOL::RemoveItemsFromSel	(	std::vector< KIID > *	aList,
		bool	aQuietMode = `false`
	)

inherited

A safer version of RemoveItemsFromSel( EDA_ITEMS ) which doesn't require the items to still exist.

Definition at line 193 of file selection_tool.cpp.

{
 EDA_ITEMS removeItems;
 
 for( EDA_ITEM* item : selection() )
 {
 if( alg::contains( *aList, item->m_Uuid ) )
 removeItems.push_back( item );
 }
 
 RemoveItemsFromSel( &removeItems, aQuietMode );
}

References alg::contains(), SELECTION_TOOL::RemoveItemsFromSel(), and SELECTION_TOOL::selection().

◆ RequestSelection()

PCB_SELECTION & PCB_SELECTION_TOOL::RequestSelection	(	CLIENT_SELECTION_FILTER	aClientFilter,
		bool	aConfirmLockedItems = `false`
	)

Return the current selection, filtered according to aClientFilter.

If the set is empty, performs the legacy-style hover selection.

Parameters

aClientFilter	A callback to allow tool- or action-specific filtering.
aConfirmLockedItems	[optional] Signals that the user shall be asked if they want to drop locked items from the selection or override the locks. Select a single item under cursor event handler.

Definition at line 555 of file pcb_selection_tool.cpp.

{
 bool selectionEmpty = m_selection.Empty();
 m_selection.SetIsHover( selectionEmpty );
 
 if( selectionEmpty )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectionCursor, true, aClientFilter );
 m_selection.ClearReferencePoint();
 }
 
 if( aClientFilter )
 {
 enum DISPOSITION { BEFORE = 1, AFTER, BOTH };
 
 std::map<EDA_ITEM*, DISPOSITION> itemDispositions;
 GENERAL_COLLECTORS_GUIDE guide = getCollectorsGuide();
 GENERAL_COLLECTOR collector;
 
 collector.SetGuide( &guide );
 
 for( EDA_ITEM* item : m_selection )
 {
 collector.Append( item );
 itemDispositions[ item ] = BEFORE;
 }
 
 aClientFilter( VECTOR2I(), collector, this );
 
 for( EDA_ITEM* item : collector )
 {
 if( itemDispositions.count( item ) )
 itemDispositions[ item ] = BOTH;
 else
 itemDispositions[ item ] = AFTER;
 }
 
 // Unhighlight the BEFORE items before highlighting the AFTER items.
 // This is so that in the case of groups, if aClientFilter replaces a selection
 // with the enclosing group, the unhighlight of the element doesn't undo the
 // recursive highlighting of that element by the group.
 
 for( std::pair<EDA_ITEM* const, DISPOSITION> itemDisposition : itemDispositions )
 {
 EDA_ITEM* item = itemDisposition.first;
 DISPOSITION disposition = itemDisposition.second;
 
 if( disposition == BEFORE )
 unhighlight( item, SELECTED, &m_selection );
  }
 
 for( std::pair<EDA_ITEM* const, DISPOSITION> itemDisposition : itemDispositions )
 {
 EDA_ITEM* item = itemDisposition.first;
 DISPOSITION disposition = itemDisposition.second;
 
 // Note that we must re-highlight even previously-highlighted items
 // (ie: disposition BOTH) in case we removed any of their children.
 if( disposition == AFTER || disposition == BOTH )
 highlight( item, SELECTED, &m_selection );
 }
 
 m_frame->GetCanvas()->ForceRefresh();
 }
 
 if( aConfirmLockedItems )
 {
 std::vector<BOARD_ITEM*> lockedItems;
 
 for( EDA_ITEM* item : m_selection )
 {
 BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( item );
 
 if( boardItem->Type() == PCB_GROUP_T )
 {
 PCB_GROUP* group = static_cast<PCB_GROUP*>( boardItem );
 bool lockedDescendant = false;
 
 group->RunOnDescendants(
  [&lockedDescendant]( BOARD_ITEM* child )
 {
 if( child->IsLocked() )
 lockedDescendant = true;
 } );
 
 if( lockedDescendant )
 lockedItems.push_back( group );
 }
 else if( boardItem->IsLocked() )
 {
 lockedItems.push_back( boardItem );
 }
 }
 
 if( !lockedItems.empty() )
 {
 DIALOG_LOCKED_ITEMS_QUERY dlg( frame(), (int) lockedItems.size() );
 
 switch( dlg.ShowModal() )
 {
 case wxID_OK:
 // remove locked items from selection
 for( BOARD_ITEM* item : lockedItems )
 unselect( item );
 
 break;
 
 case wxID_CANCEL:
 // cancel operation
 ClearSelection();
 break;
 
 case wxID_APPLY:
 // continue with operation with current selection
 break;
 }
 }
 }
 
 return m_selection;
}

References COLLECTOR::Append(), SELECTION::ClearReferencePoint(), ClearSelection(), SELECTION::Empty(), EDA_DRAW_PANEL_GAL::ForceRefresh(), frame(), PCB_BASE_FRAME::GetCanvas(), getCollectorsGuide(), group, highlight(), BOARD_ITEM::IsLocked(), m_frame, m_selection, TOOL_BASE::m_toolMgr, PCB_GROUP_T, TOOL_MANAGER::RunAction(), SELECTED, PCB_ACTIONS::selectionCursor, GENERAL_COLLECTOR::SetGuide(), SELECTION::SetIsHover(), DIALOG_LOCKED_ITEMS_QUERY::ShowModal(), EDA_ITEM::Type(), unhighlight(), and unselect().

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), EDIT_TOOL::ChangeTrackWidth(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), EDIT_TOOL::FilletLines(), EDIT_TOOL::FilletTracks(), EDIT_TOOL::Flip(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GROUP_TOOL::Group(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), EDIT_TOOL::PackAndMoveFootprints(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Properties(), EDIT_TOOL::Remove(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), EDIT_TOOL::Rotate(), CONVERT_TOOL::SegmentToArc(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), and EDIT_TOOL::Swap().

◆ Reset()

void PCB_SELECTION_TOOL::Reset ( RESET_REASON aReason )

overridevirtual

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.

Implements TOOL_BASE.

Definition at line 210 of file pcb_selection_tool.cpp.

{
 m_frame = getEditFrame<PCB_BASE_FRAME>();
 m_isFootprintEditor = m_frame->IsType( FRAME_FOOTPRINT_EDITOR );
 
 if( m_enteredGroup )
 ExitGroup();
 
 if( aReason == TOOL_BASE::MODEL_RELOAD )
 {
 // Deselect any item being currently in edit, to avoid unexpected behavior
 // and remove pointers to the selected items from containers
 // without changing their properties (as they are already deleted
 // while a new board is loaded)
 ClearSelection( true );
 
 getView()->GetPainter()->GetSettings()->SetHighlight( false );
 }
 else if ( aReason != TOOL_BASE::REDRAW )
 {
 // Restore previous properties of selected items and remove them from containers
 ClearSelection( true );
 }
 
 // Reinsert the VIEW_GROUP, in case it was removed from the VIEW
 view()->Remove( &m_selection );
 view()->Add( &m_selection );
 
 view()->Remove( &m_enteredGroupOverlay );
 view()->Add( &m_enteredGroupOverlay );
}

References KIGFX::PCB_VIEW::Add(), ClearSelection(), ExitGroup(), FRAME_FOOTPRINT_EDITOR, KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), TOOL_BASE::getView(), EDA_BASE_FRAME::IsType(), m_enteredGroup, m_enteredGroupOverlay, m_frame, m_isFootprintEditor, m_selection, TOOL_BASE::MODEL_RELOAD, TOOL_BASE::REDRAW, KIGFX::PCB_VIEW::Remove(), KIGFX::RENDER_SETTINGS::SetHighlight(), and view().

◆ resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

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

Definition at line 63 of file tool_interactive.cpp.

{
 m_toolMgr->ClearTransitions( this );
 setTransitions();
}

References TOOL_MANAGER::ClearTransitions(), TOOL_BASE::m_toolMgr, and TOOL_INTERACTIVE::setTransitions().

◆ 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 87 of file tool_interactive.cpp.

{
 m_toolMgr->RunMainStack( this, std::move( aFunc ) );
}

References TOOL_BASE::m_toolMgr, and TOOL_MANAGER::RunMainStack().

Referenced by DRAWING_TOOL::PlaceText().

◆ select()

void PCB_SELECTION_TOOL::select ( EDA_ITEM * aItem )

overridevirtual

Take necessary action mark an item as selected.

Parameters

aItem The item to be selected.

Implements SELECTION_TOOL.

Definition at line 2628 of file pcb_selection_tool.cpp.

{
 if( aItem->IsSelected() )
 return;
 
 if( aItem->Type() == PCB_PAD_T )
 {
 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( aItem->GetParent() );
 
 if( m_selection.Contains( footprint ) )
 return;
 }
 
 if( m_enteredGroup &&
 !PCB_GROUP::WithinScope( static_cast<BOARD_ITEM*>( aItem ), m_enteredGroup,
 m_isFootprintEditor ) )
 {
 ExitGroup();
 }
 
 highlight( aItem, SELECTED, &m_selection );
}

References SELECTION::Contains(), ExitGroup(), EDA_ITEM::GetParent(), highlight(), EDA_ITEM::IsSelected(), m_enteredGroup, m_isFootprintEditor, m_selection, PCB_PAD_T, SELECTED, EDA_ITEM::Type(), and PCB_GROUP::WithinScope().

Referenced by doSyncSelection(), EnterGroup(), ExitGroup(), filterSelection(), FindItem(), grabUnconnected(), GROUP_TOOL::Group(), SelectAll(), selectAllConnectedTracks(), SelectAllItemsOnNet(), selectAllItemsOnSheet(), selectConnections(), selectMultiple(), selectNet(), selectPoint(), selectUnconnected(), and unrouteSelected().

◆ Selectable()

bool PCB_SELECTION_TOOL::Selectable	(	const BOARD_ITEM *	aItem,
		bool	checkVisibilityOnly = `false`
	)		const

Returns: true if an item fulfills conditions to be selected.

Definition at line 2373 of file pcb_selection_tool.cpp.

{
 const RENDER_SETTINGS* settings = getView()->GetPainter()->GetSettings();
 
 auto visibleLayers =
 [&]()
 {
 if( m_isFootprintEditor )
 {
 LSET set;
 
 for( PCB_LAYER_ID layer : LSET::AllLayersMask().Seq() )
 set.set( layer, view()->IsLayerVisible( layer ) );
 
 return set;
 }
 else
 {
  return board()->GetVisibleLayers();
 }
 };
 
 if( settings->GetHighContrast() )
 {
 const std::set<int> activeLayers = settings->GetHighContrastLayers();
 bool onActiveLayer = false;
 
 for( int layer : activeLayers )
 {
 // NOTE: Only checking the regular layers (not GAL meta-layers)
 if( layer < PCB_LAYER_ID_COUNT && aItem->IsOnLayer( ToLAYER_ID( layer ), true ) )
 {
 onActiveLayer = true;
 break;
 }
 }
 
 if( !onActiveLayer ) // We do not want to select items that are in the background
 return false;
 }
 
 if( aItem->Type() == PCB_FOOTPRINT_T )
 {
 // In footprint editor, we do not want to select the footprint itself.
 if( m_isFootprintEditor )
 return false;
 
 // Allow selection of footprints if some part of the footprint is visible.
 const FOOTPRINT* footprint = static_cast<const FOOTPRINT*>( aItem );
 LSET boardSide = footprint->IsFlipped() ? LSET::BackMask() : LSET::FrontMask();
 
 if( !( visibleLayers() & boardSide ).any() && !m_skip_heuristics )
 return false;
 
 // If the footprint has no items except the reference and value fields, include the
 // footprint in the selections.
 if( footprint->GraphicalItems().empty()
 && footprint->Pads().empty()
 && footprint->Zones().empty() )
 {
 return true;
 }
 
 for( const BOARD_ITEM* item : footprint->GraphicalItems() )
 {
 if( Selectable( item, true ) )
 return true;
 }
 
 for( const PAD* pad : footprint->Pads() )
 {
 if( Selectable( pad, true ) )
 return true;
 }
 
 for( const ZONE* zone : footprint->Zones() )
 {
 if( Selectable( zone, true ) )
 return true;
 }
 
 return false;
 }
 else if( aItem->Type() == PCB_GROUP_T )
 {
 PCB_GROUP* group = const_cast<PCB_GROUP*>( static_cast<const PCB_GROUP*>( aItem ) );
 
 // Similar to logic for footprint, a group is selectable if any of its members are.
 // (This recurses.)
 for( BOARD_ITEM* item : group->GetItems() )
 {
 if( Selectable( item, true ) )
 return true;
 }
 
 return false;
 }
 
 const ZONE* zone = nullptr;
 const PCB_VIA* via = nullptr;
 const PAD* pad = nullptr;
 const FP_TEXT* text = nullptr;
 
 switch( aItem->Type() )
 {
 case PCB_ZONE_T:
 case PCB_FP_ZONE_T:
 if( !board()->IsElementVisible( LAYER_ZONES ) )
 return false;
 
 zone = static_cast<const ZONE*>( aItem );
 
 // A footprint zone is only selectable within the footprint editor
 if( zone->GetParent()
 && zone->GetParent()->Type() == PCB_FOOTPRINT_T
 && !m_isFootprintEditor
 && !checkVisibilityOnly )
 {
 return false;
 }
 
 // zones can exist on multiple layers!
 if( !( zone->GetLayerSet() & visibleLayers() ).any() )
 return false;
 
 break;
 
 case PCB_TRACE_T:
 case PCB_ARC_T:
 if( !board()->IsElementVisible( LAYER_TRACKS ) )
 return false;
 
 if( m_isFootprintEditor )
 {
 if( !view()->IsLayerVisible( aItem->GetLayer() ) )
 return false;
 }
 else
 {
 if( !board()->IsLayerVisible( aItem->GetLayer() ) )
 return false;
 }
 
 break;
 
 case PCB_VIA_T:
 if( !board()->IsElementVisible( LAYER_VIAS ) )
 return false;
 
 via = static_cast<const PCB_VIA*>( aItem );
 
 // For vias it is enough if only one of its layers is visible
 if( !( visibleLayers() & via->GetLayerSet() ).any() )
 return false;
 
 break;
 
 case PCB_FP_TEXT_T:
 if( m_isFootprintEditor )
 {
 text = static_cast<const FP_TEXT*>( aItem );
 
 if( !text->IsVisible() && !view()->IsLayerVisible( LAYER_MOD_TEXT_INVISIBLE ) )
 return false;
 
 if( !view()->IsLayerVisible( aItem->GetLayer() ) )
 return false;
 }
 else
 {
 if( !view()->IsVisible( aItem ) )
 return false;
 
 if( !board()->IsLayerVisible( aItem->GetLayer() ) )
 return false;
 
 int controlLayer = UNDEFINED_LAYER;
 
 switch( static_cast<const FP_TEXT*>( aItem )->GetType() )
 {
 case FP_TEXT::TEXT_is_REFERENCE: controlLayer = LAYER_MOD_REFERENCES; break;
 case FP_TEXT::TEXT_is_VALUE: controlLayer = LAYER_MOD_VALUES; break;
 case FP_TEXT::TEXT_is_DIVERS: controlLayer = LAYER_MOD_TEXT; break;
 }
 
 if( controlLayer == UNDEFINED_LAYER )
 return false;
 
 if( !view()->IsLayerVisible( controlLayer ) )
 return false;
 }
 
 break;
 
 case PCB_FP_SHAPE_T:
 case PCB_FP_TEXTBOX_T:
 if( m_isFootprintEditor )
 {
 if( !view()->IsLayerVisible( aItem->GetLayer() ) )
 return false;
 }
 else
 {
 // Footprint shape selections are only allowed in footprint editor mode.
 if( !checkVisibilityOnly )
 return false;
 
 if( !board()->IsLayerVisible( aItem->GetLayer() ) )
 return false;
 }
 
 break;
 
 case PCB_PAD_T:
 pad = static_cast<const PAD*>( aItem );
 
 if( pad->GetAttribute() == PAD_ATTRIB::PTH || pad->GetAttribute() == PAD_ATTRIB::NPTH )
 {
 // Check render mode (from the Items tab) first
 if( !board()->IsElementVisible( LAYER_PADS_TH ) )
 return false;
 
 // A pad's hole is visible on every layer the pad is visible on plus many layers the
 // pad is not visible on -- so we only need to check for any visible hole layers.
 if( !( visibleLayers() & LSET::PhysicalLayersMask() ).any() )
 return false;
 }
 else
 {
 // Check render mode (from the Items tab) first
 if( pad->IsOnLayer( F_Cu ) && !board()->IsElementVisible( LAYER_PAD_FR ) )
 return false;
 else if( pad->IsOnLayer( B_Cu ) && !board()->IsElementVisible( LAYER_PAD_BK ) )
 return false;
 
 if( !( pad->GetLayerSet() & visibleLayers() ).any() )
 return false;
 }
 
 break;
 
 // These are not selectable
 case PCB_NETINFO_T:
 case NOT_USED:
 case TYPE_NOT_INIT:
 return false;
 
 default: // Suppress warnings
 break;
 }
 
 return true;
}

References LSET::AllLayersMask(), B_Cu, LSET::BackMask(), board(), F_Cu, LSET::FrontMask(), KIGFX::RENDER_SETTINGS::GetHighContrast(), KIGFX::RENDER_SETTINGS::GetHighContrastLayers(), BOARD_ITEM::GetLayer(), ZONE::GetLayerSet(), KIGFX::VIEW::GetPainter(), BOARD_ITEM::GetParent(), KIGFX::PAINTER::GetSettings(), FP_TEXT::GetType(), TOOL_BASE::getView(), BOARD::GetVisibleLayers(), FOOTPRINT::GraphicalItems(), group, BOARD::IsElementVisible(), FOOTPRINT::IsFlipped(), KIGFX::VIEW::IsLayerVisible(), BOARD::IsLayerVisible(), KIGFX::VIEW::IsVisible(), LAYER_MOD_REFERENCES, LAYER_MOD_TEXT, LAYER_MOD_TEXT_INVISIBLE, LAYER_MOD_VALUES, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_TH, LAYER_TRACKS, LAYER_VIAS, LAYER_ZONES, m_isFootprintEditor, SELECTION_TOOL::m_skip_heuristics, NOT_USED, NPTH, pad, FOOTPRINT::Pads(), PCB_ARC_T, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_NETINFO_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, LSET::PhysicalLayersMask(), PTH, Selectable(), LSET::Seq(), text, FP_TEXT::TEXT_is_DIVERS, FP_TEXT::TEXT_is_REFERENCE, FP_TEXT::TEXT_is_VALUE, ToLAYER_ID(), EDA_ITEM::Type(), TYPE_NOT_INIT, UNDEFINED_LAYER, via, view(), and FOOTPRINT::Zones().

Referenced by PCB_CONTROL::DeleteItemCursor(), Selectable(), SelectAll(), selectMultiple(), and selectPoint().

◆ SelectAll()

int PCB_SELECTION_TOOL::SelectAll ( const TOOL_EVENT & aEvent )

Definition at line 1079 of file pcb_selection_tool.cpp.

{
 KIGFX::VIEW* view = getView();
 
 // hold all visible items
 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> selectedItems;
 
 // Filter the view items based on the selection box
 BOX2I selectionBox;
 
 // Intermediate step to allow filtering against hierarchy
 GENERAL_COLLECTOR collection;
 
 selectionBox.SetMaximum();
 view->Query( selectionBox, selectedItems ); // Get the list of selected items
 
 for( const KIGFX::VIEW::LAYER_ITEM_PAIR& item_pair : selectedItems )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( item_pair.first );
 
 if( !item || !Selectable( item ) || !itemPassesFilter( item, true ) )
 continue;
 
 collection.Append( item );
 }
 
 FilterCollectorForHierarchy( collection, true );
 
 for( EDA_ITEM* item : collection )
 select( item );
 
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 
 m_frame->GetCanvas()->ForceRefresh();
 
 return 0;
}

References COLLECTOR::Append(), FilterCollectorForHierarchy(), EDA_DRAW_PANEL_GAL::ForceRefresh(), PCB_BASE_FRAME::GetCanvas(), TOOL_BASE::getView(), itemPassesFilter(), m_frame, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), KIGFX::VIEW::Query(), select(), Selectable(), EVENTS::SelectedEvent, BOX2< Vec >::SetMaximum(), and view().

Referenced by setTransitions().

◆ selectAllConnectedTracks()

void PCB_SELECTION_TOOL::selectAllConnectedTracks	(	const std::vector< BOARD_CONNECTED_ITEM * > &	aStartItems,
		STOP_CONDITION	aStopCondition
	)

private

Select connected tracks and vias.

Parameters

aStopCondition Indicates where to stop selecting more items.

Definition at line 1231 of file pcb_selection_tool.cpp.

{
 const LSET allCuMask = LSET::AllCuMask();
 
 PROF_TIMER refreshTimer;
 double refreshIntervalMs = 500; // Refresh display with this interval to indicate progress
 int lastSelectionSize = (int) m_selection.GetSize();
 
 auto connectivity = board()->GetConnectivity();
 
 std::map<VECTOR2I, std::vector<PCB_TRACK*>> trackMap;
 std::map<VECTOR2I, PCB_VIA*> viaMap;
 std::map<VECTOR2I, PAD*> padMap;
 std::set<PAD*> startPadSet;
 std::vector<BOARD_CONNECTED_ITEM*> cleanupItems;
 std::vector<std::pair<VECTOR2I, LSET>> activePts;
 
 for( BOARD_CONNECTED_ITEM* startItem : aStartItems )
 {
 // Track starting pads
 if( startItem->Type() == PCB_PAD_T )
 startPadSet.insert( static_cast<PAD*>( startItem ) );
 }
 
 for( BOARD_CONNECTED_ITEM* startItem : aStartItems )
 {
 if( startItem->HasFlag( SKIP_STRUCT ) ) // Skip already visited items
 continue;
 
 auto connectedItems = connectivity->GetConnectedItems( startItem,
 { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T, PCB_PAD_T }, true );
 
 // Build maps of connected items
 for( BOARD_CONNECTED_ITEM* item : connectedItems )
 {
 switch( item->Type() )
 {
 case PCB_ARC_T:
 case PCB_TRACE_T:
 {
 PCB_TRACK* track = static_cast<PCB_TRACK*>( item );
 trackMap[track->GetStart()].push_back( track );
 trackMap[track->GetEnd()].push_back( track );
 break;
 }
 
 case PCB_VIA_T:
 {
 PCB_VIA* via = static_cast<PCB_VIA*>( item );
 viaMap[via->GetStart()] = via;
 break;
 }
 
 case PCB_PAD_T:
 {
 PAD* pad = static_cast<PAD*>( item );
 padMap[pad->GetPosition()] = pad;
 break;
 }
 
 default:
 break;
 }
 }
 
 // Set up the initial active points
 switch( startItem->Type() )
 {
 case PCB_ARC_T:
 case PCB_TRACE_T:
 {
 PCB_TRACK* track = static_cast<PCB_TRACK*>( startItem );
 
 activePts.push_back( { track->GetStart(), track->GetLayerSet() } );
 activePts.push_back( { track->GetEnd(), track->GetLayerSet() } );
 break;
 }
 
 case PCB_VIA_T:
 activePts.push_back( { startItem->GetPosition(), startItem->GetLayerSet() } );
 break;
 
 case PCB_PAD_T:
 activePts.push_back( { startItem->GetPosition(), startItem->GetLayerSet() } );
 break;
 
 default:
 break;
 }
 
 bool expand = true;
 int failSafe = 0;
 
 // Iterative push from all active points
 while( expand && failSafe++ < 100000 )
 {
 expand = false;
 
 for( int i = (int) activePts.size() - 1; i >= 0; --i )
 {
 VECTOR2I pt = activePts[i].first;
 LSET layerSetCu = activePts[i].second & allCuMask;
 
 auto viaIt = viaMap.find( pt );
 auto padIt = padMap.find( pt );
 
 bool gotVia = ( viaIt != viaMap.end() )
 && ( layerSetCu & ( viaIt->second->GetLayerSet() ) ).any();
 
 bool gotPad = ( padIt != padMap.end() )
 && ( layerSetCu & ( padIt->second->GetLayerSet() ) ).any();
 
 bool gotNonStartPad =
 gotPad && ( startPadSet.find( padIt->second ) == startPadSet.end() );
 
 if( aStopCondition == STOP_AT_JUNCTION )
 {
 size_t pt_count = 0;
 
 for( PCB_TRACK* track : trackMap[pt] )
 {
 if( track->GetStart() != track->GetEnd()
 && layerSetCu.Contains( track->GetLayer() ) )
 {
 pt_count++;
 }
 }
 
 if( pt_count > 2 || gotVia || gotNonStartPad )
 {
 activePts.erase( activePts.begin() + i );
 continue;
 }
 }
 else if( aStopCondition == STOP_AT_PAD )
 {
 if( gotNonStartPad )
 {
 activePts.erase( activePts.begin() + i );
 continue;
 }
 }
 
 if( gotPad )
 {
 PAD* pad = padIt->second;
 
 if( !pad->HasFlag( SKIP_STRUCT ) )
 {
 pad->SetFlags( SKIP_STRUCT );
 cleanupItems.push_back( pad );
 
 activePts.push_back( { pad->GetPosition(), pad->GetLayerSet() } );
 expand = true;
 }
 }
 
 for( PCB_TRACK* track : trackMap[pt] )
 {
 if( !layerSetCu.Contains( track->GetLayer() ) )
 continue;
 
 if( !track->IsSelected() )
 select( track );
 
 if( !track->HasFlag( SKIP_STRUCT ) )
 {
 track->SetFlags( SKIP_STRUCT );
 cleanupItems.push_back( track );
 
 if( track->GetStart() == pt )
 activePts.push_back( { track->GetEnd(), track->GetLayerSet() } );
 else
 activePts.push_back( { track->GetStart(), track->GetLayerSet() } );
 
 expand = true;
 }
 }
 
 if( viaMap.count( pt ) )
 {
 PCB_VIA* via = viaMap[pt];
 
 if( !via->IsSelected() )
 select( via );
 
 if( !via->HasFlag( SKIP_STRUCT ) )
 {
 via->SetFlags( SKIP_STRUCT );
 cleanupItems.push_back( via );
 
 activePts.push_back( { via->GetPosition(), via->GetLayerSet() } );
 expand = true;
 }
 }
 
 activePts.erase( activePts.begin() + i );
 }
 
 // Refresh display for the feel of progress
 if( refreshTimer.msecs() >= refreshIntervalMs )
 {
 if( m_selection.Size() != lastSelectionSize )
 {
 m_frame->GetCanvas()->ForceRefresh();
 lastSelectionSize = m_selection.Size();
 }
 
 refreshTimer.Start();
 }
 }
 }
 
 for( BOARD_CONNECTED_ITEM* item : cleanupItems )
 item->ClearFlags( SKIP_STRUCT );
}

References LSET::AllCuMask(), board(), LSET::Contains(), EDA_DRAW_PANEL_GAL::ForceRefresh(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetConnectivity(), PCB_TRACK::GetEnd(), BOARD_ITEM::GetLayerSet(), SELECTION::GetSize(), PCB_TRACK::GetStart(), m_frame, m_selection, PROF_TIMER::msecs(), pad, PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, select(), SELECTION::Size(), SKIP_STRUCT, PROF_TIMER::Start(), STOP_AT_JUNCTION, STOP_AT_PAD, and via.

Referenced by expandConnection(), selectConnections(), and unrouteSelected().

◆ SelectAllItemsOnNet()

void PCB_SELECTION_TOOL::SelectAllItemsOnNet	(	int	aNetCode,
		bool	aSelect = `true`
	)

Select all items with the given net code.

Parameters

aNetCode	is the target net to select
aSelect	is true to add the items to the selection, false to remove them (deselect)

Definition at line 1559 of file pcb_selection_tool.cpp.

{
 std::shared_ptr<CONNECTIVITY_DATA> conn = board()->GetConnectivity();
 
 for( BOARD_ITEM* item : conn->GetNetItems( aNetCode, { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T } ) )
 {
 if( itemPassesFilter( item, true ) )
 aSelect ? select( item ) : unselect( item );
 }
}

References board(), BOARD::GetConnectivity(), itemPassesFilter(), select(), and unselect().

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), FindItem(), and selectNet().

◆ selectAllItemsOnSheet()

void PCB_SELECTION_TOOL::selectAllItemsOnSheet ( wxString & aSheetPath )

private

Select all items with the given sheet timestamp/UUID name (the sheet path).

The path of the root sheet is "/". Select all footprints belonging to same sheet, from Eeschema using cross-probing.

Definition at line 1615 of file pcb_selection_tool.cpp.

{
 std::vector<BOARD_ITEM*> footprints;
 
 // store all footprints that are on that sheet path
 for( FOOTPRINT* footprint : board()->Footprints() )
 {
 if( footprint == nullptr )
 continue;
 
 wxString footprint_path = footprint->GetPath().AsString().BeforeLast( '/' );
 
 if( footprint_path.IsEmpty() )
 footprint_path += '/';
 
 if( footprint_path == aSheetPath )
 footprints.push_back( footprint );
 }
 
 for( BOARD_ITEM* i : footprints )
 {
 if( i != nullptr )
 select( i );
 }
 
 selectConnections( footprints );
}

References board(), select(), and selectConnections().

Referenced by selectSameSheet(), and selectSheetContents().

◆ selectConnections()

void PCB_SELECTION_TOOL::selectConnections ( const std::vector< BOARD_ITEM * > & aItems )

private

Definition at line 1644 of file pcb_selection_tool.cpp.

{
 // Generate a list of all pads, and of all nets they belong to.
 std::list<int> netcodeList;
 std::vector<BOARD_CONNECTED_ITEM*> padList;
 
 for( BOARD_ITEM* item : aItems )
 {
 switch( item->Type() )
 {
 case PCB_FOOTPRINT_T:
 {
 for( PAD* pad : static_cast<FOOTPRINT*>( item )->Pads() )
 {
 if( pad->IsConnected() )
 {
 netcodeList.push_back( pad->GetNetCode() );
 padList.push_back( pad );
 }
 }
 
 break;
 }
 
 case PCB_PAD_T:
 {
 PAD* pad = static_cast<PAD*>( item );
 
 if( pad->IsConnected() )
 {
 netcodeList.push_back( pad->GetNetCode() );
 padList.push_back( pad );
 }
 
 break;
 }
 
 default:
 break;
 }
 }
 
 // Sort for binary search
 std::sort( padList.begin(), padList.end() );
 
 // remove all duplicates
 netcodeList.sort();
 netcodeList.unique();
 
 selectAllConnectedTracks( padList, STOP_AT_PAD );
 
 // now we need to find all footprints that are connected to each of these nets then we need
 // to determine if these footprints are in the list of footprints
 std::vector<int> removeCodeList;
 std::shared_ptr<CONNECTIVITY_DATA> conn = board()->GetConnectivity();
 
 for( int netCode : netcodeList )
 {
 for( BOARD_CONNECTED_ITEM* pad : conn->GetNetItems( netCode, { PCB_PAD_T } ) )
 {
 if( !std::binary_search( padList.begin(), padList.end(), pad ) )
 {
 // if we cannot find the pad in the padList then we can assume that that pad
 // should not be used, therefore invalidate this netcode.
 removeCodeList.push_back( netCode );
 break;
 }
 }
 }
 
 for( int removeCode : removeCodeList )
 netcodeList.remove( removeCode );
 
 std::unordered_set<BOARD_ITEM*> localConnectionList;
 
 for( int netCode : netcodeList )
 {
 for( BOARD_ITEM* item : conn->GetNetItems( netCode, { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T } ) )
 localConnectionList.insert( item );
 }
 
 for( BOARD_ITEM* item : localConnectionList )
 select( item );
}

References board(), BOARD::GetConnectivity(), pad, PCB_FOOTPRINT_T, PCB_PAD_T, select(), selectAllConnectedTracks(), and STOP_AT_PAD.

Referenced by doSyncSelection(), and selectAllItemsOnSheet().

◆ selectCursor()

bool PCB_SELECTION_TOOL::selectCursor	(	bool	aForceSelect = `false`,
		CLIENT_SELECTION_FILTER	aClientFilter = `nullptr`
	)

private

Select an item under the cursor unless there is something already selected.

Parameters

aForceSelect	[optional] Forces an item to be selected even if there is already a selection.
aClientFilter	A callback to allow tool- or action-specific filtering.

Returns: whether or not the selection is empty.

Definition at line 837 of file pcb_selection_tool.cpp.

{
 if( aForceSelect || m_selection.Empty() )
 {
 ClearSelection( true /*quiet mode*/ );
 selectPoint( getViewControls()->GetCursorPosition( false ), false, nullptr, aClientFilter );
 }
 
 return !m_selection.Empty();
}

References ClearSelection(), SELECTION::Empty(), TOOL_BASE::getViewControls(), m_selection, and selectPoint().

Referenced by CursorSelection(), expandConnection(), and selectNet().

◆ selection()

SELECTION & PCB_SELECTION_TOOL::selection ( )

inlineoverrideprotectedvirtual

Return a reference to the selection.

Implements SELECTION_TOOL.

Definition at line 242 of file pcb_selection_tool.h.

242{ return m_selection; }

References m_selection.

Referenced by filterSelection(), and selectNet().

◆ selectionContains()

bool PCB_SELECTION_TOOL::selectionContains ( const VECTOR2I & aPoint ) const

private

Returns: true if the given point is contained in any of selected items' bounding boxes.

Definition at line 2745 of file pcb_selection_tool.cpp.

{
 const unsigned GRIP_MARGIN = 20;
 int margin = KiROUND( getView()->ToWorld( GRIP_MARGIN ) );
 
 // Check if the point is located close to any of the currently selected items
 for( EDA_ITEM* item : m_selection )
 {
 BOX2I itemBox = item->ViewBBox();
 itemBox.Inflate( margin ); // Give some margin for gripping an item
 
 if( itemBox.Contains( aPoint ) )
 {
 if( item->HitTest( aPoint, margin ) )
 return true;
 
 bool found = false;
 
 std::function<void( PCB_GROUP* )> checkGroup;
 checkGroup = [&]( PCB_GROUP* aGroup )
 {
 aGroup->RunOnChildren(
 [&]( BOARD_ITEM* aItem )
 {
 if( PCB_GROUP* group = dyn_cast<PCB_GROUP*>( aItem ) )
 checkGroup( group );
 else if( aItem->HitTest( aPoint, margin ) )
 found = true;
 } );
 };
 
 if( PCB_GROUP* group = dyn_cast<PCB_GROUP*>( item ) )
 {
 checkGroup( group );
 
 if( found )
 return true;
 }
 }
 }
 
 return false;
}

References BOX2< Vec >::Contains(), TOOL_BASE::getView(), group, EDA_ITEM::HitTest(), BOX2< Vec >::Inflate(), KiROUND(), and m_selection.

Referenced by Main().

◆ SelectionMenu()

int SELECTION_TOOL::SelectionMenu ( const TOOL_EVENT & aEvent )

inherited

Show a popup menu to trim the COLLECTOR passed as aEvent's parameter down to a single item.

Note: This routine does not modify the selection.

Definition at line 234 of file selection_tool.cpp.

{
 COLLECTOR* collector = aEvent.Parameter<COLLECTOR*>();
 
 if( !doSelectionMenu( collector ) )
 collector->m_MenuCancelled = true;
 
 return 0;
}

References SELECTION_TOOL::doSelectionMenu(), COLLECTOR::m_MenuCancelled, and TOOL_EVENT::Parameter().

Referenced by EE_SELECTION_TOOL::setTransitions(), PL_SELECTION_TOOL::setTransitions(), and setTransitions().

◆ selectMultiple()

bool PCB_SELECTION_TOOL::selectMultiple ( )

private

Handle drawing a selection box that allows one to select many items at the same time.

Returns: true if the function was canceled (i.e. CancelEvent was received).

Definition at line 862 of file pcb_selection_tool.cpp.

{
 bool cancelled = false; // Was the tool cancelled while it was running?
 m_multiple = true; // Multiple selection mode is active
 KIGFX::VIEW* view = getView();
 
 KIGFX::PREVIEW::SELECTION_AREA area;
 view->Add( &area );
 
 bool anyAdded = false;
 bool anySubtracted = false;
 
 while( TOOL_EVENT* evt = Wait() )
 {
 int width = area.GetEnd().x - area.GetOrigin().x;
 
 /* Selection mode depends on direction of drag-selection:
 * Left > Right : Select objects that are fully enclosed by selection
 * Right > Left : Select objects that are crossed by selection
 */
 bool greedySelection = width >= 0 ? false : true;
 
 if( view->IsMirroredX() )
 greedySelection = !greedySelection;
 
 m_frame->GetCanvas()->SetCurrentCursor( !greedySelection ? KICURSOR::SELECT_WINDOW
 : KICURSOR::SELECT_LASSO );
 
 if( evt->IsCancelInteractive() || evt->IsActivate() )
 {
 cancelled = true;
 break;
 }
 
 if( evt->IsDrag( BUT_LEFT ) )
 {
 if( !m_drag_additive && !m_drag_subtractive )
 {
 if( m_selection.GetSize() > 0 )
 {
 anySubtracted = true;
 ClearSelection( true /*quiet mode*/ );
 }
 }
 
 // Start drawing a selection box
 area.SetOrigin( evt->DragOrigin() );
 area.SetEnd( evt->Position() );
 area.SetAdditive( m_drag_additive );
 area.SetSubtractive( m_drag_subtractive );
 area.SetExclusiveOr( false );
 
 view->SetVisible( &area, true );
 view->Update( &area );
 getViewControls()->SetAutoPan( true );
 }
 
 if( evt->IsMouseUp( BUT_LEFT ) )
 {
 getViewControls()->SetAutoPan( false );
 
 // End drawing the selection box
 view->SetVisible( &area, false );
 
 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> candidates;
 BOX2I selectionBox = area.ViewBBox();
 view->Query( selectionBox, candidates ); // Get the list of nearby items
 
 int height = area.GetEnd().y - area.GetOrigin().y;
 
 // Construct a BOX2I to determine BOARD_ITEM selection
 BOX2I selectionRect( area.GetOrigin(), VECTOR2I( width, height ) );
 
 selectionRect.Normalize();
 
 GENERAL_COLLECTOR collector;
 GENERAL_COLLECTOR padsCollector;
 std::set<BOARD_ITEM*> group_items;
 
 for( PCB_GROUP* group : board()->Groups() )
 {
 // The currently entered group does not get limited
 if( m_enteredGroup == group )
 continue;
 
 std::unordered_set<BOARD_ITEM*>& newset = group->GetItems();
 
 // If we are not greedy and have selected the whole group, add just one item
 // to allow it to be promoted to the group later
 if( !greedySelection && selectionRect.Contains( group->GetBoundingBox() )
 && newset.size() )
 {
 for( BOARD_ITEM* group_item : newset )
 {
 if( Selectable( group_item ) )
 collector.Append( *newset.begin() );
 }
 }
 
 for( BOARD_ITEM* group_item : newset )
 group_items.emplace( group_item );
 }
 
 for( const KIGFX::VIEW::LAYER_ITEM_PAIR& candidate : candidates )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( candidate.first );
 
 if( item && Selectable( item ) && item->HitTest( selectionRect, !greedySelection )
 && ( greedySelection || !group_items.count( item ) ) )
 {
 if( item->Type() == PCB_PAD_T && !m_isFootprintEditor )
 padsCollector.Append( item );
 else
 collector.Append( item );
 }
 }
 
 // Apply the stateful filter
 FilterCollectedItems( collector, true );
 
 FilterCollectorForHierarchy( collector, true );
 
 // If we selected nothing but pads, allow them to be selected
 if( collector.GetCount() == 0 )
 {
 collector = padsCollector;
 FilterCollectedItems( collector, true );
 FilterCollectorForHierarchy( collector, true );
 }
 
 for( EDA_ITEM* i : collector )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( i );
 
 if( m_subtractive || ( m_exclusive_or && item->IsSelected() ) )
 {
 unselect( item );
 anySubtracted = true;
 }
 else
 {
 select( item );
 anyAdded = true;
 }
 }
 
 m_selection.SetIsHover( false );
 
 // Inform other potentially interested tools
 if( anyAdded )
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 else if( anySubtracted )
 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
 
 break; // Stop waiting for events
 }
 
 // Allow some actions for navigation
 for( int i = 0; allowedActions[i]; ++i )
 {
 if( evt->IsAction( allowedActions[i] ) )
 {
 evt->SetPassEvent();
 break;
 }
 }
 }
 
 getViewControls()->SetAutoPan( false );
 
 // Stop drawing the selection box
 view->Remove( &area );
 m_multiple = false; // Multiple selection mode is inactive
 
 if( !cancelled )
 m_selection.ClearReferencePoint();
 
 m_toolMgr->ProcessEvent( EVENTS::UninhibitSelectionEditing );
 
 return cancelled;
}

Referenced by Main().

◆ selectNet()

int PCB_SELECTION_TOOL::selectNet ( const TOOL_EVENT & aEvent )

private

Select all copper connections belonging to the same net(s) as the items in the selection.

Definition at line 1571 of file pcb_selection_tool.cpp.

{
 bool select = aEvent.IsAction( &PCB_ACTIONS::selectNet );
 
 // If we've been passed an argument, just select that netcode1
 int netcode = (int) aEvent.Parameter<intptr_t>();
 
 if( netcode > 0 )
 {
 SelectAllItemsOnNet( netcode, select );
 
 // Inform other potentially interested tools
 if( m_selection.Size() > 0 )
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 else
 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
 
 return 0;
 }
 
 if( !selectCursor() )
 return 0;
 
 // copy the selection, since we're going to iterate and modify
 auto selection = m_selection.GetItems();
 
 for( EDA_ITEM* i : selection )
 {
 BOARD_CONNECTED_ITEM* connItem = dynamic_cast<BOARD_CONNECTED_ITEM*>( i );
 
 if( connItem )
 SelectAllItemsOnNet( connItem->GetNetCode(), select );
 }
 
 // Inform other potentially interested tools
 if( m_selection.Size() > 0 )
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 else
 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
 
 return 0;
}

References SELECTION::GetItems(), BOARD_CONNECTED_ITEM::GetNetCode(), TOOL_EVENT::IsAction(), m_selection, TOOL_BASE::m_toolMgr, TOOL_EVENT::Parameter(), TOOL_MANAGER::ProcessEvent(), select(), SelectAllItemsOnNet(), selectCursor(), EVENTS::SelectedEvent, selection(), PCB_ACTIONS::selectNet, SELECTION::Size(), and EVENTS::UnselectedEvent.

Referenced by setTransitions().

◆ selectPoint()

bool PCB_SELECTION_TOOL::selectPoint	(	const VECTOR2I &	aWhere,
		bool	aOnDrag = `false`,
		bool *	aSelectionCancelledFlag = `nullptr`,
		CLIENT_SELECTION_FILTER	aClientFilter = `nullptr`
	)

private

Select an item pointed by the parameter aWhere.

If there is more than one item at that place, there is a menu displayed that allows one to choose the item.

Parameters

aWhere	is the place where the item should be selected.
aOnDrag	indicates whether a drag operation is being performed.
aSelectionCancelledFlag	allows the function to inform its caller that a selection was canceled (for instance, by clicking outside of the disambiguation menu).
aClientFilter	a callback to allow tool- or action-specific filtering.

Returns: whether or not the selection is empty.

Definition at line 712 of file pcb_selection_tool.cpp.

{
 GENERAL_COLLECTORS_GUIDE guide = getCollectorsGuide();
 GENERAL_COLLECTOR collector;
 const PCB_DISPLAY_OPTIONS& displayOpts = m_frame->GetDisplayOptions();
 
 guide.SetIgnoreZoneFills( displayOpts.m_ZoneDisplayMode != ZONE_DISPLAY_MODE::SHOW_FILLED );
 
 if( m_enteredGroup && !m_enteredGroup->GetBoundingBox().Contains( aWhere ) )
 ExitGroup();
 
 collector.Collect( board(), m_isFootprintEditor ? GENERAL_COLLECTOR::FootprintItems
 : GENERAL_COLLECTOR::AllBoardItems,
 aWhere, guide );
 
 // Remove unselectable items
 for( int i = collector.GetCount() - 1; i >= 0; --i )
 {
 if( !Selectable( collector[ i ] ) || ( aOnDrag && collector[i]->IsLocked() ) )
 collector.Remove( i );
 }
 
 m_selection.ClearReferencePoint();
 
 // Allow the client to do tool- or action-specific filtering to see if we can get down
 // to a single item
 if( aClientFilter )
 aClientFilter( aWhere, collector, this );
 
 FilterCollectorForHierarchy( collector, false );
 
 // Apply the stateful filter
 FilterCollectedItems( collector, false );
 
 // For subtracting, we only want items that are selected
 if( m_subtractive )
 {
 for( int i = collector.GetCount() - 1; i >= 0; --i )
 {
 if( !collector[i]->IsSelected() )
 collector.Remove( i );
 }
 }
 
 // Apply some ugly heuristics to avoid disambiguation menus whenever possible
 if( collector.GetCount() > 1 && !m_skip_heuristics )
 {
 try
 {
 GuessSelectionCandidates( collector, aWhere );
 }
 catch( const ClipperLib::clipperException& exc )
 {
 wxLogWarning( wxS( "Exception \"%s\" occurred attemption to guess selection "
 "candidates." ), exc.what() );
 return false;
 }
 }
 
 // If still more than one item we're going to have to ask the user.
 if( collector.GetCount() > 1 )
 {
 if( aOnDrag )
 Wait( TOOL_EVENT( TC_ANY, TA_MOUSE_UP, BUT_LEFT ) );
 
 if( !doSelectionMenu( &collector ) )
 {
 if( aSelectionCancelledFlag )
 *aSelectionCancelledFlag = true;
 
 return false;
 }
 }
 
 int addedCount = 0;
 bool anySubtracted = false;
 
 if( !m_additive && !m_subtractive && !m_exclusive_or )
 {
 if( m_selection.GetSize() > 0 )
 {
 ClearSelection( true /*quiet mode*/ );
 anySubtracted = true;
 }
 }
 
 if( collector.GetCount() > 0 )
 {
 for( int i = 0; i < collector.GetCount(); ++i )
 {
 if( m_subtractive || ( m_exclusive_or && collector[i]->IsSelected() ) )
 {
 unselect( collector[i] );
 anySubtracted = true;
 }
 else
 {
 select( collector[i] );
 addedCount++;
 }
 }
 }
 
 if( addedCount == 1 )
 {
 m_toolMgr->ProcessEvent( EVENTS::PointSelectedEvent );
 return true;
 }
 else if( addedCount > 1 )
 {
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 return true;
 }
 else if( anySubtracted )
 {
 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
 return true;
 }
 
 return false;
}

References GENERAL_COLLECTOR::AllBoardItems, board(), BUT_LEFT, SELECTION::ClearReferencePoint(), ClearSelection(), GENERAL_COLLECTOR::Collect(), BOX2< Vec >::Contains(), SELECTION_TOOL::doSelectionMenu(), ExitGroup(), FilterCollectedItems(), FilterCollectorForHierarchy(), GENERAL_COLLECTOR::FootprintItems, PCB_GROUP::GetBoundingBox(), getCollectorsGuide(), COLLECTOR::GetCount(), PCB_BASE_FRAME::GetDisplayOptions(), SELECTION::GetSize(), GuessSelectionCandidates(), SELECTION_TOOL::m_additive, m_enteredGroup, SELECTION_TOOL::m_exclusive_or, m_frame, m_isFootprintEditor, m_selection, SELECTION_TOOL::m_skip_heuristics, SELECTION_TOOL::m_subtractive, TOOL_BASE::m_toolMgr, PCB_DISPLAY_OPTIONS::m_ZoneDisplayMode, EVENTS::PointSelectedEvent, TOOL_MANAGER::ProcessEvent(), COLLECTOR::Remove(), select(), Selectable(), EVENTS::SelectedEvent, GENERAL_COLLECTORS_GUIDE::SetIgnoreZoneFills(), SHOW_FILLED, TA_MOUSE_UP, TC_ANY, unselect(), EVENTS::UnselectedEvent, and TOOL_INTERACTIVE::Wait().

Referenced by disambiguateCursor(), Main(), and selectCursor().

◆ selectSameSheet()

int PCB_SELECTION_TOOL::selectSameSheet ( const TOOL_EVENT & aEvent )

private

Set selection to items passed by parameter and connected nets (optionally).

Zooms to fit, if enabled

Definition at line 1801 of file pcb_selection_tool.cpp.

{
 // this function currently only supports footprints since they are only on one sheet.
 EDA_ITEM* item = m_selection.Front();
 
 if( !item )
 return 0;
 
 if( item->Type() != PCB_FOOTPRINT_T )
 return 0;
 
 FOOTPRINT* footprint = dynamic_cast<FOOTPRINT*>( item );
 
 if( !footprint || footprint->GetPath().empty() )
 return 0;
 
 ClearSelection( true /*quiet mode*/ );
 
 // get the sheet path only.
 wxString sheetPath = footprint->GetPath().AsString().BeforeLast( '/' );
 
 if( sheetPath.IsEmpty() )
 sheetPath += '/';
 
 selectAllItemsOnSheet( sheetPath );
 
 // Inform other potentially interested tools
 if( m_selection.Size() > 0 )
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 
 return 0;
}

References KIID_PATH::AsString(), ClearSelection(), SELECTION::Front(), FOOTPRINT::GetPath(), m_selection, TOOL_BASE::m_toolMgr, PCB_FOOTPRINT_T, TOOL_MANAGER::ProcessEvent(), selectAllItemsOnSheet(), EVENTS::SelectedEvent, SELECTION::Size(), and EDA_ITEM::Type().

Referenced by setTransitions().

◆ selectSheetContents()

int PCB_SELECTION_TOOL::selectSheetContents ( const TOOL_EVENT & aEvent )

private

Select all footprints belonging to same hierarchical sheet as the selected footprint (same sheet path).

Definition at line 1785 of file pcb_selection_tool.cpp.

{
 ClearSelection( true /*quiet mode*/ );
 wxString sheetPath = *aEvent.Parameter<wxString*>();
 
 selectAllItemsOnSheet( sheetPath );
 
 zoomFitSelection();
 
 if( m_selection.Size() > 0 )
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 
 return 0;
}

References ClearSelection(), m_selection, TOOL_BASE::m_toolMgr, TOOL_EVENT::Parameter(), TOOL_MANAGER::ProcessEvent(), selectAllItemsOnSheet(), EVENTS::SelectedEvent, SELECTION::Size(), and zoomFitSelection().

Referenced by setTransitions().

◆ selectUnconnected()

int PCB_SELECTION_TOOL::selectUnconnected ( const TOOL_EVENT & aEvent )

private

Select nearest unconnected footprints on same net as selected items.

Definition at line 1450 of file pcb_selection_tool.cpp.

{
 // Get all pads
 std::vector<PAD*> pads;
 
 for( EDA_ITEM* item : m_selection.GetItems() )
 {
 if( item->Type() == PCB_FOOTPRINT_T )
 {
 for( PAD* pad : static_cast<FOOTPRINT*>( item )->Pads() )
 pads.push_back( pad );
 }
 else if( item->Type() == PCB_PAD_T )
 {
 pads.push_back( static_cast<PAD*>( item ) );
 }
 }
 
 // Select every footprint on the end of the ratsnest for each pad in our selection
 std::shared_ptr<CONNECTIVITY_DATA> conn = board()->GetConnectivity();
 
 for( PAD* pad : pads )
 {
 for( const CN_EDGE& edge : conn->GetRatsnestForPad( pad ) )
 {
 BOARD_CONNECTED_ITEM* sourceParent = edge.GetSourceNode()->Parent();
 BOARD_CONNECTED_ITEM* targetParent = edge.GetTargetNode()->Parent();
 
 if( sourceParent == pad )
 {
 if( targetParent->Type() == PCB_PAD_T )
 select( static_cast<PAD*>( targetParent )->GetParent() );
 }
 else if( targetParent == pad )
 {
 if( sourceParent->Type() == PCB_PAD_T )
 select( static_cast<PAD*>( sourceParent )->GetParent() );
 }
 }
 }
 
 return 0;
}

References board(), BOARD::GetConnectivity(), SELECTION::GetItems(), m_selection, pad, PCB_FOOTPRINT_T, PCB_PAD_T, select(), and EDA_ITEM::Type().

Referenced by setTransitions().

◆ 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 76 of file tool_interactive.cpp.

{
 if( aMenu )
 aMenu->SetTool( this );
 else
 aTrigger = CMENU_OFF;
 
 m_toolMgr->ScheduleContextMenu( this, aMenu, aTrigger );
}

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

Referenced by SELECTION_TOOL::doSelectionMenu(), TOOL_MENU::ShowContextMenu(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ setModifiersState()

void SELECTION_TOOL::setModifiersState	(	bool	aShiftState,
		bool	aCtrlState,
		bool	aAltState
	)

protectedinherited

Set the configuration of m_additive, m_subtractive, m_exclusive_or, m_skip_heuristics from the state of modifier keys SHIFT, CTRL, ALT and depending on the OS.

Definition at line 48 of file selection_tool.cpp.

{
 // Set the configuration of m_additive, m_subtractive, m_exclusive_or from the state of
 // modifier keys SHIFT and CTRL
 
 // ALT key cannot be used on MSW because of a conflict with the system menu
 
 m_subtractive = aCtrlState && aShiftState;
 m_additive = !aCtrlState && aShiftState;
 
 if( ctrlClickHighlights() )
 {
 m_exclusive_or = false;
 m_highlight_modifier = aCtrlState && !aShiftState;
 }
 else
 {
 m_exclusive_or = aCtrlState && !aShiftState;
 m_highlight_modifier = false;
 }
 
 // Drag is more forgiving and allows either Ctrl+Drag or Shift+Drag to add to the selection
 // Note, however that we cannot provide disambiguation at the same time as the box selection
 m_drag_additive = ( aCtrlState || aShiftState ) && !aAltState;
 m_drag_subtractive = aCtrlState && aShiftState && !aAltState;
 
 // While the ALT key has some conflicts under MSW (and some flavors of Linux WMs), it remains
 // useful for users who only use tap-click rather than holding the button. We disable it for
 // windows because it flashes the disambiguation menu without showing data
#ifndef __WINDOWS__
 m_skip_heuristics = aAltState;
#else
 m_skip_heuristics = false;
#endif
 
}

References SELECTION_TOOL::ctrlClickHighlights(), SELECTION_TOOL::m_additive, SELECTION_TOOL::m_drag_additive, SELECTION_TOOL::m_drag_subtractive, SELECTION_TOOL::m_exclusive_or, SELECTION_TOOL::m_highlight_modifier, SELECTION_TOOL::m_skip_heuristics, and SELECTION_TOOL::m_subtractive.

Referenced by EE_SELECTION_TOOL::disambiguateCursor(), PL_SELECTION_TOOL::disambiguateCursor(), disambiguateCursor(), EE_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), Main(), EE_SELECTION_TOOL::OnIdle(), and OnIdle().

◆ setTransitions()

void PCB_SELECTION_TOOL::setTransitions ( )

overridevirtual

Zoom the screen to center and fit the current selection.

Implements TOOL_INTERACTIVE.

Definition at line 3206 of file pcb_selection_tool.cpp.

{
 Go( &PCB_SELECTION_TOOL::UpdateMenu, ACTIONS::updateMenu.MakeEvent() );
 
 Go( &PCB_SELECTION_TOOL::Main, PCB_ACTIONS::selectionActivate.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::CursorSelection, PCB_ACTIONS::selectionCursor.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::ClearSelection, PCB_ACTIONS::selectionClear.MakeEvent() );
 
 Go( &PCB_SELECTION_TOOL::AddItemToSel, PCB_ACTIONS::selectItem.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::AddItemsToSel, PCB_ACTIONS::selectItems.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::RemoveItemFromSel, PCB_ACTIONS::unselectItem.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::RemoveItemsFromSel, PCB_ACTIONS::unselectItems.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::SelectionMenu, PCB_ACTIONS::selectionMenu.MakeEvent() );
 
 Go( &PCB_SELECTION_TOOL::filterSelection, PCB_ACTIONS::filterSelection.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::expandConnection, PCB_ACTIONS::selectConnection.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::unrouteSelected, PCB_ACTIONS::unrouteSelected.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::selectNet, PCB_ACTIONS::selectNet.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::selectNet, PCB_ACTIONS::deselectNet.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::selectUnconnected, PCB_ACTIONS::selectUnconnected.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::grabUnconnected, PCB_ACTIONS::grabUnconnected.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::syncSelection, PCB_ACTIONS::syncSelection.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::syncSelectionWithNets,
 PCB_ACTIONS::syncSelectionWithNets.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::selectSameSheet, PCB_ACTIONS::selectSameSheet.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::selectSheetContents,
 PCB_ACTIONS::selectOnSheetFromEeschema.MakeEvent() );
 Go( &PCB_SELECTION_TOOL::updateSelection, EVENTS::SelectedItemsModified );
 Go( &PCB_SELECTION_TOOL::updateSelection, EVENTS::SelectedItemsMoved );
 
 Go( &PCB_SELECTION_TOOL::SelectAll, ACTIONS::selectAll.MakeEvent() );
 
 Go( &PCB_SELECTION_TOOL::disambiguateCursor, EVENTS::DisambiguatePoint );
}

◆ syncSelection()

int PCB_SELECTION_TOOL::syncSelection ( const TOOL_EVENT & aEvent )

private

Definition at line 1730 of file pcb_selection_tool.cpp.

{
 std::vector<BOARD_ITEM*>* items = aEvent.Parameter<std::vector<BOARD_ITEM*>*>();
 
 if( items )
 doSyncSelection( *items, false );
 
 return 0;
}

References doSyncSelection(), and TOOL_EVENT::Parameter().

Referenced by setTransitions().

◆ syncSelectionWithNets()

int PCB_SELECTION_TOOL::syncSelectionWithNets ( const TOOL_EVENT & aEvent )

private

Definition at line 1741 of file pcb_selection_tool.cpp.

{
 std::vector<BOARD_ITEM*>* items = aEvent.Parameter<std::vector<BOARD_ITEM*>*>();
 
 if( items )
 doSyncSelection( *items, true );
 
 return 0;
}

References doSyncSelection(), and TOOL_EVENT::Parameter().

Referenced by setTransitions().

◆ UnbrightenItem()

void SELECTION_TOOL::UnbrightenItem ( EDA_ITEM * aItem )

inherited

Definition at line 213 of file selection_tool.cpp.

{
 unhighlight( aItem, BRIGHTENED );
}

References BRIGHTENED, and SELECTION_TOOL::unhighlight().

Referenced by SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), SCH_EDIT_FRAME::DisplayCurrentSheet(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ unhighlight()

void PCB_SELECTION_TOOL::unhighlight	(	EDA_ITEM *	aItem,
		int	aHighlightMode,
		SELECTION *	aGroup = `nullptr`
	)

overrideprivatevirtual

Unhighlight the item visually.

Parameters

aItem	The item to be highlighted.
aHighlightMode	Either SELECTED or BRIGHTENED
aGroup	[optional] A group to remove the item from.

Implements SELECTION_TOOL.

Definition at line

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ RESET_REASON

◆ STOP_CONDITION

Constructor & Destructor Documentation

◆ PCB_SELECTION_TOOL()

◆ ~PCB_SELECTION_TOOL()

Member Function Documentation

◆ Activate()

◆ AddItemsToSel() [1/2]

◆ AddItemsToSel() [2/2]

◆ AddItemToSel() [1/2]

◆ AddItemToSel() [2/2]

◆ attachManager()

◆ board()

◆ BrightenItem()

◆ canvas()

◆ ClearSelection() [1/2]

◆ ClearSelection() [2/2]

◆ controls()

◆ ctrlClickHighlights()

◆ CursorSelection()

◆ disambiguateCursor()

◆ doSelectionMenu()

◆ doSyncSelection()

◆ EnterGroup()

◆ ExitGroup()

◆ expandConnection()

◆ FilterCollectedItems()

◆ FilterCollectorForFreePads()

◆ FilterCollectorForHierarchy()

◆ FilterCollectorForMarkers()

◆ filterSelection()

◆ FindItem()

◆ frame()

◆ GetActiveLayer()

◆ getCollectorsGuide()

◆ getEditFrame()

◆ GetEnteredGroup()

◆ GetFilter()

◆ GetId()

◆ GetManager()

◆ getModel()

◆ getModelInt()

◆ GetName()

◆ GetSelection()

◆ getToolHolderInt()

◆ GetToolMenu()

◆ GetType()

◆ getView()

◆ getViewControls()

◆ Go()

◆ goInternal()

◆ grabUnconnected()

◆ GuessSelectionCandidates()

◆ hasModifier()

◆ highlight()

◆ highlightInternal()

◆ hitTestDistance()

◆ Init()

◆ IsFootprintEditor()

◆ IsToolActive()

◆ itemPassesFilter()

◆ Main()

◆ onDisambiguationExpire()

◆ OnIdle()

◆ RebuildSelection()

◆ RemoveItemFromSel() [1/2]

◆ RemoveItemFromSel() [2/2]

◆ RemoveItemsFromSel() [1/3]

◆ RemoveItemsFromSel() [2/3]

◆ RemoveItemsFromSel() [3/3]