#include <ee_selection_tool.h>

Inheritance diagram for EE_SELECTION_TOOL:

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

Public Member Functions
	EE_SELECTION_TOOL ()

	~EE_SELECTION_TOOL ()

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

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

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

void	OnIdle (wxIdleEvent &aEvent)
	Zoom the screen to fit the bounding box for cross probing/selection sync. More...

void	ZoomFitCrossProbeBBox (const BOX2I &aBBox)

EE_SELECTION &	GetSelection ()

EE_SELECTION &	RequestSelection (const std::vector< KICAD_T > &aScanTypes={ SCH_LOCATE_ANY_T })
	Return either an existing selection (filtered), or the selection at the current cursor position if the existing selection is empty. More...

bool	SelectPoint (const VECTOR2I &aWhere, const std::vector< KICAD_T > &aScanTypes={ SCH_LOCATE_ANY_T }, EDA_ITEM *aItem=nullptr, bool aSelectionCancelledFlag=nullptr, bool aCheckLocked=false, bool aAdd=false, bool aSubtract=false, bool aExclusiveOr=false)
	Perform a click-type selection at a point (usually the cursor position). More...

EDA_ITEM *	GetNode (VECTOR2I aPosition)
	Finds a connected item at a point (usually the cursor position). More...

int	SelectNode (const TOOL_EVENT &aEvent)
	Selects the connected item at the current cursor position. More...

int	SelectConnection (const TOOL_EVENT &aEvent)
	If a connected item is selected then expand the selection to the entire connection, otherwise select connection under the current cursor position. More...

int	ClearSelection (const TOOL_EVENT &aEvent)
	Select all visible items in sheet. More...

int	SelectAll (const TOOL_EVENT &aEvent)

void	ClearSelection (bool aQuietMode=false)

bool	Selectable (const EDA_ITEM aItem, const VECTOR2I aPos=nullptr, bool checkVisibilityOnly=false) const
	Check conditions for an item to be selected. More...

void	GuessSelectionCandidates (EE_COLLECTOR &collector, const VECTOR2I &aPos)
	Apply heuristics to try and determine a single object when multiple are found under the cursor. More...

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

bool	CollectHits (EE_COLLECTOR &aCollector, const VECTOR2I &aWhere, const std::vector< KICAD_T > &aScanTypes={ SCH_LOCATE_ANY_T })
	Collect one or more items at a given point. More...

int	SyncSelection (std::optional< SCH_SHEET_PATH > targetSheetPath, SCH_ITEM focusItem, std::vector< SCH_ITEM > items)

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

int	AddItemToSel (const TOOL_EVENT &aEvent)

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

int	AddItemsToSel (const TOOL_EVENT &aEvent)

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

int	RemoveItemFromSel (const TOOL_EVENT &aEvent)

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

int	RemoveItemsFromSel (const TOOL_EVENT &aEvent)

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

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

void	BrightenItem (EDA_ITEM *aItem)

void	UnbrightenItem (EDA_ITEM *aItem)

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

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

TOOL_MENU &	GetToolMenu ()

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

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

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

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

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

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

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

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

bool	IsToolActive () const

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

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

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

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

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

bool	doSelectionMenu (COLLECTOR *aCollector)

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

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

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

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

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

Protected Attributes
bool	m_additive

bool	m_subtractive

bool	m_exclusive_or

bool	m_multiple

bool	m_skip_heuristics

bool	m_highlight_modifier

bool	m_drag_additive

bool	m_drag_subtractive

bool	m_canceledMenu

wxTimer	m_disambiguateTimer

VECTOR2I	m_originalCursor

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

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

TOOL_ID	m_toolId
	Name of the tool. More...

std::string	m_toolName

TOOL_MANAGER *	m_toolMgr

Private Member Functions
OPT_TOOL_EVENT	autostartEvent (TOOL_EVENT aEvent, EE_GRID_HELPER &aGrid, SCH_ITEM aItem)

void	narrowSelection (EE_COLLECTOR &collector, const VECTOR2I &aWhere, bool aCheckLocked, bool aSelectedOnly=false)
	Apply rules to narrow the collection down to selectable objects, and then heuristics to try and narrow it to a single object. More...

bool	selectPoint (EE_COLLECTOR &aCollector, const VECTOR2I &aWhere, EDA_ITEM *aItem=nullptr, bool aSelectionCancelledFlag=nullptr, bool aAdd=false, bool aSubtract=false, bool aExclusiveOr=false)
	Perform a click-type selection at a point (usually the cursor position). More...

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

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

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

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

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

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

void	updateReferencePoint ()
	Set the reference point to the anchor of the top-left item. More...

bool	selectionContains (const VECTOR2I &aPoint) const
	Set up handlers for various events. More...

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

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

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

EDA_ITEM *	getModelInt () const

TOOLS_HOLDER *	getToolHolderInt () const

Private Attributes
SCH_BASE_FRAME *	m_frame

EE_SELECTION	m_selection

KICURSOR	m_nonModifiedCursor

bool	m_isSymbolEditor

bool	m_isSymbolViewer

int	m_unit

int	m_convert

Detailed Description

Definition at line 58 of file ee_selection_tool.h.

Member Enumeration Documentation

◆ RESET_REASON

enum TOOL_BASE::RESET_REASON

inherited

Determine the reason of reset for a tool.

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

Definition at line 77 of file tool_base.h.

Constructor & Destructor Documentation

◆ EE_SELECTION_TOOL()

EE_SELECTION_TOOL::EE_SELECTION_TOOL ( )

Definition at line 131 of file ee_selection_tool.cpp.

References SELECTION::Clear(), and m_selection.

◆ ~EE_SELECTION_TOOL()

EE_SELECTION_TOOL::~EE_SELECTION_TOOL ( )

Definition at line 144 of file ee_selection_tool.cpp.

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

Member Function Documentation

◆ Activate()

void TOOL_INTERACTIVE::Activate ( )

inherited

Run the tool.

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

Definition at line 51 of file tool_interactive.cpp.

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

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

◆ AddItemsToSel() [1/2]

int SELECTION_TOOL::AddItemsToSel ( const TOOL_EVENT & aEvent )

inherited

Definition at line 128 of file selection_tool.cpp.

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

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

◆ AddItemsToSel() [2/2]

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

inherited

Definition at line 136 of file selection_tool.cpp.

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

◆ AddItemToSel() [1/2]

int SELECTION_TOOL::AddItemToSel ( const TOOL_EVENT & aEvent )

inherited

Definition at line 107 of file selection_tool.cpp.

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

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

◆ AddItemToSel() [2/2]

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

inherited

Definition at line 115 of file selection_tool.cpp.

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

