EE_SELECTION_TOOL Class Reference

#include <ee_selection_tool.h>

Inheritance diagram for EE_SELECTION_TOOL:

Public Types
enum	RESET_REASON { RUN , MODEL_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 (required full reload)
GAL_SWITCH	Rendering engine changes.
REDRAW	Full drawing refresh.

Definition at line 77 of file tool_base.h.

 {
 RUN, 
 MODEL_RELOAD, 
 GAL_SWITCH, 
 REDRAW 
 };

Constructor & Destructor Documentation

EE_SELECTION_TOOL()

EE_SELECTION_TOOL::EE_SELECTION_TOOL

(

)

Definition at line 131 of file ee_selection_tool.cpp.

 :
 SELECTION_TOOL( "eeschema.InteractiveSelection" ),
 m_frame( nullptr ),
 m_nonModifiedCursor( KICURSOR::ARROW ),
 m_isSymbolEditor( false ),
 m_isSymbolViewer( false ),
 m_unit( 0 ),
 m_convert( 0 )
{
 m_selection.Clear();
}

References ARROW, SELECTION::Clear(), and m_selection.

~EE_SELECTION_TOOL()

EE_SELECTION_TOOL::~EE_SELECTION_TOOL

(

)

Definition at line 144 of file ee_selection_tool.cpp.

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

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.

{
 m_toolMgr->InvokeTool( m_toolId );
}

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

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

AddItemsToSel() [1/2]

int SELECTION_TOOL::AddItemsToSel ( const TOOL_EVENT &  aEvent )

inherited

Definition at line 128 of file selection_tool.cpp.

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

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

Referenced by SELECTION_TOOL::AddItemsToSel(), 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.

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

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

AddItemToSel() [1/2]

int SELECTION_TOOL::AddItemToSel ( const TOOL_EVENT &  aEvent )

inherited

Definition at line 107 of file selection_tool.cpp.

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

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

Referenced by SELECTION_TOOL::AddItemToSel(), SCH_EDIT_TOOL::BreakWire(), SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EDIT_TOOL::doMoveSelection(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), EDIT_TOOL::FilletTracks(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), DIALOG_INSPECTOR::onCellClicked(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), 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.

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

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

attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER *  aManager )

protectedinherited

Set the TOOL_MANAGER the tool will belong to.

Called by TOOL_MANAGER::RegisterTool()

Definition at line 60 of file tool_base.cpp.

{
 m_toolMgr = aManager;
}

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

autostartEvent()

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

private

Definition at line 703 of file ee_selection_tool.cpp.

{
 VECTOR2I pos = aGrid.BestSnapAnchor( aEvent->Position(), LAYER_CONNECTABLE );
 
 if( m_frame->eeconfig()->m_Drawing.auto_start_wires
 && !m_toolMgr->GetTool<EE_POINT_EDITOR>()->HasPoint()
 && aItem->IsPointClickableAnchor( pos ) )
 {
 OPT_TOOL_EVENT newEvt = EE_ACTIONS::drawWire.MakeEvent();
 
 if( aItem->Type() == SCH_BUS_BUS_ENTRY_T )
 {
 newEvt = EE_ACTIONS::drawBus.MakeEvent();
 }
 else if( aItem->Type() == SCH_BUS_WIRE_ENTRY_T )
 {
 SCH_BUS_WIRE_ENTRY* busEntry = static_cast<SCH_BUS_WIRE_ENTRY*>( aItem );
 
 if( !busEntry->m_connected_bus_item )
 newEvt = EE_ACTIONS::drawBus.MakeEvent();
 }
 else if( aItem->Type() == SCH_LINE_T )
 {
 SCH_LINE* line = static_cast<SCH_LINE*>( aItem );
 
 if( line->IsBus() )
 newEvt = EE_ACTIONS::drawBus.MakeEvent();
 else if( line->IsGraphicLine() )
 newEvt = EE_ACTIONS::drawLines.MakeEvent();
 }
 else if( aItem->Type() == SCH_LABEL_T || aItem->Type() == SCH_HIER_LABEL_T
 || aItem->Type() == SCH_SHEET_PIN_T )
 {
 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( aItem );
 SCH_CONNECTION possibleConnection( label->Schematic()->ConnectionGraph() );
 possibleConnection.ConfigureFromLabel( label->GetText() );
 
 if( possibleConnection.IsBus() )
 newEvt = EE_ACTIONS::drawBus.MakeEvent();
 }
 
 newEvt->SetMousePosition( pos );
 newEvt->SetHasPosition( true );
 newEvt->SetForceImmediate( true );
 
 getViewControls()->ForceCursorPosition( true, pos );
 
 return newEvt;
 }
 
 return OPT_TOOL_EVENT();
}

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.

{
 highlight( aItem, BRIGHTENED );
}

References BRIGHTENED, and SELECTION_TOOL::highlight().

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

ClearSelection() [1/2]

void EE_SELECTION_TOOL::ClearSelection

(

bool

aQuietMode = false

)

Definition at line 1852 of file ee_selection_tool.cpp.

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

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 1580 of file ee_selection_tool.cpp.

{
 ClearSelection();
 
 return 0;
}

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(), Reset(), selectMultiple(), selectPoint(), setTransitions(), SyncSelection(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

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 801 of file ee_selection_tool.cpp.

{
 int pixelThreshold = KiROUND( getView()->ToWorld( HITTEST_THRESHOLD_PIXELS ) );
 int gridThreshold = KiROUND( getView()->GetGAL()->GetGridSize().EuclideanNorm() / 2 );
 aCollector.m_Threshold = std::max( pixelThreshold, gridThreshold );
 aCollector.m_ShowPinElectricalTypes = m_frame->GetRenderSettings()->m_ShowPinsElectricalType;
 
 if( m_isSymbolEditor )
 {
 LIB_SYMBOL* symbol = static_cast<SYMBOL_EDIT_FRAME*>( m_frame )->GetCurSymbol();
 
 if( !symbol )
 return false;
 
 aCollector.Collect( symbol->GetDrawItems(), aScanTypes, aWhere, m_unit, m_convert );
 }
 else
 {
 aCollector.Collect( m_frame->GetScreen(), aScanTypes, aWhere, m_unit, m_convert );
 
 if( m_frame->eeconfig()->m_Selection.select_pin_selects_symbol )
 {
 int originalCount = aCollector.GetCount();
 
 for( int ii = 0; ii < originalCount; ++ii )
 {
 if( aCollector[ii]->Type() == SCH_PIN_T )
 {
 SCH_PIN* pin = static_cast<SCH_PIN*>( aCollector[ii] );
 
 if( !aCollector.HasItem( pin->GetParentSymbol() ) )
 aCollector.Append( pin->GetParentSymbol() );
 }
 }
 }
 }
 
 return aCollector.GetCount() > 0;
}

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.

{ return false; }

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 758 of file ee_selection_tool.cpp.

{
 wxMouseState keyboardState = wxGetMouseState();
 
 setModifiersState( keyboardState.ShiftDown(), keyboardState.ControlDown(),
 keyboardState.AltDown() );
 
 m_skip_heuristics = true;
 SelectPoint( m_originalCursor, { SCH_LOCATE_ANY_T }, nullptr, &m_canceledMenu, false,
 m_additive, m_subtractive, m_exclusive_or );
 m_skip_heuristics = false;
 
 return 0;
}

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.

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

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

Referenced by SELECTION_TOOL::SelectionMenu(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), 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 185 of file tool_base.h.

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

References TOOL_BASE::getToolHolderInt().

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

GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Return the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns

Identifier of the tool.

Definition at line 121 of file tool_base.h.

 {
 return m_toolId;
 }

References TOOL_BASE::m_toolId.

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

GetManager()

TOOL_MANAGER * TOOL_BASE::GetManager ( ) const

inlineinherited

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

Returns

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

Definition at line 144 of file tool_base.h.

 {
 return m_toolMgr;
 }

References TOOL_BASE::m_toolMgr.

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

getModel()

template<typename T >

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Store the type of the tool.

Definition at line 197 of file tool_base.h.

References TOOL_BASE::getModelInt().

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

getModelInt()

EDA_ITEM * TOOL_BASE::getModelInt ( ) const

privateinherited

Definition at line 54 of file tool_base.cpp.

{
 return m_toolMgr->GetModel();
}

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

Referenced by TOOL_BASE::getModel().

GetName()

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

inlineinherited

Return the name of the tool.

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

Returns

The name of the tool.

Definition at line 134 of file tool_base.h.

 {
 return m_toolName;
 }

References TOOL_BASE::m_toolName.

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

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 1509 of file ee_selection_tool.cpp.

{
 EE_COLLECTOR collector;
 
 //TODO(snh): Reimplement after exposing KNN interface
 int pixelThreshold = KiROUND( getView()->ToWorld( HITTEST_THRESHOLD_PIXELS ) );
 int gridThreshold = KiROUND( getView()->GetGAL()->GetGridSize().EuclideanNorm() );
 int thresholdMax = std::max( pixelThreshold, gridThreshold );
 
 for( int threshold : { 0, thresholdMax/4, thresholdMax/2, thresholdMax } )
 {
 collector.m_Threshold = threshold;
 collector.Collect( m_frame->GetScreen(), connectedTypes, aPosition );
 
 if( collector.GetCount() > 0 )
 break;
 }
 
 return collector.GetCount() ? collector[ 0 ] : nullptr;
}

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

GetSelection()

EE_SELECTION & EE_SELECTION_TOOL::GetSelection

(

)

Returns

the set of currently selected items.

Definition at line 795 of file ee_selection_tool.cpp.

{
 return m_selection;
}

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::FindNext(), SYMBOL_EDIT_FRAME::HardRedraw(), SCH_FIND_REPLACE_TOOL::HasMatch(), 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_FIND_REPLACE_TOOL::ReplaceAndFindNext(), 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.

{
 return m_toolMgr->GetToolHolder();
}

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

Referenced by TOOL_BASE::getEditFrame().

GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inlineinherited

Definition at line 77 of file tool_interactive.h.

{ return m_menu; }

References TOOL_INTERACTIVE::m_menu.

Referenced by EE_INSPECTION_TOOL::Init(), EE_POINT_EDITOR::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_MOVE_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), CONVERT_TOOL::Init(), EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_POINT_EDITOR::Init(), and ALIGN_DISTRIBUTE_TOOL::Init().

GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns

The type of the tool.

Definition at line 109 of file tool_base.h.

 {
 return m_type;
 }

References TOOL_BASE::m_type.

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

getView()

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

protectedinherited

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

It allows tools to draw.

Returns

The instance of VIEW.

Definition at line 36 of file tool_base.cpp.

{
 return m_toolMgr->GetView();
}

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

Referenced by EE_POINT_EDITOR::addCornerCondition(), ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), COMMON_TOOLS::CenterContents(), SCH_EDIT_TOOL::ChangeTextType(), EE_INSPECTION_TOOL::CheckSymbol(), GERBVIEW_CONTROL::ClearAllLayers(), PL_SELECTION_TOOL::ClearSelection(), ClearSelection(), CollectHits(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), COMMON_TOOLS::CursorControl(), SCH_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::DeleteItems(), PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), GetNode(), ROUTER_TOOL::getStartLayer(), PCB_CONTROL::GridResetOrigin(), PCB_CONTROL::GridSetOrigin(), GuessSelectionCandidates(), ROUTER_TOOL::handleCommonEvents(), highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineDrag(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), Reset(), EE_TOOL_BASE< T >::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PNS::TOOL_BASE::Reset(), BOARD_EDITOR_CONTROL::Reset(), DRAWING_TOOL::Reset(), PCB_CONTROL::Reset(), PCB_SELECTION_TOOL::Reset(), SCH_EDIT_TOOL::Rotate(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), SelectAll(), PCB_SELECTION_TOOL::SelectAll(), selectionContains(), PL_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectionContains(), selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), selectPoint(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCExclusions(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), GERBVIEW_SELECTION_TOOL::unselectVisually(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), SCH_FIND_REPLACE_TOOL::UpdateFind(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< T >::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), PCB_SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_SELECTION_TOOL::view(), PCB_TOOL_BASE::view(), PCB_VIEWER_TOOLS::view(), ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::zoomFitSelection(), ~EE_SELECTION_TOOL(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), and PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL().

getViewControls()

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

protectedinherited

Return the instance of VIEW_CONTROLS object used in the application.

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

Returns

The instance of VIEW_CONTROLS.

Definition at line 42 of file tool_base.cpp.

{
 return m_toolMgr->GetViewControls();
}

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

Referenced by EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), 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.

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

References TOOL_INTERACTIVE::goInternal().

Referenced by EDA_3D_CONTROLLER::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), EE_INSPECTION_TOOL::setTransitions(), EE_POINT_EDITOR::setTransitions(), setTransitions(), SCH_DRAWING_TOOLS::setTransitions(), SCH_EDIT_TOOL::setTransitions(), SCH_EDITOR_CONTROL::setTransitions(), SCH_FIND_REPLACE_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::setTransitions(), SCH_MOVE_TOOL::setTransitions(), SCH_NAVIGATE_TOOL::setTransitions(), SYMBOL_EDITOR_CONTROL::setTransitions(), SYMBOL_EDITOR_DRAWING_TOOLS::setTransitions(), SYMBOL_EDITOR_EDIT_TOOL::setTransitions(), SYMBOL_EDITOR_MOVE_TOOL::setTransitions(), SYMBOL_EDITOR_PIN_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), COMMON_CONTROL::setTransitions(), COMMON_TOOLS::setTransitions(), PICKER_TOOL::setTransitions(), ZOOM_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), PL_EDIT_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), PL_POINT_EDITOR::setTransitions(), PL_SELECTION_TOOL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), MICROWAVE_TOOL::setTransitions(), SCRIPTING_TOOL::setTransitions(), LENGTH_TUNER_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), CONVERT_TOOL::setTransitions(), DRAWING_TOOL::setTransitions(), DRC_TOOL::setTransitions(), EDIT_TOOL::setTransitions(), FOOTPRINT_EDITOR_CONTROL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), GROUP_TOOL::setTransitions(), PAD_TOOL::setTransitions(), PCB_CONTROL::setTransitions(), PCB_PICKER_TOOL::setTransitions(), PCB_POINT_EDITOR::setTransitions(), PCB_SELECTION_TOOL::setTransitions(), PCB_VIEWER_TOOLS::setTransitions(), ALIGN_DISTRIBUTE_TOOL::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), PROPERTIES_TOOL::setTransitions(), and ZONE_FILLER_TOOL::setTransitions().

goInternal()

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

privateinherited

Definition at line 70 of file tool_interactive.cpp.

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

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

Referenced by TOOL_INTERACTIVE::Go().

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 1046 of file ee_selection_tool.cpp.

{
 // Prefer exact hits to sloppy ones
 std::set<EDA_ITEM*> exactHits;
 
 for( int i = collector.GetCount() - 1; i >= 0; --i )
 {
 EDA_ITEM* item = collector[ i ];
 SCH_LINE* line = dynamic_cast<SCH_LINE*>( item );
 LIB_SHAPE* shape = dynamic_cast<LIB_SHAPE*>( item );
 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( item );
 
 // Lines are hard to hit. Give them a bit more slop to still be considered "exact".
 
 if( line || ( shape && shape->GetShape() == SHAPE_T::POLY )
 || ( shape && shape->GetShape() == SHAPE_T::ARC ) )
 {
 int pixelThreshold = KiROUND( getView()->ToWorld( 6 ) );
 
 if( item->HitTest( aPos, pixelThreshold ) )
 exactHits.insert( item );
 }
 else if( symbol && m_frame->eeconfig()->m_Selection.select_pin_selects_symbol )
 {
 if( symbol->GetBodyAndPinsBoundingBox().Contains( aPos ) )
 exactHits.insert( item );
 }
 else
 {
 if( item->HitTest( aPos, 0 ) )
 exactHits.insert( item );
 }
 }
 
 if( exactHits.size() > 0 && exactHits.size() < (unsigned) collector.GetCount() )
 {
 for( int i = collector.GetCount() - 1; i >= 0; --i )
 {
 EDA_ITEM* item = collector[ i ];
 
 if( !exactHits.count( item ) )
 collector.Transfer( item );
 }
 }
 
 // Find the closest item. (Note that at this point all hits are either exact or non-exact.)
 VECTOR2I pos( aPos );
 SEG poss( m_isSymbolEditor ? mapCoords( pos ) : pos,
 m_isSymbolEditor ? mapCoords( pos ) : pos );
 EDA_ITEM* closest = nullptr;
 int closestDist = INT_MAX / 2;
 
 for( EDA_ITEM* item : collector )
 {
 BOX2I bbox = item->GetBoundingBox();
 int dist = INT_MAX / 2;
 
 if( exactHits.count( item ) )
 {
 if( item->Type() == SCH_PIN_T || item->Type() == SCH_JUNCTION_T )
 {
 closest = item;
 break;
 }
 
 SCH_LINE* line = dynamic_cast<SCH_LINE*>( item );
 EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( item );
 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( item );
 
 if( line )
 {
 dist = DistanceLinePoint( line->GetStartPoint(), line->GetEndPoint(), pos );
 }
 else if( text )
 {
 if( SCH_FIELD* field = dynamic_cast<SCH_FIELD*>( text ) )
 {
 if( field->GetParent() && field->GetParent()->Type() == SCH_SYMBOL_T )
 {
 symbol = static_cast<SCH_SYMBOL*>( field->GetParent() );
 
 VECTOR2I relPos = pos - symbol->GetPosition();
 relPos = symbol->GetTransform().InverseTransform().TransformCoordinate( relPos );
 pos = relPos + symbol->GetPosition();
 
 poss = SEG( pos, pos );
 }
 }
 
 text->GetEffectiveTextShape()->Collide( poss, closestDist, &dist );
 }
 else if( symbol )
 {
 try
 {
 bbox = symbol->GetBodyBoundingBox();
 }
 catch( const boost::bad_pointer& exc )
 {
 // This may be overkill and could be an assertion but we are more likely to
 // find any boost pointer container errors this way.
 wxLogError( wxT( "Boost bad pointer exception '%s' occurred." ), exc.what() );
 }
 
 SHAPE_RECT rect( bbox.GetPosition(), bbox.GetWidth(), bbox.GetHeight() );
 
 if( bbox.Contains( pos ) )
 dist = EuclideanNorm( bbox.GetCenter() - pos );
 else
 rect.Collide( poss, closestDist, &dist );
 }
 else
 {
 dist = EuclideanNorm( bbox.GetCenter() - pos );
 }
 }
 else
 {
 SHAPE_RECT rect( bbox.GetPosition(), bbox.GetWidth(), bbox.GetHeight() );
 rect.Collide( poss, collector.m_Threshold, &dist );
 }
 
 if( dist == closestDist )
 {
 if( item->GetParent() == closest )
 closest = item;
 }
 else if( dist < closestDist )
 {
 closestDist = dist;
 closest = item;
 }
 }
 
 // Construct a tight box (1/2 height and width) around the center of the closest item.
 // All items which exist at least partly outside this box have sufficient other areas
 // for selection and can be dropped.
 if( closest ) // Don't try and get a tight bbox if nothing is near the mouse pointer
 {
 BOX2I tightBox = closest->GetBoundingBox();
 tightBox.Inflate( -tightBox.GetWidth() / 4, -tightBox.GetHeight() / 4 );
 
 for( int i = collector.GetCount() - 1; i >= 0; --i )
 {
 EDA_ITEM* item = collector[i];
 
 if( item == closest )
 continue;
 
 if( !item->HitTest( tightBox, true ) )
 collector.Transfer( item );
 }
 }
}

References ARC, 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(), POLY, 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(), and narrowSelection().

hasModifier()

bool SELECTION_TOOL::hasModifier ( )

protectedinherited

