ROUTER_TOOL Class Reference

#include <router_tool.h>

Inheritance diagram for ROUTER_TOOL:

Public Types
enum	RESET_REASON { RUN, MODEL_RELOAD, GAL_SWITCH }
	Determine the reason of reset for a tool. More...

Public Member Functions
	ROUTER_TOOL ()
	~ROUTER_TOOL ()
bool	Init () override
	Init() is called once upon a registration of the tool. More...
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state. More...
int	MainLoop (const TOOL_EVENT &aEvent)
int	InlineBreakTrack (const TOOL_EVENT &aEvent)
bool	CanInlineDrag (int aDragMode)
int	InlineDrag (const TOOL_EVENT &aEvent)
int	SelectCopperLayerPair (const TOOL_EVENT &aEvent)
int	DpDimensionsDialog (const TOOL_EVENT &aEvent)
int	SettingsDialog (const TOOL_EVENT &aEvent)
int	ChangeRouterMode (const TOOL_EVENT &aEvent)
int	CycleRouterMode (const TOOL_EVENT &aEvent)
int	CustomTrackWidthDialog (const TOOL_EVENT &aEvent)
PNS::PNS_MODE	GetRouterMode ()
bool	RoutingInProgress ()
	Returns whether routing is currently active. More...
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events. More...
void	UpdateMessagePanel ()
ROUTER *	Router () const
void	SetIsFootprintEditor (bool aEnabled)
	Function SetIsFootprintEditor() More...
bool	IsFootprintEditor () const
virtual bool	Is45Limited () const
	Should the tool use its 45° mode option? More...
void	Activate ()
	Run the tool. More...
TOOL_MENU &	GetToolMenu ()
void	SetContextMenu (ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
	Assign a context menu and tells when it should be activated. More...
void	RunMainStack (std::function< void()> aFunc)
	Call a function using the main stack. More...
template<class T >
void	Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
	Define which state (aStateFunc) to go when a certain event arrives (aConditions). More...
TOOL_EVENT *	Wait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
	Suspend execution of the tool until an event specified in aEventList arrives. More...
TOOL_TYPE	GetType () const
	Return the type of the tool. More...
TOOL_ID	GetId () const
	Return the unique identifier of the tool. More...
const std::string &	GetName () const
	Return the name of the tool. More...
TOOL_MANAGER *	GetManager () const
	Return the instance of TOOL_MANAGER that takes care of the tool. More...
bool	IsToolActive () const

Static Public Member Functions
static void	NeighboringSegmentFilter (const VECTOR2I &aPt, GENERAL_COLLECTOR &aCollector)

Protected Types
enum	INTERACTIVE_PLACEMENT_OPTIONS { IPO_ROTATE = 0x01, IPO_FLIP = 0x02, IPO_SINGLE_CLICK = 0x04, IPO_REPEAT = 0x08 }
	Options for placing items interactively. More...

Protected Member Functions
bool	checkSnap (ITEM *aItem)
const VECTOR2I	snapToItem (ITEM *aSnapToItem, const VECTOR2I &aP)
virtual ITEM *	pickSingleItem (const VECTOR2I &aWhere, int aNet=-1, int aLayer=-1, bool aIgnorePads=false, const std::vector< ITEM * > aAvoidItems={})
virtual void	highlightNet (bool aEnabled, int aNetcode=-1)
virtual void	updateStartItem (const TOOL_EVENT &aEvent, bool aIgnorePads=false)
virtual void	updateEndItem (const TOOL_EVENT &aEvent)
void	doInteractiveItemPlacement (const std::string &aTool, 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_VIEW *	view () const
KIGFX::VIEW_CONTROLS *	controls () const
PCB_BASE_EDIT_FRAME *	frame () const
BOARD *	board () const
FOOTPRINT *	footprint () const
const PCB_DISPLAY_OPTIONS &	displayOptions () const
PCB_DRAW_PANEL_GAL *	canvas () const
const PCB_SELECTION &	selection () const
PCB_SELECTION &	selection ()
void	attachManager (TOOL_MANAGER *aManager)
	Set the TOOL_MANAGER the tool will belong to. More...
KIGFX::VIEW *	getView () const
	Returns the instance of #VIEW object used in the application. More...
KIGFX::VIEW_CONTROLS *	getViewControls () const
	Return the instance of VIEW_CONTROLS object used in the application. More...
template<typename T >
T *	getEditFrame () const
	Return the application window object, casted to requested user type. More...
template<typename T >
T *	getModel () const
	Return the model object if it matches the requested type. More...

Protected Attributes
SIZES_SETTINGS	m_savedSizes
ITEM *	m_startItem
VECTOR2I	m_startSnapPoint
bool	m_startHighlight
ITEM *	m_endItem
VECTOR2I	m_endSnapPoint
PCB_GRID_HELPER *	m_gridHelper
PNS_KICAD_IFACE *	m_iface
ROUTER *	m_router
bool	m_cancelled
bool	m_isFootprintEditor
TOOL_MENU	m_menu
	The functions below are not yet implemented - their interface may change. More...
TOOL_TYPE	m_type
	Unique identifier for the tool, assigned by a TOOL_MANAGER instance. More...
TOOL_ID	m_toolId
	Name of the tool. More...
std::string	m_toolName
TOOL_MANAGER *	m_toolMgr

Private Member Functions
void	performRouting ()
void	performDragging (int aMode=PNS::DM_ANY)
void	breakTrack ()
void	handleCommonEvents (TOOL_EVENT &evt)
int	handleLayerSwitch (const TOOL_EVENT &aEvent, bool aForceVia)
int	getStartLayer (const PNS::ITEM *aItem)
void	switchLayerOnViaPlacement ()
int	onLayerCommand (const TOOL_EVENT &aEvent)
int	onViaCommand (const TOOL_EVENT &aEvent)
int	onTrackViaSizeChanged (const TOOL_EVENT &aEvent)
bool	prepareInteractive ()
bool	finishInteractive ()
void	saveRouterDebugLog ()

Private Attributes
std::shared_ptr< ACTION_MENU >	m_diffPairMenu
std::shared_ptr< ACTION_MENU >	m_trackViaMenu
int	m_lastTargetLayer

Detailed Description

Definition at line 28 of file router_tool.h.

Member Enumeration Documentation

INTERACTIVE_PLACEMENT_OPTIONS

enum PCB_TOOL_BASE::INTERACTIVE_PLACEMENT_OPTIONS

protectedinherited

Options for placing items interactively.

Enumerator
IPO_ROTATE	Handle the rotate action in the loop by calling the item's rotate method.
IPO_FLIP	Handle flip action in the loop by calling the item's flip method.
IPO_SINGLE_CLICK	Create an item immediately on placement starting, otherwise show the pencil cursor until the item is created.
IPO_REPEAT	Allow repeat placement of the item.

Definition at line 116 of file pcb_tool_base.h.

 {
 IPO_ROTATE = 0x01,

 IPO_FLIP = 0x02,

 IPO_SINGLE_CLICK = 0x04,

 IPO_REPEAT = 0x08
 };

RESET_REASON

enum TOOL_BASE::RESET_REASON

inherited

Determine 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 77 of file tool_base.h.

 {
 RUN, 
 MODEL_RELOAD, 
 GAL_SWITCH 
 };

Constructor & Destructor Documentation

ROUTER_TOOL()

ROUTER_TOOL::ROUTER_TOOL

(

)

Definition at line 171 of file router_tool.cpp.

 :
 TOOL_BASE( "pcbnew.InteractiveRouter" ),
 m_lastTargetLayer( UNDEFINED_LAYER )
{
}

~ROUTER_TOOL()

ROUTER_TOOL::~ROUTER_TOOL

(

)

Definition at line 421 of file router_tool.cpp.

{
}

Member Function Documentation

Activate()

void TOOL_INTERACTIVE::Activate ( )

inherited

Run the tool.

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

Definition at line 51 of file tool_interactive.cpp.

{
 m_toolMgr->InvokeTool( m_toolId );
}

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

Referenced by AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::copyToClipboard(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridSetOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), InlineBreakTrack(), InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PCB_PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), EE_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), PICKER_TOOL::Main(), MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), LIB_TREE::onContextMenu(), PCB_POINT_EDITOR::OnSelectionChange(), GROUP_TOOL::PickNewMember(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), DRAWING_TOOL::SetAnchor(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER *  aManager )

protectedinherited

Set the TOOL_MANAGER the tool will belong to.

Called by TOOL_MANAGER::RegisterTool()

Definition at line 60 of file tool_base.cpp.

{
 m_toolMgr = aManager;
}

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

board()

BOARD* PCB_TOOL_BASE::board ( ) const

inlineprotectedinherited

Definition at line 165 of file pcb_tool_base.h.

{ return getModel<BOARD>(); }

