#include <pns_tool_base.h>

Inheritance diagram for PNS::TOOL_BASE:

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

Public Member Functions
	TOOL_BASE (const std::string &aToolName)

virtual	~TOOL_BASE ()

virtual void	Reset (RESET_REASON aReason) override
	Function Reset() Brings the tool to a known, initial state. More...

const ROUTING_SETTINGS &	PNSSettings () const

ROUTER *	Router () const

void	Activate ()
	Function Activate() Runs the tool. More...

void	SetContextMenu (CONTEXT_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
	Function SetContextMenu() More...

void	RunMainStack (std::function< void()> aFunc)
	Function RunMainStack() More...

template<class T >
void	Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
	Function Go() More...

OPT_TOOL_EVENT	Wait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
	Function Wait() More...

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

TOOL_TYPE	GetType () const
	Function GetType() Returns the type of the tool. More...

TOOL_ID	GetId () const
	Function GetId() Returns the unique identifier of the tool. More...

const std::string &	GetName () const
	Function GetName() Returns the name of the tool. More...

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

virtual void	SetTransitions ()
	Function SetTransitions() This method is meant to be overridden in order to specify handlers for events. More...

TOOL_SETTINGS &	GetSettings ()

Static Public Attributes
static TOOL_ACTION	ACT_RouterOptions

Protected Member Functions
const VECTOR2I	snapToItem (bool aEnabled, ITEM *aItem, VECTOR2I aP)

virtual ITEM *	pickSingleItem (const VECTOR2I &aWhere, int aNet=-1, int aLayer=-1)

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

virtual void	updateStartItem (TOOL_EVENT &aEvent)

virtual void	updateEndItem (const TOOL_EVENT &aEvent)

void	deleteTraces (ITEM *aStartItem, bool aWholeTrack)

const TOOL_EVENT	evActivate (std::string aToolName="")
	functions below are not yet implemented - their interface may change More...

const TOOL_EVENT	evCommand (int aCommandId=-1)

const TOOL_EVENT	evCommand (std::string aCommandStr="")

const TOOL_EVENT	evMotion ()

const TOOL_EVENT	evClick (int aButton=BUT_ANY)

const TOOL_EVENT	evDrag (int aButton=BUT_ANY)

const TOOL_EVENT	evButtonUp (int aButton=BUT_ANY)

const TOOL_EVENT	evButtonDown (int aButton=BUT_ANY)

void	attachManager (TOOL_MANAGER *aManager)
	Function attachManager() More...

KIGFX::VIEW *	getView () const
	Function getView() More...

KIGFX::VIEW_CONTROLS *	getViewControls () const
	Function getViewControls() More...

template<typename T >
T *	getEditFrame () const
	Function getEditFrame() More...

template<typename T >
T *	getModel () const
	Function getModel() More...

Protected Attributes
MSG_PANEL_ITEMS	m_panelItems

ROUTING_SETTINGS	m_savedSettings
	Stores routing settings between router invocations. More...

SIZES_SETTINGS	m_savedSizes
	Stores sizes settings between router invocations. More...

ITEM *	m_startItem

int	m_startLayer

VECTOR2I	m_startSnapPoint

ITEM *	m_endItem

VECTOR2I	m_endSnapPoint

PCB_EDIT_FRAME *	m_frame

KIGFX::VIEW_CONTROLS *	m_ctls

BOARD *	m_board

GRID_HELPER *	m_gridHelper

PNS_KICAD_IFACE *	m_iface

ROUTER *	m_router

TOOL_TYPE	m_type
	Stores the type of the tool. More...

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

std::string	m_toolName
	Name of the tool. More...

TOOL_MANAGER *	m_toolMgr

TOOL_SETTINGS	m_toolSettings

Detailed Description

Definition at line 44 of file pns_tool_base.h.

Member Enumeration Documentation

enum TOOL_BASE::RESET_REASON

inherited

Determines the reason of reset for a tool

Enumerator
RUN	Tool is invoked after being inactive.
MODEL_RELOAD	Model changes (required full reload)
GAL_SWITCH	Rendering engine changes.

Definition at line 80 of file tool_base.h.

     {
         RUN,                
         MODEL_RELOAD,       
         GAL_SWITCH          
     };

Constructor & Destructor Documentation

TOOL_BASE::TOOL_BASE ( const std::string & aToolName )

Definition at line 69 of file pns_tool_base.cpp.

References m_board, m_ctls, m_endItem, m_frame, m_gridHelper, m_iface, m_router, m_startItem, and m_startLayer.

                                                  :
     TOOL_INTERACTIVE( aToolName )
 {
     m_gridHelper = nullptr;
     m_iface = nullptr;
     m_router = nullptr;
 
     m_startItem = nullptr;
     m_startLayer = 0;
 
     m_endItem = nullptr;
 
     m_frame = nullptr;
     m_ctls = nullptr;
     m_board = nullptr;
     m_gridHelper = nullptr;
 }

TOOL_BASE::~TOOL_BASE ( )

virtual

Reimplemented from TOOL_BASE.

Definition at line 88 of file pns_tool_base.cpp.

References m_gridHelper, m_iface, and m_router.

 {
     delete m_gridHelper;
     delete m_iface;
     delete m_router;
 }

Member Function Documentation

void TOOL_INTERACTIVE::Activate ( )

inherited

Function Activate() Runs the tool.

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

Definition at line 49 of file tool_interactive.cpp.

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

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

 {
     m_toolMgr->InvokeTool( m_toolId );
 }

void TOOL_BASE::attachManager ( TOOL_MANAGER * aManager )

protectedinherited

Function attachManager()

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

Definition at line 54 of file tool_base.cpp.

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

Referenced by TOOL_MANAGER::RegisterTool().

 {
     m_toolMgr = aManager;
     m_toolSettings = TOOL_SETTINGS( this );
 }

void TOOL_BASE::deleteTraces	(	ITEM *	aStartItem,
		bool	aWholeTrack
	)

protected

Definition at line 281 of file pns_tool_base.cpp.

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

Referenced by ROUTER_TOOL::mainLoop().

 {
     NODE *node = m_router->GetWorld()->Branch();
 
     if( !aStartItem )
         return;
 
     if( !aWholeTrack )
     {
         node->Remove( aStartItem );
     }
     else
     {
         TOPOLOGY topo( node );
         ITEM_SET path = topo.AssembleTrivialPath( aStartItem );
 
         for( auto ent : path.Items() )
             node->Remove( ent.item );
     }
 
     m_router->CommitRouting( node );
 }

const TOOL_EVENT TOOL_INTERACTIVE::evActivate ( std::string aToolName = "" )

protectedinherited

functions below are not yet implemented - their interface may change

const TOOL_EVENT TOOL_INTERACTIVE::evButtonDown ( int aButton = BUT_ANY )

protectedinherited

const TOOL_EVENT TOOL_INTERACTIVE::evButtonUp ( int aButton = BUT_ANY )

protectedinherited

const TOOL_EVENT TOOL_INTERACTIVE::evClick ( int aButton = BUT_ANY )

protectedinherited

const TOOL_EVENT TOOL_INTERACTIVE::evCommand ( int aCommandId = -1 )

protectedinherited

const TOOL_EVENT TOOL_INTERACTIVE::evCommand ( std::string aCommandStr = "" )

protectedinherited

const TOOL_EVENT TOOL_INTERACTIVE::evDrag ( int aButton = BUT_ANY )

protectedinherited

const TOOL_EVENT TOOL_INTERACTIVE::evMotion ( )

protectedinherited

template<typename T >

T* TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

Function getEditFrame()

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

Definition at line 193 of file tool_base.h.

References TOOL_BASE::getEditFrameInt().

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

     {
         return static_cast<T*>( getEditFrameInt() );
     }

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

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

The identifier is set by an instance of TOOL_MANAGER.

Returns: Identifier of the tool.

Definition at line 122 of file tool_base.h.

References TOOL_BASE::m_toolId.

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

     {
         return m_toolId;
     }

TOOL_MANAGER* TOOL_BASE::GetManager ( ) const

inlineinherited

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

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

Definition at line 144 of file tool_base.h.

References TOOL_BASE::m_toolMgr.

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

     {
         return m_toolMgr;
     }

template<typename T >

T* TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Function getModel()

Returns the model object if it matches the requested type.

Definition at line 204 of file tool_base.h.

References TOOL_BASE::getModelInt().

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

     {
         EDA_ITEM* m = getModelInt();
 
         return static_cast<T*>( m );
     }

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

inlineinherited

Function GetName() Returns the name of the tool.

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

Returns: The name of the tool.

Definition at line 133 of file tool_base.h.

References TOOL_BASE::m_toolName.

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

     {
         return m_toolName;
     }

TOOL_SETTINGS & TOOL_BASE::GetSettings ( )

inherited

Definition at line 72 of file tool_base.cpp.

References TOOL_BASE::m_toolSettings.

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

 {
     return m_toolSettings;
 }

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Function GetType() Returns the type of the tool.

Returns: The type of the tool.

Definition at line 111 of file tool_base.h.

References TOOL_BASE::m_type.

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

     {
         return m_type;
     }

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

protectedinherited

Function getView()

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

Returns: The instance of VIEW.

Definition at line 30 of file tool_base.cpp.

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

Referenced by PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), PCBNEW_CONTROL::CursorControl(), SELECTION_TOOL::disambiguationMenu(), MICROWAVE_TOOL::drawMicrowaveInductor(), PCB_EDITOR_CONTROL::DrillOrigin(), MODULE_EDITOR_TOOLS::EnumeratePads(), SELECTION_TOOL::findCallback(), ROUTER_TOOL::getStartLayer(), PCBNEW_CONTROL::GridSetOrigin(), PCBNEW_CONTROL::HighContrastMode(), highlightNet(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), EDIT_TOOL::Main(), EDIT_TOOL::MeasureTool(), MODULE_EDITOR_TOOLS::ModuleEdgeOutlines(), MODULE_EDITOR_TOOLS::ModuleTextOutlines(), EDIT_TOOL::MoveExact(), POINT_EDITOR::OnSelectionChange(), PCBNEW_CONTROL::PadDisplayMode(), PCBNEW_CONTROL::PanControl(), pickSingleItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), PCB_EDITOR_CONTROL::Reset(), PCBNEW_CONTROL::Reset(), Reset(), DRAWING_TOOL::Reset(), SELECTION_TOOL::Reset(), SELECTION_TOOL::selectable(), SELECTION_TOOL::selectionContains(), SELECTION_TOOL::selectMultiple(), ZOOM_TOOL::selectRegion(), PCBNEW_CONTROL::TrackDisplayMode(), POINT_EDITOR::updateEditedPoint(), COMMON_TOOLS::updateGrid(), PCBNEW_CONTROL::updateGrid(), POINT_EDITOR::updatePoints(), SELECTION_TOOL::updateSelection(), updateStartItem(), PCBNEW_CONTROL::ViaDisplayMode(), PCB_TOOL::view(), PCBNEW_CONTROL::ZoneDisplayMode(), COMMON_TOOLS::ZoomFitScreen(), SELECTION_TOOL::zoomFitSelection(), COMMON_TOOLS::ZoomInOutCenter(), and SELECTION_TOOL::~SELECTION_TOOL().

 {
     return m_toolMgr->GetView();
 }

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

