#include <selection_tool.h>

Inheritance diagram for SELECTION_TOOL:

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

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

Public Member Functions
	SELECTION_TOOL ()

	~SELECTION_TOOL ()

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

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

int	Main (const TOOL_EVENT &aEvent)
	Function Main() More...

PCBNEW_SELECTION &	GetSelection ()
	Function GetSelection() More...

PCBNEW_SELECTION &	RequestSelection (CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
	Function RequestSelection() More...

SELECTION_LOCK_FLAGS	CheckLock ()
	Checks if the user has agreed to modify locked items for the given selection. More...

int	CursorSelection (const TOOL_EVENT &aEvent)
	Select a single item under cursor event handler. More...

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

void	ClearSelection (bool aQuietMode=false)

int	SelectItem (const TOOL_EVENT &aEvent)
	Item selection event handler. More...

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

int	SelectAll (const TOOL_EVENT &aEvent)
	Select all items on the board More...

int	SelectItems (const TOOL_EVENT &aEvent)
	Multiple item selection event handler More...

int	UnselectItem (const TOOL_EVENT &aEvent)
	Item unselection event handler. More...

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

int	UnselectItems (const TOOL_EVENT &aEvent)
	Multiple item unselection event handler More...

void	BrightenItem (BOARD_ITEM *aItem)

void	UnbrightenItem (BOARD_ITEM *aItem)

void	select (BOARD_ITEM *aItem)
	Function select() Takes necessary action mark an item as selected. More...

bool	Selectable (const BOARD_ITEM *aItem, bool checkVisibilityOnly=false) const
	Function selectable() Checks conditions for an item to be selected. More...

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

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

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

SELECTION_FILTER_OPTIONS &	GetFilter ()

void	setTransitions () override
	Sets up handlers for various events. More...

void	zoomFitSelection ()
	Zooms the screen to center and fit the current selection. More...

BOARD *	GetBoard () const

void	EnterGroup ()

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

void	FilterCollectorForGroups (GENERAL_COLLECTOR &aCollector) const

PCB_GROUP *	GetEnteredGroup ()

void	FilterCollectedItems (GENERAL_COLLECTOR &aCollector)
	Applies the SELECTION_FILTER_OPTIONS to a collection of items More...

void	SetIsFootprintEditor (bool aEnabled)
	Function SetIsFootprintEditor() More...

bool	IsFootprintEditor () const

void	Activate ()
	Function Activate() Runs the tool. More...

TOOL_MENU &	GetToolMenu ()

void	SetContextMenu (ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
	Function SetContextMenu() More...

void	RunMainStack (std::function< void()> aFunc)
	Function RunMainStack() More...

template<class T >
void	Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
	Function Go() More...

TOOL_EVENT *	Wait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
	Function Wait() More...

TOOL_TYPE	GetType () const
	Function GetType() Returns the type of the tool. More...

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

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

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

bool	IsToolActive () const

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

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

KIGFX::PCB_VIEW *	view () const

KIGFX::VIEW_CONTROLS *	controls () const

PCB_BASE_EDIT_FRAME *	frame () const

BOARD *	board () const

FOOTPRINT *	footprint () const

const PCB_DISPLAY_OPTIONS &	displayOptions () const

PCB_DRAW_PANEL_GAL *	canvas () const

const PCBNEW_SELECTION &	selection () const

PCBNEW_SELECTION &	selection ()

void	attachManager (TOOL_MANAGER *aManager)
	Function attachManager() More...

KIGFX::VIEW *	getView () const
	Function getView() More...

KIGFX::VIEW_CONTROLS *	getViewControls () const
	Function getViewControls() More...

template<typename T >
T *	getEditFrame () const
	Function getEditFrame() More...

template<typename T >
T *	getModel () const
	Function getModel() More...

Protected Attributes
bool	m_isFootprintEditor

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

TOOL_TYPE	m_type
	Stores the type of the tool. More...

TOOL_ID	m_toolId
	Unique identifier for the tool, assigned by a TOOL_MANAGER instance. More...

std::string	m_toolName
	Name of the tool. More...

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=NULL, CLIENT_SELECTION_FILTER aClientFilter=NULL)
	Function selectPoint() Selects an item pointed by the parameter aWhere. More...

bool	selectCursor (bool aForceSelect=false, CLIENT_SELECTION_FILTER aClientFilter=NULL)
	Function selectCursor() Selects an item under the cursor unless there is something already selected or aSelectAlways is true. More...

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

bool	doSelectionMenu (GENERAL_COLLECTOR *aItems, const wxString &aTitle)
	Allows the selection of a single item from a list via pop-up menu. More...

int	expandConnection (const TOOL_EVENT &aEvent)
	Expands the current track selection to the next boundary (junctions, pads, or all) More...

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

void	selectConnectedTracks (BOARD_CONNECTED_ITEM &aSourceItem, STOP_CONDITION aStopCondition)
	Selects connecteed tracks and vias. More...

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

void	selectAllItemsOnSheet (wxString &aSheetPath)
	Selects all items with the given sheet timestamp/UUID name (the sheet path) The path of the root sheet is "/". More...

int	selectSheetContents (const TOOL_EVENT &aEvent)
	Selects all footprints belonging to same sheet, from Eeschema, using crossprobing More...

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

void	findCallback (BOARD_ITEM *aItem)
	Find dialog callback. More...

int	find (const TOOL_EVENT &aEvent)
	Find an item. More...

int	filterSelection (const TOOL_EVENT &aEvent)
	Invoke filter dialog and modify current selection More...

bool	itemPassesFilter (BOARD_ITEM *aItem)
	Returns true if the given item passes the current SELECTION_FILTER_OPTIONS More...

BOARD_ITEM *	pickSmallestComponent (GENERAL_COLLECTOR *aCollector)
	Function pickSmallestComponent() Allows one to find the smallest (in terms of bounding box area) item from the list. More...

void	unselect (BOARD_ITEM *aItem)
	Function unselect() Takes necessary action mark an item as unselected. More...

void	highlight (BOARD_ITEM aItem, int aHighlightMode, PCBNEW_SELECTION aGroup=nullptr)
	Function highlight() Highlights the item visually. More...

void	unhighlight (BOARD_ITEM aItem, int aHighlightMode, PCBNEW_SELECTION aGroup=nullptr)
	Function unhighlight() Unhighlights the item visually. More...

bool	selectionContains (const VECTOR2I &aPoint) const
	Function selectionContains() More...

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

int	UpdateMenu (const TOOL_EVENT &aEvent)
	Pass the selection to a conditional menu for updating. More...

const GENERAL_COLLECTORS_GUIDE	getCollectorsGuide () const

void	highlightInternal (BOARD_ITEM aItem, int aHighlightMode, PCBNEW_SELECTION aSelectionViewGroup, bool isChild)

void	unhighlightInternal (BOARD_ITEM aItem, int aHighlightMode, PCBNEW_SELECTION aSelectionViewGroup, bool isChild)

Private Attributes
PCB_BASE_FRAME *	m_frame

PCBNEW_SELECTION	m_selection

SELECTION_FILTER_OPTIONS	m_filter

bool	m_additive

bool	m_subtractive

bool	m_exclusive_or

bool	m_multiple

bool	m_skip_heuristics

bool	m_locked

PCB_GROUP *	m_enteredGroup

KIGFX::VIEW_GROUP	m_enteredGroupOverlay

std::unique_ptr< PRIV >	m_priv

Detailed Description

SELECTION_TOOL.

Our sample 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 selection_tool.h.

Member Enumeration Documentation

◆ INTERACTIVE_PLACEMENT_OPTIONS

enum PCB_TOOL_BASE::INTERACTIVE_PLACEMENT_OPTIONS

protectedinherited

Options for placing items interactively.

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

Definition at line 111 of file pcb_tool_base.h.

                                        {
         IPO_ROTATE       = 0x01,
 
         IPO_FLIP         = 0x02,
 
         IPO_SINGLE_CLICK = 0x04,
 
         IPO_REPEAT       = 0x08
     };

◆ RESET_REASON

enum TOOL_BASE::RESET_REASON

inherited

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

Definition at line 79 of file tool_base.h.

     {
         RUN,                
         MODEL_RELOAD,       
         GAL_SWITCH          
     };

◆ STOP_CONDITION

enum 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 261 of file selection_tool.h.

     {
         STOP_AT_JUNCTION,
         STOP_AT_PAD,
         STOP_NEVER
     };

Constructor & Destructor Documentation

◆ SELECTION_TOOL()

SELECTION_TOOL::SELECTION_TOOL ( )

Definition at line 97 of file selection_tool.cpp.

                                :
         PCB_TOOL_BASE( "pcbnew.InteractiveSelection" ),
         m_frame( NULL ),
         m_additive( false ),
         m_subtractive( false ),
         m_exclusive_or( false ),
         m_multiple( false ),
         m_skip_heuristics( false ),
         m_locked( true ),
         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 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.

◆ ~SELECTION_TOOL()

SELECTION_TOOL::~SELECTION_TOOL ( )

Definition at line 123 of file selection_tool.cpp.

 {
     getView()->Remove( &m_selection );
     getView()->Remove( &m_enteredGroupOverlay );
 }

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

Member Function Documentation

◆ Activate()

void TOOL_INTERACTIVE::Activate ( )

inherited

Function Activate() Runs 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(), LIB_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), PCBNEW_CONTROL::DeleteItemCursor(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PCB_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EnumeratePads(), PCBNEW_CONTROL::GridSetOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PCB_INSPECTION_TOOL::HighlightNetTool(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_INSPECTION_TOOL::LocalRatsnestTool(), PL_EDIT_TOOL::Main(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), LIB_TREE::onContextMenu(), POINT_EDITOR::OnSelectionChange(), GROUP_TOOL::PickNewMember(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), DRAWING_TOOL::SetAnchor(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ AddItemToSel()

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

Definition at line 885 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(), select(), and EVENTS::SelectedEvent.

Referenced by PCBNEW_CONTROL::DeleteItemCursor(), EDIT_TOOL::FilletTracks(), and SelectItem().

◆ attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER * aManager )

protectedinherited

Function attachManager()

Sets 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_TOOL_BASE::board ( ) const

inlineprotectedinherited

Definition at line 160 of file pcb_tool_base.h.

160 { return getModel<BOARD>(); }

◆ BrightenItem()

void SELECTION_TOOL::BrightenItem ( BOARD_ITEM * aItem )

Definition at line 934 of file selection_tool.cpp.

 {
     highlight( aItem, BRIGHTENED );
 }

References BRIGHTENED, and highlight().

Referenced by PCBNEW_CONTROL::DeleteItemCursor().

◆ canvas()

PCB_DRAW_PANEL_GAL * PCB_TOOL_BASE::canvas ( ) const

protectedinherited

Definition at line 285 of file pcb_tool_base.cpp.

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

References PCB_TOOL_BASE::frame().

Referenced by ZONE_FILLER_TOOL::CheckAllZones(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), ZONE_FILLER_TOOL::FillAllZones(), FOOTPRINT_EDITOR_TOOLS::NewFootprint(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), FOOTPRINT_EDITOR_TOOLS::Save(), FOOTPRINT_EDITOR_TOOLS::SaveAs(), ZONE_FILLER_TOOL::singleShotRefocus(), PCBNEW_CONTROL::ToggleRatsnest(), PCBNEW_CONTROL::TrackDisplayMode(), PCBNEW_CONTROL::ViaDisplayMode(), PCBNEW_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

◆ CheckLock()

SELECTION_LOCK_FLAGS SELECTION_TOOL::CheckLock ( )

Checks if the user has agreed to modify locked items for the given selection.

Definition at line 770 of file selection_tool.cpp.

 {
     if( !m_locked || m_isFootprintEditor )
         return SELECTION_UNLOCKED;
 
     bool containsLocked = false;
 
     // Check if the selection contains locked items
     for( EDA_ITEM* item : m_selection )
     {
         switch( item->Type() )
         {
         case PCB_FOOTPRINT_T:
             if( static_cast<FOOTPRINT*>( item )->IsLocked() )
                 containsLocked = true;
             break;
 
         case PCB_FP_SHAPE_T:
         case PCB_FP_TEXT_T:
         case PCB_FP_ZONE_T:
             if( static_cast<FOOTPRINT*>( item->GetParent() )->IsLocked() )
                 containsLocked = true;
             break;
 
         default:    // suppress warnings
             break;
         }
     }
 
     if( containsLocked )
     {
         if( IsOK( m_frame, _( "Selection contains locked items. Do you want to continue?" ) ) )
         {
             m_locked = false;
             return SELECTION_LOCK_OVERRIDE;
         }
         else
             return SELECTION_LOCKED;
     }
 
     return SELECTION_UNLOCKED;
 }

References _, IsOK(), m_frame, PCB_TOOL_BASE::m_isFootprintEditor, m_locked, m_selection, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, SELECTION_LOCK_OVERRIDE, SELECTION_LOCKED, and SELECTION_UNLOCKED.

Referenced by EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), and RequestSelection().

◆ ClearSelection() [1/2]

int SELECTION_TOOL::ClearSelection ( const TOOL_EVENT & aEvent )

Clear current selection event handler.

Definition at line 824 of file selection_tool.cpp.

 {
     ClearSelection();
 
     return 0;
 }

Referenced by EnterGroup(), ExitGroup(), filterSelection(), findCallback(), GROUP_TOOL::Group(), Main(), RequestSelection(), Reset(), selectCursor(), selectMultiple(), selectPoint(), selectSameSheet(), selectSheetContents(), and setTransitions().

◆ ClearSelection() [2/2]

void SELECTION_TOOL::ClearSelection ( bool aQuietMode = false )

Definition at line 1577 of file selection_tool.cpp.

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

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

◆ controls()

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

inlineprotectedinherited

Definition at line 150 of file pcb_tool_base.h.

     {
         return getViewControls();
     }

References TOOL_BASE::getViewControls().

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), MICROWAVE_TOOL::drawMicrowaveInductor(), ROUTER_TOOL::finishInteractive(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCBNEW_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::onViaCommand(), LENGTH_TUNER_TOOL::performTuning(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), ROUTER_TOOL::prepareInteractive(), PCBNEW_PICKER_TOOL::setControls(), POINT_EDITOR::setEditedPoint(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

◆ CursorSelection()

int SELECTION_TOOL::CursorSelection ( const TOOL_EVENT & aEvent )

Select a single item under cursor event handler.

Definition at line 814 of file 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().

◆ displayOptions()

const PCB_DISPLAY_OPTIONS & PCB_TOOL_BASE::displayOptions ( ) const

protectedinherited

Definition at line 280 of file pcb_tool_base.cpp.

 {
     return frame()->GetDisplayOptions();
 }

References PCB_TOOL_BASE::frame(), and PCB_BASE_FRAME::GetDisplayOptions().

Referenced by PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), PCBNEW_CONTROL::HighContrastMode(), PCBNEW_CONTROL::HighContrastModeCycle(), PCB_INSPECTION_TOOL::LocalRatsnestTool(), PNS::TOOL_BASE::pickSingleItem(), PCBNEW_CONTROL::ToggleRatsnest(), PCBNEW_CONTROL::TrackDisplayMode(), PCBNEW_CONTROL::ViaDisplayMode(), and PCBNEW_CONTROL::ZoneDisplayMode().

◆ doInteractiveItemPlacement()

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

protectedinherited

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

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

Parameters

aItemCreator	the callable that will attempt to create the item
aCommitMessage	the message used on a successful commit

Definition at line 36 of file pcb_tool_base.cpp.

 {
     using namespace std::placeholders;
     std::unique_ptr<BOARD_ITEM> newItem;
 
     frame()->PushTool( aTool );
     Activate();
 
     BOARD_COMMIT commit( frame() );
 
     GetManager()->RunAction( PCB_ACTIONS::selectionClear, true );
 
     // do not capture or auto-pan until we start placing an item
     controls()->ShowCursor( true );
 
     // Add a VIEW_GROUP that serves as a preview for the new item
     PCBNEW_SELECTION preview;
     view()->Add( &preview );
 
     aPlacer->m_board = board();
     aPlacer->m_frame = frame();
     aPlacer->m_modifiers = 0;
 
     auto makeNewItem =
             [&]( VECTOR2I aPosition )
             {
                 if( frame()->GetModel() )
                     newItem = aPlacer->CreateItem();
 
                 if( newItem )
                 {
                     newItem->SetPosition( (wxPoint) aPosition );
                     preview.Add( newItem.get() );
 
                     if( newItem->Type() == PCB_FOOTPRINT_T )
                     {
                         FOOTPRINT* fp = dyn_cast<FOOTPRINT*>( newItem.get() );
 
                         // footprints have more drawable parts
                         fp->RunOnChildren( std::bind( &KIGFX::VIEW_GROUP::Add, &preview, _1 ) );
                     }
                 }
             };
 
     if( aOptions & IPO_SINGLE_CLICK )
         makeNewItem( controls()->GetCursorPosition() );
 
     auto setCursor =
             [&]()
             {
                 if( !newItem )
                     frame()->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
                 else
                     frame()->GetCanvas()->SetCurrentCursor( KICURSOR::PLACE );
             };
 
     // Set initial cursor
     setCursor();
 
     // Main loop: keep receiving events
     while( TOOL_EVENT* evt = Wait() )
     {
         setCursor();
 
         VECTOR2I cursorPos = controls()->GetCursorPosition();
         aPlacer->m_modifiers = evt->Modifier();
 
         auto cleanup =
                 [&] ()
                 {
                     newItem = nullptr;
                     preview.Clear();
                     view()->Update( &preview );
                     controls()->SetAutoPan( false );
                     controls()->CaptureCursor( false );
                     controls()->ShowCursor( true );
                 };
 
         if( evt->IsCancelInteractive() )
         {
             if( aOptions & IPO_SINGLE_CLICK )
             {
                 cleanup();
                 frame()->PopTool( aTool );
                 break;
             }
             else if( newItem )
                 cleanup();
             else
             {
                 frame()->PopTool( aTool );
                 break;
             }
         }
         else if( evt->IsActivate() )
         {
             if( newItem )
                 cleanup();
 
             if( evt->IsPointEditor() )
             {
                 // don't exit (the point editor runs in the background)
             }
             else if( evt->IsMoveTool() )
             {
                 // leave ourselves on the stack so we come back after the move
                 break;
             }
             else
             {
                 frame()->PopTool( aTool );
                 break;
             }
         }
         else if( evt->IsClick( BUT_LEFT ) )
         {
             if( !newItem )
             {
                 // create the item if possible
                 makeNewItem( cursorPos );
 
                 // no item created, so wait for another click
                 if( !newItem  )
                     continue;
 
                 controls()->CaptureCursor( true );
                 controls()->SetAutoPan( true );
             }
             else
             {
                 auto oldFlags = newItem->GetFlags();
                 newItem->ClearFlags();
 
                 if( !aPlacer->PlaceItem( newItem.get(), commit ) )
                 {
                     newItem->SetFlags( oldFlags );
                     continue;
                 }
 
                 preview.Clear();
                 newItem.release();
                 commit.Push( aCommitMessage );
 
                 controls()->CaptureCursor( false );
                 controls()->SetAutoPan( false );
                 controls()->ShowCursor( true );
 
                 if( !( aOptions & IPO_REPEAT ) )
                     break;
 
                 if( aOptions & IPO_SINGLE_CLICK )
                     makeNewItem( controls()->GetCursorPosition() );
 
                 setCursor();
             }
         }
         else if( evt->IsClick( BUT_RIGHT ) )
         {
             m_menu.ShowContextMenu( selection() );
         }
         else if( evt->IsAction( &PCB_ACTIONS::trackViaSizeChanged ) )
         {
             m_toolMgr->RunAction( ACTIONS::refreshPreview );
         }
         else if( newItem && evt->Category() == TC_COMMAND )
         {
             /*
              * Handle any events that can affect the item as we move it around
              */
             if( TOOL_EVT_UTILS::IsRotateToolEvt( *evt ) && ( aOptions & IPO_ROTATE ) )
             {
                 const int rotationAngle = TOOL_EVT_UTILS::GetEventRotationAngle( *frame(), *evt );
                 newItem->Rotate( newItem->GetPosition(), rotationAngle );
                 view()->Update( &preview );
             }
             else if( evt->IsAction( &PCB_ACTIONS::flip ) && ( aOptions & IPO_FLIP ) )
             {
                 newItem->Flip( newItem->GetPosition(), frame()->Settings().m_FlipLeftRight );
                 view()->Update( &preview );
             }
             else if( evt->IsAction( &PCB_ACTIONS::viaSizeInc )
                     || evt->IsAction( &PCB_ACTIONS::viaSizeDec ) )
             {
                 // Refresh preview after event runs
                 m_toolMgr->RunAction( ACTIONS::refreshPreview );
             }
             else if( evt->IsAction( &ACTIONS::refreshPreview ) )
             {
                 preview.Clear();
                 newItem.release();
 
                 makeNewItem( (wxPoint) cursorPos );
                 aPlacer->SnapItem( newItem.get() );
                 view()->Update( &preview );
             }
         }
         else if( newItem && evt->IsMotion() )
         {
             // track the cursor
             newItem->SetPosition( (wxPoint) cursorPos );
             aPlacer->SnapItem( newItem.get() );
 
             // Show a preview of the item
             view()->Update( &preview );
         }
         else
         {
             evt->SetPassEvent();
         }
     }
 
     view()->Remove( &preview );
     frame()->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 }

References TOOL_INTERACTIVE::Activate(), KIGFX::PCB_VIEW::Add(), KIGFX::VIEW_GROUP::Add(), SELECTION::Add(), ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), PCB_TOOL_BASE::controls(), INTERACTIVE_PLACER_BASE::CreateItem(), PCB_ACTIONS::flip, PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_EVT_UTILS::GetEventRotationAngle(), TOOL_BASE::GetManager(), PCB_BASE_FRAME::GetModel(), PCB_TOOL_BASE::IPO_FLIP, PCB_TOOL_BASE::IPO_REPEAT, PCB_TOOL_BASE::IPO_ROTATE, PCB_TOOL_BASE::IPO_SINGLE_CLICK, TOOL_EVT_UTILS::IsRotateToolEvt(), INTERACTIVE_PLACER_BASE::m_board, PCBNEW_SETTINGS::m_FlipLeftRight, INTERACTIVE_PLACER_BASE::m_frame, TOOL_INTERACTIVE::m_menu, INTERACTIVE_PLACER_BASE::m_modifiers, TOOL_BASE::m_toolMgr, PCB_FOOTPRINT_T, PENCIL, PLACE, INTERACTIVE_PLACER_BASE::PlaceItem(), TOOLS_HOLDER::PopTool(), BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), ACTIONS::refreshPreview, KIGFX::PCB_VIEW::Remove(), TOOL_MANAGER::RunAction(), FOOTPRINT::RunOnChildren(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), PCB_BASE_FRAME::Settings(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), INTERACTIVE_PLACER_BASE::SnapItem(), TC_COMMAND, PCB_ACTIONS::trackViaSizeChanged, KIGFX::PCB_VIEW::Update(), PCB_ACTIONS::viaSizeDec, PCB_ACTIONS::viaSizeInc, PCB_TOOL_BASE::view(), and TOOL_INTERACTIVE::Wait().

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

