router_tool.cpp File Reference

#include <wx/hyperlink.h>
#include <advanced_config.h>
#include <functional>
#include <board.h>
#include <board_design_settings.h>
#include <board_item.h>
#include <footprint.h>
#include <fp_shape.h>
#include <pad.h>
#include <zone.h>
#include <pcb_edit_frame.h>
#include <pcbnew_id.h>
#include <dialogs/dialog_pns_settings.h>
#include <dialogs/dialog_pns_diff_pair_dimensions.h>
#include <dialogs/dialog_track_via_size.h>
#include <widgets/infobar.h>
#include <widgets/appearance_controls.h>
#include <connectivity/connectivity_data.h>
#include <connectivity/connectivity_algo.h>
#include <confirm.h>
#include <bitmaps.h>
#include <tool/action_menu.h>
#include <tool/tool_manager.h>
#include <tool/tool_menu.h>
#include <tools/pcb_actions.h>
#include <tools/pcb_selection_tool.h>
#include <tools/pcb_grid_helper.h>
#include "router_tool.h"
#include "pns_segment.h"
#include "pns_router.h"
#include "pns_itemset.h"
#include "pns_logger.h"
#include "pns_kicad_iface.h"
#include <plugins/kicad/pcb_plugin.h>

Go to the source code of this file.

Classes
class	TRACK_WIDTH_MENU
class	DIFF_PAIR_MENU

Macros
#define	_(s)   s
#define	_(s)   wxGetTranslation((s))

Enumerations
enum	VIA_ACTION_FLAGS {   VIA_MASK = 0x03, VIA = 0x00, BLIND_VIA = 0x01, MICROVIA = 0x02,   SELECT_LAYER = VIA_MASK + 1 }
	Flags used by via tool actions. More...

Functions
static VIATYPE	getViaTypeFromFlags (int aFlags)
static PCB_LAYER_ID	getTargetLayerFromEvent (const TOOL_EVENT &aEvent)

Variables
static const TOOL_ACTION	ACT_EndTrack ("pcbnew.InteractiveRouter.EndTrack", AS_CONTEXT, WXK_END, "", _("Finish Track"), _("Stops laying the current track."), BITMAPS::checked_ok)
static const TOOL_ACTION	ACT_AutoEndRoute ("pcbnew.InteractiveRouter.AutoEndRoute", AS_CONTEXT, 'F', "", _("Auto-finish Track"), _("Automatically finishes laying the current track."))
static const TOOL_ACTION	ACT_PlaceThroughVia ("pcbnew.InteractiveRouter.PlaceVia", AS_CONTEXT, 'V', LEGACY_HK_NAME("Add Through Via"), _("Place Through Via"), _("Adds a through-hole via at the end of currently routed track."), BITMAPS::via, AF_NONE,(void *) VIA_ACTION_FLAGS::VIA)
static const TOOL_ACTION	ACT_PlaceBlindVia ("pcbnew.InteractiveRouter.PlaceBlindVia", AS_CONTEXT, MD_ALT+MD_SHIFT+ 'V', LEGACY_HK_NAME("Add Blind/Buried Via"), _("Place Blind/Buried Via"), _("Adds a blind or buried via at the end of currently routed track."), BITMAPS::via_buried, AF_NONE,(void *) VIA_ACTION_FLAGS::BLIND_VIA)
static const TOOL_ACTION	ACT_PlaceMicroVia ("pcbnew.InteractiveRouter.PlaceMicroVia", AS_CONTEXT, MD_CTRL+ 'V', LEGACY_HK_NAME("Add MicroVia"), _("Place Microvia"), _("Adds a microvia at the end of currently routed track."), BITMAPS::via_microvia, AF_NONE,(void *) VIA_ACTION_FLAGS::MICROVIA)
static const TOOL_ACTION	ACT_SelLayerAndPlaceThroughVia ("pcbnew.InteractiveRouter.SelLayerAndPlaceVia", AS_CONTEXT, '<', LEGACY_HK_NAME("Select 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."), BITMAPS::select_w_layer, AF_NONE,(void *)(VIA_ACTION_FLAGS::VIA|VIA_ACTION_FLAGS::SELECT_LAYER))
static const TOOL_ACTION	ACT_SelLayerAndPlaceBlindVia ("pcbnew.InteractiveRouter.SelLayerAndPlaceBlindVia", AS_CONTEXT, MD_ALT+'<', LEGACY_HK_NAME("Select 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."), BITMAPS::select_w_layer, AF_NONE,(void *)(VIA_ACTION_FLAGS::BLIND_VIA|VIA_ACTION_FLAGS::SELECT_LAYER))
static const TOOL_ACTION	ACT_SelLayerAndPlaceMicroVia ("pcbnew.InteractiveRouter.SelLayerAndPlaceMicroVia", AS_CONTEXT, 0, "", _("Select Layer and Place Micro Via..."), _("Select a layer, then add a micro via at the end of currently routed track."), BITMAPS::select_w_layer, AF_NONE,(void *)(VIA_ACTION_FLAGS::MICROVIA|VIA_ACTION_FLAGS::SELECT_LAYER))
static const TOOL_ACTION	ACT_CustomTrackWidth ("pcbnew.InteractiveRouter.CustomTrackViaSize", AS_CONTEXT, 'Q', LEGACY_HK_NAME("Custom Track/Via Size"), _("Custom Track/Via Size..."), _("Shows a dialog for changing the track width and via size."), BITMAPS::width_track)
static const TOOL_ACTION	ACT_SwitchPosture ("pcbnew.InteractiveRouter.SwitchPosture", AS_CONTEXT, '/', LEGACY_HK_NAME("Switch Track Posture"), _("Switch Track Posture"), _("Switches posture of the currently routed track."), BITMAPS::change_entry_orient)
static const TOOL_ACTION	ACT_SwitchCornerMode ("pcbnew.InteractiveRouter.SwitchRounding", AS_CONTEXT, MD_CTRL+'/', "", _("Track Corner Mode"), _("Switches between sharp/rounded and 45°/90° corners when routing tracks."), BITMAPS::switch_corner_rounding_shape)