protectedinherited

Function getViewControls()

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

Returns: The instance of VIEW_CONTROLS.

Definition at line 36 of file tool_base.cpp.

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

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

 {
     return m_toolMgr->GetViewControls();
 }

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

Function Go()

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

Definition at line 122 of file tool_interactive.h.

References TOOL_INTERACTIVE::goInternal().

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

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

protectedvirtual

Definition at line 196 of file pns_tool_base.cpp.

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

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

 {
     RENDER_SETTINGS* rs = getView()->GetPainter()->GetSettings();
 
     if( aNetcode >= 0 && aEnabled )
         rs->SetHighlight( true, aNetcode );
     else
         rs->SetHighlight( false );
 
     getView()->UpdateAllLayersColor();
 }

virtual bool TOOL_BASE::Init ( )

inlinevirtualinherited

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

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

Reimplemented in SELECTION_TOOL, DRAWING_TOOL, EDIT_TOOL, POSITION_RELATIVE_TOOL, PCB_EDITOR_CONTROL, POINT_EDITOR, MICROWAVE_TOOL, PAD_TOOL, ALIGN_DISTRIBUTE_TOOL, and ROUTER_TOOL.

Definition at line 93 of file tool_base.h.

Referenced by TOOL_MANAGER::InitTools().

     {
         return true;
     }

