KiCad PCB EDA Suite
Loading...
Searching...
No Matches
global_edit_tool.cpp
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 The KiCad Developers, see AUTHORS.TXT for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
21#include <footprint.h>
22#include <pcb_track.h>
23#include <pcb_generator.h>
24#include <tool/tool_manager.h>
25#include <tools/pcb_actions.h>
26#include <tools/edit_tool.h>
36#include <pcb_edit_frame.h>
37
38
40 PCB_TOOL_BASE( "pcbnew.GlobalEdit" ),
41 m_selectionTool( nullptr )
42{
43}
44
45
47{
48 m_commit = std::make_unique<BOARD_COMMIT>( frame() );
49}
50
51
53{
54 // Find the selection tool, so they can cooperate
56
57 return true;
58}
59
60
62{
64 PCB_SELECTION& selection = m_selectionTool->GetSelection();
65 FOOTPRINT* footprint = nullptr;
66 bool updateMode = false;
67 bool currentMode = false;
68
69 if( aEvent.HasPosition() )
70 selection = m_selectionTool->RequestSelection( EDIT_TOOL::FootprintFilter );
71
72 if( !selection.Empty() )
73 footprint = selection.FirstOfKind<FOOTPRINT>();
74
76 {
77 updateMode = true;
78 currentMode = true;
79 }
80 else if( aEvent.IsAction( &PCB_ACTIONS::updateFootprints ) )
81 {
82 updateMode = true;
83 currentMode = selection.CountType( PCB_FOOTPRINT_T ) > 0;
84 }
85 else if( aEvent.IsAction( &PCB_ACTIONS::changeFootprint ) )
86 {
87 updateMode = false;
88 currentMode = true;
89 }
90 else if( aEvent.IsAction( &PCB_ACTIONS::changeFootprints ) )
91 {
92 updateMode = false;
93 currentMode = selection.CountType( PCB_FOOTPRINT_T ) > 0;
94 }
95 else
96 {
97 wxFAIL_MSG( wxT( "ExchangeFootprints: unexpected action" ) );
98 }
99
100 DIALOG_EXCHANGE_FOOTPRINTS dialog( editFrame, footprint, updateMode, currentMode );
101 dialog.ShowQuasiModal();
102
103 return 0;
104}
105
106
107bool GLOBAL_EDIT_TOOL::swapBoardItem( BOARD_ITEM* aItem, std::map<PCB_LAYER_ID, PCB_LAYER_ID>& aLayerMap )
108{
109 LSET originalLayers = aItem->GetLayerSet();
110 LSET newLayers;
111
112 for( PCB_LAYER_ID original : originalLayers )
113 {
114 if( aLayerMap.count( original ) )
115 newLayers.set( aLayerMap[ original ] );
116 else
117 newLayers.set( original );
118 }
119
120 if( originalLayers != newLayers )
121 {
122 m_commit->Modify( aItem, nullptr, RECURSE_MODE::RECURSE );
123 aItem->SetLayerSet( newLayers );
124 frame()->GetCanvas()->GetView()->Update( aItem, KIGFX::GEOMETRY );
125 return true;
126 }
127
128 return false;
129}
130
131
133{
134 std::map<PCB_LAYER_ID, PCB_LAYER_ID> layerMap;
135
136 DIALOG_SWAP_LAYERS dlg( frame(), layerMap );
137
138 if( dlg.ShowModal() != wxID_OK )
139 return 0;
140
141 bool hasChanges = false;
142
143 // Change tracks.
144 for( PCB_TRACK* segm : frame()->GetBoard()->Tracks() )
145 {
146 if( dynamic_cast<PCB_GENERATOR*>( segm->GetParentGroup() ) )
147 continue;
148
149 if( segm->Type() == PCB_VIA_T )
150 {
151 PCB_VIA* via = static_cast<PCB_VIA*>( segm );
152 PCB_LAYER_ID top_layer, bottom_layer;
153
154 if( via->GetViaType() == VIATYPE::THROUGH )
155 continue;
156
157 via->LayerPair( &top_layer, &bottom_layer );
158
159 if( layerMap[bottom_layer] != bottom_layer || layerMap[top_layer] != top_layer )
160 {
161 m_commit->Modify( via );
162 via->SetLayerPair( layerMap[top_layer], layerMap[bottom_layer] );
163 frame()->GetCanvas()->GetView()->Update( via, KIGFX::GEOMETRY );
164 hasChanges = true;
165 }
166 }
167 else
168 {
169 hasChanges |= swapBoardItem( segm, layerMap );
170 }
171 }
172
173 for( PCB_GENERATOR* generator : frame()->GetBoard()->Generators() )
174 hasChanges |= swapBoardItem( generator, layerMap );
175
176 for( BOARD_ITEM* zone : frame()->GetBoard()->Zones() )
177 hasChanges |= swapBoardItem( zone, layerMap );
178
179 for( BOARD_ITEM* drawing : frame()->GetBoard()->Drawings() )
180 hasChanges |= swapBoardItem( drawing, layerMap );
181
182 if( hasChanges )
183 {
184 frame()->OnModify();
185 m_commit->Push( _( "Swap Layers" ) );
186 frame()->GetCanvas()->Refresh();
187 }
188
189 return 0;
190}
191
192
194{
196 DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS dlg( editFrame );
197
198 dlg.ShowQuasiModal(); // QuasiModal required for NET_SELECTOR
199 return 0;
200}
201
202
204{
206 DIALOG_CLEANUP_TRACKS_AND_VIAS dlg( editFrame );
207
208 dlg.ShowModal();
209 return 0;
210}
211
212
214{
216 DIALOG_CLEANUP_GRAPHICS dlg( editFrame, false );
217
218 dlg.ShowModal();
219 return 0;
220}
221
222
224{
226 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
227 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
228 {
229 sTool->FilterCollectorForHierarchy( aCollector, true );
230 } );
231 DIALOG_UNUSED_PAD_LAYERS dlg( editFrame, selection, *m_commit );
232
233 dlg.ShowModal();
234
235 return 0;
236}
237
239{
241 BOARD_COMMIT commit( editFrame );
242 BOARD* board = editFrame->GetBoard();
243
244 for( ZONE* zone : board->Zones() )
245 commit.Modify( zone );
246
247 DIALOG_ZONE_MANAGER dlg( editFrame );
248
249 int dialogResult = dlg.ShowQuasiModal();
250
251 if( dialogResult == wxID_OK && dlg.GetRepourOnClose() )
252 dialogResult = ZONE_MANAGER_REPOUR;
253
254 if( dialogResult == wxID_CANCEL )
255 {
256 // The dialog hides zones in the view when they are marked for deletion
257 if( KIGFX::VIEW* view = editFrame->GetCanvas()->GetView() )
258 {
259 for( ZONE* zone : dlg.GetZonesToDelete() )
260 view->Hide( zone, false );
261 }
262
263 editFrame->GetCanvas()->Refresh();
264 return 0;
265 }
266
267 // Promote the pre-staged CHT_MODIFY entries for any zone the user marked for deletion
268 if( KIGFX::VIEW* view = editFrame->GetCanvas()->GetView() )
269 {
270 for( ZONE* zone : dlg.GetZonesToDelete() )
271 {
272 view->Hide( zone, false );
273
274 commit.Unmodify( zone, nullptr );
275 commit.Remove( zone );
276 }
277 }
278
279 // Ensure all zones are deselected before make any change in view, to avoid
280 // dangling pointers in EDIT_POINT
282 selTool->ClearSelection();
283
284 wxBusyCursor dummy;
285
286 // Clear the zone bounding box cache before Push() updates the VIEW, otherwise
287 // View->Update() will query stale cached values and the VIEW's R-Tree will be
288 // indexed with incorrect bounding boxes, causing single-click zone selection to fail.
289 board->IncrementTimeStamp();
290
291 commit.Push( _( "Zone Manager" ), SKIP_CONNECTIVITY );
292
293 board->BuildConnectivity();
294
295 if( TOOL_MANAGER* manager = GetManager() )
296 manager->PostEvent( EVENTS::ConnectivityChangedEvent );
297
298 editFrame->GetCanvas()->RedrawRatsnest();
299
300 if( dialogResult == ZONE_MANAGER_REPOUR )
301 {
302 if( TOOL_MANAGER* manager = GetManager() )
303 manager->PostAction( PCB_ACTIONS::zoneFillAll );
304 }
305
306 return 0;
307}
308
309
310
312{
314
315 if( !editFrame )
316 return 0;
317
318 DIALOG_MIGRATE_3D_MODELS dlg( editFrame );
319 dlg.ShowModal();
320 return 0;
321}
322
323
343
344
BASE_SET & set(size_t pos)
Definition base_set.h:126
void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Execute the changes.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:99
virtual void SetLayerSet(const LSET &aLayers)
Definition board_item.h:377
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition board_item.h:369
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:411
COMMIT & Remove(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Remove a new item from the model.
Definition commit.h:86
void Unmodify(EDA_ITEM *aItem, BASE_SCREEN *aScreen)
Definition commit.cpp:200
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE)
Modify a given item in the model.
Definition commit.h:102
Dialog that offers to migrate obsolete WRL 3D model references on a loaded board to current STEP mode...
int ShowModal() override
const std::vector< ZONE * > & GetZonesToDelete() const
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
static const TOOL_EVENT ConnectivityChangedEvent
Definition actions.h:351
Used when the right click button is pressed, or when the select tool is in effect.
Definition collectors.h:203
int ZonesManager(const TOOL_EVENT &aEvent)
int EditTracksAndVias(const TOOL_EVENT &aEvent)
int CleanupGraphics(const TOOL_EVENT &aEvent)
bool Init() override
Init() is called once upon a registration of the tool.
bool swapBoardItem(BOARD_ITEM *aItem, std::map< PCB_LAYER_ID, PCB_LAYER_ID > &aLayerMap)
Set up handlers for various events.
int ExchangeFootprints(const TOOL_EVENT &aEvent)
Invoke the dialog used to update or exchange the footprint definitions used for footprints.
std::unique_ptr< BOARD_COMMIT > m_commit
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
int GlobalDeletions(const TOOL_EVENT &aEvent)
int Migrate3DModels(const TOOL_EVENT &aEvent)
int CleanupTracksAndVias(const TOOL_EVENT &aEvent)
int SwapLayers(const TOOL_EVENT &aEvent)
int EditTeardrops(const TOOL_EVENT &aEvent)
PCB_SELECTION_TOOL * m_selectionTool
int RemoveUnusedPads(const TOOL_EVENT &aEvent)
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition view.h:68
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
static TOOL_ACTION editTracksAndVias
static TOOL_ACTION swapLayers
static TOOL_ACTION zonesManager
static TOOL_ACTION zoneFillAll
static TOOL_ACTION updateFootprint
static TOOL_ACTION migrate3DModels
static TOOL_ACTION cleanupTracksAndVias
static TOOL_ACTION editTextAndGraphics
static TOOL_ACTION globalDeletions
static TOOL_ACTION updateFootprints
static TOOL_ACTION removeUnusedPads
static TOOL_ACTION changeFootprints
static TOOL_ACTION changeFootprint
static TOOL_ACTION editTeardrops
static TOOL_ACTION cleanupGraphics
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
BOARD * GetBoard() const
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the KIGFX::VIEW instance used in the panel.
void RedrawRatsnest()
Force refresh of the ratsnest visual representation.
The main frame for Pcbnew.
The selection tool: currently supports:
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.
int ClearSelection(const TOOL_EVENT &aEvent)
Clear current selection event handler.
T * frame() const
KIGFX::PCB_VIEW * view() const
PCB_TOOL_BASE(TOOL_ID aId, const std::string &aName)
Constructor.
BOARD * board() const
const PCB_SELECTION & selection() const
FOOTPRINT * footprint() const
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
TOOL_MANAGER * GetManager() const
Return the instance of TOOL_MANAGER that takes care of the tool.
Definition tool_base.h:142
T * getEditFrame() const
Return the application window object, casted to requested user type.
Definition tool_base.h:182
TOOL_MANAGER * m_toolMgr
Definition tool_base.h:220
RESET_REASON
Determine the reason of reset for a tool.
Definition tool_base.h:74
Generic, UI-independent tool event.
Definition tool_event.h:167
bool HasPosition() const
Returns if it this event has a valid position (true for mouse events and context-menu or hotkey-based...
Definition tool_event.h:256
bool IsAction(const TOOL_ACTION *aAction) const
Test if the event contains an action issued upon activation of the given TOOL_ACTION.
void Go(int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
Define which state (aStateFunc) to go when a certain event arrives (aConditions).
friend class TOOL_MANAGER
T * GetTool()
Return the tool of given type or nullptr if there is no such tool registered.
Handle a list of polygons defining a copper zone.
Definition zone.h:70
#define _(s)
@ RECURSE
Definition eda_item.h:51
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:56
@ GEOMETRY
Position or shape has changed.
Definition view_item.h:51
#define SKIP_CONNECTIVITY
Definition sch_commit.h:41
std::vector< FAB_LAYER_COLOR > dummy
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition typeinfo.h:89
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition typeinfo.h:78
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:708
#define ZONE_MANAGER_REPOUR
Definition zones.h:39