◆ doSelectionMenu()

bool SELECTION_TOOL::doSelectionMenu	(	GENERAL_COLLECTOR *	aItems,
		const wxString &	aTitle
	)

private

Allows the selection of a single item from a list via pop-up menu.

The items are highlighted on the canvas when hovered in the menu. The collector is trimmed to the picked item.

Parameters

aTitle (optional) Allows the menu to be titled (ie: "Clarify Selection").

Returns: true if an item was picked

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

Definition at line 1636 of file selection_tool.cpp.

 {
     BOARD_ITEM*      current = nullptr;
     PCBNEW_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( 9, aCollector->GetCount() );
         ACTION_MENU menu( true );
 
         for( int i = 0; i < limit; ++i )
         {
             wxString    text;
             BOARD_ITEM* item = ( *aCollector )[i];
             text             = item->GetSelectMenuText( m_frame->GetUserUnits() );
 
             wxString menuText = wxString::Format( "&%d. %s\t%d", i + 1, text, i + 1 );
             menu.Add( menuText, i + 1, item->GetMenuImage() );
         }
 
         menu.AppendSeparator();
         menu.Add( _( "Select &All\tA" ), limit + 1, plus_xpm );
 
         if( !expandSelection && aCollector->HasAdditionalItems() )
             menu.Add( _( "&Expand Selection\tE" ), limit + 2, nullptr );
 
         if( aTitle.Length() )
         {
             menu.SetTitle( aTitle );
             menu.SetIcon( info_xpm );
             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 );
 
                 OPT<int> id = evt->GetCommandId();
 
                 // User has selected the "Select All" option
                 if( id == limit + 1 )
                 {
                     selectAll = true;
                     current   = nullptr;
                 }
                 else if( id == limit + 2 )
                 {
                     expandSelection = true;
                     selectAll       = false;
                     current         = nullptr;
                 }
                 // User has selected an item, so this one will be returned
                 else if( id && ( *id > 0 ) && ( *id <= limit ) )
                 {
                     selectAll = false;
                     current   = ( *aCollector )[*id - 1];
                 }
                 else
                 {
                     selectAll = false;
                     current   = nullptr;
                 }
             }
             else if( evt->Action() == TA_CHOICE_MENU_CLOSED )
             {
                 break;
             }
         }
     } while( expandSelection );
 
     getView()->Remove( &highlightGroup );
 
     if( selectAll )
         return true;
     else if( current )
     {
         aCollector->Empty();
         aCollector->Append( current );
         return true;
     }
 
     return false;
 }