ITEM * TOOL_BASE::pickSingleItem	(	const VECTOR2I &	aWhere,
		int	aNet = `-1`,
		int	aLayer = `-1`
	)

protectedvirtual

Definition at line 123 of file pns_tool_base.cpp.

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

Referenced by updateEndItem(), and updateStartItem().

 {
     int tl = getView()->GetTopLayer();
 
     if( aLayer > 0 )
         tl = aLayer;
 
     ITEM* prioritized[4];
 
     for( int i = 0; i < 4; i++ )
         prioritized[i] = 0;
 
     ITEM_SET candidates = m_router->QueryHoverItems( aWhere );
 
     for( ITEM* item : candidates.Items() )
     {
         if( !IsCopperLayer( item->Layers().Start() ) )
             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( !prioritized[2] )
                     prioritized[2] = item;
                 if( item->Layers().Overlaps( tl ) )
                     prioritized[0] = item;
             }
             else
             {
                 if( !prioritized[3] )
                     prioritized[3] = item;
                 if( item->Layers().Overlaps( tl ) )
                     prioritized[1] = item;
             }
         }
     }
 
     ITEM* rv = NULL;
     PCB_EDIT_FRAME* frame = getEditFrame<PCB_EDIT_FRAME>();
     DISPLAY_OPTIONS* displ_opts = (DISPLAY_OPTIONS*)frame->GetDisplayOptions();
 
     for( int i = 0; i < 4; i++ )
     {
         ITEM* item = prioritized[i];
 
         if( displ_opts->m_ContrastModeDisplay )
             if( item && !item->Layers().Overlaps( tl ) )
                 item = NULL;
 
         if( item )
         {
             rv = item;
             break;
         }
     }
 
     if( rv && aLayer >= 0 && !rv->Layers().Overlaps( aLayer ) )
         rv = NULL;
 
     if( rv )
     {
         wxLogTrace( "PNS", "%s, layer : %d, tl: %d", rv->KindStr().c_str(), rv->Layers().Start(), tl );
     }
 
     return rv;
 }