◆ attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER * aManager )

protectedinherited

Set the TOOL_MANAGER the tool will belong to.

Called by TOOL_MANAGER::RegisterTool()

Definition at line 60 of file tool_base.cpp.

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

◆ autostartEvent()

OPT_TOOL_EVENT EE_SELECTION_TOOL::autostartEvent	(	TOOL_EVENT *	aEvent,
		EE_GRID_HELPER &	aGrid,
		SCH_ITEM *	aItem
	)

private

Definition at line 718 of file ee_selection_tool.cpp.

References EESCHEMA_SETTINGS::DRAWING::auto_start_wires, EE_GRID_HELPER::BestSnapAnchor(), SCH_CONNECTION::ConfigureFromLabel(), SCHEMATIC::ConnectionGraph(), EE_ACTIONS::drawBus, EE_ACTIONS::drawLines, EE_ACTIONS::drawWire, SCH_BASE_FRAME::eeconfig(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), EDA_TEXT::GetText(), TOOL_MANAGER::GetTool(), TOOL_BASE::getViewControls(), EE_POINT_EDITOR::HasPoint(), SCH_CONNECTION::IsBus(), SCH_LINE::IsBus(), SCH_LINE::IsGraphicLine(), SCH_ITEM::IsPointClickableAnchor(), LAYER_CONNECTABLE, SCH_BUS_WIRE_ENTRY::m_connected_bus_item, EESCHEMA_SETTINGS::m_Drawing, m_frame, TOOL_BASE::m_toolMgr, TOOL_ACTION::MakeEvent(), TOOL_EVENT::Position(), SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_LINE_T, SCH_SHEET_PIN_T, SCH_ITEM::Schematic(), TOOL_EVENT::SetMousePosition(), and EDA_ITEM::Type().

Referenced by Main().

◆ BrightenItem()

void SELECTION_TOOL::BrightenItem ( EDA_ITEM * aItem )

inherited

Definition at line 207 of file selection_tool.cpp.

References BRIGHTENED, and SELECTION_TOOL::highlight().

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

◆ ClearSelection() [1/2]

void EE_SELECTION_TOOL::ClearSelection ( bool aQuietMode = false )

Definition at line 1873 of file ee_selection_tool.cpp.

References EVENTS::ClearedEvent, SELECTION::ClearReferencePoint(), SELECTION::Empty(), SELECTION::Front(), SELECTION::GetSize(), TOOL_BASE::getView(), m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SELECTED, SELECTION::SetIsHover(), unhighlight(), and KIGFX::VIEW::Update().

◆ ClearSelection() [2/2]

int EE_SELECTION_TOOL::ClearSelection ( const TOOL_EVENT & aEvent )

Select all visible items in sheet.

Definition at line 1595 of file ee_selection_tool.cpp.

References ClearSelection().

Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), SCH_EDIT_TOOL::BreakWire(), ClearSelection(), SCH_FIND_REPLACE_TOOL::FindNext(), Main(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), RequestSelection(), selectMultiple(), selectPoint(), setTransitions(), SCH_EDITOR_CONTROL::SimTune(), and SyncSelection().

◆ CollectHits()

bool EE_SELECTION_TOOL::CollectHits	(	EE_COLLECTOR &	aCollector,
		const VECTOR2I &	aWhere,
		const std::vector< KICAD_T > &	aScanTypes = `{ SCH_LOCATE_ANY_T }`
	)

Collect one or more items at a given point.

This method does not attempt to disambiguate multiple items and is simply "collecting".

Parameters

aCollector	[in, out] Provides collection conditions and stores collected items.
aWhere	Point from which the collection should be made.
aScanTypes	[optional] A list of item types that are acceptable for collection. Set selection to items passed by parameter. Zooms to fit, if enabled.

Definition at line 816 of file ee_selection_tool.cpp.

References COLLECTOR::Append(), EE_COLLECTOR::Collect(), SCH_BASE_FRAME::eeconfig(), EuclideanNorm(), COLLECTOR::GetCount(), LIB_SYMBOL::GetDrawItems(), SCH_BASE_FRAME::GetRenderSettings(), SCH_BASE_FRAME::GetScreen(), TOOL_BASE::getView(), COLLECTOR::HasItem(), HITTEST_THRESHOLD_PIXELS, KiROUND(), m_convert, m_frame, m_isSymbolEditor, EESCHEMA_SETTINGS::m_Selection, EE_COLLECTOR::m_ShowPinElectricalTypes, KIGFX::SCH_RENDER_SETTINGS::m_ShowPinsElectricalType, COLLECTOR::m_Threshold, m_unit, pin, SCH_PIN_T, and EESCHEMA_SETTINGS::SELECTION::select_pin_selects_symbol.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), Main(), and SelectPoint().

◆ ctrlClickHighlights()

virtual bool SELECTION_TOOL::ctrlClickHighlights ( )

inlineprotectedvirtualinherited

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

Reimplemented in PCB_SELECTION_TOOL.

Definition at line 127 of file selection_tool.h.

Referenced by SELECTION_TOOL::setModifiersState().

◆ disambiguateCursor()

int EE_SELECTION_TOOL::disambiguateCursor ( const TOOL_EVENT & aEvent )

private

Handle disambiguation actions including displaying the menu.

Definition at line 773 of file ee_selection_tool.cpp.

References SELECTION_TOOL::m_additive, SELECTION_TOOL::m_canceledMenu, SELECTION_TOOL::m_exclusive_or, SELECTION_TOOL::m_originalCursor, SELECTION_TOOL::m_skip_heuristics, SELECTION_TOOL::m_subtractive, SCH_LOCATE_ANY_T, SelectPoint(), and SELECTION_TOOL::setModifiersState().

Referenced by setTransitions().

◆ doSelectionMenu()

bool SELECTION_TOOL::doSelectionMenu ( COLLECTOR * aCollector )

protectedinherited

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

Definition at line 245 of file selection_tool.cpp.

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

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

◆ getEditFrame()

template<typename T >

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 186 of file tool_base.h.

References TOOL_BASE::getToolHolderInt().

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

◆ GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Return the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns: Identifier of the tool.

Definition at line 122 of file tool_base.h.

References TOOL_BASE::m_toolId.

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

◆ GetManager()

TOOL_MANAGER * TOOL_BASE::GetManager ( ) const

inlineinherited

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

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

Definition at line 145 of file tool_base.h.

References TOOL_BASE::m_toolMgr.

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

◆ getModel()

template<typename T >

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Store the type of the tool.

Definition at line 198 of file tool_base.h.

References TOOL_BASE::getModelInt().

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

◆ getModelInt()

EDA_ITEM * TOOL_BASE::getModelInt ( ) const

