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

ROUTER *	Router () const

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

void	SetEditModules (bool aEnabled)
	Function SetEditModules() More...

bool	EditingModules () const

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

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

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

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

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

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

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

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

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

TOOL_SETTINGS &	GetSettings ()

bool	IsToolActive () const

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

Protected Member Functions
bool	checkSnap (ITEM *aItem)

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

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

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	deleteTraces (ITEM *aStartItem, bool aWholeTrack)

void	doInteractiveItemPlacement (INTERACTIVE_PLACER_BASE *aPlacer, const wxString &aCommitMessage, int aOptions=IPO_ROTATE\|IPO_FLIP\|IPO_REPEAT)
	Helper function for performing a common interactive idiom: wait for a left click, place an item there (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc. More...

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

KIGFX::PCB_VIEW *	view () const

KIGFX::VIEW_CONTROLS *	controls () const

PCB_EDIT_FRAME *	frame () const

BOARD *	board () const

MODULE *	module () const

PCB_DISPLAY_OPTIONS *	displayOptions () const

PCB_DRAW_PANEL_GAL *	canvas () const

const SELECTION &	selection () const

SELECTION &	selection ()

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

bool	m_startHighlight
	Keeps track of whether the net was highlighted before routing. More...

ITEM *	m_endItem

VECTOR2I	m_endSnapPoint

GRID_HELPER *	m_gridHelper

PNS_KICAD_IFACE *	m_iface

ROUTER *	m_router

TOOL_MENU	m_menu
	Menu model displayed by the tool. More...

bool	m_editModules

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

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

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

TOOL_MANAGER *	m_toolMgr

TOOL_SETTINGS	m_toolSettings

Detailed Description

Definition at line 44 of file pns_tool_base.h.

Member Enumeration Documentation

◆ INTERACTIVE_PLACEMENT_OPTIONS

enum PCB_TOOL::INTERACTIVE_PLACEMENT_OPTIONS

protectedinherited

Enumerator
IPO_ROTATE
IPO_FLIP
IPO_PROPERTIES
IPO_SINGLE_CLICK
IPO_REPEAT

Definition at line 109 of file pcb_tool.h.

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

◆ RESET_REASON

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::TOOL_BASE ( const std::string & aToolName )

Definition at line 65 of file pns_tool_base.cpp.

                                                  :
     PCB_TOOL( aToolName )
 {
     m_gridHelper = nullptr;
     m_iface = nullptr;
     m_router = nullptr;
 
     m_startItem = nullptr;
     m_startLayer = 0;
     m_startHighlight = false;
 
     m_endItem = nullptr;
     m_gridHelper = nullptr;
 }

References m_endItem, m_gridHelper, m_iface, m_router, m_startHighlight, m_startItem, and m_startLayer.

◆ ~TOOL_BASE()

TOOL_BASE::~TOOL_BASE ( )

virtual

Reimplemented from TOOL_BASE.

Definition at line 81 of file pns_tool_base.cpp.

 {
     delete m_gridHelper;
     delete m_iface;
     delete m_router;
 }

References m_gridHelper, m_iface, and m_router.

Member Function Documentation

◆ Activate()

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.

 {
     m_toolMgr->InvokeTool( m_toolId );
 }

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

Referenced by AUTOPLACE_TOOL::autoplace(), PCBNEW_CONTROL::DeleteItemCursor(), EDIT_TOOL::doCopyToClipboard(), PCB_TOOL::doInteractiveItemPlacement(), 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::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EDIT_TOOL::Main(), LENGTH_TUNER_TOOL::mainLoop(), ROUTER_TOOL::mainLoop(), CVPCB_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), POINT_EDITOR::OnSelectionChange(), EDIT_TOOL::pickCopyReferencePoint(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), DRAWING_TOOL::SetAnchor(), and PCB_EDITOR_CONTROL::ShowLocalRatsnest().

◆ attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER * aManager )

protectedinherited

Function attachManager()

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

Definition at line 59 of file tool_base.cpp.

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

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

Referenced by TOOL_MANAGER::RegisterTool().

◆ board()

BOARD* PCB_TOOL::board ( ) const

inlineprotectedinherited

Definition at line 140 of file pcb_tool.h.

140 { return getModel<BOARD>(); }

◆ canvas()

PCB_DRAW_PANEL_GAL * PCB_TOOL::canvas ( ) const

protectedinherited

Definition at line 246 of file pcb_tool.cpp.

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

References PCB_TOOL::frame().

Referenced by PCBNEW_CONTROL::GraphicDisplayMode(), PCBNEW_CONTROL::HighContrastMode(), PCBNEW_CONTROL::ModuleEdgeOutlines(), PCBNEW_CONTROL::ModuleTextOutlines(), PCBNEW_CONTROL::PadDisplayMode(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), ZONE_FILLER_TOOL::SegzoneDeleteFill(), PCBNEW_CONTROL::TrackDisplayMode(), PCBNEW_CONTROL::ViaDisplayMode(), PCBNEW_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillAll(), ZONE_FILLER_TOOL::ZoneUnfill(), ZONE_FILLER_TOOL::ZoneUnfillAll(), and SELECTION_TOOL::zoomFitSelection().