const ROUTING_SETTINGS& PNS::TOOL_BASE::PNSSettings ( ) const

inline

Definition at line 54 of file pns_tool_base.h.

Referenced by EDIT_TOOL::invokeInlineRouter().

     {
         return m_savedSettings;
     }

void TOOL_BASE::Reset ( RESET_REASON aReason )

overridevirtual

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

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

Parameters

aReason contains information about the reason of tool reset.

Implements TOOL_BASE.

Reimplemented in LENGTH_TUNER_TOOL, and ROUTER_TOOL.

Definition at line 97 of file pns_tool_base.cpp.

References PNS::ROUTER::ClearWorld(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), PNS::ROUTER::LoadSettings(), m_board, m_ctls, m_frame, m_gridHelper, m_iface, m_router, m_savedSettings, m_savedSizes, PNS_KICAD_IFACE::SetBoard(), PNS::ROUTER::SetInterface(), PNS::ROUTER::SyncWorld(), and PNS::ROUTER::UpdateSizes().

 {
     delete m_gridHelper;
     delete m_iface;
     delete m_router;
 
     m_frame = getEditFrame<PCB_EDIT_FRAME>();
     m_ctls = getViewControls();
     m_board = getModel<BOARD>();
 
     m_iface = new PNS_KICAD_IFACE;
     m_iface->SetBoard( m_board );
     m_iface->SetView( getView() );
     m_iface->SetHostFrame( m_frame );
 
     m_router = new ROUTER;
     m_router->SetInterface(m_iface);
     m_router->ClearWorld();
     m_router->SyncWorld();
     m_router->LoadSettings( m_savedSettings );
     m_router->UpdateSizes( m_savedSizes );
 
     m_gridHelper = new GRID_HELPER( m_frame );
 }

ROUTER * TOOL_BASE::Router ( ) const

Definition at line 305 of file pns_tool_base.cpp.

References m_router.

 {
     return m_router;
 }

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

inherited

Function RunMainStack()

Calls a function using the main stack.

Parameters

aFunc is the function to be calls.

Definition at line 78 of file tool_interactive.cpp.

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

Referenced by DRAWING_TOOL::PlaceText().

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

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

inherited

Function SetContextMenu()

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

Parameters

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

Definition at line 67 of file tool_interactive.cpp.

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

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

 {
     if( aMenu )
         aMenu->SetTool( this );
     else
         aTrigger = CMENU_OFF;
 
     m_toolMgr->ScheduleContextMenu( this, aMenu, aTrigger );
 }

virtual void TOOL_BASE::SetTransitions ( )

inlinevirtualinherited