True if a selection modifier is enabled, false otherwise.

Definition at line 86 of file selection_tool.cpp.

{
 return m_subtractive || m_additive || m_exclusive_or;
}

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

Referenced by 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 1883 of file ee_selection_tool.cpp.

{
 KICAD_T itemType = aItem->Type();
 
 if( aMode == SELECTED )
 aItem->SetSelected();
 else if( aMode == BRIGHTENED )
 aItem->SetBrightened();
 
 if( aGroup )
 aGroup->Add( aItem );
 
 // Highlight pins and fields. (All the other symbol children are currently only
 // represented in the LIB_SYMBOL and will inherit the settings of the parent symbol.)
 if( SCH_ITEM* sch_item = dynamic_cast<SCH_ITEM*>( aItem ) )
 {
 sch_item->RunOnChildren(
 [&]( SCH_ITEM* aChild )
 {
 if( aMode == SELECTED )
 aChild->SetSelected();
 else if( aMode == BRIGHTENED )
 aChild->SetBrightened();
 } );
 }
 
 if( itemType == SCH_PIN_T || itemType == SCH_FIELD_T || itemType == SCH_SHEET_PIN_T )
 getView()->Update( aItem->GetParent() );
 else
 getView()->Update( aItem );
}

References SELECTION::Add(), BRIGHTENED, EDA_ITEM::GetParent(), TOOL_BASE::getView(), 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.

{
 m_frame = getEditFrame<SCH_BASE_FRAME>();
 
 SYMBOL_VIEWER_FRAME* symbolViewerFrame = dynamic_cast<SYMBOL_VIEWER_FRAME*>( m_frame );
 SYMBOL_EDIT_FRAME* symbolEditorFrame = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame );
 
 if( symbolEditorFrame )
 {
 m_isSymbolEditor = true;
 m_unit = symbolEditorFrame->GetUnit();
 m_convert = symbolEditorFrame->GetConvert();
 }
 else
 {
 m_isSymbolViewer = symbolViewerFrame != nullptr;
 }
 
 auto linesSelection = E_C::MoreThan( 0 ) && E_C::OnlyTypes( { SCH_ITEM_LOCATE_WIRE_T, SCH_ITEM_LOCATE_BUS_T,
 SCH_ITEM_LOCATE_GRAPHIC_LINE_T } );
 auto wireOrBusSelection = E_C::Count( 1 ) && E_C::OnlyTypes( { SCH_ITEM_LOCATE_WIRE_T, SCH_ITEM_LOCATE_BUS_T } );
 auto connectedSelection = E_C::Count( 1 ) && E_C::OnlyTypes( connectedTypes );
 auto sheetSelection = E_C::Count( 1 ) && E_C::OnlyTypes( { SCH_SHEET_T } );
 auto crossProbingSelection = E_C::MoreThan( 0 ) && E_C::HasTypes( { SCH_SYMBOL_T, SCH_PIN_T, SCH_SHEET_T } );
 
 auto schEditSheetPageNumberCondition =
 [&] ( const SELECTION& aSel )
 {
 if( m_isSymbolEditor || m_isSymbolViewer )
 return false;
 
 return E_C::LessThan( 2 )( aSel ) && E_C::OnlyTypes( { SCH_SHEET_T } )( aSel );
 };
 
 auto schEditCondition =
 [this] ( const SELECTION& aSel )
 {
 return !m_isSymbolEditor && !m_isSymbolViewer;
 };
 
 auto belowRootSheetCondition =
 [&]( const SELECTION& aSel )
 {
 SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
 
 return editFrame
 && editFrame->GetCurrentSheet().Last() != &editFrame->Schematic().Root();
 };
 
 auto haveHighlight =
 [&]( const SELECTION& sel )
 {
 SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
 
 return editFrame && editFrame->GetHighlightedConnection() != nullptr;
 };
 
 auto haveSymbol =
 [&]( const SELECTION& sel )
 {
 return m_isSymbolEditor &&
 static_cast<SYMBOL_EDIT_FRAME*>( m_frame )->GetCurSymbol();
 };
 
 auto symbolDisplayNameIsEditable =
 [&]( const SELECTION& sel )
 {
 if ( !m_isSymbolEditor )
 return false;
 
 SYMBOL_EDIT_FRAME* symbEditorFrame = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame );
 
 return symbEditorFrame
 && symbEditorFrame->GetCurSymbol()
 && symbEditorFrame->GetCurSymbol()->IsMulti()
 && symbEditorFrame->IsSymbolEditable()
 && !symbEditorFrame->IsSymbolAlias();
 };
 
 auto& menu = m_menu.GetMenu();
 
 menu.AddItem( EE_ACTIONS::clearHighlight, haveHighlight && EE_CONDITIONS::Idle, 1 );
 menu.AddSeparator( haveHighlight && EE_CONDITIONS::Idle, 1 );
 
 menu.AddItem( EE_ACTIONS::enterSheet, sheetSelection && EE_CONDITIONS::Idle, 2 );
 menu.AddItem( EE_ACTIONS::selectOnPCB, crossProbingSelection && EE_CONDITIONS::Idle, 2 );
 menu.AddItem( EE_ACTIONS::leaveSheet, belowRootSheetCondition, 2 );
 
 menu.AddSeparator( 100 );
 menu.AddItem( EE_ACTIONS::drawWire, schEditCondition && EE_CONDITIONS::Empty, 100 );
 menu.AddItem( EE_ACTIONS::drawBus, schEditCondition && EE_CONDITIONS::Empty, 100 );
 
 menu.AddSeparator( 100 );
 menu.AddItem( EE_ACTIONS::finishWire, SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire, 100 );
 
 menu.AddSeparator( 100 );
 menu.AddItem( EE_ACTIONS::finishBus, SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus, 100 );
 
 menu.AddSeparator( 200 );
 menu.AddItem( EE_ACTIONS::selectConnection, connectedSelection && EE_CONDITIONS::Idle, 250 );
 menu.AddItem( EE_ACTIONS::placeJunction, wireOrBusSelection && EE_CONDITIONS::Idle, 250 );
 menu.AddItem( EE_ACTIONS::placeLabel, wireOrBusSelection && EE_CONDITIONS::Idle, 250 );
 menu.AddItem( EE_ACTIONS::placeClassLabel, wireOrBusSelection && EE_CONDITIONS::Idle, 250 );
 menu.AddItem( EE_ACTIONS::placeGlobalLabel, wireOrBusSelection && EE_CONDITIONS::Idle, 250 );
 menu.AddItem( EE_ACTIONS::placeHierLabel, wireOrBusSelection && EE_CONDITIONS::Idle, 250 );
 menu.AddItem( EE_ACTIONS::breakWire, linesSelection && EE_CONDITIONS::Idle, 250 );
 menu.AddItem( EE_ACTIONS::slice, linesSelection && EE_CONDITIONS::Idle, 250 );
 menu.AddItem( EE_ACTIONS::importSheetPin, sheetSelection && EE_CONDITIONS::Idle, 250 );
 menu.AddItem( EE_ACTIONS::assignNetclass, connectedSelection && EE_CONDITIONS::Idle, 250 );
 menu.AddItem( EE_ACTIONS::editPageNumber, schEditSheetPageNumberCondition, 250 );
 
 menu.AddSeparator( 400 );
 menu.AddItem( EE_ACTIONS::symbolProperties, haveSymbol && EE_CONDITIONS::Empty, 400 );
 menu.AddItem( EE_ACTIONS::pinTable, haveSymbol && EE_CONDITIONS::Empty, 400 );
 menu.AddItem( EE_ACTIONS::setUnitDisplayName,
 haveSymbol && symbolDisplayNameIsEditable && EE_CONDITIONS::Empty, 400 );
 
 menu.AddSeparator( 1000 );
 m_frame->AddStandardSubMenus( m_menu );
 
 m_disambiguateTimer.SetOwner( this );
 Connect( wxEVT_TIMER, wxTimerEventHandler( EE_SELECTION_TOOL::onDisambiguationExpire ), nullptr, this );
 
 return true;
}

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.

{
 return m_toolMgr->IsToolActive( m_toolId );
}

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

Referenced by EDIT_TOOL::Drag(), ROUTER_TOOL::handleLayerSwitch(), 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 334 of file ee_selection_tool.cpp.