◆ checkSnap()

bool TOOL_BASE::checkSnap ( ITEM * aItem )

protected

Definition at line 232 of file pns_tool_base.cpp.

 {
     bool doSnap = false;
 
     // Sync PNS engine settings with the general PCB editor options. I know the code below is awful, but...
     auto& pnss = m_router->Settings();
     const auto& gens = frame()->Settings();
 
     pnss.SetSnapToTracks( false );
     pnss.SetSnapToPads( false );
 
     if( gens.m_magneticPads == CAPTURE_CURSOR_IN_TRACK_TOOL || gens.m_magneticPads == CAPTURE_ALWAYS )
         pnss.SetSnapToPads( true );
 
     if( gens.m_magneticTracks == CAPTURE_CURSOR_IN_TRACK_TOOL || gens.m_magneticTracks == CAPTURE_ALWAYS )
         pnss.SetSnapToTracks( true );
 
     if( aItem )
     {
         if( ( aItem->OfKind( ITEM::VIA_T ) || aItem->OfKind( ITEM::SEGMENT_T ) ) && pnss.GetSnapToTracks() )
             doSnap = true;
         else if( aItem->OfKind( ITEM::SOLID_T ) && pnss.GetSnapToPads() )
             doSnap = true;
     }
 
     return doSnap;
 }

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

Referenced by updateEndItem(), and updateStartItem().

◆ controls()

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

inlineprotectedinherited

Definition at line 138 of file pcb_tool.h.

138 { return getViewControls(); }

TOOL_BASE::getViewControls

KIGFX::VIEW_CONTROLS * getViewControls() const

Function getViewControls()

Definition: tool_base.cpp:41

References TOOL_BASE::getViewControls().