Function SetTransitions() 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 in DRAWING_TOOL, SELECTION_TOOL, EDIT_TOOL, PCB_EDITOR_CONTROL, PICKER_TOOL, MODULE_EDITOR_TOOLS, POSITION_RELATIVE_TOOL, PCBNEW_CONTROL, ALIGN_DISTRIBUTE_TOOL, COMMON_TOOLS, POINT_EDITOR, MICROWAVE_TOOL, PAD_TOOL, ROUTER_TOOL, LENGTH_TUNER_TOOL, and ZOOM_TOOL.

Definition at line 154 of file tool_base.h.

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

154 {};

const VECTOR2I TOOL_BASE::snapToItem	(	bool	aEnabled,
		ITEM *	aItem,
		VECTOR2I	aP
	)

protected

Definition at line 311 of file pns_tool_base.cpp.

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

Referenced by updateEndItem(), and updateStartItem().

 {
     VECTOR2I anchor;
 
     if( !aItem || !aEnabled )
     {
         return m_gridHelper->Align( aP );
     }
 
     switch( aItem->Kind() )
     {
     case ITEM::SOLID_T:
         anchor = static_cast<SOLID*>( aItem )->Pos();
         break;
 
     case ITEM::VIA_T:
         anchor = static_cast<VIA*>( aItem )->Pos();
         break;
 
     case ITEM::SEGMENT_T:
     {
         SEGMENT* seg = static_cast<SEGMENT*>( aItem );
         const SEG& s = seg->Seg();
         int w = seg->Width();
 
 
         if( ( aP - s.A ).EuclideanNorm() < w / 2 )
             anchor = s.A;
         else if( ( aP - s.B ).EuclideanNorm() < w / 2 )
             anchor = s.B;
         else
             anchor = m_gridHelper->AlignToSegment( aP, s );
 
         break;
     }
 
     default:
         break;
     }
 
     return anchor;
 }

void TOOL_BASE::updateEndItem ( const TOOL_EVENT & aEvent )

protectedvirtual

Definition at line 237 of file pns_tool_base.cpp.

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

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

 {
     VECTOR2I p = m_ctls->GetMousePosition();
     int layer;
     bool snapEnabled = !aEvent.Modifier( MD_SHIFT );
 
     if( m_router->GetCurrentNets().empty() || m_router->GetCurrentNets().front() < 0 )
     {
         m_endSnapPoint = snapToItem( snapEnabled, nullptr, p );
         m_ctls->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( p, net, layer );
 
         if( endItem )
             break;
     }
 
     VECTOR2I cursorPos = snapToItem( snapEnabled, endItem, p );
     m_ctls->ForceCursorPosition( true, cursorPos );
     m_endItem = endItem;
     m_endSnapPoint = cursorPos;
 
     if( m_endItem )
     {
         wxLogTrace( "PNS", "%s, layer : %d", m_endItem->KindStr().c_str(), m_endItem->Layers().Start() );
     }
 }

void TOOL_BASE::updateStartItem ( TOOL_EVENT & aEvent )

protectedvirtual

Definition at line 209 of file pns_tool_base.cpp.

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

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

 {
     int tl = getView()->GetTopLayer();
     VECTOR2I cp = m_ctls->GetCursorPosition();
     VECTOR2I p;
 
     bool snapEnabled = true;
 
     if( aEvent.IsMotion() || aEvent.IsClick() )
     {
         snapEnabled = !aEvent.Modifier( MD_SHIFT );
         p = aEvent.Position();
     }
     else
     {
         p = cp;
     }
 
     m_startItem = pickSingleItem( p );
 
     if( !snapEnabled && m_startItem && !m_startItem->Layers().Overlaps( tl ) )
         m_startItem = nullptr;
 
     m_startSnapPoint = snapToItem( snapEnabled, m_startItem, p );
     m_ctls->ForceCursorPosition( true, m_startSnapPoint );
 }

OPT_TOOL_EVENT TOOL_INTERACTIVE::Wait ( const TOOL_EVENT_LIST & aEventList = TOOL_EVENT( TC_ANY, TA_ANY ) )

inherited

Function Wait()

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

Definition at line 55 of file tool_interactive.cpp.

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

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

 {
     return m_toolMgr->ScheduleWait( this, aEventList );
 }

Member Data Documentation

TOOL_ACTION TOOL_BASE::ACT_RouterOptions

static

Definition at line 47 of file pns_tool_base.h.