{
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 
 KIID lastRolloverItem = niluuid;
 
 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 bool selCancelled = false;
 bool displayWireCursor = false;
 bool displayBusCursor = false;
 bool displayLineCursor = false;
 KIID rolloverItem = lastRolloverItem;
 
 // on left click, a selection is made, depending on modifiers ALT, SHIFT, CTRL:
 setModifiersState( evt->Modifier( MD_SHIFT ), evt->Modifier( MD_CTRL ),
 evt->Modifier( MD_ALT ) );
 
 MOUSE_DRAG_ACTION drag_action = m_frame->GetDragAction();
 EE_GRID_HELPER grid( m_toolMgr );
 
 if( evt->IsMouseDown( BUT_LEFT ) )
 {
 // Avoid triggering when running under other tools
 // Distinguish point editor from selection modification by checking modifiers
 if( m_frame->ToolStackIsEmpty() && m_toolMgr->GetTool<EE_POINT_EDITOR>()
 && ( !m_toolMgr->GetTool<EE_POINT_EDITOR>()->HasPoint() || hasModifier() ) )
 {
 m_originalCursor = m_toolMgr->GetMousePosition();
 m_disambiguateTimer.StartOnce( 500 );
 }
 }
 // Single click? Select single object
 else if( evt->IsClick( BUT_LEFT ) )
 {
 // If the timer has stopped, then we have already run the disambiguate routine
 // and we don't want to register an extra click here
 if( !m_disambiguateTimer.IsRunning() )
 {
 evt->SetPassEvent();
 continue;
 }
 
 m_disambiguateTimer.Stop();
 
 if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
 schframe->FocusOnItem( nullptr );
 
 // Collect items at the clicked location (doesn't select them yet)
 EE_COLLECTOR collector;
 CollectHits( collector, evt->Position() );
 narrowSelection( collector, evt->Position(), false );
 
 if( collector.GetCount() == 1 && !m_isSymbolEditor && !hasModifier() )
 {
 OPT_TOOL_EVENT autostart = autostartEvent( evt, grid, collector[0] );
 
 if( autostart )
 {
 DRAW_SEGMENT_EVENT_PARAMS* params = new DRAW_SEGMENT_EVENT_PARAMS();
 
 params->layer = autostart->Parameter<DRAW_SEGMENT_EVENT_PARAMS*>()->layer;
 params->quitOnDraw = true;
 params->sourceSegment = dynamic_cast<SCH_LINE*>( collector[0] );
 
 autostart->SetParameter( params );
 m_toolMgr->ProcessEvent( *autostart );
 
 selCancelled = true;
 }
 else if( collector[0]->IsHypertext() )
 {
 collector[ 0 ]->DoHypertextAction( m_frame );
 selCancelled = true;
 }
 }
 
 if( !selCancelled )
 {
 selectPoint( collector, evt->Position(), nullptr, nullptr, m_additive,
  m_subtractive, m_exclusive_or );
 m_selection.SetIsHover( false );
 }
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_disambiguateTimer.Stop();
 
 // right click? if there is any object - show the context menu
 if( m_selection.Empty() )
 {
 ClearSelection();
 SelectPoint( evt->Position(), { SCH_LOCATE_ANY_T }, nullptr, &selCancelled );
 m_selection.SetIsHover( true );
 }
 // If the cursor has moved off the bounding box of the selection by more than
 // a grid square, check to see if there is another item available for selection
 // under the cursor. If there is, the user likely meant to get the context menu
 // for that item. If there is no new item, then keep the original selection and
 // show the context menu for it.
 else if( !m_selection.GetBoundingBox().Inflate( grid.GetGrid().x, grid.GetGrid().y )
 .Contains( evt->Position() ) )
 {
 EE_COLLECTOR collector;
 
 if( CollectHits( collector, evt->Position(), { SCH_LOCATE_ANY_T } ) )
 {
 ClearSelection();
 
 SelectPoint( evt->Position(), { SCH_LOCATE_ANY_T }, nullptr, &selCancelled );
 m_selection.SetIsHover( true );
 }
 }
 
 if( !selCancelled )
 m_menu.ShowContextMenu( m_selection );
 }
 else if( evt->IsDblClick( BUT_LEFT ) )
 {
 m_disambiguateTimer.Stop();
 
 // double click? Display the properties window
 if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
 schframe->FocusOnItem( nullptr );
 
 if( m_selection.Empty() )
 SelectPoint( evt->Position() );
 
 EDA_ITEM* item = m_selection.Front();
 
 if( item && item->Type() == SCH_SHEET_T )
 m_toolMgr->RunAction( EE_ACTIONS::enterSheet );
 else
 m_toolMgr->RunAction( EE_ACTIONS::properties );
 }
 else if( evt->IsDblClick( BUT_MIDDLE ) )
 {
 m_disambiguateTimer.Stop();
 
 // Middle double click? Do zoom to fit or zoom to objects
 if( evt->Modifier( MD_CTRL ) ) // Is CTRL key down?
 m_toolMgr->RunAction( ACTIONS::zoomFitObjects, true );
 else
 m_toolMgr->RunAction( ACTIONS::zoomFitScreen, true );
 }
 else if( evt->IsDrag( BUT_LEFT ) )
 {
 m_disambiguateTimer.Stop();
 
 // Is another tool already moving a new object? Don't allow a drag start
 if( !m_selection.Empty() && m_selection[0]->HasFlag( IS_NEW | IS_MOVING ) )
 {
 evt->SetPassEvent();
 continue;
 }
 
 // drag with LMB? Select multiple objects (or at least draw a selection box) or
 // drag them
 if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
 schframe->FocusOnItem( nullptr );
 
 if( hasModifier() || drag_action == MOUSE_DRAG_ACTION::SELECT )
 {
 selectMultiple();
 }
 else if( m_selection.Empty() && drag_action != MOUSE_DRAG_ACTION::DRAG_ANY )
 {
 selectMultiple();
 }
 else
 {
 if( m_isSymbolEditor )
 {
 if( static_cast<SYMBOL_EDIT_FRAME*>( m_frame )->IsSymbolAlias() )
 {
 m_selection = RequestSelection( { LIB_FIELD_T } );
 }
 else
 {
 m_selection = RequestSelection( { LIB_SHAPE_T,
 LIB_TEXT_T,
 LIB_TEXTBOX_T,
 LIB_PIN_T,
 LIB_FIELD_T } );
 }
 }
 else
 {
 m_selection = RequestSelection( EE_COLLECTOR::MovableItems );
 }
 
 // Check if dragging has started within any of selected items bounding box
 if( selectionContains( evt->DragOrigin() ) )
 {
 // Yes -> run the move tool and wait till it finishes
 if( m_isSymbolEditor )
 m_toolMgr->InvokeTool( "eeschema.SymbolMoveTool" );
 else
 m_toolMgr->InvokeTool( "eeschema.InteractiveMove" );
 }
 else
 {
 // No -> drag a selection box
 selectMultiple();
 }
 }
 }
 else if( evt->IsMouseDown( BUT_AUX1 ) )
 {
 m_toolMgr->RunAction( EE_ACTIONS::navigateBack, true );
 }
 else if( evt->IsMouseDown( BUT_AUX2 ) )
 {
 m_toolMgr->RunAction( EE_ACTIONS::navigateForward, true );
 }
 else if( evt->Category() == TC_COMMAND && evt->Action() == TA_CHOICE_MENU_CHOICE )
 {
 m_disambiguateTimer.Stop();
 
 // context sub-menu selection? Handle unit selection or bus unfolding
 if( *evt->GetCommandId() >= ID_POPUP_SCH_SELECT_UNIT_CMP
 && *evt->GetCommandId() <= ID_POPUP_SCH_SELECT_UNIT_SYM_MAX )
 {
 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( m_selection.Front() );
 int unit = *evt->GetCommandId() - ID_POPUP_SCH_SELECT_UNIT_CMP;
 
 if( symbol )
 static_cast<SCH_EDIT_FRAME*>( m_frame )->SelectUnit( symbol, unit );
 }
 else if( *evt->GetCommandId() >= ID_POPUP_SCH_UNFOLD_BUS
 && *evt->GetCommandId() <= ID_POPUP_SCH_UNFOLD_BUS_END )
 {
 wxString* net = new wxString( *evt->Parameter<wxString*>() );
 m_toolMgr->RunAction( EE_ACTIONS::unfoldBus, true, net );
 }
 }
 else if( evt->IsCancelInteractive() )
 {
 m_disambiguateTimer.Stop();
 
 if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
 schframe->FocusOnItem( nullptr );
 
 if( !GetSelection().Empty() )
 {
 ClearSelection();
 }
 else if( evt->FirstResponder() == this && evt->GetCommandId() == (int) WXK_ESCAPE )
 {
 SCH_EDITOR_CONTROL* editor = m_toolMgr->GetTool<SCH_EDITOR_CONTROL>();
 
 if( editor && m_frame->eeconfig()->m_Input.esc_clears_net_highlight )
 editor->ClearHighlight( *evt );
 }
 }
 else if( evt->Action() == TA_UNDO_REDO_PRE )
 {
 if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
 schframe->FocusOnItem( nullptr );
 
 ClearSelection();
 }
 else if( evt->IsMotion() && !m_isSymbolEditor && evt->FirstResponder() == this )
 {
 // Update cursor and rollover item
 rolloverItem = niluuid;
 EE_COLLECTOR collector;
 
 getViewControls()->ForceCursorPosition( false );
 
 if( CollectHits( collector, evt->Position() ) )
 {
 narrowSelection( collector, evt->Position(), false );
 
 if( collector.GetCount() == 1 && !hasModifier() )
 {
 OPT_TOOL_EVENT autostartEvt = autostartEvent( evt, grid, collector[0] );
 
 if( autostartEvt )
 {
 if( autostartEvt->Matches( EE_ACTIONS::drawBus.MakeEvent() ) )
 displayBusCursor = true;
 else if( autostartEvt->Matches( EE_ACTIONS::drawWire.MakeEvent() ) )
 displayWireCursor = true;
 else if( autostartEvt->Matches( EE_ACTIONS::drawLines.MakeEvent() ) )
 displayLineCursor = true;
 }
 else if( collector[0]->IsHypertext() && !collector[0]->IsSelected() )
 {
 rolloverItem = collector[0]->m_Uuid;
 }
 }
 }
 }
 else
 {
 evt->SetPassEvent();
 }
 
 if( rolloverItem != lastRolloverItem )
 {
 if( EDA_ITEM* item = m_frame->GetItem( lastRolloverItem ) )
 {
 item->ClearFlags( IS_ROLLOVER );
 lastRolloverItem = niluuid;
 
 if( item->Type() == SCH_FIELD_T )
 m_frame->GetCanvas()->GetView()->Update( item->GetParent() );
 else
 m_frame->GetCanvas()->GetView()->Update( item );
 }
 }
 
 if( EDA_ITEM* item = m_frame->GetItem( rolloverItem ) )
 {
 if( !( item->GetFlags() & IS_ROLLOVER ) )
 {
 item->SetFlags( IS_ROLLOVER );
 lastRolloverItem = rolloverItem;
 
 if( item->Type() == SCH_FIELD_T )
 m_frame->GetCanvas()->GetView()->Update( item->GetParent() );
 else
 m_frame->GetCanvas()->GetView()->Update( item );
 }
 }
 
 if( m_frame->ToolStackIsEmpty() )
 {
 if( displayWireCursor )
 {
 m_nonModifiedCursor = KICURSOR::LINE_WIRE_ADD;
 }
 else if( displayBusCursor )
 {
 m_nonModifiedCursor = KICURSOR::LINE_BUS;
 }
 else if( displayLineCursor )
 {
 m_nonModifiedCursor = KICURSOR::LINE_GRAPHIC;
 }
 else if( rolloverItem != niluuid )
 {
 m_nonModifiedCursor = KICURSOR::HAND;
 }
 else if( !m_selection.Empty()
 && drag_action == MOUSE_DRAG_ACTION::DRAG_SELECTED
 && evt->HasPosition()
 && selectionContains( evt->Position() ) ) //move/drag option prediction
 {
 m_nonModifiedCursor = KICURSOR::MOVING;
 }
 else
 {
 m_nonModifiedCursor = KICURSOR::ARROW;
 }
 }
 }
 
 m_disambiguateTimer.Stop();
 
 // Shutting down; clear the selection
 m_selection.Clear();
 
 return 0;
}

