KiCad PCB EDA Suite
Loading...
Searching...
No Matches
mocks.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
20#include <kiface_base.h>
21#include <confirm.h>
22#include <pcb_edit_frame.h>
23#include <eda_dde.h>
24#include <wx/file.h>
25#include <wx/snglinst.h>
26#include <wx/app.h>
27#include <board.h>
28#include <collectors.h>
30#include <footprint.h>
31#include <tools/pcb_actions.h>
33#include <router/router_tool.h>
34#include <dialog_find.h>
36#include <zone_filler.h>
39
40
42 DIALOG_FIND_BASE( aParent )
43{
44 // these members are initialized to avoid warnings about non initialized vars
45 m_frame = aParent;
46 m_hitList.clear();
47 m_it = m_hitList.begin();
48 m_upToDate = false;
49 m_board = nullptr;
50}
51
53
54void DIALOG_FIND::OnBoardChanged( wxCommandEvent& event ) {}
55
56void DIALOG_FIND::onFindNextClick( wxCommandEvent& aEvent )
57{
58}
59
60void DIALOG_FIND::onFindPreviousClick( wxCommandEvent& aEvent )
61{
62}
63
64void DIALOG_FIND::onSearchAgainClick( wxCommandEvent& aEvent )
65{
66}
67
68void DIALOG_FIND::onTextEnter( wxCommandEvent& event )
69{
70}
71
72void DIALOG_FIND::onShowSearchPanel( wxHyperlinkEvent& event )
73{
74}
75
76bool DIALOG_FIND::Show( bool show )
77{
78 return true;
79}
80
81
82DIALOG_FIND_BASE::DIALOG_FIND_BASE( wxWindow* parent, wxWindowID id, const wxString& title,
83 const wxPoint& pos, const wxSize& size, long style ) :
84 DIALOG_SHIM( parent, id, title, pos, size, style )
85{
86 // these members are initialized only to avoid warnings about non initialized vars
87 searchStringLabel = nullptr;
88 m_searchCombo = nullptr;
89 m_matchCase = nullptr;
90 m_matchWords = nullptr;
91 m_wildcards = nullptr;
92 m_wrap = nullptr;
93 m_includeValues = nullptr;
94 m_includeReferences = nullptr;
95 m_includeTexts = nullptr;
96 m_includeMarkers = nullptr;
97 m_includeNets = nullptr;
98 m_findNext = nullptr;
99 m_findPrevious = nullptr;
100 m_searchAgain = nullptr;
101 m_closeButton = nullptr;
102 m_status = nullptr;
103}
104
105
107{
108}
109
110
112 const wxString& title,
113 const wxPoint& pos, const wxSize& size,
114 long style ) :
115 DIALOG_SHIM( parent, id, title, pos, size, style )
116{
117 // these members are initialized only to avoid warnings about non initialized vars
118 m_Include_Modules = nullptr;
119 m_Include_PcbTexts = nullptr;
120 m_IncludeLockedModules = nullptr;
121 m_Include_Draw_Items = nullptr;
122 m_Include_Tracks = nullptr;
123 m_Include_Vias = nullptr;
124 m_Include_Edges_Items = nullptr;
125 m_Include_Zones = nullptr;
126 m_sdbSizer1 = nullptr;
127 m_sdbSizer1OK = nullptr;
128 m_sdbSizer1Cancel = nullptr;
129}
130
131
133{
134}
135
136
139 m_options( aOptions )
140{
141 // silence another compiler warning about m_options not being used
142 if( m_options.includeFootprints )
143 {
144 }
145}
146
147
148void DIALOG_FILTER_SELECTION::checkBoxClicked( wxCommandEvent& aEvent )
149{
150}
151
152
153void DIALOG_FILTER_SELECTION::allItemsClicked( wxCommandEvent& aEvent )
154{
155}
156
157
159{
160 return true;
161}
162
163
165{
166 return true;
167}
168
169
171{
172}
173
174
175
177
178
183{
184public:
185 DIALOG_FILTER_SELECTION::OPTIONS m_filterOpts;
186};
187
188
190 SELECTION_TOOL( "common.InteractiveSelection" ),
191 m_frame( NULL ),
192 m_enteredGroup( NULL ),
193 m_nonModifiedCursor( KICURSOR::ARROW ),
194 m_lockedItemsFiltered( false ),
195 m_priv( nullptr )
196{
197}
198
199
201{
202}
203
204
206{
207 return true;
208}
209
210
211void PCB_SELECTION_TOOL::Reset( RESET_REASON aReason )
212{
213}
214
215
216int PCB_SELECTION_TOOL::Main( const TOOL_EVENT& aEvent )
217{
218 return 0;
219}
220
221
223{
224}
225
226
227void PCB_SELECTION_TOOL::ExitGroup( bool aSelectGroup )
228{
229}
230
231
233{
234 return m_selection;
235}
236
237
239{
240 m_lockedItemsFiltered = false;
241 return m_selection;
242}
243
244
246{
247 return GENERAL_COLLECTORS_GUIDE( LSET(), PCB_LAYER_ID::UNDEFINED_LAYER, nullptr );
248}
249
250
251bool PCB_SELECTION_TOOL::selectPoint( const VECTOR2I& aWhere, bool aOnDrag,
252 bool* aSelectionCancelledFlag,
253 CLIENT_SELECTION_FILTER aClientFilter )
254{
255 return false;
256}
257
258
259bool PCB_SELECTION_TOOL::selectCursor( bool aForceSelect, CLIENT_SELECTION_FILTER aClientFilter )
260{
261 return false;
262}
263
264
266 bool aExclusiveOr )
267{
268}
269
270
272{
273 return 0;
274}
275
276
278{
279 return 0;
280}
281
282
283int PCB_SELECTION_TOOL::SelectAll( const TOOL_EVENT& aEvent )
284{
285 return 0;
286}
287
288
290{
291 return 0;
292}
293
294
296 const std::vector<BOARD_CONNECTED_ITEM*>& aStartItems, STOP_CONDITION aStopCondition )
297{
298}
299
300
301void PCB_SELECTION_TOOL::SelectAllItemsOnNet( int aNetCode, bool aSelect )
302{
303}
304
305
306int PCB_SELECTION_TOOL::selectNet( const TOOL_EVENT& aEvent )
307{
308 return 0;
309}
310
311
312void PCB_SELECTION_TOOL::selectAllItemsOnSheet( wxString& aSheetPath )
313{
314}
315
316
318{
319}
320
321
323{
324 return 0;
325}
326
327
329{
330 return 0;
331}
332
333
335{
336 return false;
337}
338
339
347static bool itemIsIncludedByFilter( const BOARD_ITEM& aItem, const BOARD& aBoard,
348 const DIALOG_FILTER_SELECTION::OPTIONS& aFilterOptions )
349{
350 return false;
351}
352
353
355{
356 return 0;
357}
358
359
360void PCB_SELECTION_TOOL::FilterCollectedItems( GENERAL_COLLECTOR& aCollector, bool aMultiSelect,
362{
363}
364
365
366bool PCB_SELECTION_TOOL::itemPassesFilter( BOARD_ITEM* aItem, bool aMultiSelect,
368{
369 return true;
370}
371
372
373void PCB_SELECTION_TOOL::ClearSelection( bool aQuietMode )
374{
375}
376
377
379{
380}
381
382
383bool PCB_SELECTION_TOOL::Selectable( const BOARD_ITEM* aItem, bool checkVisibilityOnly ) const
384{
385 return false;
386}
387
388
389bool PCB_SELECTION_TOOL::selectionContains( const VECTOR2I& aPoint ) const
390{
391 return false;
392}
393
395 const VECTOR2I& aWhere ) const
396{
397}
398
399
401{
402 return 0;
403}
404
405
407{
408}
409
410
412{
413}
414
415
417{
418}
419
420
421void PCB_SELECTION_TOOL::highlight( EDA_ITEM* aItem, int aHighlightMode,
422 SELECTION* aGroup )
423{
424}
425
426
427void PCB_SELECTION_TOOL::unhighlight( EDA_ITEM* aItem, int aHighlightMode,
428 SELECTION* aGroup )
429{
430}
431
434 const wxString& aCommitMessage, int aOptions )
435{
436}
437
438
440{
441 return true;
442}
443
444
445void PCB_TOOL_BASE::Reset( RESET_REASON aReason )
446{
447}
448
449
451{
452}
453
454
456{
457 return false;
458}
459
460
462{
463 return false;
464}
465
466
468{
469}
470
471
474 m_fillInProgress( false )
475{
476}
477
478
480{
481}
482
483
484void ZONE_FILLER_TOOL::Reset( RESET_REASON aReason )
485{
486}
487
488
490{
491}
492
493
495{
496 static PCBNEW_SETTINGS::DISPLAY_OPTIONS disp;
497
498 return disp;
499}
500
502{
503 return nullptr;
504}
505
506
508{
509 static PCB_SELECTION sel;
510
511 return sel;
512}
513
514
516{
517 static PCB_SELECTION sel;
518
519 return sel;
520}
521
523{
524 return BOX2I();
525}
526
527
528EDA_ITEM* PCB_SELECTION::GetTopLeftItem( bool onlyModules ) const
529{
530 return nullptr;
531}
532
533
534const std::vector<KIGFX::VIEW_ITEM*> PCB_SELECTION::updateDrawList() const
535{
536 std::vector<VIEW_ITEM*> items;
537
538 return items;
539}
540
541
542#if 0
544
549TRACK_BALL::TRACK_BALL(float x) : CAMERA(x) {};
552
553#endif
554
556
558{
559 return nullptr;
560}
561
562
564{
565 return 0;
566}
std::function< void(const VECTOR2I &, GENERAL_COLLECTOR &, PCB_SELECTION_TOOL *)> CLIENT_SELECTION_FILTER
Definition actions.h:33
BOX2< VECTOR2I > BOX2I
Definition box2.h:918
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:81
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:372
A class used to derive camera objects from.
Definition camera.h:99
Class DIALOG_FILTER_SELECTION_BASE.
DIALOG_FILTER_SELECTION_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Filter Selected Items"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
void checkBoxClicked(wxCommandEvent &aEvent) override
DIALOG_FILTER_SELECTION(PCB_BASE_FRAME *aParent, OPTIONS &aOptions)
Create the filter selection dialog.
void allItemsClicked(wxCommandEvent &aEvent) override
Class DIALOG_FIND_BASE.
DIALOG_FIND_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE)
~DIALOG_FIND() override
void onTextEnter(wxCommandEvent &event) override
DIALOG_FIND(PCB_EDIT_FRAME *aParent)
bool Show(bool show=true) override
The Show method is overridden to make the search combobox focused by default.
void onFindNextClick(wxCommandEvent &event) override
void onSearchAgainClick(wxCommandEvent &event) override
void onShowSearchPanel(wxHyperlinkEvent &event) override
void onFindPreviousClick(wxCommandEvent &event) override
void OnBoardChanged(wxCommandEvent &event)
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition dialog_shim.h:65
A base class for most all the KiCad significant classes used in schematics and boards.
Definition eda_item.h:96
A general implementation of a COLLECTORS_GUIDE.
Definition collectors.h:320
Used when the right click button is pressed, or when the select tool is in effect.
Definition collectors.h:203
Represent a selection area (currently a rectangle) in a VIEW, drawn corner-to-corner between two poin...
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
The main frame for Pcbnew.
Private implementation of firewalled private data.
DIALOG_FILTER_SELECTION::OPTIONS m_filterOpts
The selection tool: currently supports:
void highlight(EDA_ITEM *aItem, int aHighlightMode, SELECTION *aGroup=nullptr) override
Highlight the item visually.
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 Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
void EnterGroup() override
Enter the group at the head of the current selection.
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...
void ExitGroup(bool aSelectGroup=false) override
Leave the currently-entered group.
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.
PCB_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter)
Return the current selection, filtered according to aClientFilter.
bool itemPassesFilter(BOARD_ITEM *aItem, bool aMultiSelect, PCB_SELECTION_FILTER_OPTIONS *aRejected=nullptr)
const GENERAL_COLLECTORS_GUIDE getCollectorsGuide() const
bool Selectable(const BOARD_ITEM *aItem, bool checkVisibilityOnly=false) const
bool selectPoint(const VECTOR2I &aWhere, bool aOnDrag=false, bool *aSelectionCancelledFlag=nullptr, CLIENT_SELECTION_FILTER aClientFilter=nullptr)
Select an item pointed by the parameter aWhere.
void selectAllItemsOnSheet(wxString &aSheetPath)
Select all items with the given sheet timestamp/UUID name (the sheet path).
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.
int expandConnection(const TOOL_EVENT &aEvent)
Expand the current connected-item selection to the next boundary (junctions, pads,...
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 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.
int CursorSelection(const TOOL_EVENT &aEvent)
int ClearSelection(const TOOL_EVENT &aEvent)
PCB_SELECTION & GetSelection()
int Main(const TOOL_EVENT &aEvent)
The main loop.
void RebuildSelection()
Rebuild the selection from the EDA_ITEMs' selection flags.
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.
void SelectAllItemsOnNet(int aNetCode, bool aSelect=true)
Select all items with the given net code.
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.
void FilterCollectedItems(GENERAL_COLLECTOR &aCollector, bool aMultiSelect, PCB_SELECTION_FILTER_OPTIONS *aRejected=nullptr)
Apply the SELECTION_FITLER_OPTIONS to the collector.
void unhighlight(EDA_ITEM *aItem, int aHighlightMode, SELECTION *aGroup=nullptr) override
Unhighlight the item visually.
EDA_ITEM * GetTopLeftItem(bool aFootprintsOnly=false) const override
BOX2I GetBoundingBox() const override
const std::vector< KIGFX::VIEW_ITEM * > updateDrawList() const override
virtual bool Is45Limited() const
Should the tool use its 45° mode option?
PCB_DRAW_PANEL_GAL * canvas() const
PCBNEW_SETTINGS::DISPLAY_OPTIONS & displayOptions() const
virtual void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
virtual bool Init() override
Init() is called once upon a registration of the tool.
virtual void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
void doInteractiveItemPlacement(const TOOL_EVENT &aTool, INTERACTIVE_PLACER_BASE *aPlacer, const wxString &aCommitMessage, int aOptions=IPO_ROTATE|IPO_FLIP|IPO_REPEAT)
Helper function for performing a common interactive idiom: wait for a left click, place an item there...
virtual bool Is90Limited() const
Should the tool limit drawing to horizontal and vertical only?
const PCB_SELECTION & selection() const
static void NeighboringSegmentFilter(const VECTOR2I &aPt, GENERAL_COLLECTOR &aCollector, PCB_SELECTION_TOOL *aSelTool)
Generic, UI-independent tool event.
Definition tool_event.h:167
TRACK_BALL(float aInitialDistance)
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
This file is part of the common library.
KICURSOR
Definition cursors.h:40
DDE server & client.
@ UNDEFINED_LAYER
Definition layer_ids.h:57
const FAB_LAYER_COLOR * GetColorStandardList()
Definition mocks.cpp:557
int GetColorStandardListCount()
Definition mocks.cpp:563
static bool itemIsIncludedByFilter(const BOARD_ITEM &aItem, const BOARD &aBoard, const DIALOG_FILTER_SELECTION::OPTIONS &aFilterOptions)
Function itemIsIncludedByFilter()
Definition mocks.cpp:347
OBJECT_2D_TYPE
Definition object_2d.h:41
BBOX_3D()
Create with default values a bounding box (not initialized)
Definition bbox_3d.cpp:33
~BBOX_3D()
Definition bbox_3d.cpp:52
Struct that will be set with the result of the user choices in the dialog.
This file contains data structures that are saved in the project file or project local settings file ...
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:683
#define ZONE_FILLER_TOOL_NAME