References _, KIGFX::VIEW::Add(), COLLECTOR::Append(), BRIGHTENED, CMENU_NOW, COLLECTOR::Combine(), COLLECTOR::Empty(), Format(), COLLECTOR::GetCount(), EDA_ITEM::GetMenuImage(), EDA_ITEM::GetSelectMenuText(), EDA_BASE_FRAME::GetUserUnits(), TOOL_BASE::getView(), COLLECTOR::HasAdditionalItems(), highlight(), info_xpm, LAYER_SELECT_OVERLAY, m_frame, plus_xpm, KIGFX::VIEW::Remove(), TOOL_INTERACTIVE::SetContextMenu(), KIGFX::VIEW_GROUP::SetLayer(), TA_CHOICE_MENU_CHOICE, TA_CHOICE_MENU_CLOSED, TA_CHOICE_MENU_UPDATE, unhighlight(), and TOOL_INTERACTIVE::Wait().

Referenced by SelectionMenu(), and selectPoint().

◆ EnterGroup()

void SELECTION_TOOL::EnterGroup ( )

Definition at line 369 of file selection_tool.cpp.

 {
     wxCHECK_RET( m_selection.GetSize() == 1 && m_selection[0]->Type() == PCB_GROUP_T,
                  "EnterGroup called when selection is not a single group" );
     PCB_GROUP* aGroup = static_cast<PCB_GROUP*>( m_selection[0] );
 
     if( m_enteredGroup != NULL )
         ExitGroup();
 
     ClearSelection();
     m_enteredGroup = aGroup;
     m_enteredGroup->RunOnChildren( [&]( BOARD_ITEM* titem )
                                    {
                                        select( titem );
                                    } );
 
     m_enteredGroupOverlay.Add( m_enteredGroup );
 }

References KIGFX::VIEW_GROUP::Add(), ClearSelection(), ExitGroup(), SELECTION::GetSize(), m_enteredGroup, m_enteredGroupOverlay, m_selection, NULL, PCB_GROUP_T, PCB_GROUP::RunOnChildren(), and select().

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

◆ ExitGroup()

void SELECTION_TOOL::ExitGroup ( bool aSelectGroup = false )

Leave the currently entered group.

Parameters

aSelectGroup when true will select the group after leaving

Definition at line 389 of file selection_tool.cpp.

 {
     // Only continue if there is a group entered
     if( m_enteredGroup == nullptr )
         return;
 
     ClearSelection();
 
     if( aSelectGroup )
         select( m_enteredGroup );
 
     m_enteredGroupOverlay.Clear();
     m_enteredGroup = nullptr;
 }

References KIGFX::VIEW_GROUP::Clear(), ClearSelection(), m_enteredGroup, m_enteredGroupOverlay, and select().

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

◆ expandConnection()

int SELECTION_TOOL::expandConnection ( const TOOL_EVENT & aEvent )

private

Expands the current track selection to the next boundary (junctions, pads, or all)

Definition at line 965 of file selection_tool.cpp.

 {
     unsigned initialCount = 0;
 
     for( auto item : m_selection.GetItems() )
     {
         if( dynamic_cast<BOARD_CONNECTED_ITEM*>( item ) )
             initialCount++;
     }
 
     if( initialCount == 0 )
         selectCursor( true, connectedItemFilter );
 
     for( STOP_CONDITION stopCondition : { STOP_AT_JUNCTION, STOP_AT_PAD, STOP_NEVER } )
     {
         // copy the selection, since we're going to iterate and modify
         std::deque<EDA_ITEM*> selectedItems = m_selection.GetItems();
 
         for( EDA_ITEM* item : selectedItems )
             item->ClearTempFlags();
 
         for( EDA_ITEM* item : selectedItems )
         {
             TRACK* trackItem = dynamic_cast<TRACK*>( item );
 
             // Track items marked SKIP_STRUCT have already been visited
             if( trackItem && !( trackItem->GetFlags() & SKIP_STRUCT ) )
                 selectConnectedTracks( *trackItem, stopCondition );
         }
 
         if( m_selection.GetItems().size() > initialCount )
             break;
     }
 
     // Inform other potentially interested tools
     if( m_selection.Size() > 0 )
         m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 
     return 0;
 }

References connectedItemFilter(), EDA_ITEM::GetFlags(), SELECTION::GetItems(), m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), selectConnectedTracks(), selectCursor(), EVENTS::SelectedEvent, SELECTION::Size(), SKIP_STRUCT, STOP_AT_JUNCTION, STOP_AT_PAD, and STOP_NEVER.

Referenced by setTransitions().

◆ FilterCollectedItems()

void SELECTION_TOOL::FilterCollectedItems ( GENERAL_COLLECTOR & aCollector )

Applies the SELECTION_FILTER_OPTIONS to a collection of items

Definition at line 1481 of file 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 ) )
             rejected.insert( item );
     }
 
     for( BOARD_ITEM* item : rejected )
         aCollector.Remove( item );
 }

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

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

◆ FilterCollectorForGroups()

void SELECTION_TOOL::FilterCollectorForGroups ( GENERAL_COLLECTOR & aCollector ) const

Definition at line 2582 of file selection_tool.cpp.

 {
     std::unordered_set<BOARD_ITEM*> toAdd;
 
     // If any element is a member of a group, replace those elements with the top containing group.
     for( int j = 0; j < aCollector.GetCount(); )
     {
         BOARD_ITEM* item = aCollector[j];
         PCB_GROUP*  aTop = PCB_GROUP::TopLevelGroup( item, m_enteredGroup );
 
         if( aTop != NULL )
         {
             if( aTop != item )
             {
                 toAdd.insert( aTop );
                 aCollector.Remove( item );
                 continue;
             }
         }
         else if( m_enteredGroup && !PCB_GROUP::WithinScope( item, m_enteredGroup ) )
         {
             // If a group is entered, disallow selections of objects outside the group.
             aCollector.Remove( item );
             continue;
         }
 
         ++j;
     }
 
     for( BOARD_ITEM* item : toAdd )
     {
         if( !aCollector.HasItem( item ) )
             aCollector.Append( item );
     }
 }

References COLLECTOR::Append(), COLLECTOR::GetCount(), COLLECTOR::HasItem(), m_enteredGroup, NULL, COLLECTOR::Remove(), PCB_GROUP::TopLevelGroup(), and PCB_GROUP::WithinScope().

Referenced by EditToolSelectionFilter(), selectMultiple(), and selectPoint().

◆ filterSelection()

int SELECTION_TOOL::filterSelection ( const TOOL_EVENT & aEvent )

private

Invoke filter dialog and modify current selection

Definition at line 1449 of file 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 PCB_TOOL_BASE::board(), ClearSelection(), SELECTION::GetItems(), itemIsIncludedByFilter(), m_frame, m_priv, m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), select(), EVENTS::SelectedEvent, and PCB_TOOL_BASE::selection().

Referenced by setTransitions().

◆ find()

int SELECTION_TOOL::find ( const TOOL_EVENT & aEvent )

private

Find an item.

Definition at line 1371 of file selection_tool.cpp.

 {
     DIALOG_FIND dlg( m_frame );
     dlg.SetCallback( std::bind( &SELECTION_TOOL::findCallback, this, _1 ) );
     dlg.ShowModal();
 
     return 0;
 }

References findCallback(), m_frame, and DIALOG_FIND::SetCallback().

Referenced by setTransitions().

◆ findCallback()

void SELECTION_TOOL::findCallback ( BOARD_ITEM * aItem )

private

Find dialog callback.

Definition at line 1342 of file 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 )
     {
         select( aItem );
         m_frame->FocusOnLocation( aItem->GetPosition() );
 
         // Inform other potentially interested tools
         m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
     }
     else if( cleared )
     {
         m_toolMgr->ProcessEvent( EVENTS::ClearedEvent );
     }
 
     m_frame->GetCanvas()->ForceRefresh();
 }

References EVENTS::ClearedEvent, ClearSelection(), EDA_DRAW_FRAME::FocusOnLocation(), EDA_DRAW_PANEL_GAL::ForceRefresh(), PCB_BASE_FRAME::GetCanvas(), EDA_ITEM::GetPosition(), SELECTION::GetSize(), m_frame, m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), select(), and EVENTS::SelectedEvent.

Referenced by find().

◆ footprint()

FOOTPRINT* PCB_TOOL_BASE::footprint ( ) const

inlineprotectedinherited

Definition at line 162 of file pcb_tool_base.h.

     {
         return board()->GetFirstFootprint();
     }

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

Referenced by PCBNEW_CONTROL::AppendBoard(), MICROWAVE_TOOL::createBaseFootprint(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), MICROWAVE_TOOL::createPolygonShape(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawVia(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), GuessSelectionCandidates(), ROUTER_TOOL::InlineDrag(), PCB_INSPECTION_TOOL::InspectConstraints(), PCBNEW_CONTROL::Paste(), pickSmallestComponent(), FOOTPRINT_EDITOR_TOOLS::Properties(), PAD_TOOL::pushPadSettings(), PCB_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_TOOLS::Save(), FOOTPRINT_EDITOR_TOOLS::SaveAs(), select(), Selectable(), selectAllItemsOnSheet(), selectSameSheet(), DRAWING_TOOL::SetAnchor(), and PCBNEW_CONTROL::UpdateMessagePanel().

◆ frame()

PCB_BASE_EDIT_FRAME* PCB_TOOL_BASE::frame ( ) const

inlineprotectedinherited

Definition at line 155 of file pcb_tool_base.h.

     {
         return getEditFrame<PCB_BASE_EDIT_FRAME>();
     }

Referenced by POINT_EDITOR::addCorner(), AUTOPLACE_TOOL::autoplace(), PCB_TOOL_BASE::canvas(), ZONE_FILLER_TOOL::CheckAllZones(), PNS::TOOL_BASE::checkSnap(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), ROUTER_TOOL::CustomTrackWidthDialog(), FOOTPRINT_EDITOR_TOOLS::DeleteFootprint(), PCB_TOOL_BASE::displayOptions(), PCB_TOOL_BASE::doInteractiveItemPlacement(), ROUTER_TOOL::DpDimensionsDialog(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), PCB_EDITOR_CONTROL::ExportSpecctraDSN(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), ROUTER_TOOL::finishInteractive(), EDIT_TOOL::Flip(), PCB_EDITOR_CONTROL::FlipPcbView(), GLOBAL_EDIT_TOOL::GlobalDeletions(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), PCB_EDITOR_CONTROL::ImportSpecctraSession(), ROUTER_TOOL::Init(), Init(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCBNEW_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::meanderSettingsDialog(), EDIT_TOOL::MoveExact(), POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::onViaCommand(), PCBNEW_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), GROUP_TOOL::PickNewMember(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), PAD_TOOL::pushPadSettings(), PAD_TOOL::recombinePad(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), POINT_EDITOR::removeCorner(), PNS::TOOL_BASE::Reset(), ROUTER_TOOL::SelectCopperLayerPair(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), POINT_EDITOR::setEditedPoint(), ROUTER_TOOL::SettingsDialog(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), ROUTER_TOOL::switchLayerOnViaPlacement(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), ZONE_FILLER_TOOL::ZoneFill(), and ZONE_FILLER_TOOL::ZoneFillAll().

◆ GetBoard()

BOARD* SELECTION_TOOL::GetBoard ( ) const

inline

Definition at line 182 of file selection_tool.h.

     {
         return board();
     }

References PCB_TOOL_BASE::board().

Referenced by GROUP_CONTEXT_MENU::update().

◆ getCollectorsGuide()

const GENERAL_COLLECTORS_GUIDE SELECTION_TOOL::getCollectorsGuide ( ) const

private

Definition at line 494 of file 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_BK ) );
     guide.SetIgnoreMTextsOnFront( ! board()->IsElementVisible( LAYER_MOD_TEXT_FR ) );
     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 selectPoint().

