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 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 <core/optional.h>
23 
24 #include "class_draw_panel_gal.h"
25 #include "board.h"
26 
27 #include <pcb_edit_frame.h>
28 #include <pcbnew_id.h>
29 #include <view/view_controls.h>
30 #include <pcb_painter.h>
33 #include <tool/action_menu.h>
34 #include <tool/tool_manager.h>
35 #include <tools/pcb_actions.h>
36 #include "pns_segment.h"
37 #include "pns_router.h"
38 #include "pns_meander_placer.h" // fixme: move settings to separate header
39 #include "pns_tune_status_popup.h"
40 
41 #include "length_tuner_tool.h"
42 #include <bitmaps.h>
43 #include <tools/tool_event_utils.h>
44 
45 using namespace KIGFX;
46 
47 // Actions, being statically-defined, require specialized I18N handling. We continue to
48 // use the _() macro so that string harvesting by the I18N framework doesn't have to be
49 // specialized, but we don't translate on initialization and instead do it in the getters.
50 
51 #undef _
52 #define _(s) s
53 
54 static TOOL_ACTION ACT_StartTuning( "pcbnew.LengthTuner.StartTuning",
55  AS_CONTEXT,
56  'X', LEGACY_HK_NAME( "Add New Track" ),
57  _( "New Track" ), _( "Starts laying a new track." ) );
58 
59 static TOOL_ACTION ACT_EndTuning( "pcbnew.LengthTuner.EndTuning",
60  AS_CONTEXT,
61  WXK_END, LEGACY_HK_NAME( "Stop laying the current track." ),
62  _( "End Track" ), _( "Stops laying the current meander." ) );
63 
64 static TOOL_ACTION ACT_Settings( "pcbnew.LengthTuner.Settings",
65  AS_CONTEXT,
66  // Don't be tempted to remove "Modern Toolset only". It's in the legacy property name.
67  MD_CTRL + 'L', LEGACY_HK_NAME( "Length Tuning Settings (Modern Toolset only)" ),
68  _( "Length Tuning Settings..." ), _( "Sets the length tuning parameters for currently routed item." ),
70 
71 static TOOL_ACTION ACT_SpacingIncrease( "pcbnew.LengthTuner.SpacingIncrease",
72  AS_CONTEXT,
73  '1', LEGACY_HK_NAME( "Increase meander spacing by one step." ),
74  _( "Increase Spacing" ), _( "Increase meander spacing by one step." ),
76 
77 static TOOL_ACTION ACT_SpacingDecrease( "pcbnew.LengthTuner.SpacingDecrease",
78  AS_CONTEXT,
79  '2', LEGACY_HK_NAME( "Decrease meander spacing by one step." ),
80  _( "Decrease Spacing" ), _( "Decrease meander spacing by one step." ),
82 
83 static TOOL_ACTION ACT_AmplIncrease( "pcbnew.LengthTuner.AmplIncrease",
84  AS_CONTEXT,
85  '3', LEGACY_HK_NAME( "Increase meander amplitude by one step." ),
86  _( "Increase Amplitude" ), _( "Increase meander amplitude by one step." ),
88 
89 static TOOL_ACTION ACT_AmplDecrease( "pcbnew.LengthTuner.AmplDecrease",
90  AS_CONTEXT,
91  '4', LEGACY_HK_NAME( "Decrease meander amplitude by one step." ),
92  _( "Decrease Amplitude" ), _( "Decrease meander amplitude by one step." ),
94 
95 #undef _
96 #define _(s) wxGetTranslation((s))
97 
98 
100  TOOL_BASE( "pcbnew.LengthTuner" )
101 {
102 }
103 
104 
106 {
107 }
108 
109 
111 {
112  auto& menu = m_menu.GetMenu();
113 
114  menu.SetTitle( _( "Length Tuner" ) );
115  menu.SetIcon( router_len_tuner_xpm );
116  menu.DisplayTitle( true );
117 
119 
120  menu.AddSeparator();
121 
127 
128  return true;
129 }
130 
132 {
133  if( aReason == RUN )
134  TOOL_BASE::Reset( aReason );
135 }
136 
137 
139 {
140  // fixme: wx code not allowed inside tools!
141  wxPoint p = wxGetMousePosition();
142 
143  p.x += 20;
144  p.y += 20;
145 
146  aPopup.UpdateStatus( m_router );
147  aPopup.Move( p );
148 }
149 
150 
152 {
153  if( m_startItem )
154  {
156 
157  if( m_startItem->Net() >= 0 )
158  highlightNet( true, m_startItem->Net() );
159  }
160 
161  controls()->ForceCursorPosition( false );
162  controls()->SetAutoPan( true );
163 
165  {
167  highlightNet( false );
168  return;
169  }
170 
171  auto placer = static_cast<PNS::MEANDER_PLACER_BASE*>( m_router->Placer() );
172 
173  placer->UpdateSettings( m_savedMeanderSettings );
174  frame()->UndoRedoBlock( true );
175 
177 
178  // Create an instance of PNS_TUNE_STATUS_POPUP.
179  PNS_TUNE_STATUS_POPUP statusPopup( frame() );
180  statusPopup.Popup();
181 
182  m_router->Move( end, NULL );
183  updateStatusPopup( statusPopup );
184 
185  auto setCursor =
186  [&]()
187  {
189  };
190 
191  // Set initial cursor
192  setCursor();
193 
194  while( TOOL_EVENT* evt = Wait() )
195  {
196  setCursor();
197 
198  if( evt->IsCancelInteractive() || evt->IsActivate() )
199  {
200  break;
201  }
202  else if( evt->IsMotion() )
203  {
204  end = evt->Position();
205  m_router->Move( end, NULL );
206  updateStatusPopup( statusPopup );
207  }
208  else if( evt->IsClick( BUT_LEFT ) )
209  {
210  if( m_router->FixRoute( evt->Position(), NULL ) )
211  break;
212  }
213  else if( evt->IsClick( BUT_RIGHT ) )
214  {
216  }
217  else if( evt->IsAction( &ACT_EndTuning ) )
218  {
219  if( m_router->FixRoute( end, NULL ) )
220  break;
221  }
222  else if( evt->IsAction( &ACT_AmplDecrease ) )
223  {
224  placer->AmplitudeStep( -1 );
225  m_router->Move( end, NULL );
226  updateStatusPopup( statusPopup );
227  }
228  else if( evt->IsAction( &ACT_AmplIncrease ) )
229  {
230  placer->AmplitudeStep( 1 );
231  m_router->Move( end, NULL );
232  updateStatusPopup( statusPopup );
233  }
234  else if(evt->IsAction( &ACT_SpacingDecrease ) )
235  {
236  placer->SpacingStep( -1 );
237  m_router->Move( end, NULL );
238  updateStatusPopup( statusPopup );
239  }
240  else if( evt->IsAction( &ACT_SpacingIncrease ) )
241  {
242  placer->SpacingStep( 1 );
243  m_router->Move( end, NULL );
244  updateStatusPopup( statusPopup );
245  }
246  else if( evt->IsAction( &ACT_Settings ) )
247  {
248  statusPopup.Hide();
251  statusPopup.Show();
252  }
253  }
254 
256  frame()->UndoRedoBlock( false );
257 
258  controls()->SetAutoPan( false );
259  controls()->ForceCursorPosition( false );
261  highlightNet( false );
262 }
263 
264 
266 {
270 }
271 
272 
274 {
275  // Deselect all items
277 
278  std::string tool = aEvent.GetCommandStr().get();
279  frame()->PushTool( tool );
280  Activate();
281 
283 
284  controls()->ShowCursor( true );
285 
286  auto setCursor =
287  [&]()
288  {
290  };
291 
292  // Set initial cursor
293  setCursor();
294 
295  // Main loop: keep receiving events
296  while( TOOL_EVENT* evt = Wait() )
297  {
298  setCursor();
299 
300  if( evt->IsCancelInteractive() || evt->IsActivate() )
301  {
302  break; // Finish
303  }
304  else if( evt->IsMotion() )
305  {
306  updateStartItem( *evt );
307  }
308  else if( evt->IsClick( BUT_LEFT ) || evt->IsAction( &ACT_StartTuning ) )
309  {
310  updateStartItem( *evt );
311  performTuning();
312  }
313  else if( evt->IsAction( &ACT_Settings ) )
314  {
317  }
318  else if( evt->IsClick( BUT_RIGHT ) )
319  {
321  }
322  else
323  {
324  evt->SetPassEvent();
325  }
326  }
327 
328  // Store routing settings till the next invocation
330 
332  frame()->PopTool( tool );
333  return 0;
334 }
335 
337 {
338  PNS::MEANDER_PLACER_BASE* placer = static_cast<PNS::MEANDER_PLACER_BASE*>( m_router->Placer() );
339 
340  PNS::MEANDER_SETTINGS settings = placer ? placer->MeanderSettings() : m_savedMeanderSettings;
341  DIALOG_PNS_LENGTH_TUNING_SETTINGS settingsDlg( frame(), settings, m_router->Mode() );
342 
343  if( settingsDlg.ShowModal() == wxID_OK )
344  {
345  if( placer )
346  placer->UpdateSettings( settings );
347 
348  m_savedMeanderSettings = settings;
349  }
350 
351  return 0;
352 }
static TOOL_ACTION selectionClear
Clear the current selection.
Definition: pcb_actions.h:63
const wxString & FailureReason() const
Definition: pns_router.h:211
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.
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.
const BITMAP_OPAQUE router_len_tuner_setup_xpm[1]
#define LEGACY_HK_NAME(x)
Definition: actions.h:35
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:175
Action belongs to a particular tool (i.e. a part of a pop-up menu)
Definition: tool_event.h:149
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:80
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
PLACEMENT_ALGO * Placer()
Definition: pns_router.h:213
static TOOL_ACTION routerTuneDiffPair
Activation of the Push and Shove router (diff pair tuning mode)
Definition: pcb_actions.h:192
static TOOL_ACTION cancelInteractive
Definition: actions.h:65
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
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
void updateStatusPopup(PNS_TUNE_STATUS_POPUP &aPopup)
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: sch_symbol.cpp:69
void UndoRedoBlock(bool aBlock=true)
Enable/disable undo and redo operations.
Dimensions for the meandering algorithm.
Definition: pns_meander.h:57
SIZES_SETTINGS & Sizes()
Definition: pns_router.h:208
virtual void UpdateSettings(const MEANDER_SETTINGS &aSettings)
const BITMAP_OPAQUE router_len_tuner_dist_incr_xpm[1]
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).
void SetCurrentCursor(KICURSOR cursor)
Set the current cursor shape for this panel.
static TOOL_ACTION routerTuneDiffPairSkew
Activation of the Push and Shove router (skew tuning mode)
Definition: pcb_actions.h:195
int meanderSettingsDialog(const TOOL_EVENT &aEvent)
int Start() const
Definition: pns_layerset.h:82
PCB_BASE_EDIT_FRAME * frame() const
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 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."), router_len_tuner_amplitude_incr_xpm)
const PCB_SELECTION & selection() const
#define NULL
const BITMAP_OPAQUE router_len_tuner_amplitude_incr_xpm[1]
PNS::MEANDER_SETTINGS m_savedMeanderSettings
virtual void PopTool(const std::string &actionName)
int Net() const
Definition: pns_item.h:148
T Parameter() const
Return a non-standard parameter assigned to the event.
Definition: tool_event.h:443
Generic, UI-independent tool event.
Definition: tool_event.h:173
ITEM * m_startItem
Definition: pns_tool_base.h:69
const BITMAP_OPAQUE router_len_tuner_dist_decr_xpm[1]
bool FixRoute(const VECTOR2I &aP, ITEM *aItem, bool aForceFinish=false)
Definition: pns_router.cpp:613
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
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:389
bool StartRouting(const VECTOR2I &aP, ITEM *aItem, int aLayer)
Definition: pns_router.cpp:339
virtual void SetAutoPan(bool aEnabled)
Turn on/off auto panning (this feature is used when there is a tool active (eg.
const BITMAP_OPAQUE router_len_tuner_amplitude_decr_xpm[1]
void StopRouting()
Definition: pns_router.cpp:656
virtual void highlightNet(bool aEnabled, int aNetcode=-1)
static TOOL_ACTION ACT_Settings("pcbnew.LengthTuner.Settings", AS_CONTEXT, MD_CTRL+ 'L', LEGACY_HK_NAME("Length Tuning Settings (Modern Toolset only)"), _("Length Tuning Settings..."), _("Sets the length tuning parameters for currently routed item."), router_len_tuner_setup_xpm)
const BITMAP_OPAQUE router_len_tuner_xpm[1]
OPT< std::string > GetCommandStr() const
Definition: tool_event.h:471
ROUTER_MODE
Definition: pns_router.h:68
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."), router_len_tuner_dist_incr_xpm)
void SetTitle(const wxString &aTitle) override
Set title for the menu.
Definition: action_menu.cpp:89
KIGFX::VIEW_CONTROLS * controls() const
void SetMode(ROUTER_MODE aMode)
Definition: pns_router.cpp:782
int MainLoop(const TOOL_EVENT &aEvent)
Base abstract interface for all kinds of tools.
Definition: tool_base.h:66
Represent a single user action.
Definition: tool_action.h:49
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."), router_len_tuner_dist_decr_xpm)
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
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."), router_len_tuner_amplitude_decr_xpm)
void Activate()
Run the tool.
KIGFX::VIEW_CONTROLS * getViewControls() const
Return the instance of VIEW_CONTROLS object used in the application.
Definition: tool_base.cpp:42
#define _(s)
ROUTER_MODE Mode() const
Definition: pns_router.h:136
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:150
static TOOL_ACTION routerTuneSingleTrace
Activation of the Push and Shove router (tune single line mode)
Definition: pcb_actions.h:189