privateinherited

Definition at line 54 of file tool_base.cpp.

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

Referenced by TOOL_BASE::getModel().

◆ GetName()

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

inlineinherited

Return the name of the tool.

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

Returns: The name of the tool.

Definition at line 135 of file tool_base.h.

References TOOL_BASE::m_toolName.

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

◆ GetNode()

EDA_ITEM * EE_SELECTION_TOOL::GetNode ( VECTOR2I aPosition )

Finds a connected item at a point (usually the cursor position).

Iterative process with a decreasing slop factor.

Parameters

aPosition Cursor position from which the search should be made.

Returns: a connected item or nullptr.

Definition at line 1524 of file ee_selection_tool.cpp.

References EE_COLLECTOR::Collect(), connectedTypes, EuclideanNorm(), COLLECTOR::GetCount(), SCH_BASE_FRAME::GetScreen(), TOOL_BASE::getView(), HITTEST_THRESHOLD_PIXELS, KiROUND(), m_frame, and COLLECTOR::m_Threshold.

Referenced by highlightNet(), and SCH_EDITOR_CONTROL::SimProbe().

◆ GetSelection()

EE_SELECTION & EE_SELECTION_TOOL::GetSelection ( )

Returns: the set of currently selected items.

Definition at line 810 of file ee_selection_tool.cpp.

References m_selection.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDITOR_CONTROL::AssignNetclass(), EE_INSPECTION_TOOL::CrossProbe(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), EE_INSPECTION_TOOL::ExcludeMarker(), SCH_FIND_REPLACE_TOOL::getCurrentMatch(), SYMBOL_EDIT_FRAME::HardRedraw(), EE_POINT_EDITOR::Main(), Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_DRAWING_TOOLS::SingleClickPlace(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_UNIT_MENU::update(), SCH_FIND_REPLACE_TOOL::UpdateFind(), and EE_INSPECTION_TOOL::UpdateMessagePanel().

◆ getToolHolderInt()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInt ( ) const

privateinherited

Definition at line 48 of file tool_base.cpp.

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

Referenced by TOOL_BASE::getEditFrame().

◆ GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inlineinherited

◆ GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns: The type of the tool.

Definition at line 110 of file tool_base.h.

References TOOL_BASE::m_type.

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

◆ getView()

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

protectedinherited

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

It allows tools to draw.

Returns: The instance of VIEW.

Definition at line 36 of file tool_base.cpp.

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

◆ getViewControls()

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

protectedinherited

Return the instance of VIEW_CONTROLS object used in the application.

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

Returns: The instance of VIEW_CONTROLS.

Definition at line 42 of file tool_base.cpp.

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

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

◆ Go()

template<class T >

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

inherited

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

No conditions means any event.

Definition at line 147 of file tool_interactive.h.

References TOOL_INTERACTIVE::goInternal().

◆ goInternal()

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

privateinherited

Definition at line 70 of file tool_interactive.cpp.

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

Referenced by TOOL_INTERACTIVE::Go().

◆ GuessSelectionCandidates()

void EE_SELECTION_TOOL::GuessSelectionCandidates	(	EE_COLLECTOR &	collector,
		const VECTOR2I &	aPos
	)

Apply heuristics to try and determine a single object when multiple are found under the cursor.

Definition at line 1061 of file ee_selection_tool.cpp.

References SHAPE_RECT::Collide(), BOX2< Vec >::Contains(), DistanceLinePoint(), SCH_BASE_FRAME::eeconfig(), EuclideanNorm(), SCH_SYMBOL::GetBodyAndPinsBoundingBox(), SCH_SYMBOL::GetBodyBoundingBox(), EDA_ITEM::GetBoundingBox(), BOX2< Vec >::GetCenter(), COLLECTOR::GetCount(), SCH_LINE::GetEndPoint(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetPosition(), SCH_SYMBOL::GetPosition(), EDA_SHAPE::GetShape(), SCH_LINE::GetStartPoint(), SCH_SYMBOL::GetTransform(), TOOL_BASE::getView(), BOX2< Vec >::GetWidth(), EDA_ITEM::HitTest(), BOX2< Vec >::Inflate(), TRANSFORM::InverseTransform(), KiROUND(), m_frame, m_isSymbolEditor, EESCHEMA_SETTINGS::m_Selection, COLLECTOR::m_Threshold, mapCoords(), SCH_JUNCTION_T, SCH_PIN_T, SCH_SYMBOL_T, EESCHEMA_SETTINGS::SELECTION::select_pin_selects_symbol, text, COLLECTOR::Transfer(), and TRANSFORM::TransformCoordinate().

Referenced by SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), narrowSelection(), SCH_EDITOR_CONTROL::SimProbe(), and SCH_EDITOR_CONTROL::SimTune().

◆ hasModifier()

bool SELECTION_TOOL::hasModifier ( )

protectedinherited

True if a selection modifier is enabled, false otherwise.

Definition at line 86 of file selection_tool.cpp.

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

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

◆ highlight()

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

overrideprivatevirtual

Highlight the item visually.

Parameters

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

Implements SELECTION_TOOL.

Definition at line 1904 of file ee_selection_tool.cpp.

References SELECTION::Add(), BRIGHTENED, EDA_ITEM::GetParent(), TOOL_BASE::getView(), KIGFX::VIEW::Hide(), KIGFX::REPAINT, SCH_FIELD_T, SCH_PIN_T, SCH_SHEET_PIN_T, SELECTED, EDA_ITEM::SetBrightened(), EDA_ITEM::SetSelected(), EDA_ITEM::Type(), and KIGFX::VIEW::Update().

Referenced by select().

◆ Init()

bool EE_SELECTION_TOOL::Init ( )

overridevirtual

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

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

Reimplemented from TOOL_BASE.

Definition at line 170 of file ee_selection_tool.cpp.

References CONDITIONAL_MENU::AddItem(), EDA_DRAW_FRAME::AddStandardSubMenus(), EE_ACTIONS::assignNetclass, EE_ACTIONS::breakWire, EE_ACTIONS::clearHighlight, connectedTypes, SELECTION_CONDITIONS::Count(), EE_ACTIONS::drawBus, EE_ACTIONS::drawWire, EE_ACTIONS::editPageNumber, SELECTION_CONDITIONS::Empty(), EE_ACTIONS::enterSheet, EE_ACTIONS::finishBus, EE_ACTIONS::finishWire, SYMBOL_EDIT_FRAME::GetConvert(), SCH_EDIT_FRAME::GetCurrentSheet(), SYMBOL_EDIT_FRAME::GetCurSymbol(), SCH_EDIT_FRAME::GetHighlightedConnection(), TOOL_MENU::GetMenu(), SYMBOL_EDIT_FRAME::GetUnit(), SELECTION_CONDITIONS::HasTypes(), SELECTION_CONDITIONS::Idle(), EE_ACTIONS::importSheetPin, SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), LIB_SYMBOL::IsMulti(), SYMBOL_EDIT_FRAME::IsSymbolAlias(), SYMBOL_EDIT_FRAME::IsSymbolEditable(), SCH_SHEET_PATH::Last(), EE_ACTIONS::leaveSheet, SELECTION_CONDITIONS::LessThan(), m_convert, SELECTION_TOOL::m_disambiguateTimer, m_frame, m_isSymbolEditor, m_isSymbolViewer, TOOL_INTERACTIVE::m_menu, m_unit, SELECTION_CONDITIONS::MoreThan(), SELECTION_TOOL::onDisambiguationExpire(), SELECTION_CONDITIONS::OnlyTypes(), EE_ACTIONS::pinTable, EE_ACTIONS::placeClassLabel, EE_ACTIONS::placeGlobalLabel, EE_ACTIONS::placeHierLabel, EE_ACTIONS::placeJunction, EE_ACTIONS::placeLabel, SCHEMATIC::Root(), SCH_ITEM_LOCATE_BUS_T, SCH_ITEM_LOCATE_GRAPHIC_LINE_T, SCH_ITEM_LOCATE_WIRE_T, SCH_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_EDIT_FRAME::Schematic(), EE_ACTIONS::selectConnection, EE_ACTIONS::selectOnPCB, EE_ACTIONS::setUnitDisplayName, EE_ACTIONS::slice, and EE_ACTIONS::symbolProperties.