Referenced by PCB_TOOL::doInteractiveItemPlacement(), MICROWAVE_TOOL::drawMicrowaveInductor(), ROUTER_TOOL::finishInteractive(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PICKER_TOOL::Main(), EDIT_TOOL::Main(), LENGTH_TUNER_TOOL::mainLoop(), EDIT_TOOL::MeasureTool(), POINT_EDITOR::OnSelectionChange(), LENGTH_TUNER_TOOL::performTuning(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), ROUTER_TOOL::prepareInteractive(), PICKER_TOOL::setControls(), POINT_EDITOR::setEditedPoint(), updateEndItem(), and updateStartItem().

◆ deleteTraces()

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

protected

Definition at line 351 of file pns_tool_base.cpp.

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

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

◆ displayOptions()

PCB_DISPLAY_OPTIONS * PCB_TOOL::displayOptions ( ) const

protectedinherited

Definition at line 241 of file pcb_tool.cpp.

 {
     return static_cast<PCB_DISPLAY_OPTIONS*>( frame()->GetDisplayOptions() );
 }

References PCB_TOOL::frame().

Referenced by PCBNEW_CONTROL::GraphicDisplayMode(), PCBNEW_CONTROL::HighContrastMode(), PCBNEW_CONTROL::ModuleEdgeOutlines(), PCBNEW_CONTROL::ModuleTextOutlines(), PCBNEW_CONTROL::PadDisplayMode(), pickSingleItem(), PCBNEW_CONTROL::TrackDisplayMode(), PCBNEW_CONTROL::ViaDisplayMode(), and PCBNEW_CONTROL::ZoneDisplayMode().

◆ doInteractiveItemPlacement()

void PCB_TOOL::doInteractiveItemPlacement	(	INTERACTIVE_PLACER_BASE *	aPlacer,
		const wxString &	aCommitMessage,
		int	aOptions = `IPO_ROTATE \| IPO_FLIP \| IPO_REPEAT`
	)

protectedinherited

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

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

Parameters

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

Definition at line 39 of file pcb_tool.cpp.

 {
     using namespace std::placeholders;
     std::unique_ptr<BOARD_ITEM> newItem;
 
     Activate();
 
     BOARD_COMMIT commit( frame() );
 
     GetManager()->RunAction( PCB_ACTIONS::selectionClear, true );
 
     // do not capture or auto-pan until we start placing an item
     controls()->ShowCursor( true );
     controls()->SetSnapping( true );
 
     // Add a VIEW_GROUP that serves as a preview for the new item
     SELECTION preview;
     view()->Add( &preview );
 
     aPlacer->m_board = board();
     aPlacer->m_frame = frame();
     aPlacer->m_modifiers = 0;
 
     if( aOptions & IPO_SINGLE_CLICK  && !( aOptions & IPO_PROPERTIES ) )
     {
         VECTOR2I cursorPos = controls()->GetCursorPosition();
 
         newItem = aPlacer->CreateItem();
 
         if( newItem )
         {
             newItem->SetPosition( wxPoint( cursorPos.x, cursorPos.y ) );
             preview.Add( newItem.get() );
         }
     }
 
     // Main loop: keep receiving events
     while( OPT_TOOL_EVENT evt = Wait() )
     {
         VECTOR2I cursorPos = controls()->GetCursorPosition();
         aPlacer->m_modifiers = evt->Modifier();
 
         if( TOOL_EVT_UTILS::IsCancelInteractive( *evt ) )
         {
             if( newItem )
             {
                 // Delete the old item and have another try
                 newItem = nullptr;
 
                 preview.Clear();
 
                 if( aOptions & IPO_SINGLE_CLICK )
                     break;
 
                 controls()->SetAutoPan( false );
                 controls()->CaptureCursor( false );
                 controls()->ShowCursor( true );
             }
             else
             {
                 break;
             }
 
             if( evt->IsActivate() )  // now finish unconditionally
                 break;
         }
         else if( evt->IsClick( BUT_LEFT ) )
         {
             if( !newItem )
             {
                 // create the item if possible
                 newItem = aPlacer->CreateItem();
 
                 // no item created, so wait for another click
                 if( !newItem  )
                     continue;
 
                 controls()->CaptureCursor( true );
                 controls()->SetAutoPan( true );
 
                 newItem->SetPosition( wxPoint( cursorPos.x, cursorPos.y ) );
 
                 preview.Add( newItem.get() );
 
                 if( newItem->Type() == PCB_MODULE_T )
                 {
                     auto module = dyn_cast<MODULE*>( newItem.get() );
 
                     // modules have more drawable parts
                     module->RunOnChildren( std::bind( &KIGFX::VIEW_GROUP::Add, &preview, _1 ) );
                 }
             }
             else
             {
                 auto oldFlags = newItem->GetFlags();
                 newItem->ClearFlags();
 
                 if( !aPlacer->PlaceItem( newItem.get(), commit ) )
                 {
                     newItem->SetFlags( oldFlags );
                     continue;
                 }
 
                 preview.Remove( newItem.get() );
 
                 if( newItem->Type() == PCB_MODULE_T )
                 {
                     auto module = dyn_cast<MODULE*>( newItem.get() );
                     module->RunOnChildren( std::bind( &KIGFX::VIEW_GROUP::Remove, &preview, _1 ) );
                 }
 
                 newItem.release();
                 commit.Push( aCommitMessage );
 
                 controls()->CaptureCursor( false );
                 controls()->SetAutoPan( false );
                 controls()->ShowCursor( true );
 
                 if( !( aOptions & IPO_REPEAT ) )
                     break;
 
                 if( aOptions & IPO_SINGLE_CLICK  && !( aOptions & IPO_PROPERTIES ) )
                 {
                     VECTOR2I pos = controls()->GetCursorPosition();
 
                     newItem = aPlacer->CreateItem();
 
                     if( newItem )
                     {
                         newItem->SetPosition( wxPoint( pos.x, pos.y ) );
                         preview.Add( newItem.get() );
                     }
                 }
             }
         }
         else if( evt->IsClick( BUT_RIGHT ) )
         {
             m_menu.ShowContextMenu();
         }
         else if( newItem && evt->Category() == TC_COMMAND )
         {
             /*
              * Handle any events that can affect the item as we move
              * it around, eg rotate and flip
              */
 
             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() );
                 view()->Update( &preview );
             }
         }
 
         else if( newItem && evt->IsMotion() )
         {
             // track the cursor
             newItem->SetPosition( wxPoint( cursorPos.x, cursorPos.y ) );
             aPlacer->SnapItem( newItem.get() );
 
             // Show a preview of the item
             view()->Update( &preview );
         }
     }
 
     view()->Remove( &preview );
 }

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

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

◆ EditingModules()

bool PCB_TOOL::EditingModules ( ) const

inlineinherited

Definition at line 102 of file pcb_tool.h.

     {
         return m_editModules;
     }

References PCB_TOOL::m_editModules.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), EDIT_TOOL::Flip(), PAD_TOOL::Init(), EDIT_TOOL::Main(), EDIT_TOOL::MeasureTool(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), and EDIT_TOOL::Rotate().

◆ evActivate()

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

protectedinherited

functions below are not yet implemented - their interface may change

◆ evButtonDown()

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

protectedinherited

◆ evButtonUp()

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

protectedinherited

◆ evClick()

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

protectedinherited

◆ evCommand() [1/2]

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

protectedinherited

◆ evCommand() [2/2]

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

protectedinherited

◆ evDrag()

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

protectedinherited

◆ evMotion()

const TOOL_EVENT TOOL_INTERACTIVE::evMotion ( )

protectedinherited

◆ frame()

PCB_EDIT_FRAME* PCB_TOOL::frame ( ) const

inlineprotectedinherited

Definition at line 139 of file pcb_tool.h.

139 { return getEditFrame<PCB_EDIT_FRAME>(); }

