KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_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 * Copyright The KiCad Developers, see AUTHORS.TXT for contributors.
6 *
7 * @author Tomasz Wlostowski <[email protected]>
8 * @author Maciej Suminski <[email protected]>
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, you may find one here:
22 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23 * or you may search the http://www.gnu.org website for the version 2 license,
24 * or you may write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26 */
27
28#ifndef PCB_SELECTION_TOOL_H
29#define PCB_SELECTION_TOOL_H
30
31#include <functional>
32#include <memory>
33
34#include <tool/actions.h>
35#include <math/vector2d.h>
38#include <tool/action_menu.h>
39#include <tool/selection_tool.h>
40#include <tool/tool_menu.h>
42#include <tools/pcb_tool_base.h>
43#include <tools/pcb_selection.h>
44
45class PCB_BASE_FRAME;
46class BOARD_ITEM;
48class PCB_TABLE;
49
50namespace KIGFX
51{
52 class GAL;
53}
54
55
66{
67public:
70
72 bool Init() override;
73
75 void Reset( RESET_REASON aReason ) override;
76
77 void OnIdle( wxIdleEvent& aEvent );
78
80 {
82 }
83
87 int Main( const TOOL_EVENT& aEvent );
88
93
104 bool aConfirmLockedItems = false );
105
107 int CursorSelection( const TOOL_EVENT& aEvent );
108
109 int SelectColumns( const TOOL_EVENT& aEvent );
110 int SelectRows( const TOOL_EVENT& aEvent );
111 int SelectTable( const TOOL_EVENT& aEvent );
112
114 int ClearSelection( const TOOL_EVENT& aEvent );
115 void ClearSelection( bool aQuietMode = false );
116
118 int SelectAll( const TOOL_EVENT& aEvent );
119
121 int UnselectAll( const TOOL_EVENT& aEvent );
122
124 int SetSelectRect( const TOOL_EVENT& aEvent );
125 int SetSelectPoly( const TOOL_EVENT& aEvent );
126
132 int SelectRectArea( const TOOL_EVENT& aEvent );
133
140 int SelectPolyArea( const TOOL_EVENT& aEvent );
141
145 void SelectMultiple( KIGFX::PREVIEW::SELECTION_AREA& aArea, bool aSubtractive = false,
146 bool aExclusiveOr = false );
147
153 void FindItem( BOARD_ITEM* aItem );
154
160 void select( EDA_ITEM* aItem ) override;
161
165 bool Selectable( const BOARD_ITEM* aItem, bool checkVisibilityOnly = false ) const;
166
173 void SelectAllItemsOnNet( int aNetCode, bool aSelect = true );
174
182 void GuessSelectionCandidates( GENERAL_COLLECTOR& aCollector, const VECTOR2I& aWhere ) const;
183
190 void RebuildSelection();
191
193 {
194 return m_filter;
195 }
196
198 void setTransitions() override;
199
201 void zoomFitSelection();
202
204 void ZoomFitCrossProbeBBox( const BOX2I& bbox );
205
209 void EnterGroup() override;
210
216 void ExitGroup( bool aSelectGroup = false ) override;
217
222
224
229 void FilterCollectorForHierarchy( GENERAL_COLLECTOR& aCollector, bool aMultiselect ) const;
230
236 bool aForcePromotion = false ) const;
237
241 void FilterCollectorForTableCells( GENERAL_COLLECTOR& aCollector ) const;
242
246 void FilterCollectorForMarkers( GENERAL_COLLECTOR& aCollector ) const;
247
251 void FilterCollectedItems( GENERAL_COLLECTOR& aCollector, bool aMultiSelect );
252
257 const VECTOR2I& aWhere ) const;
258
259protected:
261 {
262 return static_cast<KIGFX::PCB_VIEW*>( getView() );
263 }
264
266 {
267 return getViewControls();
268 }
269
271 {
272 return getEditFrame<PCB_BASE_FRAME>();
273 }
274
276 {
277 return getEditFrame<PCB_BASE_EDIT_FRAME>();
278 }
279
280 BOARD* board() const
281 {
282 return getModel<BOARD>();
283 }
284
286 {
287 return static_cast<PCB_DRAW_PANEL_GAL*>( frame()->GetCanvas() );
288 }
289
290 virtual bool ctrlClickHighlights() override;
291
292 SELECTION& selection() override { return m_selection; }
293
294private:
309 bool selectPoint( const VECTOR2I& aWhere, bool aOnDrag = false,
310 bool* aSelectionCancelledFlag = nullptr,
311 CLIENT_SELECTION_FILTER aClientFilter = nullptr );
312
321 bool selectCursor( bool aForceSelect = false,
322 CLIENT_SELECTION_FILTER aClientFilter = nullptr );
323
324 bool selectTableCells( PCB_TABLE* aTable );
325
329 int disambiguateCursor( const TOOL_EVENT& aEvent );
330
334 int expandConnection( const TOOL_EVENT& aEvent );
335
339 int unrouteSelected( const TOOL_EVENT& aEvent );
340
344 int unrouteSegment( const TOOL_EVENT& aEvent );
345
349 int selectNet( const TOOL_EVENT& aEvent );
350
354 int selectUnconnected( const TOOL_EVENT& aEvent );
355
359 int grabUnconnected( const TOOL_EVENT& aEvent );
360
362 {
376 };
377
383 void selectAllConnectedTracks( const std::vector<BOARD_CONNECTED_ITEM*>& aStartItems,
384 STOP_CONDITION aStopCondition );
385
391 void selectAllConnectedShapes( const std::vector<PCB_SHAPE*>& aStartItems );
392
396 bool isExpandableGraphicShape( const EDA_ITEM* aItem ) const;
397
398 /*
399 * Select tracks and vias connected to specified board items.
400 */
401 void selectConnections( const std::vector<BOARD_ITEM*>& aItems );
402
408 void selectAllItemsOnSheet( wxString& aSheetPath );
409
411 int selectSheetContents( const TOOL_EVENT& aEvent );
412
415 int selectSameSheet( const TOOL_EVENT& aEvent );
416
419 int syncSelection( const TOOL_EVENT& aEvent );
420 int syncSelectionWithNets( const TOOL_EVENT& aEvent );
421 void doSyncSelection( const std::vector<BOARD_ITEM*>& aItems, bool aWithNets );
422
424 int filterSelection( const TOOL_EVENT& aEvent );
425
427 bool itemPassesFilter( BOARD_ITEM* aItem, bool aMultiSelect );
428
434 void unselect( EDA_ITEM* aItem ) override;
435
443 void highlight( EDA_ITEM* aItem, int aHighlightMode, SELECTION* aGroup = nullptr ) override;
444
452 void unhighlight( EDA_ITEM* aItem, int aHighlightMode, SELECTION* aGroup = nullptr ) override;
453
457 bool selectionContains( const VECTOR2I& aPoint ) const;
458
462 int hitTestDistance( const VECTOR2I& aWhere, BOARD_ITEM* aItem, int aMaxDistance ) const;
463
467 int updateSelection( const TOOL_EVENT& aEvent );
468
469 void pruneObscuredSelectionCandidates( GENERAL_COLLECTOR& aCollector ) const;
470
472
473private:
474 void highlightInternal( EDA_ITEM* aItem, int aHighlightMode, bool aUsingOverlay );
475
476 void unhighlightInternal( EDA_ITEM* aItem, int aHighlightMode, bool aUsingOverlay );
477
478private:
479 PCB_BASE_FRAME* m_frame; // Pointer to the parent frame
481
482 PCB_SELECTION m_selection; // Current state of selection
483
485
486 KICURSOR m_nonModifiedCursor; // Cursor in the absence of shift/ctrl/alt
487
488 PCB_GROUP* m_enteredGroup; // If non-null, selections are limited to
489 // members of this group
490 KIGFX::VIEW_GROUP m_enteredGroupOverlay; // Overlay for the entered group's frame.
491
492 SELECTION_MODE m_selectionMode; // Current selection mode
493
495 class PRIV;
496 std::unique_ptr<PRIV> m_priv;
497};
498
499#endif /* PCB_SELECTION_TOOL_H */
std::function< void(const VECTOR2I &, GENERAL_COLLECTOR &, PCB_SELECTION_TOOL *)> CLIENT_SELECTION_FILTER
Definition: actions.h:38
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:317
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:98
A general implementation of a COLLECTORS_GUIDE.
Definition: collectors.h:324
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:207
Represent a selection area (currently a rectangle) in a VIEW, drawn corner-to-corner between two poin...
An interface for classes handling user events controlling the view behavior such as zooming,...
Extend VIEW_ITEM by possibility of grouping items into a single object.
Definition: view_group.h:43
Common, abstract interface for edit frames.
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
virtual PCB_LAYER_ID GetActiveLayer() const
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
A set of BOARD_ITEMs (i.e., without duplicates).
Definition: pcb_group.h:53
Private implementation of firewalled private data.
The selection tool: currently supports:
void highlight(EDA_ITEM *aItem, int aHighlightMode, SELECTION *aGroup=nullptr) override
Highlight the item visually.
int syncSelectionWithNets(const TOOL_EVENT &aEvent)
int SelectTable(const TOOL_EVENT &aEvent)
Clear current selection event handler.
PCB_BASE_FRAME * frame() const
int syncSelection(const TOOL_EVENT &aEvent)
int selectNet(const TOOL_EVENT &aEvent)
Select all copper connections belonging to the same net(s) as the items in the selection.
int filterSelection(const TOOL_EVENT &aEvent)
Return true if the given item passes the current SELECTION_FILTER_OPTIONS.
void ZoomFitCrossProbeBBox(const BOX2I &bbox)
void EnterGroup() override
Enter the group at the head of the current selection.
void doSyncSelection(const std::vector< BOARD_ITEM * > &aItems, bool aWithNets)
Invoke filter dialog and modify current selection.
SELECTION_MODE m_selectionMode
void GuessSelectionCandidates(GENERAL_COLLECTOR &aCollector, const VECTOR2I &aWhere) const
Try to guess best selection candidates in case multiple items are clicked, by doing some brain-dead h...
bool itemPassesFilter(BOARD_ITEM *aItem, bool aMultiSelect)
void ExitGroup(bool aSelectGroup=false) override
Leave the currently-entered group.
bool isExpandableGraphicShape(const EDA_ITEM *aItem) const
int disambiguateCursor(const TOOL_EVENT &aEvent)
Handle disambiguation actions including displaying the menu.
int SelectPolyArea(const TOOL_EVENT &aEvent)
Handles drawing a lasso selection area that allows multiple items to be selected simultaneously.
void FilterCollectorForMarkers(GENERAL_COLLECTOR &aCollector) const
Drop any PCB_MARKERs from the collector.
int UnselectAll(const TOOL_EVENT &aEvent)
Change the selection mode.
void unhighlightInternal(EDA_ITEM *aItem, int aHighlightMode, bool aUsingOverlay)
bool selectionContains(const VECTOR2I &aPoint) const
void select(EDA_ITEM *aItem) override
Take necessary action mark an item as selected.
bool selectCursor(bool aForceSelect=false, CLIENT_SELECTION_FILTER aClientFilter=nullptr)
Select an item under the cursor unless there is something already selected.
int SetSelectPoly(const TOOL_EVENT &aEvent)
int SetSelectRect(const TOOL_EVENT &aEvent)
int SelectColumns(const TOOL_EVENT &aEvent)
std::unique_ptr< PRIV > m_priv
PCB_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, bool aConfirmLockedItems=false)
Return the current selection, filtered according to aClientFilter.
int unrouteSelected(const TOOL_EVENT &aEvent)
Unroute the selected board connected items.
int unrouteSegment(const TOOL_EVENT &aEvent)
Unroute the selected track connected item.
SELECTION & selection() override
Return a reference to the selection.
int grabUnconnected(const TOOL_EVENT &aEvent)
Select and move other nearest footprint unconnected on same net as selected items.
void FilterCollectorForFreePads(GENERAL_COLLECTOR &aCollector, bool aForcePromotion=false) const
Check the "allow free pads" setting and if disabled, replace any pads in the collector with their par...
const GENERAL_COLLECTORS_GUIDE getCollectorsGuide() const
bool Selectable(const BOARD_ITEM *aItem, bool checkVisibilityOnly=false) const
void FilterCollectedItems(GENERAL_COLLECTOR &aCollector, bool aMultiSelect)
Apply the SELECTION_FITLER_OPTIONS to the collector.
bool selectPoint(const VECTOR2I &aWhere, bool aOnDrag=false, bool *aSelectionCancelledFlag=nullptr, CLIENT_SELECTION_FILTER aClientFilter=nullptr)
Select an item pointed by the parameter aWhere.
KIGFX::PCB_VIEW * view() const
void selectAllItemsOnSheet(wxString &aSheetPath)
Select all items with the given sheet timestamp/UUID name (the sheet path).
PCB_GROUP * GetEnteredGroup()
void FilterCollectorForHierarchy(GENERAL_COLLECTOR &aCollector, bool aMultiselect) const
In general we don't want to select both a parent and any of it's children.
void SelectMultiple(KIGFX::PREVIEW::SELECTION_AREA &aArea, bool aSubtractive=false, bool aExclusiveOr=false)
Selects multiple PCB items within a specified area.
void setTransitions() override
Zoom the screen to center and fit the current selection.
PCB_BASE_EDIT_FRAME * editFrame() const
int expandConnection(const TOOL_EVENT &aEvent)
Expand the current connected-item selection to the next boundary (junctions, pads,...
PCB_SELECTION_FILTER_OPTIONS & GetFilter()
Set up handlers for various events.
PCB_LAYER_ID GetActiveLayer()
int selectUnconnected(const TOOL_EVENT &aEvent)
Select nearest unconnected footprints on same net as selected items.
virtual bool ctrlClickHighlights() override
Determine if ctrl-click is highlight net or XOR selection.
int selectSheetContents(const TOOL_EVENT &aEvent)
Select all footprints belonging to same hierarchical sheet as the selected footprint (same sheet path...
int SelectRows(const TOOL_EVENT &aEvent)
int selectSameSheet(const TOOL_EVENT &aEvent)
Set selection to items passed by parameter and connected nets (optionally).
void zoomFitSelection()
Zoom the screen to fit the bounding box for cross probing/selection sync.
void selectAllConnectedTracks(const std::vector< BOARD_CONNECTED_ITEM * > &aStartItems, STOP_CONDITION aStopCondition)
Select connected tracks and vias.
KIGFX::VIEW_CONTROLS * controls() const
int CursorSelection(const TOOL_EVENT &aEvent)
int ClearSelection(const TOOL_EVENT &aEvent)
void highlightInternal(EDA_ITEM *aItem, int aHighlightMode, bool aUsingOverlay)
PCB_BASE_FRAME * m_frame
PCB_SELECTION_FILTER_OPTIONS m_filter
PCB_SELECTION & GetSelection()
@ STOP_AT_SEGMENT
Stop when reaching a segment (next track/arc/via).
@ STOP_AT_PAD
Stop when reaching a pad.
@ STOP_NEVER
Select the entire net.
@ STOP_AT_JUNCTION
Stop at any place where more than two traces meet.
int Main(const TOOL_EVENT &aEvent)
The main loop.
void RebuildSelection()
Rebuild the selection from the EDA_ITEMs' selection flags.
void pruneObscuredSelectionCandidates(GENERAL_COLLECTOR &aCollector) const
void OnIdle(wxIdleEvent &aEvent)
PCB_DRAW_PANEL_GAL * canvas() const
void FilterCollectorForFootprints(GENERAL_COLLECTOR &aCollector, const VECTOR2I &aWhere) const
Drop footprints that are not directly selected.
void FindItem(BOARD_ITEM *aItem)
Take necessary actions to mark an item as found.
int SelectRectArea(const TOOL_EVENT &aEvent)
Handles drawing a selection box that allows multiple items to be selected simultaneously.
int updateSelection(const TOOL_EVENT &aEvent)
Event handler to update the selection VIEW_ITEM.
bool Init() override
Init() is called once upon a registration of the tool.
BOARD * board() const
KIGFX::VIEW_GROUP m_enteredGroupOverlay
void selectConnections(const std::vector< BOARD_ITEM * > &aItems)
int hitTestDistance(const VECTOR2I &aWhere, BOARD_ITEM *aItem, int aMaxDistance) const
void selectAllConnectedShapes(const std::vector< PCB_SHAPE * > &aStartItems)
Select all non-closed shapes that are graphically connected to the given start items.
void SelectAllItemsOnNet(int aNetCode, bool aSelect=true)
Select all items with the given net code.
void FilterCollectorForTableCells(GENERAL_COLLECTOR &aCollector) const
Promote any table cell selections to the whole table.
void unselect(EDA_ITEM *aItem) override
Take necessary action mark an item as unselected.
int SelectAll(const TOOL_EVENT &aEvent)
Unselect all items on the board.
PCB_SELECTION m_selection
bool selectTableCells(PCB_TABLE *aTable)
void unhighlight(EDA_ITEM *aItem, int aHighlightMode, SELECTION *aGroup=nullptr) override
Unhighlight the item visually.
KIGFX::VIEW_CONTROLS * getViewControls() const
Return the instance of VIEW_CONTROLS object used in the application.
Definition: tool_base.cpp:44
KIGFX::VIEW * getView() const
Returns the instance of #VIEW object used in the application.
Definition: tool_base.cpp:38
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:168
KICURSOR
Definition: cursors.h:44
void Reset() override
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
The Cairo implementation of the graphics abstraction layer.
Definition: eda_group.h:33
SELECTION_MODE
This file contains data structures that are saved in the project file or project local settings file ...