◆ getEditFrame()

template<typename T >

T* TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

Function getEditFrame()

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

Definition at line 187 of file tool_base.h.

     {
 #if !defined( QA_TEST )   // Dynamic casts give the linker a siezure 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().

◆ GetEnteredGroup()

PCB_GROUP* SELECTION_TOOL::GetEnteredGroup ( )

inline

Definition at line 198 of file selection_tool.h.

198 { return m_enteredGroup; }

SELECTION_TOOL::m_enteredGroup

PCB_GROUP * m_enteredGroup

Definition: selection_tool.h:387

References m_enteredGroup.

Referenced by PCBNEW_CONTROL::placeBoardItems(), and EDIT_TOOL::Remove().

◆ GetFilter()

SELECTION_FILTER_OPTIONS& SELECTION_TOOL::GetFilter ( )

inline

Definition at line 171 of file selection_tool.h.

     {
         return m_filter;
     }

References m_filter.

Referenced by PANEL_SELECTION_FILTER::OnFilterChanged(), and PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER().

◆ GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Function GetId() Returns 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

Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool.

Returns: Instance of the TOOL_MANAGER. If there is no TOOL_MANAGER associated, it returns NULL.

Definition at line 143 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(), PCB_TOOL_BASE::doInteractiveItemPlacement(), ACTION_MENU::getToolManager(), LIB_TREE::onContextMenu(), ZONE_CREATE_HELPER::OnFirstPoint(), ACTION_MENU::OnMenuEvent(), and ZONE_CREATE_HELPER::performZoneCutout().

◆ getModel()

template<typename T >

T* TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Function getModel()

Returns the model object if it matches the requested type.

Definition at line 201 of file tool_base.h.

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

References TOOL_BASE::getModelInt().

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

◆ GetName()

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

inlineinherited

Function GetName() Returns the name of the tool.

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

Returns: The name of the tool.

Definition at line 132 of file tool_base.h.

     {
         return m_toolName;
     }

References TOOL_BASE::m_toolName.

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

◆ GetSelection()

PCBNEW_SELECTION & SELECTION_TOOL::GetSelection ( )

Function GetSelection()

Returns the set of currently selected items.

Definition at line 405 of file selection_tool.cpp.

 {
     return m_selection;
 }

References m_selection.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), ZONE_CREATE_HELPER::createNewZone(), PCB_INSPECTION_TOOL::CrossProbePcbToSch(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), GROUP_TOOL::EnterGroup(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), EDIT_TOOL::GetAndPlace(), DRAWING_TOOL::getSourceZoneForAction(), GROUP_TOOL::Group(), PCB_INSPECTION_TOOL::highlightNet(), PCB_INSPECTION_TOOL::InspectClearance(), PCB_INSPECTION_TOOL::InspectConstraints(), PCB_INSPECTION_TOOL::LocalRatsnestTool(), PCB_EDITOR_CONTROL::modifyLockSelected(), PCB_EDIT_FRAME::OnNetlistChanged(), POINT_EDITOR::OnSelectionChange(), PCBNEW_CONTROL::placeBoardItems(), EDIT_TOOL::Remove(), GROUP_TOOL::RemoveFromGroup(), PCB_TOOL_BASE::selection(), GROUP_CONTEXT_MENU::update(), PCBNEW_CONTROL::UpdateMessagePanel(), and PCB_EDITOR_CONTROL::ZoneDuplicate().

◆ GetToolMenu()

TOOL_MENU& TOOL_INTERACTIVE::GetToolMenu ( )

inlineinherited

Definition at line 58 of file tool_interactive.h.

58 { return m_menu; }

TOOL_INTERACTIVE::m_menu

TOOL_MENU m_menu

functions below are not yet implemented - their interface may change

Definition: tool_interactive.h:108

References TOOL_INTERACTIVE::m_menu.

Referenced by LIB_EDIT_TOOL::Init(), LIB_PIN_TOOL::Init(), LIB_MOVE_TOOL::Init(), SCH_EDIT_TOOL::Init(), PL_EDIT_TOOL::Init(), GROUP_TOOL::Init(), EE_INSPECTION_TOOL::Init(), CONVERT_TOOL::Init(), PAD_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), EE_POINT_EDITOR::Init(), SCH_MOVE_TOOL::Init(), POINT_EDITOR::Init(), PCB_EDITOR_CONTROL::Init(), PCB_INSPECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), EDIT_TOOL::Init(), and LIB_TREE::onContextMenu().

◆ GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Function GetType() Returns the type of the tool.

Returns: The type of the tool.

Definition at line 110 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

Function getView()

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

Function getViewControls()

Returns 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(), POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), SCH_EDITOR_CONTROL::AssignNetclass(), SCH_EDIT_TOOL::BreakWire(), PCB_TOOL_BASE::controls(), EDIT_TOOL::copyToClipboard(), SCH_DRAWING_TOOLS::createSheetPin(), COMMON_TOOLS::CursorControl(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EDIT_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomToPreset(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), LIB_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PCB_INSPECTION_TOOL::HighlightNet(), SCH_EDITOR_CONTROL::HighlightNet(), PCB_INSPECTION_TOOL::HighlightNetTool(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), PL_EDIT_TOOL::Main(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), LENGTH_TUNER_TOOL::performTuning(), LIB_DRAWING_TOOLS::PlaceAnchor(), PCBNEW_CONTROL::placeBoardItems(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), EDIT_TOOL::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), PL_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), POINT_EDITOR::Reset(), DRAWING_TOOL::Reset(), COMMON_TOOLS::ResetLocalCoords(), GERBVIEW_SELECTION_TOOL::selectCursor(), selectCursor(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), selectMultiple(), EE_SELECTION_TOOL::SelectNode(), ZOOM_TOOL::selectRegion(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), PCBNEW_PICKER_TOOL::setControls(), EE_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), POINT_EDITOR::updateEditedPoint(), POINT_EDITOR::updateItem(), PL_EDIT_TOOL::updateModificationPoint(), 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

Function Go()

Defines which state (aStateFunc) to go when a certain event arrives (aConditions). No conditions means any event.

Definition at line 129 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().

◆ GuessSelectionCandidates()

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

Function guessSelectionCandidates() Tries to guess best selection candidates in case multiple items are clicked, by doing some brain-dead heuristics.

Parameters

aCollector	is the collector that has a list of items to be queried.
aWhere	is the selection point to consider

Definition at line 2244 of file selection_tool.cpp.

 {
     std::set<BOARD_ITEM*> preferred;
     std::set<BOARD_ITEM*> rejected;
     wxPoint               where( aWhere.x, aWhere.y );
 
     // footprints which are below this percentage of the largest footprint will be considered
     // for selection; all others will not
     constexpr double footprintToFootprintMinRatio = 0.20;
     // pads which are below this percentage of their parent's area will exclude their parent
     constexpr double padToFootprintMinRatio = 0.45;
     // footprints containing items with items-to-footprint area ratio higher than this will be
     // forced to stay on the list
     constexpr double footprintMaxCoverRatio = 0.90;
     constexpr double viaToPadMinRatio = 0.50;
     constexpr double trackViaLengthRatio = 2.0;
     constexpr double trackTrackLengthRatio = 0.3;
     constexpr double textToFeatureMinRatio = 0.2;
     constexpr double textToFootprintMinRatio = 0.4;
     // If the common area of two compared items is above the following threshold, they cannot
     // be rejected (it means they overlap and it might be hard to pick one by selecting
     // its unique area).
     constexpr double commonAreaRatio = 0.6;
 
     PCB_LAYER_ID activeLayer = (PCB_LAYER_ID) view()->GetTopLayer();
     LSET         silkLayers( 2, B_SilkS, F_SilkS );
 
     if( silkLayers[activeLayer] )
     {
         for( int i = 0; i < aCollector.GetCount(); ++i )
         {
             BOARD_ITEM* item = aCollector[i];
             KICAD_T type = item->Type();
 
             if( ( type == PCB_FP_TEXT_T || type == PCB_TEXT_T || type == PCB_SHAPE_T )
                     && silkLayers[item->GetLayer()] )
             {
                 preferred.insert( item );
             }
         }
 
         if( preferred.size() > 0 )
         {
             aCollector.Empty();
 
             for( BOARD_ITEM* item : preferred )
                 aCollector.Append( item );
             return;
         }
     }
 
     // Zone edges are very specific; zone fills much less so.
     if( aCollector.CountType( PCB_ZONE_T ) > 0 )
     {
         for( int i = aCollector.GetCount() - 1; i >= 0; i-- )
         {
             if( aCollector[i]->Type() == PCB_ZONE_T )
             {
                 ZONE* zone = static_cast<ZONE*>( aCollector[i] );
 
                 if( zone->HitTestForEdge( where, 5 * aCollector.GetGuide()->OnePixelInIU() ) )
                     preferred.insert( zone );
                 else
                     rejected.insert( zone );
             }
         }
 
         if( preferred.size() > 0 )
         {
             aCollector.Empty();
 
             for( BOARD_ITEM* item : preferred )
                 aCollector.Append( item );
             return;
         }
     }
 
     if( aCollector.CountType( PCB_FP_TEXT_T ) > 0 )
     {
         for( int i = 0; i < aCollector.GetCount(); ++i )
         {
             if( FP_TEXT* txt = dyn_cast<FP_TEXT*>( aCollector[i] ) )
             {
                 double textArea = calcArea( txt );
 
                 for( int j = 0; j < aCollector.GetCount(); ++j )
                 {
                     if( i == j )
                         continue;
 
                     BOARD_ITEM* item = aCollector[j];
                     double itemArea = calcArea( item );
                     double areaRatio = calcRatio( textArea, itemArea );
                     double commonArea = calcCommonArea( txt, item );
                     double itemCommonRatio = calcRatio( commonArea, itemArea );
                     double txtCommonRatio = calcRatio( commonArea, textArea );
 
                     if( item->Type() == PCB_FOOTPRINT_T )
                     {
                         // when text area is small compared to an overlapping footprint,
                         // then it's a clear sign the text is the selection target
                         if( areaRatio < textToFootprintMinRatio && itemCommonRatio < commonAreaRatio )
                             rejected.insert( item );
                     }
 
                     switch( item->Type() )
                     {
                         case PCB_TRACE_T:
                         case PCB_ARC_T:
                         case PCB_PAD_T:
                         case PCB_SHAPE_T:
                         case PCB_VIA_T:
                         case PCB_FOOTPRINT_T:
                             if( areaRatio > textToFeatureMinRatio && txtCommonRatio < commonAreaRatio )
                                 rejected.insert( txt );
                             break;
                         default:
                             break;
                     }
                 }
             }
         }
     }
 
     if( aCollector.CountType( PCB_FP_SHAPE_T ) + aCollector.CountType( PCB_SHAPE_T ) > 1 )
     {
         // Prefer exact hits to sloppy ones
         int accuracy = KiROUND( 5 * aCollector.GetGuide()->OnePixelInIU() );
         bool found = false;
 
         for( int dist = 0; dist < accuracy; ++dist )
         {
             for( int i = 0; i < aCollector.GetCount(); ++i )
             {
                 if( PCB_SHAPE* shape = dynamic_cast<PCB_SHAPE*>( aCollector[i] ) )
                 {
                     if( shape->HitTest( where, dist ) )
                     {
                         found = true;
                         break;
                     }
                 }
             }
 
             if( found )
             {
                 // throw out everything that is more sloppy than what we found
                 for( int i = 0; i < aCollector.GetCount(); ++i )
                 {
                     if( PCB_SHAPE* shape = dynamic_cast<PCB_SHAPE*>( aCollector[i] ) )
                     {
                         if( !shape->HitTest( where, dist ) )
                             rejected.insert( shape );
                     }
                 }
 
                 // we're done now
                 break;
             }
         }
     }
 
     if( aCollector.CountType( PCB_PAD_T ) > 0 )
     {
         for( int i = 0; i < aCollector.GetCount(); ++i )
         {
             if( PAD* pad = dyn_cast<PAD*>( aCollector[i] ) )
             {
                 FOOTPRINT* parent = pad->GetParent();
                 double ratio = calcRatio( calcArea( pad ), calcArea( parent ) );
 
                 // when pad area is small compared to the parent footprint,
                 // then it is a clear sign the pad is the selection target
                 if( ratio < padToFootprintMinRatio )
                     rejected.insert( pad->GetParent() );
             }
         }
     }
 
     bool hasNonModules = false;
 
     for( int i = 0; i < aCollector.GetCount(); ++i )
     {
         if( aCollector[i]->Type() != PCB_FOOTPRINT_T )
         {
             hasNonModules = true;
             break;
         }
     }
 
     if( aCollector.CountType( PCB_FOOTPRINT_T ) > 0 )
     {
         double maxArea = calcMaxArea( aCollector, PCB_FOOTPRINT_T );
         BOX2D  viewportD = getView()->GetViewport();
         BOX2I  viewport( VECTOR2I( viewportD.GetPosition() ), VECTOR2I( viewportD.GetSize() ) );
         double maxCoverRatio = footprintMaxCoverRatio;
 
         // FOOTPRINT::CoverageRatio() doesn't take zone handles & borders into account so just
         // use a more aggressive cutoff point if zones are involved.
         if(  aCollector.CountType( PCB_ZONE_T ) )
             maxCoverRatio /= 2;
 
         for( int i = 0; i < aCollector.GetCount(); ++i )
         {
             if( FOOTPRINT* footprint = dyn_cast<FOOTPRINT*>( aCollector[i] ) )
             {
                 // filter out components larger than the viewport
                 if( footprint->ViewBBox().GetHeight() > viewport.GetHeight()
                             ||  footprint->ViewBBox().GetWidth() > viewport.GetWidth() )
                 {
                     rejected.insert( footprint );
                 }
                 // footprints completely covered with other features have no other
                 // means of selection, so must be kept
                 else if( footprint->CoverageRatio( aCollector ) > maxCoverRatio )
                 {
                     rejected.erase( footprint );
                 }
                 // if a footprint is much smaller than the largest overlapping
                 // footprint then it should be considered for selection
                 else if( calcRatio( calcArea( footprint ), maxArea ) <= footprintToFootprintMinRatio )
                 {
                     continue;
                 }
                 // reject ALL OTHER footprints if there's still something else left
                 // to select
                 else if( hasNonModules )
                 {
                     rejected.insert( footprint );
                 }
             }
         }
     }
 
     if( aCollector.CountType( PCB_VIA_T ) > 0 )
     {
         for( int i = 0; i < aCollector.GetCount(); ++i )
         {
             if( VIA* via = dyn_cast<VIA*>( aCollector[i] ) )
             {
                 double viaArea = calcArea( via );
 
                 for( int j = 0; j < aCollector.GetCount(); ++j )
                 {
                     if( i == j )
                         continue;
 
                     BOARD_ITEM* item = aCollector[j];
                     double areaRatio = calcRatio( viaArea, calcArea( item ) );
 
                     if( item->Type() == PCB_FOOTPRINT_T && areaRatio < padToFootprintMinRatio )
                         rejected.insert( item );
 
                     if( item->Type() == PCB_PAD_T && areaRatio < viaToPadMinRatio )
                         rejected.insert( item );
 
                     if( TRACK* track = dyn_cast<TRACK*>( item ) )
                     {
                         if( track->GetNetCode() != via->GetNetCode() )
                             continue;
 
                         double lenRatio = (double) ( track->GetLength() + track->GetWidth() ) /
                                           (double) via->GetWidth();
 
                         if( lenRatio > trackViaLengthRatio )
                             rejected.insert( track );
                     }
                 }
             }
         }
     }
 
     int nTracks = aCollector.CountType( PCB_TRACE_T );
 
     if( nTracks > 0 )
     {
         double maxLength = 0.0;
         double minLength = std::numeric_limits<double>::max();
         double maxArea = 0.0;
         const TRACK* maxTrack = nullptr;
 
         for( int i = 0; i < aCollector.GetCount(); ++i )
         {
             if( TRACK* track = dyn_cast<TRACK*>( aCollector[i] ) )
             {
                 maxLength = std::max( track->GetLength(), maxLength );
                 maxLength = std::max( (double) track->GetWidth(), maxLength );
 
                 minLength = std::min( std::max( track->GetLength(), (double) track->GetWidth() ), minLength );
 
                 double area = track->GetLength() * track->GetWidth();
 
                 if( area > maxArea )
                 {
                     maxArea = area;
                     maxTrack = track;
                 }
             }
         }
 
         if( maxLength > 0.0 && minLength / maxLength < trackTrackLengthRatio && nTracks > 1 )
         {
             for( int i = 0; i < aCollector.GetCount(); ++i )
              {
                 if( TRACK* track = dyn_cast<TRACK*>( aCollector[i] ) )
                 {
                     double ratio = std::max( (double) track->GetWidth(), track->GetLength() ) / maxLength;
 
                     if( ratio > trackTrackLengthRatio )
                         rejected.insert( track );
                 }
             }
         }
 
         for( int j = 0; j < aCollector.GetCount(); ++j )
         {
             if( FOOTPRINT* footprint = dyn_cast<FOOTPRINT*>( aCollector[j] ) )
             {
                 double ratio = calcRatio( maxArea, footprint->GetFootprintRect().GetArea() );
 
                 if( ratio < padToFootprintMinRatio
                         && calcCommonArea( maxTrack, footprint ) < commonAreaRatio )
                 {
                     rejected.insert( footprint );
                 }
             }
         }
     }
 
     if( (unsigned) aCollector.GetCount() > rejected.size() )  // do not remove everything
     {
         for( BOARD_ITEM* item : rejected )
             aCollector.Transfer( item );
     }
 }