References ARROW, autostartEvent(), BUT_AUX1, BUT_AUX2, BUT_LEFT, BUT_MIDDLE, BUT_RIGHT, SELECTION::Clear(), ClearSelection(), CollectHits(), BOX2< Vec >::Contains(), DRAG_ANY, DRAG_SELECTED, 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, HAND, 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, LINE_BUS, LINE_GRAPHIC, LINE_WIRE_ADD, 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, MOVING, 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, SELECT, selectionContains(), selectMultiple(), SelectPoint(), selectPoint(), 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 843 of file ee_selection_tool.cpp.

{
 for( int i = collector.GetCount() - 1; i >= 0; --i )
 {
 if( !Selectable( collector[i], &aWhere ) )
 {
 collector.Remove( i );
 continue;
 }
 
 if( aCheckLocked && collector[i]->IsLocked() )
 {
 collector.Remove( i );
 continue;
 }
 
 if( aSelectedOnly && !collector[i]->IsSelected() )
 {
 collector.Remove( i );
 continue;
 }
 }
 
 // Apply some ugly heuristics to avoid disambiguation menus whenever possible
 if( collector.GetCount() > 1 && !m_skip_heuristics )
 GuessSelectionCandidates( collector, aWhere );
}

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.

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

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

Referenced by 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 774 of file ee_selection_tool.cpp.

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

References ADD, 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(), SUBTRACT, TOOLS_HOLDER::ToolStackIsEmpty(), and XOR.

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 1739 of file ee_selection_tool.cpp.

{
 m_selection.Clear();
 
 if( m_isSymbolEditor )
 {
 LIB_SYMBOL* start = static_cast<SYMBOL_EDIT_FRAME*>( m_frame )->GetCurSymbol();
 
 for( LIB_ITEM& item : start->GetDrawItems() )
 {
 if( item.IsSelected() )
 select( &item );
 }
 }
 else
 {
 for( SCH_ITEM* item : m_frame->GetScreen()->Items() )
 {
 // If the field and symbol are selected, only use the symbol
 if( item->IsSelected() )
 {
 select( item );
 }
 else
 {
 item->RunOnChildren(
 [&]( SCH_ITEM* aChild )
 {
 if( aChild->IsSelected() )
 select( aChild );
 } );
 }
 }
 }
 
 updateReferencePoint();
 
 // Inform other potentially interested tools
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
}

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(), 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.

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

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

Referenced by PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), SELECTION_TOOL::RemoveItemFromSel(), 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.

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

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

RemoveItemsFromSel() [1/3]

int SELECTION_TOOL::RemoveItemsFromSel ( const TOOL_EVENT &  aEvent )

inherited

Definition at line 171 of file selection_tool.cpp.

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

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

Referenced by SCH_MOVE_TOOL::Main(), 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.

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

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

RemoveItemsFromSel() [3/3]

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

inherited

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

Definition at line 193 of file selection_tool.cpp.

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

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

RequestSelection()

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 1202 of file ee_selection_tool.cpp.

{
 if( m_selection.Empty() )
 {
 VECTOR2D cursorPos = getViewControls()->GetCursorPosition( true );
 
 ClearSelection();
 SelectPoint( cursorPos, aScanTypes );
 m_selection.SetIsHover( true );
 m_selection.ClearReferencePoint();
 }
 else // Trim an existing selection by aFilterList
 {
 bool isMoving = false;
 bool anyUnselected = false;
 
 for( int i = (int) m_selection.GetSize() - 1; i >= 0; --i )
 {
 EDA_ITEM* item = (EDA_ITEM*) m_selection.GetItem( i );
 isMoving |= static_cast<SCH_ITEM*>( item )->IsMoving();
 
 if( !item->IsType( aScanTypes ) )
 {
 unselect( item );
 anyUnselected = true;
 }
 }
 
 if( anyUnselected )
 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
 
 if( !isMoving )
 updateReferencePoint();
 }
 
 return m_selection;
}

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(), 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(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_EDIT_TOOL::Swap(), 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.

{
 m_frame = getEditFrame<SCH_BASE_FRAME>();
 
 if( aReason == TOOL_BASE::MODEL_RELOAD )
 {
 // Remove pointers to the selected items from containers without changing their
 // properties (as they are already deleted while a new sheet is loaded)
 m_selection.Clear();
 getView()->GetPainter()->GetSettings()->SetHighlight( false );
 
 SYMBOL_EDIT_FRAME* symbolEditFrame = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame );
 SYMBOL_VIEWER_FRAME* symbolViewerFrame = dynamic_cast<SYMBOL_VIEWER_FRAME*>( m_frame );
 
 if( symbolEditFrame )
 {
 m_isSymbolEditor = true;
 m_unit = symbolEditFrame->GetUnit();
 m_convert = symbolEditFrame->GetConvert();
 }
 else
 {
 m_isSymbolViewer = symbolViewerFrame != nullptr;
 }
 }
 else
 {
 // Restore previous properties of selected items and remove them from containers
 ClearSelection();
 }
 
 // Reinsert the VIEW_GROUP, in case it was removed from the VIEW
 getView()->Remove( &m_selection );
 getView()->Add( &m_selection );
}

References KIGFX::VIEW::Add(), SELECTION::Clear(), ClearSelection(), 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, KIGFX::VIEW::Remove(), and KIGFX::RENDER_SETTINGS::SetHighlight().

resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

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

Definition at line 63 of file tool_interactive.cpp.

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

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

RunMainStack()

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

inherited

Call a function using the main stack.

Parameters

aFunc

is the function to be calls.

Definition at line 87 of file tool_interactive.cpp.

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

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

Referenced by DRAWING_TOOL::PlaceText().

select()

void 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 1871 of file ee_selection_tool.cpp.

{
 highlight( aItem, SELECTED, &m_selection );
}

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 1781 of file ee_selection_tool.cpp.

{
 // NOTE: in the future this is where Eeschema layer/itemtype visibility will be handled
 
 SYMBOL_EDIT_FRAME* symEditFrame = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame );
 
 // Do not allow selection of anything except fields when the current symbol in the symbol
 // editor is a derived symbol.
 if( symEditFrame && symEditFrame->IsSymbolAlias() && aItem->Type() != LIB_FIELD_T )
 return false;
 
 switch( aItem->Type() )
 {
 case SCH_PIN_T:
 {
 const SCH_PIN* pin = static_cast<const SCH_PIN*>( aItem );
 
 if( !pin->IsVisible() && !m_frame->GetShowAllPins() )
 return false;
 
 if( m_frame->eeconfig()->m_Selection.select_pin_selects_symbol )
 {
 // Pin anchors have to be allowed for auto-starting wires.
 if( aPos )
 {
 EE_GRID_HELPER grid( m_toolMgr );
 
 if( pin->IsPointClickableAnchor( grid.BestSnapAnchor( *aPos, LAYER_CONNECTABLE ) ) )
 return true;
 }
 
 return false;
 }
 
 break;
 }
 
 case LIB_SYMBOL_T: // In symbol_editor we do not want to select the symbol itself.
 return false;
 
 case LIB_FIELD_T: // LIB_FIELD object can always be edited.
 break;
 
 case LIB_SHAPE_T:
 case LIB_TEXT_T:
 case LIB_PIN_T:
 if( symEditFrame )
 {
 LIB_ITEM* lib_item = (LIB_ITEM*) aItem;
 
 if( lib_item->GetUnit() && lib_item->GetUnit() != symEditFrame->GetUnit() )
 return false;
 
 if( lib_item->GetConvert() && lib_item->GetConvert() != symEditFrame->GetConvert() )
 return false;
 }
 
 break;
 
 case SCH_MARKER_T: // Always selectable
 return true;
 
 default: // Suppress warnings
 break;
 }
 
 return true;
}

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, m_frame, EESCHEMA_SETTINGS::m_Selection, TOOL_BASE::m_toolMgr, pin, SCH_MARKER_T, SCH_PIN_T, EESCHEMA_SETTINGS::SELECTION::select_pin_selects_symbol, 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 993 of file ee_selection_tool.cpp.

{
 m_multiple = true; // Multiple selection mode is active
 KIGFX::VIEW* view = getView();
 
 // hold all visible items
 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> selectedItems;
 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> sheetPins;
 
 // Filter the view items based on the selection box
 BOX2I selectionBox;
 
 selectionBox.SetMaximum();
 view->Query( selectionBox, selectedItems ); // Get the list of selected items
 
 // Sheet pins aren't in the view; add them by hand
 for( KIGFX::VIEW::LAYER_ITEM_PAIR& pair : selectedItems )
 {
 SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>( pair.first );
 
 if( sheet )
 {
 int layer = pair.second;
 
 for( SCH_SHEET_PIN* pin : sheet->GetPins() )
 sheetPins.emplace_back( KIGFX::VIEW::LAYER_ITEM_PAIR( pin, layer ) );
 }
 }
 
 selectedItems.insert( selectedItems.end(), sheetPins.begin(), sheetPins.end() );
 
 for( const std::pair<KIGFX::VIEW_ITEM*, int>& item_pair : selectedItems )
 {
 if( EDA_ITEM* item = dynamic_cast<EDA_ITEM*>( item_pair.first ) )
 {
 if( Selectable( item ) )
 {
 if( item->Type() == SCH_LINE_T )
 item->SetFlags( STARTPOINT | ENDPOINT );
 
 select( item );
 }
 }
 }
 
 m_multiple = false;
 
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 
 return 0;
}

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 1541 of file ee_selection_tool.cpp.