◆ IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 31 of file tool_base.cpp.

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

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

◆ Main()

int EE_SELECTION_TOOL::Main ( const TOOL_EVENT & aEvent )

The main loop.

Definition at line 333 of file ee_selection_tool.cpp.

References autostartEvent(), BUT_AUX1, BUT_AUX2, BUT_LEFT, BUT_MIDDLE, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), ClearSelection(), CollectHits(), BOX2< Vec >::Contains(), EE_ACTIONS::drawBus, EE_ACTIONS::drawLines, EE_ACTIONS::drawWire, editor, SCH_BASE_FRAME::eeconfig(), SELECTION::Empty(), EE_ACTIONS::enterSheet, EESCHEMA_SETTINGS::INPUT::esc_clears_net_highlight, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), SELECTION::Front(), EE_SELECTION::GetBoundingBox(), SCH_BASE_FRAME::GetCanvas(), COLLECTOR::GetCount(), TOOLS_HOLDER::GetDragAction(), EDA_DRAW_FRAME::GetItem(), TOOL_MANAGER::GetMousePosition(), GetSelection(), TOOL_MANAGER::GetTool(), SCH_DRAW_PANEL::GetView(), TOOL_BASE::getViewControls(), grid, SELECTION_TOOL::hasModifier(), EE_POINT_EDITOR::HasPoint(), ID_POPUP_SCH_SELECT_UNIT_CMP, ID_POPUP_SCH_SELECT_UNIT_SYM_MAX, ID_POPUP_SCH_UNFOLD_BUS, ID_POPUP_SCH_UNFOLD_BUS_END, BOX2< Vec >::Inflate(), TOOL_MANAGER::InvokeTool(), IS_MOVING, IS_NEW, IS_ROLLOVER, DRAW_SEGMENT_EVENT_PARAMS::layer, LIB_FIELD_T, LIB_PIN_T, LIB_SHAPE_T, LIB_TEXT_T, LIB_TEXTBOX_T, SELECTION_TOOL::m_additive, SELECTION_TOOL::m_disambiguateTimer, SELECTION_TOOL::m_exclusive_or, m_frame, EESCHEMA_SETTINGS::m_Input, m_isSymbolEditor, TOOL_INTERACTIVE::m_menu, m_nonModifiedCursor, SELECTION_TOOL::m_originalCursor, m_selection, SELECTION_TOOL::m_subtractive, TOOL_BASE::m_toolMgr, TOOL_ACTION::MakeEvent(), MD_ALT, MD_CTRL, MD_SHIFT, EE_COLLECTOR::MovableItems, narrowSelection(), EE_ACTIONS::navigateBack, EE_ACTIONS::navigateForward, niluuid, TOOL_MANAGER::ProcessEvent(), EE_ACTIONS::properties, DRAW_SEGMENT_EVENT_PARAMS::quitOnDraw, RequestSelection(), TOOL_MANAGER::RunAction(), SCH_FIELD_T, SCH_SHEET_T, selectionContains(), selectMultiple(), SelectPoint(), selectPoint(), KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), SELECTION::SetIsHover(), SELECTION_TOOL::setModifiersState(), TOOL_MENU::ShowContextMenu(), DRAW_SEGMENT_EVENT_PARAMS::sourceSegment, TA_CHOICE_MENU_CHOICE, TA_UNDO_REDO_PRE, TC_COMMAND, TOOLS_HOLDER::ToolStackIsEmpty(), EDA_ITEM::Type(), EE_ACTIONS::unfoldBus, KIGFX::VIEW::Update(), TOOL_INTERACTIVE::Wait(), ACTIONS::zoomFitObjects, and ACTIONS::zoomFitScreen.

Referenced by setTransitions().

◆ narrowSelection()

void EE_SELECTION_TOOL::narrowSelection	(	EE_COLLECTOR &	collector,
		const VECTOR2I &	aWhere,
		bool	aCheckLocked,
		bool	aSelectedOnly = `false`
	)

private

Apply rules to narrow the collection down to selectable objects, and then heuristics to try and narrow it to a single object.

Parameters

aCollector	[in, out] Provides collection conditions and stores collected items.
aWhere	point where we should narrow (if relevant)
aCheckLocked	If false, remove locked elements from #collector
aSelectedOnly	If true, remove non-selected items from #collector

Definition at line 858 of file ee_selection_tool.cpp.

References COLLECTOR::GetCount(), GuessSelectionCandidates(), SELECTION_TOOL::m_skip_heuristics, COLLECTOR::Remove(), and Selectable().

Referenced by Main(), and SelectPoint().

◆ onDisambiguationExpire()

void SELECTION_TOOL::onDisambiguationExpire ( wxTimerEvent & aEvent )

protectedinherited

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

Parameters

aEvent

Definition at line 219 of file selection_tool.cpp.

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

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

◆ OnIdle()

void EE_SELECTION_TOOL::OnIdle ( wxIdleEvent & aEvent )

Zoom the screen to fit the bounding box for cross probing/selection sync.

Definition at line 789 of file ee_selection_tool.cpp.

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

