KiCad PCB EDA Suite
EE_SELECTION_TOOL Class Reference

#include <ee_selection_tool.h>

Inheritance diagram for EE_SELECTION_TOOL:
TOOL_INTERACTIVE TOOL_BASE

Public Types

enum  RESET_REASON { RUN, MODEL_RELOAD, GAL_SWITCH }
 

Determines the reason of reset for a tool

More...
 

Public Member Functions

 EE_SELECTION_TOOL ()
 
 ~EE_SELECTION_TOOL ()
 
bool Init () override
 Function Init() Init() is called once upon a registration of the tool. More...
 
void Reset (RESET_REASON aReason) override
 Function Reset() Brings the tool to a known, initial state. More...
 
int UpdateMenu (const TOOL_EVENT &aEvent)
 
int Main (const TOOL_EVENT &aEvent)
 Function Main() More...
 
EE_SELECTIONGetSelection ()
 Function GetSelection() More...
 
EE_SELECTIONRequestSelection (const KICAD_T *aFilterList=EE_COLLECTOR::AllItems)
 Function RequestSelection() More...
 
EDA_ITEMSelectPoint (const VECTOR2I &aWhere, const KICAD_T *aFilterList=EE_COLLECTOR::AllItems, bool *aSelectionCancelledFlag=NULL, bool aCheckLocked=false, bool aAdd=false, bool aSubtract=false, bool aExclusiveOr=false)
 Function selectPoint() Selects an item pointed by the parameter aWhere. 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 BrightenItem (EDA_ITEM *aItem)
 
void UnbrightenItem (EDA_ITEM *aItem)
 
EDA_ITEMGetNode (VECTOR2I aPosition)
 

Find (but don't select) node under cursor

More...
 
int SelectNode (const TOOL_EVENT &aEvent)
 

Select node under cursor

More...
 
int SelectConnection (const TOOL_EVENT &aEvent)
 

If node selected then expand to connection, otherwise select connection under cursor

More...
 
int ClearSelection (const TOOL_EVENT &aEvent)
 

Clear current selection event handler.

More...
 
void ClearSelection ()
 
bool Selectable (const EDA_ITEM *aItem, bool checkVisibilityOnly=false) const
 Function Selectable() Checks 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...
 
int SelectionMenu (const TOOL_EVENT &aEvent)
 Function SelectionMenu() Shows a popup menu to trim the COLLECTOR passed as aEvent's parameter down to a single item. More...
 
void RebuildSelection ()
 Rebuilds the selection from the EDA_ITEMs' selection flags. More...
 
void Activate ()
 Function Activate() Runs the tool. More...
 
TOOL_MENUGetToolMenu ()
 
void SetContextMenu (ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
 Function SetContextMenu() More...
 
void RunMainStack (std::function< void()> aFunc)
 Function RunMainStack() More...
 
template<class T >
void Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
 Function Go() More...
 
TOOL_EVENTWait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
 Function Wait() More...
 
TOOL_TYPE GetType () const
 Function GetType() Returns the type of the tool. More...
 
TOOL_ID GetId () const
 Function GetId() Returns the unique identifier of the tool. More...
 
const std::string & GetName () const
 Function GetName() Returns the name of the tool. More...
 
TOOL_MANAGERGetManager () const
 Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool. More...
 
bool IsToolActive () const
 

Protected Member Functions

void attachManager (TOOL_MANAGER *aManager)
 Function attachManager() More...
 
KIGFX::VIEWgetView () const
 Function getView() More...
 
KIGFX::VIEW_CONTROLSgetViewControls () const
 Function getViewControls() More...
 
template<typename T >
T * getEditFrame () const
 Function getEditFrame() More...
 
template<typename T >
T * getModel () const
 Function getModel() More...
 

Protected Attributes

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

Stores the type of the tool.

More...
 
TOOL_ID m_toolId
 

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

More...
 
std::string m_toolName
 

Name of the tool.

More...
 
TOOL_MANAGERm_toolMgr
 

Private Member Functions

bool selectMultiple ()
 Function selectMultiple() Handles drawing a selection box that allows one to select many items at the same time. More...
 
bool doSelectionMenu (EE_COLLECTOR *aItems)
 Allows the selection of a single item from a list via pop-up menu. More...
 
void select (EDA_ITEM *aItem)
 Function select() Takes necessary action mark an item as selected. More...
 
void unselect (EDA_ITEM *aItem)
 Function unselect() Takes necessary action mark an item as unselected. More...
 
void highlight (EDA_ITEM *aItem, int aHighlightMode, EE_SELECTION *aGroup=nullptr)
 Function highlight() Highlights the item visually. More...
 
void unhighlight (EDA_ITEM *aItem, int aHighlightMode, EE_SELECTION *aGroup=nullptr)
 Function unhighlight() Unhighlights the item visually. More...
 
void updateReferencePoint ()
 Sets the reference point to the anchor of the top-left item. More...
 
bool selectionContains (const VECTOR2I &aPoint) const
 Function selectionContains() More...
 
void setTransitions () override
 

Sets up handlers for various events.

More...
 

Private Attributes

SCH_BASE_FRAMEm_frame
 
EE_SELECTION m_selection
 
bool m_additive
 
bool m_subtractive
 
bool m_exclusive_or
 
bool m_multiple
 
bool m_skip_heuristics
 
bool m_isLibEdit
 
bool m_isLibView
 
int m_unit
 
int m_convert
 

Detailed Description

Definition at line 57 of file ee_selection_tool.h.

Member Enumeration Documentation

◆ RESET_REASON

enum TOOL_BASE::RESET_REASON
inherited

Determines the reason of reset for a tool

Enumerator
RUN 

Tool is invoked after being inactive.

MODEL_RELOAD 

Model changes (required full reload)

GAL_SWITCH 

Rendering engine changes.

Definition at line 78 of file tool_base.h.

79  {
80  RUN,
81  MODEL_RELOAD,
82  GAL_SWITCH
83  };
Model changes (required full reload)
Definition: tool_base.h:81
Tool is invoked after being inactive.
Definition: tool_base.h:80
Rendering engine changes.
Definition: tool_base.h:82

Constructor & Destructor Documentation

◆ EE_SELECTION_TOOL()

EE_SELECTION_TOOL::EE_SELECTION_TOOL ( )

Definition at line 117 of file ee_selection_tool.cpp.

117  :
118  TOOL_INTERACTIVE( "eeschema.InteractiveSelection" ),
119  m_frame( nullptr ),
120  m_additive( false ),
121  m_subtractive( false ),
122  m_exclusive_or( false ),
123  m_multiple( false ),
124  m_skip_heuristics( false ),
125  m_isLibEdit( false ),
126  m_isLibView( false ),
127  m_unit( 0 ),
128  m_convert( 0 )
129 {
130 }
TOOL_INTERACTIVE(TOOL_ID aId, const std::string &aName)
Constructor.
SCH_BASE_FRAME * m_frame

◆ ~EE_SELECTION_TOOL()

EE_SELECTION_TOOL::~EE_SELECTION_TOOL ( )

Definition at line 133 of file ee_selection_tool.cpp.

134 {
135  getView()->Remove( &m_selection );
136 }
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:376
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
EE_SELECTION m_selection

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

Member Function Documentation

◆ Activate()

void TOOL_INTERACTIVE::Activate ( )
inherited

Function Activate() Runs the tool.

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

Definition at line 51 of file tool_interactive.cpp.

52 {
54 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
TOOL_ID m_toolId
Unique identifier for the tool, assigned by a TOOL_MANAGER instance.
Definition: tool_base.h:213
bool InvokeTool(TOOL_ID aToolId)
Function InvokeTool() Calls a tool by sending a tool activation event to tool of given ID.

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

Referenced by AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::copyToClipboard(), LIB_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), PCBNEW_CONTROL::DeleteItemCursor(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PCB_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EnumeratePads(), PCBNEW_CONTROL::GridSetOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PCB_INSPECTION_TOOL::HighlightNetTool(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_INSPECTION_TOOL::LocalRatsnestTool(), SCH_MOVE_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), EDIT_TOOL::Move(), LIB_TREE::onContextMenu(), POINT_EDITOR::OnSelectionChange(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), DRAWING_TOOL::SetAnchor(), DRC::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ AddItemsToSel() [1/2]

int EE_SELECTION_TOOL::AddItemsToSel ( const TOOL_EVENT aEvent)

Definition at line 880 of file ee_selection_tool.cpp.

881 {
882  AddItemsToSel( aEvent.Parameter<EDA_ITEMS*>(), false );
883  m_selection.SetIsHover( false );
884  return 0;
885 }
int AddItemsToSel(const TOOL_EVENT &aEvent)
void SetIsHover(bool aIsHover)
Definition: selection.h:65
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition: base_struct.h:603
T Parameter() const
Function Parameter() Returns a non-standard parameter assigned to the event.
Definition: tool_event.h:435
EE_SELECTION m_selection

References m_selection, TOOL_EVENT::Parameter(), and SELECTION::SetIsHover().

Referenced by SCH_MOVE_TOOL::Main(), and setTransitions().

◆ AddItemsToSel() [2/2]

void EE_SELECTION_TOOL::AddItemsToSel ( EDA_ITEMS aList,
bool  aQuietMode = false 
)

Definition at line 888 of file ee_selection_tool.cpp.

889 {
890  if( aList )
891  {
892  for( EDA_ITEM* item : *aList )
893  select( item );
894 
895  // Inform other potentially interested tools
896  if( !aQuietMode )
898  }
899 }
static const TOOL_EVENT SelectedEvent
Definition: actions.h:201
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
void select(EDA_ITEM *aItem)
Function select() Takes necessary action mark an item as selected.
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166

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

◆ AddItemToSel() [1/2]

int EE_SELECTION_TOOL::AddItemToSel ( const TOOL_EVENT aEvent)

◆ AddItemToSel() [2/2]

void EE_SELECTION_TOOL::AddItemToSel ( EDA_ITEM aItem,
bool  aQuietMode = false 
)

Definition at line 867 of file ee_selection_tool.cpp.

868 {
869  if( aItem )
870  {
871  select( aItem );
872 
873  // Inform other potentially interested tools
874  if( !aQuietMode )
876  }
877 }
static const TOOL_EVENT SelectedEvent
Definition: actions.h:201
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
void select(EDA_ITEM *aItem)
Function select() Takes necessary action mark an item as selected.
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).

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

◆ attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER aManager)
protectedinherited

Function attachManager()

Sets the TOOL_MANAGER the tool will belong to. Called by TOOL_MANAGER::RegisterTool()

Definition at line 60 of file tool_base.cpp.

61 {
62  m_toolMgr = aManager;
63 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

◆ BrightenItem()

void EE_SELECTION_TOOL::BrightenItem ( EDA_ITEM aItem)

Definition at line 945 of file ee_selection_tool.cpp.

946 {
947  highlight( aItem, BRIGHTENED );
948 }
void highlight(EDA_ITEM *aItem, int aHighlightMode, EE_SELECTION *aGroup=nullptr)
Function highlight() Highlights the item visually.
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143

References BRIGHTENED, and highlight().

Referenced by LIB_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ ClearSelection() [1/2]

int EE_SELECTION_TOOL::ClearSelection ( const TOOL_EVENT aEvent)

Clear current selection event handler.

Definition at line 957 of file ee_selection_tool.cpp.

958 {
959  ClearSelection();
960 
961  return 0;
962 }

References ClearSelection().

Referenced by SCH_EDITOR_CONTROL::FindNext(), LIB_EDIT_TOOL::Paste(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ ClearSelection() [2/2]

void EE_SELECTION_TOOL::ClearSelection ( )

Definition at line 1178 of file ee_selection_tool.cpp.

1179 {
1180  if( m_selection.Empty() )
1181  return;
1182 
1183  while( m_selection.GetSize() )
1185 
1186  getView()->Update( &m_selection );
1187 
1188  m_selection.SetIsHover( false );
1190 
1191  // Inform other potentially interested tools
1193 }
void ClearReferencePoint()
Definition: selection.h:249
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
void SetIsHover(bool aIsHover)
Definition: selection.h:65
#define SELECTED
Definition: base_struct.h:127
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
static const TOOL_EVENT ClearedEvent
Definition: actions.h:203
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1540
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
virtual unsigned int GetSize() const override
Function GetSize() Returns the number of stored items.
Definition: selection.h:99
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
EE_SELECTION m_selection
void unhighlight(EDA_ITEM *aItem, int aHighlightMode, EE_SELECTION *aGroup=nullptr)
Function unhighlight() Unhighlights the item visually.
EDA_ITEM * Front() const
Definition: selection.h:183

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

Referenced by ClearSelection(), Main(), RequestSelection(), Reset(), selectMultiple(), SelectPoint(), and setTransitions().

◆ doSelectionMenu()

bool EE_SELECTION_TOOL::doSelectionMenu ( EE_COLLECTOR aItems)
private

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

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

Returns
true if an item was picked

Definition at line 1036 of file ee_selection_tool.cpp.

1037 {
1038  EDA_ITEM* current = nullptr;
1039  ACTION_MENU menu( true );
1040 
1041  int limit = std::min( MAX_SELECT_ITEM_IDS, aCollector->GetCount() );
1042 
1043  for( int i = 0; i < limit; ++i )
1044  {
1045  wxString text;
1046  EDA_ITEM* item = ( *aCollector )[i];
1047  text = item->GetSelectMenuText( m_frame->GetUserUnits() );
1048 
1049  wxString menuText = wxString::Format("&%d. %s", i + 1, text );
1050  menu.Add( menuText, i + 1, item->GetMenuImage() );
1051  }
1052 
1053  if( aCollector->m_MenuTitle.Length() )
1054  menu.SetTitle( aCollector->m_MenuTitle );
1055 
1056  menu.SetIcon( info_xpm );
1057  menu.DisplayTitle( true );
1058  SetContextMenu( &menu, CMENU_NOW );
1059 
1060  while( TOOL_EVENT* evt = Wait() )
1061  {
1062  if( evt->Action() == TA_CHOICE_MENU_UPDATE )
1063  {
1064  if( current )
1065  unhighlight( current, BRIGHTENED );
1066 
1067  int id = *evt->GetCommandId();
1068 
1069  // User has pointed an item, so show it in a different way
1070  if( id > 0 && id <= limit )
1071  {
1072  current = ( *aCollector )[id - 1];
1073  highlight( current, BRIGHTENED );
1074  }
1075  else
1076  {
1077  current = nullptr;
1078  }
1079  }
1080  else if( evt->Action() == TA_CHOICE_MENU_CHOICE )
1081  {
1082  if( current )
1083  unhighlight( current, BRIGHTENED );
1084 
1085  OPT<int> id = evt->GetCommandId();
1086 
1087  // User has selected an item, so this one will be returned
1088  if( id && ( *id > 0 ) )
1089  current = ( *aCollector )[*id - 1];
1090  else
1091  current = nullptr;
1092 
1093  break;
1094  }
1095 
1096  getView()->UpdateItems();
1097  m_frame->GetCanvas()->Refresh();
1098  }
1099 
1100  if( current )
1101  {
1102  unhighlight( current, BRIGHTENED );
1103 
1104  getView()->UpdateItems();
1105  m_frame->GetCanvas()->Refresh();
1106 
1107  aCollector->Empty();
1108  aCollector->Append( current );
1109  return true;
1110  }
1111 
1112  return false;
1113 }
#define MAX_SELECT_ITEM_IDS
The maximum number of items in the clarify selection context menu.
Definition: eeschema_id.h:37
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
ACTION_MENU.
Definition: action_menu.h:43
void SetContextMenu(ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
Function SetContextMenu()
void highlight(EDA_ITEM *aItem, int aHighlightMode, EE_SELECTION *aGroup=nullptr)
Function highlight() Highlights the item visually.
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
TOOL_EVENT.
Definition: tool_event.h:171
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1421
const BITMAP_OPAQUE info_xpm[1]
Definition: info.cpp:75
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
SCH_BASE_FRAME * m_frame
virtual wxString GetSelectMenuText(EDA_UNITS aUnits) const
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
boost::optional< T > OPT
Definition: optional.h:7
virtual BITMAP_DEF GetMenuImage() const
Function GetMenuImage returns a pointer to an image to be used in menus.
void unhighlight(EDA_ITEM *aItem, int aHighlightMode, EE_SELECTION *aGroup=nullptr)
Function unhighlight() Unhighlights the item visually.
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

References ACTION_MENU::Add(), COLLECTOR::Append(), BRIGHTENED, CMENU_NOW, ACTION_MENU::DisplayTitle(), COLLECTOR::Empty(), Format(), SCH_BASE_FRAME::GetCanvas(), COLLECTOR::GetCount(), EDA_ITEM::GetMenuImage(), EDA_ITEM::GetSelectMenuText(), EDA_BASE_FRAME::GetUserUnits(), TOOL_BASE::getView(), highlight(), info_xpm, m_frame, COLLECTOR::m_MenuTitle, MAX_SELECT_ITEM_IDS, EDA_DRAW_PANEL_GAL::Refresh(), TOOL_INTERACTIVE::SetContextMenu(), ACTION_MENU::SetIcon(), ACTION_MENU::SetTitle(), TA_CHOICE_MENU_CHOICE, TA_CHOICE_MENU_UPDATE, unhighlight(), KIGFX::VIEW::UpdateItems(), and TOOL_INTERACTIVE::Wait().

Referenced by SelectionMenu().

◆ getEditFrame()

template<typename T >
T* TOOL_BASE::getEditFrame ( ) const
inlineprotectedinherited

Function getEditFrame()

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

Definition at line 186 of file tool_base.h.

187  {
188 #if !defined( QA_TEST ) // Dynamic casts give the linker a siezure in the test framework
189  wxASSERT( dynamic_cast<T*>( getEditFrameInt() ) );
190 #endif
191  return static_cast<T*>( getEditFrameInt() );
192  }
EDA_BASE_FRAME * getEditFrameInt() const
Definition: tool_base.cpp:48

References TOOL_BASE::getEditFrameInt().

Referenced by ZONE_CREATE_HELPER::createNewZone().

◆ GetId()

TOOL_ID TOOL_BASE::GetId ( ) const
inlineinherited

Function GetId() Returns the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns
Identifier of the tool.

Definition at line 120 of file tool_base.h.

121  {
122  return m_toolId;
123  }
TOOL_ID m_toolId
Unique identifier for the tool, assigned by a TOOL_MANAGER instance.
Definition: tool_base.h:213

References TOOL_BASE::m_toolId.

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

◆ GetManager()

TOOL_MANAGER* TOOL_BASE::GetManager ( ) const
inlineinherited

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

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

Definition at line 142 of file tool_base.h.

143  {
144  return m_toolMgr;
145  }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218

References TOOL_BASE::m_toolMgr.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), PCB_TOOL_BASE::doInteractiveItemPlacement(), ACTION_MENU::getToolManager(), LIB_TREE::onContextMenu(), ZONE_CREATE_HELPER::OnFirstPoint(), ACTION_MENU::OnMenuEvent(), and ZONE_CREATE_HELPER::performZoneCutout().

◆ getModel()

template<typename T >
T* TOOL_BASE::getModel ( ) const
inlineprotectedinherited

Function getModel()

Returns the model object if it matches the requested type.

Definition at line 200 of file tool_base.h.

201  {
202  EDA_ITEM* m = getModelInt();
203 #if !defined( QA_TEST ) // Dynamic casts give the linker a siezure in the test framework
204  wxASSERT( dynamic_cast<T*>( m ) );
205 #endif
206  return static_cast<T*>( m );
207  }
EDA_ITEM * getModelInt() const
Definition: tool_base.cpp:54
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166

References TOOL_BASE::getModelInt().

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

◆ GetName()

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

Function GetName() Returns the name of the tool.

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

Returns
The name of the tool.

Definition at line 131 of file tool_base.h.

132  {
133  return m_toolName;
134  }
std::string m_toolName
Name of the tool.
Definition: tool_base.h:217

References TOOL_BASE::m_toolName.

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

◆ GetNode()

EDA_ITEM * EE_SELECTION_TOOL::GetNode ( VECTOR2I  aPosition)

Find (but don't select) node under cursor

Definition at line 804 of file ee_selection_tool.cpp.

805 {
806  EE_COLLECTOR collector;
807 
808  //TODO(snh): Reimplement after exposing KNN interface
809  int thresholdMax = KiROUND( getView()->ToWorld( HITTEST_THRESHOLD_PIXELS ) );
810 
811  for( int threshold : { 0, thresholdMax/2, thresholdMax } )
812  {
813  collector.m_Threshold = threshold;
814  collector.Collect( m_frame->GetScreen(), nodeTypes, (wxPoint) aPosition );
815 
816  if( collector.GetCount() > 0 )
817  break;
818  }
819 
820  return collector.GetCount() ? collector[ 0 ] : nullptr;
821 }
int m_Threshold
Definition: collector.h:66
void Collect(SCH_SCREEN *aScreen, const KICAD_T aFilterList[], const wxPoint &aPos, int aUnit=0, int aConvert=0)
Function Collect scans a EDA_ITEM using this class's Inspector method, which does the collection.
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
#define HITTEST_THRESHOLD_PIXELS
EE_COLLECTOR.
Definition: ee_collectors.h:39
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:100
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
static KICAD_T nodeTypes[]
SCH_BASE_FRAME * m_frame
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61

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

◆ GetSelection()

◆ GetToolMenu()

◆ GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const
inlineinherited

Function GetType() Returns the type of the tool.

Returns
The type of the tool.

Definition at line 109 of file tool_base.h.

110  {
111  return m_type;
112  }
TOOL_TYPE m_type
Stores the type of the tool.
Definition: tool_base.h:210

References TOOL_BASE::m_type.

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

◆ getView()

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

Function getView()

Returns the instance of VIEW object used in the application. It allows tools to draw.

Returns
The instance of VIEW.

Definition at line 36 of file tool_base.cpp.

37 {
38  return m_toolMgr->GetView();
39 }
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:280
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218

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(), ClearSelection(), COMMON_TOOLS::CursorControl(), LIB_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), PCBNEW_CONTROL::DeleteItemCursor(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), MICROWAVE_TOOL::drawMicrowaveInductor(), PCB_EDITOR_CONTROL::DrillOrigin(), LIB_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), GetNode(), ROUTER_TOOL::getStartLayer(), COMMON_TOOLS::GridPreset(), PCBNEW_CONTROL::GridResetOrigin(), PCBNEW_CONTROL::GridSetOrigin(), SELECTION_TOOL::GuessSelectionCandidates(), highlight(), SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), PNS::TOOL_BASE::highlightNet(), PCB_INSPECTION_TOOL::highlightNet(), EE_POINT_EDITOR::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), PNS::TOOL_BASE::pickSingleItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Remove(), PCB_EDITOR_CONTROL::Reset(), PNS::TOOL_BASE::Reset(), PCBNEW_CONTROL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), DRAWING_TOOL::Reset(), Reset(), SELECTION_TOOL::Reset(), EE_TOOL_BASE< SCH_BASE_FRAME >::Reset(), SCH_EDIT_TOOL::Rotate(), GERBVIEW_SELECTION_TOOL::select(), GERBVIEW_SELECTION_TOOL::selectable(), SELECTION_TOOL::Selectable(), selectionContains(), SELECTION_TOOL::selectionContains(), selectMultiple(), SELECTION_TOOL::selectMultiple(), SelectPoint(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), COMMON_TOOLS::ToggleGrid(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), unhighlight(), SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), GERBVIEW_SELECTION_TOOL::unselectVisually(), EE_POINT_EDITOR::updateEditedPoint(), POINT_EDITOR::updateEditedPoint(), SCH_EDITOR_CONTROL::UpdateFind(), PCBNEW_CONTROL::updateGrid(), EE_POINT_EDITOR::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_TOOL_BASE::view(), COMMON_TOOLS::ZoomFitScreen(), SELECTION_TOOL::zoomFitSelection(), ~EE_SELECTION_TOOL(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), and SELECTION_TOOL::~SELECTION_TOOL().