References COLLECTOR::Append(), B_SilkS, calcArea(), calcCommonArea(), calcMaxArea(), calcRatio(), COLLECTOR::CountType(), FOOTPRINT::CoverageRatio(), COLLECTOR::Empty(), F_SilkS, PCB_TOOL_BASE::footprint(), EDA_RECT::GetArea(), COLLECTOR::GetCount(), FOOTPRINT::GetFootprintRect(), GENERAL_COLLECTOR::GetGuide(), BOX2< Vec >::GetHeight(), BOARD_ITEM::GetLayer(), BOARD_ITEM::GetParent(), BOX2< Vec >::GetPosition(), BOX2< Vec >::GetSize(), KIGFX::VIEW::GetTopLayer(), TOOL_BASE::getView(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), ZONE::HitTestForEdge(), KiROUND(), COLLECTORS_GUIDE::OnePixelInIU(), PCB_ARC_T, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, COLLECTOR::Transfer(), EDA_ITEM::Type(), PCB_TOOL_BASE::view(), FOOTPRINT::ViewBBox(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCBNEW_CONTROL::DeleteItemCursor(), and selectPoint().

◆ highlight()

void SELECTION_TOOL::highlight	(	BOARD_ITEM *	aItem,
		int	aHighlightMode,
		PCBNEW_SELECTION *	aGroup = `nullptr`
	)

private

Function highlight() Highlights the item visually.

Parameters

aItem	is an item to be be highlighted.
aHighlightMode	should be either SELECTED or BRIGHTENED
aGroup	is the group to add the item to in the BRIGHTENED mode.

Definition at line 2031 of file selection_tool.cpp.

 {
     highlightInternal( aItem, aMode, aGroup, false );
 
     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 BRIGHTENED, TOOL_BASE::getView(), highlightInternal(), KIGFX::VIEW::MarkTargetDirty(), KIGFX::REPAINT, KIGFX::TARGET_OVERLAY, KIGFX::PCB_VIEW::Update(), and PCB_TOOL_BASE::view().

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

◆ highlightInternal()

void SELECTION_TOOL::highlightInternal	(	BOARD_ITEM *	aItem,
		int	aHighlightMode,
		PCBNEW_SELECTION *	aSelectionViewGroup,
		bool	isChild
	)

private

Definition at line 2044 of file selection_tool.cpp.

 {
     if( aMode == SELECTED )
         aItem->SetSelected();
     else if( aMode == BRIGHTENED )
         aItem->SetBrightened();
 
     if( aSelectionViewGroup )
     {
         // Hide the original item, so it is shown only on overlay
         view()->Hide( aItem, true );
 
         if( !isChild || aMode == BRIGHTENED )
             aSelectionViewGroup->Add( aItem );
     }
 
     // footprints are treated in a special way - when they are highlighted, we have to highlight
     // all the parts that make the footprint, not the footprint itself
     if( aItem->Type() == PCB_FOOTPRINT_T )
     {
         static_cast<FOOTPRINT*>( aItem )->RunOnChildren(
                 [&]( BOARD_ITEM* aChild )
                 {
                     highlightInternal( aChild, aMode, aSelectionViewGroup, true );
                 } );
     }
     else if( aItem->Type() == PCB_GROUP_T )
     {
         static_cast<PCB_GROUP*>( aItem )->RunOnChildren(
                 [&]( BOARD_ITEM* aChild )
                 {
                     highlightInternal( aChild, aMode, aSelectionViewGroup, true );
                 } );
     }
 }

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

Referenced by highlight().

◆ Init()

bool SELECTION_TOOL::Init ( void )

overridevirtual

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

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

Reimplemented from PCB_TOOL_BASE.

Definition at line 130 of file selection_tool.cpp.

 {
     auto frame = getEditFrame<PCB_BASE_FRAME>();
 
     if( frame && ( frame->IsType( FRAME_FOOTPRINT_VIEWER )
                    || frame->IsType( FRAME_FOOTPRINT_VIEWER_MODAL ) ) )
     {
         frame->AddStandardSubMenus( m_menu );
         return true;
     }
 
     auto selectMenu = std::make_shared<SELECT_MENU>();
     selectMenu->SetTool( this );
     m_menu.AddSubMenu( selectMenu );
 
     auto& menu = m_menu.GetMenu();
 
     auto activeToolCondition =
             [ frame ] ( const SELECTION& aSel )
             {
                 return !frame->ToolStackIsEmpty();
             };
 
     auto inGroupCondition =
             [this] ( const SELECTION& )
             {
                 return m_enteredGroup != nullptr;
             };
 
     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::groupLeave,    inGroupCondition,    1);
     menu.AddSeparator( 1 );
 
     if( frame )
         frame->AddStandardSubMenus( m_menu );
 
     return true;
 }

References PCB_GROUP::AddItem(), EDA_DRAW_FRAME::AddStandardSubMenus(), TOOL_MENU::AddSubMenu(), ACTIONS::cancelInteractive, PCB_TOOL_BASE::frame(), FRAME_FOOTPRINT_VIEWER, FRAME_FOOTPRINT_VIEWER_MODAL, TOOL_MENU::GetMenu(), PCB_ACTIONS::groupLeave, EDA_BASE_FRAME::IsType(), m_enteredGroup, TOOL_INTERACTIVE::m_menu, SELECTION_CONDITIONS::NotEmpty(), and TOOLS_HOLDER::ToolStackIsEmpty().

◆ IsFootprintEditor()

bool PCB_TOOL_BASE::IsFootprintEditor ( ) const

inlineinherited

Definition at line 105 of file pcb_tool_base.h.

105 { return m_isFootprintEditor; }

PCB_TOOL_BASE::m_isFootprintEditor

bool m_isFootprintEditor

Definition: pcb_tool_base.h:176

References PCB_TOOL_BASE::m_isFootprintEditor.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Flip(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), and EDIT_TOOL::Rotate().

◆ 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::isRouterActive(), and ROUTER_TOOL::onViaCommand().

◆ itemPassesFilter()

bool SELECTION_TOOL::itemPassesFilter ( BOARD_ITEM * aItem )

private

Returns true if the given item passes the current SELECTION_FILTER_OPTIONS

Definition at line 1501 of file selection_tool.cpp.

 {
     if( aItem->IsLocked() && !m_filter.lockedItems )
         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_ZONE_T:
     {
         ZONE* zone = static_cast<ZONE*>( aItem );
 
         if( ( !m_filter.zones && !zone->GetIsRuleArea() )
             || ( !m_filter.keepouts && zone->GetIsRuleArea() ) )
         {
             return false;
         }
     }
         break;
 
     case PCB_SHAPE_T:
     case PCB_TARGET_T:
         if( !m_filter.graphics )
             return false;
 
         break;
 
     case PCB_FP_TEXT_T:
     case PCB_TEXT_T:
         if( !m_filter.text )
             return false;
 
         break;
 
     case PCB_DIM_ALIGNED_T:
     case PCB_DIM_CENTER_T:
     case PCB_DIM_ORTHOGONAL_T:
     case PCB_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 SELECTION_TOOL::Main ( const TOOL_EVENT & aEvent )

Function Main()

The main loop.

Definition at line 207 of file selection_tool.cpp.

 {
     // Main loop: keep receiving events
     while( TOOL_EVENT* evt = Wait() )
     {
         bool dragAlwaysSelects = getEditFrame<PCB_BASE_FRAME>()->GetDragSelects();
         TRACK_DRAG_ACTION dragAction = getEditFrame<PCB_BASE_FRAME>()->Settings().m_TrackDragAction;
         m_additive = m_subtractive = m_exclusive_or = false;
 
         // OSX uses CTRL for context menu, and SHIFT is exclusive-or
 #ifdef __WXOSX_MAC__
         if( evt->Modifier( MD_SHIFT ) )
             m_exclusive_or = true;
 #else
         if( evt->Modifier( MD_SHIFT ) && evt->Modifier( MD_CTRL ) )
             m_subtractive = true;
         else if( evt->Modifier( MD_SHIFT ) )
             m_additive = true;
         else if( evt->Modifier( MD_CTRL ) )
             m_exclusive_or = true;
 #endif
 
         bool modifier_enabled = m_subtractive || m_additive || m_exclusive_or;
 
         // Is the user requesting that the selection list include all possible
         // items without removing less likely selection candidates
         m_skip_heuristics = !!evt->Modifier( MD_ALT );
 
         // Single click? Select single object
         if( evt->IsClick( BUT_LEFT ) )
         {
             m_frame->FocusOnItem( nullptr );
 
             selectPoint( evt->Position() );
         }
 
         // Right click? if there is any object - show the context menu
         else if( evt->IsClick( BUT_RIGHT ) )
         {
             bool selectionCancelled = false;
 
             if( m_selection.Empty() )
             {
                 selectPoint( evt->Position(), false, &selectionCancelled );
                 m_selection.SetIsHover( true );
             }
 
             if( !selectionCancelled )
                 m_menu.ShowContextMenu( m_selection );
         }
 
         // Double click? Display the properties window
         else if( evt->IsDblClick( BUT_LEFT ) )
         {
             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 );
             }
         }
 
         // Middle double click?  Do zoom to fit or zoom to objects
         else if( evt->IsDblClick( BUT_MIDDLE ) )
         {
             if( m_exclusive_or ) // Is CTRL key down?
                 m_toolMgr->RunAction( ACTIONS::zoomFitObjects, true );
             else
                 m_toolMgr->RunAction( ACTIONS::zoomFitScreen, true );
         }
 
         // Drag with LMB? Select multiple objects (or at least draw a selection box) or drag them
         else if( evt->IsDrag( BUT_LEFT ) )
         {
             m_frame->FocusOnItem( nullptr );
             m_toolMgr->ProcessEvent( EVENTS::InhibitSelectionEditing );
 
             if( modifier_enabled || dragAlwaysSelects )
             {
                 selectMultiple();
             }
             else
             {
                 // Selection is empty? try to start dragging the item under the point where drag
                 // started
                 if( m_selection.Empty() && selectCursor() )
                     m_selection.SetIsHover( true );
 
                 // Check if dragging has started within any of selected items bounding box.
                 // We verify "HasPosition()" first to protect against edge case involving
                 // moving off menus that causes problems (issue #5250)
                 if( evt->HasPosition() && selectionContains( evt->Position() ) )
                 {
                     // Yes -> run the move tool and wait till it finishes
                     TRACK* track = dynamic_cast<TRACK*>( m_selection.GetItem( 0 ) );
 
                     if( track && dragAction == TRACK_DRAG_ACTION::DRAG )
                         m_toolMgr->RunAction( PCB_ACTIONS::drag45Degree, true );
                     else if( track && dragAction == TRACK_DRAG_ACTION::DRAG_FREE_ANGLE )
                         m_toolMgr->RunAction( PCB_ACTIONS::dragFreeAngle, true );
                     else
                         m_toolMgr->RunAction( PCB_ACTIONS::move, true );
                 }
                 else
                 {
                     // No -> drag a selection box
                     selectMultiple();
                 }
             }
         }
 
         else if( evt->IsCancel() )
         {
             m_frame->FocusOnItem( nullptr );
 
             if( m_enteredGroup )
                 ExitGroup();
 
             ClearSelection();
 
             if( evt->FirstResponder() == this )
                 m_toolMgr->RunAction( PCB_ACTIONS::clearHighlight );
         }
 
         else
             evt->SetPassEvent();
 
 
         if( m_frame->ToolStackIsEmpty() )
         {
             //move cursor prediction
             if( !modifier_enabled && !dragAlwaysSelects && !m_selection.Empty()
                     && evt->HasPosition() && selectionContains( evt->Position() ) )
                 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::MOVING );
             else
             {
                 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( KICURSOR::ARROW );
             }
         }
     }
 
     // Shutting down; clear the selection
     m_selection.Clear();
 
     return 0;
 }