Referenced by SCH_BASE_FRAME::SCH_BASE_FRAME().

◆ RebuildSelection()

void EE_SELECTION_TOOL::RebuildSelection ( )

Rebuild the selection from the EDA_ITEMs' selection flags.

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

Definition at line 1754 of file ee_selection_tool.cpp.

References SELECTION::Clear(), LIB_SYMBOL::GetDrawItems(), SCH_BASE_FRAME::GetScreen(), EDA_ITEM::IsSelected(), SCH_SCREEN::Items(), m_frame, m_isSymbolEditor, m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), select(), EVENTS::SelectedEvent, and updateReferencePoint().

Referenced by SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Redo(), SCHEMATIC_COMMIT::Revert(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), and SYMBOL_EDITOR_EDIT_TOOL::Undo().

◆ RemoveItemFromSel() [1/2]

int SELECTION_TOOL::RemoveItemFromSel ( const TOOL_EVENT & aEvent )

inherited

Definition at line 150 of file selection_tool.cpp.

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

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

◆ RemoveItemFromSel() [2/2]

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

inherited

Definition at line 158 of file selection_tool.cpp.

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

◆ RemoveItemsFromSel() [1/3]

int SELECTION_TOOL::RemoveItemsFromSel ( const TOOL_EVENT & aEvent )

inherited

Definition at line 171 of file selection_tool.cpp.

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

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

◆ RemoveItemsFromSel() [2/3]

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

inherited

Definition at line 179 of file selection_tool.cpp.

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

◆ RemoveItemsFromSel() [3/3]

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

inherited

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

Definition at line 193 of file selection_tool.cpp.

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

◆ RequestSelection()

EE_SELECTION & EE_SELECTION_TOOL::RequestSelection ( const std::vector< KICAD_T > & aScanTypes = { SCH_LOCATE_ANY_T } )

Return either an existing selection (filtered), or the selection at the current cursor position if the existing selection is empty.

Parameters

aScanTypes [optional] List of item types that are acceptable for selection.

Returns: either the current selection or, if empty, the selection at the cursor.

Definition at line 1217 of file ee_selection_tool.cpp.

References SELECTION::ClearReferencePoint(), ClearSelection(), SELECTION::Empty(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), SELECTION::GetItem(), SELECTION::GetSize(), TOOL_BASE::getViewControls(), EDA_ITEM::IsType(), m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SelectPoint(), SELECTION::SetIsHover(), unselect(), EVENTS::UnselectedEvent, and updateReferencePoint().