Referenced by POINT_EDITOR::addCorner(), MICROWAVE_TOOL::addMicrowaveFootprint(), AUTOPLACE_TOOL::autoplace(), PCB_TOOL::canvas(), EDIT_TOOL::changeTrackWidthOnClick(), checkSnap(), PCB_EDITOR_CONTROL::ClearHighlight(), PAD_TOOL::copyPadSettings(), MICROWAVE_TOOL::createInductorBetween(), MODULE_EDITOR_TOOLS::CreatePadFromShapes(), ROUTER_TOOL::CustomTrackWidthDialog(), PCB_TOOL::displayOptions(), EDIT_TOOL::doCopyToClipboard(), PCB_TOOL::doInteractiveItemPlacement(), ROUTER_TOOL::DpDimensionsDialog(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::drawZone(), MODULE_EDITOR_TOOLS::EnumeratePads(), EDIT_TOOL::ExchangeFootprints(), MODULE_EDITOR_TOOLS::ExplodePadToShapes(), ROUTER_TOOL::finishInteractive(), PAD_TOOL::Init(), EDIT_TOOL::Init(), SELECTION_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PICKER_TOOL::Main(), EDIT_TOOL::Main(), LENGTH_TUNER_TOOL::mainLoop(), ROUTER_TOOL::mainLoop(), LENGTH_TUNER_TOOL::meanderSettingsDialog(), EDIT_TOOL::MeasureTool(), POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::onViaCommand(), PCBNEW_CONTROL::PasteItemsFromClipboard(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), EDIT_TOOL::pickCopyReferencePoint(), MODULE_EDITOR_TOOLS::PlacePad(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), PAD_TOOL::pushPadSettings(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), POINT_EDITOR::removeCorner(), Reset(), ROUTER_TOOL::RouteDiffPair(), ROUTER_TOOL::RouteSingleTrace(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ROUTER_TOOL::SettingsDialog(), ROUTER_TOOL::switchLayerOnViaPlacement(), LENGTH_TUNER_TOOL::TuneDiffPair(), LENGTH_TUNER_TOOL::TuneDiffPairSkew(), LENGTH_TUNER_TOOL::TuneSingleTrace(), POINT_EDITOR::updateItem(), ZONE_FILLER_TOOL::ZoneFill(), and ZONE_FILLER_TOOL::ZoneFillAll().

◆ getEditFrame()

template<typename T >

T* TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

Function getEditFrame()

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

Definition at line 188 of file tool_base.h.

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

References TOOL_BASE::getEditFrameInt().

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

◆ GetId()

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.

     {
         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(), and TOOL_MANAGER::saveViewControls().

◆ GetManager()

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.

     {
         return m_toolMgr;
     }

References TOOL_BASE::m_toolMgr.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), ZONE_CREATE_HELPER::createNewZone(), PCB_TOOL::doInteractiveItemPlacement(), CONTEXT_MENU::getToolManager(), CONTEXT_MENU::onMenuEvent(), and ZONE_CREATE_HELPER::performZoneCutout().

◆ getModel()

template<typename T >

T* TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Function getModel()

Returns the model object if it matches the requested type.

Definition at line 199 of file tool_base.h.

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

References TOOL_BASE::getModelInt().

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

◆ GetName()

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.

     {
         return m_toolName;
     }

References TOOL_BASE::m_toolName.

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

◆ GetSettings()

TOOL_SETTINGS & TOOL_BASE::GetSettings ( )

inherited

Definition at line 77 of file tool_base.cpp.

 {
     return m_toolSettings;
 }

References TOOL_BASE::m_toolSettings.

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

◆ GetType()

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.

     {
         return m_type;
     }

References TOOL_BASE::m_type.

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

◆ getView()

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

protectedinherited

Function getView()

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

Returns: The instance of VIEW.

Definition at line 35 of file tool_base.cpp.

 {
     return m_toolMgr->GetView();
 }

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

◆ getViewControls()

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

protectedinherited

Function getViewControls()

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

Returns: The instance of VIEW_CONTROLS.

Definition at line 41 of file tool_base.cpp.

 {
     return m_toolMgr->GetViewControls();
 }

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

Referenced by POINT_EDITOR::addCorner(), PCB_TOOL::controls(), COMMON_TOOLS::CursorControl(), COMMON_TOOLS::doZoomToPreset(), MICROWAVE_TOOL::drawMicrowaveInductor(), MODULE_EDITOR_TOOLS::EnumeratePads(), SELECTION_TOOL::findMove(), PCB_EDITOR_CONTROL::HighlightNet(), PCB_EDITOR_CONTROL::HighlightNetCursor(), PICKER_TOOL::Main(), CVPCB_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), EDIT_TOOL::Main(), ROUTER_TOOL::mainLoop(), CVPCB_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), POINT_EDITOR::Reset(), DRAWING_TOOL::Reset(), CVPCB_CONTROL::ResetCoords(), GERBVIEW_CONTROL::ResetCoords(), PCBNEW_CONTROL::ResetCoords(), GERBVIEW_SELECTION_TOOL::selectCursor(), SELECTION_TOOL::selectCursor(), GERBVIEW_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), ZOOM_TOOL::selectRegion(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), POINT_EDITOR::setEditedPoint(), 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

Function Go()

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

Definition at line 135 of file tool_interactive.h.

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

References TOOL_INTERACTIVE::goInternal().

◆ highlightNet()

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

protectedvirtual