References ADD, ARROW, BUT_LEFT, BUT_MIDDLE, BUT_RIGHT, SELECTION::Clear(), PCB_ACTIONS::clearHighlight, ClearSelection(), DRAG, PCB_ACTIONS::drag45Degree, DRAG_FREE_ANGLE, PCB_ACTIONS::dragFreeAngle, SELECTION::Empty(), EnterGroup(), ExitGroup(), PCB_BASE_FRAME::FocusOnItem(), PCB_BASE_FRAME::GetCanvas(), SELECTION::GetItem(), SELECTION::GetSize(), EVENTS::InhibitSelectionEditing, m_additive, m_enteredGroup, m_exclusive_or, m_frame, TOOL_INTERACTIVE::m_menu, m_selection, m_skip_heuristics, m_subtractive, TOOL_BASE::m_toolMgr, MD_ALT, MD_CTRL, MD_SHIFT, PCB_ACTIONS::move, MOVING, PCB_GROUP_T, TOOL_MANAGER::ProcessEvent(), PCB_ACTIONS::properties, TOOL_MANAGER::RunAction(), selectCursor(), selectionContains(), selectMultiple(), selectPoint(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), SELECTION::SetIsHover(), TOOL_MENU::ShowContextMenu(), SUBTRACT, TOOLS_HOLDER::ToolStackIsEmpty(), TOOL_INTERACTIVE::Wait(), XOR, ACTIONS::zoomFitObjects, and ACTIONS::zoomFitScreen.

Referenced by setTransitions().

◆ pickSmallestComponent()

BOARD_ITEM * SELECTION_TOOL::pickSmallestComponent ( GENERAL_COLLECTOR * aCollector )

private

Function pickSmallestComponent() Allows one to find the smallest (in terms of bounding box area) item from the list.

Parameters

aCollector containes the list of items.

Definition at line 1775 of file selection_tool.cpp.

 {
     int count = aCollector->GetPrimaryCount();     // try to use preferred layer
 
     if( 0 == count )
         count = aCollector->GetCount();
 
     for( int i = 0; i < count; ++i )
     {
         if(( *aCollector )[i]->Type() != PCB_FOOTPRINT_T )
             return NULL;
     }
 
     // All are footprints, now find smallest FOOTPRINT
     int minDim = 0x7FFFFFFF;
     int minNdx = 0;
 
     for( int i = 0; i < count; ++i )
     {
         FOOTPRINT* footprint = (FOOTPRINT*) ( *aCollector )[i];
 
         int lx = footprint->GetFootprintRect().GetWidth();
         int ly = footprint->GetFootprintRect().GetHeight();
 
         int lmin = std::min( lx, ly );
 
         if( lmin < minDim )
         {
             minDim = lmin;
             minNdx = i;
         }
     }
 
     return (*aCollector)[minNdx];
 }

References PCB_TOOL_BASE::footprint(), COLLECTOR::GetCount(), FOOTPRINT::GetFootprintRect(), EDA_RECT::GetHeight(), GENERAL_COLLECTOR::GetPrimaryCount(), EDA_RECT::GetWidth(), NULL, and PCB_FOOTPRINT_T.

◆ RebuildSelection()

void SELECTION_TOOL::RebuildSelection ( )

Rebuilds 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 1601 of file selection_tool.cpp.

 {
     m_selection.Clear();
 
     INSPECTOR_FUNC inspector = [&] ( EDA_ITEM* item, void* testData )
     {
         if( item->IsSelected() )
         {
             EDA_ITEM* parent = item->GetParent();
 
             // Flags on footprint children might be set only because the parent is selected.
             if( parent && parent->Type() == PCB_FOOTPRINT_T && parent->IsSelected() )
                 return SEARCH_RESULT::CONTINUE;
 
             highlight( (BOARD_ITEM*) item, SELECTED, &m_selection );
         }
 
         return SEARCH_RESULT::CONTINUE;
     };
 
     board()->Visit( inspector, nullptr, m_isFootprintEditor ? GENERAL_COLLECTOR::FootprintItems
                                                             : GENERAL_COLLECTOR::AllBoardItems );
 }

References GENERAL_COLLECTOR::AllBoardItems, PCB_TOOL_BASE::board(), SELECTION::Clear(), CONTINUE, GENERAL_COLLECTOR::FootprintItems, EDA_ITEM::GetParent(), highlight(), EDA_ITEM::IsSelected(), PCB_TOOL_BASE::m_isFootprintEditor, m_selection, PCB_FOOTPRINT_T, SELECTED, EDA_ITEM::Type(), and BOARD::Visit().

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

◆ RemoveItemFromSel()

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

Definition at line 922 of file selection_tool.cpp.

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

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

Referenced by BOARD_COMMIT::Push(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), and UnselectItem().

◆ RequestSelection()

PCBNEW_SELECTION & SELECTION_TOOL::RequestSelection	(	CLIENT_SELECTION_FILTER	aClientFilter,
		std::vector< BOARD_ITEM * > *	aFiltered = `nullptr`,
		bool	aConfirmLockedItems = `false`
	)

Function RequestSelection()

Returns the current selection set, filtered according to aFlags and aClientFilter. If the set is empty, performs the legacy-style hover selection.

Parameters

aFiltered is an optional vector, that is filled with items removed by the filter

Definition at line 411 of file 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 ( aConfirmLockedItems && CheckLock() == SELECTION_LOCKED )
     {
         ClearSelection();
         return m_selection;
     }
 
     if( aClientFilter )
     {
         enum DISPOSITION { BEFORE = 1, AFTER, BOTH };
 
         std::map<EDA_ITEM*, DISPOSITION> itemDispositions;
         GENERAL_COLLECTOR                collector;
 
         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 elemetn by the group.
 
         for( std::pair<EDA_ITEM* const, DISPOSITION> itemDisposition : itemDispositions )
         {
             BOARD_ITEM* item = static_cast<BOARD_ITEM*>( itemDisposition.first );
             DISPOSITION disposition = itemDisposition.second;
 
             if( disposition == BEFORE )
             {
                 if( aFiltered )
                     aFiltered->push_back( item );
 
                 unhighlight( item, SELECTED, &m_selection );
             }
         }
 
         for( std::pair<EDA_ITEM* const, DISPOSITION> itemDisposition : itemDispositions )
         {
             BOARD_ITEM* item = static_cast<BOARD_ITEM*>( itemDisposition.first );
             DISPOSITION disposition = itemDisposition.second;
 
             if( disposition == AFTER )
             {
                 highlight( item, SELECTED, &m_selection );
             }
             else if( disposition == BOTH )
             {
                 // nothing to do
             }
         }
 
         m_frame->GetCanvas()->ForceRefresh();
     }
 
     return m_selection;
 }

References COLLECTOR::Append(), CheckLock(), SELECTION::ClearReferencePoint(), ClearSelection(), SELECTION::Empty(), EDA_DRAW_PANEL_GAL::ForceRefresh(), PCB_BASE_FRAME::GetCanvas(), highlight(), m_frame, m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::RunAction(), SELECTED, SELECTION_LOCKED, PCB_ACTIONS::selectionCursor, SELECTION::SetIsHover(), and unhighlight().