Referenced by SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::BreakWire(), SCH_EDIT_TOOL::ChangeSymbols(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::CheckAnnotate(), SCH_EDIT_TOOL::CleanupSheetPins(), SCH_EDIT_TOOL::ConvertDeMorgan(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), SCH_EDIT_FRAME::DeleteAnnotation(), EE_INSPECTION_TOOL::DiffSymbol(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), SCH_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::EditPageNumber(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_NAVIGATE_TOOL::EnterSheet(), Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), SelectConnection(), SCH_EDIT_TOOL::SetAttribute(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_EDIT_TOOL::Swap(), SCH_EDIT_TOOL::ToggleAttribute(), SCH_EDIT_TOOL::UnsetAttribute(), and BUS_UNFOLD_MENU::update().

◆ Reset()

void EE_SELECTION_TOOL::Reset ( RESET_REASON aReason )

overridevirtual

Bring the tool to a known, initial state.

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

Parameters

aReason contains information about the reason of tool reset.

Implements TOOL_BASE.

Definition at line 297 of file ee_selection_tool.cpp.

References KIGFX::VIEW::Add(), SELECTION::Clear(), SYMBOL_EDIT_FRAME::GetConvert(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), SYMBOL_EDIT_FRAME::GetUnit(), TOOL_BASE::getView(), m_convert, m_frame, m_isSymbolEditor, m_isSymbolViewer, m_selection, m_unit, TOOL_BASE::MODEL_RELOAD, TOOL_BASE::REDRAW, KIGFX::VIEW::Remove(), KIGFX::RENDER_SETTINGS::SetHighlight(), and TOOL_BASE::SUPERMODEL_RELOAD.

◆ resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

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

Definition at line 63 of file tool_interactive.cpp.

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

◆ RunMainStack()

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

inherited

Call a function using the main stack.

Parameters

aFunc is the function to be calls.

Definition at line 87 of file tool_interactive.cpp.

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

Referenced by DRAWING_TOOL::PlaceText().

◆ select()

void EE_SELECTION_TOOL::select ( EDA_ITEM * aItem )

overrideprivatevirtual

Take necessary action to mark an item as selected.

Parameters

aItem The item to be selected.

Implements SELECTION_TOOL.

Definition at line 1892 of file ee_selection_tool.cpp.

References highlight(), m_selection, and SELECTED.

Referenced by RebuildSelection(), SelectAll(), SelectConnection(), selectMultiple(), selectPoint(), and SyncSelection().

◆ Selectable()

bool EE_SELECTION_TOOL::Selectable	(	const EDA_ITEM *	aItem,
		const VECTOR2I *	aPos = `nullptr`,
		bool	checkVisibilityOnly = `false`
	)		const

Check conditions for an item to be selected.

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

Definition at line 1796 of file ee_selection_tool.cpp.

References SCH_BASE_FRAME::eeconfig(), LIB_ITEM::GetConvert(), SYMBOL_EDIT_FRAME::GetConvert(), SCH_BASE_FRAME::GetShowAllPins(), LIB_ITEM::GetUnit(), SYMBOL_EDIT_FRAME::GetUnit(), grid, SYMBOL_EDIT_FRAME::IsSymbolAlias(), LAYER_CONNECTABLE, LIB_FIELD_T, LIB_PIN_T, LIB_SHAPE_T, LIB_SYMBOL_T, LIB_TEXT_T, EESCHEMA_SETTINGS::m_Appearance, m_frame, EESCHEMA_SETTINGS::m_Selection, TOOL_BASE::m_toolMgr, pin, SCH_DIRECTIVE_LABEL_T, SCH_MARKER_T, SCH_PIN_T, EESCHEMA_SETTINGS::SELECTION::select_pin_selects_symbol, EESCHEMA_SETTINGS::APPEARANCE::show_directive_labels, and EDA_ITEM::Type().

Referenced by SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), narrowSelection(), SelectAll(), and selectMultiple().

◆ SelectAll()

int EE_SELECTION_TOOL::SelectAll ( const TOOL_EVENT & aEvent )

Definition at line 1008 of file ee_selection_tool.cpp.

References ENDPOINT, SCH_SHEET::GetPins(), TOOL_BASE::getView(), SELECTION_TOOL::m_multiple, TOOL_BASE::m_toolMgr, pin, TOOL_MANAGER::ProcessEvent(), KIGFX::VIEW::Query(), SCH_LINE_T, select(), Selectable(), EVENTS::SelectedEvent, EDA_ITEM::SetFlags(), BOX2< Vec >::SetMaximum(), and STARTPOINT.

Referenced by setTransitions().

◆ SelectConnection()

int EE_SELECTION_TOOL::SelectConnection ( const TOOL_EVENT & aEvent )

If a connected item is selected then expand the selection to the entire connection, otherwise select connection under the current cursor position.

Clear current selection event handler.

Definition at line 1556 of file ee_selection_tool.cpp.

References SCH_SCREEN::ClearDrawingState(), SELECTION::Empty(), SELECTION::Front(), SCH_BASE_FRAME::GetScreen(), SELECTION::GetSize(), m_frame, m_selection, TOOL_BASE::m_toolMgr, SCH_SCREEN::MarkConnections(), TOOL_MANAGER::ProcessEvent(), RequestSelection(), SCH_ITEM_LOCATE_BUS_T, SCH_ITEM_LOCATE_WIRE_T, select(), and EVENTS::SelectedEvent.

Referenced by setTransitions().

◆ selection()

SELECTION & EE_SELECTION_TOOL::selection ( )

inlineoverrideprotectedvirtual

Return a reference to the selection.

Implements SELECTION_TOOL.

Definition at line 183 of file ee_selection_tool.h.

References m_selection.

◆ selectionContains()

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

private

Set up handlers for various events.

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

Definition at line 1993 of file ee_selection_tool.cpp.

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

Referenced by Main().

◆ SelectionMenu()

int SELECTION_TOOL::SelectionMenu ( const TOOL_EVENT & aEvent )

inherited

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

Note: This routine does not modify the selection.

Definition at line 234 of file selection_tool.cpp.

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

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

◆ selectMultiple()

bool EE_SELECTION_TOOL::selectMultiple ( )

private

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

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

Definition at line 1285 of file ee_selection_tool.cpp.

Referenced by Main().

◆ SelectNode()

int EE_SELECTION_TOOL::SelectNode ( const TOOL_EVENT & aEvent )

Selects the connected item at the current cursor position.

Iterative process with a decreasing slop factor.

Definition at line 1546 of file ee_selection_tool.cpp.

References connectedTypes, KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_BASE::getViewControls(), and SelectPoint().

Referenced by setTransitions().

◆ SelectPoint()

bool EE_SELECTION_TOOL::SelectPoint	(	const VECTOR2I &	aWhere,
		const std::vector< KICAD_T > &	aScanTypes = `{ SCH_LOCATE_ANY_T }`,
		EDA_ITEM **	aItem = `nullptr`,
		bool *	aSelectionCancelledFlag = `nullptr`,
		bool	aCheckLocked = `false`,
		bool	aAdd = `false`,
		bool	aSubtract = `false`,
		bool	aExclusiveOr = `false`
	)

Perform a click-type selection at a point (usually the cursor position).

Parameters

aWhere	Point from which the selection should be made.
aScanTypes	[optional] List of item types that are acceptable for selection.
aItem	[out, optional] The newly selected item if only one was selected, otherwise unchanged.
aSelectionCancelledFlag	[out] Allows the function to inform its caller that a selection was canceled (for instance, by clicking outside of the disambiguation menu).
aCheckLocked	Indicates if locked items should be excluded.
aAdd	Indicates if found item(s) should be added to the selection.
aSubtract	Indicates if found item(s) should be subtracted from the selection.
aExclusiveOr	Indicates if found item(s) should be toggle in the selection.

Returns: true if the selection was modified.

Definition at line 990 of file ee_selection_tool.cpp.

References CollectHits(), narrowSelection(), and selectPoint().

Referenced by disambiguateCursor(), Main(), RequestSelection(), SelectNode(), SCH_EDITOR_CONTROL::SimTune(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ selectPoint()

bool EE_SELECTION_TOOL::selectPoint	(	EE_COLLECTOR &	aCollector,
		const VECTOR2I &	aWhere,
		EDA_ITEM **	aItem = `nullptr`,
		bool *	aSelectionCancelledFlag = `nullptr`,
		bool	aAdd = `false`,
		bool	aSubtract = `false`,
		bool	aExclusiveOr = `false`
	)

private

Perform a click-type selection at a point (usually the cursor position).

Parameters

aCollector	[in, out] Provides collection conditions and stores collected items.
aWhere	Point from which the selection should be made.
aItem	[out, optional] The newly selected item if only one was selected, otherwise unchanged.
aSelectionCancelledFlag	[out] Allows the function to inform its caller that a selection was canceled (for instance, by clicking outside of the disambiguation menu).
aAdd	Indicates if found item(s) should be added to the selection.
aSubtract	Indicates if found item(s) should be subtracted from the selection.
aExclusiveOr	Indicates if found item(s) should be toggle in the selection.

Returns: true if the selection was modified.

Definition at line 888 of file ee_selection_tool.cpp.

References SELECTION::ClearReferencePoint(), ClearSelection(), SELECTION_TOOL::doSelectionMenu(), ENDPOINT, COLLECTOR::GetCount(), SCH_LINE::GetEndPoint(), SCH_LINE::GetStartPoint(), TOOL_BASE::getView(), HitTestPoints(), COLLECTOR::m_MenuCancelled, m_selection, COLLECTOR::m_Threshold, TOOL_BASE::m_toolMgr, EVENTS::PointSelectedEvent, TOOL_MANAGER::ProcessEvent(), TOOL_MANAGER::RunAction(), SCH_LINE_T, select(), EVENTS::SelectedEvent, EE_ACTIONS::selectionMenu, STARTPOINT, unselect(), EVENTS::UnselectedEvent, and KIGFX::VIEW::Update().

Referenced by Main(), and SelectPoint().

◆ SetContextMenu()

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

inherited

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

Parameters

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

Definition at line 76 of file tool_interactive.cpp.

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

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

◆ setModifiersState()

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

protectedinherited

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

Definition at line 48 of file selection_tool.cpp.

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

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

◆ setTransitions()

void EE_SELECTION_TOOL::setTransitions ( )

overrideprivatevirtual

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

It is called every time tool is reset or finished.

Implements TOOL_INTERACTIVE.

Definition at line 2012 of file ee_selection_tool.cpp.

References EE_ACTIONS::addItemsToSel, SELECTION_TOOL::AddItemsToSel(), EE_ACTIONS::addItemToSel, SELECTION_TOOL::AddItemToSel(), EE_ACTIONS::clearSelection, ClearSelection(), disambiguateCursor(), EVENTS::DisambiguatePoint, TOOL_INTERACTIVE::Go(), Main(), EE_ACTIONS::removeItemFromSel, SELECTION_TOOL::RemoveItemFromSel(), EE_ACTIONS::removeItemsFromSel, SELECTION_TOOL::RemoveItemsFromSel(), SelectAll(), ACTIONS::selectAll, EE_ACTIONS::selectConnection, SelectConnection(), EE_ACTIONS::selectionActivate, EE_ACTIONS::selectionMenu, SELECTION_TOOL::SelectionMenu(), EE_ACTIONS::selectNode, SelectNode(), ACTIONS::updateMenu, and SELECTION_TOOL::UpdateMenu().

◆ SyncSelection()

int EE_SELECTION_TOOL::SyncSelection	(	std::optional< SCH_SHEET_PATH >	targetSheetPath,
		SCH_ITEM *	focusItem,
		std::vector< SCH_ITEM * >	items
	)

◆ UnbrightenItem()

void SELECTION_TOOL::UnbrightenItem ( EDA_ITEM * aItem )

inherited

Definition at line 213 of file selection_tool.cpp.

References BRIGHTENED, and SELECTION_TOOL::unhighlight().

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

◆ unhighlight()

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

overrideprivatevirtual

Unhighlight the item visually.

Parameters

aItem	is an item to be highlighted.
aHighlightMode	should be either SELECTED or BRIGHTENED
aGroup	[optional] A group to remove the item from.

Implements SELECTION_TOOL.

Definition at line 1945 of file ee_selection_tool.cpp.

References BRIGHTENED, EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearFlags(), EDA_ITEM::ClearSelected(), ENDPOINT, EDA_ITEM::GetParent(), TOOL_BASE::getView(), KIGFX::VIEW::Hide(), SELECTION::Remove(), KIGFX::REPAINT, SCH_FIELD_T, SCH_LINE_T, SCH_PIN_T, SCH_SHEET_PIN_T, SELECTED, STARTPOINT, EDA_ITEM::Type(), and KIGFX::VIEW::Update().

Referenced by ClearSelection(), and unselect().

◆ unselect()

void EE_SELECTION_TOOL::unselect ( EDA_ITEM * aItem )

overrideprivatevirtual

Take necessary action to mark an item as unselected.

Parameters

aItem The item to be unselected.

Implements SELECTION_TOOL.

Definition at line 1898 of file ee_selection_tool.cpp.

References m_selection, SELECTED, and unhighlight().

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

◆ UpdateMenu()

int SELECTION_TOOL::UpdateMenu ( const TOOL_EVENT & aEvent )

inherited

Update a menu's state based on the current selection.

The menu is passed in aEvent's parameter.

Definition at line 92 of file selection_tool.cpp.

References CONDITIONAL_MENU::Evaluate(), TOOL_EVENT::Parameter(), SELECTION_TOOL::selection(), and ACTION_MENU::UpdateAll().

Referenced by setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), PL_SELECTION_TOOL::setTransitions(), and PCB_SELECTION_TOOL::setTransitions().

◆ updateReferencePoint()

void EE_SELECTION_TOOL::updateReferencePoint ( )

private

Set the reference point to the anchor of the top-left item.

Definition at line 1256 of file ee_selection_tool.cpp.

References EE_SELECTION::GetTopLeftItem(), m_isSymbolEditor, m_selection, SELECTION::SetReferencePoint(), and SELECTION::Size().

Referenced by RebuildSelection(), and RequestSelection().

◆ Wait()

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

inherited

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

No parameters means waiting for any event.

Definition at line 57 of file tool_interactive.cpp.

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

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_POINT_EDITOR::Main(), Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ZOOM_TOOL::selectRegion(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ ZoomFitCrossProbeBBox()

void EE_SELECTION_TOOL::ZoomFitCrossProbeBBox ( const BOX2I & aBBox )

Definition at line 1603 of file ee_selection_tool.cpp.

References DEFAULT_TEXT_SIZE, BOX2< Vec >::GetSize(), TOOL_BASE::getView(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), BOX2< Vec >::Inflate(), EDA_IU_SCALE::MilsToIU(), next(), BOX2< Vec >::Normalize(), schIUScale, KIGFX::VIEW::SetScale(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SyncSelection().

Member Data Documentation

◆ m_additive

bool SELECTION_TOOL::m_additive

protectedinherited

Definition at line 132 of file selection_tool.h.

Referenced by disambiguateCursor(), SELECTION_TOOL::hasModifier(), Main(), PL_SELECTION_TOOL::Main(), OnIdle(), PCB_SELECTION_TOOL::OnIdle(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), and SELECTION_TOOL::setModifiersState().

◆ m_canceledMenu

bool SELECTION_TOOL::m_canceledMenu

protectedinherited

Definition at line 143 of file selection_tool.h.

Referenced by disambiguateCursor(), PL_SELECTION_TOOL::disambiguateCursor(), PCB_SELECTION_TOOL::disambiguateCursor(), and PCB_SELECTION_TOOL::Main().

◆ m_convert

int EE_SELECTION_TOOL::m_convert

private

Definition at line 286 of file ee_selection_tool.h.

Referenced by CollectHits(), Init(), and Reset().

◆ m_disambiguateTimer

wxTimer SELECTION_TOOL::m_disambiguateTimer

protectedinherited

Definition at line 145 of file selection_tool.h.

Referenced by Init(), PL_SELECTION_TOOL::Init(), PCB_SELECTION_TOOL::Init(), Main(), PL_SELECTION_TOOL::Main(), and PCB_SELECTION_TOOL::Main().

◆ m_drag_additive

bool SELECTION_TOOL::m_drag_additive

protectedinherited

Definition at line 140 of file selection_tool.h.

Referenced by selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), and SELECTION_TOOL::setModifiersState().

◆ m_drag_subtractive

bool SELECTION_TOOL::m_drag_subtractive

protectedinherited

Definition at line 141 of file selection_tool.h.

Referenced by selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), and SELECTION_TOOL::setModifiersState().

◆ m_exclusive_or

bool SELECTION_TOOL::m_exclusive_or

protectedinherited

Definition at line 134 of file selection_tool.h.

Referenced by disambiguateCursor(), SELECTION_TOOL::hasModifier(), Main(), PL_SELECTION_TOOL::Main(), OnIdle(), PCB_SELECTION_TOOL::OnIdle(), selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), and SELECTION_TOOL::setModifiersState().