Definition at line 209 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->GetHighlightNetCode() == aNetcode );
 
         rs->SetHighlight( true, aNetcode );
     }
     else
     {
         if( !m_startHighlight )
             rs->SetHighlight( false );
 
         m_startHighlight = false;
     }
 
     getView()->UpdateAllLayersColor();
 }

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

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

◆ Init()

bool PCB_TOOL::Init ( )

overridevirtualinherited

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

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

Reimplemented from TOOL_BASE.

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

Definition at line 214 of file pcb_tool.cpp.

 {
     // A basic context manu.  Many (but not all) tools will choose to override this.
 
     auto& ctxMenu = m_menu.GetMenu();
 
     // cancel current tool goes in main context menu at the top if present
     ctxMenu.AddItem( ACTIONS::cancelInteractive, SELECTION_CONDITIONS::ShowAlways, 1 );
     ctxMenu.AddSeparator( SELECTION_CONDITIONS::ShowAlways, 1 );
 
     // Finally, add the standard zoom/grid items
     m_menu.AddStandardSubMenus( *getEditFrame<PCB_BASE_FRAME>() );
 
     return true;
 }

References CONDITIONAL_MENU::AddItem(), TOOL_MENU::AddStandardSubMenus(), ACTIONS::cancelInteractive, TOOL_MENU::GetMenu(), PCB_TOOL::m_menu, and SELECTION_CONDITIONS::ShowAlways().

◆ IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 30 of file tool_base.cpp.

 {
     return m_toolMgr->IsToolActive( m_toolId );
 }

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

◆ module()

MODULE* PCB_TOOL::module ( ) const

inlineprotectedinherited

Definition at line 141 of file pcb_tool.h.

141 { return board()->m_Modules; }

PCB_TOOL::board

BOARD * board() const

Definition: pcb_tool.h:140

BOARD::m_Modules

DLIST< MODULE > m_Modules

Definition: class_board.h:249

References PCB_TOOL::board(), and BOARD::m_Modules.

Referenced by MICROWAVE_TOOL::addMicrowaveFootprint(), PCBNEW_CONTROL::AppendBoard(), PCB_TOOL::doInteractiveItemPlacement(), SELECTION_TOOL::findMove(), PCBNEW_CONTROL::ModuleEdgeOutlines(), PCBNEW_CONTROL::ModuleTextOutlines(), PCBNEW_CONTROL::PadDisplayMode(), PCBNEW_CONTROL::PasteItemsFromClipboard(), SELECTION_TOOL::pickSmallestComponent(), PCB_EDITOR_CONTROL::PlaceModule(), PAD_TOOL::pushPadSettings(), SELECTION_TOOL::select(), SELECTION_TOOL::selectable(), and DRAWING_TOOL::SetAnchor().

◆ pickSingleItem()

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

protectedvirtual

Definition at line 113 of file pns_tool_base.cpp.

 {
     int tl = getView()->GetTopLayer();
 
     if( aLayer > 0 )
         tl = aLayer;
 
     static const int candidateCount = 5;
     ITEM* prioritized[candidateCount];
     int dist[candidateCount];
 
     for( int i = 0; i < candidateCount; i++ )
     {
         prioritized[i] = 0;
         dist[i] = std::numeric_limits<int>::max();
     }
 
     ITEM_SET candidates = m_router->QueryHoverItems( aWhere );
 
     for( ITEM* item : candidates.Items() )
     {
         if( !item->IsRoutable() )
             continue;
 
         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( item->OfKind( ITEM::SOLID_T ) && aIgnorePads )
                     continue;
 
                 int itemDist = ( item->Shape()->Centre() - aWhere ).SquaredEuclideanNorm();
 
                 if( !prioritized[2] || itemDist < dist[2] )
                 {
                     prioritized[2] = item;
                     dist[2] = itemDist;
                 }
                 if( item->Layers().Overlaps( tl ) &&  itemDist < dist[0] )
                 {
                     prioritized[0] = item;
                     dist[0] = itemDist;
                 }
             }
             else
             {
                 if( !prioritized[3] )
                     prioritized[3] = item;
                 if( item->Layers().Overlaps( tl ) )
                     prioritized[1] = item;
             }
         }
         // Allow unconnected items as last resort in RM_MarkObstacles mode
         else if ( item->Net() == 0 && m_router->Settings().Mode() == RM_MarkObstacles )
         {
             if( item->OfKind( ITEM::SOLID_T ) && aIgnorePads )
                 continue;
 
             if( item->Layers().Overlaps( tl ) )
                 prioritized[4] = item;
         }
     }
 
     ITEM* rv = NULL;
 
     for( int i = 0; i < candidateCount; i++ )
     {
         ITEM* item = prioritized[i];
 
         if( displayOptions()->m_ContrastModeDisplay )
             if( item && !item->Layers().Overlaps( tl ) )
                 item = NULL;
 
         if( item && ( aLayer < 0 || item->Layers().Overlaps( aLayer ) ) )
         {
             rv = item;
             break;
         }
     }
 
     if( rv )
     {
         wxLogTrace( "PNS", "%s, layer : %d, tl: %d", rv->KindStr().c_str(), rv->Layers().Start(), tl );
     }
 
     return rv;
 }

