887 lines
25 KiB
C++
887 lines
25 KiB
C++
/*
|
|
* KiRouter - a push-and-(sometimes-)shove PCB router
|
|
*
|
|
* Copyright (C) 2013-2017 CERN
|
|
* Copyright (C) 2017 KiCad Developers, see AUTHORS.txt for contributors.
|
|
* Author: Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the
|
|
* Free Software Foundation, either version 3 of the License, or (at your
|
|
* option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include <wx/numdlg.h>
|
|
|
|
#include <boost/optional.hpp>
|
|
#include <functional>
|
|
using namespace std::placeholders;
|
|
|
|
#include "class_draw_panel_gal.h"
|
|
#include "class_board.h"
|
|
|
|
#include <wxPcbStruct.h>
|
|
#include <id.h>
|
|
#include <macros.h>
|
|
#include <pcbnew_id.h>
|
|
#include <view/view.h>
|
|
#include <view/view_controls.h>
|
|
#include <pcb_painter.h>
|
|
#include <dialogs/dialog_pns_settings.h>
|
|
#include <dialogs/dialog_pns_diff_pair_dimensions.h>
|
|
#include <dialogs/dialog_track_via_size.h>
|
|
#include <base_units.h>
|
|
#include <hotkeys.h>
|
|
#include <confirm.h>
|
|
|
|
#include <tool/context_menu.h>
|
|
#include <tool/tool_manager.h>
|
|
#include <tool/tool_settings.h>
|
|
#include <tools/common_actions.h>
|
|
#include <tools/size_menu.h>
|
|
#include <tools/selection_tool.h>
|
|
#include <tools/edit_tool.h>
|
|
#include <tools/grid_menu.h>
|
|
#include <tools/zoom_menu.h>
|
|
|
|
#include <ratsnest_data.h>
|
|
|
|
#include "router_tool.h"
|
|
#include "pns_segment.h"
|
|
#include "pns_router.h"
|
|
|
|
using namespace KIGFX;
|
|
using boost::optional;
|
|
|
|
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 const TOOL_ACTION ACT_EndTrack( "pcbnew.InteractiveRouter.EndTrack", AS_CONTEXT, WXK_END,
|
|
_( "End Track" ), _( "Stops laying the current track." ), checked_ok_xpm );
|
|
|
|
static const TOOL_ACTION ACT_AutoEndRoute( "pcbnew.InteractiveRouter.AutoEndRoute", AS_CONTEXT, 'F',
|
|
_( "Auto-end Track" ), _( "Automagically finishes currently routed track." ) );
|
|
|
|
static const TOOL_ACTION ACT_Drag( "pcbnew.InteractiveRouter.Drag", AS_CONTEXT,
|
|
TOOL_ACTION::LegacyHotKey( HK_DRAG_TRACK_KEEP_SLOPE ),
|
|
_( "Drag Track/Via" ), _( "Drags a track or a via." ), drag_track_segment_xpm );
|
|
|
|
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 );
|
|
|
|
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 );
|
|
|
|
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 );
|
|
|
|
static const TOOL_ACTION ACT_CustomTrackWidth( "pcbnew.InteractiveRouter.CustomTrackViaSize",
|
|
AS_CONTEXT, 'Q',
|
|
_( "Custom Track/Via Size" ),
|
|
_( "Shows a dialog for changing the track width and via size." ),
|
|
width_track_xpm );
|
|
|
|
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 );
|
|
|
|
static const TOOL_ACTION ACT_SetDpDimensions( "pcbnew.InteractiveRouter.SetDpDimensions",
|
|
AS_CONTEXT, 'P',
|
|
_( "Differential Pair Dimensions..." ),
|
|
_( "Sets the width and gap of the currently routed differential pair." ),
|
|
ps_diff_pair_tune_length_xpm );
|
|
|
|
|
|
ROUTER_TOOL::ROUTER_TOOL() :
|
|
TOOL_BASE( "pcbnew.InteractiveRouter" )
|
|
{
|
|
}
|
|
|
|
|
|
class TRACK_WIDTH_MENU: public TRACK_VIA_SIZE_MENU
|
|
{
|
|
public:
|
|
TRACK_WIDTH_MENU( const BOARD* aBoard )
|
|
: TRACK_VIA_SIZE_MENU( true, true )
|
|
{
|
|
SetBoard( aBoard );
|
|
}
|
|
|
|
void SetBoard( const BOARD* aBoard )
|
|
{
|
|
m_board = aBoard;
|
|
|
|
Clear();
|
|
|
|
Append( ID_POPUP_PCB_SELECT_CUSTOM_WIDTH, _( "Custom size" ),
|
|
wxEmptyString, wxITEM_CHECK );
|
|
|
|
Append( ID_POPUP_PCB_SELECT_AUTO_WIDTH, _( "Use the starting track width" ),
|
|
_( "Route using the width of the starting track." ), wxITEM_CHECK );
|
|
|
|
Append( ID_POPUP_PCB_SELECT_USE_NETCLASS_VALUES, _( "Use net class values" ),
|
|
_( "Use track and via sizes from the net class" ), wxITEM_CHECK );
|
|
|
|
AppendSeparator();
|
|
|
|
// Append the list of tracks & via sizes
|
|
AppendSizes( aBoard );
|
|
}
|
|
|
|
protected:
|
|
CONTEXT_MENU* create() const override
|
|
{
|
|
return new TRACK_WIDTH_MENU( m_board );
|
|
}
|
|
|
|
OPT_TOOL_EVENT eventHandler( const wxMenuEvent& aEvent ) override
|
|
{
|
|
BOARD_DESIGN_SETTINGS &bds = m_board->GetDesignSettings();
|
|
int id = aEvent.GetId();
|
|
|
|
// On Windows, this handler can be called with a non existing event ID not existing
|
|
// in any menuitem.
|
|
// So we keep trace of in-range/out-of-range event ID
|
|
bool in_range = true;
|
|
|
|
// Initial settings, to be modified below, but only if the ID exists in this menu
|
|
bool useConnectedTrackWidth = false;
|
|
bool useCustomTrackViaSize = false;
|
|
|
|
if( id == ID_POPUP_PCB_SELECT_CUSTOM_WIDTH )
|
|
{
|
|
useCustomTrackViaSize = true;
|
|
}
|
|
else if( id == ID_POPUP_PCB_SELECT_AUTO_WIDTH )
|
|
{
|
|
useConnectedTrackWidth = true;
|
|
}
|
|
else if( id == ID_POPUP_PCB_SELECT_USE_NETCLASS_VALUES )
|
|
{
|
|
bds.SetViaSizeIndex( 0 );
|
|
bds.SetTrackWidthIndex( 0 );
|
|
}
|
|
else if( id >= ID_POPUP_PCB_SELECT_VIASIZE1 &&
|
|
id <= ID_POPUP_PCB_SELECT_VIASIZE16 )
|
|
{
|
|
// via size has changed
|
|
bds.SetViaSizeIndex( id - ID_POPUP_PCB_SELECT_VIASIZE1 );
|
|
}
|
|
else if( id >= ID_POPUP_PCB_SELECT_WIDTH1 &&
|
|
id <= ID_POPUP_PCB_SELECT_WIDTH16 )
|
|
{
|
|
// track width has changed
|
|
bds.SetTrackWidthIndex( id - ID_POPUP_PCB_SELECT_WIDTH1 );
|
|
}
|
|
else
|
|
{
|
|
in_range = false; // This event ID does not exist in the menu
|
|
wxASSERT_MSG( false, "OPT_TOOL_EVENT EventHandler: unexpected id" );
|
|
// Fix me: How to return this error as OPT_TOOL_EVENT?
|
|
}
|
|
|
|
if( in_range )
|
|
{
|
|
// Update this setup only id the event ID matches the options of this menu
|
|
bds.m_UseConnectedTrackWidth = useConnectedTrackWidth;
|
|
bds.UseCustomTrackViaSize( useCustomTrackViaSize );
|
|
}
|
|
|
|
return OPT_TOOL_EVENT( COMMON_ACTIONS::trackViaSizeChanged.MakeEvent() );
|
|
}
|
|
|
|
private:
|
|
const BOARD* m_board;
|
|
};
|
|
|
|
|
|
class ROUTER_TOOL_MENU : public CONTEXT_MENU
|
|
{
|
|
public:
|
|
ROUTER_TOOL_MENU( const BOARD* aBoard, PCB_EDIT_FRAME& aFrame, PNS::ROUTER_MODE aMode ) :
|
|
m_board( aBoard ), m_frame( aFrame ), m_mode( aMode ),
|
|
m_widthMenu( aBoard ), m_zoomMenu( &aFrame ), m_gridMenu( &aFrame )
|
|
{
|
|
SetTitle( _( "Interactive Router" ) );
|
|
Add( ACT_NewTrack );
|
|
Add( ACT_EndTrack );
|
|
// Add( ACT_AutoEndRoute ); // fixme: not implemented yet. Sorry.
|
|
Add( ACT_Drag );
|
|
Add( ACT_PlaceThroughVia );
|
|
Add( ACT_PlaceBlindVia );
|
|
Add( ACT_PlaceMicroVia );
|
|
Add( ACT_SwitchPosture );
|
|
|
|
AppendSeparator();
|
|
|
|
m_widthMenu.SetBoard( aBoard );
|
|
Add( &m_widthMenu, _( "Select Track/Via Width" ) );
|
|
|
|
Add( ACT_CustomTrackWidth );
|
|
|
|
if( aMode == PNS::PNS_MODE_ROUTE_DIFF_PAIR )
|
|
Add( ACT_SetDpDimensions );
|
|
|
|
AppendSeparator();
|
|
Add( PNS::TOOL_BASE::ACT_RouterOptions );
|
|
|
|
AppendSeparator();
|
|
Add( &m_zoomMenu, _( "Zoom Select" ), false );
|
|
Add( &m_gridMenu, _( "Grid Select" ), false );
|
|
}
|
|
|
|
private:
|
|
CONTEXT_MENU* create() const override
|
|
{
|
|
return new ROUTER_TOOL_MENU( m_board, m_frame, m_mode );
|
|
}
|
|
|
|
const BOARD* m_board;
|
|
PCB_EDIT_FRAME& m_frame;
|
|
PNS::ROUTER_MODE m_mode;
|
|
TRACK_WIDTH_MENU m_widthMenu;
|
|
ZOOM_MENU m_zoomMenu;
|
|
GRID_MENU m_gridMenu;
|
|
};
|
|
|
|
|
|
ROUTER_TOOL::~ROUTER_TOOL()
|
|
{
|
|
m_savedSettings.Save( GetSettings() );
|
|
}
|
|
|
|
|
|
bool ROUTER_TOOL::Init()
|
|
{
|
|
m_savedSettings.Load( GetSettings() );
|
|
return true;
|
|
}
|
|
|
|
|
|
void ROUTER_TOOL::Reset( RESET_REASON aReason )
|
|
{
|
|
TOOL_BASE::Reset( aReason );
|
|
}
|
|
|
|
|
|
int ROUTER_TOOL::getDefaultWidth( int aNetCode )
|
|
{
|
|
int w, d1, d2;
|
|
|
|
getNetclassDimensions( aNetCode, w, d1, d2 );
|
|
|
|
return w;
|
|
}
|
|
|
|
|
|
void ROUTER_TOOL::getNetclassDimensions( int aNetCode, int& aWidth,
|
|
int& aViaDiameter, int& aViaDrill )
|
|
{
|
|
BOARD_DESIGN_SETTINGS &bds = m_board->GetDesignSettings();
|
|
|
|
NETCLASSPTR netClass;
|
|
NETINFO_ITEM* ni = m_board->FindNet( aNetCode );
|
|
|
|
if( ni )
|
|
{
|
|
wxString netClassName = ni->GetClassName();
|
|
netClass = bds.m_NetClasses.Find( netClassName );
|
|
}
|
|
|
|
if( !netClass )
|
|
netClass = bds.GetDefault();
|
|
|
|
aWidth = netClass->GetTrackWidth();
|
|
aViaDiameter = netClass->GetViaDiameter();
|
|
aViaDrill = netClass->GetViaDrill();
|
|
}
|
|
|
|
|
|
void ROUTER_TOOL::handleCommonEvents( const TOOL_EVENT& aEvent )
|
|
{
|
|
#ifdef DEBUG
|
|
if( aEvent.IsKeyPressed() )
|
|
{
|
|
switch( aEvent.KeyCode() )
|
|
{
|
|
case '0':
|
|
wxLogTrace( "PNS", "saving drag/route log...\n" );
|
|
m_router->DumpLog();
|
|
break;
|
|
}
|
|
}
|
|
#endif
|
|
}
|
|
|
|
|
|
int ROUTER_TOOL::getStartLayer( const PNS::ITEM* aItem )
|
|
{
|
|
int tl = getView()->GetTopLayer();
|
|
|
|
if( m_startItem )
|
|
{
|
|
const LAYER_RANGE& ls = m_startItem->Layers();
|
|
|
|
if( ls.Overlaps( tl ) )
|
|
return tl;
|
|
else
|
|
return ls.Start();
|
|
}
|
|
|
|
return tl;
|
|
}
|
|
|
|
|
|
void ROUTER_TOOL::switchLayerOnViaPlacement()
|
|
{
|
|
int al = m_frame->GetActiveLayer();
|
|
int cl = m_router->GetCurrentLayer();
|
|
|
|
if( cl != al )
|
|
{
|
|
m_router->SwitchLayer( al );
|
|
}
|
|
|
|
optional<int> newLayer = m_router->Sizes().PairedLayer( cl );
|
|
|
|
if( !newLayer )
|
|
newLayer = m_router->Sizes().GetLayerTop();
|
|
|
|
m_router->SwitchLayer( *newLayer );
|
|
m_frame->SetActiveLayer( ToLAYER_ID( *newLayer ) );
|
|
}
|
|
|
|
|
|
int ROUTER_TOOL::onViaCommand( const TOOL_EVENT& aEvent )
|
|
{
|
|
VIATYPE_T viaType = VIA_THROUGH;
|
|
|
|
if( aEvent.IsAction( &ACT_PlaceThroughVia ) )
|
|
viaType = VIA_THROUGH;
|
|
else if( aEvent.IsAction( &ACT_PlaceBlindVia ) )
|
|
viaType = VIA_BLIND_BURIED;
|
|
else if( aEvent.IsAction( &ACT_PlaceMicroVia ) )
|
|
viaType = VIA_MICROVIA;
|
|
else
|
|
wxASSERT_MSG( false, "Unhandled via type" );
|
|
|
|
BOARD_DESIGN_SETTINGS& bds = m_board->GetDesignSettings();
|
|
|
|
const int layerCount = bds.GetCopperLayerCount();
|
|
int currentLayer = m_router->GetCurrentLayer();
|
|
LAYER_ID pairTop = m_frame->GetScreen()->m_Route_Layer_TOP;
|
|
LAYER_ID pairBottom = m_frame->GetScreen()->m_Route_Layer_BOTTOM;
|
|
|
|
PNS::SIZES_SETTINGS sizes = m_router->Sizes();
|
|
|
|
// fixme: P&S supports more than one fixed layer pair. Update the dialog?
|
|
sizes.ClearLayerPairs();
|
|
|
|
if( !m_router->IsPlacingVia() )
|
|
{
|
|
// Cannot place microvias or blind vias if not allowed (obvious)
|
|
if( ( viaType == VIA_BLIND_BURIED ) && ( !bds.m_BlindBuriedViaAllowed ) )
|
|
{
|
|
DisplayError( m_frame, _( "Blind/buried vias have to be enabled in the design settings." ) );
|
|
return false;
|
|
}
|
|
|
|
if( ( viaType == VIA_MICROVIA ) && ( !bds.m_MicroViasAllowed ) )
|
|
{
|
|
DisplayError( m_frame, _( "Microvias have to be enabled in the design settings." ) );
|
|
return false;
|
|
}
|
|
|
|
// Can only place through vias on 2-layer boards
|
|
if( ( viaType != VIA_THROUGH ) && ( layerCount <= 2 ) )
|
|
{
|
|
DisplayError( m_frame, _( "Only through vias are allowed on 2 layer boards." ) );
|
|
return false;
|
|
}
|
|
|
|
// Can only place microvias if we're on an outer layer, or directly adjacent to one
|
|
if( ( viaType == VIA_MICROVIA ) && ( currentLayer > In1_Cu ) && ( currentLayer < layerCount - 2 ) )
|
|
{
|
|
DisplayError( m_frame, _( "Microvias can be placed only between the outer layers " \
|
|
"(F.Cu/B.Cu) and the ones directly adjacent to them." ) );
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Convert blind/buried via to a through hole one, if it goes through all layers
|
|
if( viaType == VIA_BLIND_BURIED && ( ( currentLayer == B_Cu ) || ( currentLayer == F_Cu ) )
|
|
&& ( ( pairTop == B_Cu && pairBottom == F_Cu )
|
|
|| ( pairTop == F_Cu && pairBottom == B_Cu ) ) )
|
|
{
|
|
viaType = VIA_THROUGH;
|
|
}
|
|
|
|
switch( viaType )
|
|
{
|
|
case VIA_THROUGH:
|
|
sizes.SetViaDiameter( bds.GetCurrentViaSize() );
|
|
sizes.SetViaDrill( bds.GetCurrentViaDrill() );
|
|
sizes.AddLayerPair( pairTop, pairBottom );
|
|
break;
|
|
|
|
case VIA_MICROVIA:
|
|
sizes.SetViaDiameter( bds.GetCurrentMicroViaSize() );
|
|
sizes.SetViaDrill( bds.GetCurrentMicroViaDrill() );
|
|
|
|
if( currentLayer == F_Cu || currentLayer == In1_Cu )
|
|
sizes.AddLayerPair( F_Cu, In1_Cu );
|
|
else if( currentLayer == B_Cu || currentLayer == layerCount - 2 )
|
|
sizes.AddLayerPair( B_Cu, layerCount - 2 );
|
|
else
|
|
wxASSERT( false );
|
|
break;
|
|
|
|
case VIA_BLIND_BURIED:
|
|
sizes.SetViaDiameter( bds.GetCurrentViaSize() );
|
|
sizes.SetViaDrill( bds.GetCurrentViaDrill() );
|
|
|
|
if( currentLayer == pairTop || currentLayer == pairBottom )
|
|
sizes.AddLayerPair( pairTop, pairBottom );
|
|
else
|
|
sizes.AddLayerPair( pairTop, currentLayer );
|
|
break;
|
|
|
|
default:
|
|
wxASSERT( false );
|
|
break;
|
|
}
|
|
|
|
sizes.SetViaType( viaType );
|
|
|
|
m_router->UpdateSizes( sizes );
|
|
m_router->ToggleViaPlacement();
|
|
|
|
updateEndItem( aEvent );
|
|
|
|
m_router->Move( m_endSnapPoint, m_endItem ); // refresh
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
bool ROUTER_TOOL::prepareInteractive()
|
|
{
|
|
int routingLayer = getStartLayer( m_startItem );
|
|
|
|
if( !IsCopperLayer( routingLayer ) )
|
|
{
|
|
DisplayError( m_frame, _( "Tracks on Copper layers only" ) );
|
|
return false;
|
|
}
|
|
|
|
m_frame->SetActiveLayer( ToLAYER_ID( routingLayer ) );
|
|
|
|
// fixme: switch on invisible layer
|
|
|
|
// for some reason I don't understand, GetNetclass() may return null sometimes...
|
|
if( m_startItem && m_startItem->Net() >= 0 &&
|
|
m_startItem->Parent() && m_startItem->Parent()->GetNetClass() )
|
|
{
|
|
highlightNet( true, m_startItem->Net() );
|
|
// Update track width and via size shown in main toolbar comboboxes
|
|
m_frame->SetCurrentNetClass( m_startItem->Parent()->GetNetClass()->GetName() );
|
|
}
|
|
else
|
|
m_frame->SetCurrentNetClass( NETCLASS::Default );
|
|
|
|
m_ctls->ForceCursorPosition( false );
|
|
m_ctls->SetAutoPan( true );
|
|
|
|
PNS::SIZES_SETTINGS sizes( m_router->Sizes() );
|
|
|
|
sizes.Init( m_board, m_startItem );
|
|
sizes.AddLayerPair( m_frame->GetScreen()->m_Route_Layer_TOP,
|
|
m_frame->GetScreen()->m_Route_Layer_BOTTOM );
|
|
m_router->UpdateSizes( sizes );
|
|
|
|
if( !m_router->StartRouting( m_startSnapPoint, m_startItem, routingLayer ) )
|
|
{
|
|
DisplayError( m_frame, m_router->FailureReason() );
|
|
highlightNet( false );
|
|
return false;
|
|
}
|
|
|
|
m_endItem = NULL;
|
|
m_endSnapPoint = m_startSnapPoint;
|
|
|
|
m_frame->UndoRedoBlock( true );
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool ROUTER_TOOL::finishInteractive()
|
|
{
|
|
m_router->StopRouting();
|
|
|
|
m_ctls->SetAutoPan( false );
|
|
m_ctls->ForceCursorPosition( false );
|
|
m_frame->UndoRedoBlock( false );
|
|
highlightNet( false );
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void ROUTER_TOOL::performRouting()
|
|
{
|
|
if( !prepareInteractive() )
|
|
return;
|
|
|
|
while( OPT_TOOL_EVENT evt = Wait() )
|
|
{
|
|
if( evt->IsMotion() )
|
|
{
|
|
m_router->SetOrthoMode( evt->Modifier( MD_CTRL ) );
|
|
updateEndItem( *evt );
|
|
m_router->Move( m_endSnapPoint, m_endItem );
|
|
}
|
|
else if( evt->IsClick( BUT_LEFT ) )
|
|
{
|
|
updateEndItem( *evt );
|
|
bool needLayerSwitch = m_router->IsPlacingVia();
|
|
|
|
if( m_router->FixRoute( m_endSnapPoint, m_endItem ) )
|
|
break;
|
|
|
|
if( needLayerSwitch )
|
|
switchLayerOnViaPlacement();
|
|
|
|
// Synchronize the indicated layer
|
|
m_frame->SetActiveLayer( ToLAYER_ID( m_router->GetCurrentLayer() ) );
|
|
updateEndItem( *evt );
|
|
m_router->Move( m_endSnapPoint, m_endItem );
|
|
m_startItem = NULL;
|
|
}
|
|
else if( evt->IsAction( &ACT_SwitchPosture ) )
|
|
{
|
|
m_router->FlipPosture();
|
|
updateEndItem( *evt );
|
|
m_router->Move( m_endSnapPoint, m_endItem ); // refresh
|
|
}
|
|
else if( evt->IsAction( &COMMON_ACTIONS::layerChanged ) )
|
|
{
|
|
m_router->SwitchLayer( m_frame->GetActiveLayer() );
|
|
updateEndItem( *evt );
|
|
m_router->Move( m_endSnapPoint, m_endItem ); // refresh
|
|
}
|
|
else if( evt->IsAction( &ACT_EndTrack ) )
|
|
{
|
|
bool still_routing = true;
|
|
while( still_routing )
|
|
still_routing = m_router->FixRoute( m_endSnapPoint, m_endItem );
|
|
break;
|
|
}
|
|
else if( evt->IsCancel() || evt->IsActivate() || evt->IsUndoRedo() )
|
|
break;
|
|
}
|
|
|
|
finishInteractive();
|
|
}
|
|
|
|
|
|
int ROUTER_TOOL::DpDimensionsDialog( const TOOL_EVENT& aEvent )
|
|
{
|
|
Activate();
|
|
|
|
PNS::SIZES_SETTINGS sizes = m_router->Sizes();
|
|
DIALOG_PNS_DIFF_PAIR_DIMENSIONS settingsDlg( m_frame, sizes );
|
|
|
|
if( settingsDlg.ShowModal() )
|
|
{
|
|
m_router->UpdateSizes( sizes );
|
|
m_savedSizes = sizes;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
int ROUTER_TOOL::SettingsDialog( const TOOL_EVENT& aEvent )
|
|
{
|
|
Activate();
|
|
|
|
DIALOG_PNS_SETTINGS settingsDlg( m_frame, m_router->Settings() );
|
|
|
|
if( settingsDlg.ShowModal() )
|
|
m_savedSettings = m_router->Settings();
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
void ROUTER_TOOL::SetTransitions()
|
|
{
|
|
Go( &ROUTER_TOOL::RouteSingleTrace, COMMON_ACTIONS::routerActivateSingle.MakeEvent() );
|
|
Go( &ROUTER_TOOL::RouteDiffPair, COMMON_ACTIONS::routerActivateDiffPair.MakeEvent() );
|
|
Go( &ROUTER_TOOL::DpDimensionsDialog, COMMON_ACTIONS::routerActivateDpDimensionsDialog.MakeEvent() );
|
|
Go( &ROUTER_TOOL::SettingsDialog, COMMON_ACTIONS::routerActivateSettingsDialog.MakeEvent() );
|
|
Go( &ROUTER_TOOL::InlineDrag, COMMON_ACTIONS::routerInlineDrag.MakeEvent() );
|
|
|
|
Go( &ROUTER_TOOL::onViaCommand, ACT_PlaceThroughVia.MakeEvent() );
|
|
Go( &ROUTER_TOOL::onViaCommand, ACT_PlaceBlindVia.MakeEvent() );
|
|
Go( &ROUTER_TOOL::onViaCommand, ACT_PlaceMicroVia.MakeEvent() );
|
|
|
|
// TODO is not this redundant? the same actions can be used for menus and hotkeys
|
|
Go( &ROUTER_TOOL::SettingsDialog, ACT_RouterOptions.MakeEvent() );
|
|
Go( &ROUTER_TOOL::DpDimensionsDialog, ACT_SetDpDimensions.MakeEvent() );
|
|
|
|
Go( &ROUTER_TOOL::CustomTrackWidthDialog, ACT_CustomTrackWidth.MakeEvent() );
|
|
Go( &ROUTER_TOOL::onTrackViaSizeChanged, COMMON_ACTIONS::trackViaSizeChanged.MakeEvent() );
|
|
}
|
|
|
|
|
|
int ROUTER_TOOL::RouteSingleTrace( const TOOL_EVENT& aEvent )
|
|
{
|
|
m_frame->SetToolID( ID_TRACK_BUTT, wxCURSOR_PENCIL, _( "Route Track" ) );
|
|
return mainLoop( PNS::PNS_MODE_ROUTE_SINGLE );
|
|
}
|
|
|
|
|
|
int ROUTER_TOOL::RouteDiffPair( const TOOL_EVENT& aEvent )
|
|
{
|
|
m_frame->SetToolID( ID_TRACK_BUTT, wxCURSOR_PENCIL, _( "Router Differential Pair" ) );
|
|
return mainLoop( PNS::PNS_MODE_ROUTE_DIFF_PAIR );
|
|
}
|
|
|
|
|
|
int ROUTER_TOOL::mainLoop( PNS::ROUTER_MODE aMode )
|
|
{
|
|
PCB_EDIT_FRAME* frame = getEditFrame<PCB_EDIT_FRAME>();
|
|
BOARD* board = getModel<BOARD>();
|
|
|
|
// Deselect all items
|
|
m_toolMgr->RunAction( COMMON_ACTIONS::selectionClear, true );
|
|
|
|
Activate();
|
|
|
|
m_router->SetMode( aMode );
|
|
|
|
m_ctls->ShowCursor( true );
|
|
|
|
m_startSnapPoint = getViewControls()->GetCursorPosition();
|
|
|
|
std::unique_ptr<ROUTER_TOOL_MENU> ctxMenu( new ROUTER_TOOL_MENU( board, *frame, aMode ) );
|
|
SetContextMenu( ctxMenu.get() );
|
|
|
|
// Main loop: keep receiving events
|
|
while( OPT_TOOL_EVENT evt = Wait() )
|
|
{
|
|
if( evt->IsCancel() || evt->IsActivate() )
|
|
{
|
|
break; // Finish
|
|
}
|
|
else if( evt->Action() == TA_UNDO_REDO_PRE )
|
|
{
|
|
m_router->ClearWorld();
|
|
}
|
|
else if( evt->Action() == TA_UNDO_REDO_POST || evt->Action() == TA_MODEL_CHANGE )
|
|
{
|
|
m_router->SyncWorld();
|
|
}
|
|
else if( evt->IsMotion() )
|
|
{
|
|
updateStartItem( *evt );
|
|
}
|
|
else if( evt->IsClick( BUT_LEFT ) || evt->IsAction( &ACT_NewTrack ) )
|
|
{
|
|
updateStartItem( *evt );
|
|
|
|
if( evt->Modifier( MD_CTRL ) )
|
|
performDragging();
|
|
else
|
|
performRouting();
|
|
}
|
|
else if( evt->IsAction( &ACT_Drag ) )
|
|
{
|
|
updateStartItem( *evt );
|
|
performDragging();
|
|
}
|
|
else if( evt->IsAction( &ACT_PlaceThroughVia ) )
|
|
{
|
|
m_toolMgr->RunAction( COMMON_ACTIONS::layerToggle, true );
|
|
}
|
|
else if( evt->IsAction( &COMMON_ACTIONS::remove ) )
|
|
{
|
|
deleteTraces( m_startItem, true );
|
|
}
|
|
else if( evt->IsAction( &COMMON_ACTIONS::removeAlt ) )
|
|
{
|
|
deleteTraces( m_startItem, false );
|
|
}
|
|
}
|
|
|
|
frame->SetToolID( ID_NO_TOOL_SELECTED, wxCURSOR_DEFAULT, wxEmptyString );
|
|
|
|
// Store routing settings till the next invocation
|
|
m_savedSettings = m_router->Settings();
|
|
m_savedSizes = m_router->Sizes();
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
void ROUTER_TOOL::performDragging()
|
|
{
|
|
VIEW_CONTROLS* ctls = getViewControls();
|
|
|
|
if( m_startItem && m_startItem->IsLocked() )
|
|
{
|
|
if( !IsOK( m_frame, _( "The item is locked. Do you want to continue?" ) ) )
|
|
return;
|
|
}
|
|
|
|
bool dragStarted = m_router->StartDragging( m_startSnapPoint, m_startItem );
|
|
|
|
if( !dragStarted )
|
|
return;
|
|
|
|
if( m_startItem && m_startItem->Net() >= 0 )
|
|
highlightNet( true, m_startItem->Net() );
|
|
|
|
ctls->SetAutoPan( true );
|
|
|
|
m_frame->UndoRedoBlock( true );
|
|
|
|
while( OPT_TOOL_EVENT evt = Wait() )
|
|
{
|
|
ctls->ForceCursorPosition( false );
|
|
|
|
if( evt->IsMotion() )
|
|
{
|
|
updateEndItem( *evt );
|
|
m_router->Move( m_endSnapPoint, m_endItem );
|
|
}
|
|
else if( evt->IsClick( BUT_LEFT ) )
|
|
{
|
|
if( m_router->FixRoute( m_endSnapPoint, m_endItem ) )
|
|
break;
|
|
}
|
|
else if( evt->IsCancel() || evt->IsActivate() || evt->IsUndoRedo() )
|
|
break;
|
|
|
|
handleCommonEvents( *evt );
|
|
}
|
|
|
|
if( m_router->RoutingInProgress() )
|
|
m_router->StopRouting();
|
|
|
|
m_startItem = NULL;
|
|
|
|
m_frame->UndoRedoBlock( false );
|
|
ctls->SetAutoPan( false );
|
|
ctls->ForceCursorPosition( false );
|
|
highlightNet( false );
|
|
}
|
|
|
|
|
|
int ROUTER_TOOL::InlineDrag( const TOOL_EVENT& aEvent )
|
|
{
|
|
const BOARD_CONNECTED_ITEM* item = aEvent.Parameter<const BOARD_CONNECTED_ITEM*>();
|
|
PCB_EDIT_FRAME* frame = getEditFrame<PCB_EDIT_FRAME>();
|
|
VIEW_CONTROLS* ctls = getViewControls();
|
|
|
|
m_toolMgr->RunAction( COMMON_ACTIONS::selectionClear, true );
|
|
|
|
Activate();
|
|
|
|
m_router->SyncWorld();
|
|
|
|
m_startItem = m_router->GetWorld()->FindItemByParent( item );
|
|
|
|
if( m_startItem && m_startItem->IsLocked() )
|
|
{
|
|
if( !IsOK( m_frame, _( "The item is locked. Do you want to continue?" ) ) )
|
|
return false;
|
|
}
|
|
|
|
VECTOR2I p0 = ctls->GetCursorPosition();
|
|
|
|
bool dragStarted = m_router->StartDragging( p0, m_startItem );
|
|
|
|
if( !dragStarted )
|
|
return 0;
|
|
|
|
ctls->ForceCursorPosition( false );
|
|
ctls->SetAutoPan( true );
|
|
frame->UndoRedoBlock( true );
|
|
|
|
while( OPT_TOOL_EVENT evt = Wait() )
|
|
{
|
|
|
|
if( evt->IsCancel() )
|
|
{
|
|
break;
|
|
}
|
|
else if( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) )
|
|
{
|
|
updateEndItem( *evt );
|
|
m_router->Move( m_endSnapPoint, m_endItem );
|
|
}
|
|
else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) )
|
|
{
|
|
updateEndItem( *evt );
|
|
m_router->FixRoute( m_endSnapPoint, m_endItem );
|
|
break;
|
|
}
|
|
}
|
|
|
|
if( m_router->RoutingInProgress() )
|
|
m_router->StopRouting();
|
|
|
|
ctls->SetAutoPan( false );
|
|
ctls->ShowCursor( false );
|
|
frame->UndoRedoBlock( false );
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
int ROUTER_TOOL::CustomTrackWidthDialog( const TOOL_EVENT& aEvent )
|
|
{
|
|
BOARD_DESIGN_SETTINGS& bds = m_board->GetDesignSettings();
|
|
DIALOG_TRACK_VIA_SIZE sizeDlg( m_frame, bds );
|
|
|
|
if( sizeDlg.ShowModal() )
|
|
{
|
|
bds.UseCustomTrackViaSize( true );
|
|
m_toolMgr->RunAction( COMMON_ACTIONS::trackViaSizeChanged );
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
int ROUTER_TOOL::onTrackViaSizeChanged( const TOOL_EVENT& aEvent )
|
|
{
|
|
PNS::SIZES_SETTINGS sizes( m_router->Sizes() );
|
|
sizes.ImportCurrent( m_board->GetDesignSettings() );
|
|
m_router->UpdateSizes( sizes );
|
|
|
|
return 0;
|
|
}
|