Macro Definition Documentation

_ [1/2]

#define _

(

s

)

s

Definition at line 168 of file router_tool.cpp.

_ [2/2]

#define _

(

s

)

wxGetTranslation((s))

Definition at line 168 of file router_tool.cpp.

Enumeration Type Documentation

VIA_ACTION_FLAGS

enum VIA_ACTION_FLAGS

Flags used by via tool actions.

Enumerator
VIA_MASK
VIA	Normal via.
BLIND_VIA	blind/buried via
MICROVIA	Microvia.
SELECT_LAYER	Ask user to select layer before adding via.

Definition at line 68 of file router_tool.cpp.

{
 // Via type
 VIA_MASK = 0x03,
 VIA = 0x00, 
 BLIND_VIA = 0x01, 
 MICROVIA = 0x02, 

 // Select layer
 SELECT_LAYER = VIA_MASK + 1, 
};

Function Documentation

getTargetLayerFromEvent()

static PCB_LAYER_ID getTargetLayerFromEvent ( const TOOL_EVENT &  aEvent )

static

Definition at line 638 of file router_tool.cpp.

{
 if( aEvent.IsAction( &PCB_ACTIONS::layerTop ) )
 return F_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner1 ) )
 return In1_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner2 ) )
 return In2_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner3 ) )
 return In3_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner4 ) )
 return In4_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner5 ) )
 return In5_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner6 ) )
 return In6_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner7 ) )
 return In7_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner8 ) )
 return In8_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner9 ) )
 return In9_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner10 ) )
 return In10_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner11 ) )
 return In11_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner12 ) )
 return In12_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner13 ) )
 return In13_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner14 ) )
 return In14_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner15 ) )
 return In15_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner16 ) )
 return In16_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner17 ) )
 return In17_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner18 ) )
 return In18_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner19 ) )
 return In19_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner20 ) )
 return In20_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner21 ) )
 return In21_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner22 ) )
 return In22_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner23 ) )
 return In23_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner24 ) )
 return In24_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner25 ) )
 return In25_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner26 ) )
 return In26_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner27 ) )
 return In27_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner28 ) )
 return In28_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner29 ) )
 return In29_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerInner30 ) )
 return In30_Cu;
 else if( aEvent.IsAction( &PCB_ACTIONS::layerBottom ) )
 return B_Cu;
 else
 return UNDEFINED_LAYER;
}

References B_Cu, F_Cu, In10_Cu, In11_Cu, In12_Cu, In13_Cu, In14_Cu, In15_Cu, In16_Cu, In17_Cu, In18_Cu, In19_Cu, In1_Cu, In20_Cu, In21_Cu, In22_Cu, In23_Cu, In24_Cu, In25_Cu, In26_Cu, In27_Cu, In28_Cu, In29_Cu, In2_Cu, In30_Cu, In3_Cu, In4_Cu, In5_Cu, In6_Cu, In7_Cu, In8_Cu, In9_Cu, TOOL_EVENT::IsAction(), PCB_ACTIONS::layerBottom, PCB_ACTIONS::layerInner1, PCB_ACTIONS::layerInner10, PCB_ACTIONS::layerInner11, PCB_ACTIONS::layerInner12, PCB_ACTIONS::layerInner13, PCB_ACTIONS::layerInner14, PCB_ACTIONS::layerInner15, PCB_ACTIONS::layerInner16, PCB_ACTIONS::layerInner17, PCB_ACTIONS::layerInner18, PCB_ACTIONS::layerInner19, PCB_ACTIONS::layerInner2, PCB_ACTIONS::layerInner20, PCB_ACTIONS::layerInner21, PCB_ACTIONS::layerInner22, PCB_ACTIONS::layerInner23, PCB_ACTIONS::layerInner24, PCB_ACTIONS::layerInner25, PCB_ACTIONS::layerInner26, PCB_ACTIONS::layerInner27, PCB_ACTIONS::layerInner28, PCB_ACTIONS::layerInner29, PCB_ACTIONS::layerInner3, PCB_ACTIONS::layerInner30, PCB_ACTIONS::layerInner4, PCB_ACTIONS::layerInner5, PCB_ACTIONS::layerInner6, PCB_ACTIONS::layerInner7, PCB_ACTIONS::layerInner8, PCB_ACTIONS::layerInner9, PCB_ACTIONS::layerTop, and UNDEFINED_LAYER.

Referenced by ROUTER_TOOL::handleLayerSwitch().

getViaTypeFromFlags()

static VIATYPE getViaTypeFromFlags ( int  aFlags )

static

Definition at line 621 of file router_tool.cpp.

{
 switch( aFlags & VIA_ACTION_FLAGS::VIA_MASK )
 {
 case VIA_ACTION_FLAGS::VIA:
 return VIATYPE::THROUGH;
 case VIA_ACTION_FLAGS::BLIND_VIA:
 return VIATYPE::BLIND_BURIED;
 case VIA_ACTION_FLAGS::MICROVIA:
 return VIATYPE::MICROVIA;
 default:
 wxASSERT_MSG( false, wxT( "Unhandled via type" ) );
 return VIATYPE::THROUGH;
 }
}

References BLIND_BURIED, BLIND_VIA, MICROVIA, THROUGH, VIA, and VIA_MASK.

Referenced by ROUTER_TOOL::handleLayerSwitch().

Variable Documentation

ACT_AutoEndRoute

const TOOL_ACTION ACT_AutoEndRoute("pcbnew.InteractiveRouter.AutoEndRoute", AS_CONTEXT, 'F', "", _("Auto-finish Track"), _("Automatically finishes laying the current track."))

static

ACT_CustomTrackWidth

const TOOL_ACTION ACT_CustomTrackWidth("pcbnew.InteractiveRouter.CustomTrackViaSize", AS_CONTEXT, 'Q', LEGACY_HK_NAME("Custom Track/Via Size"), _("Custom Track/Via Size..."), _("Shows a dialog for changing the track width and via size."), BITMAPS::width_track)

static

Referenced by TRACK_WIDTH_MENU::eventHandler(), ROUTER_TOOL::performRouting(), and ROUTER_TOOL::setTransitions().

ACT_EndTrack

const TOOL_ACTION ACT_EndTrack("pcbnew.InteractiveRouter.EndTrack", AS_CONTEXT, WXK_END, "", _("Finish Track"), _("Stops laying the current track."), BITMAPS::checked_ok)

static

Referenced by ROUTER_TOOL::Init(), and ROUTER_TOOL::performRouting().

ACT_PlaceBlindVia