References PCB_TOOL::displayOptions(), dist, KIGFX::VIEW::GetTopLayer(), TOOL_BASE::getView(), i, IsCopperLayer(), PNS::ITEM_SET::Items(), PNS::ITEM::KindStr(), PNS::ITEM::Layers(), PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, m_router, max, PNS::ROUTING_SETTINGS::Mode(), 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 updateEndItem(), and updateStartItem().

◆ Reset()

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.

Reimplemented from PCB_TOOL.

Reimplemented in LENGTH_TUNER_TOOL, and ROUTER_TOOL.

Definition at line 90 of file pns_tool_base.cpp.

 {
     delete m_gridHelper;
     delete m_iface;
     delete m_router;
 
     m_iface = new PNS_KICAD_IFACE;
     m_iface->SetBoard( board() );
     m_iface->SetView( getView() );
     m_iface->SetHostTool( this );
     m_iface->SetDisplayOptions( (PCB_DISPLAY_OPTIONS*) frame()->GetDisplayOptions() );
 
     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( frame() );
 }

References PCB_TOOL::board(), PNS::ROUTER::ClearWorld(), PCB_TOOL::frame(), TOOL_BASE::getView(), PNS::ROUTER::LoadSettings(), m_gridHelper, m_iface, m_router, m_savedSettings, m_savedSizes, PNS_KICAD_IFACE::SetBoard(), PNS_KICAD_IFACE::SetDisplayOptions(), PNS_KICAD_IFACE::SetHostTool(), PNS::ROUTER::SetInterface(), PNS_KICAD_IFACE::SetView(), PNS::ROUTER::SyncWorld(), and PNS::ROUTER::UpdateSizes().

◆ Router()

ROUTER * TOOL_BASE::Router ( ) const

Definition at line 375 of file pns_tool_base.cpp.

 {
     return m_router;
 }

References m_router.

Referenced by EDIT_TOOL::Remove().

◆ RunMainStack()

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

◆ selection() [1/2]

const SELECTION & PCB_TOOL::selection ( ) const

protectedinherited

Definition at line 251 of file pcb_tool.cpp.

 {
     auto selTool = m_toolMgr->GetTool<SELECTION_TOOL>();
     const auto& selection = selTool->GetSelection();
     return selection;
 }

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

Referenced by AUTOPLACE_TOOL::autoplaceSelected(), PCB_EDITOR_CONTROL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), EDIT_TOOL::changeTrackWidthOnClick(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::CreateArray(), MODULE_EDITOR_TOOLS::CreatePadFromShapes(), PCB_EDITOR_CONTROL::CrossProbePcbToSch(), EDIT_TOOL::doCopyToClipboard(), EDIT_TOOL::Duplicate(), EDIT_TOOL::editFootprintInFpEditor(), EDIT_TOOL::ExchangeFootprints(), SELECTION_TOOL::expandSelectedConnection(), MODULE_EDITOR_TOOLS::ExplodePadToShapes(), SELECTION_TOOL::filterSelection(), EDIT_TOOL::Flip(), DRAWING_TOOL::getSourceZoneForAction(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EDIT_TOOL::Main(), EDIT_TOOL::Mirror(), PCB_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), POINT_EDITOR::OnSelectionChange(), PAD_TOOL::pastePadProperties(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EDIT_TOOL::Rotate(), ZONE_FILLER_TOOL::SegzoneDeleteFill(), SELECTION_TOOL::selectCopper(), PCB_TOOL::selection(), SELECTION_TOOL::selectNet(), PCB_EDITOR_CONTROL::UpdateSelectionRatsnest(), PCB_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), PCB_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfill().

◆ selection() [2/2]

SELECTION & PCB_TOOL::selection ( )

protectedinherited

Definition at line 258 of file pcb_tool.cpp.

 {
     auto selTool = m_toolMgr->GetTool<SELECTION_TOOL>();
     auto& selection = selTool->GetSelection();
     return selection;
 }

References TOOL_MANAGER::GetTool(), TOOL_BASE::m_toolMgr, and PCB_TOOL::selection().

◆ SetContextMenu()

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 74 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 CONTEXT_MENU::SetTool().

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

◆ SetEditModules()

void PCB_TOOL::SetEditModules ( bool aEnabled )

inlineinherited

Function SetEditModules()

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

Parameters

aEnabled decides if the mode should be enabled.

Definition at line 97 of file pcb_tool.h.

     {
         m_editModules = aEnabled;
     }

References PCB_TOOL::m_editModules.

◆ setTransitions()

void PCB_TOOL::setTransitions ( )

overrideprotectedvirtualinherited

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

It is called every time tool is reset or finished.

Implements TOOL_INTERACTIVE.

Reimplemented in DRAWING_TOOL, EDIT_TOOL, SELECTION_TOOL, PCB_EDITOR_CONTROL, PICKER_TOOL, PCBNEW_CONTROL, MODULE_EDITOR_TOOLS, POSITION_RELATIVE_TOOL, POINT_EDITOR, ZONE_FILLER_TOOL, PAD_TOOL, ROUTER_TOOL, MICROWAVE_TOOL, LENGTH_TUNER_TOOL, and AUTOPLACE_TOOL.

Definition at line 236 of file pcb_tool.cpp.

 {
 
 }

◆ snapToItem()

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

protected

Definition at line 381 of file pns_tool_base.cpp.

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

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 ROUTER_TOOL::InlineBreakTrack(), updateEndItem(), and updateStartItem().

◆ updateEndItem()

void TOOL_BASE::updateEndItem ( const TOOL_EVENT & aEvent )

protectedvirtual

Definition at line 296 of file pns_tool_base.cpp.

 {
     int layer;
     bool snapEnabled = !aEvent.Modifier( MD_SHIFT );
     m_gridHelper->SetUseGrid( !aEvent.Modifier( MD_ALT ) );
     m_gridHelper->SetSnap( snapEnabled );
 
     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( snapEnabled, 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 );
 
         if( endItem )
             break;
     }
 
     if( checkSnap( endItem ) )
     {
         m_endItem = endItem;
         m_endSnapPoint = snapToItem( snapEnabled, endItem, mousePos );
     } else {
         m_endItem = nullptr;
         m_endSnapPoint = m_gridHelper->Align( mousePos );
     }
 
     controls()->ForceCursorPosition( true, m_endSnapPoint );
 
     if( m_endItem )
     {
         wxLogTrace( "PNS", "%s, layer : %d", m_endItem->KindStr().c_str(), m_endItem->Layers().Start() );
     }
 }

References GRID_HELPER::Align(), checkSnap(), PCB_TOOL::controls(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PNS::ROUTER::GetCurrentLayer(), PNS::ROUTER::GetCurrentNets(), KIGFX::VIEW_CONTROLS::GetMousePosition(), PNS::ROUTER::IsPlacingVia(), PNS::ITEM::KindStr(), PNS::ITEM::Layers(), m_endItem, m_endSnapPoint, m_gridHelper, m_router, MD_ALT, MD_SHIFT, PNS::ROUTING_SETTINGS::Mode(), TOOL_EVENT::Modifier(), pickSingleItem(), PNS::RM_MarkObstacles, GRID_HELPER::SetSnap(), PNS::ROUTER::Settings(), GRID_HELPER::SetUseGrid(), snapToItem(), and LAYER_RANGE::Start().

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

◆ updateStartItem()

void TOOL_BASE::updateStartItem	(	const TOOL_EVENT &	aEvent,
		bool	aIgnorePads = `false`
	)

protectedvirtual

Definition at line 260 of file pns_tool_base.cpp.

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

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

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

◆ view()

KIGFX::PCB_VIEW* PCB_TOOL::view ( ) const

inlineprotectedinherited

Definition at line 137 of file pcb_tool.h.

137 { return static_cast<KIGFX::PCB_VIEW*>( getView() ); }

TOOL_BASE::getView

KIGFX::VIEW * getView() const

Function getView()

Definition: tool_base.cpp:35

References TOOL_BASE::getView().

Referenced by AUTOPLACE_TOOL::autoplace(), SELECTION_TOOL::clearSelection(), PCB_TOOL::doInteractiveItemPlacement(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawVia(), MODULE_EDITOR_TOOLS::EnumeratePads(), SELECTION_TOOL::getCollectorsGuide(), PCBNEW_CONTROL::GraphicDisplayMode(), SELECTION_TOOL::guessSelectionCandidates(), PCBNEW_CONTROL::HighContrastMode(), SELECTION_TOOL::highlight(), EDIT_TOOL::MeasureTool(), PCBNEW_CONTROL::ModuleEdgeOutlines(), PCBNEW_CONTROL::ModuleTextOutlines(), POINT_EDITOR::OnSelectionChange(), PCBNEW_CONTROL::PadDisplayMode(), PCB_EDITOR_CONTROL::PlaceTarget(), SELECTION_TOOL::Reset(), SELECTION_TOOL::select(), SELECTION_TOOL::selectable(), SELECTION_TOOL::selectMultiple(), PCBNEW_CONTROL::TrackDisplayMode(), SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unselect(), PCBNEW_CONTROL::ViaDisplayMode(), PCBNEW_CONTROL::ZoneDisplayMode(), and SELECTION_TOOL::zoomFitSelection().

◆ Wait()

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.

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

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

Referenced by PCBNEW_CONTROL::DeleteItemCursor(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PCB_TOOL::doInteractiveItemPlacement(), SELECTION_TOOL::doSelectionMenu(), 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(), ZOOM_TOOL::Main(), PICKER_TOOL::Main(), CVPCB_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), EDIT_TOOL::Main(), SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::mainLoop(), ROUTER_TOOL::mainLoop(), CVPCB_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), EDIT_TOOL::pickCopyReferencePoint(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), GERBVIEW_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ZOOM_TOOL::selectRegion(), DRAWING_TOOL::SetAnchor(), and PCB_EDITOR_CONTROL::ShowLocalRatsnest().

Member Data Documentation

◆ m_editModules

◆ m_endItem

ITEM* PNS::TOOL_BASE::m_endItem

protected

Definition at line 73 of file pns_tool_base.h.

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

◆ m_endSnapPoint

VECTOR2I PNS::TOOL_BASE::m_endSnapPoint

protected

Definition at line 74 of file pns_tool_base.h.

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

◆ m_gridHelper

GRID_HELPER* PNS::TOOL_BASE::m_gridHelper

protected

Definition at line 76 of file pns_tool_base.h.

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

◆ m_iface

PNS_KICAD_IFACE* PNS::TOOL_BASE::m_iface

protected

Definition at line 77 of file pns_tool_base.h.

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

◆ m_menu

TOOL_MENU PCB_TOOL::m_menu

protectedinherited

Menu model displayed by the tool.

Definition at line 148 of file pcb_tool.h.

Referenced by PCB_TOOL::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::drawZone(), MODULE_EDITOR_TOOLS::EnumeratePads(), DRAWING_TOOL::GetToolMenu(), DRAWING_TOOL::Init(), PCB_TOOL::Init(), PICKER_TOOL::Main(), EDIT_TOOL::MeasureTool(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), and DRAWING_TOOL::SetAnchor().

◆ m_panelItems

MSG_PANEL_ITEMS PNS::TOOL_BASE::m_panelItems

protected

Definition at line 64 of file pns_tool_base.h.

◆ m_router

ROUTER* PNS::TOOL_BASE::m_router

protected

◆ m_savedSettings

ROUTING_SETTINGS PNS::TOOL_BASE::m_savedSettings

protected

Stores routing settings between router invocations.

Definition at line 66 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().

◆ m_savedSizes

SIZES_SETTINGS PNS::TOOL_BASE::m_savedSizes

protected

Stores sizes settings between router invocations.

Definition at line 67 of file pns_tool_base.h.

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

◆ m_startHighlight

bool PNS::TOOL_BASE::m_startHighlight

protected

Keeps track of whether the net was highlighted before routing.

Definition at line 71 of file pns_tool_base.h.

Referenced by highlightNet(), and TOOL_BASE().

◆ m_startItem

ITEM* PNS::TOOL_BASE::m_startItem

protected

Definition at line 68 of file pns_tool_base.h.

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

◆ m_startLayer

int PNS::TOOL_BASE::m_startLayer

protected

Definition at line 69 of file pns_tool_base.h.

Referenced by TOOL_BASE().

◆ m_startSnapPoint

VECTOR2I PNS::TOOL_BASE::m_startSnapPoint

protected

Definition at line 70 of file pns_tool_base.h.

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

◆ m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

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

Definition at line 210 of file tool_base.h.

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

◆ m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 215 of file tool_base.h.

◆ m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Name of the tool.

Names are expected to obey the format application.ToolName (eg. pcbnew.InteractiveSelection).

Definition at line 214 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

◆ m_toolSettings

TOOL_SETTINGS TOOL_BASE::m_toolSettings

protectedinherited

Definition at line 216 of file tool_base.h.

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

◆ m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

Stores the type of the tool.

Definition at line 207 of file tool_base.h.

Referenced by TOOL_BASE::GetType().

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ INTERACTIVE_PLACEMENT_OPTIONS

◆ RESET_REASON

Constructor & Destructor Documentation

◆ TOOL_BASE()

◆ ~TOOL_BASE()

Member Function Documentation

◆ Activate()

◆ attachManager()

◆ board()

◆ canvas()

◆ checkSnap()

◆ controls()

◆ deleteTraces()

◆ displayOptions()

◆ doInteractiveItemPlacement()

◆ EditingModules()

◆ evActivate()

◆ evButtonDown()

◆ evButtonUp()

◆ evClick()

◆ evCommand() [1/2]

◆ evCommand() [2/2]

◆ evDrag()

◆ evMotion()

◆ frame()

◆ getEditFrame()

◆ GetId()

◆ GetManager()

◆ getModel()

◆ GetName()

◆ GetSettings()

◆ GetType()

◆ getView()

◆ getViewControls()

◆ Go()

◆ highlightNet()

◆ Init()

◆ IsToolActive()

◆ module()

◆ pickSingleItem()

◆ Reset()

◆ Router()

◆ RunMainStack()

◆ selection() [1/2]

◆ selection() [2/2]

◆ SetContextMenu()

◆ SetEditModules()

◆ setTransitions()

◆ snapToItem()

◆ updateEndItem()

◆ updateStartItem()

◆ view()

◆ Wait()

Member Data Documentation

◆ m_editModules

◆ m_endItem

◆ m_endSnapPoint

◆ m_gridHelper

◆ m_iface

◆ m_menu

◆ m_panelItems

◆ m_router

◆ m_savedSettings

◆ m_savedSizes

◆ m_startHighlight

◆ m_startItem

◆ m_startLayer

◆ m_startSnapPoint

◆ m_toolId

◆ m_toolMgr

◆ m_toolName

◆ m_toolSettings

◆ m_type