KiCad PCB EDA Suite
ROUTER_TOOL Class Reference

#include <router_tool.h>

Inheritance diagram for ROUTER_TOOL:
PNS::TOOL_BASE PCB_TOOL TOOL_INTERACTIVE TOOL_BASE

Public Types

enum  RESET_REASON { RUN, MODEL_RELOAD, GAL_SWITCH }
 

Determines the reason of reset for a tool

More...
 

Public Member Functions

 ROUTER_TOOL ()
 
 ~ROUTER_TOOL ()
 
bool Init () override
 Function Init() Init() is called once upon a registration of the tool. More...
 
void Reset (RESET_REASON aReason) override
 Function Reset() Brings the tool to a known, initial state. More...
 
int RouteSingleTrace (const TOOL_EVENT &aEvent)
 
int RouteDiffPair (const TOOL_EVENT &aEvent)
 
int InlineDrag (const TOOL_EVENT &aEvent)
 
int DpDimensionsDialog (const TOOL_EVENT &aEvent)
 
int SettingsDialog (const TOOL_EVENT &aEvent)
 
int CustomTrackWidthDialog (const TOOL_EVENT &aEvent)
 
void setTransitions () override
 This method is meant to be overridden in order to specify handlers for events. More...
 
ROUTER * Router () const
 
void SetEditModules (bool aEnabled)
 Function SetEditModules() More...
 
bool EditingModules () const
 
void Activate ()
 Function Activate() Runs the tool. More...
 