Referenced by PCB_CONTROL::AppendBoard(), AUTOPLACE_TOOL::autoplace(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), EDIT_TOOL::ChangeTrackWidth(), ZONE_FILLER_TOOL::CheckAllZones(), BOARD_INSPECTION_TOOL::ClearHighlight(), EDIT_TOOL::copyToClipboard(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), MICROWAVE_TOOL::createInductorBetween(), CustomTrackWidthDialog(), PCB_CONTROL::DeleteItemCursor(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportNetlist(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::filterSelection(), PCB_TOOL_BASE::footprint(), PCB_SELECTION_TOOL::GetBoard(), PCB_SELECTION_TOOL::getCollectorsGuide(), GROUP_TOOL::Group(), handleLayerSwitch(), BOARD_INSPECTION_TOOL::highlightNet(), InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_CONTROL::LayerNext(), PCB_CONTROL::LayerPrev(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EDIT_TOOL::MoveExact(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PAD_TOOL::PlacePad(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::recombinePad(), BOARD_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_CONTROL::RepairFootprint(), PNS::TOOL_BASE::Reset(), PCB_CONTROL::Reset(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectAllItemsOnNet(), PCB_SELECTION_TOOL::selectAllItemsOnSheet(), PCB_SELECTION_TOOL::selectConnectedTracks(), PCB_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectPoint(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::unfilledZoneCheck(), GROUP_TOOL::Ungroup(), UpdateMessagePanel(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), BOARD_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

breakTrack()

void ROUTER_TOOL::breakTrack ( )

private

Definition at line 1342 of file router_tool.cpp.

{
 if( m_startItem && m_startItem->OfKind( PNS::ITEM::SEGMENT_T ) )
 m_router->BreakSegment( m_startItem, m_startSnapPoint );
}

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 InlineBreakTrack(), and MainLoop().

CanInlineDrag()

bool ROUTER_TOOL::CanInlineDrag

(

int

aDragMode

)

Definition at line 1649 of file router_tool.cpp.

{
 m_toolMgr->RunAction( PCB_ACTIONS::selectionCursor, true, NeighboringSegmentFilter );
 const PCB_SELECTION& selection = m_toolMgr->GetTool<PCB_SELECTION_TOOL>()->GetSelection();

 if( selection.Size() == 1 )
 {
 const BOARD_ITEM* item = static_cast<const BOARD_ITEM*>( selection.Front() );

 // Note: EDIT_TOOL::Drag temporarily handles items of type PCB_ARC_T on its own using
 // DragArcTrack(), so PCB_ARC_T should never occur here.
 if( item->IsType( GENERAL_COLLECTOR::DraggableItems ) )
 {
 static const KICAD_T footprints[] = { PCB_FOOTPRINT_T, EOT };

 // Footprints cannot be dragged freely.
 if( item->IsType( footprints ) )
 return !( aDragMode & PNS::DM_FREE_ANGLE );
 else
 return true;
 }
 }

 return false;
}

References PNS::DM_FREE_ANGLE, GENERAL_COLLECTOR::DraggableItems, EOT, SELECTION::Front(), TOOL_MANAGER::GetTool(), EDA_ITEM::IsType(), TOOL_BASE::m_toolMgr, NeighboringSegmentFilter(), PCB_FOOTPRINT_T, TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionCursor, and SELECTION::Size().

canvas()

PCB_DRAW_PANEL_GAL * PCB_TOOL_BASE::canvas ( ) const

protectedinherited

Definition at line 301 of file pcb_tool_base.cpp.

{
 return static_cast<PCB_DRAW_PANEL_GAL*>( frame()->GetCanvas() );
}

References PCB_TOOL_BASE::frame().

Referenced by ZONE_FILLER_TOOL::CheckAllZones(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), ZONE_FILLER_TOOL::FillAllZones(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), ZONE_FILLER_TOOL::singleShotRefocus(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

ChangeRouterMode()

int ROUTER_TOOL::ChangeRouterMode

(

const TOOL_EVENT &

aEvent

)

Definition at line 1301 of file router_tool.cpp.

{
 PNS::PNS_MODE mode = aEvent.Parameter<PNS::PNS_MODE>();
 PNS::ROUTING_SETTINGS& settings = m_router->Settings();

 settings.SetMode( mode );

 return 0;
}

References PNS::TOOL_BASE::m_router, TOOL_EVENT::Parameter(), PNS::ROUTING_SETTINGS::SetMode(), and PNS::ROUTER::Settings().

Referenced by setTransitions().

checkSnap()

bool TOOL_BASE::checkSnap ( ITEM *  aItem )

protectedinherited

Definition at line 243 of file pns_tool_base.cpp.

{
 // Sync PNS engine settings with the general PCB editor options.
 auto& pnss = m_router->Settings();

 // If we're dragging a track segment, don't try to snap to items on the same copper layer.
 // This way we avoid 'flickery' behaviour for short segments when the snap algo is trying to
 // snap to the corners of the segments next to the one being dragged.
 if( m_startItem && aItem && m_router->GetState() == ROUTER::DRAG_SEGMENT
 && aItem->Layer() == m_startItem->Layer() && aItem->OfKind( ITEM::SEGMENT_T )
 && m_startItem->OfKind( ITEM::SEGMENT_T ) )
 return false;

 pnss.SetSnapToPads(
 frame()->GetMagneticItemsSettings()->pads == MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ||
 frame()->GetMagneticItemsSettings()->pads == MAGNETIC_OPTIONS::CAPTURE_ALWAYS );

 pnss.SetSnapToTracks(
 frame()->GetMagneticItemsSettings()->tracks == MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL
 || frame()->GetMagneticItemsSettings()->tracks == MAGNETIC_OPTIONS::CAPTURE_ALWAYS );

 if( aItem )
 {
 if( aItem->OfKind( ITEM::VIA_T | ITEM::SEGMENT_T | ITEM::ARC_T ) )
 return pnss.GetSnapToTracks();
 else if( aItem->OfKind( ITEM::SOLID_T ) )
 return pnss.GetSnapToPads();
 }

 return false;
}

References PNS::ITEM::ARC_T, CAPTURE_ALWAYS, CAPTURE_CURSOR_IN_TRACK_TOOL, PNS::ROUTER::DRAG_SEGMENT, PCB_TOOL_BASE::frame(), PNS::ROUTER::GetState(), PNS::ITEM::Layer(), PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, PNS::ITEM::OfKind(), PNS::ITEM::SEGMENT_T, PNS::ROUTING_SETTINGS::SetSnapToPads(), PNS::ROUTER::Settings(), PNS::ITEM::SOLID_T, and PNS::ITEM::VIA_T.

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

controls()

KIGFX::VIEW_CONTROLS* PCB_TOOL_BASE::controls ( ) const

inlineprotectedinherited

Definition at line 155 of file pcb_tool_base.h.

 {
 return getViewControls();
 }

References TOOL_BASE::getViewControls().

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawZone(), finishInteractive(), handleLayerSwitch(), InlineBreakTrack(), InlineDrag(), PCB_PICKER_TOOL::Main(), MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), performRouting(), LENGTH_TUNER_TOOL::performTuning(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BOARD_EDITOR_CONTROL::PlaceTarget(), prepareInteractive(), PCB_PICKER_TOOL::setControls(), PCB_POINT_EDITOR::setEditedPoint(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

CustomTrackWidthDialog()

int ROUTER_TOOL::CustomTrackWidthDialog

(

const TOOL_EVENT &

aEvent

)

Definition at line 2037 of file router_tool.cpp.

{
 BOARD_DESIGN_SETTINGS& bds = board()->GetDesignSettings();
 DIALOG_TRACK_VIA_SIZE sizeDlg( frame(), bds );

 if( sizeDlg.ShowModal() == wxID_OK )
 {
 bds.m_TempOverrideTrackWidth = true;
 bds.UseCustomTrackViaSize( true );

 TOOL_EVENT dummy;
 onTrackViaSizeChanged( dummy );
 }

 return 0;
}

References PCB_TOOL_BASE::board(), dummy(), PCB_TOOL_BASE::frame(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::m_TempOverrideTrackWidth, onTrackViaSizeChanged(), and BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize().

Referenced by setTransitions().

CycleRouterMode()

int ROUTER_TOOL::CycleRouterMode

(

const TOOL_EVENT &

aEvent

)

Definition at line 1312 of file router_tool.cpp.

{
 PNS::ROUTING_SETTINGS& settings = m_router->Settings();
 PNS::PNS_MODE mode = settings.Mode();

 switch( mode )
 {
 case PNS::RM_MarkObstacles: mode = PNS::RM_Shove; break;
 case PNS::RM_Shove: mode = PNS::RM_Walkaround; break;
 case PNS::RM_Walkaround: mode = PNS::RM_MarkObstacles; break;
 }

 settings.SetMode( mode );

 return 0;
}

References PNS::TOOL_BASE::m_router, PNS::ROUTING_SETTINGS::Mode(), PNS::RM_MarkObstacles, PNS::RM_Shove, PNS::RM_Walkaround, PNS::ROUTING_SETTINGS::SetMode(), and PNS::ROUTER::Settings().

Referenced by setTransitions().

displayOptions()

const PCB_DISPLAY_OPTIONS & PCB_TOOL_BASE::displayOptions ( ) const

protectedinherited

Definition at line 296 of file pcb_tool_base.cpp.

{
 return frame()->GetDisplayOptions();
}

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

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), PCB_CONTROL::HighContrastMode(), PCB_CONTROL::HighContrastModeCycle(), InlineDrag(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PCB_CONTROL::NetColorModeCycle(), PNS::TOOL_BASE::pickSingleItem(), PCB_CONTROL::RatsnestModeCycle(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::ViaDisplayMode(), and PCB_CONTROL::ZoneDisplayMode().

doInteractiveItemPlacement()

void PCB_TOOL_BASE::doInteractiveItemPlacement ( const std::string &  aTool, 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

aItemCreator	the callable that will attempt to create the item
aCommitMessage	the message used on a successful commit

Definition at line 37 of file pcb_tool_base.cpp.

{
 using namespace std::placeholders;
 std::unique_ptr<BOARD_ITEM> newItem;

 frame()->PushTool( aTool );

 BOARD_COMMIT commit( frame() );

 GetManager()->RunAction( PCB_ACTIONS::selectionClear, true );

 Activate();
 // Must be done after Activate() so that it gets set into the correct context
 controls()->ShowCursor( true );
 // do not capture or auto-pan until we start placing an item

 PCB_GRID_HELPER grid( m_toolMgr, frame()->GetMagneticItemsSettings() );

 // Add a VIEW_GROUP that serves as a preview for the new item
 PCB_SELECTION preview;
 view()->Add( &preview );

 aPlacer->m_board = board();
 aPlacer->m_frame = frame();
 aPlacer->m_modifiers = 0;

 auto makeNewItem =
 [&]( VECTOR2I aPosition )
 {
 if( frame()->GetModel() )
 newItem = aPlacer->CreateItem();

 if( newItem )
 {
 newItem->SetPosition( (wxPoint) aPosition );
 preview.Add( newItem.get() );

 if( newItem->Type() == PCB_FOOTPRINT_T )
 {
 FOOTPRINT* fp = dyn_cast<FOOTPRINT*>( newItem.get() );

 // footprints have more drawable parts
 fp->RunOnChildren( std::bind( &KIGFX::VIEW_GROUP::Add, &preview, _1 ) );
 }
 }
 };

 if( aOptions & IPO_SINGLE_CLICK )
 makeNewItem( controls()->GetCursorPosition() );

 auto setCursor =
 [&]()
 {
 if( !newItem )
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
 else
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::PLACE );
 };

 // Set initial cursor
 setCursor();

 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 setCursor();

 grid.SetSnap( false ); // Interactive placement tools need to set their own item snaps
 grid.SetUseGrid( getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
 VECTOR2I cursorPos = grid.BestSnapAnchor( controls()->GetMousePosition(), nullptr );

 aPlacer->m_modifiers = evt->Modifier();

 auto cleanup =
 [&] ()
 {
 newItem = nullptr;
 preview.Clear();
 view()->Update( &preview );
 controls()->SetAutoPan( false );
 controls()->CaptureCursor( false );
 controls()->ShowCursor( true );
 };

 if( evt->IsCancelInteractive() )
 {
 if( aOptions & IPO_SINGLE_CLICK )
 {
 cleanup();
 frame()->PopTool( aTool );
 break;
 }
 else if( newItem )
 {
 cleanup();
 }
 else
 {
 frame()->PopTool( aTool );
 break;
 }
 }
 else if( evt->IsActivate() )
 {
 if( newItem )
 cleanup();

 if( evt->IsPointEditor() )
 {
 // don't exit (the point editor runs in the background)
 }
 else if( evt->IsMoveTool() )
 {
 // leave ourselves on the stack so we come back after the move
 break;
 }
 else
 {
 frame()->PopTool( aTool );
 break;
 }
 }
 else if( evt->IsClick( BUT_LEFT ) || evt->IsDblClick( BUT_LEFT ) )
 {
 if( !newItem )
 {
 // create the item if possible
 makeNewItem( cursorPos );

 // no item created, so wait for another click
 if( !newItem )
 continue;

 controls()->CaptureCursor( true );
 controls()->SetAutoPan( true );
 }
 else
 {
 auto oldFlags = newItem->GetFlags();
 newItem->ClearFlags();

 if( !aPlacer->PlaceItem( newItem.get(), commit ) )
 {
 newItem->SetFlags( oldFlags );
 continue;
 }

 preview.Clear();
 newItem.release();
 commit.Push( aCommitMessage );

 controls()->CaptureCursor( false );
 controls()->SetAutoPan( false );
 controls()->ShowCursor( true );

 if( !( aOptions & IPO_REPEAT ) )
 break;

 if( aOptions & IPO_SINGLE_CLICK )
 makeNewItem( controls()->GetCursorPosition() );

 setCursor();
 }
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else if( evt->IsAction( &PCB_ACTIONS::trackViaSizeChanged ) )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else if( newItem && evt->Category() == TC_COMMAND )
 {
 /*
 * Handle any events that can affect the item as we move it around
 */
 if( TOOL_EVT_UTILS::IsRotateToolEvt( *evt ) && ( aOptions & IPO_ROTATE ) )
 {
 const int rotationAngle = TOOL_EVT_UTILS::GetEventRotationAngle( *frame(), *evt );
 newItem->Rotate( newItem->GetPosition(), rotationAngle );
 view()->Update( &preview );
 }
 else if( evt->IsAction( &PCB_ACTIONS::flip ) && ( aOptions & IPO_FLIP ) )
 {
 newItem->Flip( newItem->GetPosition(), frame()->Settings().m_FlipLeftRight );
 view()->Update( &preview );
 }
 else if( evt->IsAction( &PCB_ACTIONS::properties ) )
 {
 frame()->OnEditItemRequest( newItem.get() );

 // Notify other tools of the changes
 m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 }
 else if( evt->IsAction( &ACTIONS::refreshPreview ) )
 {
 preview.Clear();
 newItem.release();

 makeNewItem( (wxPoint) cursorPos );
 aPlacer->SnapItem( newItem.get() );
 view()->Update( &preview );
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 else if( newItem && evt->IsMotion() )
 {
 // track the cursor
 newItem->SetPosition( (wxPoint) cursorPos );
 aPlacer->SnapItem( newItem.get() );

 // Show a preview of the item
 view()->Update( &preview );
 }
 else
 {
 evt->SetPassEvent();
 }
 }

 view()->Remove( &preview );
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 controls()->SetAutoPan( false );
 controls()->CaptureCursor( false );
}

References TOOL_INTERACTIVE::Activate(), KIGFX::PCB_VIEW::Add(), KIGFX::VIEW_GROUP::Add(), SELECTION::Add(), ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), PCB_TOOL_BASE::controls(), INTERACTIVE_PLACER_BASE::CreateItem(), PCB_ACTIONS::flip, PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), TOOL_EVT_UTILS::GetEventRotationAngle(), TOOL_BASE::GetManager(), PCB_BASE_FRAME::GetModel(), TOOL_BASE::getView(), grid, PCB_TOOL_BASE::IPO_FLIP, PCB_TOOL_BASE::IPO_REPEAT, PCB_TOOL_BASE::IPO_ROTATE, PCB_TOOL_BASE::IPO_SINGLE_CLICK, TOOL_EVT_UTILS::IsRotateToolEvt(), INTERACTIVE_PLACER_BASE::m_board, PCBNEW_SETTINGS::m_FlipLeftRight, INTERACTIVE_PLACER_BASE::m_frame, TOOL_INTERACTIVE::m_menu, INTERACTIVE_PLACER_BASE::m_modifiers, TOOL_BASE::m_toolMgr, PCB_BASE_EDIT_FRAME::OnEditItemRequest(), PCB_FOOTPRINT_T, PENCIL, PLACE, INTERACTIVE_PLACER_BASE::PlaceItem(), TOOLS_HOLDER::PopTool(), TOOL_MANAGER::ProcessEvent(), PCB_ACTIONS::properties, BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), ACTIONS::refreshPreview, KIGFX::PCB_VIEW::Remove(), TOOL_MANAGER::RunAction(), FOOTPRINT::RunOnChildren(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), PCB_BASE_FRAME::Settings(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), INTERACTIVE_PLACER_BASE::SnapItem(), TC_COMMAND, PCB_ACTIONS::trackViaSizeChanged, KIGFX::PCB_VIEW::Update(), PCB_TOOL_BASE::view(), and TOOL_INTERACTIVE::Wait().

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

DpDimensionsDialog()

int ROUTER_TOOL::DpDimensionsDialog

(

const TOOL_EVENT &

aEvent

)

Definition at line 1269 of file router_tool.cpp.

{
 PNS::SIZES_SETTINGS sizes = m_router->Sizes();
 DIALOG_PNS_DIFF_PAIR_DIMENSIONS settingsDlg( frame(), sizes );

 if( settingsDlg.ShowModal() == wxID_OK )
 {
 m_router->UpdateSizes( sizes );
 m_savedSizes = sizes;

 BOARD_DESIGN_SETTINGS& bds = frame()->GetBoard()->GetDesignSettings();
 bds.SetCustomDiffPairWidth( sizes.DiffPairWidth() );
 bds.SetCustomDiffPairGap( sizes.DiffPairGap() );
 bds.SetCustomDiffPairViaGap( sizes.DiffPairViaGap() );
 }

 return 0;
}

References PNS::SIZES_SETTINGS::DiffPairGap(), PNS::SIZES_SETTINGS::DiffPairViaGap(), PNS::SIZES_SETTINGS::DiffPairWidth(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetBoard(), BOARD::GetDesignSettings(), PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_savedSizes, BOARD_DESIGN_SETTINGS::SetCustomDiffPairGap(), BOARD_DESIGN_SETTINGS::SetCustomDiffPairViaGap(), BOARD_DESIGN_SETTINGS::SetCustomDiffPairWidth(), PNS::ROUTER::Sizes(), and PNS::ROUTER::UpdateSizes().

Referenced by setTransitions().

finishInteractive()

bool ROUTER_TOOL::finishInteractive ( )

private

Definition at line 1121 of file router_tool.cpp.

{
 m_router->StopRouting();

 m_startItem = nullptr;
 m_endItem = nullptr;

 UpdateMessagePanel();
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 controls()->SetAutoPan( false );
 controls()->ForceCursorPosition( false );
 frame()->UndoRedoBlock( false );
 highlightNet( false );

 return true;
}

References ARROW, PCB_TOOL_BASE::controls(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), PNS::TOOL_BASE::highlightNet(), PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), PNS::ROUTER::StopRouting(), PCB_BASE_EDIT_FRAME::UndoRedoBlock(), and UpdateMessagePanel().

Referenced by performRouting().

footprint()

FOOTPRINT* PCB_TOOL_BASE::footprint ( ) const

inlineprotectedinherited

Definition at line 167 of file pcb_tool_base.h.

 {
 return board()->GetFirstFootprint();
 }

References PCB_TOOL_BASE::board(), and BOARD::GetFirstFootprint().

Referenced by PCB_CONTROL::AppendBoard(), MICROWAVE_TOOL::createBaseFootprint(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawVia(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), BOARD_EDITOR_CONTROL::ExportNetlist(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), PCB_SELECTION_TOOL::hitTestDistance(), InlineDrag(), BOARD_INSPECTION_TOOL::InspectConstraints(), PCB_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::Properties(), PAD_TOOL::pushPadSettings(), BOARD_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_CONTROL::RepairFootprint(), BOARD_INSPECTION_TOOL::reportClearance(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectAllItemsOnSheet(), PCB_SELECTION_TOOL::selectSameSheet(), DRAWING_TOOL::SetAnchor(), and PCB_CONTROL::UpdateMessagePanel().

frame()

PCB_BASE_EDIT_FRAME* PCB_TOOL_BASE::frame ( ) const

inlineprotectedinherited

Definition at line 160 of file pcb_tool_base.h.

 {
 return getEditFrame<PCB_BASE_EDIT_FRAME>();
 }

Referenced by PCB_POINT_EDITOR::addCorner(), AUTOPLACE_TOOL::autoplace(), PCB_TOOL_BASE::canvas(), ZONE_FILLER_TOOL::CheckAllZones(), PNS::TOOL_BASE::checkSnap(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), BOARD_INSPECTION_TOOL::CrossProbePcbToSch(), CustomTrackWidthDialog(), FOOTPRINT_EDITOR_CONTROL::DeleteFootprint(), PCB_TOOL_BASE::displayOptions(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DpDimensionsDialog(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), finishInteractive(), EDIT_TOOL::Flip(), PCB_CONTROL::FlipPcbView(), GLOBAL_EDIT_TOOL::GlobalDeletions(), handleLayerSwitch(), BOARD_INSPECTION_TOOL::HighlightItem(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), Init(), SCRIPTING_TOOL::Init(), PCB_SELECTION_TOOL::Init(), EDIT_TOOL::Init(), InlineBreakTrack(), InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_TOOL_BASE::Is45Limited(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::meanderSettingsDialog(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), performDragging(), performRouting(), LENGTH_TUNER_TOOL::performTuning(), GROUP_TOOL::PickNewMember(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), prepareInteractive(), PAD_TOOL::pushPadSettings(), PAD_TOOL::recombinePad(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SCRIPTING_TOOL::reloadPlugins(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), PCB_SELECTION_TOOL::RequestSelection(), PAD_TOOL::Reset(), PNS::TOOL_BASE::Reset(), EDIT_TOOL::Rotate(), SelectCopperLayerPair(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), PCB_POINT_EDITOR::setEditedPoint(), SettingsDialog(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), switchLayerOnViaPlacement(), PCB_CONTROL::unfilledZoneCheck(), UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), ZONE_FILLER_TOOL::ZoneFill(), and ZONE_FILLER_TOOL::ZoneFillAll().

getEditFrame()

template<typename T >

T* TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 184 of file tool_base.h.

 {
#if !defined( QA_TEST ) // Dynamic casts give the linker a seizure in the test framework
 wxASSERT( dynamic_cast<T*>( getToolHolderInt() ) );
#endif
 return static_cast<T*>( getToolHolderInt() );
 }

References TOOL_BASE::getToolHolderInt().

Referenced by ZONE_CREATE_HELPER::createNewZone().

GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Return the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns

Identifier of the tool.

Definition at line 120 of file tool_base.h.

 {
 return m_toolId;
 }

References TOOL_BASE::m_toolId.

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

GetManager()

TOOL_MANAGER* TOOL_BASE::GetManager ( ) const

inlineinherited

Return the instance of TOOL_MANAGER that takes care of the tool.

Returns

Instance of the TOOL_MANAGER or NULL if there is no associated tool manager.

Definition at line 143 of file tool_base.h.

 {
 return m_toolMgr;
 }

References TOOL_BASE::m_toolMgr.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), PCB_TOOL_BASE::doInteractiveItemPlacement(), ACTION_MENU::getToolManager(), LIB_TREE::onContextMenu(), ZONE_CREATE_HELPER::OnFirstPoint(), ACTION_MENU::OnMenuEvent(), and ZONE_CREATE_HELPER::performZoneCutout().

getModel()

template<typename T >

T* TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Store the type of the tool.

Definition at line 196 of file tool_base.h.

References TOOL_BASE::getModelInt().

Referenced by ZONE_CREATE_HELPER::commitZone(), and ZONE_CREATE_HELPER::createZoneFromExisting().

GetName()

const std::string& TOOL_BASE::GetName ( void  ) const

inlineinherited

Return 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.

 {
 return m_toolName;
 }

References TOOL_BASE::m_toolName.

Referenced by TOOL_MANAGER::dispatchInternal(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::invokeTool(), TOOL_MANAGER::RegisterTool(), and TOOL_MANAGER::runTool().

GetRouterMode()

PNS::PNS_MODE ROUTER_TOOL::GetRouterMode

(

)

Definition at line 1330 of file router_tool.cpp.

{
 return m_router->Settings().Mode();
}

References PNS::TOOL_BASE::m_router, PNS::ROUTING_SETTINGS::Mode(), and PNS::ROUTER::Settings().

Referenced by PCB_EDIT_FRAME::setupUIConditions().

getStartLayer()

int ROUTER_TOOL::getStartLayer ( const PNS::ITEM *  aItem )

private

Definition at line 583 of file router_tool.cpp.

{
 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;
}

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().

GetToolMenu()

TOOL_MENU& TOOL_INTERACTIVE::GetToolMenu ( )

inlineinherited

Definition at line 77 of file tool_interactive.h.

{ return m_menu; }

References TOOL_INTERACTIVE::m_menu.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), SCH_EDIT_TOOL::Init(), EE_INSPECTION_TOOL::Init(), PAD_TOOL::Init(), GROUP_TOOL::Init(), CONVERT_TOOL::Init(), EE_POINT_EDITOR::Init(), BOARD_INSPECTION_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), PCB_POINT_EDITOR::Init(), SCH_MOVE_TOOL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), and LIB_TREE::onContextMenu().

GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns

The type of the tool.

Definition at line 108 of file tool_base.h.

 {
 return m_type;
 }

References TOOL_BASE::m_type.

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

getView()

KIGFX::VIEW * TOOL_BASE::getView ( ) const

protectedinherited

Returns the instance of #VIEW object used in the application.

It allows tools to draw.

Returns

The instance of VIEW.

Definition at line 36 of file tool_base.cpp.

{
 return m_toolMgr->GetView();
}

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

Referenced by EE_POINT_EDITOR::addCornerCondition(), ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), COMMON_TOOLS::CenterContents(), SCH_EDIT_TOOL::ChangeTextType(), EE_INSPECTION_TOOL::CheckSymbol(), GERBVIEW_CONTROL::ClearAllLayers(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::CollectHits(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), COMMON_TOOLS::CursorControl(), PL_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), EE_SELECTION_TOOL::GetNode(), getStartLayer(), PCB_CONTROL::GridResetOrigin(), PCB_CONTROL::GridSetOrigin(), handleCommonEvents(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), PNS::TOOL_BASE::highlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), InlineDrag(), PCB_PICKER_TOOL::Main(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), BOARD_EDITOR_CONTROL::PlaceTarget(), prepareInteractive(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), EDIT_TOOL::Remove(), BOARD_EDITOR_CONTROL::Reset(), PNS::TOOL_BASE::Reset(), PCB_CONTROL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), DRAWING_TOOL::Reset(), EE_SELECTION_TOOL::Reset(), PCB_SELECTION_TOOL::Reset(), EE_TOOL_BASE< SCH_BASE_FRAME >::Reset(), SCH_EDIT_TOOL::Rotate(), GERBVIEW_SELECTION_TOOL::select(), GERBVIEW_SELECTION_TOOL::selectable(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::SelectAll(), PL_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), GERBVIEW_SELECTION_TOOL::unselectVisually(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), SCH_EDITOR_CONTROL::UpdateFind(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), PCB_SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_VIEWER_TOOLS::view(), PCB_TOOL_BASE::view(), PCB_SELECTION_TOOL::zoomFitSelection(), EE_SELECTION_TOOL::~EE_SELECTION_TOOL(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), and PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL().

getViewControls()

KIGFX::VIEW_CONTROLS * TOOL_BASE::getViewControls ( ) const

protectedinherited

Return 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 42 of file tool_base.cpp.

{
 return m_toolMgr->GetViewControls();
}

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

Referenced by EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), SCH_EDITOR_CONTROL::AssignNetclass(), SCH_EDIT_TOOL::BreakWire(), PCB_TOOL_BASE::controls(), EDIT_TOOL::copyToClipboard(), SCH_DRAWING_TOOLS::createSheetPin(), COMMON_TOOLS::CursorControl(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EDIT_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_DRAWING_TOOLS::GetCanvasFreeAreaPixels(), BOARD_INSPECTION_TOOL::HighlightNet(), SCH_EDITOR_CONTROL::HighlightNet(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), PCB_PICKER_TOOL::Main(), EE_POINT_EDITOR::Main(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), performDragging(), LENGTH_TUNER_TOOL::performTuning(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), EDIT_TOOL::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), PL_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), PCB_POINT_EDITOR::Reset(), DRAWING_TOOL::Reset(), COMMON_TOOLS::ResetLocalCoords(), GERBVIEW_SELECTION_TOOL::selectCursor(), PCB_SELECTION_TOOL::selectCursor(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectNode(), ZOOM_TOOL::selectRegion(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PCB_PICKER_TOOL::setControls(), PICKER_TOOL::setControls(), PL_POINT_EDITOR::setEditedPoint(), EE_POINT_EDITOR::setEditedPoint(), PCB_POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateItem(), PL_EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

Go()

template<class T >

void TOOL_INTERACTIVE::Go ( int(T::*)(const TOOL_EVENT &)  aStateFunc, const TOOL_EVENT_LIST &  aConditions = TOOL_EVENT( TC_ANY, TA_ANY )  )

inherited

Define which state (aStateFunc) to go when a certain event arrives (aConditions).

No conditions means any event.

Definition at line 147 of file tool_interactive.h.

{
 TOOL_STATE_FUNC sptr = std::bind( aStateFunc, static_cast<T*>( this ), std::placeholders::_1 );

 goInternal( sptr, aConditions );
}

References TOOL_INTERACTIVE::goInternal().

Referenced by AUTOPLACE_TOOL::setTransitions(), ZOOM_TOOL::setTransitions(), LENGTH_TUNER_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), PCB_PICKER_TOOL::setTransitions(), SCH_NAVIGATE_TOOL::setTransitions(), SYMBOL_EDITOR_PIN_TOOL::setTransitions(), SYMBOL_EDITOR_MOVE_TOOL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), EE_POINT_EDITOR::setTransitions(), PL_POINT_EDITOR::setTransitions(), setTransitions(), SCRIPTING_TOOL::setTransitions(), COMMON_CONTROL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), CONVERT_TOOL::setTransitions(), SYMBOL_EDITOR_DRAWING_TOOLS::setTransitions(), ZONE_FILLER_TOOL::setTransitions(), PCB_VIEWER_TOOLS::setTransitions(), MICROWAVE_TOOL::setTransitions(), EE_INSPECTION_TOOL::setTransitions(), PCB_POINT_EDITOR::setTransitions(), GERBVIEW_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), PAD_TOOL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), GROUP_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), SYMBOL_EDITOR_CONTROL::setTransitions(), SYMBOL_EDITOR_EDIT_TOOL::setTransitions(), PL_EDIT_TOOL::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), SCH_MOVE_TOOL::setTransitions(), SCH_DRAWING_TOOLS::setTransitions(), SCH_EDIT_TOOL::setTransitions(), FOOTPRINT_EDITOR_CONTROL::setTransitions(), ALIGN_DISTRIBUTE_TOOL::setTransitions(), COMMON_TOOLS::setTransitions(), DRC_TOOL::setTransitions(), EDA_3D_CONTROLLER::setTransitions(), PCB_CONTROL::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), PICKER_TOOL::setTransitions(), EDIT_TOOL::setTransitions(), PCB_SELECTION_TOOL::setTransitions(), PL_SELECTION_TOOL::setTransitions(), DRAWING_TOOL::setTransitions(), SCH_EDITOR_CONTROL::setTransitions(), and EE_SELECTION_TOOL::setTransitions().

handleCommonEvents()

void ROUTER_TOOL::handleCommonEvents ( TOOL_EVENT &  evt )

private

Definition at line 557 of file router_tool.cpp.

{
 if( aEvent.Category() == TC_VIEW || aEvent.Category() == TC_MOUSE )
 {
 BOX2D viewAreaD = getView()->GetGAL()->GetVisibleWorldExtents();
 m_router->SetVisibleViewArea( BOX2I( viewAreaD.GetOrigin(), viewAreaD.GetSize() ) );
 }

 if( !aEvent.IsKeyPressed() )
 return;

 switch( aEvent.KeyCode() )
 {
 case '0':
 if( !ADVANCED_CFG::GetCfg().m_ShowRouterDebugGraphics )
 return;

 saveRouterDebugLog();
 aEvent.SetPassEvent( false );
 break;
 default:
 break;
 }
}

References TOOL_EVENT::Category(), ADVANCED_CFG::GetCfg(), KIGFX::VIEW::GetGAL(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetSize(), TOOL_BASE::getView(), KIGFX::GAL::GetVisibleWorldExtents(), TOOL_EVENT::IsKeyPressed(), TOOL_EVENT::KeyCode(), PNS::TOOL_BASE::m_router, ADVANCED_CFG::m_ShowRouterDebugGraphics, saveRouterDebugLog(), TOOL_EVENT::SetPassEvent(), PNS::ROUTER::SetVisibleViewArea(), TC_MOUSE, and TC_VIEW.

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

handleLayerSwitch()

int ROUTER_TOOL::handleLayerSwitch ( const TOOL_EVENT &  aEvent, bool  aForceVia  )

private

Definition at line 721 of file router_tool.cpp.

{
 wxCHECK( m_router, 0 );

 if( !IsToolActive() )
 return 0;

 // First see if this is one of the switch layer commands
 LSEQ layers = LSET( board()->GetEnabledLayers() & LSET::AllCuMask() ).Seq();
 PCB_LAYER_ID currentLayer = (PCB_LAYER_ID) m_router->GetCurrentLayer();
 PCB_LAYER_ID targetLayer = UNDEFINED_LAYER;

 if( aEvent.IsAction( &PCB_ACTIONS::layerNext ) )
 {
 if( m_lastTargetLayer == UNDEFINED_LAYER )
 m_lastTargetLayer = currentLayer;

 size_t idx = 0;

 for( size_t i = 0; i < layers.size(); i++ )
 {
 if( layers[i] == m_lastTargetLayer )
 {
 idx = i;
 break;
 }
 }

 idx = ( idx + 1 ) % layers.size();
 targetLayer = layers[idx];
 }
 else if( aEvent.IsAction( &PCB_ACTIONS::layerPrev ) )
 {
 if( m_lastTargetLayer == UNDEFINED_LAYER )
 m_lastTargetLayer = currentLayer;

 size_t idx = 0;

 for( size_t i = 0; i < layers.size(); i++ )
  {
 if( layers[i] == m_lastTargetLayer )
 {
 idx = i;
 break;
 }
 }

 idx = ( idx > 0 ) ? ( idx - 1 ) : ( layers.size() - 1 );
 targetLayer = layers[idx];
 }
 else
 {
 targetLayer = getTargetLayerFromEvent( aEvent );
 }

 if( targetLayer != UNDEFINED_LAYER )
 {
 m_lastTargetLayer = targetLayer;

 if( targetLayer == currentLayer )
 return 0;

 if( !aForceVia && m_router && m_router->SwitchLayer( targetLayer ) )
 {
 updateEndItem( aEvent );
 m_router->Move( m_endSnapPoint, m_endItem ); // refresh
 return 0;
 }
 }

 BOARD_DESIGN_SETTINGS& bds = board()->GetDesignSettings();
 const int layerCount = bds.GetCopperLayerCount();

 PCB_LAYER_ID pairTop = frame()->GetScreen()->m_Route_Layer_TOP;
 PCB_LAYER_ID pairBottom = frame()->GetScreen()->m_Route_Layer_BOTTOM;

 PNS::SIZES_SETTINGS sizes = m_router->Sizes();

 VIATYPE viaType = VIATYPE::THROUGH;
 bool selectLayer = false;

 // Otherwise it is one of the router-specific via commands
 if( targetLayer == UNDEFINED_LAYER )
 {
 const int actViaFlags = aEvent.Parameter<intptr_t>();
 selectLayer = actViaFlags & VIA_ACTION_FLAGS::SELECT_LAYER;

 viaType = getViaTypeFromFlags( actViaFlags );

 // ask the user for a target layer
 if( selectLayer )
 {
 wxPoint endPoint = (wxPoint) view()->ToScreen( m_endSnapPoint );
 endPoint = frame()->GetCanvas()->ClientToScreen( endPoint );

 // Build the list of not allowed layer for the target layer
 LSET not_allowed_ly = LSET::AllNonCuMask();

 if( viaType != VIATYPE::THROUGH )
 {
 not_allowed_ly.set( currentLayer );
 }

 if( viaType == VIATYPE::MICROVIA )
 {
 // Allows only the previous or the next layer from the current layer
 int previous_layer = currentLayer == B_Cu ? layerCount - 2
 : currentLayer - 1;

 int next_layer = currentLayer >= layerCount-2 ? B_Cu
 : currentLayer + 1;

 not_allowed_ly = LSET::AllLayersMask();

 if( previous_layer >= F_Cu && previous_layer != currentLayer )
 not_allowed_ly.reset( previous_layer );

 if( next_layer != currentLayer )
 not_allowed_ly.reset( next_layer );
 }

 targetLayer = frame()->SelectOneLayer( static_cast<PCB_LAYER_ID>( currentLayer ),
 not_allowed_ly, endPoint );

 // Reset the cursor to the end of the track
 controls()->SetCursorPosition( m_endSnapPoint );

 if( targetLayer == UNDEFINED_LAYER ) // cancelled by user
 return 0;

 // One cannot place a blind/buried via on only one layer:
 if( viaType != VIATYPE::THROUGH )
 {
 if( currentLayer == targetLayer )
 return 0;
 }
 }
 }

 // 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 == VIATYPE::BLIND_BURIED ) && ( !bds.m_BlindBuriedViaAllowed ) )
 {
 WX_INFOBAR* infobar = frame()->GetInfoBar();
 wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY,
 _( "Show board setup" ),
 wxEmptyString );

 button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<void( wxHyperlinkEvent& aEvent )>(
 [&]( wxHyperlinkEvent& aEvent )
 {
 getEditFrame<PCB_EDIT_FRAME>()->ShowBoardSetupDialog( _( "Constraints" ) );
 } ) );

 infobar->RemoveAllButtons();
 infobar->AddButton( button );

 infobar->ShowMessageFor( _( "Blind/buried vias must first be enabled in "
 "Board Setup > Design Rules > Constraints." ),
 10000, wxICON_ERROR, WX_INFOBAR::MESSAGE_TYPE::DRC_VIOLATION );
 return false;
 }

 if( ( viaType == VIATYPE::MICROVIA ) && ( !bds.m_MicroViasAllowed ) )
 {
 WX_INFOBAR* infobar = frame()->GetInfoBar();
 wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY,
 _( "Show board setup" ), wxEmptyString );

 button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<void( wxHyperlinkEvent& aEvent )>(
 [&]( wxHyperlinkEvent& aEvent )
 {
 getEditFrame<PCB_EDIT_FRAME>()->ShowBoardSetupDialog( _( "Constraints" ) );
 } ) );

 infobar->RemoveAllButtons();
 infobar->AddButton( button );

 infobar->ShowMessageFor( _( "Microvias must first be enabled in "
 "Board Setup > Design Rules > Constraints." ),
 10000, wxICON_ERROR, WX_INFOBAR::MESSAGE_TYPE::DRC_VIOLATION );
 return false;
 }
 }

 // Convert blind/buried via to a through hole one, if it goes through all layers
 if( viaType == VIATYPE::BLIND_BURIED
 && ( ( targetLayer == B_Cu && currentLayer == F_Cu )
 || ( targetLayer == F_Cu && currentLayer == B_Cu ) ) )
 {
  viaType = VIATYPE::THROUGH;
 }

 if( targetLayer == UNDEFINED_LAYER )
 {
 // Implicic layer selection

 switch( viaType )
 {
 case VIATYPE::THROUGH:
 // use the default layer pair
 currentLayer = pairTop;
 targetLayer = pairBottom;
 break;

 case VIATYPE::MICROVIA:
 // Try to use the layer pair preset, if the layers are adjacent,
 // because a microvia is usually restricted to 2 adjacent copper layers
 if( pairTop > pairBottom ) std::swap( pairTop, pairBottom );

 if( currentLayer == pairTop && pairBottom == pairTop+1 )
 {
 targetLayer = pairBottom;
 }
 else if( currentLayer == pairBottom && pairBottom == pairTop+1 )
 {
 targetLayer = pairTop;
 }
  else if( currentLayer == F_Cu || currentLayer == In1_Cu )
 {
 // front-side microvia
 currentLayer = F_Cu;

 if( layerCount > 2 ) // Ensure the inner layer In1_Cu exists
 targetLayer = In1_Cu;
 else
 targetLayer = B_Cu;
 }
 else if( currentLayer == B_Cu || currentLayer == layerCount - 2 )
 {
 // back-side microvia
 currentLayer = B_Cu,
 targetLayer = (PCB_LAYER_ID) ( layerCount - 2 );
 }
 else
 {
 // This is not optimal: from an internal layer one can want to switch
 // to the previous or the next internal layer
 // but at this point we do not know what the user want.
 targetLayer = PCB_LAYER_ID( currentLayer + 1 );
  }
 break;

 case VIATYPE::BLIND_BURIED:
 if( currentLayer == pairTop || currentLayer == pairBottom )
 {
 // the current layer is on the defined layer pair,
 // swap to the other side
 currentLayer = pairTop;
 targetLayer = pairBottom;
 }
 else
 {
 // the current layer is not part of the current layer pair,
 // so fallback and swap to the top layer of the pair by default
 targetLayer = pairTop;
 }

 // Do not create a broken via (i.e. a via on only one copper layer)
 if( currentLayer == targetLayer )
 {
 WX_INFOBAR* infobar = frame()->GetInfoBar();
 infobar->ShowMessageFor( _( "Blind/buried via need 2 different layers." ),
 2000, wxICON_ERROR,
 WX_INFOBAR::MESSAGE_TYPE::DRC_VIOLATION );
  return 0;
 }

 break;

 default:
 wxFAIL_MSG( wxT( "unexpected via type" ) );
 return 0;
 break;
 }
 }

 sizes.SetViaDiameter( bds.m_ViasMinSize );
 sizes.SetViaDrill( bds.m_MinThroughDrill );

 if( bds.UseNetClassVia() || viaType == VIATYPE::MICROVIA )
 {
 PCB_VIA dummyVia( board() );
 dummyVia.SetViaType( viaType );
 dummyVia.SetLayerPair( currentLayer, targetLayer );

 if( !m_router->GetCurrentNets().empty() )
 dummyVia.SetNetCode( m_router->GetCurrentNets()[0] );

 DRC_CONSTRAINT constraint;

 constraint = bds.m_DRCEngine->EvalRules( VIA_DIAMETER_CONSTRAINT, &dummyVia, nullptr,
 currentLayer );

 if( !constraint.IsNull() )
 sizes.SetViaDiameter( constraint.m_Value.Opt() );

 constraint = bds.m_DRCEngine->EvalRules( HOLE_SIZE_CONSTRAINT, &dummyVia, nullptr,
 currentLayer );

 if( !constraint.IsNull() )
 sizes.SetViaDrill( constraint.m_Value.Opt() );
 }
 else
 {
 sizes.SetViaDiameter( bds.GetCurrentViaSize() );
 sizes.SetViaDrill( bds.GetCurrentViaDrill() );
 }

 sizes.SetViaType( viaType );
 sizes.AddLayerPair( currentLayer, targetLayer );

 m_router->UpdateSizes( sizes );

 if( !m_router->IsPlacingVia() )
 m_router->ToggleViaPlacement();

 m_lastTargetLayer = targetLayer;

 if( m_router->RoutingInProgress() )
 {
 updateEndItem( aEvent );
 m_router->Move( m_endSnapPoint, m_endItem );
 }
 else
 {
 updateStartItem( aEvent );
 }

 return 0;
}