Referenced by EDIT_TOOL::ChangeTrackWidth(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Duplicate(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), EDIT_TOOL::FilletTracks(), EDIT_TOOL::Flip(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), CONVERT_TOOL::LinesToPoly(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), GROUP_TOOL::PickNewMember(), CONVERT_TOOL::PolyToLines(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Properties(), EDIT_TOOL::Remove(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), EDIT_TOOL::Rotate(), CONVERT_TOOL::SegmentToArc(), and POSITION_RELATIVE_TOOL::SelectPositionRelativeItem().

◆ Reset()

void SELECTION_TOOL::Reset ( RESET_REASON aReason )

overridevirtual

Function Reset() Brings the tool to a known, initial state.

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

Parameters

aReason contains information about the reason of tool reset.

Reimplemented from PCB_TOOL_BASE.

Definition at line 174 of file selection_tool.cpp.

 {
     m_frame = getEditFrame<PCB_BASE_FRAME>();
     m_locked = true;
 
     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
     {
         // 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(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), TOOL_BASE::getView(), m_enteredGroup, m_enteredGroupOverlay, m_frame, m_locked, m_selection, TOOL_BASE::MODEL_RELOAD, KIGFX::PCB_VIEW::Remove(), KIGFX::RENDER_SETTINGS::SetHighlight(), and PCB_TOOL_BASE::view().

◆ RunMainStack()

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

inherited

Function RunMainStack()

Calls 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 SELECTION_TOOL::select ( BOARD_ITEM * aItem )

Function select() Takes necessary action mark an item as selected.

Parameters

aItem is an item to be selected.

Definition at line 2003 of file 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;
     }
 
     highlight( aItem, SELECTED, &m_selection );
 }

References SELECTION::Contains(), PCB_TOOL_BASE::footprint(), BOARD_ITEM::GetParent(), highlight(), EDA_ITEM::IsSelected(), m_selection, PCB_PAD_T, SELECTED, and EDA_ITEM::Type().

Referenced by AddItemToSel(), EnterGroup(), ExitGroup(), filterSelection(), findCallback(), GROUP_TOOL::Group(), SelectAll(), selectAllItemsOnNet(), selectAllItemsOnSheet(), selectConnectedTracks(), SelectItems(), selectMultiple(), selectNet(), and selectPoint().

◆ Selectable()

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

Function selectable() Checks conditions for an item to be selected.

Returns: True if the item fulfills conditions to be selected.

Definition at line 1812 of file selection_tool.cpp.

 {
     const RENDER_SETTINGS* settings = getView()->GetPainter()->GetSettings();
 
     if( settings->GetHighContrast() )
     {
         std::set<unsigned int> activeLayers = settings->GetHighContrastLayers();
         bool                   onActiveLayer = false;
 
         for( unsigned int layer : activeLayers )
         {
             // NOTE: Only checking the regular layers (not GAL meta-layers)
             if( layer < PCB_LAYER_ID_COUNT && aItem->IsOnLayer( ToLAYER_ID( layer ) ) )
             {
                 onActiveLayer = true;
                 break;
             }
         }
 
         if( !onActiveLayer ) // We do not want to select items that are in the background
             return false;
     }
 
     switch( aItem->Type() )
     {
     case PCB_ZONE_T:
     case PCB_FP_ZONE_T:
     {
         if( !board()->IsElementVisible( LAYER_ZONES ) )
             return false;
 
         const ZONE* zone = static_cast<const ZONE*>( aItem );
 
         // Check to see if this keepout is part of a footprint
         // If it is, and we are not editing the footprint, it should not be selectable
         bool zoneInFootprint = zone->GetParent() && zone->GetParent()->Type() == PCB_FOOTPRINT_T;
 
         if( zoneInFootprint && !m_isFootprintEditor && !checkVisibilityOnly )
             return false;
 
         // zones can exist on multiple layers!
         return ( zone->GetLayerSet() & board()->GetVisibleLayers() ).any();
     }
         break;
 
     case PCB_TRACE_T:
     case PCB_ARC_T:
         if( !board()->IsElementVisible( LAYER_TRACKS ) )
             return false;
         break;
 
     case PCB_VIA_T:
     {
         if( !board()->IsElementVisible( LAYER_VIAS ) )
             return false;
 
         const VIA* via = static_cast<const VIA*>( aItem );
 
         // For vias it is enough if only one of its layers is visible
         return ( board()->GetVisibleLayers() & via->GetLayerSet() ).any();
     }
 
     case 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.
 
         FOOTPRINT* footprint = const_cast<FOOTPRINT*>( static_cast<const FOOTPRINT*>( aItem ) );
 
         for( BOARD_ITEM* item : footprint->GraphicalItems() )
         {
             if( Selectable( item, true ) )
                 return true;
         }
 
         for( PAD* pad : footprint->Pads() )
         {
             if( Selectable( pad, true ) )
                 return true;
         }
 
         for( ZONE* zone : footprint->Zones() )
         {
             if( Selectable( zone, true ) )
                 return true;
         }
 
         return false;
     }
 
     case PCB_FP_TEXT_T:
         // Multiple selection is only allowed in footprint editor mode.  In pcbnew, you have to
         // select footprint subparts one by one, rather than with a drag selection.  This is so
         // you can pick up items under an (unlocked) footprint without also moving the
         // footprint's sub-parts.
         if( !m_isFootprintEditor && !checkVisibilityOnly )
         {
             if( m_multiple && !settings->GetHighContrast() )
                 return false;
         }
 
         if( !m_isFootprintEditor && !view()->IsVisible( aItem ) )
             return false;
 
         break;
 
     case PCB_FP_SHAPE_T:
         // Footprint shape selections are only allowed in footprint editor mode.
         if( !m_isFootprintEditor && !checkVisibilityOnly )
             return false;
 
         break;
 
     case PCB_PAD_T:
     {
         // Multiple selection is only allowed in footprint editor mode.  In pcbnew, you have to
         // select footprint subparts one by one, rather than with a drag selection.  This is so
         // you can pick up items under an (unlocked) footprint without also moving the
         // footprint's sub-parts.
         if( !m_isFootprintEditor && !checkVisibilityOnly )
         {
             if( m_multiple )
                 return false;
         }
 
         if( aItem->Type() == PCB_PAD_T )
         {
             const PAD* pad = static_cast<const PAD*>( aItem );
 
             // Check render mode (from the Items tab) first
             switch( pad->GetAttribute() )
             {
             case PAD_ATTRIB_PTH:
             case PAD_ATTRIB_NPTH:
                 if( !board()->IsElementVisible( LAYER_PADS_TH ) )
                     return false;
                 break;
 
             case PAD_ATTRIB_CONN:
             case PAD_ATTRIB_SMD:
                 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;
                 break;
             }
 
             // Otherwise, pads are selectable if any draw layer is visible
             return ( pad->GetLayerSet() & board()->GetVisibleLayers() ).any();
         }
 
         break;
     }
 
     case 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;
     }
 
     case PCB_MARKER_T:  // Always selectable
         return true;
 
     // These are not selectable
     case PCB_NETINFO_T:
     case NOT_USED:
     case TYPE_NOT_INIT:
         return false;
 
     default:    // Suppress warnings
         break;
     }
 
     // All other items are selected only if the layer on which they exist is visible
     return board()->IsLayerVisible( aItem->GetLayer() )
             && aItem->ViewGetLOD( aItem->GetLayer(), view() ) < view()->GetScale();
 }

References B_Cu, PCB_TOOL_BASE::board(), F_Cu, PCB_TOOL_BASE::footprint(), PAD::GetAttribute(), KIGFX::RENDER_SETTINGS::GetHighContrast(), KIGFX::RENDER_SETTINGS::GetHighContrastLayers(), PCB_GROUP::GetItems(), BOARD_ITEM::GetLayer(), ZONE::GetLayerSet(), PAD::GetLayerSet(), VIA::GetLayerSet(), KIGFX::VIEW::GetPainter(), BOARD_ITEM::GetParent(), KIGFX::VIEW::GetScale(), KIGFX::PAINTER::GetSettings(), TOOL_BASE::getView(), BOARD::GetVisibleLayers(), FOOTPRINT::GraphicalItems(), BOARD::IsElementVisible(), BOARD::IsLayerVisible(), PAD::IsOnLayer(), KIGFX::VIEW::IsVisible(), LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_TH, LAYER_TRACKS, LAYER_VIAS, LAYER_ZONES, PCB_TOOL_BASE::m_isFootprintEditor, m_multiple, NOT_USED, PAD_ATTRIB_CONN, PAD_ATTRIB_NPTH, PAD_ATTRIB_PTH, PAD_ATTRIB_SMD, FOOTPRINT::Pads(), PCB_ARC_T, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_MARKER_T, PCB_NETINFO_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, ToLAYER_ID(), EDA_ITEM::Type(), TYPE_NOT_INIT, PCB_TOOL_BASE::view(), KIGFX::VIEW_ITEM::ViewGetLOD(), and FOOTPRINT::Zones().

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

◆ SelectAll()

int SELECTION_TOOL::SelectAll ( const TOOL_EVENT & aEvent )

Select all items on the board

Definition at line 856 of file 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;
 
     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 ) )
             continue;
 
         select( item );
     }
 
     m_frame->GetCanvas()->ForceRefresh();
 
     return 0;
 }

References EDA_DRAW_PANEL_GAL::ForceRefresh(), PCB_BASE_FRAME::GetCanvas(), TOOL_BASE::getView(), itemPassesFilter(), m_frame, KIGFX::VIEW::Query(), select(), Selectable(), BOX2< Vec >::SetMaximum(), and PCB_TOOL_BASE::view().

Referenced by setTransitions().

◆ selectAllItemsOnNet()

void SELECTION_TOOL::selectAllItemsOnNet	(	int	aNetCode,
		bool	aSelect = `true`
	)

private

Selects 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 1125 of file selection_tool.cpp.

 {
     constexpr KICAD_T types[] = { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T, EOT };
     auto connectivity = board()->GetConnectivity();
 
     for( BOARD_CONNECTED_ITEM* item : connectivity->GetNetItems( aNetCode, types ) )
         if( itemPassesFilter( item ) )
             aSelect ? select( item ) : unselect( item );
 }

References PCB_TOOL_BASE::board(), EOT, BOARD::GetConnectivity(), itemPassesFilter(), PCB_ARC_T, PCB_TRACE_T, PCB_VIA_T, select(), and unselect().

Referenced by selectNet().

◆ selectAllItemsOnSheet()

void SELECTION_TOOL::selectAllItemsOnSheet ( wxString & aSheetPath )

private

Selects all items with the given sheet timestamp/UUID name (the sheet path) The path of the root sheet is "/".

Definition at line 1171 of file selection_tool.cpp.

 {
     std::list<FOOTPRINT*> footprintList;
 
     // 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( aSheetPath.IsEmpty() )
             aSheetPath += '/';
 
         if( footprint_path == aSheetPath )
             footprintList.push_back( footprint );
     }
 
     //Generate a list of all pads, and of all nets they belong to.
     std::list<int>  netcodeList;
     std::list<PAD*> padList;
 
     for( FOOTPRINT* footprint : footprintList )
     {
         for( PAD* pad : footprint->Pads() )
         {
             if( pad->IsConnected() )
             {
                 netcodeList.push_back( pad->GetNetCode() );
                 padList.push_back( pad );
             }
         }
     }
     // remove all duplicates
     netcodeList.sort();
     netcodeList.unique();
 
     for( PAD* pad : padList )
         selectConnectedTracks( *pad, STOP_NEVER );
 
     // 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 belonging to this sheet
     std::list<int> removeCodeList;
     constexpr KICAD_T padType[] = { PCB_PAD_T, EOT };
 
     for( int netCode : netcodeList )
     {
         for( BOARD_CONNECTED_ITEM* mitem : board()->GetConnectivity()->GetNetItems( netCode, padType ) )
         {
             if( mitem->Type() == PCB_PAD_T && !alg::contains( footprintList, mitem->GetParent() ) )
             {
                 // if we cannot find the footprint of the pad in the footprintList then we can
                 // assume that that footprint is not located in the same schematic, therefore
                 // invalidate this netcode.
                 removeCodeList.push_back( netCode );
                 break;
             }
         }
     }
 
     // remove all duplicates
     removeCodeList.sort();
     removeCodeList.unique();
 
     for( int removeCode : removeCodeList )
     {
         netcodeList.remove( removeCode );
     }
 
     std::list<BOARD_CONNECTED_ITEM*> localConnectionList;
     constexpr KICAD_T trackViaType[] = { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T, EOT };
 
     for( int netCode : netcodeList )
     {
         for( BOARD_CONNECTED_ITEM* item : board()->GetConnectivity()->GetNetItems( netCode, trackViaType ) )
             localConnectionList.push_back( item );
     }
 
     for( BOARD_ITEM* i : footprintList )
     {
         if( i != NULL )
             select( i );
     }
 
     for( BOARD_CONNECTED_ITEM* i : localConnectionList )
     {
         if( i != NULL )
             select( i );
     }
 }

References KIID_PATH::AsString(), PCB_TOOL_BASE::board(), alg::contains(), EOT, PCB_TOOL_BASE::footprint(), FOOTPRINT::GetPath(), NULL, FOOTPRINT::Pads(), PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, select(), selectConnectedTracks(), and STOP_NEVER.

Referenced by selectSameSheet(), and selectSheetContents().

◆ selectConnectedTracks()