◆ getViewControls()

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

Function getViewControls()

Returns the instance of VIEW_CONTROLS object used in the application. It allows tools to read & modify user input and its settings (eg. show cursor, enable snapping to grid, etc.)

Returns
The instance of VIEW_CONTROLS.

Definition at line 42 of file tool_base.cpp.

43 {
44  return m_toolMgr->GetViewControls();
45 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
KIGFX::VIEW_CONTROLS * GetViewControls() const
Definition: tool_manager.h:285

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

Referenced by EE_POINT_EDITOR::addCorner(), POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), SCH_EDIT_TOOL::BreakWire(), PCB_TOOL_BASE::controls(), COMMON_TOOLS::CursorControl(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomToPreset(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), LIB_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), COMMON_TOOLS::GridPreset(), PCB_INSPECTION_TOOL::HighlightNet(), SCH_EDITOR_CONTROL::HighlightNet(), PCB_INSPECTION_TOOL::HighlightNetTool(), MODULE_EDITOR_TOOLS::ImportFootprint(), SCH_MOVE_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), EDIT_TOOL::Move(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), LIB_DRAWING_TOOLS::PlaceAnchor(), PCBNEW_CONTROL::placeBoardItems(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), SCH_EDIT_TOOL::RepeatDrawItem(), RequestSelection(), POINT_EDITOR::Reset(), DRAWING_TOOL::Reset(), COMMON_TOOLS::ResetLocalCoords(), GERBVIEW_SELECTION_TOOL::selectCursor(), SELECTION_TOOL::selectCursor(), selectMultiple(), SELECTION_TOOL::selectMultiple(), SelectNode(), ZOOM_TOOL::selectRegion(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), PCBNEW_PICKER_TOOL::setControls(), EE_POINT_EDITOR::setEditedPoint(), POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), EE_POINT_EDITOR::updateEditedPoint(), POINT_EDITOR::updateEditedPoint(), LIB_MOVE_TOOL::updateModificationPoint(), EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

◆ Go()

template<class T >
void TOOL_INTERACTIVE::Go ( int(T::*)(const TOOL_EVENT &)  aStateFunc,
const TOOL_EVENT_LIST aConditions = TOOL_EVENTTC_ANYTA_ANY ) 
)
inherited

Function Go()

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

Definition at line 129 of file tool_interactive.h.

131 {
132  TOOL_STATE_FUNC sptr = std::bind( aStateFunc, static_cast<T*>( this ), std::placeholders::_1 );
133 
134  goInternal( sptr, aConditions );
135 }
std::function< int(const TOOL_EVENT &)> TOOL_STATE_FUNC
Definition: tool_base.h:57
void goInternal(TOOL_STATE_FUNC &aState, const TOOL_EVENT_LIST &aConditions)

References TOOL_INTERACTIVE::goInternal().

Referenced by LENGTH_TUNER_TOOL::setTransitions(), ZOOM_TOOL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), MICROWAVE_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_CONTROL::setTransitions(), LIB_PIN_TOOL::setTransitions(), PAD_TOOL::setTransitions(), EE_INSPECTION_TOOL::setTransitions(), ZONE_FILLER_TOOL::setTransitions(), LIB_DRAWING_TOOLS::setTransitions(), EE_POINT_EDITOR::setTransitions(), COMMON_CONTROL::setTransitions(), SCH_MOVE_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), LIB_MOVE_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), SCH_DRAWING_TOOLS::setTransitions(), POINT_EDITOR::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), EDA_3D_VIEWER_CONTROL::setTransitions(), LIB_EDIT_TOOL::setTransitions(), LIB_CONTROL::setTransitions(), SCH_EDIT_TOOL::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), COMMON_TOOLS::setTransitions(), PCB_INSPECTION_TOOL::setTransitions(), PCBNEW_CONTROL::setTransitions(), ALIGN_DISTRIBUTE_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::setTransitions(), MODULE_EDITOR_TOOLS::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), PCBNEW_PICKER_TOOL::setTransitions(), PICKER_TOOL::setTransitions(), PCB_EDITOR_CONTROL::setTransitions(), DRAWING_TOOL::setTransitions(), EDIT_TOOL::setTransitions(), SELECTION_TOOL::setTransitions(), SCH_EDITOR_CONTROL::setTransitions(), DRC::setTransitions(), and setTransitions().

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

520 {
521  // There are certain parent/child and enclosure combinations that can be handled
522  // automatically.
523 
524  // Prefer exact hits to sloppy ones
525  int exactHits = 0;
526 
527  for( int i = collector.GetCount() - 1; i >= 0; --i )
528  {
529  EDA_ITEM* item = collector[ i ];
530 
531  if( item->HitTest( (wxPoint) aPos, 0 ) )
532  exactHits++;
533  }
534 
535  if( exactHits > 0 && exactHits < collector.GetCount() )
536  {
537  for( int i = collector.GetCount() - 1; i >= 0; --i )
538  {
539  EDA_ITEM* item = collector[ i ];
540 
541  if( !item->HitTest( (wxPoint) aPos, 0 ) )
542  collector.Remove( item );
543  }
544  }
545 
546  // Prefer a non-sheet to a sheet
547  for( int i = 0; collector.GetCount() == 2 && i < 2; ++i )
548  {
549  EDA_ITEM* item = collector[ i ];
550  EDA_ITEM* other = collector[ ( i + 1 ) % 2 ];
551 
552  if( item->Type() != SCH_SHEET_T && other->Type() == SCH_SHEET_T )
553  collector.Remove( other );
554  }
555 
556  // Prefer a symbol to a pin or the opposite, when both a symbol and a pin are selected
557  // We need to be able to select only a pin:
558  // - to display its characteristics (especially if an ERC is attached to the pin)
559  // - for cross probing, to select the corresponding pad.
560  // Note also the case happens only in schematic editor. In symbol editor, the symbol
561  // itself is never selected
562  for( int i = 0; collector.GetCount() == 2 && i < 2; ++i )
563  {
564  EDA_ITEM* item = collector[ i ];
565  EDA_ITEM* other = collector[ ( i + 1 ) % 2 ];
566 
567  if( item->Type() == SCH_COMPONENT_T && other->Type() == SCH_PIN_T )
568  {
570  collector.Remove( other );
571  else
572  collector.Remove( item );
573  }
574  }
575 
576  // Prefer a field to a symbol
577  for( int i = 0; collector.GetCount() == 2 && i < 2; ++i )
578  {
579  EDA_ITEM* item = collector[ i ];
580  EDA_ITEM* other = collector[ ( i + 1 ) % 2 ];
581 
582  if( item->Type() == SCH_FIELD_T && other->Type() == SCH_COMPONENT_T )
583  collector.Remove( other );
584  }
585 
586  // No need for multiple wires at a single point; if there's a junction select that;
587  // otherwise any of the wires will do
588  bool junction = false;
589  bool wiresOnly = true;
590 
591  for( EDA_ITEM* item : collector )
592  {
593  if( item->Type() == SCH_JUNCTION_T )
594  junction = true;
595  else if( item->Type() != SCH_LINE_T )
596  wiresOnly = false;
597  }
598 
599  if( wiresOnly )
600  {
601  for( int j = collector.GetCount() - 1; j >= 0; --j )
602  {
603  if( junction && collector[ j ]->Type() != SCH_JUNCTION_T )
604  collector.Remove( j );
605  else if( !junction && j > 0 )
606  collector.Remove( j );
607  }
608  }
609 }
virtual bool GetSelectPinSelectSymbol() const
Allow some frames to select the parent symbol when trying to select a pin.
void Remove(int aIndex)
Function Remove removes the item at aIndex (first position is 0);.
Definition: collector.h:129
virtual bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
Definition: base_struct.h:332
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:100
SCH_BASE_FRAME * m_frame
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

References COLLECTOR::GetCount(), SCH_BASE_FRAME::GetSelectPinSelectSymbol(), EDA_ITEM::HitTest(), m_frame, COLLECTOR::Remove(), SCH_COMPONENT_T, SCH_FIELD_T, SCH_JUNCTION_T, SCH_LINE_T, SCH_PIN_T, SCH_SHEET_T, and EDA_ITEM::Type().

Referenced by LIB_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), and SelectPoint().

◆ highlight()

void EE_SELECTION_TOOL::highlight ( EDA_ITEM aItem,
int  aHighlightMode,
EE_SELECTION aGroup = nullptr 
)
private

Function highlight() Highlights the item visually.

Parameters
aItemis an item to be be highlighted.
aHighlightModeshould be either SELECTED or BRIGHTENED
aGroupis the group to add the item to in the BRIGHTENED mode.

Definition at line 1208 of file ee_selection_tool.cpp.

1209 {
1210  KICAD_T itemType = aItem->Type();
1211 
1212  if( aMode == SELECTED )
1213  aItem->SetSelected();
1214  else if( aMode == BRIGHTENED )
1215  aItem->SetBrightened();
1216 
1217  if( aGroup )
1218  aGroup->Add( aItem );
1219 
1220  // Highlight pins and fields. (All the other component children are currently only
1221  // represented in the LIB_PART and will inherit the settings of the parent component.)
1222  if( itemType == SCH_COMPONENT_T )
1223  {
1224  SCH_PIN_PTRS pins = static_cast<SCH_COMPONENT*>( aItem )->GetSchPins( g_CurrentSheet );
1225 
1226  for( SCH_PIN* pin : pins )
1227  {
1228  if( aMode == SELECTED )
1229  pin->SetSelected();
1230  else if( aMode == BRIGHTENED )
1231  pin->SetBrightened();
1232  }
1233 
1234  for( SCH_FIELD* field : static_cast<SCH_COMPONENT*>( aItem )->GetFields() )
1235  {
1236  if( aMode == SELECTED )
1237  field->SetSelected();
1238  else if( aMode == BRIGHTENED )
1239  field->SetBrightened();
1240  }
1241  }
1242  else if( itemType == SCH_SHEET_T )
1243  {
1244  for( SCH_FIELD& field : static_cast<SCH_SHEET*>( aItem )->GetFields() )
1245  {
1246  if( aMode == SELECTED )
1247  field.SetSelected();
1248  else if( aMode == BRIGHTENED )
1249  field.SetBrightened();
1250  }
1251 
1252  for( SCH_SHEET_PIN* pin : static_cast<SCH_SHEET*>( aItem )->GetPins() )
1253  {
1254  if( aMode == SELECTED )
1255  pin->SetSelected();
1256  else if( aMode == BRIGHTENED )
1257  pin->SetBrightened();
1258  }
1259  }
1260 
1261  if( itemType == SCH_PIN_T || itemType == SCH_FIELD_T || itemType == SCH_SHEET_PIN_T )
1262  getView()->Update( aItem->GetParent() );
1263  else
1264  getView()->Update( aItem );
1265 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
std::vector< SCH_PIN * > SCH_PIN_PTRS
Definition: sch_component.h:73
void SetBrightened()
Definition: base_struct.h:233
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
virtual void Add(EDA_ITEM *aItem)
Definition: selection.h:75
#define SELECTED
Definition: base_struct.h:127
SCH_SHEET_PATH * g_CurrentSheet
With the new connectivity algorithm, many more places than before want to know what the current sheet...
void SetSelected()
Definition: base_struct.h:231
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
EDA_ITEM * GetParent() const
Definition: base_struct.h:217
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1540
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

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

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

◆ Init()

bool EE_SELECTION_TOOL::Init ( )
overridevirtual

Function Init() 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 140 of file ee_selection_tool.cpp.

141 {
142  m_frame = getEditFrame<SCH_BASE_FRAME>();
143 
144  LIB_VIEW_FRAME* libViewFrame = dynamic_cast<LIB_VIEW_FRAME*>( m_frame );
145  LIB_EDIT_FRAME* libEditFrame = dynamic_cast<LIB_EDIT_FRAME*>( m_frame );
146 
147  if( libEditFrame )
148  {
149  m_isLibEdit = true;
150  m_unit = libEditFrame->GetUnit();
151  m_convert = libEditFrame->GetConvert();
152  }
153  else
154  m_isLibView = libViewFrame != nullptr;
155 
156 
157  static KICAD_T wireOrBusTypes[] = { SCH_LINE_LOCATE_WIRE_T, SCH_LINE_LOCATE_BUS_T, EOT };
158 
159  auto wireSelection = E_C::MoreThan( 0 ) && E_C::OnlyType( SCH_LINE_LOCATE_WIRE_T );
160  auto busSelection = E_C::MoreThan( 0 ) && E_C::OnlyType( SCH_LINE_LOCATE_BUS_T );
161  auto wireOrBusSelection = E_C::MoreThan( 0 ) && E_C::OnlyTypes( wireOrBusTypes );
162  auto sheetSelection = E_C::Count( 1 ) && E_C::OnlyType( SCH_SHEET_T );
163  auto schEditCondition = [this] ( const SELECTION& aSel ) {
164  return !m_isLibEdit && !m_isLibView;
165  };
166  auto belowRootSheetCondition = [this] ( const SELECTION& aSel ) {
168  };
169  auto havePartCondition = [ this ] ( const SELECTION& sel ) {
170  return m_isLibEdit && ( (LIB_EDIT_FRAME*) m_frame )->GetCurPart();
171  };
172 
173  auto& menu = m_menu.GetMenu();
174 
175  menu.AddItem( EE_ACTIONS::enterSheet, sheetSelection && EE_CONDITIONS::Idle, 1 );
176  menu.AddItem( EE_ACTIONS::explicitCrossProbe, sheetSelection && EE_CONDITIONS::Idle, 1 );
177  menu.AddItem( EE_ACTIONS::leaveSheet, belowRootSheetCondition, 1 );
178 
179  menu.AddSeparator( 100 );
180  menu.AddItem( EE_ACTIONS::drawWire, schEditCondition && EE_CONDITIONS::Empty, 100 );
181  menu.AddItem( EE_ACTIONS::drawBus, schEditCondition && EE_CONDITIONS::Empty, 100 );
182 
183  menu.AddSeparator( 100 );
185 
186  menu.AddSeparator( 100 );
188 
189  menu.AddSeparator( 200 );
190  menu.AddItem( EE_ACTIONS::selectConnection, wireOrBusSelection && EE_CONDITIONS::Idle, 250 );
191  menu.AddItem( EE_ACTIONS::placeJunction, wireOrBusSelection && EE_CONDITIONS::Idle, 250 );
192  menu.AddItem( EE_ACTIONS::placeLabel, wireOrBusSelection && EE_CONDITIONS::Idle, 250 );
193  menu.AddItem( EE_ACTIONS::placeGlobalLabel, wireOrBusSelection && EE_CONDITIONS::Idle, 250 );
194  menu.AddItem( EE_ACTIONS::placeHierLabel, wireOrBusSelection && EE_CONDITIONS::Idle, 250 );
195  menu.AddItem( EE_ACTIONS::breakWire, wireSelection && EE_CONDITIONS::Idle, 250 );
196  menu.AddItem( EE_ACTIONS::breakBus, busSelection && EE_CONDITIONS::Idle, 250 );
197  menu.AddItem( EE_ACTIONS::importSheetPin, sheetSelection && EE_CONDITIONS::Idle, 250 );
198 
199  menu.AddSeparator( 400 );
200  menu.AddItem( EE_ACTIONS::symbolProperties, havePartCondition && EE_CONDITIONS::Empty, 400 );
201  menu.AddItem( EE_ACTIONS::pinTable, havePartCondition && EE_CONDITIONS::Empty, 400 );
202 
203  menu.AddSeparator( 1000 );
205 
206  return true;
207 }
static TOOL_ACTION pinTable
Definition: ee_actions.h:149
void AddStandardSubMenus(TOOL_MENU &aMenu)
Function CreateBasicMenu.
TOOL_MENU m_menu
functions below are not yet implemented - their interface may change
static bool IsDrawingWire(const SELECTION &aSelection)
static TOOL_ACTION breakBus
Definition: ee_actions.h:138
int GetConvert() const
SCH_SHEET * Last() const
Function Last returns a pointer to the last sheet of the list One can see the others sheet as the "pa...
static SELECTION_CONDITION MoreThan(int aNumber)
Function MoreThan Creates a functor that tests if the number of selected items is greater than the va...
static SELECTION_CONDITION OnlyTypes(const KICAD_T aTypes[])
Function OnlyTypes Creates a functor that tests if the selected items are only of given types.
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
static TOOL_ACTION placeHierLabel
Definition: ee_actions.h:90
static TOOL_ACTION placeJunction
Definition: ee_actions.h:85
static TOOL_ACTION selectConnection
If current selection is a wire or bus, expand to entire connection.
Definition: ee_actions.h:55
static SELECTION_CONDITION Idle
static SELECTION_CONDITION Count(int aNumber)
Function Count Creates a functor that tests if the number of selected items is equal to the value giv...
Symbol library viewer main window.
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
static TOOL_ACTION breakWire
Definition: ee_actions.h:137
static TOOL_ACTION leaveSheet
Definition: ee_actions.h:177
int GetUnit() const
static SELECTION_CONDITION Empty
SCH_SHEET_PATH * g_CurrentSheet
With the new connectivity algorithm, many more places than before want to know what the current sheet...
static TOOL_ACTION drawWire
Definition: ee_actions.h:81
static TOOL_ACTION explicitCrossProbe
Definition: ee_actions.h:186
static TOOL_ACTION symbolProperties
Definition: ee_actions.h:148
static TOOL_ACTION importSheetPin
Definition: ee_actions.h:93
static bool IsDrawingBus(const SELECTION &aSelection)
static TOOL_ACTION drawBus
Definition: ee_actions.h:82
static TOOL_ACTION placeLabel
Definition: ee_actions.h:88
The symbol library editor main window.
SCH_BASE_FRAME * m_frame
static SELECTION_CONDITION OnlyType(KICAD_T aType)
Function OnlyType Creates a functor that tests if the selected items are only of given type.
static TOOL_ACTION enterSheet
Definition: ee_actions.h:176
SCH_SHEET * g_RootSheet
static TOOL_ACTION placeGlobalLabel
Definition: ee_actions.h:89
static TOOL_ACTION finishBus
Definition: ee_actions.h:99
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Function AddItem()
static TOOL_ACTION finishWire
Definition: ee_actions.h:98

References CONDITIONAL_MENU::AddItem(), EDA_DRAW_FRAME::AddStandardSubMenus(), EE_ACTIONS::breakBus, EE_ACTIONS::breakWire, SELECTION_CONDITIONS::Count(), EE_ACTIONS::drawBus, EE_ACTIONS::drawWire, EE_CONDITIONS::Empty, EE_ACTIONS::enterSheet, EOT, EE_ACTIONS::explicitCrossProbe, EE_ACTIONS::finishBus, EE_ACTIONS::finishWire, g_CurrentSheet, g_RootSheet, LIB_EDIT_FRAME::GetConvert(), TOOL_MENU::GetMenu(), LIB_EDIT_FRAME::GetUnit(), EE_CONDITIONS::Idle, EE_ACTIONS::importSheetPin, SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_SHEET_PATH::Last(), EE_ACTIONS::leaveSheet, m_convert, m_frame, m_isLibEdit, m_isLibView, TOOL_INTERACTIVE::m_menu, m_unit, SELECTION_CONDITIONS::MoreThan(), SELECTION_CONDITIONS::OnlyType(), SELECTION_CONDITIONS::OnlyTypes(), EE_ACTIONS::pinTable, EE_ACTIONS::placeGlobalLabel, EE_ACTIONS::placeHierLabel, EE_ACTIONS::placeJunction, EE_ACTIONS::placeLabel, SCH_LINE_LOCATE_BUS_T, SCH_LINE_LOCATE_WIRE_T, SCH_SHEET_T, EE_ACTIONS::selectConnection, and EE_ACTIONS::symbolProperties.

◆ IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const
inherited

Definition at line 31 of file tool_base.cpp.

32 {
33  return m_toolMgr->IsToolActive( m_toolId );
34 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
TOOL_ID m_toolId
Unique identifier for the tool, assigned by a TOOL_MANAGER instance.
Definition: tool_base.h:213
bool IsToolActive(TOOL_ID aId) const
Function IsToolActive() Returns true if a tool with given id is active (executing)

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

◆ Main()

int EE_SELECTION_TOOL::Main ( const TOOL_EVENT aEvent)

Function Main()

The main loop.

Definition at line 258 of file ee_selection_tool.cpp.

259 {
260  const KICAD_T movableItems[] =
261  {
262  SCH_MARKER_T,
267  SCH_LINE_T,
268  SCH_BITMAP_T,
269  SCH_TEXT_T,
270  SCH_LABEL_T,
273  SCH_FIELD_T,
276  SCH_SHEET_T,
277  EOT
278  };
279 
280  // Main loop: keep receiving events
281  while( TOOL_EVENT* evt = Wait() )
282  {
283  if( m_frame->ToolStackIsEmpty() )
284  m_frame->GetCanvas()->SetCurrentCursor( wxCURSOR_ARROW );
285 
287 
288  if( evt->Modifier( MD_SHIFT ) && evt->Modifier( MD_CTRL ) )
289  m_subtractive = true;
290  else if( evt->Modifier( MD_SHIFT ) )
291  m_additive = true;
292  else if( evt->Modifier( MD_CTRL ) )
293  m_exclusive_or = true;
294 
295  // Is the user requesting that the selection list include all possible
296  // items without removing less likely selection candidates
297  m_skip_heuristics = !!evt->Modifier( MD_ALT );
298 
299  // Single click? Select single object
300  if( evt->IsClick( BUT_LEFT ) )
301  {
302  m_frame->FocusOnItem( nullptr );
303 
304  SelectPoint( evt->Position(), EE_COLLECTOR::AllItems, nullptr, false,
306  }
307 
308  // right click? if there is any object - show the context menu
309  else if( evt->IsClick( BUT_RIGHT ) )
310  {
311  bool selectionCancelled = false;
312 
313  if( m_selection.Empty() ||
314  !m_selection.GetBoundingBox().Contains( wxPoint( evt->Position() ) ) )
315  {
316  ClearSelection();
317  SelectPoint( evt->Position(), EE_COLLECTOR::AllItems, &selectionCancelled );
318  m_selection.SetIsHover( true );
319  }
320 
321  if( !selectionCancelled )
323  }
324 
325  // double click? Display the properties window
326  else if( evt->IsDblClick( BUT_LEFT ) )
327  {
328  m_frame->FocusOnItem( nullptr );
329 
330  if( m_selection.Empty() )
331  SelectPoint( evt->Position());
332 
333  EDA_ITEM* item = m_selection.Front();
334 
335  if( item && item->Type() == SCH_SHEET_T )
337  else
339  }
340 
341  // drag with LMB? Select multiple objects (or at least draw a selection box) or drag them
342  else if( evt->IsDrag( BUT_LEFT ) )
343  {
344  m_frame->FocusOnItem( nullptr );
345 
347  {
348  selectMultiple();
349  }
350  else
351  {
352  // selection is empty? try to start dragging the item under the point where drag
353  // started
354  if( m_selection.Empty() )
355  m_selection = RequestSelection( movableItems );
356 
357  // Check if dragging has started within any of selected items bounding box
358  if( selectionContains( evt->Position() ) )
359  {
360  // Yes -> run the move tool and wait till it finishes
361  m_toolMgr->InvokeTool( "eeschema.InteractiveMove" );
362  }
363  else
364  {
365  // No -> drag a selection box
366  selectMultiple();
367  }
368  }
369  }
370 
371  // context sub-menu selection? Handle unit selection or bus unfolding
372  else if( evt->Category() == TC_COMMAND && evt->Action() == TA_CHOICE_MENU_CHOICE )
373  {
374  if( evt->GetCommandId().get() >= ID_POPUP_SCH_SELECT_UNIT_CMP
375  && evt->GetCommandId().get() <= ID_POPUP_SCH_SELECT_UNIT_CMP_MAX )
376  {
377  SCH_COMPONENT* component = dynamic_cast<SCH_COMPONENT*>( m_selection.Front() );
378  int unit = evt->GetCommandId().get() - ID_POPUP_SCH_SELECT_UNIT_CMP;
379 
380  if( component )
381  static_cast<SCH_EDIT_FRAME*>( m_frame )->SelectUnit( component, unit );
382  }
383  else if( evt->GetCommandId().get() >= ID_POPUP_SCH_UNFOLD_BUS
384  && evt->GetCommandId().get() <= ID_POPUP_SCH_UNFOLD_BUS_END )
385  {
386  wxString* net = new wxString( *evt->Parameter<wxString*>() );
388  }
389 
390  }
391 
392  else if( evt->IsCancelInteractive() )
393  {
394  m_frame->FocusOnItem( nullptr );
395 
396  ClearSelection();
397  }
398 
399  else if( evt->Action() == TA_UNDO_REDO_PRE )
400  {
401  m_frame->FocusOnItem( nullptr );
402 
403  ClearSelection();
404  }
405 
406  else
407  evt->SetPassEvent();
408  }
409 
410  return 0;
411 }
static TOOL_ACTION properties
Definition: ee_actions.h:122
TOOL_MENU m_menu
functions below are not yet implemented - their interface may change
bool selectionContains(const VECTOR2I &aPoint) const
Function selectionContains()
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
void SetCurrentCursor(wxStockCursor aStockCursorID)
Function SetCurrentCursor Set the current cursor shape for this panel.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
bool selectMultiple()
Function selectMultiple() Handles drawing a selection box that allows one to select many items at the...
static TOOL_ACTION unfoldBus
Definition: ee_actions.h:83
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:139
bool Contains(const wxPoint &aPoint) const
Function Contains.
bool InvokeTool(TOOL_ID aToolId)
Function InvokeTool() Calls a tool by sending a tool activation event to tool of given ID.
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
void SetIsHover(bool aIsHover)
Definition: selection.h:65
EE_SELECTION & RequestSelection(const KICAD_T *aFilterList=EE_COLLECTOR::AllItems)
Function RequestSelection()
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
TOOL_EVENT.
Definition: tool_event.h:171
void FocusOnItem(SCH_ITEM *aItem)
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
bool ToolStackIsEmpty()
SCH_BASE_FRAME * m_frame
static const KICAD_T AllItems[]
Definition: ee_collectors.h:42
SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:99
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
static TOOL_ACTION enterSheet
Definition: ee_actions.h:176
EDA_ITEM * SelectPoint(const VECTOR2I &aWhere, const KICAD_T *aFilterList=EE_COLLECTOR::AllItems, bool *aSelectionCancelledFlag=NULL, bool aCheckLocked=false, bool aAdd=false, bool aSubtract=false, bool aExclusiveOr=false)
Function selectPoint() Selects an item pointed by the parameter aWhere.
EE_SELECTION m_selection
EDA_RECT GetBoundingBox() const
Definition: selection.h:155
void ShowContextMenu(SELECTION &aSelection)
Function ShowContextMenu.
Definition: tool_menu.cpp:59
bool GetDragSelects() const
Indicates that a drag should draw a selection rectangle, even when started over an item.
EDA_ITEM * Front() const
Definition: selection.h:183
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

References EE_COLLECTOR::AllItems, BUT_LEFT, BUT_RIGHT, ClearSelection(), EDA_RECT::Contains(), SELECTION::Empty(), EE_ACTIONS::enterSheet, EOT, SCH_BASE_FRAME::FocusOnItem(), SELECTION::Front(), SELECTION::GetBoundingBox(), SCH_BASE_FRAME::GetCanvas(), EDA_BASE_FRAME::GetDragSelects(), ID_POPUP_SCH_SELECT_UNIT_CMP, ID_POPUP_SCH_SELECT_UNIT_CMP_MAX, ID_POPUP_SCH_UNFOLD_BUS, ID_POPUP_SCH_UNFOLD_BUS_END, TOOL_MANAGER::InvokeTool(), m_additive, m_exclusive_or, m_frame, TOOL_INTERACTIVE::m_menu, m_selection, m_skip_heuristics, m_subtractive, TOOL_BASE::m_toolMgr, MD_ALT, MD_CTRL, MD_SHIFT, EE_ACTIONS::properties, RequestSelection(), TOOL_MANAGER::RunAction(), SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_COMPONENT_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_MARKER_T, SCH_NO_CONNECT_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_TEXT_T, selectionContains(), selectMultiple(), SelectPoint(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), SELECTION::SetIsHover(), TOOL_MENU::ShowContextMenu(), TA_CHOICE_MENU_CHOICE, TA_UNDO_REDO_PRE, TC_COMMAND, EDA_BASE_FRAME::ToolStackIsEmpty(), EDA_ITEM::Type(), EE_ACTIONS::unfoldBus, and TOOL_INTERACTIVE::Wait().

Referenced by setTransitions().

◆ RebuildSelection()

void EE_SELECTION_TOOL::RebuildSelection ( )

Rebuilds the selection from the EDA_ITEMs' selection flags.

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

Definition at line 965 of file ee_selection_tool.cpp.

966 {
967  m_selection.Clear();
968 
969  if( m_isLibEdit )
970  {
971  LIB_PART* start = static_cast<LIB_EDIT_FRAME*>( m_frame )->GetCurPart();
972 
973  for( LIB_ITEM& item : start->GetDrawItems() )
974  {
975  if( item.IsSelected() )
976  select( static_cast<EDA_ITEM*>( &item ) );
977  }
978  }
979  else
980  {
981  for( auto item : m_frame->GetScreen()->Items() )
982  {
983  // If the field and component are selected, only use the component
984  if( item->IsSelected() )
985  {
986  select( item );
987  }
988  else
989  {
990  if( item->Type() == SCH_COMPONENT_T )
991  {
992  for( SCH_FIELD* field : static_cast<SCH_COMPONENT*>( item )->GetFields() )
993  {
994  if( field->IsSelected() )
995  select( field );
996  }
997  }
998 
999  if( item->Type() == SCH_SHEET_T )
1000  {
1001  for( SCH_FIELD& field : static_cast<SCH_SHEET*>( item )->GetFields() )
1002  {
1003  if( field.IsSelected() )
1004  select( &field );
1005  }
1006 
1007  for( SCH_SHEET_PIN* pin : static_cast<SCH_SHEET*>( item )->GetPins() )
1008  {
1009  if( pin->IsSelected() )
1010  select( pin );
1011  }
1012  }
1013 
1014  }
1015  }
1016  }
1017 
1019 
1020  // Inform other potentially interested tools
1022 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
static const TOOL_EVENT SelectedEvent
Definition: actions.h:201
virtual void Clear() override
Function Clear() Removes all the stored items from the group.
Definition: selection.h:94
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void select(EDA_ITEM *aItem)
Function select() Takes necessary action mark an item as selected.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:60
void updateReferencePoint()
Sets the reference point to the anchor of the top-left item.
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
LIB_ITEMS_CONTAINER & GetDrawItems()
Return a reference to the draw item list.
Define a library symbol object.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
SCH_BASE_FRAME * m_frame
EE_RTREE & Items()
Definition: sch_screen.h:127
EE_SELECTION m_selection

References SELECTION::Clear(), LIB_PART::GetDrawItems(), SCH_BASE_FRAME::GetScreen(), SCH_SCREEN::Items(), m_frame, m_isLibEdit, m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SCH_COMPONENT_T, SCH_SHEET_T, select(), EVENTS::SelectedEvent, and updateReferencePoint().

Referenced by SCH_MOVE_TOOL::Main(), LIB_EDIT_TOOL::Paste(), SCH_EDIT_FRAME::PutDataInPreviousState(), LIB_EDIT_TOOL::Redo(), SCH_EDITOR_CONTROL::Redo(), LIB_EDIT_FRAME::RollbackPartFromUndo(), LIB_EDIT_TOOL::Undo(), and SCH_EDITOR_CONTROL::Undo().

◆ RemoveItemFromSel() [1/2]

int EE_SELECTION_TOOL::RemoveItemFromSel ( const TOOL_EVENT aEvent)

Definition at line 902 of file ee_selection_tool.cpp.

903 {
904  RemoveItemFromSel( aEvent.Parameter<EDA_ITEM*>() );
905  m_selection.SetIsHover( false );
906  return 0;
907 }
void SetIsHover(bool aIsHover)
Definition: selection.h:65
T Parameter() const
Function Parameter() Returns a non-standard parameter assigned to the event.
Definition: tool_event.h:435
int RemoveItemFromSel(const TOOL_EVENT &aEvent)
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
EE_SELECTION m_selection

References m_selection, TOOL_EVENT::Parameter(), and SELECTION::SetIsHover().

Referenced by SCH_EDIT_FRAME::DeleteJunction(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_EDIT_FRAME::SchematicCleanUp(), and setTransitions().

◆ RemoveItemFromSel() [2/2]

void EE_SELECTION_TOOL::RemoveItemFromSel ( EDA_ITEM aItem,
bool  aQuietMode = false 
)

Definition at line 910 of file ee_selection_tool.cpp.

911 {
912  if( aItem )
913  {
914  unselect( aItem );
915 
916  // Inform other potentially interested tools
917  if( !aQuietMode )
919  }
920 }
static const TOOL_EVENT UnselectedEvent
Definition: actions.h:202
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
void unselect(EDA_ITEM *aItem)
Function unselect() Takes necessary action mark an item as unselected.

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

◆ RemoveItemsFromSel() [1/2]

int EE_SELECTION_TOOL::RemoveItemsFromSel ( const TOOL_EVENT aEvent)

Definition at line 923 of file ee_selection_tool.cpp.

924 {
925  RemoveItemsFromSel( aEvent.Parameter<EDA_ITEMS*>(), false );
926  m_selection.SetIsHover( false );
927  return 0;
928 }
void SetIsHover(bool aIsHover)
Definition: selection.h:65
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition: base_struct.h:603
T Parameter() const
Function Parameter() Returns a non-standard parameter assigned to the event.
Definition: tool_event.h:435
int RemoveItemsFromSel(const TOOL_EVENT &aEvent)
EE_SELECTION m_selection

References m_selection, TOOL_EVENT::Parameter(), and SELECTION::SetIsHover().

Referenced by SCH_MOVE_TOOL::Main(), and setTransitions().

◆ RemoveItemsFromSel() [2/2]

void EE_SELECTION_TOOL::RemoveItemsFromSel ( EDA_ITEMS aList,
bool  aQuietMode = false 
)

Definition at line 931 of file ee_selection_tool.cpp.

932 {
933  if( aList )
934  {
935  for( EDA_ITEM* item : *aList )
936  unselect( item );
937 
938  // Inform other potentially interested tools
939  if( !aQuietMode )
941  }
942 }
static const TOOL_EVENT UnselectedEvent
Definition: actions.h:202
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
void unselect(EDA_ITEM *aItem)
Function unselect() Takes necessary action mark an item as unselected.
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166

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

◆ RequestSelection()

EE_SELECTION & EE_SELECTION_TOOL::RequestSelection ( const KICAD_T aFilterList = EE_COLLECTOR::AllItems)

Function RequestSelection()

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

Definition at line 612 of file ee_selection_tool.cpp.

613 {
614  if( m_selection.Empty() )
615  {
616  VECTOR2D cursorPos = getViewControls()->GetCursorPosition( true );
617 
618  ClearSelection();
619  SelectPoint( cursorPos, aFilterList );
620  m_selection.SetIsHover( true );
622  }
623  else // Trim an existing selection by aFilterList
624  {
625  for( int i = (int) m_selection.GetSize() - 1; i >= 0; --i )
626  {
627  EDA_ITEM* item = (EDA_ITEM*) m_selection.GetItem( i );
628 
629  if( !item->IsType( aFilterList ) )
630  {
631  unselect( item );
633  }
634  }
635  }
636 
638 
639  return m_selection;
640 }
void ClearReferencePoint()
Definition: selection.h:249
static const TOOL_EVENT UnselectedEvent
Definition: actions.h:202
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
void SetIsHover(bool aIsHover)
Definition: selection.h:65
void updateReferencePoint()
Sets the reference point to the anchor of the top-left item.
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
virtual bool IsType(const KICAD_T aScanTypes[]) const
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:286
virtual KIGFX::VIEW_ITEM * GetItem(unsigned int aIdx) const override
Definition: selection.h:104
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
virtual unsigned int GetSize() const override
Function GetSize() Returns the number of stored items.
Definition: selection.h:99
void unselect(EDA_ITEM *aItem)
Function unselect() Takes necessary action mark an item as unselected.
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:42
EDA_ITEM * SelectPoint(const VECTOR2I &aWhere, const KICAD_T *aFilterList=EE_COLLECTOR::AllItems, bool *aSelectionCancelledFlag=NULL, bool aCheckLocked=false, bool aAdd=false, bool aSubtract=false, bool aExclusiveOr=false)
Function selectPoint() Selects an item pointed by the parameter aWhere.
EE_SELECTION m_selection
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.

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_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::CleanupSheetPins(), SCH_EDIT_TOOL::ConvertDeMorgan(), LIB_EDIT_TOOL::Copy(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), LIB_EDIT_TOOL::DoDelete(), SCH_EDIT_TOOL::DoDelete(), LIB_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_EDITOR_CONTROL::EnterSheet(), SCH_MOVE_TOOL::Main(), LIB_MOVE_TOOL::Main(), Main(), LIB_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), LIB_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), SelectConnection(), EE_INSPECTION_TOOL::ShowDatasheet(), and BUS_UNFOLD_MENU::update().

◆ Reset()

void EE_SELECTION_TOOL::Reset ( RESET_REASON  aReason)
overridevirtual

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

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

Parameters
aReasoncontains information about the reason of tool reset.

Implements TOOL_BASE.

Definition at line 210 of file ee_selection_tool.cpp.

211 {
212  m_frame = getEditFrame<SCH_BASE_FRAME>();
213 
214  if( aReason == TOOL_BASE::MODEL_RELOAD )
215  {
216  // Remove pointers to the selected items from containers without changing their
217  // properties (as they are already deleted while a new sheet is loaded)
218  m_selection.Clear();
219  getView()->GetPainter()->GetSettings()->SetHighlight( false );
220 
221  LIB_EDIT_FRAME* libEditFrame = dynamic_cast<LIB_EDIT_FRAME*>( m_frame );
222  LIB_VIEW_FRAME* libViewFrame = dynamic_cast<LIB_VIEW_FRAME*>( m_frame );
223 
224  if( libEditFrame )
225  {
226  m_isLibEdit = true;
227  m_unit = libEditFrame->GetUnit();
228  m_convert = libEditFrame->GetConvert();
229  }
230  else
231  m_isLibView = libViewFrame != nullptr;
232  }
233  else
234  // Restore previous properties of selected items and remove them from containers
235  ClearSelection();
236 
237  // Reinsert the VIEW_GROUP, in case it was removed from the VIEW
238  getView()->Remove( &m_selection );
239  getView()->Add( &m_selection );
240 }
virtual void Clear() override
Function Clear() Removes all the stored items from the group.
Definition: selection.h:94
int GetConvert() const
Model changes (required full reload)
Definition: tool_base.h:81
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:376
Symbol library viewer main window.
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
int GetUnit() const
void SetHighlight(bool aEnabled, int aNetcode=-1, bool aHighlightItems=false)
Function SetHighlight Turns on/off highlighting - it may be done for the active layer,...
Definition: painter.h:136
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
The symbol library editor main window.
SCH_BASE_FRAME * m_frame
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346
EE_SELECTION m_selection

References KIGFX::VIEW::Add(), SELECTION::Clear(), ClearSelection(), LIB_EDIT_FRAME::GetConvert(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), LIB_EDIT_FRAME::GetUnit(), TOOL_BASE::getView(), m_convert, m_frame, m_isLibEdit, m_isLibView, m_selection, m_unit, TOOL_BASE::MODEL_RELOAD, KIGFX::VIEW::Remove(), and KIGFX::RENDER_SETTINGS::SetHighlight().

◆ RunMainStack()

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

Function RunMainStack()

Calls a function using the main stack.

Parameters
aFuncis the function to be calls.

Definition at line 87 of file tool_interactive.cpp.

88 {
89  m_toolMgr->RunMainStack( this, std::move( aFunc ) );
90 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
void RunMainStack(TOOL_BASE *aTool, std::function< void()> aFunc)

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

Referenced by DRAWING_TOOL::PlaceText().

◆ select()

void EE_SELECTION_TOOL::select ( EDA_ITEM aItem)
private

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

Parameters
aItemis an item to be selected.

Definition at line 1196 of file ee_selection_tool.cpp.

1197 {
1198  highlight( aItem, SELECTED, &m_selection );
1199 }
#define SELECTED
Definition: base_struct.h:127
void highlight(EDA_ITEM *aItem, int aHighlightMode, EE_SELECTION *aGroup=nullptr)
Function highlight() Highlights the item visually.
EE_SELECTION m_selection

References highlight(), m_selection, and SELECTED.

Referenced by AddItemsToSel(), AddItemToSel(), RebuildSelection(), SelectConnection(), selectMultiple(), and SelectPoint().

◆ Selectable()

bool EE_SELECTION_TOOL::Selectable ( const EDA_ITEM aItem,
bool  checkVisibilityOnly = false 
) const

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

Returns
True if the item fulfills conditions to be selected.

Definition at line 1116 of file ee_selection_tool.cpp.

1117 {
1118  // NOTE: in the future this is where eeschema layer/itemtype visibility will be handled
1119  LIB_EDIT_FRAME* symbeditFrame = dynamic_cast< LIB_EDIT_FRAME* >( m_frame );
1120 
1121  switch( aItem->Type() )
1122  {
1123  case SCH_PIN_T:
1124  if( !static_cast<const SCH_PIN*>( aItem )->IsVisible() && !m_frame->GetShowAllPins() )
1125  return false;
1126  break;
1127 
1128  case LIB_PART_T: // In libedit we do not want to select the symbol itself.
1129  return false;
1130 
1131  case LIB_FIELD_T:
1132  {
1133  if( symbeditFrame )
1134  {
1135  LIB_PART* currentPart = symbeditFrame->GetCurPart();
1136 
1137  // Nothing in derived symbols is editable at the moment.
1138  if( currentPart && currentPart->IsAlias() )
1139  return false;
1140  }
1141 
1142  break;
1143  }
1144 
1145  case LIB_ARC_T:
1146  case LIB_CIRCLE_T:
1147  case LIB_TEXT_T:
1148  case LIB_RECTANGLE_T:
1149  case LIB_POLYLINE_T:
1150  case LIB_BEZIER_T:
1151  case LIB_PIN_T:
1152  {
1153  if( symbeditFrame )
1154  {
1155  LIB_ITEM* lib_item = (LIB_ITEM*) aItem;
1156 
1157  if( lib_item->GetUnit() && lib_item->GetUnit() != symbeditFrame->GetUnit() )
1158  return false;
1159 
1160  if( lib_item->GetConvert() && lib_item->GetConvert() != symbeditFrame->GetConvert() )
1161  return false;
1162  }
1163 
1164  break;
1165  }
1166 
1167  case SCH_MARKER_T: // Always selectable
1168  return true;
1169 
1170  default: // Suppress warnings
1171  break;
1172  }
1173 
1174  return true;
1175 }
int GetConvert() const
LIB_PART * GetCurPart()
Return the current part being edited or NULL if none selected.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:60
int GetUnit() const
Definition: lib_item.h:309
int GetUnit() const
Define a library symbol object.
int GetConvert() const
Definition: lib_item.h:312
The symbol library editor main window.
virtual bool GetShowAllPins() const
Allow some frames to show/hide hidden pins.
SCH_BASE_FRAME * m_frame
bool IsAlias() const
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

References LIB_EDIT_FRAME::GetConvert(), LIB_ITEM::GetConvert(), LIB_EDIT_FRAME::GetCurPart(), SCH_BASE_FRAME::GetShowAllPins(), LIB_EDIT_FRAME::GetUnit(), LIB_ITEM::GetUnit(), LIB_PART::IsAlias(), LIB_ARC_T, LIB_BEZIER_T, LIB_CIRCLE_T, LIB_FIELD_T, LIB_PART_T, LIB_PIN_T, LIB_POLYLINE_T, LIB_RECTANGLE_T, LIB_TEXT_T, m_frame, SCH_MARKER_T, SCH_PIN_T, and EDA_ITEM::Type().

Referenced by LIB_EDIT_TOOL::DeleteItemCursor(), selectMultiple(), and SelectPoint().

◆ SelectConnection()

int EE_SELECTION_TOOL::SelectConnection ( const TOOL_EVENT aEvent)

If node selected then expand to connection, otherwise select connection under cursor

Definition at line 834 of file ee_selection_tool.cpp.

835 {
836  static KICAD_T wiresAndBusses[] = { SCH_LINE_LOCATE_WIRE_T, SCH_LINE_LOCATE_BUS_T, EOT };
837 
838  RequestSelection( wiresAndBusses );
839 
840  if( m_selection.Empty() )
841  return 0;
842 
843  SCH_LINE* line = (SCH_LINE*) m_selection.Front();
844  EDA_ITEMS items;
845 
847  auto conns = m_frame->GetScreen()->MarkConnections( line );
848 
849  for( auto item : conns )
850  select( item );
851 
852  if( m_selection.GetSize() > 1 )
854 
855  return 0;
856 }
static const TOOL_EVENT SelectedEvent
Definition: actions.h:201
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void select(EDA_ITEM *aItem)
Function select() Takes necessary action mark an item as selected.
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
EE_SELECTION & RequestSelection(const KICAD_T *aFilterList=EE_COLLECTOR::AllItems)
Function RequestSelection()
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition: base_struct.h:603
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
virtual unsigned int GetSize() const override
Function GetSize() Returns the number of stored items.
Definition: selection.h:99
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:38
SCH_BASE_FRAME * m_frame
void ClearDrawingState()
Clear the state flags of all the items in the screen.
Definition: sch_screen.cpp:642
EE_SELECTION m_selection
EDA_ITEM * Front() const
Definition: selection.h:183
std::set< SCH_ITEM * > MarkConnections(SCH_LINE *aSegment)
Return all wires and junctions connected to aSegment which are not connected any component pin.
Definition: sch_screen.cpp:289

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

Referenced by setTransitions().

◆ selectionContains()

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

Function selectionContains()

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

Definition at line 1328 of file ee_selection_tool.cpp.

1329 {
1330  const unsigned GRIP_MARGIN = 20;
1331  VECTOR2I margin = getView()->ToWorld( VECTOR2I( GRIP_MARGIN, GRIP_MARGIN ), false );
1332 
1333  // Check if the point is located within any of the currently selected items bounding boxes
1334  for( auto item : m_selection )
1335  {
1336  BOX2I itemBox = item->ViewBBox();
1337  itemBox.Inflate( margin.x, margin.y ); // Give some margin for gripping an item
1338 
1339  if( itemBox.Contains( aPoint ) )
1340  return true;
1341  }
1342 
1343  return false;
1344 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:475
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
bool Contains(const Vec &aPoint) const
Function Contains.
Definition: box2.h:150
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:301
EE_SELECTION m_selection

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

Referenced by Main().

◆ SelectionMenu()

int EE_SELECTION_TOOL::SelectionMenu ( const TOOL_EVENT aEvent)

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

NOTE: this routine DOES NOT modify the selection.

Definition at line 1025 of file ee_selection_tool.cpp.

1026 {
1027  EE_COLLECTOR* collector = aEvent.Parameter<EE_COLLECTOR*>();
1028 
1029  if( !doSelectionMenu( collector ) )
1030  collector->m_MenuCancelled = true;
1031 
1032  return 0;
1033 }
EE_COLLECTOR.
Definition: ee_collectors.h:39
bool m_MenuCancelled
Definition: collector.h:69
T Parameter() const
Function Parameter() Returns a non-standard parameter assigned to the event.
Definition: tool_event.h:435
bool doSelectionMenu(EE_COLLECTOR *aItems)
Allows the selection of a single item from a list via pop-up menu.

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

Referenced by setTransitions().

◆ selectMultiple()

bool EE_SELECTION_TOOL::selectMultiple ( )
private

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

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

Definition at line 659 of file ee_selection_tool.cpp.

660 {
661  bool cancelled = false; // Was the tool cancelled while it was running?
662  m_multiple = true; // Multiple selection mode is active
663  KIGFX::VIEW* view = getView();
664 
666  view->Add( &area );
667 
668  while( TOOL_EVENT* evt = Wait() )
669  {
670  if( evt->IsCancelInteractive() || evt->IsActivate() )
671  {
672  cancelled = true;
673  break;
674  }
675 
676  if( evt->IsDrag( BUT_LEFT ) )
677  {
679  ClearSelection();
680 
681  // Start drawing a selection box
682  area.SetOrigin( evt->DragOrigin() );
683  area.SetEnd( evt->Position() );
684  area.SetAdditive( m_additive );
687 
688  view->SetVisible( &area, true );
689  view->Update( &area );
690  getViewControls()->SetAutoPan( true );
691  }
692 
693  if( evt->IsMouseUp( BUT_LEFT ) )
694  {
695  getViewControls()->SetAutoPan( false );
696 
697  // End drawing the selection box
698  view->SetVisible( &area, false );
699 
700  // Mark items within the selection box as selected
701  std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> selectedItems;
702  std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> sheetPins;
703 
704  // Filter the view items based on the selection box
705  BOX2I selectionBox = area.ViewBBox();
706  view->Query( selectionBox, selectedItems ); // Get the list of selected items
707 
708  // Sheet pins aren't in the view; add them by hand
709  for( KIGFX::VIEW::LAYER_ITEM_PAIR& pair : selectedItems )
710  {
711  SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>( pair.first );
712 
713  if( sheet )
714  {
715  int layer = pair.second;
716 
717  for( SCH_SHEET_PIN* pin : sheet->GetPins() )
718  sheetPins.emplace_back( KIGFX::VIEW::LAYER_ITEM_PAIR( pin, layer ) );
719  }
720  }
721 
722  selectedItems.insert( selectedItems.end(), sheetPins.begin(), sheetPins.end() );
723 
724  int width = area.GetEnd().x - area.GetOrigin().x;
725  int height = area.GetEnd().y - area.GetOrigin().y;
726 
727  /* Selection mode depends on direction of drag-selection:
728  * Left > Right : Select objects that are fully enclosed by selection
729  * Right > Left : Select objects that are crossed by selection
730  */
731  bool windowSelection = width >= 0;
732  bool anyAdded = false;
733  bool anySubtracted = false;
734 
735  if( view->IsMirroredX() )
736  windowSelection = !windowSelection;
737 
738  // Construct an EDA_RECT to determine EDA_ITEM selection
739  EDA_RECT selectionRect( (wxPoint) area.GetOrigin(), wxSize( width, height ) );
740 
741  selectionRect.Normalize();
742 
743  for( KIGFX::VIEW::LAYER_ITEM_PAIR& pair : selectedItems )
744  {
745  EDA_ITEM* item = dynamic_cast<EDA_ITEM*>( pair.first );
746 
747  if( item && Selectable( item ) && item->HitTest( selectionRect, windowSelection ) )
748  {
749  if( m_subtractive || ( m_exclusive_or && item->IsSelected() ) )
750  {
751  unselect( item );
752  anySubtracted = true;
753  }
754  else
755  {
756  select( item );
757  item->SetFlags( STARTPOINT | ENDPOINT );
758  anyAdded = true;
759  }
760  }
761  }
762 
763  m_selection.SetIsHover( false );
764 
765  // Inform other potentially interested tools
766  if( anyAdded )
768 
769  if( anySubtracted )
771 
772  break; // Stop waiting for events
773  }
774  }
775 
776  getViewControls()->SetAutoPan( false );
777 
778  // Stop drawing the selection box
779  view->Remove( &area );
780  m_multiple = false; // Multiple selection mode is inactive
781 
782  if( !cancelled )
784 
785  return cancelled;
786 }
void ClearReferencePoint()
Definition: selection.h:249
static const TOOL_EVENT SelectedEvent
Definition: actions.h:201
void SetEnd(VECTOR2I aEnd)
Set the current end of the rectangle (the corner that moves with the cursor.
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
bool IsSelected() const
Definition: base_struct.h:225
static const TOOL_EVENT UnselectedEvent
Definition: actions.h:202
void SetOrigin(VECTOR2I aOrigin)
Set the origin of the rectange (the fixed corner)
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:376
void SetExclusiveOr(bool aExclusiveOr)
bool Selectable(const EDA_ITEM *aItem, bool checkVisibilityOnly=false) const
Function Selectable() Checks conditions for an item to be selected.
void select(EDA_ITEM *aItem)
Function select() Takes necessary action mark an item as selected.
void SetIsHover(bool aIsHover)
Definition: selection.h:65
void SetAdditive(bool aAdditive)
virtual bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
Definition: base_struct.h:332
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:257
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
TOOL_EVENT.
Definition: tool_event.h:171
const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1540
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
virtual void SetAutoPan(bool aEnabled)
Function SetAutoPan Turns on/off auto panning (this feature is used when there is a tool active (eg.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:215
bool IsMirroredX() const
Function IsMirroredX() Returns true if view is flipped across the X axis.
Definition: view.h:230
void SetSubtractive(bool aSubtractive)
std::vector< SCH_SHEET_PIN * > & GetPins()
Definition: sch_sheet.h:357
void Normalize()
Function Normalize ensures that the height ant width are positive.
void unselect(EDA_ITEM *aItem)
Function unselect() Takes necessary action mark an item as unselected.
std::pair< VIEW_ITEM *, int > LAYER_ITEM_PAIR
Definition: view.h:66
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Sets the item visibility.
Definition: view.cpp:1486
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346
virtual int Query(const BOX2I &aRect, std::vector< LAYER_ITEM_PAIR > &aResult) const
Function Query() Finds all visible items that touch or are within the rectangle aRect.
Definition: view.cpp:452
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:42
VIEW.
Definition: view.h:61
EE_SELECTION m_selection
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125

References KIGFX::VIEW::Add(), BUT_LEFT, SELECTION::ClearReferencePoint(), ClearSelection(), ENDPOINT, KIGFX::PREVIEW::SELECTION_AREA::GetEnd(), KIGFX::PREVIEW::SELECTION_AREA::GetOrigin(), SCH_SHEET::GetPins(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), EDA_ITEM::HitTest(), KIGFX::VIEW::IsMirroredX(), EDA_ITEM::IsSelected(), m_additive, m_exclusive_or, m_multiple, m_selection, m_subtractive, TOOL_BASE::m_toolMgr, EDA_RECT::Normalize(), TOOL_MANAGER::ProcessEvent(), KIGFX::VIEW::Query(), KIGFX::VIEW::Remove(), select(), Selectable(), EVENTS::SelectedEvent, KIGFX::PREVIEW::SELECTION_AREA::SetAdditive(), KIGFX::VIEW_CONTROLS::SetAutoPan(), 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(), STARTPOINT, unselect(), EVENTS::UnselectedEvent, KIGFX::VIEW::Update(), KIGFX::PREVIEW::SELECTION_AREA::ViewBBox(), TOOL_INTERACTIVE::Wait(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Main().

◆ SelectNode()

int EE_SELECTION_TOOL::SelectNode ( const TOOL_EVENT aEvent)

Select node under cursor

Definition at line 824 of file ee_selection_tool.cpp.

825 {
826  VECTOR2I cursorPos = getViewControls()->GetCursorPosition( !aEvent.Modifier( MD_ALT ) );
827 
828  SelectPoint( cursorPos, nodeTypes );
829 
830  return 0;
831 }
int Modifier(int aMask=MD_MODIFIER_MASK) const
Returns information about key modifiers state (Ctrl, Alt, etc.)
Definition: tool_event.h:342
static KICAD_T nodeTypes[]
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:42
EDA_ITEM * SelectPoint(const VECTOR2I &aWhere, const KICAD_T *aFilterList=EE_COLLECTOR::AllItems, bool *aSelectionCancelledFlag=NULL, bool aCheckLocked=false, bool aAdd=false, bool aSubtract=false, bool aExclusiveOr=false)
Function selectPoint() Selects an item pointed by the parameter aWhere.
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.

References KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_BASE::getViewControls(), MD_ALT, TOOL_EVENT::Modifier(), nodeTypes, and SelectPoint().

Referenced by setTransitions().

◆ SelectPoint()

EDA_ITEM * EE_SELECTION_TOOL::SelectPoint ( const VECTOR2I aWhere,
const KICAD_T aFilterList = EE_COLLECTOR::AllItems,
bool *  aSelectionCancelledFlag = NULL,
bool  aCheckLocked = false,
bool  aAdd = false,
bool  aSubtract = false,
bool  aExclusiveOr = false 
)

Function selectPoint() Selects an item pointed by the parameter aWhere.

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

Parameters
aWhereis the place where the item should be selected.
aSelectionCancelledFlagallows the function to inform its caller that a selection was cancelled (for instance, by clicking outside of the disambiguation menu).
aCheckLockedindicates if locked items should be excluded

Definition at line 420 of file ee_selection_tool.cpp.

423 {
424  EE_COLLECTOR collector;
425 
426  collector.m_Threshold = KiROUND( getView()->ToWorld( HITTEST_THRESHOLD_PIXELS ) );
427 
428  if( m_isLibEdit )
429  {
430  auto part = static_cast<LIB_EDIT_FRAME*>( m_frame )->GetCurPart();
431 
432  if( !part )
433  return nullptr;
434 
435  collector.Collect( part->GetDrawItems(), aFilterList, (wxPoint) aWhere, m_unit, m_convert );
436  }
437  else
438  collector.Collect( m_frame->GetScreen(), aFilterList, (wxPoint) aWhere, m_unit, m_convert );
439 
440  // Post-process collected items
441  for( int i = collector.GetCount() - 1; i >= 0; --i )
442  {
443  if( !Selectable( collector[ i ] ) )
444  {
445  collector.Remove( i );
446  continue;
447  }
448 
449  if( aCheckLocked && collector[ i ]->IsLocked() )
450  {
451  collector.Remove( i );
452  continue;
453  }
454 
455  // SelectPoint, unlike other selection routines, can select line ends
456  if( collector[ i ]->Type() == SCH_LINE_T )
457  {
458  SCH_LINE* line = (SCH_LINE*) collector[ i ];
459  line->ClearFlags( STARTPOINT | ENDPOINT );
460 
461  if( HitTestPoints( line->GetStartPoint(), (wxPoint) aWhere, collector.m_Threshold ) )
462  line->SetFlags( STARTPOINT );
463  else if (HitTestPoints( line->GetEndPoint(), (wxPoint) aWhere, collector.m_Threshold ) )
464  line->SetFlags( ENDPOINT );
465  else
466  line->SetFlags( STARTPOINT | ENDPOINT );
467  }
468  }
469 
471 
472  // Apply some ugly heuristics to avoid disambiguation menus whenever possible
473  if( collector.GetCount() > 1 && !m_skip_heuristics )
474  {
475  GuessSelectionCandidates( collector, aWhere );
476  }
477 
478  // If still more than one item we're going to have to ask the user.
479  if( collector.GetCount() > 1 )
480  {
481  collector.m_MenuTitle = _( "Clarify Selection" );
482  // Must call selectionMenu via RunAction() to avoid event-loop contention
483  m_toolMgr->RunAction( EE_ACTIONS::selectionMenu, true, &collector );
484 
485  if( collector.m_MenuCancelled )
486  {
487  if( aSelectionCancelledFlag )
488  *aSelectionCancelledFlag = true;
489 
490  return nullptr;
491  }
492  }
493 
494  if( !aAdd && !aSubtract && !aExclusiveOr )
495  ClearSelection();
496 
497  if( collector.GetCount() == 1 )
498  {
499  EDA_ITEM* item = collector[ 0 ];
500 
501  if( aSubtract || ( aExclusiveOr && item->IsSelected() ) )
502  {
503  unselect( item );
505  return nullptr;
506  }
507  else
508  {
509  select( item );
511  return item;
512  }
513  }
514 
515  return nullptr;
516 }
void ClearReferencePoint()
Definition: selection.h:249
static const TOOL_EVENT SelectedEvent
Definition: actions.h:201
int m_Threshold
Definition: collector.h:66
wxPoint GetStartPoint() const
Definition: sch_line.h:97
bool IsSelected() const
Definition: base_struct.h:225
static const TOOL_EVENT UnselectedEvent
Definition: actions.h:202
void Collect(SCH_SCREEN *aScreen, const KICAD_T aFilterList[], const wxPoint &aPos, int aUnit=0, int aConvert=0)
Function Collect scans a EDA_ITEM using this class's Inspector method, which does the collection.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
#define HITTEST_THRESHOLD_PIXELS
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:139
EE_COLLECTOR.
Definition: ee_collectors.h:39
bool Selectable(const EDA_ITEM *aItem, bool checkVisibilityOnly=false) const
Function Selectable() Checks conditions for an item to be selected.
void select(EDA_ITEM *aItem)
Function select() Takes necessary action mark an item as selected.
void Remove(int aIndex)
Function Remove removes the item at aIndex (first position is 0);.
Definition: collector.h:129
void GuessSelectionCandidates(EE_COLLECTOR &collector, const VECTOR2I &aPos)
Apply heuristics to try and determine a single object when multiple are found under the cursor.
bool m_MenuCancelled
Definition: collector.h:69
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:100
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:257
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
wxString m_MenuTitle
Definition: collector.h:68
void unselect(EDA_ITEM *aItem)
Function unselect() Takes necessary action mark an item as unselected.
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:38
#define _(s)
Definition: 3d_actions.cpp:33
SCH_BASE_FRAME * m_frame
bool HitTestPoints(const wxPoint &pointA, const wxPoint &pointB, double threshold)
Test, if two points are near each other.
Definition: trigo.h:166
static TOOL_ACTION selectionMenu
Runs a selection menu to select from a list of items.
Definition: ee_actions.h:69
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:258
EE_SELECTION m_selection
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125
wxPoint GetEndPoint() const
Definition: sch_line.h:100

References _, EDA_ITEM::ClearFlags(), SELECTION::ClearReferencePoint(), ClearSelection(), EE_COLLECTOR::Collect(), ENDPOINT, COLLECTOR::GetCount(), SCH_LINE::GetEndPoint(), SCH_BASE_FRAME::GetScreen(), SCH_LINE::GetStartPoint(), TOOL_BASE::getView(), GuessSelectionCandidates(), HITTEST_THRESHOLD_PIXELS, HitTestPoints(), EDA_ITEM::IsSelected(), KiROUND(), m_convert, m_frame, m_isLibEdit, COLLECTOR::m_MenuCancelled, COLLECTOR::m_MenuTitle, m_selection, m_skip_heuristics, COLLECTOR::m_Threshold, TOOL_BASE::m_toolMgr, m_unit, TOOL_MANAGER::ProcessEvent(), COLLECTOR::Remove(), TOOL_MANAGER::RunAction(), SCH_LINE_T, select(), Selectable(), EVENTS::SelectedEvent, EE_ACTIONS::selectionMenu, EDA_ITEM::SetFlags(), STARTPOINT, unselect(), and EVENTS::UnselectedEvent.

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

◆ SetContextMenu()

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

Function SetContextMenu()

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

Parameters
aMenuis the menu to be assigned.
aTriggerdetermines conditions upon which the context menu is activated.

Definition at line 76 of file tool_interactive.cpp.

77 {
78  if( aMenu )
79  aMenu->SetTool( this );
80  else
81  aTrigger = CMENU_OFF;
82 
83  m_toolMgr->ScheduleContextMenu( this, aMenu, aTrigger );
84 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
void SetTool(TOOL_INTERACTIVE *aTool)
Function SetTool() Sets a tool that is the creator of the menu.
void ScheduleContextMenu(TOOL_BASE *aTool, ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger)
Sets behaviour of the tool's context popup menu.

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

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), TOOL_MENU::ShowContextMenu(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ setTransitions()

void EE_SELECTION_TOOL::setTransitions ( )
overrideprivatevirtual

Sets up handlers for various events.

Implements TOOL_INTERACTIVE.

Definition at line 1347 of file ee_selection_tool.cpp.

1348 {
1350 
1355 
1361 }
int UpdateMenu(const TOOL_EVENT &aEvent)
static TOOL_ACTION addItemsToSel
Selects a list of items (specified as the event parameter)
Definition: ee_actions.h:65
static TOOL_ACTION selectConnection
If current selection is a wire or bus, expand to entire connection.
Definition: ee_actions.h:55
int AddItemsToSel(const TOOL_EVENT &aEvent)
static TOOL_ACTION removeItemsFromSel
Definition: ee_actions.h:66
void Go(int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
Function Go()
static TOOL_ACTION removeItemFromSel
Definition: ee_actions.h:62
int SelectNode(const TOOL_EVENT &aEvent)
Select node under cursor
static TOOL_ACTION addItemToSel
Selects an item (specified as the event parameter).
Definition: ee_actions.h:61
int SelectConnection(const TOOL_EVENT &aEvent)
If node selected then expand to connection, otherwise select connection under cursor
static TOOL_ACTION selectionActivate
Activation of the selection tool.
Definition: ee_actions.h:48
static TOOL_ACTION clearSelection
Clears the current selection.
Definition: ee_actions.h:58
static TOOL_ACTION updateMenu
Definition: actions.h:162
int RemoveItemFromSel(const TOOL_EVENT &aEvent)
int AddItemToSel(const TOOL_EVENT &aEvent)
int SelectionMenu(const TOOL_EVENT &aEvent)
Function SelectionMenu() Shows a popup menu to trim the COLLECTOR passed as aEvent's parameter down t...
static TOOL_ACTION selectionMenu
Runs a selection menu to select from a list of items.
Definition: ee_actions.h:69
static TOOL_ACTION selectNode
Select the junction, wire or bus segment under the cursor.
Definition: ee_actions.h:51
int RemoveItemsFromSel(const TOOL_EVENT &aEvent)
int Main(const TOOL_EVENT &aEvent)
Function Main()

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

◆ UnbrightenItem()

void EE_SELECTION_TOOL::UnbrightenItem ( EDA_ITEM aItem)

Definition at line 951 of file ee_selection_tool.cpp.

952 {
953  unhighlight( aItem, BRIGHTENED );
954 }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
void unhighlight(EDA_ITEM *aItem, int aHighlightMode, EE_SELECTION *aGroup=nullptr)
Function unhighlight() Unhighlights the item visually.

References BRIGHTENED, and unhighlight().

Referenced by LIB_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ unhighlight()

void EE_SELECTION_TOOL::unhighlight ( EDA_ITEM aItem,
int  aHighlightMode,
EE_SELECTION aGroup = nullptr 
)
private

Function unhighlight() Unhighlights the item visually.

Parameters
aItemis an item to be be highlighted.
aHighlightModeshould be either SELECTED or BRIGHTENED
aGroupis the group to remove the item from.

Definition at line 1268 of file ee_selection_tool.cpp.

1269 {
1270  KICAD_T itemType = aItem->Type();
1271 
1272  if( aMode == SELECTED )
1273  aItem->ClearSelected();
1274  else if( aMode == BRIGHTENED )
1275  aItem->ClearBrightened();
1276 
1277  if( aGroup )
1278  aGroup->Remove( aItem );
1279 
1280  // Unhighlight pins and fields. (All the other component children are currently only
1281  // represented in the LIB_PART.)
1282  if( itemType == SCH_COMPONENT_T )
1283  {
1284  SCH_PIN_PTRS pins = static_cast<SCH_COMPONENT*>( aItem )->GetSchPins( g_CurrentSheet );
1285 
1286  for( SCH_PIN* pin : pins )
1287  {
1288  if( aMode == SELECTED )
1289  pin->ClearSelected();
1290  else if( aMode == BRIGHTENED )
1291  pin->ClearBrightened();
1292  }
1293 
1294  for( SCH_FIELD* field : static_cast<SCH_COMPONENT*>( aItem )->GetFields() )
1295  {
1296  if( aMode == SELECTED )
1297  field->ClearSelected();
1298  else if( aMode == BRIGHTENED )
1299  field->ClearBrightened();
1300  }
1301  }
1302  else if( itemType == SCH_SHEET_T )
1303  {
1304  for( SCH_FIELD& field : static_cast<SCH_SHEET*>( aItem )->GetFields() )
1305  {
1306  if( aMode == SELECTED )
1307  field.ClearSelected();
1308  else if( aMode == BRIGHTENED )
1309  field.ClearBrightened();
1310  }
1311 
1312  for( SCH_SHEET_PIN* pin : static_cast<SCH_SHEET*>( aItem )->GetPins() )
1313  {
1314  if( aMode == SELECTED )
1315  pin->ClearSelected();
1316  else if( aMode == BRIGHTENED )
1317  pin->ClearBrightened();
1318  }
1319  }
1320 
1321  if( itemType == SCH_PIN_T || itemType == SCH_FIELD_T || itemType == SCH_SHEET_PIN_T )
1322  getView()->Update( aItem->GetParent() );
1323  else
1324  getView()->Update( aItem );
1325 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
std::vector< SCH_PIN * > SCH_PIN_PTRS
Definition: sch_component.h:73
void ClearSelected()
Definition: base_struct.h:235
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
void ClearBrightened()
Definition: base_struct.h:237
#define SELECTED
Definition: base_struct.h:127
SCH_SHEET_PATH * g_CurrentSheet
With the new connectivity algorithm, many more places than before want to know what the current sheet...
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
EDA_ITEM * GetParent() const
Definition: base_struct.h:217
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1540
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
virtual void Remove(EDA_ITEM *aItem)
Definition: selection.h:86

References BRIGHTENED, EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearSelected(), g_CurrentSheet, EDA_ITEM::GetParent(), TOOL_BASE::getView(), SELECTION::Remove(), SCH_COMPONENT_T, SCH_FIELD_T, SCH_PIN_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SELECTED, EDA_ITEM::Type(), and KIGFX::VIEW::Update().

Referenced by ClearSelection(), doSelectionMenu(), UnbrightenItem(), and unselect().

◆ unselect()

void EE_SELECTION_TOOL::unselect ( EDA_ITEM aItem)
private

Function unselect() Takes necessary action mark an item as unselected.

Parameters
aItemis an item to be unselected.

Definition at line 1202 of file ee_selection_tool.cpp.

1203 {
1204  unhighlight( aItem, SELECTED, &m_selection );
1205 }
#define SELECTED
Definition: base_struct.h:127
EE_SELECTION m_selection
void unhighlight(EDA_ITEM *aItem, int aHighlightMode, EE_SELECTION *aGroup=nullptr)
Function unhighlight() Unhighlights the item visually.

References m_selection, SELECTED, and unhighlight().

Referenced by RemoveItemFromSel(), RemoveItemsFromSel(), RequestSelection(), selectMultiple(), and SelectPoint().

◆ UpdateMenu()

int EE_SELECTION_TOOL::UpdateMenu ( const TOOL_EVENT aEvent)

Definition at line 243 of file ee_selection_tool.cpp.

244 {
245  ACTION_MENU* actionMenu = aEvent.Parameter<ACTION_MENU*>();
246  CONDITIONAL_MENU* conditionalMenu = dynamic_cast<CONDITIONAL_MENU*>( actionMenu );
247 
248  if( conditionalMenu )
249  conditionalMenu->Evaluate( m_selection );
250 
251  if( actionMenu )
252  actionMenu->UpdateAll();
253 
254  return 0;
255 }
ACTION_MENU.
Definition: action_menu.h:43
void UpdateAll()
Function UpdateAll() Runs update handlers for the menu and its submenus.
T Parameter() const
Function Parameter() Returns a non-standard parameter assigned to the event.
Definition: tool_event.h:435
EE_SELECTION m_selection

References m_selection, TOOL_EVENT::Parameter(), and ACTION_MENU::UpdateAll().

Referenced by setTransitions().

◆ updateReferencePoint()

void EE_SELECTION_TOOL::updateReferencePoint ( )
private

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

Definition at line 643 of file ee_selection_tool.cpp.

644 {
645  VECTOR2I refP( 0, 0 );
646 
647  if( m_selection.Size() > 0 )
648  {
649  if( m_isLibEdit )
650  refP = static_cast<LIB_ITEM*>( m_selection.GetTopLeftItem() )->GetPosition();
651  else
652  refP = static_cast<SCH_ITEM*>( m_selection.GetTopLeftItem() )->GetPosition();
653  }
654 
656 }
void SetReferencePoint(const VECTOR2I &aP)
Definition: selection.h:244
EDA_ITEM * GetTopLeftItem(bool onlyModules=false) const override
int Size() const
Returns the number of selected parts.
Definition: selection.h:126
EE_SELECTION m_selection

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

Referenced by RebuildSelection(), and RequestSelection().

◆ Wait()

TOOL_EVENT * TOOL_INTERACTIVE::Wait ( const TOOL_EVENT_LIST aEventList = TOOL_EVENTTC_ANYTA_ANY ))
inherited

Function Wait()

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

58 {
59  return m_toolMgr->ScheduleWait( this, aEventList );
60 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
TOOL_EVENT * ScheduleWait(TOOL_BASE *aTool, const TOOL_EVENT_LIST &aConditions)
Pauses execution of a given tool until one or more events matching aConditions arrives.

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

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), ZOOM_TOOL::Main(), CVPCB_CONTROL::Main(), SCH_MOVE_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_VIEWER_CONTROL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), Main(), SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), EDIT_TOOL::Move(), POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), EDIT_TOOL::pickCopyReferencePoint(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), selectMultiple(), SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ZOOM_TOOL::selectRegion(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

Member Data Documentation

◆ m_additive

bool EE_SELECTION_TOOL::m_additive
private

Definition at line 233 of file ee_selection_tool.h.

Referenced by Main(), and selectMultiple().

◆ m_convert

int EE_SELECTION_TOOL::m_convert
private

Definition at line 242 of file ee_selection_tool.h.

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

◆ m_exclusive_or

bool EE_SELECTION_TOOL::m_exclusive_or
private

Definition at line 235 of file ee_selection_tool.h.

Referenced by Main(), and selectMultiple().

◆ m_frame

◆ m_isLibEdit

bool EE_SELECTION_TOOL::m_isLibEdit
private

Definition at line 239 of file ee_selection_tool.h.

Referenced by Init(), RebuildSelection(), Reset(), SelectPoint(), and updateReferencePoint().

◆ m_isLibView

bool EE_SELECTION_TOOL::m_isLibView
private

Definition at line 240 of file ee_selection_tool.h.

Referenced by Init(), and Reset().

◆ m_menu

TOOL_MENU TOOL_INTERACTIVE::m_menu
protectedinherited

functions below are not yet implemented - their interface may change

Definition at line 108 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(), DRAWING_TOOL::drawSegment(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), TOOL_INTERACTIVE::GetToolMenu(), PICKER_TOOL::Init(), SCH_EDIT_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), LIB_DRAWING_TOOLS::Init(), EDA_3D_VIEWER_CONTROL::Init(), MODULE_EDITOR_TOOLS::Init(), LIB_CONTROL::Init(), PCB_EDITOR_CONTROL::Init(), SCH_DRAWING_TOOLS::Init(), GERBVIEW_SELECTION_TOOL::Init(), DRAWING_TOOL::Init(), Init(), EE_TOOL_BASE< SCH_BASE_FRAME >::Init(), SELECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), EDIT_TOOL::Init(), PCB_TOOL_BASE::Init(), SCH_MOVE_TOOL::Main(), LIB_MOVE_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_VIEWER_CONTROL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), Main(), SELECTION_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ m_multiple

bool EE_SELECTION_TOOL::m_multiple
private

Definition at line 236 of file ee_selection_tool.h.

Referenced by selectMultiple().

◆ m_selection

◆ m_skip_heuristics

bool EE_SELECTION_TOOL::m_skip_heuristics
private

Definition at line 237 of file ee_selection_tool.h.

Referenced by Main(), and SelectPoint().

◆ m_subtractive

bool EE_SELECTION_TOOL::m_subtractive
private

Definition at line 234 of file ee_selection_tool.h.

Referenced by Main(), and selectMultiple().

◆ m_toolId

TOOL_ID TOOL_BASE::m_toolId
protectedinherited

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

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

Referenced by TOOL_INTERACTIVE::Activate(), AddItemsToSel(), AddItemToSel(), SELECTION_TOOL::AddItemToSel(), CVPCB_ASSOCIATION_TOOL::Associate(), TOOL_BASE::attachManager(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), EDIT_TOOL::ChangeTrackWidth(), PCB_INSPECTION_TOOL::ClearHighlight(), SCH_EDITOR_CONTROL::ClearHighlight(), SELECTION_TOOL::ClearSelection(), GERBVIEW_SELECTION_TOOL::clearSelection(), ClearSelection(), SCH_EDIT_TOOL::ConvertDeMorgan(), LIB_EDIT_TOOL::Copy(), PAD_TOOL::copyPadSettings(), MICROWAVE_TOOL::createInductorBetween(), MODULE_EDITOR_TOOLS::CreatePadFromShapes(), PCB_INSPECTION_TOOL::CrossProbePcbToSch(), COMMON_TOOLS::CursorControl(), ROUTER_TOOL::CustomTrackWidthDialog(), SCH_EDITOR_CONTROL::Cut(), LIB_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), PCBNEW_CONTROL::DeleteItemCursor(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), LIB_EDIT_TOOL::DoDelete(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PCB_EDITOR_CONTROL::DrillOrigin(), LIB_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::editFieldText(), EDIT_TOOL::EditFpInFpEditor(), LIB_EDIT_TOOL::editSymbolProperties(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_EDITOR_CONTROL::EnterSheet(), PAD_TOOL::EnumeratePads(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), SELECTION_TOOL::expandConnection(), MODULE_EDITOR_TOOLS::ExplodePadToShapes(), SELECTION_TOOL::filterSelection(), SELECTION_TOOL::findCallback(), SCH_EDITOR_CONTROL::FindComponentAndItem(), POINT_EDITOR::finishItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), TOOL_BASE::getEditFrameInt(), TOOL_BASE::GetManager(), TOOL_BASE::getModelInt(), DRAWING_TOOL::getSourceZoneForAction(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_INTERACTIVE::goInternal(), PCBNEW_CONTROL::GridSetOrigin(), GERBVIEW_CONTROL::HighlightControl(), PCB_INSPECTION_TOOL::HighlightItem(), PCB_INSPECTION_TOOL::HighlightNet(), SCH_EDITOR_CONTROL::HighlightNet(), PCB_INSPECTION_TOOL::highlightNet(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PCB_INSPECTION_TOOL::HighlightNetTool(), MODULE_EDITOR_TOOLS::ImportFootprint(), LIB_EDIT_TOOL::Init(), SCH_EDIT_TOOL::Init(), PAD_TOOL::Init(), GLOBAL_EDIT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), LIB_CONTROL::Init(), PCB_EDITOR_CONTROL::Init(), POINT_EDITOR::Init(), POSITION_RELATIVE_TOOL::Init(), EE_TOOL_BASE< SCH_BASE_FRAME >::Init(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isInteractiveDragEnabled(), TOOL_BASE::IsToolActive(), SCH_EDITOR_CONTROL::LeaveSheet(), COMMON_CONTROL::ListHotKeys(), PCB_INSPECTION_TOOL::LocalRatsnestTool(), SCH_MOVE_TOOL::Main(), CVPCB_CONTROL::Main(), LIB_MOVE_TOOL::Main(), Main(), SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), LIB_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), PCB_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::Move(), EDIT_TOOL::MoveExact(), LIB_CONTROL::OnDeMorgan(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), EDIT_TOOL::pickCopyReferencePoint(), LIB_EDIT_TOOL::PinTable(), PCBNEW_CONTROL::placeBoardItems(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCBNEW_CONTROL::Print(), GERBVIEW_CONTROL::Print(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), RebuildSelection(), LIB_EDIT_TOOL::Redo(), SCH_EDITOR_CONTROL::Redo(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), POINT_EDITOR::removeCorner(), RemoveItemFromSel(), SELECTION_TOOL::RemoveItemFromSel(), RemoveItemsFromSel(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_DRAWING_TOOLS::RepeatDrawItem(), RequestSelection(), SELECTION_TOOL::RequestSelection(), COMMON_TOOLS::ResetLocalCoords(), TOOL_INTERACTIVE::resetTransitions(), LIB_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), TOOL_INTERACTIVE::RunMainStack(), DRC::RunTests(), SelectConnection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), GERBVIEW_SELECTION_TOOL::SelectItems(), SELECTION_TOOL::SelectItems(), selectMultiple(), SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectNet(), GERBVIEW_SELECTION_TOOL::selectPoint(), SelectPoint(), SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), SELECTION_TOOL::selectSameSheet(), SELECTION_TOOL::selectSheetContents(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE::SetContextMenu(), DRC::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), LIB_EDIT_TOOL::Undo(), SCH_EDITOR_CONTROL::Undo(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), SELECTION_TOOL::UnselectItems(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PCBNEW_CONTROL::UpdateMessagePanel(), PCB_INSPECTION_TOOL::UpdateSelectionRatsnest(), PCB_EDITOR_CONTROL::ViaSizeDec(), PCB_EDITOR_CONTROL::ViaSizeInc(), TOOL_INTERACTIVE::Wait(), PCB_EDITOR_CONTROL::ZoneDuplicate(), and PCB_EDITOR_CONTROL::ZoneMerge().

◆ m_toolName

std::string TOOL_BASE::m_toolName
protectedinherited

Name of the tool.

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

Definition at line 217 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

◆ m_type

TOOL_TYPE TOOL_BASE::m_type
protectedinherited

Stores the type of the tool.

Definition at line 210 of file tool_base.h.

Referenced by TOOL_BASE::GetType(), and BOARD_COMMIT::Push().

◆ m_unit

int EE_SELECTION_TOOL::m_unit
private

Definition at line 241 of file ee_selection_tool.h.

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


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