References _, WX_INFOBAR::AddButton(), PNS::SIZES_SETTINGS::AddLayerPair(), LSET::AllCuMask(), LSET::AllLayersMask(), LSET::AllNonCuMask(), B_Cu, BLIND_BURIED, PCB_TOOL_BASE::board(), PNS::SIZES_SETTINGS::ClearLayerPairs(), PCB_TOOL_BASE::controls(), WX_INFOBAR::DRC_VIOLATION, F_Cu, PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), BOARD_DESIGN_SETTINGS::GetCopperLayerCount(), PNS::ROUTER::GetCurrentLayer(), PNS::ROUTER::GetCurrentNets(), BOARD_DESIGN_SETTINGS::GetCurrentViaDrill(), BOARD_DESIGN_SETTINGS::GetCurrentViaSize(), BOARD::GetDesignSettings(), EDA_BASE_FRAME::GetInfoBar(), PCB_BASE_FRAME::GetScreen(), getTargetLayerFromEvent(), getViaTypeFromFlags(), HOLE_SIZE_CONSTRAINT, In1_Cu, TOOL_EVENT::IsAction(), DRC_CONSTRAINT::IsNull(), PNS::ROUTER::IsPlacingVia(), TOOL_BASE::IsToolActive(), PCB_ACTIONS::layerNext, PCB_ACTIONS::layerPrev, BOARD_DESIGN_SETTINGS::m_BlindBuriedViaAllowed, BOARD_DESIGN_SETTINGS::m_DRCEngine, PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, m_lastTargetLayer, BOARD_DESIGN_SETTINGS::m_MicroViasAllowed, BOARD_DESIGN_SETTINGS::m_MinThroughDrill, PCB_SCREEN::m_Route_Layer_BOTTOM, PCB_SCREEN::m_Route_Layer_TOP, PNS::TOOL_BASE::m_router, DRC_CONSTRAINT::m_Value, BOARD_DESIGN_SETTINGS::m_ViasMinSize, MICROVIA, PNS::ROUTER::Move(), MINOPTMAX< T >::Opt(), TOOL_EVENT::Parameter(), WX_INFOBAR::RemoveAllButtons(), PNS::ROUTER::RoutingInProgress(), SELECT_LAYER, PCB_BASE_FRAME::SelectOneLayer(), LSET::Seq(), KIGFX::VIEW_CONTROLS::SetCursorPosition(), PCB_VIA::SetLayerPair(), BOARD_CONNECTED_ITEM::SetNetCode(), PNS::SIZES_SETTINGS::SetViaDiameter(), PNS::SIZES_SETTINGS::SetViaDrill(), PNS::SIZES_SETTINGS::SetViaType(), PCB_VIA::SetViaType(), WX_INFOBAR::ShowMessageFor(), PNS::ROUTER::Sizes(), PNS::ROUTER::SwitchLayer(), THROUGH, PNS::ROUTER::ToggleViaPlacement(), KIGFX::VIEW::ToScreen(), UNDEFINED_LAYER, PNS::TOOL_BASE::updateEndItem(), PNS::ROUTER::UpdateSizes(), PNS::TOOL_BASE::updateStartItem(), BOARD_DESIGN_SETTINGS::UseNetClassVia(), VIA_DIAMETER_CONSTRAINT, and PCB_TOOL_BASE::view().

Referenced by onLayerCommand(), and onViaCommand().

highlightNet()

void TOOL_BASE::highlightNet ( bool  aEnabled, int  aNetcode = -1  )

protectedvirtualinherited

Definition at line 218 of file pns_tool_base.cpp.

{
 RENDER_SETTINGS* rs = getView()->GetPainter()->GetSettings();

 if( aNetcode >= 0 && aEnabled )
 {
 // If the user has previously set the current net to be highlighted,
 // we assume they want to keep it highlighted after routing
 m_startHighlight = ( rs->IsHighlightEnabled()
 && rs->GetHighlightNetCodes().count( aNetcode ) );

 rs->SetHighlight( true, aNetcode );
 }
 else
 {
 if( !m_startHighlight )
 rs->SetHighlight( false );

 m_startHighlight = false;
 }

 getView()->UpdateAllLayersColor();
}

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

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

Init()

bool ROUTER_TOOL::Init ( )

overridevirtual

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

Returns

True if the initialization went fine, false - otherwise.

Reimplemented from PCB_TOOL_BASE.

Definition at line 426 of file router_tool.cpp.

{
 m_lastTargetLayer = UNDEFINED_LAYER;

 PCB_EDIT_FRAME* frame = getEditFrame<PCB_EDIT_FRAME>();

 wxASSERT( frame );

 auto& menu = m_menu.GetMenu();
 menu.SetTitle( _( "Interactive Router" ) );

 m_trackViaMenu = std::make_shared<TRACK_WIDTH_MENU>( *frame );
 m_trackViaMenu->SetTool( this );
 m_menu.AddSubMenu( m_trackViaMenu );

 m_diffPairMenu = std::make_shared<DIFF_PAIR_MENU>( *frame );
 m_diffPairMenu->SetTool( this );
 m_menu.AddSubMenu( m_diffPairMenu );

 auto notRoutingCond =
 [this]( const SELECTION& )
 {
 return !m_router->RoutingInProgress();
 };

 menu.AddItem( ACTIONS::cancelInteractive, SELECTION_CONDITIONS::ShowAlways );

 menu.AddSeparator();

 menu.AddItem( PCB_ACTIONS::routeSingleTrack, notRoutingCond );
 menu.AddItem( PCB_ACTIONS::routeDiffPair, notRoutingCond );
 menu.AddItem( ACT_EndTrack, SELECTION_CONDITIONS::ShowAlways );
 menu.AddItem( PCB_ACTIONS::routerUndoLastSegment, SELECTION_CONDITIONS::ShowAlways );
 menu.AddItem( PCB_ACTIONS::breakTrack, notRoutingCond );

 menu.AddItem( PCB_ACTIONS::drag45Degree, notRoutingCond );
 menu.AddItem( PCB_ACTIONS::dragFreeAngle, notRoutingCond );

// Add( ACT_AutoEndRoute ); // fixme: not implemented yet. Sorry.
 menu.AddItem( ACT_PlaceThroughVia, SELECTION_CONDITIONS::ShowAlways );
 menu.AddItem( ACT_PlaceBlindVia, SELECTION_CONDITIONS::ShowAlways );
 menu.AddItem( ACT_PlaceMicroVia, SELECTION_CONDITIONS::ShowAlways );
 menu.AddItem( ACT_SelLayerAndPlaceThroughVia, SELECTION_CONDITIONS::ShowAlways );
 menu.AddItem( ACT_SelLayerAndPlaceBlindVia, SELECTION_CONDITIONS::ShowAlways );
 menu.AddItem( ACT_SelLayerAndPlaceMicroVia, SELECTION_CONDITIONS::ShowAlways );
 menu.AddItem( ACT_SwitchPosture, SELECTION_CONDITIONS::ShowAlways );
 menu.AddItem( ACT_SwitchCornerMode, SELECTION_CONDITIONS::ShowAlways );

 menu.AddSeparator();

 auto diffPairCond =
 [this]( const SELECTION& )
 {
 return m_router->Mode() == PNS::PNS_MODE_ROUTE_DIFF_PAIR;
 };

 menu.AddMenu( m_trackViaMenu.get(), SELECTION_CONDITIONS::ShowAlways );
 menu.AddMenu( m_diffPairMenu.get(), diffPairCond );

 menu.AddItem( PCB_ACTIONS::routerSettingsDialog, SELECTION_CONDITIONS::ShowAlways );

 menu.AddSeparator();

 frame->AddStandardSubMenus( m_menu );

 return true;
}

References _, ACT_EndTrack, ACT_PlaceBlindVia, ACT_PlaceMicroVia, ACT_PlaceThroughVia, ACT_SelLayerAndPlaceBlindVia, ACT_SelLayerAndPlaceMicroVia, ACT_SelLayerAndPlaceThroughVia, ACT_SwitchCornerMode, ACT_SwitchPosture, EDA_DRAW_FRAME::AddStandardSubMenus(), TOOL_MENU::AddSubMenu(), PCB_ACTIONS::breakTrack, ACTIONS::cancelInteractive, PCB_ACTIONS::drag45Degree, PCB_ACTIONS::dragFreeAngle, PCB_TOOL_BASE::frame(), TOOL_MENU::GetMenu(), m_diffPairMenu, m_lastTargetLayer, TOOL_INTERACTIVE::m_menu, PNS::TOOL_BASE::m_router, m_trackViaMenu, PNS::ROUTER::Mode(), PNS::PNS_MODE_ROUTE_DIFF_PAIR, PCB_ACTIONS::routeDiffPair, PCB_ACTIONS::routerSettingsDialog, PCB_ACTIONS::routerUndoLastSegment, PCB_ACTIONS::routeSingleTrack, PNS::ROUTER::RoutingInProgress(), ACTION_MENU::SetTitle(), SELECTION_CONDITIONS::ShowAlways(), and UNDEFINED_LAYER.

InlineBreakTrack()

int ROUTER_TOOL::InlineBreakTrack

(

const TOOL_EVENT &

aEvent

)

Definition at line 1975 of file router_tool.cpp.