void SELECTION_TOOL::selectConnectedTracks	(	BOARD_CONNECTED_ITEM &	aSourceItem,
		STOP_CONDITION	aStopCondition
	)

private

Selects connecteed tracks and vias.

Parameters

aStopCondition where to stop selecting more items

Definition at line 1007 of file selection_tool.cpp.

 {
     constexpr KICAD_T types[] = { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T, PCB_PAD_T, EOT };
 
     auto connectivity = board()->GetConnectivity();
     auto connectedItems = connectivity->GetConnectedItems( &aStartItem, types );
 
     std::map<wxPoint, std::vector<TRACK*>> trackMap;
     std::map<wxPoint, VIA*>                viaMap;
     std::map<wxPoint, PAD*>                padMap;
 
     // Build maps of connected items
     for( BOARD_CONNECTED_ITEM* item : connectedItems )
     {
         switch( item->Type() )
         {
         case PCB_ARC_T:
         case PCB_TRACE_T:
         {
             TRACK* track = static_cast<TRACK*>( item );
             trackMap[ track->GetStart() ].push_back( track );
             trackMap[ track->GetEnd() ].push_back( track );
         }
             break;
 
         case PCB_VIA_T:
         {
             VIA* via = static_cast<VIA*>( item );
             viaMap[ via->GetStart() ] = via;
         }
             break;
 
         case PCB_PAD_T:
         {
             PAD* pad = static_cast<PAD*>( item );
             padMap[ pad->GetPosition() ] = pad;
         }
             break;
 
         default:
             break;
         }
 
         item->SetState( SKIP_STRUCT, false );
     }
 
     std::vector<wxPoint> activePts;
 
     // Set up the initial active points
     switch( aStartItem.Type() )
     {
     case PCB_ARC_T:
     case PCB_TRACE_T:
         activePts.push_back( static_cast<TRACK*>( &aStartItem )->GetStart() );
         activePts.push_back( static_cast<TRACK*>( &aStartItem )->GetEnd() );
         break;
 
     case PCB_VIA_T:
         activePts.push_back( static_cast<TRACK*>( &aStartItem )->GetStart() );
         break;
 
     case PCB_PAD_T:
         activePts.push_back( aStartItem.GetPosition() );
         break;
 
     default:
         break;
     }
 
     bool expand = true;
 
     // Iterative push from all active points
     while( expand )
     {
         expand = false;
 
         for( int i = activePts.size() - 1; i >= 0; --i )
         {
             wxPoint pt = activePts[i];
 
             if( trackMap[ pt ].size() > 2 && aStopCondition == STOP_AT_JUNCTION )
             {
                 activePts.erase( activePts.begin() + i );
                 continue;
             }
 
             if( padMap.count( pt ) && aStopCondition != STOP_NEVER )
             {
                 activePts.erase( activePts.begin() + i );
                 continue;
             }
 
             for( TRACK* track : trackMap[ pt ] )
             {
                 if( track->GetState( SKIP_STRUCT ) )
                     continue;
 
                 track->SetState( SKIP_STRUCT, true );
                 select( track );
 
                 if( track->GetStart() == pt )
                     activePts.push_back( track->GetEnd() );
                 else
                     activePts.push_back( track->GetStart() );
 
                 expand = true;
             }
 
             if( viaMap.count( pt ) && !viaMap[ pt ]->IsSelected() )
                 select( viaMap[ pt ] );
 
             activePts.erase( activePts.begin() + i );
         }
     }
 }

References PCB_TOOL_BASE::board(), EOT, BOARD::GetConnectivity(), TRACK::GetEnd(), PAD::GetPosition(), EDA_ITEM::GetPosition(), TRACK::GetStart(), PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, select(), EDA_ITEM::SetState(), SKIP_STRUCT, STOP_AT_JUNCTION, STOP_NEVER, and EDA_ITEM::Type().

Referenced by expandConnection(), and selectAllItemsOnSheet().

◆ selectCursor()

bool SELECTION_TOOL::selectCursor	(	bool	aForceSelect = `false`,
		CLIENT_SELECTION_FILTER	aClientFilter = `NULL`
	)

private

Function selectCursor() Selects an item under the cursor unless there is something already selected or aSelectAlways is true.

Parameters

aForceSelect	forces to select an item even if there is an item already selected.
aClientFilter	allows the client to perform tool- or action-specific filtering.

Returns: true if eventually there is an item selected, false otherwise.

Definition at line 625 of file selection_tool.cpp.

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

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

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

◆ selection() [1/2]

const PCBNEW_SELECTION & PCB_TOOL_BASE::selection ( ) const

protectedinherited

Definition at line 291 of file pcb_tool_base.cpp.

 {
     SELECTION_TOOL* selTool = m_toolMgr->GetTool<SELECTION_TOOL>();
 
     return selTool->GetSelection();
 }

References GetSelection(), TOOL_MANAGER::GetTool(), and TOOL_BASE::m_toolMgr.

◆ selection() [2/2]

PCBNEW_SELECTION & PCB_TOOL_BASE::selection ( )

protectedinherited

Definition at line 299 of file pcb_tool_base.cpp.

 {
     SELECTION_TOOL* selTool = m_toolMgr->GetTool<SELECTION_TOOL>();
 
     return selTool->GetSelection();
 }

References GetSelection(), TOOL_MANAGER::GetTool(), and TOOL_BASE::m_toolMgr.

◆ selectionContains()

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

private

Function selectionContains()

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

Definition at line 2137 of file selection_tool.cpp.

 {
     const unsigned GRIP_MARGIN = 20;
     VECTOR2I margin = getView()->ToWorld( VECTOR2I( GRIP_MARGIN, GRIP_MARGIN ), false );
 
     // Check if the point is located within any of the currently selected items bounding boxes
     for( auto item : m_selection )
     {
         BOX2I itemBox = item->ViewBBox();
         itemBox.Inflate( margin.x, margin.y );    // Give some margin for gripping an item
 
         if( itemBox.Contains( aPoint ) )
             return true;
     }
 
     return false;
 }

References BOX2< Vec >::Contains(), TOOL_BASE::getView(), BOX2< Vec >::Inflate(), m_selection, KIGFX::VIEW::ToWorld(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Main().

◆ SelectionMenu()

int SELECTION_TOOL::SelectionMenu ( const TOOL_EVENT & aEvent )

Function SelectionMenu() Shows 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 1626 of file selection_tool.cpp.

 {
     GENERAL_COLLECTOR* collector = aEvent.Parameter<GENERAL_COLLECTOR*>();
 
     doSelectionMenu( collector, wxEmptyString );
 
     return 0;
 }

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

Referenced by setTransitions().

◆ SelectItem()

int SELECTION_TOOL::SelectItem ( const TOOL_EVENT & aEvent )

Item selection event handler.

Definition at line 849 of file selection_tool.cpp.

 {
     AddItemToSel( aEvent.Parameter<BOARD_ITEM*>() );
     return 0;
 }

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

Referenced by setTransitions().

◆ SelectItems()

int SELECTION_TOOL::SelectItems ( const TOOL_EVENT & aEvent )

Multiple item selection event handler

Definition at line 832 of file selection_tool.cpp.

 {
     std::vector<BOARD_ITEM*>* items = aEvent.Parameter<std::vector<BOARD_ITEM*>*>();
 
     if( items )
     {
         // Perform individual selection of each item before processing the event.
         for( BOARD_ITEM* item : *items )
             select( item );
 
         m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
     }
 
     return 0;
 }

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

Referenced by setTransitions().

◆ selectMultiple()

bool SELECTION_TOOL::selectMultiple ( )

private

Function selectMultiple() Handles drawing a selection box that allows one to select many items at the same time.

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

Definition at line 637 of file 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 windowSelection = width >= 0 ? true : false;
 
         if( view->IsMirroredX() )
             windowSelection = !windowSelection;
 
         m_frame->GetCanvas()->SetCurrentCursor(
                 windowSelection ? KICURSOR::SELECT_WINDOW : KICURSOR::SELECT_LASSO );
 
         if( evt->IsCancelInteractive() || evt->IsActivate() )
         {
             cancelled = true;
             break;
         }
 
         if( evt->IsDrag( BUT_LEFT ) )
         {
             if( !m_additive && !m_subtractive && !m_exclusive_or )
             {
                 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_additive );
             area.SetSubtractive( m_subtractive );
             area.SetExclusiveOr( m_exclusive_or );
 
             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 an EDA_RECT to determine BOARD_ITEM selection
             EDA_RECT selectionRect( (wxPoint) area.GetOrigin(), wxSize( width, height ) );
 
             selectionRect.Normalize();
 
             GENERAL_COLLECTOR collector;
 
             for( auto it = candidates.begin(), it_end = candidates.end(); it != it_end; ++it )
             {
                 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( it->first );
 
                 if( item && Selectable( item ) && item->HitTest( selectionRect, windowSelection ) )
                     collector.Append( item );
             }
 
             // Apply the stateful filter
             FilterCollectedItems( collector );
 
             FilterCollectorForGroups( collector );
 
             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
         }
     }
 
     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 SELECTION_TOOL::selectNet ( const TOOL_EVENT & aEvent )

private

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

Definition at line 1136 of file selection_tool.cpp.

 {
     bool select = aEvent.IsAction( &PCB_ACTIONS::selectNet );
 
     // If we've been passed an argument, just select that netcode1
     int netcode = aEvent.Parameter<intptr_t>();
 
     if( netcode > 0 )
     {
         selectAllItemsOnNet( netcode, select );
         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 );
 
     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, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectNet, and SELECTION::Size().

Referenced by setTransitions().

◆ selectPoint()

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

private

Function selectPoint() Selects 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 cancelled (for instance, by clicking outside of the disambiguation menu).
aClientFilter	allows the client to perform tool- or action-specific filtering.

Returns: True if an item was selected, false otherwise.

Definition at line 521 of file 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( wxPoint( aWhere.x, aWhere.y ) ) )
     {
             ExitGroup();
     }
 
     collector.Collect( board(), m_isFootprintEditor ? GENERAL_COLLECTOR::FootprintItems
                                                     : GENERAL_COLLECTOR::AllBoardItems,
                        (wxPoint) 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 );
 
     // Apply the stateful filter
     FilterCollectedItems( collector );
 
     FilterCollectorForGroups( collector );
 
     // Apply some ugly heuristics to avoid disambiguation menus whenever possible
     if( collector.GetCount() > 1 && !m_skip_heuristics )
     {
         GuessSelectionCandidates( collector, aWhere );
     }
 
     // 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, wxEmptyString ) )
         {
             if( aSelectionCancelledFlag )
                 *aSelectionCancelledFlag = true;
 
             return false;
         }
     }

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ INTERACTIVE_PLACEMENT_OPTIONS

◆ RESET_REASON

◆ STOP_CONDITION

Constructor & Destructor Documentation

◆ SELECTION_TOOL()

◆ ~SELECTION_TOOL()

Member Function Documentation

◆ Activate()

◆ AddItemToSel()

◆ attachManager()

◆ board()

◆ BrightenItem()

◆ canvas()

◆ CheckLock()

◆ ClearSelection() [1/2]

◆ ClearSelection() [2/2]

◆ controls()

◆ CursorSelection()

◆ displayOptions()

◆ doInteractiveItemPlacement()

◆ doSelectionMenu()

◆ EnterGroup()

◆ ExitGroup()

◆ expandConnection()

◆ FilterCollectedItems()

◆ FilterCollectorForGroups()

◆ filterSelection()

◆ find()

◆ findCallback()

◆ footprint()

◆ frame()

◆ GetBoard()

◆ getCollectorsGuide()

◆ getEditFrame()

◆ GetEnteredGroup()

◆ GetFilter()

◆ GetId()

◆ GetManager()

◆ getModel()

◆ GetName()

◆ GetSelection()

◆ GetToolMenu()

◆ GetType()

◆ getView()

◆ getViewControls()

◆ Go()

◆ GuessSelectionCandidates()

◆ highlight()

◆ highlightInternal()

◆ Init()

◆ IsFootprintEditor()

◆ IsToolActive()

◆ itemPassesFilter()

◆ Main()

◆ pickSmallestComponent()

◆ RebuildSelection()

◆ RemoveItemFromSel()

◆ RequestSelection()

◆ Reset()

◆ RunMainStack()

◆ select()

◆ Selectable()

◆ SelectAll()

◆ selectAllItemsOnNet()

◆ selectAllItemsOnSheet()

◆ selectConnectedTracks()

◆ selectCursor()

◆ selection() [1/2]

◆ selection() [2/2]