void SetContextMenu (CONTEXT_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
 Function SetContextMenu() More...
 
void RunMainStack (std::function< void()> aFunc)
 Function RunMainStack() More...
 
template<class T >
void Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
 Function Go() More...
 
OPT_TOOL_EVENT Wait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
 Function Wait() More...
 
TOOL_TYPE GetType () const
 Function GetType() Returns the type of the tool. More...
 
TOOL_ID GetId () const
 Function GetId() Returns the unique identifier of the tool. More...
 
const std::string & GetName () const
 Function GetName() Returns the name of the tool. More...
 
TOOL_MANAGERGetManager () const
 Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool. More...
 
TOOL_SETTINGSGetSettings ()
 
bool IsToolActive () const
 

Static Public Attributes

static TOOL_ACTION ACT_RouterOptions
 

Protected Types

enum  INTERACTIVE_PLACEMENT_OPTIONS {
  IPO_ROTATE = 1, IPO_FLIP = 2, IPO_PROPERTIES = 4, IPO_SINGLE_CLICK = 8,
  IPO_REPEAT = 16
}
 

Protected Member Functions

bool checkSnap (ITEM *aItem)
 
const VECTOR2I snapToItem (bool aEnabled, ITEM *aItem, VECTOR2I aP)
 
virtual ITEM * pickSingleItem (const VECTOR2I &aWhere, int aNet=-1, int aLayer=-1)
 
virtual void highlightNet (bool aEnabled, int aNetcode=-1)
 
virtual void updateStartItem (TOOL_EVENT &aEvent)
 
virtual void updateEndItem (const TOOL_EVENT &aEvent)
 
void deleteTraces (ITEM *aStartItem, bool aWholeTrack)
 
void doInteractiveItemPlacement (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 (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc. More...
 
KIGFX::PCB_VIEWview () const
 
KIGFX::VIEW_CONTROLScontrols () const
 
PCB_EDIT_FRAMEframe () const
 
BOARDboard () const
 
MODULEmodule () const
 
PCB_DISPLAY_OPTIONSdisplayOptions () const
 
PCB_DRAW_PANEL_GALcanvas () const
 
const TOOL_EVENT evActivate (std::string aToolName="")
 functions below are not yet implemented - their interface may change More...
 
const TOOL_EVENT evCommand (int aCommandId=-1)
 
const TOOL_EVENT evCommand (std::string aCommandStr="")
 
const TOOL_EVENT evMotion ()
 
const TOOL_EVENT evClick (int aButton=BUT_ANY)
 
const TOOL_EVENT evDrag (int aButton=BUT_ANY)
 
const TOOL_EVENT evButtonUp (int aButton=BUT_ANY)
 
const TOOL_EVENT evButtonDown (int aButton=BUT_ANY)
 
void attachManager (TOOL_MANAGER *aManager)
 Function attachManager() More...
 
KIGFX::VIEWgetView () const
 Function getView() More...
 
KIGFX::VIEW_CONTROLSgetViewControls () const
 Function getViewControls() More...
 
template<typename T >
T * getEditFrame () const
 Function getEditFrame() More...
 
template<typename T >
T * getModel () const
 Function getModel() More...
 

Protected Attributes

MSG_PANEL_ITEMS m_panelItems
 
ROUTING_SETTINGS m_savedSettings
 Stores routing settings between router invocations. More...
 
SIZES_SETTINGS m_savedSizes
 Stores sizes settings between router invocations. More...
 
ITEM * m_startItem
 
int m_startLayer
 
VECTOR2I m_startSnapPoint
 
ITEM * m_endItem
 
VECTOR2I m_endSnapPoint
 
GRID_HELPERm_gridHelper
 
PNS_KICAD_IFACEm_iface
 
ROUTER * m_router
 
bool m_editModules
 
TOOL_TYPE m_type
 

Stores the type of the tool.

More...
 
TOOL_ID m_toolId
 

Unique identifier for the tool, assigned by a TOOL_MANAGER instance.

More...
 
std::string m_toolName
 

Name of the tool.

More...
 
TOOL_MANAGERm_toolMgr
 
TOOL_SETTINGS m_toolSettings
 

Private Member Functions

int mainLoop (PNS::ROUTER_MODE aMode)
 
int getDefaultWidth (int aNetCode)
 
void performRouting ()
 
void performDragging (int aMode=PNS::DM_ANY)
 
void breakTrack ()
 
void getNetclassDimensions (int aNetCode, int &aWidth, int &aViaDiameter, int &aViaDrill)
 
void handleCommonEvents (const TOOL_EVENT &evt)
 
int getStartLayer (const PNS::ITEM *aItem)
 
void switchLayerOnViaPlacement ()
 
int onViaCommand (const TOOL_EVENT &aEvent)
 
int onTrackViaSizeChanged (const TOOL_EVENT &aEvent)
 
int onLayerChanged (const TOOL_EVENT &aEvent)
 
bool prepareInteractive ()
 
bool finishInteractive ()
 

Detailed Description

Definition at line 28 of file router_tool.h.

Member Enumeration Documentation

enum PCB_TOOL::INTERACTIVE_PLACEMENT_OPTIONS
protectedinherited
Enumerator
IPO_ROTATE 
IPO_FLIP 
IPO_PROPERTIES 
IPO_SINGLE_CLICK 
IPO_REPEAT 

Definition at line 103 of file pcb_tool.h.

enum TOOL_BASE::RESET_REASON
inherited

Determines the reason of reset for a tool

Enumerator
RUN 

Tool is invoked after being inactive.

MODEL_RELOAD 

Model changes (required full reload)

GAL_SWITCH 

Rendering engine changes.

Definition at line 80 of file tool_base.h.

81  {
82  RUN,
83  MODEL_RELOAD,
84  GAL_SWITCH
85  };
Model changes (required full reload)
Definition: tool_base.h:83
Tool is invoked after being inactive.
Definition: tool_base.h:82
Rendering engine changes.
Definition: tool_base.h:84

Constructor & Destructor Documentation

ROUTER_TOOL::ROUTER_TOOL ( )

Definition at line 199 of file router_tool.cpp.

199  :
200  TOOL_BASE( "pcbnew.InteractiveRouter" )
201 {
202 }
TOOL_BASE(const std::string &aToolName)
ROUTER_TOOL::~ROUTER_TOOL ( )

Definition at line 364 of file router_tool.cpp.

References TOOL_BASE::GetSettings(), PNS::TOOL_BASE::m_savedSettings, and PNS::ROUTING_SETTINGS::Save().

365 {
367 }
ROUTING_SETTINGS m_savedSettings
Stores routing settings between router invocations.
Definition: pns_tool_base.h:67
TOOL_SETTINGS & GetSettings()
Definition: tool_base.cpp:77
void Save(TOOL_SETTINGS &where) const

Member Function Documentation

void TOOL_INTERACTIVE::Activate ( )
inherited

Function Activate() Runs the tool.

After activation, the tool starts receiving events until it is finished.

Definition at line 49 of file tool_interactive.cpp.

References TOOL_MANAGER::InvokeTool(), TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

Referenced by EDIT_TOOL::copyToClipboard(), PCBNEW_CONTROL::DeleteItemCursor(), PCB_TOOL::doInteractiveItemPlacement(), DpDimensionsDialog(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::drawZone(), PCB_EDITOR_CONTROL::DrillOrigin(), MODULE_EDITOR_TOOLS::EnumeratePads(), PCBNEW_CONTROL::GridSetOrigin(), PCB_EDITOR_CONTROL::HighlightNetCursor(), InlineDrag(), EDIT_TOOL::Main(), LENGTH_TUNER_TOOL::mainLoop(), mainLoop(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), POINT_EDITOR::OnSelectionChange(), EDIT_TOOL::pickCopyReferencePoint(), DRAWING_TOOL::PlaceDXF(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), DRAWING_TOOL::SetAnchor(), SettingsDialog(), and PCB_EDITOR_CONTROL::ShowLocalRatsnest().

50 {
52 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
TOOL_ID m_toolId
Unique identifier for the tool, assigned by a TOOL_MANAGER instance.
Definition: tool_base.h:210
bool InvokeTool(TOOL_ID aToolId)
Function InvokeTool() Calls a tool by sending a tool activation event to tool of given ID...
void TOOL_BASE::attachManager ( TOOL_MANAGER aManager)
protectedinherited

Function attachManager()

Sets the TOOL_MANAGER the tool will belong to. Called by TOOL_MANAGER::RegisterTool()

Definition at line 59 of file tool_base.cpp.

References TOOL_BASE::m_toolMgr, TOOL_BASE::m_toolSettings, and TOOL_BASE::TOOL_SETTINGS.

Referenced by TOOL_MANAGER::RegisterTool().

60 {
61  m_toolMgr = aManager;
62  m_toolSettings = TOOL_SETTINGS( this );
63 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
TOOL_SETTINGS m_toolSettings
Definition: tool_base.h:216
friend class TOOL_SETTINGS
Definition: tool_base.h:155
BOARD* PCB_TOOL::board ( ) const
inlineprotectedinherited

Definition at line 134 of file pcb_tool.h.

Referenced by PCBNEW_CONTROL::AppendBoard(), PCB_EDITOR_CONTROL::calculateSelectionRatsnest(), EDIT_TOOL::changeTrackWidthOnClick(), EDIT_TOOL::copyToClipboard(), MICROWAVE_TOOL::createInductorBetween(), MODULE_EDITOR_TOOLS::CreatePadFromShapes(), CustomTrackWidthDialog(), PCB_TOOL::doInteractiveItemPlacement(), MODULE_EDITOR_TOOLS::EnumeratePads(), MODULE_EDITOR_TOOLS::ExplodePadToShapes(), SELECTION_TOOL::filterSelection(), SELECTION_TOOL::getCollectorsGuide(), getNetclassDimensions(), PCBNEW_CONTROL::GridResetOrigin(), PAD_TOOL::haveFootprints(), PCBNEW_CONTROL::LayerNext(), PCBNEW_CONTROL::LayerPrev(), mainLoop(), PCB_TOOL::module(), MODULE_EDITOR_TOOLS::ModuleEdgeOutlines(), MODULE_EDITOR_TOOLS::ModuleTextOutlines(), onTrackViaSizeChanged(), onViaCommand(), PCBNEW_CONTROL::PadDisplayMode(), PCBNEW_CONTROL::PasteItemsFromClipboard(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDITOR_CONTROL::PlaceModule(), MODULE_EDITOR_TOOLS::PlacePad(), PCB_EDITOR_CONTROL::PlaceTarget(), prepareInteractive(), PCBNEW_CONTROL::Reset(), PNS::TOOL_BASE::Reset(), SELECTION_TOOL::selectable(), SELECTION_TOOL::selectAllItemsConnectedToItem(), SELECTION_TOOL::selectAllItemsConnectedToTrack(), SELECTION_TOOL::selectAllItemsOnNet(), SELECTION_TOOL::selectAllItemsOnSheet(), SELECTION_TOOL::selectPoint(), PCBNEW_CONTROL::TrackDisplayMode(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), PCBNEW_CONTROL::ViaDisplayMode(), PCB_EDITOR_CONTROL::ViaSizeDec(), PCB_EDITOR_CONTROL::ViaSizeInc(), PCBNEW_CONTROL::ZoneDisplayMode(), PCB_EDITOR_CONTROL::ZoneFillAll(), PCB_EDITOR_CONTROL::ZoneMerge(), and PCB_EDITOR_CONTROL::ZoneUnfillAll().

134 { return getModel<BOARD>(); }
void ROUTER_TOOL::breakTrack ( )
private

Definition at line 843 of file router_tool.cpp.

References PNS::ROUTER::BreakSegment(), PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, PNS::TOOL_BASE::m_startSnapPoint, PNS::ITEM::OfKind(), and PNS::ITEM::SEGMENT_T.

Referenced by mainLoop().

844 {
846  {
848  }
849 }
VECTOR2I m_startSnapPoint
Definition: pns_tool_base.h:71
bool OfKind(int aKindMask) const
Function OfKind()
Definition: pns_item.h:130
void BreakSegment(ITEM *aItem, const VECTOR2I &aP)
Definition: pns_router.cpp:498
ITEM * m_startItem
Definition: pns_tool_base.h:69
ROUTER * m_router
Definition: pns_tool_base.h:78
PCB_DRAW_PANEL_GAL * PCB_TOOL::canvas ( ) const
protectedinherited

Definition at line 213 of file pcb_tool.cpp.

References PCB_TOOL::frame(), and EDA_DRAW_FRAME::GetGalCanvas().

Referenced by PCBNEW_CONTROL::HighContrastMode(), PCBNEW_CONTROL::PadDisplayMode(), PCBNEW_CONTROL::TrackDisplayMode(), PCBNEW_CONTROL::ViaDisplayMode(), PCBNEW_CONTROL::ZoneDisplayMode(), and SELECTION_TOOL::zoomFitSelection().

214 {
215  return static_cast<PCB_DRAW_PANEL_GAL*>( frame()->GetGalCanvas() );
216 }
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
EDA_DRAW_PANEL_GAL * GetGalCanvas() const
Function GetGalCanvas returns a pointer to GAL-based canvas of given EDA draw frame.
Definition: draw_frame.h:870
bool TOOL_BASE::checkSnap ( ITEM aItem)
protectedinherited

Definition at line 199 of file pns_tool_base.cpp.

References CAPTURE_ALWAYS, CAPTURE_CURSOR_IN_TRACK_TOOL, PCB_TOOL::frame(), PNS::TOOL_BASE::m_router, PNS::ITEM::OfKind(), PNS::ITEM::SEGMENT_T, PNS::ROUTER::Settings(), PCB_BASE_FRAME::Settings(), PNS::ITEM::SOLID_T, and PNS::ITEM::VIA_T.

Referenced by PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

200 {
201  bool doSnap = false;
202 
203  // Sync PNS engine settings with the general PCB editor options. I know the code below is awful, but...
204  auto& pnss = m_router->Settings();
205  const auto& gens = frame()->Settings();
206 
207  pnss.SetSnapToTracks( false );
208  pnss.SetSnapToPads( false );
209 
210  if( gens.m_magneticPads == CAPTURE_CURSOR_IN_TRACK_TOOL || gens.m_magneticPads == CAPTURE_ALWAYS )
211  pnss.SetSnapToPads( true );
212 
213  if( gens.m_magneticTracks == CAPTURE_CURSOR_IN_TRACK_TOOL || gens.m_magneticTracks == CAPTURE_ALWAYS )
214  pnss.SetSnapToTracks( true );
215 
216  if( aItem )
217  {
218  if( ( aItem->OfKind( ITEM::VIA_T ) || aItem->OfKind( ITEM::SEGMENT_T ) ) && pnss.GetSnapToTracks() )
219  doSnap = true;
220  else if( aItem->OfKind( ITEM::SOLID_T ) && pnss.GetSnapToPads() )
221  doSnap = true;
222  }
223 
224  return doSnap;
225 }
PCB_GENERAL_SETTINGS & Settings()
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
ROUTER * m_router
Definition: pns_tool_base.h:78
ROUTING_SETTINGS & Settings()
Definition: pns_router.h:187
int ROUTER_TOOL::CustomTrackWidthDialog ( const TOOL_EVENT aEvent)

Definition at line 1065 of file router_tool.cpp.

References PCB_TOOL::board(), PCB_TOOL::frame(), BOARD::GetDesignSettings(), TOOL_BASE::m_toolMgr, TOOL_MANAGER::RunAction(), PCB_ACTIONS::trackViaSizeChanged, and BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize().

Referenced by setTransitions().

1066 {
1068  DIALOG_TRACK_VIA_SIZE sizeDlg( frame(), bds );
1069 
1070  if( sizeDlg.ShowModal() )
1071  {
1072  bds.UseCustomTrackViaSize( true );
1074  }
1075 
1076  return 0;
1077 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
static TOOL_ACTION trackViaSizeChanged
Definition: pcb_actions.h:278
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:532
Implementing DIALOG_TRACK_VIA_SIZE_BASE.
void UseCustomTrackViaSize(bool aEnabled)
Function UseCustomTrackViaSize Enables/disables custom track/via size settings.
Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.
BOARD * board() const
Definition: pcb_tool.h:134
void TOOL_BASE::deleteTraces ( ITEM aStartItem,
bool  aWholeTrack 
)
protectedinherited

Definition at line 315 of file pns_tool_base.cpp.

References PNS::TOPOLOGY::AssembleTrivialPath(), PNS::NODE::Branch(), PNS::ROUTER::CommitRouting(), PNS::ROUTER::GetWorld(), PNS::ITEM_SET::Items(), PNS::TOOL_BASE::m_router, and PNS::NODE::Remove().

Referenced by mainLoop().

316 {
317  NODE *node = m_router->GetWorld()->Branch();
318 
319  if( !aStartItem )
320  return;
321 
322  if( !aWholeTrack )
323  {
324  node->Remove( aStartItem );
325  }
326  else
327  {
328  TOPOLOGY topo( node );
329  ITEM_SET path = topo.AssembleTrivialPath( aStartItem );
330 
331  for( auto ent : path.Items() )
332  node->Remove( ent.item );
333  }
334 
335  m_router->CommitRouting( node );
336 }
NODE * Branch()
Function Branch()
Definition: pns_node.cpp:107
NODE * GetWorld() const
Definition: pns_router.h:143
ROUTER * m_router
Definition: pns_tool_base.h:78
void Remove(SOLID *aSolid)
Function Remove()
Definition: pns_node.cpp:727
void CommitRouting(NODE *aNode)
Definition: pns_router.cpp:326
PCB_DISPLAY_OPTIONS * PCB_TOOL::displayOptions ( ) const
protectedinherited

Definition at line 208 of file pcb_tool.cpp.

References PCB_TOOL::frame(), and PCB_BASE_FRAME::GetDisplayOptions().

Referenced by PCBNEW_CONTROL::HighContrastMode(), PCBNEW_CONTROL::PadDisplayMode(), PNS::TOOL_BASE::pickSingleItem(), PCBNEW_CONTROL::TrackDisplayMode(), PCBNEW_CONTROL::ViaDisplayMode(), and PCBNEW_CONTROL::ZoneDisplayMode().

209 {
210  return static_cast<PCB_DISPLAY_OPTIONS*>( frame()->GetDisplayOptions() );
211 }
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings...
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
void PCB_TOOL::doInteractiveItemPlacement ( INTERACTIVE_PLACER_BASE aPlacer,
const wxString &  aCommitMessage,
int  aOptions = IPO_ROTATE | IPO_FLIP | IPO_REPEAT 
)
protectedinherited

Helper function for performing a common interactive idiom: wait for a left click, place an item there (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc.

More complex interactive processes are not supported here, you should implement a customised event loop for those.

Parameters
aItemCreatorthe callable that will attempt to create the item
aCommitMessagethe message used on a successful commit

Definition at line 39 of file pcb_tool.cpp.

References TOOL_INTERACTIVE::Activate(), KIGFX::PCB_VIEW::Add(), KIGFX::VIEW_GROUP::Add(), SELECTION::Add(), COMMIT::Add(), PCB_TOOL::board(), BUT_LEFT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), PCB_TOOL::controls(), INTERACTIVE_PLACER_BASE::CreateItem(), dyn_cast(), PCB_ACTIONS::flip, PCB_TOOL::frame(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_EVT_UTILS::GetEventRotationAngle(), TOOL_BASE::GetManager(), PCB_TOOL::IPO_FLIP, PCB_TOOL::IPO_REPEAT, PCB_TOOL::IPO_ROTATE, PCB_TOOL::IPO_SINGLE_CLICK, TOOL_EVT_UTILS::IsCancelInteractive(), TOOL_EVT_UTILS::IsRotateToolEvt(), INTERACTIVE_PLACER_BASE::m_board, INTERACTIVE_PLACER_BASE::m_frame, PCB_TOOL::module(), PCB_MODULE_T, INTERACTIVE_PLACER_BASE::PlaceItem(), BOARD_COMMIT::Push(), KIGFX::PCB_VIEW::Remove(), KIGFX::VIEW_GROUP::Remove(), SELECTION::Remove(), TOOL_MANAGER::RunAction(), MODULE::RunOnChildren(), PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), KIGFX::VIEW_CONTROLS::SetSnapping(), KIGFX::VIEW_CONTROLS::ShowCursor(), TC_COMMAND, KIGFX::PCB_VIEW::Update(), PCB_TOOL::view(), TOOL_INTERACTIVE::Wait(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by MICROWAVE_TOOL::addMicrowaveFootprint(), DRAWING_TOOL::DrawVia(), and MODULE_EDITOR_TOOLS::PlacePad().

42 {
43  using namespace std::placeholders;
44  std::unique_ptr<BOARD_ITEM> newItem;
45 
46  Activate();
47 
48  BOARD_COMMIT commit( frame() );
49 
51 
52  // do not capture or auto-pan until we start placing an item
53  controls()->ShowCursor( true );
54  controls()->SetSnapping( true );
55 
56  // Add a VIEW_GROUP that serves as a preview for the new item
57  SELECTION preview;
58  view()->Add( &preview );
59 
60  aPlacer->m_board = board();
61  aPlacer->m_frame = frame();
62 
63  if( aOptions & IPO_SINGLE_CLICK )
64  {
65  VECTOR2I cursorPos = controls()->GetCursorPosition();
66 
67  newItem = aPlacer->CreateItem();
68  newItem->SetPosition( wxPoint( cursorPos.x, cursorPos.y ) );
69 
70  preview.Add( newItem.get() );
71  }
72 
73  // Main loop: keep receiving events
74  while( OPT_TOOL_EVENT evt = Wait() )
75  {
76  VECTOR2I cursorPos = controls()->GetCursorPosition();
77 
79  {
80  if( newItem )
81  {
82  // Delete the old item and have another try
83  newItem = nullptr;
84 
85  preview.Clear();
86 
87  if( aOptions & IPO_SINGLE_CLICK )
88  break;
89 
90  controls()->SetAutoPan( false );
91  controls()->CaptureCursor( false );
92  controls()->ShowCursor( true );
93  }
94  else
95  {
96  break;
97  }
98 
99  if( evt->IsActivate() ) // now finish unconditionally
100  break;
101  }
102 
103  else if( evt->IsClick( BUT_LEFT ) )
104  {
105  if( !newItem )
106  {
107  // create the item if possible
108  newItem = aPlacer->CreateItem();
109 
110  // no item created, so wait for another click
111  if( !newItem )
112  continue;
113 
114  controls()->CaptureCursor( true );
115  controls()->SetAutoPan( true );
116 
117  newItem->SetPosition( wxPoint( cursorPos.x, cursorPos.y ) );
118 
119  preview.Add( newItem.get() );
120 
121  if( newItem->Type() == PCB_MODULE_T )
122  {
123  auto module = dyn_cast<MODULE*>( newItem.get() );
124 
125  // modules have more drawable parts
126  module->RunOnChildren( std::bind( &KIGFX::VIEW_GROUP::Add, &preview, _1 ) );
127  }
128  }
129  else
130  {
131  newItem->ClearFlags();
132  preview.Remove( newItem.get() );
133 
134  aPlacer->PlaceItem( newItem.get() );
135 
136  if( newItem->Type() == PCB_MODULE_T )
137  {
138  auto module = dyn_cast<MODULE*>( newItem.get() );
139  module->RunOnChildren( std::bind( &KIGFX::VIEW_GROUP::Remove, &preview, _1 ) );
140  }
141 
142  commit.Add( newItem.release() );
143  commit.Push( aCommitMessage );
144 
145  controls()->CaptureCursor( false );
146  controls()->SetAutoPan( false );
147  controls()->ShowCursor( true );
148 
149  if( !( aOptions & IPO_REPEAT ) )
150  break;
151 
152  if( aOptions & IPO_SINGLE_CLICK )
153  {
155 
156  newItem = aPlacer->CreateItem();
157  newItem->SetPosition( wxPoint( pos.x, pos.y ) );
158 
159  preview.Add( newItem.get() );
160  }
161  }
162  }
163 
164  else if( newItem && evt->Category() == TC_COMMAND )
165  {
166  /*
167  * Handle any events that can affect the item as we move
168  * it around, eg rotate and flip
169  */
170 
171  if( TOOL_EVT_UTILS::IsRotateToolEvt( *evt ) && ( aOptions & IPO_ROTATE ) )
172  {
173  const auto rotationAngle = TOOL_EVT_UTILS::GetEventRotationAngle(
174  *frame(), *evt );
175  newItem->Rotate( newItem->GetPosition(), rotationAngle );
176  view()->Update( &preview );
177  }
178  else if( evt->IsAction( &PCB_ACTIONS::flip ) && ( aOptions & IPO_FLIP ) )
179  {
180  newItem->Flip( newItem->GetPosition() );
181  view()->Update( &preview );
182  }
183  }
184 
185  else if( newItem && evt->IsMotion() )
186  {
187  // track the cursor
188  newItem->SetPosition( wxPoint( cursorPos.x, cursorPos.y ) );
189 
190  // Show a preview of the item
191  view()->Update( &preview );
192  }
193  }
194 
195  view()->Remove( &preview );
196 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:53
virtual void ShowCursor(bool aEnabled)
Function ShowCursor() Enables or disables display of cursor.
void RunOnChildren(std::function< void(BOARD_ITEM *)> aFunction)
Function RunOnChildren.
virtual void Clear() override
Function Clear() Removes all the stored items from the group.
Definition: selection.h:81
virtual bool PlaceItem(BOARD_ITEM *aItem)
Definition: pcb_tool.h:54
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags) override
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: pcb_view.cpp:81
virtual std::unique_ptr< BOARD_ITEM > CreateItem()=0
OPT_TOOL_EVENT Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
virtual void SetSnapping(bool aEnabled)
Function SetSnapping() Enables/disables snapping cursor to grid.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
PCB_EDIT_FRAME * m_frame
Definition: pcb_tool.h:56
bool IsRotateToolEvt(const TOOL_EVENT &aEvt)
Function isRotateToolEvt()
Casted dyn_cast(From aObject)
Function dyn_cast()
Definition: typeinfo.h:61
virtual void Remove(VIEW_ITEM *aItem) override
Function Remove() Removes a VIEW_ITEM from the view.
Definition: pcb_view.cpp:64
virtual void Add(EDA_ITEM *aItem)
Definition: selection.h:71
KIGFX::VIEW_CONTROLS * controls() const
Definition: pcb_tool.h:132
class MODULE, a footprint
Definition: typeinfo.h:89
virtual void CaptureCursor(bool aEnabled)
Function CaptureCursor() Forces the cursor to stay within the drawing panel area. ...
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
MODULE * module() const
Definition: pcb_tool.h:135
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes an item from the group.
Definition: view_group.cpp:61
bool IsCancelInteractive(const TOOL_EVENT &aEvt)
Function IsCancelInteractive()
virtual void Add(VIEW_ITEM *aItem)
Function Add() Adds an item to the group.
Definition: view_group.cpp:55
virtual void SetAutoPan(bool aEnabled)
Function SetAutoPan Turns on/off auto panning (this feature is used when there is a tool active (eg...
static TOOL_ACTION flip
Flipping of selected objects.
Definition: pcb_actions.h:99
KIGFX::PCB_VIEW * view() const
Definition: pcb_tool.h:131
TOOL_MANAGER * GetManager() const
Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool...
Definition: tool_base.h:144
void Activate()
Function Activate() Runs the tool.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1) override
Function Add() Adds a VIEW_ITEM to the view.
Definition: pcb_view.cpp:48
int GetEventRotationAngle(const PCB_BASE_EDIT_FRAME &aFrame, const TOOL_EVENT &aEvt)
Function getEventRotationAngle()
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:460
BOARD * board() const
Definition: pcb_tool.h:134
virtual void Remove(EDA_ITEM *aItem)
Definition: selection.h:76
int ROUTER_TOOL::DpDimensionsDialog ( const TOOL_EVENT aEvent)

Definition at line 775 of file router_tool.cpp.

References TOOL_INTERACTIVE::Activate(), PCB_TOOL::frame(), PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_savedSizes, PNS::ROUTER::Sizes(), and PNS::ROUTER::UpdateSizes().

Referenced by setTransitions().

776 {
777  Activate();
778 
780  DIALOG_PNS_DIFF_PAIR_DIMENSIONS settingsDlg( frame(), sizes );
781 
782  if( settingsDlg.ShowModal() )
783  {
784  m_router->UpdateSizes( sizes );
785  m_savedSizes = sizes;
786  }
787 
788  return 0;
789 }
SIZES_SETTINGS m_savedSizes
Stores sizes settings between router invocations.
Definition: pns_tool_base.h:68
SIZES_SETTINGS & Sizes()
Definition: pns_router.h:206
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
ROUTER * m_router
Definition: pns_tool_base.h:78
void UpdateSizes(const SIZES_SETTINGS &aSizes)
Applies stored settings.
Definition: pns_router.cpp:287
void Activate()
Function Activate() Runs the tool.
bool PCB_TOOL::EditingModules ( ) const
inlineinherited

Definition at line 96 of file pcb_tool.h.

References PCB_TOOL::m_editModules.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), PAD_TOOL::Init(), and EDIT_TOOL::MeasureTool().

97  {
98  return m_editModules;
99  }
bool m_editModules
Definition: pcb_tool.h:139
const TOOL_EVENT TOOL_INTERACTIVE::evActivate ( std::string  aToolName = "")
protectedinherited

functions below are not yet implemented - their interface may change

const TOOL_EVENT TOOL_INTERACTIVE::evButtonDown ( int  aButton = BUT_ANY)
protectedinherited
const TOOL_EVENT TOOL_INTERACTIVE::evButtonUp ( int  aButton = BUT_ANY)
protectedinherited
const TOOL_EVENT TOOL_INTERACTIVE::evClick ( int  aButton = BUT_ANY)
protectedinherited
const TOOL_EVENT TOOL_INTERACTIVE::evCommand ( int  aCommandId = -1)
protectedinherited
const TOOL_EVENT TOOL_INTERACTIVE::evCommand ( std::string  aCommandStr = "")
protectedinherited
const TOOL_EVENT TOOL_INTERACTIVE::evDrag ( int  aButton = BUT_ANY)
protectedinherited
const TOOL_EVENT TOOL_INTERACTIVE::evMotion ( )
protectedinherited
bool ROUTER_TOOL::finishInteractive ( )
private

Definition at line 700 of file router_tool.cpp.

References PCB_TOOL::controls(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL::frame(), PNS::TOOL_BASE::highlightNet(), PNS::TOOL_BASE::m_router, KIGFX::VIEW_CONTROLS::SetAutoPan(), PNS::ROUTER::StopRouting(), and PCB_BASE_EDIT_FRAME::UndoRedoBlock().

Referenced by performRouting().

701 {
703 
704  controls()->SetAutoPan( false );
705  controls()->ForceCursorPosition( false );
706  frame()->UndoRedoBlock( false );
707  highlightNet( false );
708 
709  return true;
710 }
void UndoRedoBlock(bool aBlock=true)
Function UndoRedoBlock Enables/disable undo and redo operations.
KIGFX::VIEW_CONTROLS * controls() const
Definition: pcb_tool.h:132
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
ROUTER * m_router
Definition: pns_tool_base.h:78
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
virtual void SetAutoPan(bool aEnabled)
Function SetAutoPan Turns on/off auto panning (this feature is used when there is a tool active (eg...
void StopRouting()
Definition: pns_router.cpp:368
virtual void highlightNet(bool aEnabled, int aNetcode=-1)
PCB_EDIT_FRAME* PCB_TOOL::frame ( ) const
inlineprotectedinherited
int ROUTER_TOOL::getDefaultWidth ( int  aNetCode)
private

Definition at line 383 of file router_tool.cpp.

References getNetclassDimensions().

384 {
385  int w, d1, d2;
386 
387  getNetclassDimensions( aNetCode, w, d1, d2 );
388 
389  return w;
390 }
void getNetclassDimensions(int aNetCode, int &aWidth, int &aViaDiameter, int &aViaDrill)
template<typename T >
T* TOOL_BASE::getEditFrame ( ) const
inlineprotectedinherited

Function getEditFrame()

Returns the application window object, casted to requested user type.

Definition at line 188 of file tool_base.h.

References TOOL_BASE::getEditFrameInt().

Referenced by ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), TOOL_SETTINGS::getConfigBase(), and ZONE_CREATE_HELPER::performZoneCutout().

189  {
190  return static_cast<T*>( getEditFrameInt() );
191  }
T
enum T contains all this lexer's tokens.
wxWindow * getEditFrameInt() const
Definition: tool_base.cpp:47
TOOL_ID TOOL_BASE::GetId ( ) const
inlineinherited

Function GetId() Returns the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns
Identifier of the tool.

Definition at line 122 of file tool_base.h.

References TOOL_BASE::m_toolId.

Referenced by TOOL_MANAGER::finishTool(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::isActive(), TOOL_MANAGER::RegisterTool(), ACTION_MANAGER::RunHotKey(), and TOOL_MANAGER::runTool().

123  {
124  return m_toolId;
125  }
TOOL_ID m_toolId
Unique identifier for the tool, assigned by a TOOL_MANAGER instance.
Definition: tool_base.h:210
TOOL_MANAGER* TOOL_BASE::GetManager ( ) const
inlineinherited

Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool.

Returns
Instance of the TOOL_MANAGER. If there is no TOOL_MANAGER associated, it returns NULL.

Definition at line 144 of file tool_base.h.

References TOOL_BASE::m_toolMgr.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), PCB_TOOL::doInteractiveItemPlacement(), CONTEXT_MENU::getToolManager(), EDIT_TOOL::MeasureTool(), and CONTEXT_MENU::onMenuEvent().

145  {
146  return m_toolMgr;
147  }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
template<typename T >
T* TOOL_BASE::getModel ( ) const
inlineprotectedinherited

Function getModel()

Returns the model object if it matches the requested type.

Definition at line 199 of file tool_base.h.

References TOOL_BASE::getModelInt().

Referenced by ZONE_CREATE_HELPER::createNewZone(), ZONE_CREATE_HELPER::createZoneFromExisting(), and ZONE_CREATE_HELPER::performZoneCutout().

200  {
201  EDA_ITEM* m = getModelInt();
202 
203  return static_cast<T*>( m );
204  }
T
enum T contains all this lexer's tokens.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
EDA_ITEM * getModelInt() const
Definition: tool_base.cpp:53
const std::string& TOOL_BASE::GetName ( void  ) const
inlineinherited

Function GetName() Returns the name of the tool.

Tool names are expected to obey the format: application.ToolName (eg. pcbnew.InteractiveSelection).

Returns
The name of the tool.

Definition at line 133 of file tool_base.h.

References TOOL_BASE::m_toolName.

Referenced by TOOL_SETTINGS::getKeyName(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::invokeTool(), and TOOL_MANAGER::RegisterTool().

134  {
135  return m_toolName;
136  }
std::string m_toolName
Name of the tool.
Definition: tool_base.h:214
void ROUTER_TOOL::getNetclassDimensions ( int  aNetCode,
int &  aWidth,
int &  aViaDiameter,
int &  aViaDrill 
)
private

Definition at line 393 of file router_tool.cpp.

References PCB_TOOL::board(), NETCLASSES::Find(), BOARD::FindNet(), NETINFO_ITEM::GetClassName(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), and BOARD_DESIGN_SETTINGS::m_NetClasses.

Referenced by getDefaultWidth().

395 {
397 
398  NETCLASSPTR netClass;
399  NETINFO_ITEM* ni = board()->FindNet( aNetCode );
400 
401  if( ni )
402  {
403  wxString netClassName = ni->GetClassName();
404  netClass = bds.m_NetClasses.Find( netClassName );
405  }
406 
407  if( !netClass )
408  netClass = bds.GetDefault();
409 
410  aWidth = netClass->GetTrackWidth();
411  aViaDiameter = netClass->GetViaDiameter();
412  aViaDrill = netClass->GetViaDrill();
413 }
NETCLASSPTR Find(const wxString &aName) const
Function Find searches this container for a NETCLASS given by aName.
NETCLASSPTR GetDefault() const
Function GetDefault.
wxString GetClassName() const
Function GetClassName returns the class name.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:532
Class NETINFO_ITEM handles the data for a net.
Definition: class_netinfo.h:69
NETINFO_ITEM * FindNet(int aNetcode) const
Function FindNet searches for a net with the given netcode.
NETCLASSES m_NetClasses
List of current netclasses. There is always the default netclass.
Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.
BOARD * board() const
Definition: pcb_tool.h:134
TOOL_SETTINGS & TOOL_BASE::GetSettings ( )
inherited

Definition at line 77 of file tool_base.cpp.

References TOOL_BASE::m_toolSettings.

Referenced by GERBVIEW_CONTROL::HighlightControl(), Init(), SELECTION_TOOL::selectable(), and ~ROUTER_TOOL().

78 {
79  return m_toolSettings;
80 }
TOOL_SETTINGS m_toolSettings
Definition: tool_base.h:216
int ROUTER_TOOL::getStartLayer ( const PNS::ITEM aItem)
private

Definition at line 433 of file router_tool.cpp.

References KIGFX::VIEW::GetTopLayer(), TOOL_BASE::getView(), PNS::ITEM::Layers(), PNS::TOOL_BASE::m_startItem, LAYER_RANGE::Overlaps(), and LAYER_RANGE::Start().

Referenced by prepareInteractive().

434 {
435  int tl = getView()->GetTopLayer();
436 
437  if( m_startItem )
438  {
439  const LAYER_RANGE& ls = m_startItem->Layers();
440 
441  if( ls.Overlaps( tl ) )
442  return tl;
443  else
444  return ls.Start();
445  }
446 
447  return tl;
448 }
virtual int GetTopLayer() const
Definition: view.cpp:721
const LAYER_RANGE & Layers() const
Function Layers()
Definition: pns_item.h:207
ITEM * m_startItem
Definition: pns_tool_base.h:69
int Start() const
Definition: pns_layerset.h:83
bool Overlaps(const LAYER_RANGE &aOther) const
Definition: pns_layerset.h:68
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:35
Class LAYER_RANGE.
Definition: pns_layerset.h:32
TOOL_TYPE TOOL_BASE::GetType ( ) const
inlineinherited

Function GetType() Returns the type of the tool.

Returns
The type of the tool.

Definition at line 111 of file tool_base.h.

References TOOL_BASE::m_type.

Referenced by TOOL_MANAGER::finishTool(), TOOL_MANAGER::InvokeTool(), TOOL_MANAGER::ResetTools(), and TOOL_MANAGER::runTool().

112  {
113  return m_type;
114  }
TOOL_TYPE m_type
Stores the type of the tool.
Definition: tool_base.h:207
KIGFX::VIEW * TOOL_BASE::getView ( ) const
protectedinherited

Function getView()

Returns the instance of VIEW object used in the application. It allows tools to draw.

Returns
The instance of VIEW.

Definition at line 35 of file tool_base.cpp.

References TOOL_MANAGER::GetView(), and TOOL_BASE::m_toolMgr.

Referenced by PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), PCBNEW_CONTROL::CursorControl(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), MICROWAVE_TOOL::drawMicrowaveInductor(), PCB_EDITOR_CONTROL::DrillOrigin(), MODULE_EDITOR_TOOLS::EnumeratePads(), SELECTION_TOOL::findCallback(), getStartLayer(), PCBNEW_CONTROL::GridSetOrigin(), SELECTION_TOOL::guessSelectionCandidates(), GERBVIEW_CONTROL::HighlightControl(), PNS::TOOL_BASE::highlightNet(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), MODULE_EDITOR_TOOLS::ModuleEdgeOutlines(), MODULE_EDITOR_TOOLS::ModuleTextOutlines(), EDIT_TOOL::MoveExact(), POINT_EDITOR::OnSelectionChange(), PCBNEW_CONTROL::PanControl(), PNS::TOOL_BASE::pickSingleItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), PCB_EDITOR_CONTROL::Reset(), PCBNEW_CONTROL::Reset(), PNS::TOOL_BASE::Reset(), DRAWING_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), SELECTION_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::select(), GERBVIEW_SELECTION_TOOL::selectable(), SELECTION_TOOL::selectable(), GERBVIEW_SELECTION_TOOL::selectionContains(), SELECTION_TOOL::selectionContains(), GERBVIEW_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), GERBVIEW_SELECTION_TOOL::unselect(), GERBVIEW_SELECTION_TOOL::unselectVisually(), POINT_EDITOR::updateEditedPoint(), COMMON_TOOLS::updateGrid(), PCBNEW_CONTROL::updateGrid(), POINT_EDITOR::updatePoints(), SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_TOOL::view(), COMMON_TOOLS::ZoomFitScreen(), GERBVIEW_SELECTION_TOOL::zoomFitSelection(), SELECTION_TOOL::zoomFitSelection(), COMMON_TOOLS::ZoomInOutCenter(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), and SELECTION_TOOL::~SELECTION_TOOL().

36 {
37  return m_toolMgr->GetView();
38 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:252
KIGFX::VIEW_CONTROLS * TOOL_BASE::getViewControls ( ) const
protectedinherited

Function getViewControls()

Returns the instance of VIEW_CONTROLS object used in the application. It allows tools to read & modify user input and its settings (eg. show cursor, enable snapping to grid, etc.)

Returns
The instance of VIEW_CONTROLS.

Definition at line 41 of file tool_base.cpp.

References TOOL_MANAGER::GetViewControls(), and TOOL_BASE::m_toolMgr.

Referenced by POINT_EDITOR::addCorner(), PCB_TOOL::controls(), PCBNEW_CONTROL::CursorControl(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawZone(), MODULE_EDITOR_TOOLS::EnumeratePads(), SELECTION_TOOL::findMove(), PCB_EDITOR_CONTROL::HighlightNet(), PICKER_TOOL::Main(), EDIT_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), mainLoop(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), POINT_EDITOR::OnSelectionChange(), performDragging(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::Reset(), PCBNEW_CONTROL::ResetCoords(), DRAWING_TOOL::runPolygonEventLoop(), GERBVIEW_SELECTION_TOOL::selectCursor(), SELECTION_TOOL::selectCursor(), GERBVIEW_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), ZOOM_TOOL::selectRegion(), PICKER_TOOL::setControls(), POINT_EDITOR::setEditedPoint(), EDIT_TOOL::updateModificationPoint(), COMMON_TOOLS::ZoomCenter(), and COMMON_TOOLS::ZoomInOut().

42 {
43  return m_toolMgr->GetViewControls();
44 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
KIGFX::VIEW_CONTROLS * GetViewControls() const
Definition: tool_manager.h:257
template<class T >
void TOOL_INTERACTIVE::Go ( int(T::*)(const TOOL_EVENT &)  aStateFunc,
const TOOL_EVENT_LIST aConditions = TOOL_EVENTTC_ANYTA_ANY ) 
)
inherited

Function Go()

Defines which state (aStateFunc) to go when a certain event arrives (aConditions). No conditions means any event.

Definition at line 135 of file tool_interactive.h.

References TOOL_INTERACTIVE::goInternal().

Referenced by ZOOM_TOOL::setTransitions(), LENGTH_TUNER_TOOL::setTransitions(), setTransitions(), PAD_TOOL::setTransitions(), MICROWAVE_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), POINT_EDITOR::setTransitions(), COMMON_TOOLS::setTransitions(), ALIGN_DISTRIBUTE_TOOL::setTransitions(), PCBNEW_CONTROL::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), MODULE_EDITOR_TOOLS::setTransitions(), PICKER_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), PCB_EDITOR_CONTROL::setTransitions(), SELECTION_TOOL::setTransitions(), EDIT_TOOL::setTransitions(), and DRAWING_TOOL::setTransitions().

137 {
138  TOOL_STATE_FUNC sptr = std::bind( aStateFunc, static_cast<T*>( this ), std::placeholders::_1 );
139 
140  goInternal( sptr, aConditions );
141 }
std::function< int(const TOOL_EVENT &)> TOOL_STATE_FUNC
Definition: tool_base.h:59
void goInternal(TOOL_STATE_FUNC &aState, const TOOL_EVENT_LIST &aConditions)
void ROUTER_TOOL::handleCommonEvents ( const TOOL_EVENT evt)
private

Definition at line 416 of file router_tool.cpp.

References PNS::ROUTER::DumpLog(), TOOL_EVENT::IsKeyPressed(), TOOL_EVENT::KeyCode(), and PNS::TOOL_BASE::m_router.

Referenced by performDragging().

417 {
418 #ifdef DEBUG
419  if( aEvent.IsKeyPressed() )
420  {
421  switch( aEvent.KeyCode() )
422  {
423  case '0':
424  wxLogTrace( "PNS", "saving drag/route log...\n" );
425  m_router->DumpLog();
426  break;
427  }
428  }
429 #endif
430 }
ROUTER * m_router
Definition: pns_tool_base.h:78
void DumpLog()
Definition: pns_router.cpp:445
void TOOL_BASE::highlightNet ( bool  aEnabled,
int  aNetcode = -1 
)
protectedvirtualinherited

Definition at line 187 of file pns_tool_base.cpp.

References KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), TOOL_BASE::getView(), KIGFX::RENDER_SETTINGS::SetHighlight(), and KIGFX::VIEW::UpdateAllLayersColor().

Referenced by finishInteractive(), performDragging(), LENGTH_TUNER_TOOL::performTuning(), and prepareInteractive().

188 {
190 
191  if( aNetcode >= 0 && aEnabled )
192  rs->SetHighlight( true, aNetcode );
193  else
194  rs->SetHighlight( false );
195 
197 }
Class RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output ...
Definition: painter.h:56
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:196
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:35
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:675
void SetHighlight(bool aEnabled, int aNetcode=-1)
Function SetHighlight Turns on/off highlighting - it may be done for the active layer or the specifie...
Definition: painter.h:140
bool ROUTER_TOOL::Init ( )
overridevirtual

Function Init() Init() is called once upon a registration of the tool.

Returns
True if the initialization went fine, false - otherwise.

Reimplemented from TOOL_BASE.

Definition at line 370 of file router_tool.cpp.

References TOOL_BASE::GetSettings(), PNS::ROUTING_SETTINGS::Load(), and PNS::TOOL_BASE::m_savedSettings.

371 {
373  return true;
374 }
void Load(const TOOL_SETTINGS &where)
ROUTING_SETTINGS m_savedSettings
Stores routing settings between router invocations.
Definition: pns_tool_base.h:67
TOOL_SETTINGS & GetSettings()
Definition: tool_base.cpp:77
int ROUTER_TOOL::InlineDrag ( const TOOL_EVENT aEvent)

Definition at line 995 of file router_tool.cpp.

References TOOL_INTERACTIVE::Activate(), BUT_LEFT, PCB_TOOL::controls(), PNS::NODE::FindItemByParent(), PNS::ROUTER::FixRoute(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL::frame(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_MANAGER::GetTool(), PNS::ROUTER::GetWorld(), PNS::ITEM::IsLocked(), IsOK(), PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, TOOL_BASE::m_toolMgr, PNS::ROUTER::Move(), TOOL_EVENT::Parameter(), PCB_TRACE_T, PCB_VIA_T, PNS::ROUTER::RoutingInProgress(), TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectionCursor, KIGFX::VIEW_CONTROLS::SetAutoPan(), KIGFX::VIEW_CONTROLS::ShowCursor(), PNS::ROUTER::StartDragging(), PNS::ROUTER::StopRouting(), PNS::ROUTER::SyncWorld(), EDA_ITEM::Type(), PCB_BASE_EDIT_FRAME::UndoRedoBlock(), PNS::TOOL_BASE::updateEndItem(), and TOOL_INTERACTIVE::Wait().

Referenced by setTransitions().

996 {
997  // Get the item under the cursor
999  const auto& selection = m_toolMgr->GetTool<SELECTION_TOOL>()->GetSelection();
1000 
1001  if( selection.Size() != 1 )
1002  return 0;
1003 
1004  const BOARD_CONNECTED_ITEM* item = static_cast<const BOARD_CONNECTED_ITEM*>( selection.Front() );
1005 
1006  if( item->Type() != PCB_TRACE_T && item->Type() != PCB_VIA_T )
1007  return 0;
1008 
1009  Activate();
1010 
1012  m_router->SyncWorld();
1014 
1015  if( m_startItem && m_startItem->IsLocked() )
1016  {
1017  if( !IsOK( frame(), _( "The item is locked. Do you want to continue?" ) ) )
1018  return false;
1019  }
1020 
1022 
1023  int dragMode = aEvent.Parameter<int64_t> ();
1024 
1025  bool dragStarted = m_router->StartDragging( p0, m_startItem, dragMode );
1026 
1027  if( !dragStarted )
1028  return 0;
1029 
1030  controls()->ShowCursor( true );
1031  controls()->ForceCursorPosition( false );
1032  controls()->SetAutoPan( true );
1033  frame()->UndoRedoBlock( true );
1034 
1035  while( OPT_TOOL_EVENT evt = Wait() )
1036  {
1037  if( evt->IsCancel() )
1038  {
1039  break;
1040  }
1041  else if( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) )
1042  {
1043  updateEndItem( *evt );
1045  }
1046  else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) )
1047  {
1048  updateEndItem( *evt );
1050  break;
1051  }
1052  }
1053 
1054  if( m_router->RoutingInProgress() )
1055  m_router->StopRouting();
1056 
1057  controls()->SetAutoPan( false );
1058  controls()->ShowCursor( false );
1059  frame()->UndoRedoBlock( false );
1060 
1061  return 0;
1062 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:53
virtual void ShowCursor(bool aEnabled)
Function ShowCursor() Enables or disables display of cursor.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
Class SELECTION_TOOL.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
void SyncWorld()
Definition: pns_router.cpp:91
OPT_TOOL_EVENT Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
void UndoRedoBlock(bool aBlock=true)
Function UndoRedoBlock Enables/disable undo and redo operations.
Class BOARD_CONNECTED_ITEM is a base class derived from BOARD_ITEM for items that can be connected an...
NODE * GetWorld() const
Definition: pns_router.h:143
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
bool RoutingInProgress() const
Definition: pns_router.cpp:112
KIGFX::VIEW_CONTROLS * controls() const
Definition: pcb_tool.h:132
virtual void updateEndItem(const TOOL_EVENT &aEvent)
bool IsLocked() const
Definition: pns_item.h:336
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
ITEM * m_startItem
Definition: pns_tool_base.h:69
bool FixRoute(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:343
ROUTER * m_router
Definition: pns_tool_base.h:78
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
void Move(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:204
virtual void SetAutoPan(bool aEnabled)
Function SetAutoPan Turns on/off auto panning (this feature is used when there is a tool active (eg...
void StopRouting()
Definition: pns_router.cpp:368
T Parameter() const
Function Parameter() Returns a non-standard parameter assigned to the event.
Definition: tool_event.h:373
VECTOR2I m_endSnapPoint
Definition: pns_tool_base.h:74
bool StartDragging(const VECTOR2I &aP, ITEM *aItem, int aDragMode=DM_ANY)
Definition: pns_router.cpp:127
ITEM * FindItemByParent(const BOARD_CONNECTED_ITEM *aParent)
Definition: pns_node.cpp:1328
void Activate()
Function Activate() Runs the tool.
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Function IsOK displays a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:129
static TOOL_ACTION selectionCursor
Select a single item under the cursor position.
Definition: pcb_actions.h:50
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:460
bool TOOL_BASE::IsToolActive ( ) const
inherited

Definition at line 30 of file tool_base.cpp.

References TOOL_MANAGER::IsToolActive(), TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

31 {
32  return m_toolMgr->IsToolActive( m_toolId );
33 }
bool IsToolActive(TOOL_ID aId) const
Function IsToolActive() Returns true if a tool with given id is active (executing) ...
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
TOOL_ID m_toolId
Unique identifier for the tool, assigned by a TOOL_MANAGER instance.
Definition: tool_base.h:210
int ROUTER_TOOL::mainLoop ( PNS::ROUTER_MODE  aMode)
private

Definition at line 851 of file router_tool.cpp.

References ACT_NewTrack, ACT_PlaceThroughVia, TOOL_INTERACTIVE::Activate(), PCB_TOOL::board(), breakTrack(), PCB_ACTIONS::breakTrack, BUT_LEFT, PNS::ROUTER::ClearWorld(), PCB_TOOL::controls(), PNS::TOOL_BASE::deleteTraces(), PNS::DM_ANY, PNS::DM_FREE_ANGLE, PCB_ACTIONS::drag45Degree, PCB_ACTIONS::dragFreeAngle, PCB_TOOL::frame(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_BASE::getViewControls(), TOOL_EVT_UTILS::IsCancelInteractive(), PCB_ACTIONS::layerToggle, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_savedSettings, PNS::TOOL_BASE::m_savedSizes, PNS::TOOL_BASE::m_startItem, PNS::TOOL_BASE::m_startSnapPoint, TOOL_BASE::m_toolMgr, MD_CTRL, performDragging(), performRouting(), PCB_ACTIONS::remove, PCB_ACTIONS::removeAlt, TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectionClear, TOOL_INTERACTIVE::SetContextMenu(), PNS::ROUTER::SetMode(), EDA_DRAW_FRAME::SetNoToolSelected(), PNS::ROUTER::Settings(), KIGFX::VIEW_CONTROLS::ShowCursor(), PNS::ROUTER::Sizes(), PNS::ROUTER::SyncWorld(), TA_MODEL_CHANGE, TA_UNDO_REDO_POST, TA_UNDO_REDO_PRE, PNS::TOOL_BASE::updateStartItem(), and TOOL_INTERACTIVE::Wait().

Referenced by RouteDiffPair(), and RouteSingleTrace().

852 {
853  PCB_EDIT_FRAME* frame = getEditFrame<PCB_EDIT_FRAME>();
854  BOARD* board = getModel<BOARD>();
855 
856  // Deselect all items
858 
859  Activate();
860 
861  m_router->SetMode( aMode );
862 
863  controls()->ShowCursor( true );
864 
866 
867  std::unique_ptr<ROUTER_TOOL_MENU> ctxMenu( new ROUTER_TOOL_MENU( board, *frame, aMode ) );
868  SetContextMenu( ctxMenu.get() );
869 
870  // Main loop: keep receiving events
871  while( OPT_TOOL_EVENT evt = Wait() )
872  {
874  {
875  break; // Finish
876  }
877  else if( evt->Action() == TA_UNDO_REDO_PRE )
878  {
879  m_router->ClearWorld();
880  }
881  else if( evt->Action() == TA_UNDO_REDO_POST || evt->Action() == TA_MODEL_CHANGE )
882  {
883  m_router->SyncWorld();
884  }
885  else if( evt->IsMotion() )
886  {
887  updateStartItem( *evt );
888  }
889  else if( evt->IsAction( &PCB_ACTIONS::dragFreeAngle ) )
890  {
891  updateStartItem( *evt );
893  }
894  else if( evt->IsAction( &PCB_ACTIONS::drag45Degree ) )
895  {
896  updateStartItem( *evt );
898  }
899  else if( evt->IsAction( &PCB_ACTIONS::breakTrack ) )
900  {
901  updateStartItem( *evt );
902  breakTrack( );
903  }
904  else if( evt->IsClick( BUT_LEFT ) || evt->IsAction( &ACT_NewTrack ) )
905  {
906  updateStartItem( *evt );
907 
908  if( evt->Modifier( MD_CTRL ) )
910  else
911  performRouting();
912  }
913  else if( evt->IsAction( &ACT_PlaceThroughVia ) )
914  {
916  }
917  else if( evt->IsAction( &PCB_ACTIONS::remove ) )
918  {
919  updateStartItem( *evt );
920  deleteTraces( m_startItem, false );
921  }
922  else if( evt->IsAction( &PCB_ACTIONS::removeAlt ) )
923  {
924  updateStartItem( *evt );
925  deleteTraces( m_startItem, true );
926  }
927  }
928 
929  frame->SetNoToolSelected();
930  SetContextMenu( nullptr );
931 
932  // Store routing settings till the next invocation
935 
936  return 0;
937 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:53
virtual void ShowCursor(bool aEnabled)
Function ShowCursor() Enables or disables display of cursor.
VECTOR2I m_startSnapPoint
Definition: pns_tool_base.h:71
static const TOOL_ACTION ACT_NewTrack("pcbnew.InteractiveRouter.NewTrack", AS_CONTEXT, TOOL_ACTION::LegacyHotKey(HK_ADD_NEW_TRACK), _("New Track"), _("Starts laying a new track."), add_tracks_xpm)
static TOOL_ACTION dragFreeAngle
Definition: pcb_actions.h:128
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
SIZES_SETTINGS m_savedSizes
Stores sizes settings between router invocations.
Definition: pns_tool_base.h:68
void SyncWorld()
Definition: pns_router.cpp:91
OPT_TOOL_EVENT Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
static TOOL_ACTION removeAlt
Definition: pcb_actions.h:124
static TOOL_ACTION drag45Degree
Definition: pcb_actions.h:127
static const TOOL_ACTION ACT_PlaceThroughVia("pcbnew.InteractiveRouter.PlaceVia", AS_CONTEXT, TOOL_ACTION::LegacyHotKey(HK_ADD_THROUGH_VIA), _("Place Through Via"), _("Adds a through-hole via at the end of currently routed track."), via_xpm, AF_NONE,(void *) VIA_ACTION_FLAGS::VIA)
SIZES_SETTINGS & Sizes()
Definition: pns_router.h:206
void breakTrack()
void ClearWorld()
Definition: pns_router.cpp:100
KIGFX::VIEW_CONTROLS * controls() const
Definition: pcb_tool.h:132
void performRouting()
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
ITEM * m_startItem
Definition: pns_tool_base.h:69
ROUTER * m_router
Definition: pns_tool_base.h:78
void SetContextMenu(CONTEXT_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
Function SetContextMenu()
ROUTING_SETTINGS m_savedSettings
Stores routing settings between router invocations.
Definition: pns_tool_base.h:67
bool IsCancelInteractive(const TOOL_EVENT &aEvt)
Function IsCancelInteractive()
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:41
static TOOL_ACTION breakTrack
Definition: pcb_actions.h:126
virtual void SetNoToolSelected()
Select the ID_NO_TOOL_SELECTED id tool (Idle tool)
Definition: draw_frame.cpp:571
void SetMode(ROUTER_MODE aMode)
Definition: pns_router.cpp:486
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
void deleteTraces(ITEM *aStartItem, bool aWholeTrack)
void performDragging(int aMode=PNS::DM_ANY)
void Activate()
Function Activate() Runs the tool.
static TOOL_ACTION remove
Deleting a BOARD_ITEM.
Definition: pcb_actions.h:123
ROUTING_SETTINGS & Settings()
Definition: pns_router.h:187
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:460
static TOOL_ACTION layerToggle
Definition: pcb_actions.h:268
BOARD * board() const
Definition: pcb_tool.h:134
virtual void updateStartItem(TOOL_EVENT &aEvent)
int ROUTER_TOOL::onLayerChanged ( const TOOL_EVENT aEvent)
private
int ROUTER_TOOL::onTrackViaSizeChanged ( const TOOL_EVENT aEvent)
private

Definition at line 1080 of file router_tool.cpp.

References PCB_TOOL::board(), PNS::SIZES_SETTINGS::ImportCurrent(), PNS::TOOL_BASE::m_router, PNS::ROUTER::Sizes(), and PNS::ROUTER::UpdateSizes().

Referenced by setTransitions().

1081 {
1082  PNS::SIZES_SETTINGS sizes( m_router->Sizes() );
1083  sizes.ImportCurrent( board()->GetDesignSettings() );
1084  m_router->UpdateSizes( sizes );
1085 
1086  return 0;
1087 }
SIZES_SETTINGS & Sizes()
Definition: pns_router.h:206
ROUTER * m_router
Definition: pns_tool_base.h:78
void ImportCurrent(BOARD_DESIGN_SETTINGS &aSettings)
void UpdateSizes(const SIZES_SETTINGS &aSizes)
Applies stored settings.
Definition: pns_router.cpp:287
BOARD * board() const
Definition: pcb_tool.h:134
int ROUTER_TOOL::onViaCommand ( const TOOL_EVENT aEvent)
private

Definition at line 496 of file router_tool.cpp.

References PNS::SIZES_SETTINGS::AddLayerPair(), LSET::AllNonCuMask(), B_Cu, PCB_TOOL::board(), PNS::SIZES_SETTINGS::ClearLayerPairs(), DisplayError(), F_Cu, PCB_TOOL::frame(), BOARD_DESIGN_SETTINGS::GetCopperLayerCount(), PNS::ROUTER::GetCurrentLayer(), BOARD_DESIGN_SETTINGS::GetCurrentMicroViaDrill(), BOARD_DESIGN_SETTINGS::GetCurrentMicroViaSize(), BOARD_DESIGN_SETTINGS::GetCurrentViaDrill(), BOARD_DESIGN_SETTINGS::GetCurrentViaSize(), BOARD::GetDesignSettings(), PCB_BASE_FRAME::GetScreen(), getViaTypeFromFlags(), In1_Cu, PNS::ROUTER::IsPlacingVia(), BOARD_DESIGN_SETTINGS::m_BlindBuriedViaAllowed, PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, BOARD_DESIGN_SETTINGS::m_MicroViasAllowed, PCB_SCREEN::m_Route_Layer_BOTTOM, PCB_SCREEN::m_Route_Layer_TOP, PNS::TOOL_BASE::m_router, PNS::ROUTER::Move(), TOOL_EVENT::Parameter(), SELECT_LAYER, PCB_BASE_FRAME::SelectLayer(), PNS::SIZES_SETTINGS::SetViaDiameter(), PNS::SIZES_SETTINGS::SetViaDrill(), PNS::SIZES_SETTINGS::SetViaType(), PNS::ROUTER::Sizes(), PNS::ROUTER::ToggleViaPlacement(), UNDEFINED_LAYER, PNS::TOOL_BASE::updateEndItem(), PNS::ROUTER::UpdateSizes(), VIA_BLIND_BURIED, VIA_MICROVIA, and VIA_THROUGH.

Referenced by setTransitions().

497 {
498  const int actViaFlags = aEvent.Parameter<intptr_t>();
499 
500  VIATYPE_T viaType = getViaTypeFromFlags( actViaFlags );
501  const bool selectLayer = actViaFlags & VIA_ACTION_FLAGS::SELECT_LAYER;
502 
504 
505  const int layerCount = bds.GetCopperLayerCount();
506  int currentLayer = m_router->GetCurrentLayer();
509 
511 
512  // ask the user for a target layer
513  PCB_LAYER_ID targetLayer = UNDEFINED_LAYER;
514 
515  if( selectLayer )
516  {
517  wxPoint dlgPosition = wxGetMousePosition();
518 
519  targetLayer = frame()->SelectLayer( static_cast<PCB_LAYER_ID>( currentLayer ),
520  LSET::AllNonCuMask(), dlgPosition );
521  }
522 
523  // fixme: P&S supports more than one fixed layer pair. Update the dialog?
524  sizes.ClearLayerPairs();
525 
526  if( !m_router->IsPlacingVia() )
527  {
528  // Cannot place microvias or blind vias if not allowed (obvious)
529  if( ( viaType == VIA_BLIND_BURIED ) && ( !bds.m_BlindBuriedViaAllowed ) )
530  {
531  DisplayError( frame(), _( "Blind/buried vias have to be enabled in the design settings." ) );
532  return false;
533  }
534 
535  if( ( viaType == VIA_MICROVIA ) && ( !bds.m_MicroViasAllowed ) )
536  {
537  DisplayError( frame(), _( "Microvias have to be enabled in the design settings." ) );
538  return false;
539  }
540 
541  // Can only place through vias on 2-layer boards
542  if( ( viaType != VIA_THROUGH ) && ( layerCount <= 2 ) )
543  {
544  DisplayError( frame(), _( "Only through vias are allowed on 2 layer boards." ) );
545  return false;
546  }
547 
548  // Can only place microvias if we're on an outer layer, or directly adjacent to one
549  if( ( viaType == VIA_MICROVIA ) && ( currentLayer > In1_Cu ) && ( currentLayer < layerCount - 2 ) )
550  {
551  DisplayError( frame(), _( "Microvias can be placed only between the outer layers " \
552  "(F.Cu/B.Cu) and the ones directly adjacent to them." ) );
553  return false;
554  }
555  }
556 
557  // Convert blind/buried via to a through hole one, if it goes through all layers
558  if( viaType == VIA_BLIND_BURIED && ( ( currentLayer == B_Cu ) || ( currentLayer == F_Cu ) )
559  && ( ( pairTop == B_Cu && pairBottom == F_Cu )
560  || ( pairTop == F_Cu && pairBottom == B_Cu ) ) )
561  {
562  viaType = VIA_THROUGH;
563  }
564 
565  switch( viaType )
566  {
567  case VIA_THROUGH:
568  sizes.SetViaDiameter( bds.GetCurrentViaSize() );
569  sizes.SetViaDrill( bds.GetCurrentViaDrill() );
570 
571  if( targetLayer != UNDEFINED_LAYER )
572  {
573  // go from the current layer to the chosen layer
574  sizes.AddLayerPair( currentLayer, targetLayer );
575  }
576  else
577  {
578  // use the default layer pair
579  sizes.AddLayerPair( pairTop, pairBottom );
580  }
581  break;
582 
583  case VIA_MICROVIA:
584  sizes.SetViaDiameter( bds.GetCurrentMicroViaSize() );
585  sizes.SetViaDrill( bds.GetCurrentMicroViaDrill() );
586 
587  wxASSERT_MSG( !selectLayer, "Unexpected select layer for microvia (microvia layers are implicit)" );
588 
589  if( currentLayer == F_Cu || currentLayer == In1_Cu )
590  {
591  // front-side microvia
592  sizes.AddLayerPair( F_Cu, In1_Cu );
593  }
594  else if( currentLayer == B_Cu || currentLayer == layerCount - 2 )
595  {
596  // back-side microvia
597  sizes.AddLayerPair( B_Cu, layerCount - 2 );
598  }
599  else
600  {
601  wxASSERT_MSG( false, "Invalid layer pair for microvia (must be on or adjacent to an outer layer)" );
602  }
603  break;
604 
605  case VIA_BLIND_BURIED:
606  sizes.SetViaDiameter( bds.GetCurrentViaSize() );
607  sizes.SetViaDrill( bds.GetCurrentViaDrill() );
608 
609  if( targetLayer != UNDEFINED_LAYER )
610  {
611  // go directly to the user specified layer
612  sizes.AddLayerPair( currentLayer, targetLayer );
613  }
614  else
615  {
616  if( currentLayer == pairTop || currentLayer == pairBottom )
617  {
618  // the current layer is on the defined layer pair,
619  // swap to the other side
620  sizes.AddLayerPair( pairTop, pairBottom );
621  }
622  else
623  {
624  // the current layer is not part of the current layer pair,
625  // so fallback and swap to the top layer of the pair by default
626  sizes.AddLayerPair( pairTop, currentLayer );
627  }
628  }
629  break;
630 
631  default:
632  wxASSERT( false );
633  break;
634  }
635 
636  sizes.SetViaType( viaType );
637 
638  m_router->UpdateSizes( sizes );
640 
641  updateEndItem( aEvent );
642 
643  m_router->Move( m_endSnapPoint, m_endItem ); // refresh
644 
645  return 0;
646 }
int GetCurrentMicroViaSize()
Function GetCurrentMicroViaSize.
int GetCurrentViaDrill() const
Function GetCurrentViaDrill.
int GetCurrentMicroViaDrill()
Function GetCurrentMicroViaDrill.
static LSET AllNonCuMask()
Function AllNonCuMask returns a mask holding all layer minus CU layers.
Definition: lset.cpp:669
Microvia
Definition: router_tool.cpp:76
void SetViaDrill(int aDrill)
bool IsPlacingVia() const
Definition: pns_router.cpp:468
SIZES_SETTINGS & Sizes()
Definition: pns_router.h:206
VIATYPE_T
Definition: class_track.h:51
int GetCurrentViaSize() const
Function GetCurrentViaSize.
void ToggleViaPlacement()
Definition: pns_router.cpp:418
virtual void updateEndItem(const TOOL_EVENT &aEvent)
PCB_LAYER_ID
A quick note on layer IDs:
int GetCopperLayerCount() const
Function GetCopperLayerCount.
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
ROUTER * m_router
Definition: pns_tool_base.h:78
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:532
PCB_LAYER_ID m_Route_Layer_BOTTOM
bool m_BlindBuriedViaAllowed
true to allow blind/buried vias
void Move(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:204
void SetViaType(VIATYPE_T aViaType)
T Parameter() const
Function Parameter() Returns a non-standard parameter assigned to the event.
Definition: tool_event.h:373
void UpdateSizes(const SIZES_SETTINGS &aSizes)
Applies stored settings.
Definition: pns_router.cpp:287
VECTOR2I m_endSnapPoint
Definition: pns_tool_base.h:74
PCB_SCREEN * GetScreen() const override
Function GetScreen returns a pointer to a BASE_SCREEN or one of its derivatives.
int GetCurrentLayer() const
Definition: pns_router.cpp:437
void AddLayerPair(int aL1, int aL2)
static VIATYPE_T getViaTypeFromFlags(int aFlags)
bool m_MicroViasAllowed
true to allow micro vias
void SetViaDiameter(int aDiameter)
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:71
PCB_LAYER_ID SelectLayer(PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
Install the dialog box for layer selection.
Definition: sel_layer.cpp:221
PCB_LAYER_ID m_Route_Layer_TOP
Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.
BOARD * board() const
Definition: pcb_tool.h:134
void ROUTER_TOOL::performDragging ( int  aMode = PNS::DM_ANY)
private

Definition at line 940 of file router_tool.cpp.

References BUT_LEFT, PNS::ROUTER::FixRoute(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL::frame(), TOOL_BASE::getViewControls(), handleCommonEvents(), PNS::TOOL_BASE::highlightNet(), TOOL_EVT_UTILS::IsCancelInteractive(), PNS::ITEM::IsLocked(), IsOK(), PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, PNS::TOOL_BASE::m_startSnapPoint, PNS::ROUTER::Move(), PNS::ITEM::Net(), PNS::ROUTER::RoutingInProgress(), KIGFX::VIEW_CONTROLS::SetAutoPan(), PNS::ROUTER::StartDragging(), PNS::ROUTER::StopRouting(), PCB_BASE_EDIT_FRAME::UndoRedoBlock(), PNS::TOOL_BASE::updateEndItem(), and TOOL_INTERACTIVE::Wait().

Referenced by mainLoop().

941 {
942  VIEW_CONTROLS* ctls = getViewControls();
943 
944  if( m_startItem && m_startItem->IsLocked() )
945  {
946  if( !IsOK( frame(), _( "The item is locked. Do you want to continue?" ) ) )
947  return;
948  }
949 
950  bool dragStarted = m_router->StartDragging( m_startSnapPoint, m_startItem, aMode );
951 
952  if( !dragStarted )
953  return;
954 
955  if( m_startItem && m_startItem->Net() >= 0 )
956  highlightNet( true, m_startItem->Net() );
957 
958  ctls->SetAutoPan( true );
959 
960  frame()->UndoRedoBlock( true );
961 
962  while( OPT_TOOL_EVENT evt = Wait() )
963  {
964  ctls->ForceCursorPosition( false );
965 
966  if( evt->IsMotion() )
967  {
968  updateEndItem( *evt );
970  }
971  else if( evt->IsClick( BUT_LEFT ) )
972  {
974  break;
975  }
976  else if( TOOL_EVT_UTILS::IsCancelInteractive( *evt )
977  || evt->IsUndoRedo() )
978  break;
979 
980  handleCommonEvents( *evt );
981  }
982 
983  if( m_router->RoutingInProgress() )
985 
986  m_startItem = nullptr;
987 
988  frame()->UndoRedoBlock( false );
989  ctls->SetAutoPan( false );
990  ctls->ForceCursorPosition( false );
991  highlightNet( false );
992 }
VECTOR2I m_startSnapPoint
Definition: pns_tool_base.h:71
OPT_TOOL_EVENT Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
void UndoRedoBlock(bool aBlock=true)
Function UndoRedoBlock Enables/disable undo and redo operations.
void handleCommonEvents(const TOOL_EVENT &evt)
bool RoutingInProgress() const
Definition: pns_router.cpp:112
virtual void updateEndItem(const TOOL_EVENT &aEvent)
bool IsLocked() const
Definition: pns_item.h:336
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
ITEM * m_startItem
Definition: pns_tool_base.h:69
bool FixRoute(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:343
ROUTER * m_router
Definition: pns_tool_base.h:78
Class VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (...
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
bool IsCancelInteractive(const TOOL_EVENT &aEvt)
Function IsCancelInteractive()
void Move(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:204
virtual void SetAutoPan(bool aEnabled)
Function SetAutoPan Turns on/off auto panning (this feature is used when there is a tool active (eg...
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:41
void StopRouting()
Definition: pns_router.cpp:368
virtual void highlightNet(bool aEnabled, int aNetcode=-1)
VECTOR2I m_endSnapPoint
Definition: pns_tool_base.h:74
bool StartDragging(const VECTOR2I &aP, ITEM *aItem, int aDragMode=DM_ANY)
Definition: pns_router.cpp:127
int Net() const
Function Net()
Definition: pns_item.h:177
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Function IsOK displays a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:129
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:460
void ROUTER_TOOL::performRouting ( )
private

Definition at line 713 of file router_tool.cpp.

References ACT_EndTrack, ACT_SwitchPosture, BUT_LEFT, finishInteractive(), PNS::ROUTER::FixRoute(), PNS::ROUTER::FlipPosture(), PCB_TOOL::frame(), PNS::ROUTER::GetCurrentLayer(), TOOL_EVT_UTILS::IsCancelInteractive(), PNS::ROUTER::IsPlacingVia(), PCB_ACTIONS::layerChanged, PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, MD_CTRL, PNS::ROUTER::Move(), prepareInteractive(), PCB_ACTIONS::routerInlineDrag, PNS::ROUTER::RoutingInProgress(), PCB_EDIT_FRAME::SetActiveLayer(), PNS::ROUTER::SetOrthoMode(), PNS::ROUTER::SwitchLayer(), switchLayerOnViaPlacement(), ToLAYER_ID(), PNS::TOOL_BASE::updateEndItem(), and TOOL_INTERACTIVE::Wait().

Referenced by mainLoop().

714 {
715  if( !prepareInteractive() )
716  return;
717 
718  while( OPT_TOOL_EVENT evt = Wait() )
719  {
720  // Don't crash if we missed an operation that cancelled routing.
721  wxCHECK2( m_router->RoutingInProgress(), break );
722 
723  if( evt->IsMotion() )
724  {
725  m_router->SetOrthoMode( evt->Modifier( MD_CTRL ) );
726  updateEndItem( *evt );
728  }
729  else if( evt->IsClick( BUT_LEFT ) )
730  {
731  updateEndItem( *evt );
732  bool needLayerSwitch = m_router->IsPlacingVia();
733 
735  break;
736 
737  if( needLayerSwitch )
739 
740  // Synchronize the indicated layer
742  updateEndItem( *evt );
744  m_startItem = NULL;
745  }
746  else if( evt->IsAction( &ACT_SwitchPosture ) )
747  {
749  updateEndItem( *evt );
750  m_router->Move( m_endSnapPoint, m_endItem ); // refresh
751  }
752  else if( evt->IsAction( &PCB_ACTIONS::layerChanged ) )
753  {
754  m_router->SwitchLayer( frame()->GetActiveLayer() );
755  updateEndItem( *evt );
756  m_router->Move( m_endSnapPoint, m_endItem ); // refresh
757  }
758  else if( evt->IsAction( &ACT_EndTrack ) )
759  {
760  bool still_routing = true;
761  while( still_routing )
762  still_routing = m_router->FixRoute( m_endSnapPoint, m_endItem );
763  break;
764  }
765  else if( TOOL_EVT_UTILS::IsCancelInteractive( *evt )
766  || evt->IsUndoRedo()
767  || evt->IsAction( &PCB_ACTIONS::routerInlineDrag ) )
768  break;
769  }
770 
772 }
bool finishInteractive()
OPT_TOOL_EVENT Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
bool IsPlacingVia() const
Definition: pns_router.cpp:468
void SwitchLayer(int layer)
Definition: pns_router.cpp:405
void SetOrthoMode(bool aEnable)
Definition: pns_router.cpp:477
bool RoutingInProgress() const
Definition: pns_router.cpp:112
virtual void updateEndItem(const TOOL_EVENT &aEvent)
bool prepareInteractive()
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
ITEM * m_startItem
Definition: pns_tool_base.h:69
bool FixRoute(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:343
static const TOOL_ACTION ACT_SwitchPosture("pcbnew.InteractiveRouter.SwitchPosture", AS_CONTEXT, TOOL_ACTION::LegacyHotKey(HK_SWITCH_TRACK_POSTURE), _("Switch Track Posture"), _("Switches posture of the currently routed track."), change_entry_orient_xpm)
ROUTER * m_router
Definition: pns_tool_base.h:78
void switchLayerOnViaPlacement()
bool IsCancelInteractive(const TOOL_EVENT &aEvt)
Function IsCancelInteractive()
void Move(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:204
static TOOL_ACTION routerInlineDrag
Activation of the Push and Shove router (inline dragging mode)
Definition: pcb_actions.h:209
static TOOL_ACTION layerChanged
Definition: pcb_actions.h:270
VECTOR2I m_endSnapPoint
Definition: pns_tool_base.h:74
int GetCurrentLayer() const
Definition: pns_router.cpp:437
static const TOOL_ACTION ACT_EndTrack("pcbnew.InteractiveRouter.EndTrack", AS_CONTEXT, WXK_END, _("End Track"), _("Stops laying the current track."), checked_ok_xpm)
void FlipPosture()
Definition: pns_router.cpp:396
virtual void SetActiveLayer(PCB_LAYER_ID aLayer) override
Function SetActiveLayer will change the currently active layer to aLayer and also update the PCB_LAYE...
Definition: pcbframe.cpp:890
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:774
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:460
ITEM * TOOL_BASE::pickSingleItem ( const VECTOR2I aWhere,
int  aNet = -1,
int  aLayer = -1 
)
protectedvirtualinherited

Definition at line 116 of file pns_tool_base.cpp.

References PCB_TOOL::displayOptions(), KIGFX::VIEW::GetTopLayer(), TOOL_BASE::getView(), IsCopperLayer(), PNS::ITEM_SET::Items(), PNS::ITEM::KindStr(), PNS::ITEM::Layers(), PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, PNS::TOOL_BASE::m_router, LAYER_RANGE::Overlaps(), PNS::ROUTER::QueryHoverItems(), PNS::ITEM::SOLID_T, LAYER_RANGE::Start(), and PNS::ITEM::VIA_T.

Referenced by PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

117 {
118  int tl = getView()->GetTopLayer();
119 
120  if( aLayer > 0 )
121  tl = aLayer;
122 
123  ITEM* prioritized[4];
124 
125  for( int i = 0; i < 4; i++ )
126  prioritized[i] = 0;
127 
128  ITEM_SET candidates = m_router->QueryHoverItems( aWhere );
129 
130  for( ITEM* item : candidates.Items() )
131  {
132  if( !IsCopperLayer( item->Layers().Start() ) )
133  continue;
134 
135  // fixme: this causes flicker with live loop removal...
136  //if( item->Parent() && !item->Parent()->ViewIsVisible() )
137  // continue;
138 
139  if( aNet < 0 || item->Net() == aNet )
140  {
141  if( item->OfKind( ITEM::VIA_T | ITEM::SOLID_T ) )
142  {
143  if( !prioritized[2] )
144  prioritized[2] = item;
145  if( item->Layers().Overlaps( tl ) )
146  prioritized[0] = item;
147  }
148  else
149  {
150  if( !prioritized[3] )
151  prioritized[3] = item;
152  if( item->Layers().Overlaps( tl ) )
153  prioritized[1] = item;
154  }
155  }
156  }
157 
158  ITEM* rv = NULL;
159 
160  for( int i = 0; i < 4; i++ )
161  {
162  ITEM* item = prioritized[i];
163 
165  if( item && !item->Layers().Overlaps( tl ) )
166  item = NULL;
167 
168  if( item )
169  {
170  rv = item;
171  break;
172  }
173  }
174 
175  if( rv && aLayer >= 0 && !rv->Layers().Overlaps( aLayer ) )
176  rv = NULL;
177 
178  if( rv )
179  {
180  wxLogTrace( "PNS", "%s, layer : %d, tl: %d", rv->KindStr().c_str(), rv->Layers().Start(), tl );
181  }
182 
183  return rv;
184 }
virtual int GetTopLayer() const
Definition: view.cpp:721
const ITEM_SET QueryHoverItems(const VECTOR2I &aP)
Definition: pns_router.cpp:118
PCB_DISPLAY_OPTIONS * displayOptions() const
Definition: pcb_tool.cpp:208
ROUTER * m_router
Definition: pns_tool_base.h:78
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:35
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
bool ROUTER_TOOL::prepareInteractive ( )
private

Definition at line 649 of file router_tool.cpp.

References PCB_TOOL::board(), PCB_TOOL::controls(), NETCLASS::Default, DisplayError(), PNS::ROUTER::FailureReason(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL::frame(), BOARD_CONNECTED_ITEM::GetNetClass(), getStartLayer(), PNS::TOOL_BASE::highlightNet(), PNS::SIZES_SETTINGS::Init(), IsCopperLayer(), PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, PNS::TOOL_BASE::m_startSnapPoint, PNS::ITEM::Net(), PNS::ITEM::Parent(), PCB_EDIT_FRAME::SetActiveLayer(), KIGFX::VIEW_CONTROLS::SetAutoPan(), PCB_EDIT_FRAME::SetCurrentNetClass(), PNS::ROUTER::Sizes(), PNS::ROUTER::StartRouting(), ToLAYER_ID(), PCB_BASE_EDIT_FRAME::UndoRedoBlock(), and PNS::ROUTER::UpdateSizes().

Referenced by performRouting().

650 {
651  int routingLayer = getStartLayer( m_startItem );
652 
653  if( !IsCopperLayer( routingLayer ) )
654  {
655  DisplayError( frame(), _( "Tracks on Copper layers only" ) );
656  return false;
657  }
658 
659  frame()->SetActiveLayer( ToLAYER_ID( routingLayer ) );
660 
661  // fixme: switch on invisible layer
662 
663  // for some reason I don't understand, GetNetclass() may return null sometimes...
664  if( m_startItem && m_startItem->Net() >= 0 &&
666  {
667  highlightNet( true, m_startItem->Net() );
668  // Update track width and via size shown in main toolbar comboboxes
669  frame()->SetCurrentNetClass( m_startItem->Parent()->GetNetClass()->GetName() );
670  }
671  else
673 
674  controls()->ForceCursorPosition( false );
675  controls()->SetAutoPan( true );
676 
677  PNS::SIZES_SETTINGS sizes( m_router->Sizes() );
678 
679  sizes.Init( board(), m_startItem );
680  sizes.AddLayerPair( frame()->GetScreen()->m_Route_Layer_TOP,
681  frame()->GetScreen()->m_Route_Layer_BOTTOM );
682  m_router->UpdateSizes( sizes );
683 
684  if( !m_router->StartRouting( m_startSnapPoint, m_startItem, routingLayer ) )
685  {
687  highlightNet( false );
688  return false;
689  }
690 
691  m_endItem = NULL;
693 
694  frame()->UndoRedoBlock( true );
695 
696  return true;
697 }
const wxString & FailureReason() const
Definition: pns_router.h:214
VECTOR2I m_startSnapPoint
Definition: pns_tool_base.h:71
void UndoRedoBlock(bool aBlock=true)
Function UndoRedoBlock Enables/disable undo and redo operations.
SIZES_SETTINGS & Sizes()
Definition: pns_router.h:206
bool SetCurrentNetClass(const wxString &aNetClassName)
Function SetCurrentNetClass Must be called after a netclass selection (or after a netclass parameter ...
Definition: pcbframe.cpp:1163
KIGFX::VIEW_CONTROLS * controls() const
Definition: pcb_tool.h:132
std::shared_ptr< NETCLASS > GetNetClass() const
Function GetNetClass returns the NETCLASS for this item.
static const char Default[]
the name of the default NETCLASS
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
ITEM * m_startItem
Definition: pns_tool_base.h:69
void Init(BOARD *aBoard, ITEM *aStartItem=NULL, int aNet=-1)
ROUTER * m_router
Definition: pns_tool_base.h:78
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
bool StartRouting(const VECTOR2I &aP, ITEM *aItem, int aLayer)
Definition: pns_router.cpp:156
virtual void SetAutoPan(bool aEnabled)
Function SetAutoPan Turns on/off auto panning (this feature is used when there is a tool active (eg...
virtual void highlightNet(bool aEnabled, int aNetcode=-1)
void UpdateSizes(const SIZES_SETTINGS &aSizes)
Applies stored settings.
Definition: pns_router.cpp:287
VECTOR2I m_endSnapPoint
Definition: pns_tool_base.h:74
int Net() const
Function Net()
Definition: pns_item.h:177
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
int getStartLayer(const PNS::ITEM *aItem)
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:71
virtual void SetActiveLayer(PCB_LAYER_ID aLayer) override
Function SetActiveLayer will change the currently active layer to aLayer and also update the PCB_LAYE...
Definition: pcbframe.cpp:890
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:774
BOARD_CONNECTED_ITEM * Parent() const
Function Parent()
Definition: pns_item.h:157
BOARD * board() const
Definition: pcb_tool.h:134
void ROUTER_TOOL::Reset ( RESET_REASON  aReason)
overridevirtual

Function Reset() Brings the tool to a known, initial state.

If the tool claimed anything from the model or the view, it must release it when its reset.

Parameters
aReasoncontains information about the reason of tool reset.

Reimplemented from PNS::TOOL_BASE.

Definition at line 377 of file router_tool.cpp.

References TOOL_BASE::Reset().

378 {
379  TOOL_BASE::Reset( aReason );
380 }
virtual void Reset(RESET_REASON aReason)=0
Function Reset() Brings the tool to a known, initial state.
int ROUTER_TOOL::RouteDiffPair ( const TOOL_EVENT aEvent)

Definition at line 837 of file router_tool.cpp.

References PCB_TOOL::frame(), ID_TRACK_BUTT, mainLoop(), PNS::PNS_MODE_ROUTE_DIFF_PAIR, and PCB_BASE_FRAME::SetToolID().

Referenced by setTransitions().

838 {
839  frame()->SetToolID( ID_TRACK_BUTT, wxCURSOR_PENCIL, _( "Router Differential Pair" ) );
841 }
int mainLoop(PNS::ROUTER_MODE aMode)
virtual void SetToolID(int aId, int aCursor, const wxString &aToolMsg) override
Function SetToolID sets the tool command ID to aId and sets the cursor to aCursor.
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
ROUTER * TOOL_BASE::Router ( ) const
inherited

Definition at line 339 of file pns_tool_base.cpp.

References PNS::TOOL_BASE::m_router.

340 {
341  return m_router;
342 }
ROUTER * m_router
Definition: pns_tool_base.h:78
int ROUTER_TOOL::RouteSingleTrace ( const TOOL_EVENT aEvent)

Definition at line 830 of file router_tool.cpp.

References PCB_TOOL::frame(), ID_TRACK_BUTT, mainLoop(), PNS::PNS_MODE_ROUTE_SINGLE, and PCB_BASE_FRAME::SetToolID().

Referenced by setTransitions().

831 {
832  frame()->SetToolID( ID_TRACK_BUTT, wxCURSOR_PENCIL, _( "Route Track" ) );
834 }
int mainLoop(PNS::ROUTER_MODE aMode)
virtual void SetToolID(int aId, int aCursor, const wxString &aToolMsg) override
Function SetToolID sets the tool command ID to aId and sets the cursor to aCursor.
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
void TOOL_INTERACTIVE::RunMainStack ( std::function< void()>  aFunc)
inherited

Function RunMainStack()

Calls a function using the main stack.

Parameters
aFuncis the function to be calls.

Definition at line 85 of file tool_interactive.cpp.

References TOOL_BASE::m_toolMgr, and TOOL_MANAGER::RunMainStack().

Referenced by DRAWING_TOOL::PlaceText().

86 {
87  m_toolMgr->RunMainStack( this, std::move( aFunc ) );
88 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
void RunMainStack(TOOL_BASE *aTool, std::function< void()> aFunc)
void TOOL_INTERACTIVE::SetContextMenu ( CONTEXT_MENU aMenu,
CONTEXT_MENU_TRIGGER  aTrigger = CMENU_BUTTON 
)
inherited

Function SetContextMenu()

Assigns a context menu and tells when it should be activated.

Parameters
aMenuis the menu to be assigned.
aTriggerdetermines conditions upon which the context menu is activated.

Definition at line 74 of file tool_interactive.cpp.

References CMENU_OFF, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ScheduleContextMenu(), and CONTEXT_MENU::SetTool().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), LENGTH_TUNER_TOOL::mainLoop(), mainLoop(), and TOOL_MENU::ShowContextMenu().

75 {
76  if( aMenu )
77  aMenu->SetTool( this );
78  else
79  aTrigger = CMENU_OFF;
80 
81  m_toolMgr->ScheduleContextMenu( this, aMenu, aTrigger );
82 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
void ScheduleContextMenu(TOOL_BASE *aTool, CONTEXT_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger)
Sets behaviour of the tool's context popup menu.
void SetTool(TOOL_INTERACTIVE *aTool)
Function SetTool() Sets a tool that is the creator of the menu.
void PCB_TOOL::SetEditModules ( bool  aEnabled)
inlineinherited

Function SetEditModules()

Toggles edit module mode. When enabled, one may select parts of modules individually (graphics, pads, etc.), so they can be modified.

Parameters
aEnableddecides if the mode should be enabled.

Definition at line 91 of file pcb_tool.h.

References PCB_TOOL::m_editModules.

92  {
93  m_editModules = aEnabled;
94  }
bool m_editModules
Definition: pcb_tool.h:139
int ROUTER_TOOL::SettingsDialog ( const TOOL_EVENT aEvent)

Definition at line 792 of file router_tool.cpp.

References TOOL_INTERACTIVE::Activate(), PCB_TOOL::frame(), PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_savedSettings, and PNS::ROUTER::Settings().

Referenced by setTransitions().

793 {
794  Activate();
795 
796  DIALOG_PNS_SETTINGS settingsDlg( frame(), m_router->Settings() );
797 
798  if( settingsDlg.ShowModal() )
799  {
801  }
802 
803  return 0;
804 }
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
ROUTER * m_router
Definition: pns_tool_base.h:78
ROUTING_SETTINGS m_savedSettings
Stores routing settings between router invocations.
Definition: pns_tool_base.h:67
void Activate()
Function Activate() Runs the tool.
ROUTING_SETTINGS & Settings()
Definition: pns_router.h:187
void ROUTER_TOOL::setTransitions ( )
overridevirtual

This method is meant to be overridden in order to specify handlers for events.

It is called every time tool is reset or finished.

Reimplemented from PCB_TOOL.

Definition at line 807 of file router_tool.cpp.

References ACT_CustomTrackWidth, ACT_PlaceBlindVia, ACT_PlaceMicroVia, ACT_PlaceThroughVia, PNS::TOOL_BASE::ACT_RouterOptions, ACT_SelLayerAndPlaceBlindVia, ACT_SelLayerAndPlaceThroughVia, ACT_SetDpDimensions, CustomTrackWidthDialog(), DpDimensionsDialog(), TOOL_INTERACTIVE::Go(), InlineDrag(), TOOL_ACTION::MakeEvent(), onTrackViaSizeChanged(), onViaCommand(), RouteDiffPair(), PCB_ACTIONS::routerActivateDiffPair, PCB_ACTIONS::routerActivateDpDimensionsDialog, PCB_ACTIONS::routerActivateSettingsDialog, PCB_ACTIONS::routerActivateSingle, PCB_ACTIONS::routerInlineDrag, RouteSingleTrace(), SettingsDialog(), and PCB_ACTIONS::trackViaSizeChanged.

808 {
814 
820 
821  // TODO is not this redundant? the same actions can be used for menus and hotkeys
824 
827 }
static TOOL_ACTION ACT_RouterOptions
Definition: pns_tool_base.h:47
static const TOOL_ACTION ACT_SelLayerAndPlaceBlindVia("pcbnew.InteractiveRouter.SelLayerAndPlaceBlindVia", AS_CONTEXT, TOOL_ACTION::LegacyHotKey(HK_SEL_LAYER_AND_ADD_BLIND_BURIED_VIA), _("Select Layer and Place Blind/Buried Via"), _("Select a layer, then add a blind or buried via at the end of currently routed track."), select_w_layer_xpm, AF_NONE,(void *)(VIA_ACTION_FLAGS::BLIND_VIA|VIA_ACTION_FLAGS::SELECT_LAYER))
int DpDimensionsDialog(const TOOL_EVENT &aEvent)
int InlineDrag(const TOOL_EVENT &aEvent)
int RouteSingleTrace(const TOOL_EVENT &aEvent)
static const TOOL_ACTION ACT_PlaceBlindVia("pcbnew.InteractiveRouter.PlaceBlindVia", AS_CONTEXT, TOOL_ACTION::LegacyHotKey(HK_ADD_BLIND_BURIED_VIA), _("Place Blind/Buried Via"), _("Adds a blind or buried via at the end of currently routed track."), via_buried_xpm, AF_NONE,(void *) VIA_ACTION_FLAGS::BLIND_VIA)
static TOOL_ACTION trackViaSizeChanged
Definition: pcb_actions.h:278
static const TOOL_ACTION ACT_PlaceThroughVia("pcbnew.InteractiveRouter.PlaceVia", AS_CONTEXT, TOOL_ACTION::LegacyHotKey(HK_ADD_THROUGH_VIA), _("Place Through Via"), _("Adds a through-hole via at the end of currently routed track."), via_xpm, AF_NONE,(void *) VIA_ACTION_FLAGS::VIA)
static TOOL_ACTION routerActivateSingle
Activation of the Push and Shove router.
Definition: pcb_actions.h:189
void Go(int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
Function Go()
int onViaCommand(const TOOL_EVENT &aEvent)
int RouteDiffPair(const TOOL_EVENT &aEvent)
int SettingsDialog(const TOOL_EVENT &aEvent)
int CustomTrackWidthDialog(const TOOL_EVENT &aEvent)
static const TOOL_ACTION ACT_PlaceMicroVia("pcbnew.InteractiveRouter.PlaceMicroVia", AS_CONTEXT, TOOL_ACTION::LegacyHotKey(HK_ADD_MICROVIA), _("Place Microvia"), _("Adds a microvia at the end of currently routed track."), via_microvia_xpm, AF_NONE,(void *) VIA_ACTION_FLAGS::MICROVIA)
int onTrackViaSizeChanged(const TOOL_EVENT &aEvent)
static TOOL_ACTION routerInlineDrag
Activation of the Push and Shove router (inline dragging mode)
Definition: pcb_actions.h:209
TOOL_EVENT MakeEvent() const
Function HasHotKey() Checks if the action has a hot key assigned.
Definition: tool_action.h:104
static TOOL_ACTION routerActivateSettingsDialog
Activation of the Push and Shove settings dialogs.
Definition: pcb_actions.h:204
static const TOOL_ACTION ACT_CustomTrackWidth("pcbnew.InteractiveRouter.CustomTrackViaSize", AS_CONTEXT, TOOL_ACTION::LegacyHotKey(HK_CUSTOM_TRACK_WIDTH), _("Custom Track/Via Size"), _("Shows a dialog for changing the track width and via size."), width_track_xpm)
static const TOOL_ACTION ACT_SetDpDimensions("pcbnew.InteractiveRouter.SetDpDimensions", AS_CONTEXT, TOOL_ACTION::LegacyHotKey(HK_DP_DIMENSIONS), _("Differential Pair Dimensions..."), _("Sets the width and gap of the currently routed differential pair."), ps_diff_pair_tune_length_xpm)
static TOOL_ACTION routerActivateDiffPair
Activation of the Push and Shove router (differential pair mode)
Definition: pcb_actions.h:192
static const TOOL_ACTION ACT_SelLayerAndPlaceThroughVia("pcbnew.InteractiveRouter.SelLayerAndPlaceVia", AS_CONTEXT, TOOL_ACTION::LegacyHotKey(HK_SEL_LAYER_AND_ADD_THROUGH_VIA), _("Select Layer and Place Through Via"), _("Select a layer, then add a through-hole via at the end of currently routed track."), select_w_layer_xpm, AF_NONE,(void *)(VIA_ACTION_FLAGS::VIA|VIA_ACTION_FLAGS::SELECT_LAYER))
static TOOL_ACTION routerActivateDpDimensionsDialog
Definition: pcb_actions.h:205
const VECTOR2I TOOL_BASE::snapToItem ( bool  aEnabled,
ITEM aItem,
VECTOR2I  aP 
)
protectedinherited

Definition at line 345 of file pns_tool_base.cpp.

References SEG::A, GRID_HELPER::Align(), GRID_HELPER::AlignToSegment(), SEG::B, PNS::ITEM::Kind(), PNS::TOOL_BASE::m_gridHelper, PNS::SEGMENT::Seg(), PNS::ITEM::SEGMENT_T, PNS::ITEM::SOLID_T, PNS::ITEM::VIA_T, and PNS::SEGMENT::Width().

Referenced by PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

346 {
347  VECTOR2I anchor;
348 
349  if( !aItem || !aEnabled )
350  {
351  return m_gridHelper->Align( aP );
352  }
353 
354  switch( aItem->Kind() )
355  {
356  case ITEM::SOLID_T:
357  anchor = static_cast<SOLID*>( aItem )->Pos();
358  break;
359 
360  case ITEM::VIA_T:
361  anchor = static_cast<VIA*>( aItem )->Pos();
362  break;
363 
364  case ITEM::SEGMENT_T:
365  {
366  SEGMENT* seg = static_cast<SEGMENT*>( aItem );
367  const SEG& s = seg->Seg();
368  int w = seg->Width();
369 
370 
371  if( ( aP - s.A ).EuclideanNorm() < w / 2 )
372  anchor = s.A;
373  else if( ( aP - s.B ).EuclideanNorm() < w / 2 )
374  anchor = s.B;
375  else
376  anchor = m_gridHelper->AlignToSegment( aP, s );
377 
378  break;
379  }
380 
381  default:
382  break;
383  }
384 
385  return anchor;
386 }
GRID_HELPER * m_gridHelper
Definition: pns_tool_base.h:76
VECTOR2I Align(const VECTOR2I &aPoint) const
VECTOR2I AlignToSegment(const VECTOR2I &aPoint, const SEG &aSeg)
Definition: seg.h:36
VECTOR2I A
Definition: seg.h:46
Struct SEGMENT is a simple container used when filling areas with segments.
Definition: class_zone.h:57
VECTOR2I B
Definition: seg.h:47
void ROUTER_TOOL::switchLayerOnViaPlacement ( )
private

Definition at line 451 of file router_tool.cpp.

References PCB_TOOL::frame(), PCB_BASE_FRAME::GetActiveLayer(), PNS::ROUTER::GetCurrentLayer(), PNS::SIZES_SETTINGS::GetLayerTop(), PNS::TOOL_BASE::m_router, PNS::SIZES_SETTINGS::PairedLayer(), PCB_EDIT_FRAME::SetActiveLayer(), PNS::ROUTER::Sizes(), PNS::ROUTER::SwitchLayer(), and ToLAYER_ID().

Referenced by performRouting().

452 {
453  int al = frame()->GetActiveLayer();
454  int cl = m_router->GetCurrentLayer();
455 
456  if( cl != al )
457  {
458  m_router->SwitchLayer( al );
459  }
460 
461  OPT<int> newLayer = m_router->Sizes().PairedLayer( cl );
462 
463  if( !newLayer )
464  newLayer = m_router->Sizes().GetLayerTop();
465 
466  m_router->SwitchLayer( *newLayer );
467  frame()->SetActiveLayer( ToLAYER_ID( *newLayer ) );
468 }
SIZES_SETTINGS & Sizes()
Definition: pns_router.h:206
void SwitchLayer(int layer)
Definition: pns_router.cpp:405
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
ROUTER * m_router
Definition: pns_tool_base.h:78
boost::optional< T > OPT
Definition: optional.h:7
int GetCurrentLayer() const
Definition: pns_router.cpp:437
OPT< int > PairedLayer(int aLayerId)
virtual void SetActiveLayer(PCB_LAYER_ID aLayer) override
Function SetActiveLayer will change the currently active layer to aLayer and also update the PCB_LAYE...
Definition: pcbframe.cpp:890
virtual PCB_LAYER_ID GetActiveLayer() const
Function GetActiveLayer returns the active layer.
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:774
void TOOL_BASE::updateEndItem ( const TOOL_EVENT aEvent)
protectedvirtualinherited

Definition at line 261 of file pns_tool_base.cpp.

References PNS::TOOL_BASE::checkSnap(), PCB_TOOL::controls(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PNS::ROUTER::GetCurrentLayer(), PNS::ROUTER::GetCurrentNets(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), KIGFX::VIEW_CONTROLS::GetMousePosition(), PNS::ROUTER::IsPlacingVia(), PNS::ITEM::KindStr(), PNS::ITEM::Layers(), PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, PNS::TOOL_BASE::m_router, MD_SHIFT, TOOL_EVENT::Modifier(), PNS::TOOL_BASE::pickSingleItem(), PNS::TOOL_BASE::snapToItem(), and LAYER_RANGE::Start().

Referenced by InlineDrag(), onViaCommand(), performDragging(), and performRouting().

262 {
263  controls()->ForceCursorPosition( false );
264 
265  VECTOR2I mousePos = controls()->GetMousePosition();
266  VECTOR2I cursorPos = controls()->GetCursorPosition();
267 
268  int layer;
269  bool snapEnabled = !aEvent.Modifier( MD_SHIFT );
270 
271  if( m_router->GetCurrentNets().empty() || m_router->GetCurrentNets().front() < 0 )
272  {
273  m_endSnapPoint = snapToItem( snapEnabled, nullptr, mousePos );
275  m_endItem = nullptr;
276 
277  return;
278  }
279 
280  if( m_router->IsPlacingVia() )
281  layer = -1;
282  else
283  layer = m_router->GetCurrentLayer();
284 
285  ITEM* endItem = nullptr;
286 
287  std::vector<int> nets = m_router->GetCurrentNets();
288 
289  for( int net : nets )
290  {
291  endItem = pickSingleItem( mousePos, net, layer );
292 
293  if( endItem )
294  break;
295  }
296 
297  if( checkSnap( endItem ) )
298  {
299  VECTOR2I p = snapToItem( snapEnabled, endItem, mousePos );
300  controls()->ForceCursorPosition( true, p );
301  m_endItem = endItem;
302  m_endSnapPoint = p;
303  } else {
304  m_endItem = nullptr;
305  m_endSnapPoint = cursorPos;
306  }
307 
308  if( m_endItem )
309  {
310  wxLogTrace( "PNS", "%s, layer : %d", m_endItem->KindStr().c_str(), m_endItem->Layers().Start() );
311  }
312 }
virtual VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Function GetMousePosition() Returns the current mouse pointer position.
const LAYER_RANGE & Layers() const
Function Layers()
Definition: pns_item.h:207
int Modifier(int aMask=MD_MODIFIER_MASK) const
Returns information about key modifiers state (Ctrl, Alt, etc.)
Definition: tool_event.h:311
bool IsPlacingVia() const
Definition: pns_router.cpp:468
const std::vector< int > GetCurrentNets() const
Definition: pns_router.cpp:428
const VECTOR2I snapToItem(bool aEnabled, ITEM *aItem, VECTOR2I aP)
KIGFX::VIEW_CONTROLS * controls() const
Definition: pcb_tool.h:132
bool checkSnap(ITEM *aItem)
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
ROUTER * m_router
Definition: pns_tool_base.h:78
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
int Start() const
Definition: pns_layerset.h:83
VECTOR2I m_endSnapPoint
Definition: pns_tool_base.h:74
virtual ITEM * pickSingleItem(const VECTOR2I &aWhere, int aNet=-1, int aLayer=-1)
int GetCurrentLayer() const
Definition: pns_router.cpp:437
const std::string KindStr() const
Function KindStr()
Definition: pns_item.cpp:63
void TOOL_BASE::updateStartItem ( TOOL_EVENT aEvent)
protectedvirtualinherited

Definition at line 227 of file pns_tool_base.cpp.

References PNS::TOOL_BASE::checkSnap(), PCB_TOOL::controls(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), KIGFX::VIEW::GetTopLayer(), TOOL_BASE::getView(), TOOL_EVENT::IsClick(), TOOL_EVENT::IsMotion(), PNS::ITEM::Layers(), PNS::TOOL_BASE::m_startItem, PNS::TOOL_BASE::m_startSnapPoint, MD_SHIFT, TOOL_EVENT::Modifier(), LAYER_RANGE::Overlaps(), PNS::TOOL_BASE::pickSingleItem(), TOOL_EVENT::Position(), and PNS::TOOL_BASE::snapToItem().

Referenced by LENGTH_TUNER_TOOL::mainLoop(), and mainLoop().

228 {
229  int tl = getView()->GetTopLayer();
231  VECTOR2I p;
232 
233  controls()->ForceCursorPosition( false );
234 
235  bool snapEnabled = true;
236 
237  if( aEvent.IsMotion() || aEvent.IsClick() )
238  {
239  snapEnabled = !aEvent.Modifier( MD_SHIFT );
240  p = aEvent.Position();
241  }
242  else
243  {
244  p = cp;
245  }
246 
248 
249  if( !snapEnabled && m_startItem && !m_startItem->Layers().Overlaps( tl ) )
250  m_startItem = nullptr;
251 
252  m_startSnapPoint = snapToItem( snapEnabled, m_startItem, p );
253 
254  if( checkSnap ( m_startItem ))
255  {
257  }
258 }
virtual int GetTopLayer() const
Definition: view.cpp:721
const LAYER_RANGE & Layers() const
Function Layers()
Definition: pns_item.h:207
bool IsMotion() const
Definition: tool_event.h:290
VECTOR2I m_startSnapPoint
Definition: pns_tool_base.h:71
int Modifier(int aMask=MD_MODIFIER_MASK) const
Returns information about key modifiers state (Ctrl, Alt, etc.)
Definition: tool_event.h:311
const VECTOR2D & Position() const
Returns mouse cursor position in world coordinates.
Definition: tool_event.h:248
const VECTOR2I snapToItem(bool aEnabled, ITEM *aItem, VECTOR2I aP)
KIGFX::VIEW_CONTROLS * controls() const
Definition: pcb_tool.h:132
bool checkSnap(ITEM *aItem)
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
ITEM * m_startItem
Definition: pns_tool_base.h:69
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
bool Overlaps(const LAYER_RANGE &aOther) const
Definition: pns_layerset.h:68
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:35
virtual ITEM * pickSingleItem(const VECTOR2I &aWhere, int aNet=-1, int aLayer=-1)
bool IsClick(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:268
OPT_TOOL_EVENT TOOL_INTERACTIVE::Wait ( const TOOL_EVENT_LIST aEventList = TOOL_EVENTTC_ANYTA_ANY ))
inherited

Function Wait()

Suspends execution of the tool until an event specified in aEventList arrives. No parameters means waiting for any event.

Definition at line 55 of file tool_interactive.cpp.

References TOOL_BASE::m_toolMgr, and TOOL_MANAGER::ScheduleWait().

Referenced by PCBNEW_CONTROL::DeleteItemCursor(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), PCB_TOOL::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), PCB_EDITOR_CONTROL::DrillOrigin(), MODULE_EDITOR_TOOLS::EnumeratePads(), PCBNEW_CONTROL::GridSetOrigin(), PCB_EDITOR_CONTROL::HighlightNetCursor(), InlineDrag(), ZOOM_TOOL::Main(), PICKER_TOOL::Main(), EDIT_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::mainLoop(), mainLoop(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), POINT_EDITOR::OnSelectionChange(), performDragging(), performRouting(), LENGTH_TUNER_TOOL::performTuning(), EDIT_TOOL::pickCopyReferencePoint(), DRAWING_TOOL::PlaceDXF(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::runPolygonEventLoop(), GERBVIEW_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ZOOM_TOOL::selectRegion(), DRAWING_TOOL::SetAnchor(), and PCB_EDITOR_CONTROL::ShowLocalRatsnest().

56 {
57  return m_toolMgr->ScheduleWait( this, aEventList );
58 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
OPT< TOOL_EVENT > ScheduleWait(TOOL_BASE *aTool, const TOOL_EVENT_LIST &aConditions)
Pauses execution of a given tool until one or more events matching aConditions arrives.

Member Data Documentation

TOOL_ACTION TOOL_BASE::ACT_RouterOptions
staticinherited

Definition at line 47 of file pns_tool_base.h.

Referenced by ROUTER_TOOL_MENU::ROUTER_TOOL_MENU(), and setTransitions().

ITEM* PNS::TOOL_BASE::m_endItem
protectedinherited
VECTOR2I PNS::TOOL_BASE::m_endSnapPoint
protectedinherited
GRID_HELPER* PNS::TOOL_BASE::m_gridHelper
protectedinherited
PNS_KICAD_IFACE* PNS::TOOL_BASE::m_iface
protectedinherited
MSG_PANEL_ITEMS PNS::TOOL_BASE::m_panelItems
protectedinherited

Definition at line 65 of file pns_tool_base.h.

ROUTING_SETTINGS PNS::TOOL_BASE::m_savedSettings
protectedinherited

Stores routing settings between router invocations.

Definition at line 67 of file pns_tool_base.h.

Referenced by Init(), LENGTH_TUNER_TOOL::mainLoop(), mainLoop(), PNS::TOOL_BASE::Reset(), SettingsDialog(), and ~ROUTER_TOOL().

SIZES_SETTINGS PNS::TOOL_BASE::m_savedSizes
protectedinherited

Stores sizes settings between router invocations.

Definition at line 68 of file pns_tool_base.h.

Referenced by DpDimensionsDialog(), LENGTH_TUNER_TOOL::mainLoop(), mainLoop(), and PNS::TOOL_BASE::Reset().

int PNS::TOOL_BASE::m_startLayer
protectedinherited

Definition at line 70 of file pns_tool_base.h.

Referenced by PNS::TOOL_BASE::TOOL_BASE().

VECTOR2I PNS::TOOL_BASE::m_startSnapPoint
protectedinherited
TOOL_ID TOOL_BASE::m_toolId
protectedinherited

Unique identifier for the tool, assigned by a TOOL_MANAGER instance.

Definition at line 210 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), TOOL_BASE::GetId(), TOOL_BASE::IsToolActive(), and EDIT_TOOL::updateModificationPoint().

TOOL_MANAGER* TOOL_BASE::m_toolMgr
protectedinherited

Definition at line 215 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), PAD_TOOL::applyPadSettings(), TOOL_BASE::attachManager(), PCB_EDITOR_CONTROL::calculateSelectionRatsnest(), GERBVIEW_SELECTION_TOOL::clearSelection(), SELECTION_TOOL::clearSelection(), PAD_TOOL::copyPadSettings(), MODULE_EDITOR_TOOLS::CreatePadFromShapes(), PCB_EDITOR_CONTROL::CrossProbePcbToSch(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), PCBNEW_CONTROL::CursorControl(), CustomTrackWidthDialog(), PCBNEW_CONTROL::DeleteItemCursor(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::drawZone(), PCB_EDITOR_CONTROL::DrillOrigin(), EDIT_TOOL::Duplicate(), EDIT_TOOL::editFootprintInFpEditor(), MODULE_EDITOR_TOOLS::EnumeratePads(), EDIT_TOOL::ExchangeFootprints(), MODULE_EDITOR_TOOLS::ExplodePadToShapes(), SELECTION_TOOL::findCallback(), SELECTION_TOOL::findMove(), EDIT_TOOL::Flip(), TOOL_BASE::getEditFrameInt(), TOOL_BASE::GetManager(), TOOL_BASE::getModelInt(), DRAWING_TOOL::getSourceZoneForAction(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_INTERACTIVE::goInternal(), PCBNEW_CONTROL::GridSetOrigin(), GERBVIEW_CONTROL::HighlightControl(), PCB_EDITOR_CONTROL::HighlightNet(), PCB_EDITOR_CONTROL::HighlightNetCursor(), ALIGN_DISTRIBUTE_TOOL::Init(), PAD_TOOL::Init(), POINT_EDITOR::Init(), PCB_EDITOR_CONTROL::Init(), POSITION_RELATIVE_TOOL::Init(), EDIT_TOOL::Init(), InlineDrag(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isInteractiveDragEnabled(), TOOL_BASE::IsToolActive(), ZOOM_TOOL::Main(), PICKER_TOOL::Main(), EDIT_TOOL::Main(), SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::mainLoop(), mainLoop(), EDIT_TOOL::Mirror(), PCB_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), POINT_EDITOR::OnSelectionChange(), EDIT_TOOL::pickCopyReferencePoint(), PCBNEW_CONTROL::placeBoardItems(), DRAWING_TOOL::PlaceDXF(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), GERBVIEW_SELECTION_TOOL::RequestSelection(), SELECTION_TOOL::RequestSelection(), TOOL_INTERACTIVE::resetTransitions(), EDIT_TOOL::Rotate(), TOOL_INTERACTIVE::RunMainStack(), SELECTION_TOOL::SanitizeSelection(), SELECTION_TOOL::selectConnection(), SELECTION_TOOL::selectCopper(), GERBVIEW_SELECTION_TOOL::SelectItem(), SELECTION_TOOL::SelectItem(), GERBVIEW_SELECTION_TOOL::SelectItems(), SELECTION_TOOL::SelectItems(), GERBVIEW_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectNet(), SELECTION_TOOL::selectOnSheetFromEeschema(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), SELECTION_TOOL::selectSameSheet(), TOOL_INTERACTIVE::SetContextMenu(), PCB_EDITOR_CONTROL::ShowLocalRatsnest(), GERBVIEW_SELECTION_TOOL::toggleSelection(), SELECTION_TOOL::toggleSelection(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), GERBVIEW_SELECTION_TOOL::UnselectItem(), SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), SELECTION_TOOL::UnselectItems(), EDIT_TOOL::updateModificationPoint(), PCB_EDITOR_CONTROL::UpdateSelectionRatsnest(), PCB_EDITOR_CONTROL::ViaSizeDec(), PCB_EDITOR_CONTROL::ViaSizeInc(), TOOL_INTERACTIVE::Wait(), PCB_EDITOR_CONTROL::ZoneDuplicate(), PCB_EDITOR_CONTROL::ZoneFill(), PCB_EDITOR_CONTROL::ZoneMerge(), and PCB_EDITOR_CONTROL::ZoneUnfill().

std::string TOOL_BASE::m_toolName
protectedinherited

Name of the tool.

Names are expected to obey the format application.ToolName

(eg. pcbnew.InteractiveSelection).

Definition at line 214 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

TOOL_SETTINGS TOOL_BASE::m_toolSettings
protectedinherited

Definition at line 216 of file tool_base.h.

Referenced by TOOL_BASE::attachManager(), and TOOL_BASE::GetSettings().

TOOL_TYPE TOOL_BASE::m_type
protectedinherited

Stores the type of the tool.

Definition at line 207 of file tool_base.h.

Referenced by TOOL_BASE::GetType().


The documentation for this class was generated from the following files: