KiCad PCB EDA Suite
length_tuner_tool.cpp
Go to the documentation of this file.
1 /*
2  * KiRouter - a push-and-(sometimes-)shove PCB router
3  *
4  * Copyright (C) 2013-2017 CERN
5  * Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  * Author: Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
7  *
8  * This program is free software: you can redistribute it and/or modify it
9  * under the terms of the GNU General Public License as published by the
10  * Free Software Foundation, either version 3 of the License, or (at your
11  * option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License along
19  * with this program. If not, see <http://www.gnu.org/licenses/>.
20  */
21 
22 #include "class_draw_panel_gal.h"
24 #include <tool/tool_manager.h>
25 #include <tools/pcb_actions.h>
26 #include "pns_router.h"
27 #include "pns_meander_placer.h" // fixme: move settings to separate header
28 #include "pns_tune_status_popup.h"
29 
30 #include "length_tuner_tool.h"
31 #include <bitmaps.h>
32 #include <tools/tool_event_utils.h>
33 
34 using namespace KIGFX;
35 
36 // Actions, being statically-defined, require specialized I18N handling. We continue to
37 // use the _() macro so that string harvesting by the I18N framework doesn't have to be
38 // specialized, but we don't translate on initialization and instead do it in the getters.
39 
40 #undef _
41 #define _(s) s
42 
43 static TOOL_ACTION ACT_StartTuning( "pcbnew.LengthTuner.StartTuning",
44  AS_CONTEXT,
45  'X', LEGACY_HK_NAME( "Add New Track" ),
46  _( "New Track" ), _( "Starts laying a new track." ) );
47 
48 static TOOL_ACTION ACT_EndTuning( "pcbnew.LengthTuner.EndTuning",
49  AS_CONTEXT,
50  WXK_END, LEGACY_HK_NAME( "Stop laying the current track." ),
51  _( "End Track" ), _( "Stops laying the current meander." ) );
52 
53 static TOOL_ACTION ACT_SpacingIncrease( "pcbnew.LengthTuner.SpacingIncrease",
54  AS_CONTEXT,
55  '1', LEGACY_HK_NAME( "Increase meander spacing by one step." ),
56  _( "Increase Spacing" ), _( "Increase meander spacing by one step." ),
58 
59 static TOOL_ACTION ACT_SpacingDecrease( "pcbnew.LengthTuner.SpacingDecrease",
60  AS_CONTEXT,
61  '2', LEGACY_HK_NAME( "Decrease meander spacing by one step." ),
62  _( "Decrease Spacing" ), _( "Decrease meander spacing by one step." ),
64 
65 static TOOL_ACTION ACT_AmplIncrease( "pcbnew.LengthTuner.AmplIncrease",
66  AS_CONTEXT,
67  '3', LEGACY_HK_NAME( "Increase meander amplitude by one step." ),
68  _( "Increase Amplitude" ), _( "Increase meander amplitude by one step." ),
70 
71 static TOOL_ACTION ACT_AmplDecrease( "pcbnew.LengthTuner.AmplDecrease",
72  AS_CONTEXT,
73  '4', LEGACY_HK_NAME( "Decrease meander amplitude by one step." ),
74  _( "Decrease Amplitude" ), _( "Decrease meander amplitude by one step." ),
76 
77 #undef _
78 #define _(s) wxGetTranslation((s))
79 
80 
82  TOOL_BASE( "pcbnew.LengthTuner" )
83 {
84  // set the initial tune mode for the settings dialog,
85  // in case the dialog is opened before the tool is activated the first time
87 }
88 
89 
91 {
92 }
93 
94 
96 {
97  auto& menu = m_menu.GetMenu();
98 
99  menu.SetTitle( _( "Length Tuner" ) );
100  menu.SetIcon( BITMAPS::router_len_tuner );
101  menu.DisplayTitle( true );
102 
104 
105  menu.AddSeparator();
106 
112 
113  return true;
114 }
115 
116 
118 {
119  if( aReason == RUN )
120  TOOL_BASE::Reset( aReason );
121 }
122 
123 
125 {
126  // fixme: wx code not allowed inside tools!
127  wxPoint p = wxGetMousePosition();
128 
129  p.x += 20;
130  p.y += 20;
131 
132  aPopup.UpdateStatus( m_router );
133  aPopup.Move( p );
134 }
135 
136 
138 {
139  if( m_startItem )
140  {
142 
143  if( m_startItem->Net() >= 0 )
144  highlightNet( true, m_startItem->Net() );
145  }
146 
147  controls()->ForceCursorPosition( false );
148  controls()->SetAutoPan( true );
149 
150  int layer = m_startItem ? m_startItem->Layer() : static_cast<int>( frame()->GetActiveLayer() );
151 
153  {
155  highlightNet( false );
156  return;
157  }
158 
159  auto placer = static_cast<PNS::MEANDER_PLACER_BASE*>( m_router->Placer() );
160 
161  placer->UpdateSettings( m_savedMeanderSettings );
162  frame()->UndoRedoBlock( true );
163 
165 
166  // Create an instance of PNS_TUNE_STATUS_POPUP.
167  PNS_TUNE_STATUS_POPUP statusPopup( frame() );
168  statusPopup.Popup();
169 
170  m_router->Move( end, nullptr );
171  updateStatusPopup( statusPopup );
172 
173  auto setCursor =
174  [&]()
175  {
177  };
178 
179  // Set initial cursor
180  setCursor();
181 
182  while( TOOL_EVENT* evt = Wait() )
183  {
184  setCursor();
185 
186  if( evt->IsCancelInteractive() || evt->IsActivate() )
187  {
188  break;
189  }
190  else if( evt->IsMotion() )
191  {
192  end = evt->Position();
193  m_router->Move( end, nullptr );
194  updateStatusPopup( statusPopup );
195  }
196  else if( evt->IsClick( BUT_LEFT ) )
197  {
198  if( m_router->FixRoute( evt->Position(), nullptr ) )
199  break;
200  }
201  else if( evt->IsClick( BUT_RIGHT ) )
202  {
204  }
205  else if( evt->IsAction( &ACT_EndTuning ) )
206  {
207  if( m_router->FixRoute( end, nullptr ) )
208  break;
209  }
210  else if( evt->IsAction( &ACT_AmplDecrease ) )
211  {
212  placer->AmplitudeStep( -1 );
213  m_router->Move( end, nullptr );
214  updateStatusPopup( statusPopup );
215  }
216  else if( evt->IsAction( &ACT_AmplIncrease ) )
217  {
218  placer->AmplitudeStep( 1 );
219  m_router->Move( end, nullptr );
220  updateStatusPopup( statusPopup );
221  }
222  else if(evt->IsAction( &ACT_SpacingDecrease ) )
223  {
224  placer->SpacingStep( -1 );
225  m_router->Move( end, nullptr );
226  updateStatusPopup( statusPopup );
227  }
228  else if( evt->IsAction( &ACT_SpacingIncrease ) )
229  {
230  placer->SpacingStep( 1 );
231  m_router->Move( end, nullptr );
232  updateStatusPopup( statusPopup );
233  }
234  else if( evt->IsAction( &PCB_ACTIONS::lengthTunerSettingsDialog ) )
235  {
236  statusPopup.Hide();
239  statusPopup.Show();
240  }
241  }
242 
244  frame()->UndoRedoBlock( false );
245 
246  controls()->SetAutoPan( false );
247  controls()->ForceCursorPosition( false );
249  highlightNet( false );
250 }
251 
252 
254 {
259 
260  // in case tool is inactive, otherwise the event is handled in the tool loop
263 }
264 
265 
267 {
268  // Deselect all items
270 
271  std::string tool = aEvent.GetCommandStr().get();
272  frame()->PushTool( tool );
273 
274  auto setCursor =
275  [&]()
276  {
278  };
279 
280  Activate();
281  // Must be done after Activate() so that it gets set into the correct context
282  controls()->ShowCursor( true );
283  // Set initial cursor
284  setCursor();
285 
286  // Router mode must be set after Activate()
289 
290  // Main loop: keep receiving events
291  while( TOOL_EVENT* evt = Wait() )
292  {
293  setCursor();
294 
295  if( evt->IsCancelInteractive() || evt->IsActivate() )
296  {
297  break; // Finish
298  }
299  else if( evt->Action() == TA_UNDO_REDO_PRE )
300  {
301  m_router->ClearWorld();
302  }
303  else if( evt->Action() == TA_UNDO_REDO_POST || evt->Action() == TA_MODEL_CHANGE )
304  {
305  m_router->SyncWorld();
306  }
307  else if( evt->IsMotion() )
308  {
309  updateStartItem( *evt );
310  }
311  else if( evt->IsClick( BUT_LEFT ) || evt->IsAction( &ACT_StartTuning ) )
312  {
313  updateStartItem( *evt );
314  performTuning();
315  }
316  else if( evt->IsAction( &PCB_ACTIONS::lengthTunerSettingsDialog ) )
317  {
320  }
321  else if( evt->IsClick( BUT_RIGHT ) )
322  {
324  }
325  else
326  {
327  evt->SetPassEvent();
328  }
329  }
330 
331  // Store routing settings till the next invocation
333 
335  frame()->PopTool( tool );
336  return 0;
337 }
338 
339 
341 {
342  PNS::MEANDER_PLACER_BASE* placer = static_cast<PNS::MEANDER_PLACER_BASE*>( m_router->Placer() );
343 
344  PNS::MEANDER_SETTINGS settings = placer ? placer->MeanderSettings() : m_savedMeanderSettings;
345  DIALOG_PNS_LENGTH_TUNING_SETTINGS settingsDlg( frame(), settings, m_lastTuneMode );
346 
347  if( settingsDlg.ShowModal() == wxID_OK )
348  {
349  if( placer )
350  placer->UpdateSettings( settings );
351 
352  m_savedMeanderSettings = settings;
353  }
354 
355  return 0;
356 }
static TOOL_ACTION selectionClear
Clear the current selection.
Definition: pcb_actions.h:59
const wxString & FailureReason() const
Definition: pns_router.h:203
virtual void ShowCursor(bool aEnabled)
Enable or disables display of cursor.
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
Base class for Single trace & Differential pair meandering tools, as both of them share a lot of code...
TOOL_MENU m_menu
The functions below are not yet implemented - their interface may change.
virtual int Layer() const
Definition: pns_item.h:156
void SetCurrentCursor(KICURSOR aCursor)
Set the current cursor shape for this panel.
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Suspend execution of the tool until an event specified in aEventList arrives.
virtual VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Return the current mouse pointer position.
#define LEGACY_HK_NAME(x)
Definition: actions.h:32
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:236
VECTOR2I m_startSnapPoint
Definition: pns_tool_base.h:70
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
static TOOL_ACTION ACT_StartTuning("pcbnew.LengthTuner.StartTuning", AS_CONTEXT, 'X', LEGACY_HK_NAME("Add New Track"), _("New Track"), _("Starts laying a new track."))
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:46
Tool is invoked after being inactive.
Definition: tool_base.h:79
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:214
PLACEMENT_ALGO * Placer()
Definition: pns_router.h:205
static TOOL_ACTION routerTuneDiffPair
Activation of the Push and Shove router (diff pair tuning mode)
Definition: pcb_actions.h:187
static TOOL_ACTION cancelInteractive
Definition: actions.h:62
virtual void PushTool(const std::string &actionName)
NB: the definition of "tool" is different at the user level.
SIZES_SETTINGS m_savedSizes
Definition: pns_tool_base.h:68
void SyncWorld()
Definition: pns_router.cpp:92
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:143
void updateStatusPopup(PNS_TUNE_STATUS_POPUP &aPopup)
void UndoRedoBlock(bool aBlock=true)
Enable/disable undo and redo operations.
Dimensions for the meandering algorithm.
Definition: pns_meander.h:58
SIZES_SETTINGS & Sizes()
Definition: pns_router.h:200
static TOOL_ACTION ACT_SpacingIncrease("pcbnew.LengthTuner.SpacingIncrease", AS_CONTEXT, '1', LEGACY_HK_NAME("Increase meander spacing by one step."), _("Increase Spacing"), _("Increase meander spacing by one step."), BITMAPS::router_len_tuner_dist_incr)
virtual void UpdateSettings(const MEANDER_SETTINGS &aSettings)
static TOOL_ACTION ACT_AmplDecrease("pcbnew.LengthTuner.AmplDecrease", AS_CONTEXT, '4', LEGACY_HK_NAME("Decrease meander amplitude by one step."), _("Decrease Amplitude"), _("Decrease meander amplitude by one step."), BITMAPS::router_len_tuner_amplitude_decr)
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).
static TOOL_ACTION routerTuneDiffPairSkew
Activation of the Push and Shove router (skew tuning mode)
Definition: pcb_actions.h:190
void ClearWorld()
Definition: pns_router.cpp:102
int meanderSettingsDialog(const TOOL_EVENT &aEvent)
int Start() const
Definition: pns_layerset.h:82
PCB_BASE_EDIT_FRAME * frame() const
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
virtual void updateStartItem(const TOOL_EVENT &aEvent, bool aIgnorePads=false)
void ShowInfoBarMsg(const wxString &aMsg, bool aShowCloseButton=false)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of...
virtual void Reset(RESET_REASON aReason)=0
Bring the tool to a known, initial state.
static TOOL_ACTION lengthTunerSettingsDialog
Definition: pcb_actions.h:197
const PCB_SELECTION & selection() const
PNS::MEANDER_SETTINGS m_savedMeanderSettings
virtual void PopTool(const std::string &actionName)
int Net() const
Definition: pns_item.h:150
T Parameter() const
Return a non-standard parameter assigned to the event.
Definition: tool_event.h:432
Generic, UI-independent tool event.
Definition: tool_event.h:152
ITEM * m_startItem
Definition: pns_tool_base.h:69
static TOOL_ACTION ACT_AmplIncrease("pcbnew.LengthTuner.AmplIncrease", AS_CONTEXT, '3', LEGACY_HK_NAME("Increase meander amplitude by one step."), _("Increase Amplitude"), _("Increase meander amplitude by one step."), BITMAPS::router_len_tuner_amplitude_incr)
bool FixRoute(const VECTOR2I &aP, ITEM *aItem, bool aForceFinish=false)
Definition: pns_router.cpp:665
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
ROUTER * m_router
Definition: pns_tool_base.h:78
Action belongs to a particular tool (i.e. a part of a pop-up menu)
virtual void Popup(wxWindow *aFocus=nullptr)
bool Init() override
Init() is called once upon a registration of the tool.
void UpdateStatus(PNS::ROUTER *aRouter)
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Place the cursor immediately at a given point.
virtual void SetActiveLayer(PCB_LAYER_ID aLayer)
virtual void Move(const wxPoint &aWhere)
void Move(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:427
bool StartRouting(const VECTOR2I &aP, ITEM *aItem, int aLayer)
Definition: pns_router.cpp:370
virtual void SetAutoPan(bool aEnabled)
Turn on/off auto panning (this feature is used when there is a tool active (eg.
void StopRouting()
Definition: pns_router.cpp:708
virtual void highlightNet(bool aEnabled, int aNetcode=-1)
OPT< std::string > GetCommandStr() const
Definition: tool_event.h:460
ROUTER_MODE
Definition: pns_router.h:62
void SetTitle(const wxString &aTitle) override
Set title for the menu.
Definition: action_menu.cpp:87
KIGFX::VIEW_CONTROLS * controls() const
void SetMode(ROUTER_MODE aMode)
Definition: pns_router.cpp:834
static TOOL_ACTION ACT_SpacingDecrease("pcbnew.LengthTuner.SpacingDecrease", AS_CONTEXT, '2', LEGACY_HK_NAME("Decrease meander spacing by one step."), _("Decrease Spacing"), _("Decrease meander spacing by one step."), BITMAPS::router_len_tuner_dist_decr)
int MainLoop(const TOOL_EVENT &aEvent)
Base abstract interface for all kinds of tools.
Definition: tool_base.h:65
Represent a single user action.
Definition: tool_action.h:67
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:77
void Activate()
Run the tool.
PNS::ROUTER_MODE m_lastTuneMode
KIGFX::VIEW_CONTROLS * getViewControls() const
Return the instance of VIEW_CONTROLS object used in the application.
Definition: tool_base.cpp:42
#define _(s)
static TOOL_ACTION ACT_EndTuning("pcbnew.LengthTuner.EndTuning", AS_CONTEXT, WXK_END, LEGACY_HK_NAME("Stop laying the current track."), _("End Track"), _("Stops laying the current meander."))
virtual const MEANDER_SETTINGS & MeanderSettings() const
Return the current meandering configuration.
void ShowContextMenu(SELECTION &aSelection)
Helper function to set and immediately show a CONDITIONAL_MENU in concert with the given SELECTION.
Definition: tool_menu.cpp:59
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:905
const LAYER_RANGE & Layers() const
Definition: pns_item.h:152
static TOOL_ACTION routerTuneSingleTrace
Activation of the Push and Shove router (tune single line mode)
Definition: pcb_actions.h:184