Referenced by ROUTER_TOOL_MENU::ROUTER_TOOL_MENU(), LENGTH_TUNER_TOOL::SetTransitions(), and ROUTER_TOOL::SetTransitions().

BOARD* PNS::TOOL_BASE::m_board

protected

Definition at line 82 of file pns_tool_base.h.

Referenced by ROUTER_TOOL::CustomTrackWidthDialog(), ROUTER_TOOL::getNetclassDimensions(), ROUTER_TOOL::onTrackViaSizeChanged(), ROUTER_TOOL::onViaCommand(), ROUTER_TOOL::prepareInteractive(), Reset(), and TOOL_BASE().

KIGFX::VIEW_CONTROLS* PNS::TOOL_BASE::m_ctls

protected

Definition at line 81 of file pns_tool_base.h.

Referenced by ROUTER_TOOL::finishInteractive(), ROUTER_TOOL::InlineDrag(), LENGTH_TUNER_TOOL::mainLoop(), ROUTER_TOOL::mainLoop(), LENGTH_TUNER_TOOL::performTuning(), ROUTER_TOOL::prepareInteractive(), Reset(), TOOL_BASE(), updateEndItem(), and updateStartItem().

ITEM* PNS::TOOL_BASE::m_endItem

protected

Definition at line 77 of file pns_tool_base.h.

Referenced by ROUTER_TOOL::InlineDrag(), ROUTER_TOOL::onViaCommand(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), ROUTER_TOOL::prepareInteractive(), TOOL_BASE(), and updateEndItem().

VECTOR2I PNS::TOOL_BASE::m_endSnapPoint

protected

Definition at line 78 of file pns_tool_base.h.

Referenced by ROUTER_TOOL::InlineDrag(), ROUTER_TOOL::onViaCommand(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), ROUTER_TOOL::prepareInteractive(), and updateEndItem().

PCB_EDIT_FRAME* PNS::TOOL_BASE::m_frame

protected

GRID_HELPER* PNS::TOOL_BASE::m_gridHelper

protected

Definition at line 83 of file pns_tool_base.h.

Referenced by Reset(), snapToItem(), TOOL_BASE(), and ~TOOL_BASE().

PNS_KICAD_IFACE* PNS::TOOL_BASE::m_iface

protected

Definition at line 84 of file pns_tool_base.h.

Referenced by Reset(), TOOL_BASE(), and ~TOOL_BASE().

MSG_PANEL_ITEMS PNS::TOOL_BASE::m_panelItems

protected

Definition at line 69 of file pns_tool_base.h.

ROUTER* PNS::TOOL_BASE::m_router

protected

ROUTING_SETTINGS PNS::TOOL_BASE::m_savedSettings

protected

Stores routing settings between router invocations.

Definition at line 71 of file pns_tool_base.h.

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

SIZES_SETTINGS PNS::TOOL_BASE::m_savedSizes

protected

Stores sizes settings between router invocations.

Definition at line 72 of file pns_tool_base.h.

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

ITEM* PNS::TOOL_BASE::m_startItem

protected

Definition at line 73 of file pns_tool_base.h.

Referenced by ROUTER_TOOL::getStartLayer(), ROUTER_TOOL::InlineDrag(), ROUTER_TOOL::mainLoop(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), ROUTER_TOOL::prepareInteractive(), TOOL_BASE(), and updateStartItem().

int PNS::TOOL_BASE::m_startLayer

protected

Definition at line 74 of file pns_tool_base.h.

Referenced by TOOL_BASE().

VECTOR2I PNS::TOOL_BASE::m_startSnapPoint

protected

Definition at line 75 of file pns_tool_base.h.

Referenced by ROUTER_TOOL::mainLoop(), ROUTER_TOOL::performDragging(), LENGTH_TUNER_TOOL::performTuning(), ROUTER_TOOL::prepareInteractive(), and updateStartItem().

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

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

Definition at line 215 of file tool_base.h.

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

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 220 of file tool_base.h.

std::string TOOL_BASE::m_toolName

protectedinherited

Name of the tool.

Names are expected to obey the format application.ToolName

(eg. pcbnew.InteractiveSelection).

Definition at line 219 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

TOOL_SETTINGS TOOL_BASE::m_toolSettings

protectedinherited

Definition at line 221 of file tool_base.h.

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

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

Stores the type of the tool.

Definition at line 212 of file tool_base.h.

Referenced by TOOL_BASE::GetType().

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation