KiCad PCB EDA Suite
selection_tool.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2013-2017 CERN
5  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
6  * @author Maciej Suminski <maciej.suminski@cern.ch>
7  * Copyright (C) 2017 KiCad Developers, see CHANGELOG.TXT for contributors.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
27 #ifndef __SELECTION_TOOL_H
28 #define __SELECTION_TOOL_H
29 
30 #include <memory>
31 
32 #include <math/vector2d.h>
33 #include <tools/pcb_tool.h>
34 #include <tool/context_menu.h>
35 #include <tool/selection.h>
36 
38 #include <tool/tool_menu.h>
39 
40 class PCB_BASE_FRAME;
41 class BOARD_ITEM;
42 class GENERAL_COLLECTOR;
43 
44 namespace KIGFX
45 {
46  class GAL;
47 }
48 
49 
61 class SELECTION_TOOL : public PCB_TOOL
62 {
63 public:
66 
68  bool Init() override;
69 
71  void Reset( RESET_REASON aReason ) override;
72 
78  int Main( const TOOL_EVENT& aEvent );
79 
86 
94 
95 
97  {
98  return m_menu;
99  }
100 
103 
105  int CursorSelection( const TOOL_EVENT& aEvent );
106 
108  int ClearSelection( const TOOL_EVENT& aEvent );
109 
112  bool SanitizeSelection();
113 
115  int SelectItem( const TOOL_EVENT& aEvent );
116 
118  int SelectItems( const TOOL_EVENT& aEvent );
119 
121  int UnselectItem( const TOOL_EVENT& aEvent );
122 
124  int UnselectItems( const TOOL_EVENT& aEvent );
125 
127  static const TOOL_EVENT SelectedEvent;
128 
131 
133  static const TOOL_EVENT ClearedEvent;
134 
136  void SetTransitions() override;
137 
139  void zoomFitSelection( void );
140 
141 private:
152  bool selectPoint( const VECTOR2I& aWhere, bool aOnDrag = false );
153 
161  bool selectCursor( bool aSelectAlways = false );
162 
169  bool selectMultiple();
170 
172  int selectConnection( const TOOL_EVENT& aEvent );
173 
175  int selectCopper( const TOOL_EVENT& aEvent );
176 
181  int selectNet( const TOOL_EVENT& aEvent );
182 
186  void selectAllItemsConnectedToTrack( TRACK& aSourceTrack );
187 
192 
196  void selectAllItemsOnNet( int aNetCode );
197 
202  void selectAllItemsOnSheet( wxString& aSheetpath );
203 
206  int selectOnSheetFromEeschema( const TOOL_EVENT& aEvent );
207 
210  int selectSameSheet( const TOOL_EVENT& aEvent );
211 
213  void findCallback( BOARD_ITEM* aItem );
214 
216  int find( const TOOL_EVENT& aEvent );
217 
219  int findMove( const TOOL_EVENT& aEvent );
220 
222  int filterSelection( const TOOL_EVENT& aEvent );
223 
228  void clearSelection();
229 
238 
246 
253  void toggleSelection( BOARD_ITEM* aItem );
254 
261  bool selectable( const BOARD_ITEM* aItem ) const;
262 
270  bool modifiable( const BOARD_ITEM* aItem ) const;
271 
278  void select( BOARD_ITEM* aItem );
279 
286  void unselect( BOARD_ITEM* aItem );
287 
293  void selectVisually( BOARD_ITEM* aItem );
294 
300  void unselectVisually( BOARD_ITEM* aItem );
301 
308  bool selectionContains( const VECTOR2I& aPoint ) const;
309 
316  void guessSelectionCandidates( GENERAL_COLLECTOR& aCollector ) const;
317 
321  int updateSelection( const TOOL_EVENT& aEvent );
322 
325 
328 
331 
334 
337 
339  bool m_locked;
340 
343 
345  class PRIV;
346  std::unique_ptr<PRIV> m_priv;
347 };
348 
349 #endif
int UnselectItem(const TOOL_EVENT &aEvent)
Item unselection event handler.
int Main(const TOOL_EVENT &aEvent)
Function Main()
void Reset(RESET_REASON aReason) override
Function Reset() Brings the tool to a known, initial state.
void zoomFitSelection(void)
Zooms the screen to center and fit the current selection.
SELECTION & RequestSelection(int aFlags=SELECTION_DEFAULT)
Function RequestSelection()
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: class_module.h:58
std::unique_ptr< PRIV > m_priv
int selectSameSheet(const TOOL_EVENT &aEvent)
Selects all modules belonging to same hierarchical sheet as the selected footprint.
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
bool m_multiple
Flag saying if multiple selection mode is active.
void guessSelectionCandidates(GENERAL_COLLECTOR &aCollector) const
Function guessSelectionCandidates() Tries to guess best selection candidates in case multiple items a...
bool selectCursor(bool aSelectAlways=false)
Function selectCursor() Selects an item under the cursor unless there is something already selected o...
Class SELECTION_TOOL.
bool m_additive
Flag saying if items should be added to the current selection or rather replace it.
SELECTION_LOCK_FLAGS CheckLock()
Checks if the user has agreed to modify locked items for the given selection.
TOOL_MENU & GetToolMenu()
Class TOOL_MENU.
Definition: tool_menu.h:47
int find(const TOOL_EVENT &aEvent)
Find an item.
int findMove(const TOOL_EVENT &aEvent)
Find an item and start moving.
int UnselectItems(const TOOL_EVENT &aEvent)
Multiple item unselection event handler
void unselectVisually(BOARD_ITEM *aItem)
Function unselectVisually() Marks item as selected, but does not add it to the ITEMS_PICKED_LIST.
static const TOOL_EVENT ClearedEvent
Event sent after selection is cleared.
Class BOARD_CONNECTED_ITEM is a base class derived from BOARD_ITEM for items that can be connected an...
int selectConnection(const TOOL_EVENT &aEvent)
Selects a trivial connection (between two junctions) of items in selection
void select(BOARD_ITEM *aItem)
Function select() Takes necessary action mark an item as selected.
bool modifiable(const BOARD_ITEM *aItem) const
Function modifiable() Checks if an item might be modified.
BOARD_ITEM * pickSmallestComponent(GENERAL_COLLECTOR *aCollector)
Function pickSmallestComponent() Allows to find the smallest (in terms of bounding box area) item fro...
Private implementation of firewalled private data.
void findCallback(BOARD_ITEM *aItem)
Find dialog callback.
int selectCopper(const TOOL_EVENT &aEvent)
Selects items with a continuous copper connection to items in selection
int filterSelection(const TOOL_EVENT &aEvent)
Invoke filter dialog and modify current selection
bool selectable(const BOARD_ITEM *aItem) const
Function selectable() Checks conditions for an item to be selected.
void toggleSelection(BOARD_ITEM *aItem)
Function toggleSelection() Changes selection status of a given item.
void selectAllItemsOnSheet(wxString &aSheetpath)
Selects all items with the given sheet timestamp name (the sheet path)
int updateSelection(const TOOL_EVENT &aEvent)
Event handler to update the selection VIEW_ITEM.
int ClearSelection(const TOOL_EVENT &aEvent)
Clear current selection event handler.
bool selectMultiple()
Function selectMultiple() Handles drawing a selection box that allows to select many items at the sam...
void selectAllItemsOnNet(int aNetCode)
Selects all items with the given net code.
int selectOnSheetFromEeschema(const TOOL_EVENT &aEvent)
Selects all modules belonging to same sheet, from Eeschema, using crossprobing
SELECTION_LOCK_FLAGS
Definition: selection.h:184
Class TOOL_EVENT.
Definition: tool_event.h:162
BOARD_ITEM * disambiguationMenu(GENERAL_COLLECTOR *aItems)
Function disambiguationMenu() Handles the menu that allows to select one of many items in case there ...
SELECTION m_selection
Current state of selection.
SELECTION & GetSelection()
Function GetSelection()
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
void clearSelection()
Function clearSelection() Clears the current selection.
PCB_BASE_FRAME * m_frame
Pointer to the parent frame.
static const TOOL_EVENT UnselectedEvent
Event sent after an item is unselected.
TOOL_MENU m_menu
Menu model displayed by the tool.
void selectVisually(BOARD_ITEM *aItem)
Function selectVisually() Marks item as selected, but does not add it to the ITEMS_PICKED_LIST.
int SelectItem(const TOOL_EVENT &aEvent)
Item selection event handler.
int selectNet(const TOOL_EVENT &aEvent)
Selects all copper connections belonging to the same net(s) as the items in the selection.
bool selectPoint(const VECTOR2I &aWhere, bool aOnDrag=false)
Function selectPoint() Selects an item pointed by the parameter aWhere.
static const TOOL_EVENT SelectedEvent
Event sent after an item is selected.
bool m_subtractive
Flag saying if items should be removed from the current selection.
void selectAllItemsConnectedToTrack(TRACK &aSourceTrack)
Selects all items connected by copper tracks to the given TRACK.
Class GENERAL_COLLECTOR is intended for use when the right click button is pressed, or when the plain "arrow" tool is in effect.
Definition: collectors.h:211
void unselect(BOARD_ITEM *aItem)
Function unselect() Takes necessary action mark an item as unselected.
bool selectionContains(const VECTOR2I &aPoint) const
Function selectionContains() Checks if the given point is placed within any of selected items' boundi...
RESET_REASON
Determines the reason of reset for a tool
Definition: tool_base.h:80
int SelectItems(const TOOL_EVENT &aEvent)
Multiple item selection event handler
bool m_locked
Can other tools modify locked items.
void SetTransitions() override
Sets up handlers for various events.
bool SanitizeSelection()
Makes sure a group selection does not contain items that would cause conflicts when moving/rotating t...
void selectAllItemsConnectedToItem(BOARD_CONNECTED_ITEM &aSourceItem)
Selects all items connected (by copper) to the given item.
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...
int CursorSelection(const TOOL_EVENT &aEvent)
Select a single item under cursor event handler.