{
 const SELECTION& selection = m_toolMgr->GetTool<PCB_SELECTION_TOOL>()->GetSelection();

 if( selection.Size() != 1 )
 return 0;

 const BOARD_CONNECTED_ITEM* item =
 static_cast<const BOARD_CONNECTED_ITEM*>( selection.Front() );

 if( item->Type() != PCB_TRACE_T )
 return 0;

 Activate();

 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 m_router->SyncWorld();
 m_startItem = m_router->GetWorld()->FindItemByParent( item );

 TOOL_MANAGER* toolManager = frame()->GetToolManager();
 GAL* gal = toolManager->GetView()->GetGAL();

 m_gridHelper->SetUseGrid( gal->GetGridSnapping() && !aEvent.DisableGridSnapping() );
 m_gridHelper->SetSnap( !aEvent.Modifier( MD_SHIFT ) );

 if( toolManager->IsContextMenuActive() )
 {
 // If we're here from a context menu then we need to get the position of the
 // cursor when the context menu was invoked. This is used to figure out the
 // break point on the track.
 m_startSnapPoint = snapToItem( m_startItem, toolManager->GetMenuCursorPos() );
 }
 else
 {
 // If we're here from a hotkey, then get the current mouse position so we know
 // where to break the track.
 m_startSnapPoint = snapToItem( m_startItem, controls()->GetCursorPosition() );
 }

 if( m_startItem && m_startItem->IsLocked() )
 {
 KIDIALOG dlg( frame(), _( "The selected item is locked." ), _( "Confirmation" ),
 wxOK | wxCANCEL | wxICON_WARNING );
 dlg.SetOKLabel( _( "Break Track" ) );
 dlg.DoNotShowCheckbox( __FILE__, __LINE__ );

 if( dlg.ShowModal() == wxID_CANCEL )
 return 0;
 }

 frame()->UndoRedoBlock( true );
 breakTrack();

 if( m_router->RoutingInProgress() )
 m_router->StopRouting();

 frame()->UndoRedoBlock( false );

 return 0;
}

References _, TOOL_INTERACTIVE::Activate(), breakTrack(), PCB_TOOL_BASE::controls(), TOOL_EVENT::DisableGridSnapping(), KIDIALOG::DoNotShowCheckbox(), PNS::NODE::FindItemByParent(), PCB_TOOL_BASE::frame(), SELECTION::Front(), KIGFX::VIEW::GetGAL(), KIGFX::GAL::GetGridSnapping(), TOOL_MANAGER::GetMenuCursorPos(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), TOOL_MANAGER::GetView(), PNS::ROUTER::GetWorld(), TOOL_MANAGER::IsContextMenuActive(), PNS::ITEM::IsLocked(), PNS::TOOL_BASE::m_gridHelper, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, PNS::TOOL_BASE::m_startSnapPoint, TOOL_BASE::m_toolMgr, MD_SHIFT, TOOL_EVENT::Modifier(), PCB_TRACE_T, PNS::ROUTER::RoutingInProgress(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, GRID_HELPER::SetSnap(), GRID_HELPER::SetUseGrid(), KIDIALOG::ShowModal(), SELECTION::Size(), PNS::TOOL_BASE::snapToItem(), PNS::ROUTER::StopRouting(), PNS::ROUTER::SyncWorld(), EDA_ITEM::Type(), and PCB_BASE_EDIT_FRAME::UndoRedoBlock().

Referenced by setTransitions().

InlineDrag()

int ROUTER_TOOL::InlineDrag

(

const TOOL_EVENT &

aEvent

)

Definition at line 1676 of file router_tool.cpp.

{
 const PCB_SELECTION& selection = m_toolMgr->GetTool<PCB_SELECTION_TOOL>()->GetSelection();

 if( selection.Empty() )
 m_toolMgr->RunAction( PCB_ACTIONS::selectionCursor, true, NeighboringSegmentFilter );

 if( selection.Size() != 1 )
 return 0;

 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( selection.Front() );

 if( item->Type() != PCB_TRACE_T
 && item->Type() != PCB_VIA_T
 && item->Type() != PCB_FOOTPRINT_T )
 {
 return 0;
 }

 // If we overrode locks, we want to clear the flag from the source item before SyncWorld is
 // called so that virtual vias are not generated for the (now unlocked) track segment. Note in
 // this case the lock can't be reliably re-applied, because there is no guarantee that the end
 // state of the drag results in the same number of segments so it's not clear which segment to
 // apply the lock state to.
 bool wasLocked = false;

 if( item->IsLocked() )
 {
 wasLocked = true;
 item->SetLocked( false );
 }

 Activate();

 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 m_router->SyncWorld();
 m_startItem = nullptr;

 PNS::ITEM* startItem = nullptr;
 PNS::ITEM_SET itemsToDrag;
 const FOOTPRINT* footprint = nullptr;

 std::shared_ptr<CONNECTIVITY_DATA> connectivityData = board()->GetConnectivity();
 std::vector<BOARD_ITEM*> dynamicItems;
 std::unique_ptr<CONNECTIVITY_DATA> dynamicData = nullptr;
 VECTOR2I lastOffset;

 if( item->Type() == PCB_FOOTPRINT_T )
 {
 footprint = static_cast<const FOOTPRINT*>(item);

 for( PAD* pad : footprint->Pads() )
 {
 PNS::ITEM* solid = m_router->GetWorld()->FindItemByParent( pad );

 if( solid )
 itemsToDrag.Add( solid );

 if( pad->GetLocalRatsnestVisible() || displayOptions().m_ShowModuleRatsnest )
 {
 if( connectivityData->GetRatsnestForPad( pad ).size() > 0 )
 dynamicItems.push_back( pad );
 }
 }

 dynamicData = std::make_unique<CONNECTIVITY_DATA>( dynamicItems, true );
 connectivityData->BlockRatsnestItems( dynamicItems );
 }
 else
 {
 startItem = m_router->GetWorld()->FindItemByParent( item );

 if( startItem )
 itemsToDrag.Add( startItem );
 }

 GAL* gal = m_toolMgr->GetView()->GetGAL();
 VECTOR2I p0 = controls()->GetCursorPosition( false );
 VECTOR2I p = p0;

 m_gridHelper->SetUseGrid( gal->GetGridSnapping() && !aEvent.DisableGridSnapping() );
 m_gridHelper->SetSnap( !aEvent.Modifier( MD_SHIFT ) );

 if( startItem )
 {
 p = snapToItem( startItem, p0 );
 m_startItem = startItem;

 if( m_startItem && m_startItem->Net() > 0 )
 highlightNet( true, m_startItem->Net() );
 }
 else if( footprint )
 {
 // The mouse is going to be moved on grid before dragging begins.
 VECTOR2I tweakedMousePos;
 PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();

 // Check if user wants to warp the mouse to origin of moved object

 if( editFrame->GetMoveWarpsCursor() )
 tweakedMousePos = footprint->GetPosition(); // Use footprint anchor to warp mouse
 else
 tweakedMousePos = controls()->GetCursorPosition(); // Just use current mouse pos

 // We tweak the mouse position using the value from above, and then use that as the
 // start position to prevent the footprint from jumping when we start dragging.
 // First we move the visual cross hair cursor...
 controls()->ForceCursorPosition( true, tweakedMousePos );
 controls()->SetCursorPosition( tweakedMousePos ); // ...then the mouse pointer

 // Now that the mouse is in the right position, get a copy of the position to use later
 p = controls()->GetCursorPosition();
 }

 int dragMode = aEvent.Parameter<int64_t> ();

 bool dragStarted = m_router->StartDragging( p, itemsToDrag, dragMode );

 if( !dragStarted )
 {
 if( wasLocked )
 item->SetLocked( true );

 return 0;
 }

 m_gridHelper->SetAuxAxes( true, p );
 controls()->ShowCursor( true );
 controls()->SetAutoPan( true );
 frame()->UndoRedoBlock( true );

 view()->ClearPreview();
 view()->InitPreview();

 auto setCursor =
 [&]()
 {
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 };

 // Set initial cursor
 setCursor();

 // Set the initial visible area
 BOX2D viewAreaD = getView()->GetGAL()->GetVisibleWorldExtents();
 m_router->SetVisibleViewArea( BOX2I( viewAreaD.GetOrigin(), viewAreaD.GetSize() ) );

 // Send an initial movement to prime the collision detection
 m_router->Move( p, nullptr );

 bool hasMouseMoved = false;

 while( TOOL_EVENT* evt = Wait() )
 {
 setCursor();

 if( evt->IsCancelInteractive() )
 {
 if( wasLocked )
 item->SetLocked( true );

 break;
 }
 else if( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) )
 {
 hasMouseMoved = true;
 updateEndItem( *evt );
 m_router->Move( m_endSnapPoint, m_endItem );

 if( footprint )
 {
 VECTOR2I offset = m_endSnapPoint - p;
 BOARD_ITEM* previewItem;
 wxPoint fp_offset = wxPoint( offset.Rotate( footprint->GetOrientationRadians() ) );

 view()->ClearPreview();

 for( BOARD_ITEM* drawing : footprint->GraphicalItems() )
 {
 previewItem = static_cast<BOARD_ITEM*>( drawing->Clone() );

 if( drawing->Type() == PCB_FP_SHAPE_T )
 {
 FP_SHAPE* shape = static_cast<FP_SHAPE*>( previewItem );
 shape->FP_SHAPE::Move( fp_offset );
 }
 else
 {
 previewItem->Move( offset );
 }

 view()->AddToPreview( previewItem );
 view()->Hide( drawing, true );
 }

 for( PAD* pad : footprint->Pads() )
 {
 if( ( pad->GetLayerSet() & LSET::AllCuMask() ).none()
 && pad->GetDrillSize().x == 0 )
 {
 previewItem = static_cast<BOARD_ITEM*>( pad->Clone() );
 previewItem->Move( offset );

 view()->AddToPreview( previewItem );
 }
 else
 {
 // Pads with copper or holes are handled by the router
 }

 view()->Hide( pad, true );
 }

 previewItem = static_cast<BOARD_ITEM*>( footprint->Reference().Clone() );
 previewItem->Move( offset );
 view()->AddToPreview( previewItem );
 view()->Hide( &footprint->Reference() );

 previewItem = static_cast<BOARD_ITEM*>( footprint->Value().Clone() );
 previewItem->Move( offset );
 view()->AddToPreview( previewItem );
 view()->Hide( &footprint->Value() );

 for( ZONE* zone : footprint->Zones() )
 {
 previewItem = static_cast<BOARD_ITEM*>( zone->Clone() );
 previewItem->Move( offset );
 view()->AddToPreview( previewItem );
 view()->Hide( zone, true );
 }

 // Update ratsnest
 dynamicData->Move( offset - lastOffset );
 lastOffset = offset;
 connectivityData->ComputeDynamicRatsnest( dynamicItems, dynamicData.get(), offset );
 }
 }
 else if( hasMouseMoved && ( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) ) )
 {
 updateEndItem( *evt );
 m_router->FixRoute( m_endSnapPoint, m_endItem );
 break;
 }
 else if( evt->Category() == TC_COMMAND )
 {
 // disallow editing commands
 if( evt->IsAction( &ACTIONS::cut )
 || evt->IsAction( &ACTIONS::copy )
 || evt->IsAction( &ACTIONS::paste )
 || evt->IsAction( &ACTIONS::pasteSpecial ) )
 {
 wxBell();
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 else
 {
 evt->SetPassEvent();
 }

 handleCommonEvents( *evt );
 }

 if( footprint )
 {
 for( BOARD_ITEM* drawing : footprint->GraphicalItems() )
 view()->Hide( drawing, false );

 view()->Hide( &footprint->Reference(), false );
 view()->Hide( &footprint->Value(), false );

 for( ZONE* zone : footprint->Zones() )
 view()->Hide( zone, false );

 for( PAD* pad : footprint->Pads() )
 view()->Hide( pad, false );

 view()->ClearPreview();
 view()->ShowPreview( false );

 connectivityData->ClearDynamicRatsnest();
 }

 if( m_router->RoutingInProgress() )
 m_router->StopRouting();

 m_gridHelper->SetAuxAxes( false );
 controls()->SetAutoPan( false );
 controls()->ForceCursorPosition( false );
 frame()->UndoRedoBlock( false );
 highlightNet( false );

 return 0;
}

References TOOL_INTERACTIVE::Activate(), PNS::ITEM_SET::Add(), KIGFX::VIEW::AddToPreview(), LSET::AllCuMask(), ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, KIGFX::VIEW::ClearPreview(), FP_TEXT::Clone(), PCB_TOOL_BASE::controls(), ACTIONS::copy, ACTIONS::cut, TOOL_EVENT::DisableGridSnapping(), PCB_TOOL_BASE::displayOptions(), SELECTION::Empty(), PNS::NODE::FindItemByParent(), PNS::ROUTER::FixRoute(), PCB_TOOL_BASE::footprint(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), SELECTION::Front(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetConnectivity(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), KIGFX::VIEW::GetGAL(), KIGFX::GAL::GetGridSnapping(), TOOLS_HOLDER::GetMoveWarpsCursor(), FOOTPRINT::GetOrientationRadians(), BOX2< Vec >::GetOrigin(), FOOTPRINT::GetPosition(), BOX2< Vec >::GetSize(), TOOL_MANAGER::GetTool(), TOOL_BASE::getView(), TOOL_MANAGER::GetView(), KIGFX::GAL::GetVisibleWorldExtents(), PNS::ROUTER::GetWorld(), FOOTPRINT::GraphicalItems(), handleCommonEvents(), KIGFX::VIEW::Hide(), PNS::TOOL_BASE::highlightNet(), KIGFX::VIEW::InitPreview(), BOARD_ITEM::IsLocked(), PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, PNS::TOOL_BASE::m_gridHelper, PNS::TOOL_BASE::m_router, PCB_DISPLAY_OPTIONS::m_ShowModuleRatsnest, PNS::TOOL_BASE::m_startItem, TOOL_BASE::m_toolMgr, MD_SHIFT, TOOL_EVENT::Modifier(), PNS::ROUTER::Move(), BOARD_ITEM::Move(), NeighboringSegmentFilter(), PNS::ITEM::Net(), pad, FOOTPRINT::Pads(), TOOL_EVENT::Parameter(), ACTIONS::paste, ACTIONS::pasteSpecial, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_TRACE_T, PCB_VIA_T, FOOTPRINT::Reference(), VECTOR2< T >::Rotate(), PNS::ROUTER::RoutingInProgress(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectionCursor, KIGFX::VIEW_CONTROLS::SetAutoPan(), GRID_HELPER::SetAuxAxes(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), KIGFX::VIEW_CONTROLS::SetCursorPosition(), BOARD_ITEM::SetLocked(), GRID_HELPER::SetSnap(), GRID_HELPER::SetUseGrid(), PNS::ROUTER::SetVisibleViewArea(), KIGFX::VIEW_CONTROLS::ShowCursor(), KIGFX::VIEW::ShowPreview(), SELECTION::Size(), PNS::TOOL_BASE::snapToItem(), PNS::ROUTER::StartDragging(), PNS::ROUTER::StopRouting(), PNS::ROUTER::SyncWorld(), TC_COMMAND, EDA_ITEM::Type(), PCB_BASE_EDIT_FRAME::UndoRedoBlock(), PNS::TOOL_BASE::updateEndItem(), FOOTPRINT::Value(), PCB_TOOL_BASE::view(), TOOL_INTERACTIVE::Wait(), and FOOTPRINT::Zones().

Referenced by setTransitions().

Is45Limited()

bool PCB_TOOL_BASE::Is45Limited ( ) const

virtualinherited

Should the tool use its 45° mode option?

Returns

True if set to use 45°

Definition at line 323 of file pcb_tool_base.cpp.

{
 if( frame()->IsType( FRAME_PCB_EDITOR ) )
 return frame()->Settings().m_PcbUse45DegreeLimit;
 else
 return frame()->Settings().m_FpeditUse45DegreeLimit;
}

References PCB_TOOL_BASE::frame(), FRAME_PCB_EDITOR, PCBNEW_SETTINGS::m_FpeditUse45DegreeLimit, PCBNEW_SETTINGS::m_PcbUse45DegreeLimit, and PCB_BASE_FRAME::Settings().

Referenced by DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), and DRAWING_TOOL::DrawZone().

IsFootprintEditor()

bool PCB_TOOL_BASE::IsFootprintEditor ( ) const

inlineinherited

Definition at line 104 of file pcb_tool_base.h.

{ return m_isFootprintEditor; }

References PCB_TOOL_BASE::m_isFootprintEditor.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), EDIT_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), EDIT_TOOL::Flip(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Remove(), and EDIT_TOOL::Rotate().

IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 31 of file tool_base.cpp.

{
 return m_toolMgr->IsToolActive( m_toolId );
}

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

Referenced by EDIT_TOOL::Drag(), handleLayerSwitch(), EDIT_TOOL::isRouterActive(), PCB_SELECTION_TOOL::Main(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

MainLoop()

int ROUTER_TOOL::MainLoop

(

const TOOL_EVENT &

aEvent

)

Definition at line 1349 of file router_tool.cpp.

{
 PNS::ROUTER_MODE mode = aEvent.Parameter<PNS::ROUTER_MODE>();
 PCB_EDIT_FRAME* frame = getEditFrame<PCB_EDIT_FRAME>();
 VIEW_CONTROLS* controls = getViewControls();

 if( m_router->RoutingInProgress() )
 {
 if( m_router->Mode() == mode )
 return 0;
 else
 m_router->StopRouting();
 }

 // Deselect all items
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );

 std::string tool = aEvent.GetCommandStr().get();
 frame->PushTool( tool );

 auto setCursor =
 [&]()
 {
 frame->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
 };

 Activate();
 // Must be done after Activate() so that it gets set into the correct context
 controls->ShowCursor( true );
 controls->ForceCursorPosition( false );
 // Set initial cursor
 setCursor();

 m_router->SetMode( mode );
 m_cancelled = false;

 // Prime the pump
 if( aEvent.HasPosition() )
 m_toolMgr->PrimeTool( controls->GetCursorPosition( false ) );

 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 if( !evt->IsDrag() )
 setCursor();

 if( evt->IsCancelInteractive() )
 {
 frame->PopTool( tool );
 break;
 }
 else if( evt->IsActivate() )
 {
 if( evt->IsMoveTool() )
 {
 // leave ourselves on the stack so we come back after the move
 break;
 }
 else
 {
 frame->PopTool( tool );
 break;
 }
 }
 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->IsAction( &PCB_ACTIONS::dragFreeAngle ) )
 {
 updateStartItem( *evt, true );
 performDragging( PNS::DM_ANY | PNS::DM_FREE_ANGLE );
 }
 else if( evt->IsAction( &PCB_ACTIONS::drag45Degree ) )
 {
 updateStartItem( *evt, true );
 performDragging( PNS::DM_ANY );
 }
 else if( evt->IsAction( &PCB_ACTIONS::breakTrack ) )
 {
 updateStartItem( *evt, true );
 breakTrack( );
 evt->SetPassEvent( false );
 }
 else if( evt->IsClick( BUT_LEFT )
 || evt->IsAction( &PCB_ACTIONS::routeSingleTrack )
 || evt->IsAction( &PCB_ACTIONS::routeDiffPair ) )
 {
 updateStartItem( *evt );

 if( evt->HasPosition() )
 {
 if( evt->Modifier( MD_SHIFT ) )
 performDragging( PNS::DM_ANY );
 else
 performRouting();
 }
 }
 else if( evt->IsAction( &ACT_PlaceThroughVia ) )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::layerToggle, true );
 }
 else if( evt->IsAction( &PCB_ACTIONS::layerChanged ) )
 {
 m_router->SwitchLayer( frame->GetActiveLayer() );
 updateStartItem( *evt );
 }
 else if( evt->IsKeyPressed() )
 {
 // wxWidgets fails to correctly translate shifted keycodes on the wxEVT_CHAR_HOOK
 // event so we need to process the wxEVT_CHAR event that will follow as long as we
 // pass the event.
 evt->SetPassEvent();
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else
 {
 evt->SetPassEvent();
 }

 if( m_cancelled )
 {
 frame->PopTool( tool );
 break;
 }
 }

 // Store routing settings till the next invocation
 m_savedSizes = m_router->Sizes();
 m_router->ClearViewDecorations();

 return 0;
}