{
 RequestSelection( { SCH_ITEM_LOCATE_WIRE_T, SCH_ITEM_LOCATE_BUS_T } );
 
 if( m_selection.Empty() )
 return 0;
 
 SCH_LINE* line = (SCH_LINE*) m_selection.Front();
 unsigned done = false;
 
 m_frame->GetScreen()->ClearDrawingState();
 std::set<SCH_ITEM*> conns = m_frame->GetScreen()->MarkConnections( line, false );
 
 for( SCH_ITEM* item : conns )
 {
 if( item->IsType( { SCH_ITEM_LOCATE_WIRE_T, SCH_ITEM_LOCATE_BUS_T } )
 && !item->IsSelected() )
 {
 done = true;
 }
 
 select( item );
 }
 
 if( !done )
 {
 conns = m_frame->GetScreen()->MarkConnections( line, true );
 
 for( SCH_ITEM* item : conns )
 select( item );
 }
 
 if( m_selection.GetSize() > 1 )
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 
 return 0;
}

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.

{ return m_selection; }

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 1954 of file ee_selection_tool.cpp.

{
 const unsigned GRIP_MARGIN = 20;
 double margin = getView()->ToWorld( GRIP_MARGIN );
 
 // Check if the point is located within any of the currently selected items bounding boxes
 for( EDA_ITEM* item : m_selection )
 {
 BOX2I itemBox = item->ViewBBox();
 itemBox.Inflate( margin ); // 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, 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.

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

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

Referenced by 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 1270 of file ee_selection_tool.cpp.

{
 bool cancelled = false; // Was the tool canceled while it was running?
 m_multiple = true; // Multiple selection mode is active
 KIGFX::VIEW* view = getView();
 
 KIGFX::PREVIEW::SELECTION_AREA area;
 view->Add( &area );
 
 while( TOOL_EVENT* evt = Wait() )
 {
 int width = area.GetEnd().x - area.GetOrigin().x;
 int height = area.GetEnd().y - area.GetOrigin().y;
 
 /* 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 isGreedy = width < 0;
 
 if( view->IsMirroredX() )
 isGreedy = !isGreedy;
 
 m_frame->GetCanvas()->SetCurrentCursor( isGreedy ? KICURSOR::SELECT_LASSO
 : KICURSOR::SELECT_WINDOW );
 
 if( evt->IsCancelInteractive() || evt->IsActivate() )
 {
 cancelled = true;
 break;
 }
 
 if( evt->IsDrag( BUT_LEFT ) )
 {
 if( !m_drag_additive && !m_drag_subtractive )
 ClearSelection();
 
 // Start drawing a selection box
 area.SetOrigin( evt->DragOrigin() );
 area.SetEnd( evt->Position() );
 area.SetAdditive( m_drag_additive );
 area.SetSubtractive( m_drag_subtractive );
 area.SetExclusiveOr( false );
 
 view->SetVisible( &area, true );
 view->Update( &area );
 getViewControls()->SetAutoPan( true );
 }
 
 if( evt->IsMouseUp( BUT_LEFT ) )
 {
 getViewControls()->SetAutoPan( false );
 
 // End drawing the selection box
 view->SetVisible( &area, false );
 
 // Fetch items from the RTree that are in our area of interest
 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> nearbyViewItems;
 view->Query( area.ViewBBox(), nearbyViewItems );
 
 // Build lists of nearby items and their children
 std::unordered_set<EDA_ITEM*> nearbyItems;
 std::vector<EDA_ITEM*> nearbyChildren;
 std::vector<EDA_ITEM*> flaggedItems;
 
 for( KIGFX::VIEW::LAYER_ITEM_PAIR& pair : nearbyViewItems )
 {
 if( EDA_ITEM* item = dynamic_cast<EDA_ITEM*>( pair.first ) )
 {
 if( nearbyItems.insert( item ).second )
 {
 item->ClearFlags( CANDIDATE );
 
 if( SCH_ITEM* sch_item = dynamic_cast<SCH_ITEM*>( item ) )
 {
 sch_item->RunOnChildren(
 [&]( SCH_ITEM* aChild )
  {
 // Filter pins by unit
 if( SCH_PIN* pin = dyn_cast<SCH_PIN*>( aChild ) )
 {
 int unit = pin->GetLibPin()->GetUnit();
 
 if( unit && unit != pin->GetParentSymbol()->GetUnit() )
 return;
 }
 
 nearbyChildren.push_back( aChild );
 } );
 }
 }
 }
 }
 
 BOX2I selectionRect( area.GetOrigin(), VECTOR2I( width, height ) );
 selectionRect.Normalize();
 
 bool anyAdded = false;
 bool anySubtracted = false;
 
 auto selectItem =
 [&]( EDA_ITEM* aItem, EDA_ITEM_FLAGS flags )
 {
 if( m_subtractive || ( m_exclusive_or && aItem->IsSelected() ) )
 {
 if ( m_exclusive_or )
 aItem->XorFlags( flags );
 else
 aItem->ClearFlags( flags );
 
 if( !aItem->HasFlag( STARTPOINT ) && !aItem->HasFlag( ENDPOINT ) )
 {
 unselect( aItem );
 anySubtracted = true;
 }
 
 // We changed one line endpoint on a selected line,
 // update the view at least.
 if( flags && !anySubtracted )
 {
 getView()->Update( aItem );
 }
 }
 else
 {
 aItem->SetFlags( flags );
 select( aItem );
 anyAdded = true;
 }
 };
 
 for( EDA_ITEM* item : nearbyItems )
 {
 bool selected = false;
 EDA_ITEM_FLAGS flags = 0;
 
 if( m_frame->GetRenderSettings()->m_ShowPinsElectricalType )
 item->SetFlags( SHOW_ELEC_TYPE );
 
 if( Selectable( item ) )
 {
 if( item->Type() == SCH_LINE_T )
 {
 SCH_LINE* line = static_cast<SCH_LINE*>( item );
 
 if( ( isGreedy && line->HitTest( selectionRect, false ) )
 || ( selectionRect.Contains( line->GetEndPoint() )
 && selectionRect.Contains( line->GetStartPoint() ) ) )
 {
 selected = true;
 flags |= STARTPOINT | ENDPOINT;
 }
 else if( !isGreedy )
 {
 if( selectionRect.Contains( line->GetStartPoint() )
 && line->IsStartDangling() )
 {
 selected = true;
 flags |= STARTPOINT;
 }
 
 if( selectionRect.Contains( line->GetEndPoint() )
 && line->IsEndDangling() )
 {
 selected = true;
 flags |= ENDPOINT;
 }
 }
 }
 else
 {
 selected = item->HitTest( selectionRect, !isGreedy );
 }
 }
 
 if( selected )
 {
 item->SetFlags( CANDIDATE );
 flaggedItems.push_back( item );
 selectItem( item, flags );
 }
 
 item->ClearFlags( SHOW_ELEC_TYPE );
 }
 
 for( EDA_ITEM* item : nearbyChildren )
  {
 if( m_frame->GetRenderSettings()->m_ShowPinsElectricalType )
 item->SetFlags( SHOW_ELEC_TYPE );
 
 if( Selectable( item )
 && !item->GetParent()->HasFlag( CANDIDATE )
 && item->HitTest( selectionRect, !isGreedy ) )
 {
 selectItem( item, 0 );
 }
 
 item->ClearFlags( SHOW_ELEC_TYPE );
 }
 
 for( EDA_ITEM* item : flaggedItems )
 item->ClearFlags( CANDIDATE );
 
 m_selection.SetIsHover( false );
 
 // Inform other potentially interested tools
 if( anyAdded )
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 
 if( anySubtracted )
 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
 
 break; // Stop waiting for events
 }
 
 // Allow some actions for navigation
 for( int i = 0; allowedActions[i]; ++i )
 {
 if( evt->IsAction( allowedActions[i] ) )
 {
 evt->SetPassEvent();
 break;
 }
 }
 }
 
 getViewControls()->SetAutoPan( false );
 
 // Stop drawing the selection box
 view->Remove( &area );
 m_multiple = false; // Multiple selection mode is inactive
 
 if( !cancelled )
 m_selection.ClearReferencePoint();
 
 return cancelled;
}

References KIGFX::VIEW::Add(), allowedActions, BUT_LEFT, CANDIDATE, EDA_ITEM::ClearFlags(), SELECTION::ClearReferencePoint(), ClearSelection(), BOX2< Vec >::Contains(), ENDPOINT, SCH_BASE_FRAME::GetCanvas(), KIGFX::PREVIEW::SELECTION_AREA::GetEnd(), SCH_LINE::GetEndPoint(), KIGFX::PREVIEW::SELECTION_AREA::GetOrigin(), SCH_BASE_FRAME::GetRenderSettings(), SCH_LINE::GetStartPoint(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), EDA_ITEM::HasFlag(), SCH_LINE::HitTest(), SCH_LINE::IsEndDangling(), KIGFX::VIEW::IsMirroredX(), EDA_ITEM::IsSelected(), SCH_LINE::IsStartDangling(), SELECTION_TOOL::m_drag_additive, SELECTION_TOOL::m_drag_subtractive, SELECTION_TOOL::m_exclusive_or, m_frame, SELECTION_TOOL::m_multiple, m_selection, KIGFX::SCH_RENDER_SETTINGS::m_ShowPinsElectricalType, SELECTION_TOOL::m_subtractive, TOOL_BASE::m_toolMgr, BOX2< Vec >::Normalize(), pin, TOOL_MANAGER::ProcessEvent(), KIGFX::VIEW::Query(), KIGFX::VIEW::Remove(), SCH_LINE_T, select(), SELECT_LASSO, SELECT_WINDOW, Selectable(), EVENTS::SelectedEvent, KIGFX::PREVIEW::SELECTION_AREA::SetAdditive(), KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), KIGFX::PREVIEW::SELECTION_AREA::SetEnd(), KIGFX::PREVIEW::SELECTION_AREA::SetExclusiveOr(), EDA_ITEM::SetFlags(), SELECTION::SetIsHover(), KIGFX::PREVIEW::SELECTION_AREA::SetOrigin(), KIGFX::PREVIEW::SELECTION_AREA::SetSubtractive(), KIGFX::VIEW::SetVisible(), SHOW_ELEC_TYPE, STARTPOINT, unselect(), EVENTS::UnselectedEvent, KIGFX::VIEW::Update(), KIGFX::PREVIEW::SELECTION_AREA::ViewBBox(), TOOL_INTERACTIVE::Wait(), VECTOR2< T >::x, EDA_ITEM::XorFlags(), and VECTOR2< T >::y.

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 1531 of file ee_selection_tool.cpp.

{
 VECTOR2I cursorPos = getViewControls()->GetCursorPosition( false );
 
 SelectPoint( cursorPos, connectedTypes );
 
 return 0;
}

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 975 of file ee_selection_tool.cpp.

{
 EE_COLLECTOR collector;
 
 if( !CollectHits( collector, aWhere, aScanTypes ) )
 return false;
 
 narrowSelection( collector, aWhere, aCheckLocked, aSubtract );
 
 return selectPoint( collector, aWhere, aItem, aSelectionCancelledFlag, aAdd, aSubtract,
 aExclusiveOr );
}

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

Referenced by disambiguateCursor(), Main(), RequestSelection(), SelectNode(), 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 873 of file ee_selection_tool.cpp.

{
 m_selection.ClearReferencePoint();
 
 // If still more than one item we're going to have to ask the user.
 if( aCollector.GetCount() > 1 )
 {
 // Try to call selectionMenu via RunAction() to avoid event-loop contention
 // But it we cannot handle the event, then we don't have an active tool loop, so
 // handle it directly.
 if( !m_toolMgr->RunAction( EE_ACTIONS::selectionMenu, true, &aCollector ) )
 {
 if( !doSelectionMenu( &aCollector ) )
 aCollector.m_MenuCancelled = true;
 }
 
 if( aCollector.m_MenuCancelled )
 {
 if( aSelectionCancelledFlag )
 *aSelectionCancelledFlag = true;
 
 return false;
 }
 }
 
 if( !aAdd && !aSubtract && !aExclusiveOr )
 ClearSelection();
 
 int addedCount = 0;
 bool anySubtracted = false;
 
 if( aCollector.GetCount() > 0 )
 {
 for( int i = 0; i < aCollector.GetCount(); ++i )
 {
 EDA_ITEM_FLAGS flags = 0;
 bool isLine = aCollector[i]->Type() == SCH_LINE_T;
 
 // Handle line ends specially
 if( isLine )
 {
 SCH_LINE* line = (SCH_LINE*) aCollector[i];
 
 if( HitTestPoints( line->GetStartPoint(), aWhere, aCollector.m_Threshold ) )
 flags = STARTPOINT;
 else if( HitTestPoints( line->GetEndPoint(), aWhere, aCollector.m_Threshold ) )
 flags = ENDPOINT;
 else
 flags = STARTPOINT | ENDPOINT;
 }
 
  if( aSubtract
 || ( aExclusiveOr && aCollector[i]->IsSelected()
 && ( !isLine || ( isLine && aCollector[i]->HasFlag( flags ) ) ) ) )
 {
 aCollector[i]->ClearFlags( flags );
 
 // Need to update end shadows after ctrl-click unselecting one of two selected endpoints
 if( isLine )
 getView()->Update( aCollector[i] );
 
 if( !aCollector[i]->HasFlag( STARTPOINT ) && !aCollector[i]->HasFlag( ENDPOINT ) )
 {
 unselect( aCollector[i] );
 anySubtracted = true;
 }
 }
 else
 {
 aCollector[i]->SetFlags( flags );
 select( aCollector[i] );
 addedCount++;
 }
 }
 }
 
 if( addedCount == 1 )
 {
 m_toolMgr->ProcessEvent( EVENTS::PointSelectedEvent );
 
 if( aItem && aCollector.GetCount() == 1 )
 *aItem = aCollector[0];
 
 return true;
 }
 else if( addedCount > 1 )
 {
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 return true;
 }
 else if( anySubtracted )
 {
 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
 return true;
 }
 
 return false;
}

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

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

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

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

setModifiersState()

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

protectedinherited

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

Definition at line 48 of file selection_tool.cpp.

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

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

Referenced by 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 1973 of file ee_selection_tool.cpp.

{
 Go( &EE_SELECTION_TOOL::UpdateMenu, ACTIONS::updateMenu.MakeEvent() );
 
 Go( &EE_SELECTION_TOOL::Main, EE_ACTIONS::selectionActivate.MakeEvent() );
 Go( &EE_SELECTION_TOOL::SelectNode, EE_ACTIONS::selectNode.MakeEvent() );
 Go( &EE_SELECTION_TOOL::SelectConnection, EE_ACTIONS::selectConnection.MakeEvent() );
 Go( &EE_SELECTION_TOOL::ClearSelection, EE_ACTIONS::clearSelection.MakeEvent() );
 
 Go( &EE_SELECTION_TOOL::AddItemToSel, EE_ACTIONS::addItemToSel.MakeEvent() );
 Go( &EE_SELECTION_TOOL::AddItemsToSel, EE_ACTIONS::addItemsToSel.MakeEvent() );
 Go( &EE_SELECTION_TOOL::RemoveItemFromSel, EE_ACTIONS::removeItemFromSel.MakeEvent() );
 Go( &EE_SELECTION_TOOL::RemoveItemsFromSel, EE_ACTIONS::removeItemsFromSel.MakeEvent() );
 Go( &EE_SELECTION_TOOL::SelectionMenu, EE_ACTIONS::selectionMenu.MakeEvent() );
 
 Go( &EE_SELECTION_TOOL::SelectAll, EE_ACTIONS::selectAll.MakeEvent() );
 
 Go( &EE_SELECTION_TOOL::disambiguateCursor, EVENTS::DisambiguatePoint );
}

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
	)

Definition at line 1696 of file ee_selection_tool.cpp.

{
 SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
 
 if( !editFrame || m_isSymbolEditor || m_isSymbolViewer )
 return 0;
 
 if( targetSheetPath && targetSheetPath != editFrame->Schematic().CurrentSheet() )
 {
 editFrame->Schematic().SetCurrentSheet( *targetSheetPath );
 editFrame->DisplayCurrentSheet();
 }
 
 ClearSelection( items.size() > 0 ? true /*quiet mode*/ : false );
 
 // Perform individual selection of each item before processing the event.
 for( SCH_ITEM* item : items )
 select( item );
 
 BOX2I bbox = m_selection.GetBoundingBox();
 
 if( bbox.GetWidth() != 0 && bbox.GetHeight() != 0 )
 {
 if( m_frame->eeconfig()->m_CrossProbing.center_on_items )
 {
 if( m_frame->eeconfig()->m_CrossProbing.zoom_to_fit )
 ZoomFitCrossProbeBBox( bbox );
 
 editFrame->FocusOnItem( focusItem );
 
 if( !focusItem )
 editFrame->FocusOnLocation( bbox.Centre() );
 }
 }
 
 if( m_selection.Size() > 0 )
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 
 return 0;
}

References CROSS_PROBING_SETTINGS::center_on_items, BOX2< Vec >::Centre(), ClearSelection(), SCHEMATIC::CurrentSheet(), SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_BASE_FRAME::eeconfig(), SCH_EDIT_FRAME::FocusOnItem(), EDA_DRAW_FRAME::FocusOnLocation(), EE_SELECTION::GetBoundingBox(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetWidth(), APP_SETTINGS_BASE::m_CrossProbing, m_frame, m_isSymbolEditor, m_isSymbolViewer, m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SCH_EDIT_FRAME::Schematic(), select(), EVENTS::SelectedEvent, SCHEMATIC::SetCurrentSheet(), SELECTION::Size(), CROSS_PROBING_SETTINGS::zoom_to_fit, and ZoomFitCrossProbeBBox().

UnbrightenItem()

void SELECTION_TOOL::UnbrightenItem ( EDA_ITEM *  aItem )

inherited

Definition at line 213 of file selection_tool.cpp.

{
 unhighlight( aItem, BRIGHTENED );
}

References BRIGHTENED, and SELECTION_TOOL::unhighlight().

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

unhighlight()

void 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 1916 of file ee_selection_tool.cpp.

{
 KICAD_T itemType = aItem->Type();
 
 if( aMode == SELECTED )
 {
 aItem->ClearSelected();
 // Lines need endpoints cleared here
 if( aItem->Type() == SCH_LINE_T )
 aItem->ClearFlags( STARTPOINT | ENDPOINT );
 }
 else if( aMode == BRIGHTENED )
 aItem->ClearBrightened();
 
 if( aGroup )
 aGroup->Remove( aItem );
 
 // Unhighlight pins and fields. (All the other symbol children are currently only
 // represented in the LIB_SYMBOL.)
 if( SCH_ITEM* sch_item = dynamic_cast<SCH_ITEM*>( aItem ) )
 {
 sch_item->RunOnChildren(
 [&]( SCH_ITEM* aChild )
 {
 if( aMode == SELECTED )
 aChild->ClearSelected();
 else if( aMode == BRIGHTENED )
 aChild->ClearBrightened();
 } );
 }
 
 if( itemType == SCH_PIN_T || itemType == SCH_FIELD_T || itemType == SCH_SHEET_PIN_T )
 getView()->Update( aItem->GetParent() );
 else
 getView()->Update( aItem );
}

References BRIGHTENED, EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearFlags(), EDA_ITEM::ClearSelected(), ENDPOINT, EDA_ITEM::GetParent(), TOOL_BASE::getView(), SELECTION::Remove(), 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 1877 of file ee_selection_tool.cpp.

{
 unhighlight( aItem, SELECTED, &m_selection );
}

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.

{
 ACTION_MENU* actionMenu = aEvent.Parameter<ACTION_MENU*>();
 CONDITIONAL_MENU* conditionalMenu = dynamic_cast<CONDITIONAL_MENU*>( actionMenu );
 
 if( conditionalMenu )
 conditionalMenu->Evaluate( selection() );
 
 if( actionMenu )
 actionMenu->UpdateAll();
 
 return 0;
}

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 1241 of file ee_selection_tool.cpp.

{
 VECTOR2I refP( 0, 0 );
 
 if( m_selection.Size() > 0 )
 {
 if( m_isSymbolEditor )
 refP = static_cast<LIB_ITEM*>( m_selection.GetTopLeftItem() )->GetPosition();
 else
 refP = static_cast<SCH_ITEM*>( m_selection.GetTopLeftItem() )->GetPosition();
 }
 
 m_selection.SetReferencePoint( refP );
}

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.

{
 return m_toolMgr->ScheduleWait( this, aEventList );
}

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 1588 of file ee_selection_tool.cpp.

{
 if( aBBox.GetWidth() == 0 )
 return;
 
 BOX2I bbox = aBBox;
 bbox.Normalize();
 
 VECTOR2I bbSize = bbox.Inflate( bbox.GetWidth() * 0.2f ).GetSize();
 VECTOR2D screenSize = getView()->GetViewport().GetSize();
 
 // This code tries to come up with a zoom factor that doesn't simply zoom in
 // to the cross probed symbol, but instead shows a reasonable amount of the
 // circuit around it to provide context. This reduces or eliminates the need
 // to manually change the zoom because it's too close.
 
 // Using the default text height as a constant to compare against, use the
 // height of the bounding box of visible items for a footprint to figure out
 // if this is a big symbol (like a processor) or a small symbol (like a resistor).
 // This ratio is not useful by itself as a scaling factor. It must be "bent" to
 // provide good scaling at varying symbol sizes. Bigger symbols need less
 // scaling than small ones.
 double currTextHeight = schIUScale.MilsToIU( DEFAULT_TEXT_SIZE );
 
 double compRatio = bbSize.y / currTextHeight; // Ratio of symbol to text height
 double compRatioBent = 1.0;
 
 // LUT to scale zoom ratio to provide reasonable schematic context. Must work
 // with symbols of varying sizes (e.g. 0402 package and 200 pin BGA).
 // "first" is used as the input and "second" as the output
 //
 // "first" = compRatio (symbol height / default text height)
 // "second" = Amount to scale ratio by
 std::vector<std::pair<double, double>> lut{ { 1.25, 16 }, // 32
 { 2.5, 12 }, //24
 { 5, 8 }, // 16
 { 6, 6 }, //
 { 10, 4 }, //8
 { 20, 2 }, //4
 { 40, 1.5 }, // 2
 { 100, 1 } };
 
 std::vector<std::pair<double, double>>::iterator it;
 
 // Large symbol default is last LUT entry (1:1).
 compRatioBent = lut.back().second;
 
 // Use LUT to do linear interpolation of "compRatio" within "first", then
 // use that result to linearly interpolate "second" which gives the scaling
 // factor needed.
 if( compRatio >= lut.front().first )
 {
 for( it = lut.begin(); it < lut.end() - 1; it++ )
 {
 if( it->first <= compRatio && next( it )->first >= compRatio )
 {
 double diffx = compRatio - it->first;
 double diffn = next( it )->first - it->first;
 
 compRatioBent = it->second + ( next( it )->second - it->second ) * diffx / diffn;
 break; // We have our interpolated value
 }
 }
 }
 else
 {
 compRatioBent = lut.front().second; // Small symbol default is first entry
 }
 
 // This is similar to the original KiCad code that scaled the zoom to make sure
 // symbols were visible on screen. It's simply a ratio of screen size to
 // symbol size, and its job is to zoom in to make the component fullscreen.
 // Earlier in the code the symbol BBox is given a 20% margin to add some
 // breathing room. We compare the height of this enlarged symbol bbox to the
 // default text height. If a symbol will end up with the sides clipped, we
 // adjust later to make sure it fits on screen.
 screenSize.x = std::max( 10.0, screenSize.x );
 screenSize.y = std::max( 10.0, screenSize.y );
 double ratio = std::max( -1.0, fabs( bbSize.y / screenSize.y ) );
 
 // Original KiCad code for how much to scale the zoom
 double kicadRatio =
 std::max( fabs( bbSize.x / screenSize.x ), fabs( bbSize.y / screenSize.y ) );
 
 // If the width of the part we're probing is bigger than what the screen width
 // will be after the zoom, then punt and use the KiCad zoom algorithm since it
 // guarantees the part's width will be encompassed within the screen.
 if( bbSize.x > screenSize.x * ratio * compRatioBent )
 {
 // Use standard KiCad zoom for parts too wide to fit on screen/
 ratio = kicadRatio;
 compRatioBent = 1.0; // Reset so we don't modify the "KiCad" ratio
 wxLogTrace( "CROSS_PROBE_SCALE",
 "Part TOO WIDE for screen. Using normal KiCad zoom ratio: %1.5f", ratio );
 }
 
 // Now that "compRatioBent" holds our final scaling factor we apply it to the
 // original fullscreen zoom ratio to arrive at the final ratio itself.
 ratio *= compRatioBent;
 
 bool alwaysZoom = false; // DEBUG - allows us to minimize zooming or not
 
 // Try not to zoom on every cross-probe; it gets very noisy
 if( ( ratio < 0.5 || ratio > 1.0 ) || alwaysZoom )
 getView()->SetScale( getView()->GetScale() / ratio );
}

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 210 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 215 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), SCH_MOVE_TOOL::AlignElements(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), TOOL_BASE::attachManager(), SCH_EDIT_TOOL::AutoplaceFields(), autostartEvent(), SCH_EDIT_TOOL::BreakWire(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), SCH_EDITOR_CONTROL::ChangeLineMode(), SCH_EDIT_TOOL::ChangeTextType(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), GERBVIEW_CONTROL::ClearAllLayers(), SCH_EDITOR_CONTROL::ClearHighlight(), BOARD_INSPECTION_TOOL::ClearHighlight(), GERBVIEW_SELECTION_TOOL::clearSelection(), PL_SELECTION_TOOL::ClearSelection(), ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), SCH_EDIT_TOOL::ConvertDeMorgan(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), PL_EDIT_TOOL::Copy(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), MICROWAVE_TOOL::createInductorBetween(), EE_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), COMMON_TOOLS::CursorControl(), SCH_EDITOR_CONTROL::Cut(), SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::DeleteItems(), SCH_EDITOR_CONTROL::doCopy(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), SCH_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::doSyncSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), PCB_SELECTION_TOOL::EnterGroup(), GROUP_TOOL::EnterGroup(), SCH_NAVIGATE_TOOL::EnterSheet(), PAD_TOOL::EnumeratePads(), EE_INSPECTION_TOOL::ExcludeMarker(), PCB_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::expandConnection(), PAD_TOOL::explodePad(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), TOOL_BASE::GetManager(), TOOL_BASE::getModelInt(), DRAWING_TOOL::getSourceZoneForAction(), TOOL_BASE::getToolHolderInt(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_INTERACTIVE::goInternal(), PCB_SELECTION_TOOL::grabUnconnected(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), PCB_CONTROL::GridSetOrigin(), GROUP_TOOL::Group(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightItem(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PL_EDIT_TOOL::ImportDrawingSheetContent(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), EE_TOOL_BASE< T >::Init(), SCH_EDIT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_POINT_EDITOR::Init(), ROUTER_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), BOARD_REANNOTATE_TOOL::Init(), CONVERT_TOOL::Init(), DRAWING_TOOL::Init(), EDIT_TOOL::Init(), GLOBAL_EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_POINT_EDITOR::Init(), PCB_SELECTION_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), POSITION_RELATIVE_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), TOOL_BASE::IsToolActive(), GROUP_TOOL::LeaveGroup(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_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(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), SCH_EDITOR_CONTROL::NextLineMode(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), SELECTION_TOOL::onDisambiguationExpire(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), PCB_CONTROL::placeBoardItems(), 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(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDITOR_CONTROL::Redo(), SYMBOL_EDITOR_EDIT_TOOL::Redo(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem(), PCB_SELECTION_TOOL::RequestSelection(), RequestSelection(), EDA_3D_CONTROLLER::Reset(), COMMON_TOOLS::Reset(), PNS::TOOL_BASE::Reset(), PAD_TOOL::Reset(), COMMON_TOOLS::ResetLocalCoords(), TOOL_INTERACTIVE::resetTransitions(), SCH_EDITOR_CONTROL::Revert(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), TOOL_INTERACTIVE::RunMainStack(), DRC_TOOL::RunTests(), Selectable(), SelectAll(), PCB_SELECTION_TOOL::SelectAll(), SelectConnection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), GERBVIEW_SELECTION_TOOL::SelectItems(), selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectNet(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE::SetContextMenu(), EDA_3D_CONTROLLER::SetMaterial(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDIT_TOOL::Swap(), SyncSelection(), COMMON_TOOLS::ToggleCursor(), COMMON_TOOLS::ToggleCursorStyle(), EDA_3D_CONTROLLER::ToggleVisibility(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), SCH_MOVE_TOOL::trimDanglingLines(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_EDITOR_CONTROL::Undo(), SYMBOL_EDITOR_EDIT_TOOL::Undo(), GROUP_TOOL::Ungroup(), PCB_SELECTION_TOOL::unrouteSelected(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), EE_POINT_EDITOR::updateParentItem(), PNS::TOOL_BASE::updateStartItem(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), TOOL_INTERACTIVE::Wait(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), and BOARD_EDITOR_CONTROL::ZoneMerge().

m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Definition at line 214 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 207 of file tool_base.h.

Referenced by TOOL_BASE::GetType().

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:

• ee_selection_tool.h
• ee_selection_tool.cpp