const TOOL_ACTION ACT_PlaceBlindVia("pcbnew.InteractiveRouter.PlaceBlindVia", AS_CONTEXT, MD_ALT+MD_SHIFT+'V', LEGACY_HK_NAME("Add Blind/Buried Via"), _("Place Blind/Buried Via"), _("Adds a blind or buried via at the end of currently routed track."), BITMAPS::via_buried, AF_NONE,(void *) VIA_ACTION_FLAGS::BLIND_VIA)

static

Referenced by ROUTER_TOOL::Init(), and ROUTER_TOOL::setTransitions().

ACT_PlaceMicroVia

const TOOL_ACTION ACT_PlaceMicroVia("pcbnew.InteractiveRouter.PlaceMicroVia", AS_CONTEXT, MD_CTRL+'V', LEGACY_HK_NAME("Add MicroVia"), _("Place Microvia"), _("Adds a microvia at the end of currently routed track."), BITMAPS::via_microvia, AF_NONE,(void *) VIA_ACTION_FLAGS::MICROVIA)

static

Referenced by ROUTER_TOOL::Init(), and ROUTER_TOOL::setTransitions().

ACT_PlaceThroughVia

const TOOL_ACTION ACT_PlaceThroughVia("pcbnew.InteractiveRouter.PlaceVia", AS_CONTEXT, 'V', LEGACY_HK_NAME("Add Through Via"), _("Place Through Via"), _("Adds a through-hole via at the end of currently routed track."), BITMAPS::via, AF_NONE,(void *) VIA_ACTION_FLAGS::VIA)

static

Referenced by ROUTER_TOOL::Init(), ROUTER_TOOL::MainLoop(), and ROUTER_TOOL::setTransitions().

ACT_SelLayerAndPlaceBlindVia

const TOOL_ACTION ACT_SelLayerAndPlaceBlindVia("pcbnew.InteractiveRouter.SelLayerAndPlaceBlindVia", AS_CONTEXT, MD_ALT+'<', LEGACY_HK_NAME("Select 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."), BITMAPS::select_w_layer, AF_NONE,(void *)(VIA_ACTION_FLAGS::BLIND_VIA|VIA_ACTION_FLAGS::SELECT_LAYER))

static

Referenced by ROUTER_TOOL::Init(), and ROUTER_TOOL::setTransitions().

ACT_SelLayerAndPlaceMicroVia

const TOOL_ACTION ACT_SelLayerAndPlaceMicroVia("pcbnew.InteractiveRouter.SelLayerAndPlaceMicroVia", AS_CONTEXT, 0, "", _("Select Layer and Place Micro Via..."), _("Select a layer, then add a micro via at the end of currently routed track."), BITMAPS::select_w_layer, AF_NONE,(void *)(VIA_ACTION_FLAGS::MICROVIA|VIA_ACTION_FLAGS::SELECT_LAYER))

static

Referenced by ROUTER_TOOL::Init(), and ROUTER_TOOL::setTransitions().

ACT_SelLayerAndPlaceThroughVia

const TOOL_ACTION ACT_SelLayerAndPlaceThroughVia("pcbnew.InteractiveRouter.SelLayerAndPlaceVia", AS_CONTEXT, '<', LEGACY_HK_NAME("Select 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."), BITMAPS::select_w_layer, AF_NONE,(void *)(VIA_ACTION_FLAGS::VIA|VIA_ACTION_FLAGS::SELECT_LAYER))

static

Referenced by ROUTER_TOOL::Init(), and ROUTER_TOOL::setTransitions().

ACT_SwitchCornerMode

const TOOL_ACTION ACT_SwitchCornerMode("pcbnew.InteractiveRouter.SwitchRounding", AS_CONTEXT, MD_CTRL+'/', "", _("Track Corner Mode"), _("Switches between sharp/rounded and 45°/90° corners when routing tracks."), BITMAPS::switch_corner_rounding_shape)

static

Referenced by ROUTER_TOOL::Init(), and ROUTER_TOOL::performRouting().

ACT_SwitchPosture

const TOOL_ACTION ACT_SwitchPosture("pcbnew.InteractiveRouter.SwitchPosture", AS_CONTEXT, '/', LEGACY_HK_NAME("Switch Track Posture"), _("Switch Track Posture"), _("Switches posture of the currently routed track."), BITMAPS::change_entry_orient)

static

Referenced by ROUTER_TOOL::Init(), and ROUTER_TOOL::performRouting().