References ACT_PlaceThroughVia, TOOL_INTERACTIVE::Activate(), breakTrack(), PCB_ACTIONS::breakTrack, BUT_LEFT, BUT_RIGHT, PNS::ROUTER::ClearViewDecorations(), PNS::ROUTER::ClearWorld(), PCB_TOOL_BASE::controls(), PNS::DM_ANY, PNS::DM_FREE_ANGLE, PCB_ACTIONS::drag45Degree, PCB_ACTIONS::dragFreeAngle, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetCanvas(), TOOL_EVENT::GetCommandStr(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_BASE::getViewControls(), TOOL_EVENT::HasPosition(), PCB_ACTIONS::layerChanged, PCB_ACTIONS::layerToggle, PNS::TOOL_BASE::m_cancelled, TOOL_INTERACTIVE::m_menu, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_savedSizes, TOOL_BASE::m_toolMgr, MD_SHIFT, PNS::ROUTER::Mode(), TOOL_EVENT::Parameter(), PENCIL, performDragging(), performRouting(), TOOLS_HOLDER::PopTool(), TOOL_MANAGER::PrimeTool(), TOOLS_HOLDER::PushTool(), PCB_ACTIONS::routeDiffPair, PCB_ACTIONS::routeSingleTrack, PNS::ROUTER::RoutingInProgress(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, EDA_DRAW_PANEL_GAL::SetCurrentCursor(), PNS::ROUTER::SetMode(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), PNS::ROUTER::Sizes(), PNS::ROUTER::StopRouting(), PNS::ROUTER::SwitchLayer(), PNS::ROUTER::SyncWorld(), TA_MODEL_CHANGE, TA_UNDO_REDO_POST, TA_UNDO_REDO_PRE, PNS::TOOL_BASE::updateStartItem(), and TOOL_INTERACTIVE::Wait().

Referenced by setTransitions().

NeighboringSegmentFilter()

void ROUTER_TOOL::NeighboringSegmentFilter ( const VECTOR2I &  aPt, GENERAL_COLLECTOR &  aCollector  )

static

Definition at line 1594 of file router_tool.cpp.

{
 /*
 * If the collection contains a trivial line corner (two connected segments)
 * or a non-fanout-via (a via with no more than two connected segments), then
 * trim the collection down to a single item (which one won't matter since
 * they're all connected).
 */

 // First make sure we've got something that *might* match.
 int vias = aCollector.CountType( PCB_VIA_T );
 int traces = aCollector.CountType( PCB_TRACE_T );
 int arcs = aCollector.CountType( PCB_ARC_T );

 if( arcs > 0 || vias > 1 || traces > 2 || vias + traces < 1 )
 return;

 // Fetch first PCB_TRACK (via or trace) as our reference
 PCB_TRACK* reference = nullptr;

 for( int i = 0; !reference && i < aCollector.GetCount(); i++ )
 reference = dynamic_cast<PCB_TRACK*>( aCollector[i] );

 int refNet = reference->GetNetCode();

 wxPoint refPoint( aPt.x, aPt.y );
 EDA_ITEM_FLAGS flags = reference->IsPointOnEnds( refPoint, -1 );

 if( flags & STARTPOINT )
 refPoint = reference->GetStart();
 else if( flags & ENDPOINT )
 refPoint = reference->GetEnd();

 // Check all items to ensure that any TRACKs are co-terminus with the reference and on
 // the same net.
 for( int i = 0; i < aCollector.GetCount(); i++ )
 {
 PCB_TRACK* neighbor = dynamic_cast<PCB_TRACK*>( aCollector[i] );

 if( neighbor && neighbor != reference )
 {
 if( neighbor->GetNetCode() != refNet )
 return;

 if( neighbor->GetStart() != refPoint && neighbor->GetEnd() != refPoint )
 return;
 }
 }

 // Selection meets criteria; trim it to the reference item.
 aCollector.Empty();
 aCollector.Append( reference );
}

References COLLECTOR::Append(), COLLECTOR::CountType(), COLLECTOR::Empty(), ENDPOINT, COLLECTOR::GetCount(), PCB_TRACK::GetEnd(), BOARD_CONNECTED_ITEM::GetNetCode(), PCB_TRACK::GetStart(), PCB_TRACK::IsPointOnEnds(), PCB_ARC_T, PCB_TRACE_T, PCB_VIA_T, STARTPOINT, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by CanInlineDrag(), and InlineDrag().

onLayerCommand()

int ROUTER_TOOL::onLayerCommand ( const TOOL_EVENT &  aEvent )

private

Definition at line 709 of file router_tool.cpp.

{
 return handleLayerSwitch( aEvent, false );
}

References handleLayerSwitch().

Referenced by setTransitions().

onTrackViaSizeChanged()

int ROUTER_TOOL::onTrackViaSizeChanged ( const TOOL_EVENT &  aEvent )

private

Definition at line 2055 of file router_tool.cpp.

{
 PNS::SIZES_SETTINGS sizes( m_router->Sizes() );

 if( !m_router->GetCurrentNets().empty() )
 m_iface->ImportSizes( sizes, m_startItem, m_router->GetCurrentNets()[0] );

 m_router->UpdateSizes( sizes );

 // Changing the track width can affect the placement, so call the
 // move routine without changing the destination
 // Update end item first to avoid moving to an invalid/missing item
 updateEndItem( aEvent );
 m_router->Move( m_endSnapPoint, m_endItem );

 UpdateMessagePanel();

 return 0;
}

References PNS::ROUTER::GetCurrentNets(), PNS_KICAD_IFACE_BASE::ImportSizes(), PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, PNS::TOOL_BASE::m_iface, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, PNS::ROUTER::Move(), PNS::ROUTER::Sizes(), PNS::TOOL_BASE::updateEndItem(), UpdateMessagePanel(), and PNS::ROUTER::UpdateSizes().

Referenced by CustomTrackWidthDialog(), and setTransitions().

onViaCommand()

int ROUTER_TOOL::onViaCommand ( const TOOL_EVENT &  aEvent )

private

Definition at line 715 of file router_tool.cpp.

{
 return handleLayerSwitch( aEvent, true );
}

References handleLayerSwitch().

Referenced by setTransitions().

performDragging()

void ROUTER_TOOL::performDragging ( int  aMode = PNS::DM_ANY )

private

Definition at line 1495 of file router_tool.cpp.

{
 m_router->ClearViewDecorations();

 VIEW_CONTROLS* ctls = getViewControls();

 if( m_startItem && m_startItem->IsLocked() )
 {
 KIDIALOG dlg( frame(), _( "The selected item is locked." ), _( "Confirmation" ),
 wxOK | wxCANCEL | wxICON_WARNING );
 dlg.SetOKLabel( _( "Drag Anyway" ) );
 dlg.DoNotShowCheckbox( __FILE__, __LINE__ );

 if( dlg.ShowModal() == wxID_CANCEL )
 return;
 }

 // We don't support dragging arcs inside the PNS right now
 if( m_startItem && m_startItem->Kind() == PNS::ITEM::ARC_T )
 {
 if( m_router->RoutingInProgress() )
 m_router->StopRouting();

 m_startItem = nullptr;

 m_gridHelper->SetAuxAxes( false );
 frame()->UndoRedoBlock( false );
 ctls->SetAutoPan( false );
 ctls->ForceCursorPosition( false );
 highlightNet( false );

 m_cancelled = true;

 m_toolMgr->RunAction( PCB_ACTIONS::drag45Degree, false );

 return;
 }

 bool dragStarted = m_router->StartDragging( m_startSnapPoint, m_startItem, aMode );

 if( !dragStarted )
 return;

 if( m_startItem && m_startItem->Net() > 0 )
 highlightNet( true, m_startItem->Net() );

 ctls->SetAutoPan( true );
 m_gridHelper->SetAuxAxes( true, m_startSnapPoint );
 frame()->UndoRedoBlock( true );

 while( 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->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else if( evt->IsCancelInteractive() || evt->IsActivate() || evt->IsUndoRedo() )
 {
 if( evt->IsCancelInteractive() && !m_startItem )
 m_cancelled = true;

  if( evt->IsActivate() && !evt->IsMoveTool() )
 m_cancelled = true;

 break;
 }
 else
 {
 evt->SetPassEvent();
 }

 handleCommonEvents( *evt );
 }

 if( m_router->RoutingInProgress() )
 m_router->StopRouting();

 m_startItem = nullptr;

 m_gridHelper->SetAuxAxes( false );
 frame()->UndoRedoBlock( false );
 ctls->SetAutoPan( false );
 ctls->ForceCursorPosition( false );
 highlightNet( false );
}

References _, PNS::ITEM::ARC_T, BUT_LEFT, BUT_RIGHT, PNS::ROUTER::ClearViewDecorations(), KIDIALOG::DoNotShowCheckbox(), PCB_ACTIONS::drag45Degree, PNS::ROUTER::FixRoute(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), TOOL_BASE::getViewControls(), handleCommonEvents(), PNS::TOOL_BASE::highlightNet(), PNS::ITEM::IsLocked(), PNS::ITEM::Kind(), PNS::TOOL_BASE::m_cancelled, PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, PNS::TOOL_BASE::m_gridHelper, TOOL_INTERACTIVE::m_menu, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, PNS::TOOL_BASE::m_startSnapPoint, TOOL_BASE::m_toolMgr, PNS::ROUTER::Move(), PNS::ITEM::Net(), PNS::ROUTER::RoutingInProgress(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), KIGFX::VIEW_CONTROLS::SetAutoPan(), GRID_HELPER::SetAuxAxes(), TOOL_MENU::ShowContextMenu(), KIDIALOG::ShowModal(), PNS::ROUTER::StartDragging(), PNS::ROUTER::StopRouting(), PCB_BASE_EDIT_FRAME::UndoRedoBlock(), PNS::TOOL_BASE::updateEndItem(), and TOOL_INTERACTIVE::Wait().

Referenced by MainLoop().

performRouting()

void ROUTER_TOOL::performRouting ( )

private

Definition at line 1139 of file router_tool.cpp.

{
 m_router->ClearViewDecorations();

 if( !prepareInteractive() )
 return;

 auto setCursor =
 [&]()
 {
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
 };

 // Set initial cursor
 setCursor();

 while( TOOL_EVENT* evt = Wait() )
 {
 setCursor();

 // Don't crash if we missed an operation that canceled routing.
 if( !m_router->RoutingInProgress() )
 {
 if( evt->IsCancelInteractive() )
 m_cancelled = true;

 break;
 }

 handleCommonEvents( *evt );

 if( evt->IsMotion() )
 {
 updateEndItem( *evt );
 m_router->Move( m_endSnapPoint, m_endItem );
 }
 else if( evt->IsAction( &PCB_ACTIONS::routerUndoLastSegment ) )
 {
 m_router->UndoLastSegment();
 updateEndItem( *evt );
 m_router->Move( m_endSnapPoint, m_endItem );
 }
 else if( evt->IsClick( BUT_LEFT ) || evt->IsAction( &PCB_ACTIONS::routeSingleTrack ) )
 {
 updateEndItem( *evt );
 bool needLayerSwitch = m_router->IsPlacingVia();
 bool forceFinish = evt->Modifier( MD_SHIFT );

 if( m_router->FixRoute( m_endSnapPoint, m_endItem, forceFinish ) )
 {
 break;
 }

 if( needLayerSwitch )
 switchLayerOnViaPlacement();

 // Synchronize the indicated layer
 PCB_LAYER_ID routingLayer = ToLAYER_ID( m_router->GetCurrentLayer() );
 PCB_EDIT_FRAME* editFrame = getEditFrame<PCB_EDIT_FRAME>();

 editFrame->SetActiveLayer( routingLayer );

 if( !getView()->IsLayerVisible( routingLayer ) )
 {
 editFrame->GetAppearancePanel()->SetLayerVisible( routingLayer, true );
 editFrame->GetCanvas()->Refresh();
 }

 updateEndItem( *evt );
 m_router->Move( m_endSnapPoint, m_endItem );
 m_startItem = nullptr;
 }
 else if( evt->IsAction( &ACT_SwitchCornerMode ) )
 {
 m_router->ToggleCornerMode();
 UpdateMessagePanel();
 updateEndItem( *evt );
 m_router->Move( m_endSnapPoint, m_endItem ); // refresh
 }
 else if( evt->IsAction( &ACT_SwitchPosture ) )
 {
 m_router->FlipPosture();
 updateEndItem( *evt );
 m_router->Move( m_endSnapPoint, m_endItem ); // refresh
 }
 else if( evt->IsAction( &PCB_ACTIONS::properties ) )
 {
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 controls()->SetAutoPan( false );
 {
 m_toolMgr->RunAction( ACT_CustomTrackWidth, true );
 }
 controls()->SetAutoPan( true );
 setCursor();
 UpdateMessagePanel();
 }
 else if( evt->IsAction( &ACT_EndTrack ) || evt->IsDblClick( BUT_LEFT ) )
 {
 // Stop current routing:
 m_router->FixRoute( m_endSnapPoint, m_endItem, true );
 break;
 }
 else if( evt->IsCancelInteractive() || evt->IsActivate()
 || evt->IsUndoRedo()
 || evt->IsAction( &PCB_ACTIONS::routerInlineDrag ) )
 {
 if( evt->IsCancelInteractive() && !m_router->RoutingInProgress() )
 m_cancelled = true;

 if( evt->IsActivate() && !evt->IsMoveTool() )
 m_cancelled = true;

 break;
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else
 {
 evt->SetPassEvent();
 }
 }

 m_router->CommitRouting();

 finishInteractive();
}

References ACT_CustomTrackWidth, ACT_EndTrack, ACT_SwitchCornerMode, ACT_SwitchPosture, ARROW, BUT_LEFT, BUT_RIGHT, PNS::ROUTER::ClearViewDecorations(), PNS::ROUTER::CommitRouting(), PCB_TOOL_BASE::controls(), finishInteractive(), PNS::ROUTER::FixRoute(), PNS::ROUTER::FlipPosture(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), PNS::ROUTER::GetCurrentLayer(), TOOL_BASE::getView(), handleCommonEvents(), PNS::ROUTER::IsPlacingVia(), PNS::TOOL_BASE::m_cancelled, PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, TOOL_INTERACTIVE::m_menu, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, TOOL_BASE::m_toolMgr, MD_SHIFT, PNS::ROUTER::Move(), PENCIL, prepareInteractive(), PCB_ACTIONS::properties, PCB_ACTIONS::routerInlineDrag, PCB_ACTIONS::routerUndoLastSegment, PCB_ACTIONS::routeSingleTrack, PNS::ROUTER::RoutingInProgress(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), TOOL_MENU::ShowContextMenu(), switchLayerOnViaPlacement(), PNS::ROUTER::ToggleCornerMode(), ToLAYER_ID(), PNS::ROUTER::UndoLastSegment(), PNS::TOOL_BASE::updateEndItem(), UpdateMessagePanel(), and TOOL_INTERACTIVE::Wait().

Referenced by MainLoop().

pickSingleItem()

ITEM * TOOL_BASE::pickSingleItem ( const VECTOR2I &  aWhere, int  aNet = -1, int  aLayer = -1, bool  aIgnorePads = false, const std::vector< ITEM * >  aAvoidItems = {}  )

protectedvirtualinherited

Definition at line 99 of file pns_tool_base.cpp.

{
 int tl = aLayer > 0 ? aLayer : getView()->GetTopLayer();

 static const int candidateCount = 5;
 ITEM* prioritized[candidateCount];
 SEG::ecoord dist[candidateCount];

 for( int i = 0; i < candidateCount; i++ )
 {
 prioritized[i] = nullptr;
 dist[i] = VECTOR2I::ECOORD_MAX;
 }

 ITEM_SET candidates = m_router->QueryHoverItems( aWhere );

 if( candidates.Empty() )
 candidates = m_router->QueryHoverItems( aWhere, true );

 for( ITEM* item : candidates.Items() )
 {
 if( !item->IsRoutable() )
 continue;

 if( !IsCopperLayer( item->Layers().Start() ) )
 continue;

 if( !m_iface->IsAnyLayerVisible( item->Layers() ) )
 continue;

 if( alg::contains( aAvoidItems, item ) )
 continue;

 // fixme: this causes flicker with live loop removal...
 //if( item->Parent() && !item->Parent()->ViewIsVisible() )
 // continue;

 if( aNet <= 0 || item->Net() == aNet )
 {
 if( item->OfKind( ITEM::VIA_T | ITEM::SOLID_T ) )
 {
 if( item->OfKind( ITEM::SOLID_T ) && aIgnorePads )
 continue;

 SEG::ecoord d = ( item->Shape()->Centre() - aWhere ).SquaredEuclideanNorm();

 if( d < dist[2] )
 {
 prioritized[2] = item;
 dist[2] = d;
 }

 if( item->Layers().Overlaps( tl ) && d < dist[0] )
 {
 prioritized[0] = item;
 dist[0] = d;
 }
 }
 else // ITEM::SEGMENT_T | ITEM::ARC_T
 {
 LINKED_ITEM* li = static_cast<LINKED_ITEM*>( item );
 SEG::ecoord d = std::min( ( li->Anchor( 0 ) - aWhere ).SquaredEuclideanNorm(),
 ( li->Anchor( 1 ) - aWhere ).SquaredEuclideanNorm() );

 if( d < dist[3] )
 {
 prioritized[3] = item;
 dist[3] = d;
 }

 if( item->Layers().Overlaps( tl ) && d < dist[1] )
 {
 prioritized[1] = item;
 dist[1] = d;
 }
 }
 }
 else if ( item->Net() == 0 && m_router->Settings().Mode() == RM_MarkObstacles )
 {
 // Allow unconnected items as last resort in RM_MarkObstacles mode
 if( item->OfKind( ITEM::SOLID_T ) && aIgnorePads )
 continue;

 if( item->Layers().Overlaps( tl ) )
 prioritized[4] = item;
 }
 }

 ITEM* rv = nullptr;

 bool highContrast = ( displayOptions().m_ContrastModeDisplay != HIGH_CONTRAST_MODE::NORMAL );

 for( int i = 0; i < candidateCount; i++ )
 {
 ITEM* item = prioritized[i];

 if( highContrast && item && !item->Layers().Overlaps( tl ) )
 item = nullptr;

 if( item && ( aLayer < 0 || item->Layers().Overlaps( aLayer ) ) )
 {
 rv = item;
 break;
 }
 }

 if( rv )
 {
 wxLogTrace( wxT( "PNS" ), wxT( "%s, layer : %d, tl: %d" ),
 rv->KindStr().c_str(),
 rv->Layers().Start(),
 tl );
 }

 return rv;
}

References PNS::ITEM::Anchor(), alg::contains(), PCB_TOOL_BASE::displayOptions(), VECTOR2< T >::ECOORD_MAX, PNS::ITEM_SET::Empty(), KIGFX::VIEW::GetTopLayer(), TOOL_BASE::getView(), PNS_KICAD_IFACE::IsAnyLayerVisible(), IsCopperLayer(), PNS::ITEM_SET::Items(), PNS::ITEM::KindStr(), PNS::ITEM::Layers(), PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, PNS::TOOL_BASE::m_iface, PNS::TOOL_BASE::m_router, PNS::ROUTING_SETTINGS::Mode(), NORMAL, LAYER_RANGE::Overlaps(), PNS::ROUTER::QueryHoverItems(), PNS::RM_MarkObstacles, PNS::ROUTER::Settings(), PNS::ITEM::SOLID_T, LAYER_RANGE::Start(), and PNS::ITEM::VIA_T.

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

prepareInteractive()

bool ROUTER_TOOL::prepareInteractive ( )

private

Definition at line 1058 of file router_tool.cpp.

{
 PCB_EDIT_FRAME* editFrame = getEditFrame<PCB_EDIT_FRAME>();
 int routingLayer = getStartLayer( m_startItem );

 if( !IsCopperLayer( routingLayer ) )
 {
 editFrame->ShowInfoBarError( _( "Tracks on Copper layers only." ) );
 return false;
 }

 editFrame->SetActiveLayer( ToLAYER_ID( routingLayer ) );

 if( !getView()->IsLayerVisible( routingLayer ) )
 {
 editFrame->GetAppearancePanel()->SetLayerVisible( routingLayer, true );
 editFrame->GetCanvas()->Refresh();
 }

 if( m_startItem && m_startItem->Net() > 0 )
 highlightNet( true, m_startItem->Net() );

 controls()->SetAutoPan( true );

 PNS::SIZES_SETTINGS sizes( m_router->Sizes() );

 m_iface->SetStartLayer( routingLayer );

 frame()->GetBoard()->GetDesignSettings().m_TempOverrideTrackWidth = false;
 m_iface->ImportSizes( sizes, m_startItem, -1 );
 sizes.AddLayerPair( frame()->GetScreen()->m_Route_Layer_TOP,
 frame()->GetScreen()->m_Route_Layer_BOTTOM );

 m_router->UpdateSizes( sizes );

 if( !m_router->StartRouting( m_startSnapPoint, m_startItem, routingLayer ) )
 {
 // It would make more sense to leave the net highlighted as the higher-contrast mode
 // makes the router clearances more visible. However, since we just started routing
 // the conversion of the screen from low contrast to high contrast is a bit jarring and
 // makes the infobar coming up less noticeable.
 highlightNet( false );

 frame()->ShowInfoBarError( m_router->FailureReason(), true,
 [&]()
 {
 m_router->ClearViewDecorations();
 } );

 controls()->SetAutoPan( false );
 return false;
 }

 m_endItem = nullptr;
 m_endSnapPoint = m_startSnapPoint;

 UpdateMessagePanel();
 frame()->UndoRedoBlock( true );

 return true;
}

References _, PNS::ROUTER::ClearViewDecorations(), PCB_TOOL_BASE::controls(), PNS::ROUTER::FailureReason(), PCB_TOOL_BASE::frame(), PCB_BASE_EDIT_FRAME::GetAppearancePanel(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetDesignSettings(), getStartLayer(), TOOL_BASE::getView(), PNS::TOOL_BASE::highlightNet(), PNS_KICAD_IFACE_BASE::ImportSizes(), IsCopperLayer(), PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, PNS::TOOL_BASE::m_iface, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, PNS::TOOL_BASE::m_startSnapPoint, BOARD_DESIGN_SETTINGS::m_TempOverrideTrackWidth, PNS::ITEM::Net(), EDA_DRAW_PANEL_GAL::Refresh(), PCB_EDIT_FRAME::SetActiveLayer(), KIGFX::VIEW_CONTROLS::SetAutoPan(), APPEARANCE_CONTROLS::SetLayerVisible(), PNS_KICAD_IFACE_BASE::SetStartLayer(), EDA_BASE_FRAME::ShowInfoBarError(), PNS::ROUTER::Sizes(), PNS::ROUTER::StartRouting(), ToLAYER_ID(), PCB_BASE_EDIT_FRAME::UndoRedoBlock(), UpdateMessagePanel(), and PNS::ROUTER::UpdateSizes().

Referenced by performRouting().

Reset()

void ROUTER_TOOL::Reset ( RESET_REASON  aReason )

overridevirtual

Bring 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

aReason

contains information about the reason of tool reset.

Reimplemented from PNS::TOOL_BASE.

Definition at line 495 of file router_tool.cpp.

{
 m_lastTargetLayer = UNDEFINED_LAYER;

 if( aReason == RUN )
 TOOL_BASE::Reset( aReason );
}

References m_lastTargetLayer, TOOL_BASE::Reset(), TOOL_BASE::RUN, and UNDEFINED_LAYER.

Router()

ROUTER * TOOL_BASE::Router ( ) const

inherited

Definition at line 363 of file pns_tool_base.cpp.

{
 return m_router;
}

References PNS::TOOL_BASE::m_router.

Referenced by DRAWING_TOOL::DrawVia(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

RoutingInProgress()

bool ROUTER_TOOL::RoutingInProgress

(

)

Returns whether routing is currently active.

Returns

True if actively routing, false if not routing or tool is activated and idle.

Definition at line 1336 of file router_tool.cpp.

{
 return m_router->RoutingInProgress();
}

References PNS::TOOL_BASE::m_router, and PNS::ROUTER::RoutingInProgress().

Referenced by PCB_SELECTION_TOOL::Main().

RunMainStack()

void TOOL_INTERACTIVE::RunMainStack ( std::function< void()>  aFunc )

inherited

Call a function using the main stack.

Parameters

aFunc

is the function to be calls.

Definition at line 87 of file tool_interactive.cpp.

{
 m_toolMgr->RunMainStack( this, std::move( aFunc ) );
}

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

Referenced by DRAWING_TOOL::PlaceText().

saveRouterDebugLog()

void ROUTER_TOOL::saveRouterDebugLog ( )

private

Definition at line 506 of file router_tool.cpp.

{
 auto logger = m_router->Logger();

 if( ! logger )
 return;

 wxString cwd = wxGetCwd();

 wxFileName fname_log( cwd );
 fname_log.SetName( "pns.log" );

 wxFileName fname_dump( cwd );
 fname_dump.SetName( "pns.dump" );

 wxString msg = wxString::Format( _( "Event file: %s\nBoard dump: %s" ), fname_log.GetFullPath(), fname_log.GetFullPath() );

 int rv = OKOrCancelDialog( nullptr, _("Save router log"), _("Would you like to save the router\nevent log for debugging purposes?"), msg, _("OK"), _("Cancel") );

 if( !rv )
 return;

 FILE *f = fopen( fname_log.GetFullPath().c_str(), "wb" );

 // save base router configuration (mode, etc.)
 fprintf(f, "config %d %d %d %d\n",
 m_router->Settings().Mode(),
 m_router->Settings().RemoveLoops() ? 1 : 0,
 m_router->Settings().GetFixAllSegments() ? 1 : 0,
 static_cast<int>( m_router->Settings().GetCornerMode() )
 );

 const auto& events = logger->GetEvents();

 for( auto evt : events)
 {
 fprintf( f, "event %d %d %d %s\n", evt.p.x, evt.p.y, evt.type,
 static_cast<const char*>( evt.uuid.AsString().c_str() ) );
 }

 fclose( f );

 // Export as *.kicad_pcb format, using a strategy which is specifically chosen
 // as an example on how it could also be used to send it to the system clipboard.

 PCB_PLUGIN pcb_io;

 pcb_io.Save( fname_dump.GetFullPath(), m_iface->GetBoard(), nullptr );
}

References _, Format(), PNS_KICAD_IFACE_BASE::GetBoard(), PNS::ROUTING_SETTINGS::GetCornerMode(), PNS::ROUTING_SETTINGS::GetFixAllSegments(), PNS::ROUTER::Logger(), PNS::TOOL_BASE::m_iface, PNS::TOOL_BASE::m_router, PNS::ROUTING_SETTINGS::Mode(), OKOrCancelDialog(), PNS::ROUTING_SETTINGS::RemoveLoops(), PCB_PLUGIN::Save(), and PNS::ROUTER::Settings().

Referenced by handleCommonEvents().

SelectCopperLayerPair()

int ROUTER_TOOL::SelectCopperLayerPair

(

const TOOL_EVENT &

aEvent

)

Definition at line 326 of file sel_layer.cpp.

{
 PCB_SCREEN* screen = frame()->GetScreen();

 SELECT_COPPER_LAYERS_PAIR_DIALOG dlg( frame(), frame()->GetBoard(), screen->m_Route_Layer_TOP,
 screen->m_Route_Layer_BOTTOM );

 if( dlg.ShowModal() == wxID_OK )
 {
 dlg.GetLayerPair( screen->m_Route_Layer_TOP, screen->m_Route_Layer_BOTTOM );

 // select the same layer for both layers is allowed (normal in some boards)
 // but could be a mistake. So display an info message
 if( screen->m_Route_Layer_TOP == screen->m_Route_Layer_BOTTOM )
 DisplayInfoMessage( frame(), _( "Warning: top and bottom layers are same." ) );
 }

 return 0;
}

References _, DisplayInfoMessage(), PCB_TOOL_BASE::frame(), GetBoard(), SELECT_COPPER_LAYERS_PAIR_DIALOG::GetLayerPair(), PCB_BASE_FRAME::GetScreen(), PCB_SCREEN::m_Route_Layer_BOTTOM, and PCB_SCREEN::m_Route_Layer_TOP.

Referenced by setTransitions().

selection() [1/2]

const PCB_SELECTION & PCB_TOOL_BASE::selection ( ) const

protectedinherited

Definition at line 307 of file pcb_tool_base.cpp.

{
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();

 return selTool->GetSelection();
}

References PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), and TOOL_BASE::m_toolMgr.

Referenced by AUTOPLACE_TOOL::autoplaceSelected(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), CanInlineDrag(), EDIT_TOOL::ChangeTrackWidth(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), DRC_TOOL::CrossProbe(), BOARD_INSPECTION_TOOL::CrossProbePcbToSch(), BOARD_INSPECTION_TOOL::doHideNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawZone(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), GROUP_TOOL::EnterGroup(), PAD_TOOL::EnumeratePads(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::filterSelection(), EDIT_TOOL::Flip(), DRAWING_TOOL::getSourceZoneForAction(), GROUP_TOOL::Group(), BOARD_INSPECTION_TOOL::highlightNet(), InlineBreakTrack(), InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), DRAWING_TOOL::InteractivePlaceWithPreview(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::OnSelectionChange(), PAD_TOOL::pastePadProperties(), performDragging(), performRouting(), LENGTH_TUNER_TOOL::performTuning(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), BOARD_REANNOTATE_TOOL::ReannotateDuplicatesInSelection(), GROUP_TOOL::RemoveFromGroup(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), EDIT_TOOL::Rotate(), PCB_SELECTION_TOOL::selectNet(), DRAWING_TOOL::SetAnchor(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), GROUP_TOOL::Ungroup(), PCB_CONTROL::UpdateMessagePanel(), BOARD_INSPECTION_TOOL::UpdateSelectionRatsnest(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), BOARD_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfill().

selection() [2/2]

PCB_SELECTION & PCB_TOOL_BASE::selection ( )

protectedinherited

Definition at line 315 of file pcb_tool_base.cpp.

{
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();

 return selTool->GetSelection();
}

References PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), and TOOL_BASE::m_toolMgr.

SetContextMenu()

void TOOL_INTERACTIVE::SetContextMenu ( ACTION_MENU *  aMenu, CONTEXT_MENU_TRIGGER  aTrigger = CMENU_BUTTON  )

inherited

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

Parameters

aMenu	is the menu to be assigned.
aTrigger	determines conditions upon which the context menu is activated.

Definition at line 76 of file tool_interactive.cpp.

{
 if( aMenu )
 aMenu->SetTool( this );
 else
 aTrigger = CMENU_OFF;

 m_toolMgr->ScheduleContextMenu( this, aMenu, aTrigger );
}

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

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), TOOL_MENU::ShowContextMenu(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

SetIsFootprintEditor()

void PCB_TOOL_BASE::SetIsFootprintEditor ( bool  aEnabled )

inlineinherited

Function SetIsFootprintEditor()

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

Parameters

aEnabled

decides if the mode should be enabled.

Definition at line 103 of file pcb_tool_base.h.

{ m_isFootprintEditor = aEnabled; }

References PCB_TOOL_BASE::m_isFootprintEditor.

SettingsDialog()

int ROUTER_TOOL::SettingsDialog

(

const TOOL_EVENT &

aEvent

)

Definition at line 1289 of file router_tool.cpp.

{
 DIALOG_PNS_SETTINGS settingsDlg( frame(), m_router->Settings() );

 settingsDlg.ShowModal();

 UpdateMessagePanel();

 return 0;
}

References PCB_TOOL_BASE::frame(), PNS::TOOL_BASE::m_router, PNS::ROUTER::Settings(), and UpdateMessagePanel().

Referenced by setTransitions().

setTransitions()

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_BASE.

Definition at line 2157 of file router_tool.cpp.

{
 Go( &ROUTER_TOOL::SelectCopperLayerPair, PCB_ACTIONS::selectLayerPair.MakeEvent() );

 Go( &ROUTER_TOOL::MainLoop, PCB_ACTIONS::routeSingleTrack.MakeEvent() );
 Go( &ROUTER_TOOL::MainLoop, PCB_ACTIONS::routeDiffPair.MakeEvent() );
 Go( &ROUTER_TOOL::DpDimensionsDialog, PCB_ACTIONS::routerDiffPairDialog.MakeEvent() );
 Go( &ROUTER_TOOL::SettingsDialog, PCB_ACTIONS::routerSettingsDialog.MakeEvent() );
 Go( &ROUTER_TOOL::ChangeRouterMode, PCB_ACTIONS::routerHighlightMode.MakeEvent() );
 Go( &ROUTER_TOOL::ChangeRouterMode, PCB_ACTIONS::routerShoveMode.MakeEvent() );
 Go( &ROUTER_TOOL::ChangeRouterMode, PCB_ACTIONS::routerWalkaroundMode.MakeEvent() );
 Go( &ROUTER_TOOL::CycleRouterMode, PCB_ACTIONS::cycleRouterMode.MakeEvent() );
 Go( &ROUTER_TOOL::InlineDrag, PCB_ACTIONS::routerInlineDrag.MakeEvent() );
 Go( &ROUTER_TOOL::InlineBreakTrack, PCB_ACTIONS::breakTrack.MakeEvent() );

 Go( &ROUTER_TOOL::onViaCommand, ACT_PlaceThroughVia.MakeEvent() );
 Go( &ROUTER_TOOL::onViaCommand, ACT_PlaceBlindVia.MakeEvent() );
 Go( &ROUTER_TOOL::onViaCommand, ACT_PlaceMicroVia.MakeEvent() );
 Go( &ROUTER_TOOL::onViaCommand, ACT_SelLayerAndPlaceThroughVia.MakeEvent() );
 Go( &ROUTER_TOOL::onViaCommand, ACT_SelLayerAndPlaceBlindVia.MakeEvent() );
 Go( &ROUTER_TOOL::onViaCommand, ACT_SelLayerAndPlaceMicroVia.MakeEvent() );

 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerTop.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner1.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner2.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner3.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner4.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner5.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner6.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner7.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner8.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner9.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner10.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner11.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner12.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner13.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner14.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner15.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner16.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner17.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner18.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner19.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner20.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner21.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner22.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner23.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner24.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner25.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner26.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner27.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner28.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner29.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerInner30.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerBottom.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerNext.MakeEvent() );
 Go( &ROUTER_TOOL::onLayerCommand, PCB_ACTIONS::layerPrev.MakeEvent() );

 Go( &ROUTER_TOOL::CustomTrackWidthDialog, ACT_CustomTrackWidth.MakeEvent() );
 Go( &ROUTER_TOOL::onTrackViaSizeChanged, PCB_ACTIONS::trackViaSizeChanged.MakeEvent() );
}

References ACT_CustomTrackWidth, ACT_PlaceBlindVia, ACT_PlaceMicroVia, ACT_PlaceThroughVia, ACT_SelLayerAndPlaceBlindVia, ACT_SelLayerAndPlaceMicroVia, ACT_SelLayerAndPlaceThroughVia, PCB_ACTIONS::breakTrack, ChangeRouterMode(), CustomTrackWidthDialog(), CycleRouterMode(), PCB_ACTIONS::cycleRouterMode, DpDimensionsDialog(), TOOL_INTERACTIVE::Go(), InlineBreakTrack(), InlineDrag(), 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::layerNext, PCB_ACTIONS::layerPrev, PCB_ACTIONS::layerTop, MainLoop(), TOOL_ACTION::MakeEvent(), onLayerCommand(), onTrackViaSizeChanged(), onViaCommand(), PCB_ACTIONS::routeDiffPair, PCB_ACTIONS::routerDiffPairDialog, PCB_ACTIONS::routerHighlightMode, PCB_ACTIONS::routerInlineDrag, PCB_ACTIONS::routerSettingsDialog, PCB_ACTIONS::routerShoveMode, PCB_ACTIONS::routerWalkaroundMode, PCB_ACTIONS::routeSingleTrack, SelectCopperLayerPair(), PCB_ACTIONS::selectLayerPair, SettingsDialog(), and PCB_ACTIONS::trackViaSizeChanged.

snapToItem()

const VECTOR2I TOOL_BASE::snapToItem ( ITEM *  aSnapToItem, const VECTOR2I &  aP  )

protectedinherited

Definition at line 369 of file pns_tool_base.cpp.

{
 if( !aItem || !m_iface->IsItemVisible( aItem ) )
 {
 return m_gridHelper->Align( aP );
 }

 switch( aItem->Kind() )
 {
 case ITEM::SOLID_T:
 return static_cast<SOLID*>( aItem )->Pos();

 case ITEM::VIA_T:
 return static_cast<VIA*>( aItem )->Pos();

 case ITEM::SEGMENT_T:
 case ITEM::ARC_T:
 {
 LINKED_ITEM* li = static_cast<LINKED_ITEM*>( aItem );
 VECTOR2I A = li->Anchor( 0 );
 VECTOR2I B = li->Anchor( 1 );
 SEG::ecoord w_sq = SEG::Square( li->Width() / 2 );
 SEG::ecoord distA_sq = ( aP - A ).SquaredEuclideanNorm();
 SEG::ecoord distB_sq = ( aP - B ).SquaredEuclideanNorm();

 if( distA_sq < w_sq || distB_sq < w_sq )
 {
 return ( distA_sq < distB_sq ) ? A : B;
 }
 else if( aItem->Kind() == ITEM::SEGMENT_T )
 {
 // TODO(snh): Clean this up
 SEGMENT* seg = static_cast<SEGMENT*>( li );
 return m_gridHelper->AlignToSegment( aP, seg->Seg() );
 }
 else if( aItem->Kind() == ITEM::ARC_T )
 {
 ARC* arc = static_cast<ARC*>( li );
 return m_gridHelper->AlignToArc( aP, *static_cast<const SHAPE_ARC*>( arc->Shape() ) );
 }

 break;
 }

 default:
 break;
 }

 return m_gridHelper->Align( aP );
}

References GRID_HELPER::Align(), PCB_GRID_HELPER::AlignToArc(), PCB_GRID_HELPER::AlignToSegment(), PNS::ITEM::Anchor(), PNS::ITEM::ARC_T, PNS_KICAD_IFACE::IsItemVisible(), PNS::ITEM::Kind(), PNS::TOOL_BASE::m_gridHelper, PNS::TOOL_BASE::m_iface, PNS::SEGMENT::Seg(), PNS::ITEM::SEGMENT_T, PNS::ARC::Shape(), PNS::ITEM::SOLID_T, SEG::Square(), PNS::ITEM::VIA_T, and PNS::LINKED_ITEM::Width().

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

switchLayerOnViaPlacement()

void ROUTER_TOOL::switchLayerOnViaPlacement ( )

private

Definition at line 601 of file router_tool.cpp.

{
 int al = frame()->GetActiveLayer();
 int cl = m_router->GetCurrentLayer();

 if( cl != al )
 {
 m_router->SwitchLayer( al );
 }

 OPT<int> newLayer = m_router->Sizes().PairedLayer( cl );

 if( !newLayer )
 newLayer = m_router->Sizes().GetLayerTop();

 m_router->SwitchLayer( *newLayer );
 m_lastTargetLayer = *newLayer;
}

References PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetActiveLayer(), PNS::ROUTER::GetCurrentLayer(), PNS::SIZES_SETTINGS::GetLayerTop(), m_lastTargetLayer, PNS::TOOL_BASE::m_router, PNS::SIZES_SETTINGS::PairedLayer(), PNS::ROUTER::Sizes(), and PNS::ROUTER::SwitchLayer().

Referenced by performRouting().

updateEndItem()

void TOOL_BASE::updateEndItem ( const TOOL_EVENT &  aEvent )

protectedvirtualinherited

Definition at line 303 of file pns_tool_base.cpp.

{
 int layer;
 GAL* gal = m_toolMgr->GetView()->GetGAL();

 m_gridHelper->SetUseGrid( gal->GetGridSnapping() && !aEvent.DisableGridSnapping() );
 m_gridHelper->SetSnap( !aEvent.Modifier( MD_SHIFT ) );

 controls()->ForceCursorPosition( false );
 VECTOR2I mousePos = controls()->GetMousePosition();

 if( m_router->Settings().Mode() != RM_MarkObstacles &&
 ( m_router->GetCurrentNets().empty() || m_router->GetCurrentNets().front() < 0 ) )
 {
 m_endSnapPoint = snapToItem( nullptr, mousePos );
 controls()->ForceCursorPosition( true, m_endSnapPoint );
 m_endItem = nullptr;

 return;
 }

 if( m_router->IsPlacingVia() )
 layer = -1;
 else
 layer = m_router->GetCurrentLayer();

 ITEM* endItem = nullptr;

 std::vector<int> nets = m_router->GetCurrentNets();

 for( int net : nets )
 {
 endItem = pickSingleItem( mousePos, net, layer, false, { m_startItem } );

 if( endItem )
 break;
 }

 if( m_gridHelper->GetSnap() && checkSnap( endItem ) )
 {
 m_endItem = endItem;
 m_endSnapPoint = snapToItem( endItem, mousePos );
 }
 else
 {
 m_endItem = nullptr;
 m_endSnapPoint = m_gridHelper->Align( mousePos );
 }

 controls()->ForceCursorPosition( true, m_endSnapPoint );

 if( m_endItem )
 {
 wxLogTrace( wxT( "PNS" ), wxT( "%s, layer : %d" ),
 m_endItem->KindStr().c_str(),
 m_endItem->Layers().Start() );
 }
}

References GRID_HELPER::Align(), PNS::TOOL_BASE::checkSnap(), PCB_TOOL_BASE::controls(), TOOL_EVENT::DisableGridSnapping(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PNS::ROUTER::GetCurrentLayer(), PNS::ROUTER::GetCurrentNets(), KIGFX::VIEW::GetGAL(), KIGFX::GAL::GetGridSnapping(), KIGFX::VIEW_CONTROLS::GetMousePosition(), GRID_HELPER::GetSnap(), TOOL_MANAGER::GetView(), PNS::ROUTER::IsPlacingVia(), PNS::ITEM::KindStr(), PNS::ITEM::Layers(), PNS::TOOL_BASE::m_endItem, PNS::TOOL_BASE::m_endSnapPoint, PNS::TOOL_BASE::m_gridHelper, PNS::TOOL_BASE::m_router, PNS::TOOL_BASE::m_startItem, TOOL_BASE::m_toolMgr, MD_SHIFT, PNS::ROUTING_SETTINGS::Mode(), TOOL_EVENT::Modifier(), PNS::TOOL_BASE::pickSingleItem(), PNS::RM_MarkObstacles, GRID_HELPER::SetSnap(), PNS::ROUTER::Settings(), GRID_HELPER::SetUseGrid(), PNS::TOOL_BASE::snapToItem(), and LAYER_RANGE::Start().

Referenced by handleLayerSwitch(), InlineDrag(), onTrackViaSizeChanged(), performDragging(), and performRouting().

UpdateMessagePanel()

void ROUTER_TOOL::UpdateMessagePanel

(

)

Definition at line 2076 of file router_tool.cpp.

{
 if( !m_router->RoutingInProgress() )
 {
 frame()->SetMsgPanel( board() );
 return;
 }

 std::vector<MSG_PANEL_ITEM> items;
 PNS::SIZES_SETTINGS sizes( m_router->Sizes() );
 PNS::RULE_RESOLVER* resolver = m_iface->GetRuleResolver();
 bool isDiffPair = m_router->Mode() == PNS::ROUTER_MODE::PNS_MODE_ROUTE_DIFF_PAIR;