◆ m_frame

SCH_BASE_FRAME* EE_SELECTION_TOOL::m_frame

private

Definition at line 278 of file ee_selection_tool.h.

Referenced by autostartEvent(), CollectHits(), GetNode(), GuessSelectionCandidates(), Init(), Main(), OnIdle(), RebuildSelection(), Reset(), Selectable(), SelectConnection(), selectMultiple(), and SyncSelection().

◆ m_highlight_modifier

bool SELECTION_TOOL::m_highlight_modifier

protectedinherited

Definition at line 139 of file selection_tool.h.

Referenced by PCB_SELECTION_TOOL::Main(), and SELECTION_TOOL::setModifiersState().

◆ m_isSymbolEditor

bool EE_SELECTION_TOOL::m_isSymbolEditor

private

Definition at line 283 of file ee_selection_tool.h.

Referenced by CollectHits(), GuessSelectionCandidates(), Init(), Main(), RebuildSelection(), Reset(), SyncSelection(), and updateReferencePoint().

◆ m_isSymbolViewer

bool EE_SELECTION_TOOL::m_isSymbolViewer

private

Definition at line 284 of file ee_selection_tool.h.

Referenced by Init(), Reset(), and SyncSelection().

◆ m_menu

TOOL_MENU TOOL_INTERACTIVE::m_menu

protectedinherited

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

Definition at line 125 of file tool_interactive.h.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), TOOL_INTERACTIVE::GetToolMenu(), EDA_3D_CONTROLLER::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), Init(), EE_TOOL_BASE< T >::Init(), SCH_DRAWING_TOOLS::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), GERBVIEW_SELECTION_TOOL::Init(), PICKER_TOOL::Init(), ZOOM_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), LENGTH_TUNER_TOOL::Init(), ROUTER_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), DRAWING_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), PAD_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_TOOL_BASE::Init(), PCB_VIEWER_TOOLS::Init(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDA_3D_CONTROLLER::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ m_multiple

bool SELECTION_TOOL::m_multiple

protectedinherited

Definition at line 135 of file selection_tool.h.

Referenced by OnIdle(), PCB_SELECTION_TOOL::OnIdle(), SelectAll(), selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), and PCB_SELECTION_TOOL::selectMultiple().

◆ m_nonModifiedCursor

KICURSOR EE_SELECTION_TOOL::m_nonModifiedCursor

private

Definition at line 281 of file ee_selection_tool.h.

Referenced by Main(), and OnIdle().

◆ m_originalCursor

VECTOR2I SELECTION_TOOL::m_originalCursor

protectedinherited

Definition at line 147 of file selection_tool.h.

Referenced by disambiguateCursor(), PL_SELECTION_TOOL::disambiguateCursor(), PCB_SELECTION_TOOL::disambiguateCursor(), Main(), PL_SELECTION_TOOL::Main(), and PCB_SELECTION_TOOL::Main().

◆ m_selection

EE_SELECTION EE_SELECTION_TOOL::m_selection

private

Definition at line 279 of file ee_selection_tool.h.

Referenced by ClearSelection(), EE_SELECTION_TOOL(), GetSelection(), Main(), RebuildSelection(), RequestSelection(), Reset(), select(), SelectConnection(), selection(), selectionContains(), selectMultiple(), selectPoint(), SyncSelection(), unselect(), updateReferencePoint(), and ~EE_SELECTION_TOOL().

◆ m_skip_heuristics

bool SELECTION_TOOL::m_skip_heuristics

protectedinherited

Definition at line 136 of file selection_tool.h.

Referenced by disambiguateCursor(), PL_SELECTION_TOOL::disambiguateCursor(), PCB_SELECTION_TOOL::disambiguateCursor(), narrowSelection(), PCB_SELECTION_TOOL::Selectable(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), and SELECTION_TOOL::setModifiersState().

◆ m_subtractive

bool SELECTION_TOOL::m_subtractive

protectedinherited

Definition at line 133 of file selection_tool.h.

Referenced by disambiguateCursor(), SELECTION_TOOL::hasModifier(), Main(), PL_SELECTION_TOOL::Main(), OnIdle(), PCB_SELECTION_TOOL::OnIdle(), selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), and SELECTION_TOOL::setModifiersState().

◆ m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Name of the tool.

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

Definition at line 211 of file tool_base.h.

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

◆ m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 216 of file tool_base.h.

◆ m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Definition at line 215 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

◆ m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

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

Definition at line 208 of file tool_base.h.

Referenced by TOOL_BASE::GetType(), and SCHEMATIC_COMMIT::pushLibEdit().

◆ m_unit

int EE_SELECTION_TOOL::m_unit

private

Definition at line 285 of file ee_selection_tool.h.

Referenced by CollectHits(), Init(), and Reset().

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ RESET_REASON

Constructor & Destructor Documentation

◆ EE_SELECTION_TOOL()

◆ ~EE_SELECTION_TOOL()

Member Function Documentation

◆ Activate()

◆ AddItemsToSel() [1/2]

◆ AddItemsToSel() [2/2]

◆ AddItemToSel() [1/2]

◆ AddItemToSel() [2/2]

◆ attachManager()

◆ autostartEvent()

◆ BrightenItem()

◆ ClearSelection() [1/2]

◆ ClearSelection() [2/2]

◆ CollectHits()

◆ ctrlClickHighlights()

◆ disambiguateCursor()

◆ doSelectionMenu()

◆ getEditFrame()

◆ GetId()

◆ GetManager()

◆ getModel()

◆ getModelInt()

◆ GetName()

◆ GetNode()

◆ GetSelection()

◆ getToolHolderInt()

◆ GetToolMenu()

◆ GetType()

◆ getView()

◆ getViewControls()

◆ Go()

◆ goInternal()

◆ GuessSelectionCandidates()

◆ hasModifier()

◆ highlight()

◆ Init()

◆ IsToolActive()

◆ Main()

◆ narrowSelection()

◆ onDisambiguationExpire()

◆ OnIdle()

◆ RebuildSelection()

◆ RemoveItemFromSel() [1/2]

◆ RemoveItemFromSel() [2/2]

◆ RemoveItemsFromSel() [1/3]

◆ RemoveItemsFromSel() [2/3]

◆ RemoveItemsFromSel() [3/3]

◆ RequestSelection()

◆ Reset()

◆ resetTransitions()

◆ RunMainStack()

◆ select()

◆ Selectable()

◆ SelectAll()

◆ SelectConnection()

◆ selection()

◆ selectionContains()

◆ SelectionMenu()

◆ selectMultiple()

◆ SelectNode()

◆ SelectPoint()

◆ selectPoint()

◆ SetContextMenu()

◆ setModifiersState()

◆ setTransitions()

◆ SyncSelection()

◆ UnbrightenItem()

◆ unhighlight()

◆ unselect()

◆ UpdateMenu()