BOARD_EDITOR_CONTROL Class Reference

Handle actions specific to the board editor in PcbNew. More...

#include <board_editor_control.h>

Inheritance diagram for BOARD_EDITOR_CONTROL:

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

Public Member Functions
	BOARD_EDITOR_CONTROL ()
	~BOARD_EDITOR_CONTROL ()
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state. More...
bool	Init () override
	Init() is called once upon a registration of the tool. More...
int	New (const TOOL_EVENT &aEvent)
int	Open (const TOOL_EVENT &aEvent)
int	Save (const TOOL_EVENT &aEvent)
int	SaveAs (const TOOL_EVENT &aEvent)
int	SaveCopyAs (const TOOL_EVENT &aEvent)
int	PageSettings (const TOOL_EVENT &aEvent)
int	Plot (const TOOL_EVENT &aEvent)
int	Find (const TOOL_EVENT &aEvent)
int	FindNext (const TOOL_EVENT &aEvent)
int	BoardSetup (const TOOL_EVENT &aEvent)
int	ImportNetlist (const TOOL_EVENT &aEvent)
int	ImportSpecctraSession (const TOOL_EVENT &aEvent)
int	ExportSpecctraDSN (const TOOL_EVENT &aEvent)
int	ExportNetlist (const TOOL_EVENT &aEvent)
int	GenerateDrillFiles (const TOOL_EVENT &aEvent)
int	GeneratePosFile (const TOOL_EVENT &aEvent)
int	GenerateFabFiles (const TOOL_EVENT &aEvent)
int	RepairBoard (const TOOL_EVENT &aEvent)
int	UpdatePCBFromSchematic (const TOOL_EVENT &aEvent)
int	UpdateSchematicFromPCB (const TOOL_EVENT &aEvent)
int	ShowEeschema (const TOOL_EVENT &aEvent)
int	ToggleLayersManager (const TOOL_EVENT &aEvent)
int	TogglePythonConsole (const TOOL_EVENT &aEvent)
int	TrackWidthInc (const TOOL_EVENT &aEvent)
int	TrackWidthDec (const TOOL_EVENT &aEvent)
int	ViaSizeInc (const TOOL_EVENT &aEvent)
int	ViaSizeDec (const TOOL_EVENT &aEvent)
int	ZoneMerge (const TOOL_EVENT &aEvent)
	Duplicate a zone onto a layer (prompts for new layer) More...
int	ZoneDuplicate (const TOOL_EVENT &aEvent)
int	EditFpInFpEditor (const TOOL_EVENT &aEvent)
int	PlaceTarget (const TOOL_EVENT &aEvent)
	Allow user to place a layer alignment target. More...
int	PlaceFootprint (const TOOL_EVENT &aEvent)
	Display a dialog to select a footprint to be added and allows the user to set its position. More...
bool	PlacingFootprint () const
	Re-entrancy checker for above. More...
int	ToggleLockSelected (const TOOL_EVENT &aEvent)
	Lock selected items. More...
int	LockSelected (const TOOL_EVENT &aEvent)
	Unlock selected items. More...
int	UnlockSelected (const TOOL_EVENT &aEvent)
	Run the drill origin tool for setting the origin for drill and pick-and-place files. More...
int	DrillOrigin (const TOOL_EVENT &aEvent)
	Low-level access (below undo) to setting the drill origin. More...
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	DoSetDrillOrigin (KIGFX::VIEW *aView, PCB_BASE_FRAME *aFrame, EDA_ITEM *aItem, const VECTOR2D &aPoint)

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
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
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 Types
enum	MODIFY_MODE { ON, OFF, TOGGLE }
	< How to modify a property for selected items. More...

Private Member Functions
int	modifyLockSelected (MODIFY_MODE aMode)
	Set up handlers for various events. More...
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events. More...

Private Attributes
PCB_EDIT_FRAME *	m_frame
bool	m_inPlaceFootprint
bool	m_placingFootprint
bool	m_inPlaceTarget
std::unique_ptr< KIGFX::ORIGIN_VIEWITEM >	m_placeOrigin

Static Private Attributes
static const int	WIDTH_STEP = 100000
	How does line width change after one -/+ key press. More...

Detailed Description

Handle actions specific to the board editor in PcbNew.

Definition at line 42 of file board_editor_control.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
 };

MODIFY_MODE

enum BOARD_EDITOR_CONTROL::MODIFY_MODE

private

< How to modify a property for selected items.

Enumerator
ON
OFF
TOGGLE

Definition at line 128 of file board_editor_control.h.

{ ON, OFF, TOGGLE };

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

BOARD_EDITOR_CONTROL()

BOARD_EDITOR_CONTROL::BOARD_EDITOR_CONTROL

(

)

Definition at line 176 of file board_editor_control.cpp.

 :
 PCB_TOOL_BASE( "pcbnew.EditorControl" ),
 m_frame( nullptr ),
 m_inPlaceFootprint( false ),
 m_placingFootprint( false ),
 m_inPlaceTarget( false )
{
 m_placeOrigin = std::make_unique<KIGFX::ORIGIN_VIEWITEM>( KIGFX::COLOR4D( 0.8, 0.0, 0.0, 1.0 ),
 KIGFX::ORIGIN_VIEWITEM::CIRCLE_CROSS );
}

References KIGFX::ORIGIN_VIEWITEM::CIRCLE_CROSS, and m_placeOrigin.

~BOARD_EDITOR_CONTROL()

BOARD_EDITOR_CONTROL::~BOARD_EDITOR_CONTROL

(

)

Definition at line 188 of file board_editor_control.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(), DrillOrigin(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridSetOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::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(), ROUTER_TOOL::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(), PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), 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(), ROUTER_TOOL::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(), 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(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::highlightNet(), ROUTER_TOOL::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(), PlaceFootprint(), PAD_TOOL::PlacePad(), PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::recombinePad(), 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(), ROUTER_TOOL::UpdateMessagePanel(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

BoardSetup()

int BOARD_EDITOR_CONTROL::BoardSetup

(

const TOOL_EVENT &

aEvent

)

Definition at line 394 of file board_editor_control.cpp.

{
 getEditFrame<PCB_EDIT_FRAME>()->ShowBoardSetupDialog();
 return 0;
}

Referenced by setTransitions().

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

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(), ROUTER_TOOL::finishInteractive(), ROUTER_TOOL::handleLayerSwitch(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), PlaceFootprint(), PlaceTarget(), ROUTER_TOOL::prepareInteractive(), PCB_PICKER_TOOL::setControls(), PCB_POINT_EDITOR::setEditedPoint(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

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(), ROUTER_TOOL::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().

DoSetDrillOrigin()

void BOARD_EDITOR_CONTROL::DoSetDrillOrigin ( KIGFX::VIEW *  aView, PCB_BASE_FRAME *  aFrame, EDA_ITEM *  aItem, const VECTOR2D &  aPoint  )

static

Definition at line 1567 of file board_editor_control.cpp.

{
 aFrame->GetDesignSettings().SetAuxOrigin( wxPoint( aPosition ) );
 originViewItem->SetPosition( (wxPoint) aPosition );
 aView->MarkDirty();
 aFrame->OnModify();
}

References PCB_BASE_FRAME::GetDesignSettings(), KIGFX::VIEW::MarkDirty(), PCB_BASE_FRAME::OnModify(), BOARD_DESIGN_SETTINGS::SetAuxOrigin(), and EDA_ITEM::SetPosition().

Referenced by DrillOrigin(), and PCB_BASE_EDIT_FRAME::PutDataInPreviousState().

DrillOrigin()

int BOARD_EDITOR_CONTROL::DrillOrigin

(

const TOOL_EVENT &

aEvent

)

Low-level access (below undo) to setting the drill origin.

Definition at line 1577 of file board_editor_control.cpp.

{
 std::string tool = aEvent.GetCommandStr().get();
 PCB_PICKER_TOOL* picker = m_toolMgr->GetTool<PCB_PICKER_TOOL>();

 // Deactivate other tools; particularly important if another PICKER is currently running
 Activate();

 picker->SetClickHandler(
 [this] ( const VECTOR2D& pt ) -> bool
 {
 m_frame->SaveCopyInUndoList( m_placeOrigin.get(), UNDO_REDO::DRILLORIGIN );
 DoSetDrillOrigin( getView(), m_frame, m_placeOrigin.get(), pt );
 return false; // drill origin is a one-shot; don't continue with tool
 } );

 m_toolMgr->RunAction( ACTIONS::pickerTool, true, &tool );

 return 0;
}

References TOOL_INTERACTIVE::Activate(), DoSetDrillOrigin(), DRILLORIGIN, TOOL_EVENT::GetCommandStr(), TOOL_MANAGER::GetTool(), TOOL_BASE::getView(), m_frame, m_placeOrigin, TOOL_BASE::m_toolMgr, ACTIONS::pickerTool, TOOL_MANAGER::RunAction(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), and PICKER_TOOL_BASE::SetClickHandler().

Referenced by setTransitions().

EditFpInFpEditor()

int BOARD_EDITOR_CONTROL::EditFpInFpEditor

(

const TOOL_EVENT &

aEvent

)

Definition at line 1535 of file board_editor_control.cpp.

{
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 const PCB_SELECTION& selection = selTool->RequestSelection( EDIT_TOOL::FootprintFilter );

 if( selection.Empty() )
 return 0;

 FOOTPRINT* fp = selection.FirstOfKind<FOOTPRINT>();

 if( !fp )
 return 0;

 PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();

 auto editor = (FOOTPRINT_EDIT_FRAME*) editFrame->Kiway().Player( FRAME_FOOTPRINT_EDITOR, true );

 if( aEvent.IsAction( &PCB_ACTIONS::editFpInFpEditor ) )
 editor->LoadFootprintFromBoard( fp );
 else if( aEvent.IsAction( &PCB_ACTIONS::editLibFpInFpEditor ) )
 editor->LoadFootprintFromLibrary( fp->GetFPID() );

 editor->Show( true );
 editor->Raise(); // Iconize( false );

 if( selection.IsHover() )
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );

 return 0;
}

References PCB_ACTIONS::editFpInFpEditor, PCB_ACTIONS::editLibFpInFpEditor, editor, SELECTION::Empty(), SELECTION::FirstOfKind(), EDIT_TOOL::FootprintFilter(), FRAME_FOOTPRINT_EDITOR, FOOTPRINT::GetFPID(), TOOL_MANAGER::GetTool(), TOOL_EVENT::IsAction(), SELECTION::IsHover(), KIWAY_HOLDER::Kiway(), TOOL_BASE::m_toolMgr, KIWAY::Player(), PCB_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), and PCB_ACTIONS::selectionClear.

Referenced by setTransitions().

ExportNetlist()

int BOARD_EDITOR_CONTROL::ExportNetlist

(

const TOOL_EVENT &

aEvent

)

Definition at line 459 of file board_editor_control.cpp.

{
 wxCHECK( m_frame, 0 );

 wxFileName fn = m_frame->Prj().GetProjectFullName();

 // Use a different file extension for the board netlist so the schematic netlist file
 // is accidentally overwritten.
 fn.SetExt( wxT( "pcb_net" ) );

 wxFileDialog dlg( m_frame, _( "Export Board Netlist" ), fn.GetPath(), fn.GetFullName(),
 _( "KiCad board netlist files" ) + AddFileExtListToFilter( { "pcb_net" } ),
 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );

 dlg.SetExtraControlCreator( &NETLIST_OPTIONS_HELPER::Create );

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

 fn = dlg.GetPath();

 if( !fn.IsDirWritable() )
 {
 wxString msg;

 msg.Printf( _( "Path `%s` is read only." ), fn.GetPath() );
 wxMessageDialog( m_frame, msg, _( "I/O Error" ), wxOK | wxCENTER | wxICON_EXCLAMATION );
 return 0;
 }

 const NETLIST_OPTIONS_HELPER* noh =
 dynamic_cast<const NETLIST_OPTIONS_HELPER*>( dlg.GetExtraControl() );
 wxCHECK( noh, 0 );

 NETLIST netlist;

 for( const FOOTPRINT* footprint : board()->Footprints() )
 {
 COMPONENT* component = new COMPONENT( footprint->GetFPID(), footprint->GetReference(),
 footprint->GetValue(), footprint->GetPath(),
 { footprint->m_Uuid } );

 for( const PAD* pad : footprint->Pads() )
 {
 const wxString& netname = pad->GetShortNetname();

 if( !netname.IsEmpty() )
 {
 component->AddNet( pad->GetNumber(), netname, pad->GetPinFunction(),
 pad->GetPinType() );
 }
 }

 netlist.AddComponent( component );
 }

 FILE_OUTPUTFORMATTER formatter( fn.GetFullPath() );

 netlist.Format( "pcb_netlist", &formatter, 0, noh->GetNetlistOptions() );

 return 0;
}

References _, AddFileExtListToFilter(), COMPONENT::AddNet(), PCB_TOOL_BASE::board(), COMPONENT, NETLIST_OPTIONS_HELPER::Create(), PCB_TOOL_BASE::footprint(), FOOTPRINT::GetFPID(), NETLIST_OPTIONS_HELPER::GetNetlistOptions(), FOOTPRINT::GetPath(), PROJECT::GetProjectFullName(), FOOTPRINT::GetReference(), FOOTPRINT::GetValue(), m_frame, EDA_ITEM::m_Uuid, netlist, pad, FOOTPRINT::Pads(), and KIWAY_HOLDER::Prj().

Referenced by setTransitions().

ExportSpecctraDSN()

int BOARD_EDITOR_CONTROL::ExportSpecctraDSN

(

const TOOL_EVENT &

aEvent

)

Definition at line 430 of file board_editor_control.cpp.

{
 wxString fullFileName = m_frame->GetLastPath( LAST_PATH_SPECCTRADSN );
 wxFileName fn;

 if( fullFileName.IsEmpty() )
 {
 fn = m_frame->GetBoard()->GetFileName();
 fn.SetExt( SpecctraDsnFileExtension );
 }
 else
 {
 fn = fullFileName;
 }

 fullFileName = wxFileSelector( _( "Specctra DSN File" ), fn.GetPath(), fn.GetFullName(),
 SpecctraDsnFileExtension, SpecctraDsnFileWildcard(),
 wxFD_SAVE | wxFD_OVERWRITE_PROMPT | wxFD_CHANGE_DIR, frame() );

 if( !fullFileName.IsEmpty() )
 {
 m_frame->SetLastPath( LAST_PATH_SPECCTRADSN, fullFileName );
 getEditFrame<PCB_EDIT_FRAME>()->ExportSpecctraFile( fullFileName );
 }

 return 0;
}

References _, PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), PCB_EDIT_FRAME::GetLastPath(), LAST_PATH_SPECCTRADSN, m_frame, PCB_EDIT_FRAME::SetLastPath(), SpecctraDsnFileExtension, and SpecctraDsnFileWildcard().

Referenced by setTransitions().

Find()

int BOARD_EDITOR_CONTROL::Find

(

const TOOL_EVENT &

aEvent

)

Definition at line 380 of file board_editor_control.cpp.

{
 m_frame->ShowFindDialog();
 return 0;
}

References m_frame, and PCB_EDIT_FRAME::ShowFindDialog().

Referenced by setTransitions().

FindNext()

int BOARD_EDITOR_CONTROL::FindNext

(

const TOOL_EVENT &

aEvent

)

Definition at line 387 of file board_editor_control.cpp.

{
 m_frame->FindNext();
 return 0;
}

References PCB_EDIT_FRAME::FindNext(), and m_frame.

Referenced by setTransitions().

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(), ExportNetlist(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), PCB_SELECTION_TOOL::hitTestDistance(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectConstraints(), PCB_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::Properties(), PAD_TOOL::pushPadSettings(), 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(), ROUTER_TOOL::CustomTrackWidthDialog(), FOOTPRINT_EDITOR_CONTROL::DeleteFootprint(), PCB_TOOL_BASE::displayOptions(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::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(), ExportSpecctraDSN(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), ROUTER_TOOL::finishInteractive(), EDIT_TOOL::Flip(), PCB_CONTROL::FlipPcbView(), GLOBAL_EDIT_TOOL::GlobalDeletions(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::HighlightItem(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), ImportSpecctraSession(), ROUTER_TOOL::Init(), SCRIPTING_TOOL::Init(), PCB_SELECTION_TOOL::Init(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_TOOL_BASE::Is45Limited(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::meanderSettingsDialog(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), GROUP_TOOL::PickNewMember(), PCB_CONTROL::placeBoardItems(), PlaceFootprint(), PlaceTarget(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::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(), ROUTER_TOOL::SelectCopperLayerPair(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), PCB_POINT_EDITOR::setEditedPoint(), ROUTER_TOOL::SettingsDialog(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), ROUTER_TOOL::switchLayerOnViaPlacement(), PCB_CONTROL::unfilledZoneCheck(), ROUTER_TOOL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), UpdateSchematicFromPCB(), ZONE_FILLER_TOOL::ZoneFill(), and ZONE_FILLER_TOOL::ZoneFillAll().

GenerateDrillFiles()

int BOARD_EDITOR_CONTROL::GenerateDrillFiles

(

const TOOL_EVENT &

aEvent

)

Definition at line 58 of file dialog_gendrill.cpp.

{
 PCB_EDIT_FRAME* editFrame = getEditFrame<PCB_EDIT_FRAME>();
 DIALOG_GENDRILL dlg( editFrame, editFrame );

 dlg.ShowModal();
 return 0;
}

Referenced by setTransitions().

GenerateFabFiles()

int BOARD_EDITOR_CONTROL::GenerateFabFiles

(

const TOOL_EVENT &

aEvent

)

Definition at line 523 of file board_editor_control.cpp.

{
 wxCommandEvent dummy;

 if( aEvent.IsAction( &PCB_ACTIONS::generateGerbers ) )
 m_frame->ToPlotter( ID_GEN_PLOT_GERBER );
 else if( aEvent.IsAction( &PCB_ACTIONS::generateReportFile ) )
 m_frame->GenFootprintsReport( dummy );
 else if( aEvent.IsAction( &PCB_ACTIONS::generateD356File ) )
 m_frame->GenD356File( dummy );
 else if( aEvent.IsAction( &PCB_ACTIONS::generateBOM ) )
 m_frame->RecreateBOMFileFromBoard( dummy );
 else
 wxFAIL_MSG( wxT( "GenerateFabFiles(): unexpected request" ) );

 return 0;
}

References dummy(), PCB_EDIT_FRAME::GenD356File(), PCB_ACTIONS::generateBOM, PCB_ACTIONS::generateD356File, PCB_ACTIONS::generateGerbers, PCB_ACTIONS::generateReportFile, PCB_EDIT_FRAME::GenFootprintsReport(), ID_GEN_PLOT_GERBER, TOOL_EVENT::IsAction(), m_frame, PCB_EDIT_FRAME::RecreateBOMFileFromBoard(), and PCB_EDIT_FRAME::ToPlotter().

Referenced by setTransitions().

GeneratePosFile()

int BOARD_EDITOR_CONTROL::GeneratePosFile

(

const TOOL_EVENT &

aEvent

)

Definition at line 516 of file gen_footprints_placefile.cpp.

{
 PCB_EDIT_FRAME* editFrame = getEditFrame<PCB_EDIT_FRAME>();
 DIALOG_GEN_FOOTPRINT_POSITION dlg( editFrame );

 dlg.ShowModal();
 return 0;
}

Referenced by setTransitions().

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

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(), 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(), DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), EE_SELECTION_TOOL::GetNode(), ROUTER_TOOL::getStartLayer(), PCB_CONTROL::GridResetOrigin(), PCB_CONTROL::GridSetOrigin(), ROUTER_TOOL::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(), ROUTER_TOOL::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(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), PlaceTarget(), ROUTER_TOOL::prepareInteractive(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), EDIT_TOOL::Remove(), 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(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), LENGTH_TUNER_TOOL::performTuning(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), PCB_CONTROL::placeBoardItems(), PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), 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(), ROUTER_TOOL::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(), 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().

ImportNetlist()

int BOARD_EDITOR_CONTROL::ImportNetlist

(

const TOOL_EVENT &

aEvent

)

Definition at line 401 of file board_editor_control.cpp.

{
 getEditFrame<PCB_EDIT_FRAME>()->InstallNetlistFrame();
 return 0;
}

Referenced by setTransitions().

ImportSpecctraSession()

int BOARD_EDITOR_CONTROL::ImportSpecctraSession

(

const TOOL_EVENT &

aEvent

)

Definition at line 408 of file board_editor_control.cpp.

{
 wxString fullFileName = frame()->GetBoard()->GetFileName();
 wxString path;
 wxString name;
 wxString ext;

 wxFileName::SplitPath( fullFileName, &path, &name, &ext );
 name += wxT( "." ) + SpecctraSessionFileExtension;

 fullFileName = wxFileSelector( _( "Specctra Session File" ), path, name,
 wxT( "." ) + SpecctraSessionFileExtension,
 SpecctraSessionFileWildcard(), wxFD_OPEN | wxFD_CHANGE_DIR,
 frame() );

 if( !fullFileName.IsEmpty() )
 getEditFrame<PCB_EDIT_FRAME>()->ImportSpecctraSession( fullFileName );

 return 0;
}

References _, PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), name, path, SpecctraSessionFileExtension, and SpecctraSessionFileWildcard().

Referenced by setTransitions().

Init()

bool BOARD_EDITOR_CONTROL::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 206 of file board_editor_control.cpp.

{
 auto activeToolCondition =
 [this]( const SELECTION& aSel )
 {
 return ( !m_frame->ToolStackIsEmpty() );
 };

 auto inactiveStateCondition =
 [this]( const SELECTION& aSel )
 {
 return ( m_frame->ToolStackIsEmpty() && aSel.Size() == 0 );
 };

 auto placeModuleCondition =
 [this]( const SELECTION& aSel )
 {
 return m_frame->IsCurrentTool( PCB_ACTIONS::placeFootprint ) && aSel.GetSize() == 0;
 };

 auto& ctxMenu = m_menu.GetMenu();

 // "Cancel" goes at the top of the context menu when a tool is active
 ctxMenu.AddItem( ACTIONS::cancelInteractive, activeToolCondition, 1 );
 ctxMenu.AddSeparator( 1 );

 // "Get and Place Footprint" should be available for Place Footprint tool
 ctxMenu.AddItem( PCB_ACTIONS::getAndPlace, placeModuleCondition, 1000 );
 ctxMenu.AddSeparator( 1000 );

 // Finally, add the standard zoom & grid items
 getEditFrame<PCB_BASE_FRAME>()->AddStandardSubMenus( m_menu );

 auto zoneMenu = std::make_shared<ZONE_CONTEXT_MENU>();
 zoneMenu->SetTool( this );

 auto lockMenu = std::make_shared<LOCK_CONTEXT_MENU>();
 lockMenu->SetTool( this );

 // Add the PCB control menus to relevant other tools

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

 if( selTool )
 {
 auto& toolMenu = selTool->GetToolMenu();
 auto& menu = toolMenu.GetMenu();

 // Add "Get and Place Footprint" when Selection tool is in an inactive state
 menu.AddItem( PCB_ACTIONS::getAndPlace, inactiveStateCondition );
 menu.AddSeparator();

 toolMenu.AddSubMenu( zoneMenu );
 toolMenu.AddSubMenu( lockMenu );

 menu.AddMenu( lockMenu.get(), SELECTION_CONDITIONS::NotEmpty, 100 );

 menu.AddMenu( zoneMenu.get(), SELECTION_CONDITIONS::OnlyType( PCB_ZONE_T ), 200 );
 }

 DRAWING_TOOL* drawingTool = m_toolMgr->GetTool<DRAWING_TOOL>();

 if( drawingTool )
 {
 auto& toolMenu = drawingTool->GetToolMenu();
 auto& menu = toolMenu.GetMenu();

 toolMenu.AddSubMenu( zoneMenu );

 // Functor to say if the PCB_EDIT_FRAME is in a given mode
 // Capture the tool pointer and tool mode by value
 auto toolActiveFunctor =
 [=]( DRAWING_TOOL::MODE aMode )
 {
 return [=]( const SELECTION& sel )
 {
 return drawingTool->GetDrawingMode() == aMode;
 };
 };

 menu.AddMenu( zoneMenu.get(), toolActiveFunctor( DRAWING_TOOL::MODE::ZONE ), 200 );
 }

 return true;
}

References CONDITIONAL_MENU::AddItem(), ACTIONS::cancelInteractive, PCB_ACTIONS::getAndPlace, DRAWING_TOOL::GetDrawingMode(), TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOL_INTERACTIVE::GetToolMenu(), TOOLS_HOLDER::IsCurrentTool(), m_frame, TOOL_INTERACTIVE::m_menu, TOOL_BASE::m_toolMgr, SELECTION_CONDITIONS::NotEmpty(), SELECTION_CONDITIONS::OnlyType(), PCB_ZONE_T, PCB_ACTIONS::placeFootprint, TOOLS_HOLDER::ToolStackIsEmpty(), and DRAWING_TOOL::ZONE.

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(), ROUTER_TOOL::handleLayerSwitch(), EDIT_TOOL::isRouterActive(), PCB_SELECTION_TOOL::Main(), TrackWidthDec(), and TrackWidthInc().

LockSelected()

int BOARD_EDITOR_CONTROL::LockSelected

(

const TOOL_EVENT &

aEvent

)

Unlock selected items.

Definition at line 1185 of file board_editor_control.cpp.

{
 return modifyLockSelected( ON );
}

References modifyLockSelected(), and ON.

Referenced by setTransitions().

modifyLockSelected()

int BOARD_EDITOR_CONTROL::modifyLockSelected ( MODIFY_MODE  aMode )

private

Set up handlers for various events.

Definition at line 1197 of file board_editor_control.cpp.

{
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 const PCB_SELECTION& selection = selTool->GetSelection();
 BOARD_COMMIT commit( m_frame );

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

 // Resolve TOGGLE mode
 if( aMode == TOGGLE )
 {
 aMode = ON;

 for( EDA_ITEM* item : selection )
 {
 BOARD_ITEM* board_item = static_cast<BOARD_ITEM*>( item );

 if( board_item->IsLocked() )
 {
 aMode = OFF;
 break;
 }
 }
 }

 bool modified = false;

 for( EDA_ITEM* item : selection )
 {
 BOARD_ITEM* board_item = static_cast<BOARD_ITEM*>( item );

 commit.Modify( board_item );

 if( aMode == ON )
 {
 modified |= !board_item->IsLocked();
 board_item->SetLocked( true );
 }
 else
 {
 modified |= board_item->IsLocked();
 board_item->SetLocked( false );
 }
 }

 if( modified )
 {
 commit.Push( aMode == ON ? _( "Lock" ) : _( "Unlock" ) );

 m_toolMgr->PostEvent( EVENTS::SelectedEvent );
 m_frame->UpdateMsgPanel();
 m_frame->OnModify();
 }

 return 0;
}

References _, SELECTION::Empty(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), BOARD_ITEM::IsLocked(), m_frame, TOOL_BASE::m_toolMgr, COMMIT::Modify(), OFF, ON, PCB_EDIT_FRAME::OnModify(), TOOL_MANAGER::PostEvent(), BOARD_COMMIT::Push(), TOOL_MANAGER::RunAction(), EVENTS::SelectedEvent, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionCursor, BOARD_ITEM::SetLocked(), TOGGLE, and EDA_DRAW_FRAME::UpdateMsgPanel().

Referenced by LockSelected(), ToggleLockSelected(), and UnlockSelected().

New()

int BOARD_EDITOR_CONTROL::New

(

const TOOL_EVENT &

aEvent

)

Definition at line 293 of file board_editor_control.cpp.

{
 m_frame->Files_io_from_id( ID_NEW_BOARD );
 return 0;
}

References PCB_EDIT_FRAME::Files_io_from_id(), ID_NEW_BOARD, and m_frame.

Referenced by setTransitions().

Open()

int BOARD_EDITOR_CONTROL::Open

(

const TOOL_EVENT &

aEvent

)

Definition at line 300 of file board_editor_control.cpp.

{
 m_frame->Files_io_from_id( ID_LOAD_FILE );
 return 0;
}

References PCB_EDIT_FRAME::Files_io_from_id(), ID_LOAD_FILE, and m_frame.

Referenced by setTransitions().

PageSettings()

int BOARD_EDITOR_CONTROL::PageSettings

(

const TOOL_EVENT &

aEvent

)

Definition at line 328 of file board_editor_control.cpp.

{
 PICKED_ITEMS_LIST undoCmd;
 DS_PROXY_UNDO_ITEM* undoItem = new DS_PROXY_UNDO_ITEM( m_frame );
 ITEM_PICKER wrapper( nullptr, undoItem, UNDO_REDO::PAGESETTINGS );

 undoCmd.PushItem( wrapper );
 m_frame->SaveCopyInUndoList( undoCmd, UNDO_REDO::PAGESETTINGS );

 DIALOG_PAGES_SETTINGS dlg( m_frame, IU_PER_MILS, wxSize( MAX_PAGE_SIZE_PCBNEW_MILS,
 MAX_PAGE_SIZE_PCBNEW_MILS ) );
 dlg.SetWksFileName( BASE_SCREEN::m_DrawingSheetFileName );

 if( dlg.ShowModal() == wxID_OK )
 {
 m_frame->GetCanvas()->GetView()->UpdateAllItemsConditionally( KIGFX::REPAINT,
 [&]( KIGFX::VIEW_ITEM* aItem ) -> bool
 {
 BOARD_ITEM* item = dynamic_cast<BOARD_ITEM*>( aItem );

 if( !item )
 return false;

 switch( item->Type() )
 {
 case PCB_TEXT_T:
 case PCB_FP_TEXT_T:
 return true; // text variables

 default:
 return false;
 }
 } );

 m_frame->OnModify();
 }
 else
 {
 m_frame->RollbackFromUndo();
 }

 return 0;
}

References PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), IU_PER_MILS, BASE_SCREEN::m_DrawingSheetFileName, m_frame, MAX_PAGE_SIZE_PCBNEW_MILS, PCB_EDIT_FRAME::OnModify(), PAGESETTINGS, PCB_FP_TEXT_T, PCB_TEXT_T, PICKED_ITEMS_LIST::PushItem(), KIGFX::REPAINT, PCB_BASE_EDIT_FRAME::RollbackFromUndo(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), DIALOG_PAGES_SETTINGS::SetWksFileName(), EDA_ITEM::Type(), and KIGFX::VIEW::UpdateAllItemsConditionally().

Referenced by setTransitions().

PlaceFootprint()

int BOARD_EDITOR_CONTROL::PlaceFootprint

(

const TOOL_EVENT &

aEvent

)

Display a dialog to select a footprint to be added and allows the user to set its position.

Definition at line 984 of file board_editor_control.cpp.

{
 if( m_inPlaceFootprint )
 return 0;

 REENTRANCY_GUARD guard( &m_inPlaceFootprint );

 FOOTPRINT* fp = aEvent.Parameter<FOOTPRINT*>();
 KIGFX::VIEW_CONTROLS* controls = getViewControls();
 BOARD_COMMIT commit( m_frame );
 BOARD* board = getModel<BOARD>();

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

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

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

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

 VECTOR2I cursorPos = controls->GetCursorPosition();
 bool reselect = false;
 bool fromOtherCommand = fp != nullptr;
 bool resetCursor = aEvent.HasPosition(); // Detect if activated from a hotkey.

 // Prime the pump
 if( fp )
 {
 m_placingFootprint = true;
 fp->SetPosition( wxPoint( cursorPos.x, cursorPos.y ) );
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, fp );
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else if( !aEvent.IsReactivate() )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::cursorClick );
 }

 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 setCursor();
 cursorPos = controls->GetCursorPosition( !evt->DisableGridSnapping() );

 if( reselect && fp )
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, fp );

 auto cleanup =
 [&] ()
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 commit.Revert();

 if( fromOtherCommand )
 {
 PICKED_ITEMS_LIST* undo = m_frame->PopCommandFromUndoList();

 if( undo )
 {
 m_frame->PutDataInPreviousState( undo );
 undo->ClearListAndDeleteItems();
 delete undo;
 }
 }

 fp = nullptr;
 m_placingFootprint = false;
 };

 if( evt->IsCancelInteractive() )
 {
 if( fp )
 {
 cleanup();
 }
 else
 {
 m_frame->PopTool( tool );
 break;
 }
 }
 else if( evt->IsActivate() )
 {
 if( fp )
 cleanup();

 if( evt->IsMoveTool() )
 {
 // leave ourselves on the stack so we come back after the move
 break;
 }
 else
 {
 frame()->PopTool( tool );
 break;
 }
 }
 else if( evt->IsClick( BUT_LEFT ) )
 {
 if( !fp )
 {
 // Pick the footprint to be placed
 fp = m_frame->SelectFootprintFromLibTree();

 if( fp == nullptr )
 continue;

 m_placingFootprint = true;

 fp->SetLink( niluuid );

 fp->SetFlags(IS_NEW ); // whatever

 // Set parent so that clearance can be loaded
 fp->SetParent( board );

 for( PAD* pad : fp->Pads() )
 {
 pad->SetLocalRatsnestVisible( m_frame->GetDisplayOptions().m_ShowGlobalRatsnest );

 // Pads in the library all have orphaned nets. Replace with Default.
 pad->SetNetCode( 0 );
 }

 // Put it on FRONT layer,
 // (Can be stored flipped if the lib is an archive built from a board)
 if( fp->IsFlipped() )
 fp->Flip( fp->GetPosition(), m_frame->Settings().m_FlipLeftRight );

 fp->SetOrientation( 0 );
 fp->SetPosition( wxPoint( cursorPos.x, cursorPos.y ) );

 commit.Add( fp );
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, fp );

 // Reset cursor to the position before the dialog opened if activated from hotkey
 if( resetCursor )
 controls->SetCursorPosition( cursorPos, false );

 // Other events must be from hotkeys or mouse clicks, so always reset cursor
 resetCursor = true;

 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 commit.Push( _( "Place a footprint" ) );
 fp = nullptr; // to indicate that there is no footprint that we currently modify
 m_placingFootprint = false;
 }
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else if( fp && ( evt->IsMotion() || evt->IsAction( &ACTIONS::refreshPreview ) ) )
 {
 fp->SetPosition( wxPoint( cursorPos.x, cursorPos.y ) );
 selection().SetReferencePoint( cursorPos );
 getView()->Update( &selection() );
 getView()->Update( fp );
 }
 else if( fp && evt->IsAction( &PCB_ACTIONS::properties ) )
 {
 // Calling 'Properties' action clears the selection, so we need to restore it
 reselect = true;
 }
 else
 {
 evt->SetPassEvent();
 }

 // Enable autopanning and cursor capture only when there is a footprint to be placed
 controls->SetAutoPan( fp != nullptr );
 controls->CaptureCursor( fp != nullptr );
 }

 controls->SetAutoPan( false );
 controls->CaptureCursor( false );
 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );

 return 0;
}

References _, TOOL_INTERACTIVE::Activate(), COMMIT::Add(), ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), PCB_TOOL_BASE::controls(), ACTIONS::cursorClick, FOOTPRINT::Flip(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), TOOL_EVENT::GetCommandStr(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), PCB_BASE_FRAME::GetDisplayOptions(), FOOTPRINT::GetPosition(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_EVENT::HasPosition(), IS_NEW, FOOTPRINT::IsFlipped(), TOOL_EVENT::IsReactivate(), PCBNEW_SETTINGS::m_FlipLeftRight, m_frame, m_inPlaceFootprint, TOOL_INTERACTIVE::m_menu, m_placingFootprint, PCB_DISPLAY_OPTIONS::m_ShowGlobalRatsnest, TOOL_BASE::m_toolMgr, niluuid, pad, FOOTPRINT::Pads(), TOOL_EVENT::Parameter(), PENCIL, EDA_BASE_FRAME::PopCommandFromUndoList(), TOOLS_HOLDER::PopTool(), PCB_ACTIONS::properties, BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), ACTIONS::refreshPreview, BOARD_COMMIT::Revert(), TOOL_MANAGER::RunAction(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItem, KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), KIGFX::VIEW_CONTROLS::SetCursorPosition(), EDA_ITEM::SetFlags(), FOOTPRINT::SetLink(), FOOTPRINT::SetOrientation(), EDA_ITEM::SetParent(), FOOTPRINT::SetPosition(), SELECTION::SetReferencePoint(), PCB_BASE_FRAME::Settings(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), undo, KIGFX::VIEW::Update(), TOOL_INTERACTIVE::Wait(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

PlaceTarget()

int BOARD_EDITOR_CONTROL::PlaceTarget

(

const TOOL_EVENT &

aEvent

)

Allow user to place a layer alignment target.

Definition at line 1256 of file board_editor_control.cpp.

{
 if( m_inPlaceTarget )
 return 0;

 REENTRANCY_GUARD guard( &m_inPlaceTarget );

 KIGFX::VIEW* view = getView();
 KIGFX::VIEW_CONTROLS* controls = getViewControls();
 BOARD* board = getModel<BOARD>();
 PCB_TARGET* target = new PCB_TARGET( board );

 // Init the new item attributes
 target->SetLayer( Edge_Cuts );
 target->SetWidth( board->GetDesignSettings().GetLineThickness( Edge_Cuts ) );
 target->SetSize( Millimeter2iu( 5 ) );
 VECTOR2I cursorPos = controls->GetCursorPosition();
 target->SetPosition( wxPoint( cursorPos.x, cursorPos.y ) );

 // Add a VIEW_GROUP that serves as a preview for the new item
 KIGFX::VIEW_GROUP preview( view );
 preview.Add( target );
 view->Add( &preview );

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

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

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

 // Set initial cursor
 setCursor();

 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 setCursor();
 cursorPos = controls->GetCursorPosition( !evt->DisableGridSnapping() );

 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->IsAction( &PCB_ACTIONS::incWidth ) )
 {
 target->SetWidth( target->GetWidth() + WIDTH_STEP );
 view->Update( &preview );
 }
 else if( evt->IsAction( &PCB_ACTIONS::decWidth ) )
 {
 int width = target->GetWidth();

 if( width > WIDTH_STEP )
 {
 target->SetWidth( width - WIDTH_STEP );
 view->Update( &preview );
 }
 }
 else if( evt->IsClick( BUT_LEFT ) )
 {
 assert( target->GetSize() > 0 );
 assert( target->GetWidth() > 0 );

 BOARD_COMMIT commit( m_frame );
 commit.Add( target );
 commit.Push( wxT( "Place a layer alignment target" ) );

 preview.Remove( target );

 // Create next PCB_TARGET
 target = new PCB_TARGET( *target );
 preview.Add( target );
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else if( evt->IsMotion() )
 {
 target->SetPosition( wxPoint( cursorPos.x, cursorPos.y ) );
 view->Update( &preview );
 }
 else
 {
 evt->SetPassEvent();
 }
 }

 preview.Clear();
 delete target;
 view->Remove( &preview );

 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );

 return 0;
}

References TOOL_INTERACTIVE::Activate(), KIGFX::PCB_VIEW::Add(), KIGFX::VIEW_GROUP::Add(), ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_GROUP::Clear(), PCB_TOOL_BASE::controls(), PCB_ACTIONS::decWidth, Edge_Cuts, PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), TOOL_EVENT::GetCommandStr(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetLineThickness(), PCB_TARGET::GetSize(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), PCB_TARGET::GetWidth(), PCB_ACTIONS::incWidth, m_frame, m_inPlaceTarget, TOOL_INTERACTIVE::m_menu, TOOL_BASE::m_toolMgr, Millimeter2iu(), TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), KIGFX::PCB_VIEW::Remove(), KIGFX::VIEW_GROUP::Remove(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, EDA_DRAW_PANEL_GAL::SetCurrentCursor(), BOARD_ITEM::SetLayer(), PCB_TARGET::SetPosition(), PCB_TARGET::SetSize(), PCB_TARGET::SetWidth(), TOOL_MENU::ShowContextMenu(), KIGFX::PCB_VIEW::Update(), PCB_TOOL_BASE::view(), TOOL_INTERACTIVE::Wait(), WIDTH_STEP, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

PlacingFootprint()

bool BOARD_EDITOR_CONTROL::PlacingFootprint ( ) const

inline

Re-entrancy checker for above.

Toggle 'lock' property for selected items.

Definition at line 108 of file board_editor_control.h.

References m_placingFootprint.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

Plot()

int BOARD_EDITOR_CONTROL::Plot

(

const TOOL_EVENT &

aEvent

)

Definition at line 373 of file board_editor_control.cpp.

{
 m_frame->ToPlotter( ID_GEN_PLOT );
 return 0;
}

References ID_GEN_PLOT, m_frame, and PCB_EDIT_FRAME::ToPlotter().

Referenced by setTransitions().

RepairBoard()

int BOARD_EDITOR_CONTROL::RepairBoard

(

const TOOL_EVENT &

aEvent

)

Definition at line 542 of file board_editor_control.cpp.

{
 int errors = 0;
 wxString details;
 bool quiet = aEvent.Parameter<bool>();

 // Repair duplicate IDs and missing nets.
 std::set<KIID> ids;
 int duplicates = 0;

 auto processItem =
 [&]( EDA_ITEM* aItem )
 {
 if( ids.count( aItem->m_Uuid ) )
 {
 duplicates++;
 const_cast<KIID&>( aItem->m_Uuid ) = KIID();
 }

 ids.insert( aItem->m_Uuid );

 BOARD_CONNECTED_ITEM* cItem = dynamic_cast<BOARD_CONNECTED_ITEM*>( aItem );

 if( cItem && cItem->GetNetCode() )
 {
 NETINFO_ITEM* netinfo = cItem->GetNet();

 if( netinfo && !board()->FindNet( netinfo->GetNetname() ) )
 {
 board()->Add( netinfo );

 details += wxString::Format( _( "Orphaned net %s re-parented.\n" ),
 netinfo->GetNetname() );
 errors++;
 }
 }
 };

 // Footprint IDs are the most important, so give them the first crack at "claiming" a
 // particular KIID.

 for( FOOTPRINT* footprint : board()->Footprints() )
 processItem( footprint );

 // After that the principal use is for DRC marker pointers, which are most likely to pads
 // or tracks.

 for( FOOTPRINT* footprint : board()->Footprints() )
 {
 for( PAD* pad : footprint->Pads() )
 processItem( pad );
 }

 for( PCB_TRACK* track : board()->Tracks() )
 processItem( track );

 // From here out I don't think order matters much.

 for( FOOTPRINT* footprint : board()->Footprints() )
 {
 processItem( &footprint->Reference() );
 processItem( &footprint->Value() );

 for( BOARD_ITEM* item : footprint->GraphicalItems() )
 processItem( item );

 for( ZONE* zone : footprint->Zones() )
 processItem( zone );

 for( PCB_GROUP* group : footprint->Groups() )
 processItem( group );
 }

 for( BOARD_ITEM* drawing : board()->Drawings() )
 processItem( drawing );

 for( ZONE* zone : board()->Zones() )
 processItem( zone );

 for( PCB_MARKER* marker : board()->Markers() )
 processItem( marker );

 for( PCB_GROUP* group : board()->Groups() )
 processItem( group );

 if( duplicates )
 {
 errors += duplicates;
 details += wxString::Format( _( "%d duplicate IDs replaced.\n" ), duplicates );
 }

 /*******************************
 * Your test here
 */

 /*******************************
 * Inform the user
 */

 if( errors )
 {
 m_frame->OnModify();

 wxString msg = wxString::Format( _( "%d potential problems repaired." ), errors );

 if( !quiet )
 DisplayInfoMessage( m_frame, msg, details );
 }
 else if( !quiet )
 {
 DisplayInfoMessage( m_frame, _( "No board problems found." ) );
 }

 return 0;
}

References _, BOARD::Add(), PCB_TOOL_BASE::board(), DisplayInfoMessage(), BOARD::Drawings(), PCB_TOOL_BASE::footprint(), BOARD::Footprints(), Format(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetCode(), NETINFO_ITEM::GetNetname(), FOOTPRINT::GraphicalItems(), group, FOOTPRINT::Groups(), BOARD::Groups(), m_frame, BOARD::Markers(), PCB_EDIT_FRAME::OnModify(), pad, FOOTPRINT::Pads(), TOOL_EVENT::Parameter(), FOOTPRINT::Reference(), BOARD::Tracks(), FOOTPRINT::Value(), FOOTPRINT::Zones(), and BOARD::Zones().

Referenced by setTransitions().

Reset()

void BOARD_EDITOR_CONTROL::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 PCB_TOOL_BASE.

Definition at line 193 of file board_editor_control.cpp.

{
 m_frame = getEditFrame<PCB_EDIT_FRAME>();

 if( aReason == MODEL_RELOAD || aReason == GAL_SWITCH )
 {
 m_placeOrigin->SetPosition( getModel<BOARD>()->GetDesignSettings().GetAuxOrigin() );
 getView()->Remove( m_placeOrigin.get() );
 getView()->Add( m_placeOrigin.get() );
 }
}

References KIGFX::VIEW::Add(), TOOL_BASE::GAL_SWITCH, TOOL_BASE::getView(), m_frame, m_placeOrigin, TOOL_BASE::MODEL_RELOAD, and KIGFX::VIEW::Remove().

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

Save()

int BOARD_EDITOR_CONTROL::Save

(

const TOOL_EVENT &

aEvent

)

Definition at line 307 of file board_editor_control.cpp.

{
 m_frame->Files_io_from_id( ID_SAVE_BOARD );
 return 0;
}

References PCB_EDIT_FRAME::Files_io_from_id(), ID_SAVE_BOARD, and m_frame.

Referenced by setTransitions().

SaveAs()

int BOARD_EDITOR_CONTROL::SaveAs

(

const TOOL_EVENT &

aEvent

)

Definition at line 314 of file board_editor_control.cpp.

{
 m_frame->Files_io_from_id( ID_SAVE_BOARD_AS );
 return 0;
}

References PCB_EDIT_FRAME::Files_io_from_id(), ID_SAVE_BOARD_AS, and m_frame.

Referenced by setTransitions().

SaveCopyAs()

int BOARD_EDITOR_CONTROL::SaveCopyAs

(

const TOOL_EVENT &

aEvent

)

Definition at line 321 of file board_editor_control.cpp.

{
 m_frame->Files_io_from_id( ID_COPY_BOARD_AS );
 return 0;
}

References PCB_EDIT_FRAME::Files_io_from_id(), ID_COPY_BOARD_AS, and m_frame.

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(), ROUTER_TOOL::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(), 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(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), DRAWING_TOOL::InteractivePlaceWithPreview(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), EDIT_TOOL::Mirror(), modifyLockSelected(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::OnSelectionChange(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), PCB_CONTROL::placeBoardItems(), PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), 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(), TrackWidthDec(), TrackWidthInc(), GROUP_TOOL::Ungroup(), PCB_CONTROL::UpdateMessagePanel(), BOARD_INSPECTION_TOOL::UpdateSelectionRatsnest(), ViaSizeDec(), ViaSizeInc(), ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), 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.

setTransitions()

void BOARD_EDITOR_CONTROL::setTransitions ( )

overrideprivatevirtual

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 1599 of file board_editor_control.cpp.

{
 Go( &BOARD_EDITOR_CONTROL::New, ACTIONS::doNew.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::Open, ACTIONS::open.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::Save, ACTIONS::save.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::SaveAs, ACTIONS::saveAs.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::SaveCopyAs, ACTIONS::saveCopyAs.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::PageSettings, ACTIONS::pageSettings.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::Plot, ACTIONS::plot.MakeEvent() );

 Go( &BOARD_EDITOR_CONTROL::Find, ACTIONS::find.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::FindNext, ACTIONS::findNext.MakeEvent() );

 Go( &BOARD_EDITOR_CONTROL::BoardSetup, PCB_ACTIONS::boardSetup.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::ImportNetlist, PCB_ACTIONS::importNetlist.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::ImportSpecctraSession,
 PCB_ACTIONS::importSpecctraSession.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::ExportSpecctraDSN, PCB_ACTIONS::exportSpecctraDSN.MakeEvent() );

 if( ADVANCED_CFG::GetCfg().m_ShowPcbnewExportNetlist && m_frame &&
 m_frame->GetExportNetlistAction() )
 Go( &BOARD_EDITOR_CONTROL::ExportNetlist, m_frame->GetExportNetlistAction()->MakeEvent() );

 Go( &BOARD_EDITOR_CONTROL::GenerateDrillFiles,
 PCB_ACTIONS::generateDrillFiles.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::GenerateFabFiles, PCB_ACTIONS::generateGerbers.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::GeneratePosFile, PCB_ACTIONS::generatePosFile.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::GenerateFabFiles,
 PCB_ACTIONS::generateReportFile.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::GenerateFabFiles, PCB_ACTIONS::generateD356File.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::GenerateFabFiles, PCB_ACTIONS::generateBOM.MakeEvent() );

 // Track & via size control
 Go( &BOARD_EDITOR_CONTROL::TrackWidthInc, PCB_ACTIONS::trackWidthInc.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::TrackWidthDec, PCB_ACTIONS::trackWidthDec.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::ViaSizeInc, PCB_ACTIONS::viaSizeInc.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::ViaSizeDec, PCB_ACTIONS::viaSizeDec.MakeEvent() );

 // Zone actions
 Go( &BOARD_EDITOR_CONTROL::ZoneMerge, PCB_ACTIONS::zoneMerge.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::ZoneDuplicate, PCB_ACTIONS::zoneDuplicate.MakeEvent() );

 // Placing tools
 Go( &BOARD_EDITOR_CONTROL::PlaceTarget, PCB_ACTIONS::placeTarget.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::PlaceFootprint, PCB_ACTIONS::placeFootprint.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::DrillOrigin, PCB_ACTIONS::drillOrigin.MakeEvent() );

 Go( &BOARD_EDITOR_CONTROL::EditFpInFpEditor, PCB_ACTIONS::editFpInFpEditor.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::EditFpInFpEditor, PCB_ACTIONS::editLibFpInFpEditor.MakeEvent() );

 // Other
 Go( &BOARD_EDITOR_CONTROL::ToggleLockSelected, PCB_ACTIONS::toggleLock.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::LockSelected, PCB_ACTIONS::lock.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::UnlockSelected, PCB_ACTIONS::unlock.MakeEvent() );

 Go( &BOARD_EDITOR_CONTROL::UpdatePCBFromSchematic,
 ACTIONS::updatePcbFromSchematic.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB,
 ACTIONS::updateSchematicFromPcb.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::ShowEeschema, PCB_ACTIONS::showEeschema.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::ToggleLayersManager, PCB_ACTIONS::showLayersManager.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::TogglePythonConsole, PCB_ACTIONS::showPythonConsole.MakeEvent() );
 Go( &BOARD_EDITOR_CONTROL::RepairBoard, PCB_ACTIONS::repairBoard.MakeEvent() );
}

References BoardSetup(), PCB_ACTIONS::boardSetup, ACTIONS::doNew, DrillOrigin(), PCB_ACTIONS::drillOrigin, EditFpInFpEditor(), PCB_ACTIONS::editFpInFpEditor, PCB_ACTIONS::editLibFpInFpEditor, ExportNetlist(), ExportSpecctraDSN(), PCB_ACTIONS::exportSpecctraDSN, Find(), ACTIONS::find, FindNext(), ACTIONS::findNext, PCB_ACTIONS::generateBOM, PCB_ACTIONS::generateD356File, GenerateDrillFiles(), PCB_ACTIONS::generateDrillFiles, GenerateFabFiles(), PCB_ACTIONS::generateGerbers, GeneratePosFile(), PCB_ACTIONS::generatePosFile, PCB_ACTIONS::generateReportFile, ADVANCED_CFG::GetCfg(), PCB_EDIT_FRAME::GetExportNetlistAction(), TOOL_INTERACTIVE::Go(), ImportNetlist(), PCB_ACTIONS::importNetlist, ImportSpecctraSession(), PCB_ACTIONS::importSpecctraSession, PCB_ACTIONS::lock, LockSelected(), m_frame, TOOL_ACTION::MakeEvent(), New(), ACTIONS::open, Open(), ACTIONS::pageSettings, PageSettings(), PlaceFootprint(), PCB_ACTIONS::placeFootprint, PlaceTarget(), PCB_ACTIONS::placeTarget, ACTIONS::plot, Plot(), RepairBoard(), PCB_ACTIONS::repairBoard, ACTIONS::save, Save(), ACTIONS::saveAs, SaveAs(), ACTIONS::saveCopyAs, SaveCopyAs(), ShowEeschema(), PCB_ACTIONS::showEeschema, PCB_ACTIONS::showLayersManager, PCB_ACTIONS::showPythonConsole, ToggleLayersManager(), PCB_ACTIONS::toggleLock, ToggleLockSelected(), TogglePythonConsole(), TrackWidthDec(), PCB_ACTIONS::trackWidthDec, TrackWidthInc(), PCB_ACTIONS::trackWidthInc, PCB_ACTIONS::unlock, UnlockSelected(), UpdatePCBFromSchematic(), ACTIONS::updatePcbFromSchematic, UpdateSchematicFromPCB(), ACTIONS::updateSchematicFromPcb, ViaSizeDec(), PCB_ACTIONS::viaSizeDec, ViaSizeInc(), PCB_ACTIONS::viaSizeInc, ZoneDuplicate(), PCB_ACTIONS::zoneDuplicate, ZoneMerge(), and PCB_ACTIONS::zoneMerge.

ShowEeschema()

int BOARD_EDITOR_CONTROL::ShowEeschema

(

const TOOL_EVENT &

aEvent

)

Definition at line 696 of file board_editor_control.cpp.

{
 m_frame->RunEeschema();
 return 0;
}

References m_frame, and PCB_EDIT_FRAME::RunEeschema().

Referenced by setTransitions().

ToggleLayersManager()

int BOARD_EDITOR_CONTROL::ToggleLayersManager

(

const TOOL_EVENT &

aEvent

)

Definition at line 703 of file board_editor_control.cpp.

{
 getEditFrame<PCB_EDIT_FRAME>()->ToggleLayersManager();
 return 0;
}

Referenced by setTransitions().

ToggleLockSelected()

int BOARD_EDITOR_CONTROL::ToggleLockSelected

(

const TOOL_EVENT &

aEvent

)

Lock selected items.

Definition at line 1179 of file board_editor_control.cpp.

{
 return modifyLockSelected( TOGGLE );
}

References modifyLockSelected(), and TOGGLE.

Referenced by setTransitions().

TogglePythonConsole()

int BOARD_EDITOR_CONTROL::TogglePythonConsole

(

const TOOL_EVENT &

aEvent

)

Definition at line 710 of file board_editor_control.cpp.

{
 m_frame->ScriptingConsoleEnableDisable();
 return 0;
}

References m_frame, and EDA_DRAW_FRAME::ScriptingConsoleEnableDisable().

Referenced by setTransitions().

TrackWidthDec()

int BOARD_EDITOR_CONTROL::TrackWidthDec

(

const TOOL_EVENT &

aEvent

)

Definition at line 798 of file board_editor_control.cpp.

{
 BOARD_DESIGN_SETTINGS& designSettings = getModel<BOARD>()->GetDesignSettings();
 constexpr KICAD_T types[] = { PCB_TRACE_T, PCB_VIA_T, EOT };
 PCB_SELECTION& selection = m_toolMgr->GetTool<PCB_SELECTION_TOOL>()->GetSelection();

 if( m_frame->ToolStackIsEmpty() && SELECTION_CONDITIONS::OnlyTypes( types )( selection ) )
 {
 BOARD_COMMIT commit( this );

 for( EDA_ITEM* item : selection )
 {
 if( item->Type() == PCB_TRACE_T )
 {
 PCB_TRACK* track = static_cast<PCB_TRACK*>( item );

 // Note: skip first entry which is the current netclass value
 for( int i = designSettings.m_TrackWidthList.size() - 1; i >= 1; --i )
 {
 int candidate = designSettings.m_TrackWidthList[ i ];

 if( candidate < track->GetWidth() )
 {
 commit.Modify( track );
 track->SetWidth( candidate );
 break;
 }
 }
 }
 }

 commit.Push( wxT( "Decrease Track Width" ) );
 return 0;
 }

 ROUTER_TOOL* routerTool = m_toolMgr->GetTool<ROUTER_TOOL>();

 if( routerTool && routerTool->IsToolActive()
 && routerTool->Router()->Mode() == PNS::PNS_MODE_ROUTE_DIFF_PAIR )
 {
 int widthIndex = designSettings.GetDiffPairIndex() - 1;

 // If we get to the lowest entry start over at the highest
 if( widthIndex < 0 )
 widthIndex = designSettings.m_DiffPairDimensionsList.size() - 1;

 designSettings.SetDiffPairIndex( widthIndex );
 designSettings.UseCustomDiffPairDimensions( false );

 m_toolMgr->RunAction( PCB_ACTIONS::trackViaSizeChanged, true );
 }
 else
 {
 int widthIndex = designSettings.GetTrackWidthIndex();

 if( routerTool && routerTool->IsToolActive()
 && routerTool->Router()->GetState() == PNS::ROUTER::RouterState::ROUTE_TRACK
 && designSettings.m_UseConnectedTrackWidth && !designSettings.m_TempOverrideTrackWidth )
 {
 designSettings.m_TempOverrideTrackWidth = true;
 }
 else
 {
 widthIndex--;
 }

 // If we get to the lowest entry start over at the highest
 if( widthIndex < 0 )
 widthIndex = designSettings.m_TrackWidthList.size() - 1;

 designSettings.SetTrackWidthIndex( widthIndex );
 designSettings.UseCustomTrackViaSize( false );

 m_toolMgr->RunAction( PCB_ACTIONS::trackViaSizeChanged, true );
 }

 return 0;
}

References EOT, BOARD_DESIGN_SETTINGS::GetDiffPairIndex(), PNS::ROUTER::GetState(), TOOL_MANAGER::GetTool(), BOARD_DESIGN_SETTINGS::GetTrackWidthIndex(), TOOL_BASE::IsToolActive(), BOARD_DESIGN_SETTINGS::m_DiffPairDimensionsList, m_frame, BOARD_DESIGN_SETTINGS::m_TempOverrideTrackWidth, TOOL_BASE::m_toolMgr, BOARD_DESIGN_SETTINGS::m_TrackWidthList, BOARD_DESIGN_SETTINGS::m_UseConnectedTrackWidth, PNS::ROUTER::Mode(), COMMIT::Modify(), SELECTION_CONDITIONS::OnlyTypes(), PCB_TRACE_T, PCB_VIA_T, PNS::PNS_MODE_ROUTE_DIFF_PAIR, BOARD_COMMIT::Push(), PNS::TOOL_BASE::Router(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), BOARD_DESIGN_SETTINGS::SetDiffPairIndex(), BOARD_DESIGN_SETTINGS::SetTrackWidthIndex(), PCB_TRACK::SetWidth(), TOOLS_HOLDER::ToolStackIsEmpty(), PCB_ACTIONS::trackViaSizeChanged, BOARD_DESIGN_SETTINGS::UseCustomDiffPairDimensions(), and BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize().

Referenced by setTransitions().

TrackWidthInc()

int BOARD_EDITOR_CONTROL::TrackWidthInc

(

const TOOL_EVENT &

aEvent

)

Definition at line 718 of file board_editor_control.cpp.

{
 BOARD_DESIGN_SETTINGS& designSettings = getModel<BOARD>()->GetDesignSettings();
 constexpr KICAD_T types[] = { PCB_TRACE_T, PCB_VIA_T, EOT };
 PCB_SELECTION& selection = m_toolMgr->GetTool<PCB_SELECTION_TOOL>()->GetSelection();

 if( m_frame->ToolStackIsEmpty() && SELECTION_CONDITIONS::OnlyTypes( types )( selection ) )
 {
 BOARD_COMMIT commit( this );

 for( EDA_ITEM* item : selection )
 {
 if( item->Type() == PCB_TRACE_T )
 {
 PCB_TRACK* track = static_cast<PCB_TRACK*>( item );

 // Note: skip first entry which is the current netclass value
 for( int i = 1; i < (int) designSettings.m_TrackWidthList.size(); ++i )
 {
 int candidate = designSettings.m_TrackWidthList[ i ];

 if( candidate > track->GetWidth() )
 {
 commit.Modify( track );
 track->SetWidth( candidate );
 break;
 }
 }
 }
 }

 commit.Push( wxT( "Increase Track Width" ) );
 return 0;
 }

 ROUTER_TOOL* routerTool = m_toolMgr->GetTool<ROUTER_TOOL>();

 if( routerTool && routerTool->IsToolActive()
 && routerTool->Router()->Mode() == PNS::PNS_MODE_ROUTE_DIFF_PAIR )
 {
 int widthIndex = designSettings.GetDiffPairIndex() + 1;

 // If we go past the last track width entry in the list, start over at the beginning
 if( widthIndex >= (int) designSettings.m_DiffPairDimensionsList.size() )
 widthIndex = 0;

 designSettings.SetDiffPairIndex( widthIndex );
 designSettings.UseCustomDiffPairDimensions( false );

 m_toolMgr->RunAction( PCB_ACTIONS::trackViaSizeChanged, true );
 }
 else
 {
 int widthIndex = designSettings.GetTrackWidthIndex();

 if( routerTool && routerTool->IsToolActive()
 && routerTool->Router()->GetState() == PNS::ROUTER::RouterState::ROUTE_TRACK
 && designSettings.m_UseConnectedTrackWidth && !designSettings.m_TempOverrideTrackWidth )
 {
 designSettings.m_TempOverrideTrackWidth = true;
 }
 else
 {
 widthIndex++;
 }

 // If we go past the last track width entry in the list, start over at the beginning
 if( widthIndex >= (int) designSettings.m_TrackWidthList.size() )
 widthIndex = 0;

 designSettings.SetTrackWidthIndex( widthIndex );
 designSettings.UseCustomTrackViaSize( false );

 m_toolMgr->RunAction( PCB_ACTIONS::trackViaSizeChanged, true );
 }

 return 0;
}

References EOT, BOARD_DESIGN_SETTINGS::GetDiffPairIndex(), PNS::ROUTER::GetState(), TOOL_MANAGER::GetTool(), BOARD_DESIGN_SETTINGS::GetTrackWidthIndex(), PCB_TRACK::GetWidth(), TOOL_BASE::IsToolActive(), BOARD_DESIGN_SETTINGS::m_DiffPairDimensionsList, m_frame, BOARD_DESIGN_SETTINGS::m_TempOverrideTrackWidth, TOOL_BASE::m_toolMgr, BOARD_DESIGN_SETTINGS::m_TrackWidthList, BOARD_DESIGN_SETTINGS::m_UseConnectedTrackWidth, PNS::ROUTER::Mode(), COMMIT::Modify(), SELECTION_CONDITIONS::OnlyTypes(), PCB_TRACE_T, PCB_VIA_T, PNS::PNS_MODE_ROUTE_DIFF_PAIR, BOARD_COMMIT::Push(), PNS::TOOL_BASE::Router(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), BOARD_DESIGN_SETTINGS::SetDiffPairIndex(), BOARD_DESIGN_SETTINGS::SetTrackWidthIndex(), PCB_TRACK::SetWidth(), TOOLS_HOLDER::ToolStackIsEmpty(), PCB_ACTIONS::trackViaSizeChanged, BOARD_DESIGN_SETTINGS::UseCustomDiffPairDimensions(), and BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize().

Referenced by setTransitions().

UnlockSelected()

int BOARD_EDITOR_CONTROL::UnlockSelected

(

const TOOL_EVENT &

aEvent

)

Run the drill origin tool for setting the origin for drill and pick-and-place files.

Definition at line 1191 of file board_editor_control.cpp.

{
 return modifyLockSelected( OFF );
}

References modifyLockSelected(), and OFF.

Referenced by setTransitions().

UpdatePCBFromSchematic()

int BOARD_EDITOR_CONTROL::UpdatePCBFromSchematic

(

const TOOL_EVENT &

aEvent

)

Definition at line 659 of file board_editor_control.cpp.

{
 NETLIST netlist;

 if( m_frame->FetchNetlistFromSchematic( netlist, _( "Updating PCB requires a fully annotated "
 "schematic." ) ) )
 {
 DIALOG_UPDATE_PCB updateDialog( m_frame, &netlist );
 updateDialog.ShowModal();
 }

 return 0;
}

References _, PCB_EDIT_FRAME::FetchNetlistFromSchematic(), m_frame, and netlist.

Referenced by setTransitions().

UpdateSchematicFromPCB()

int BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB

(

const TOOL_EVENT &

aEvent

)

Definition at line 673 of file board_editor_control.cpp.

{
 if( Kiface().IsSingle() )
 {
 DisplayErrorMessage( m_frame, _( "Cannot update schematic because Pcbnew is opened in "
 "stand-alone mode. In order to create or update PCBs "
 "from schematics, you must launch the KiCad project "
 "manager and create a project." ) );
 return 0;
 }

 m_frame->RunEeschema();
 KIWAY_PLAYER* frame = m_frame->Kiway().Player( FRAME_SCH, false );

 if( frame )
 {
 std::string payload;
 m_frame->Kiway().ExpressMail( FRAME_SCH, MAIL_SCH_UPDATE, payload, m_frame );
 }
 return 0;
}

References _, DisplayErrorMessage(), KIWAY::ExpressMail(), PCB_TOOL_BASE::frame(), FRAME_SCH, Kiface(), KIWAY_HOLDER::Kiway(), m_frame, MAIL_SCH_UPDATE, KIWAY::Player(), and PCB_EDIT_FRAME::RunEeschema().

Referenced by setTransitions().

ViaSizeDec()

int BOARD_EDITOR_CONTROL::ViaSizeDec

(

const TOOL_EVENT &

aEvent

)

Definition at line 927 of file board_editor_control.cpp.

{
 BOARD_DESIGN_SETTINGS& designSettings = getModel<BOARD>()->GetDesignSettings();
 constexpr KICAD_T types[] = { PCB_TRACE_T, PCB_VIA_T, EOT };
 PCB_SELECTION& selection = m_toolMgr->GetTool<PCB_SELECTION_TOOL>()->GetSelection();

 if( m_frame->ToolStackIsEmpty() && SELECTION_CONDITIONS::OnlyTypes( types )( selection ) )
 {
 BOARD_COMMIT commit( this );

 for( EDA_ITEM* item : selection )
 {
 if( item->Type() == PCB_VIA_T )
 {
 PCB_VIA* via = static_cast<PCB_VIA*>( item );

 for( int i = designSettings.m_ViasDimensionsList.size() - 1; i >= 0; --i )
 {
 VIA_DIMENSION candidate = designSettings.m_ViasDimensionsList[ i ];

 if( candidate.m_Diameter < via->GetWidth() )
 {
 commit.Modify( via );
 via->SetWidth( candidate.m_Diameter );
 via->SetDrill( candidate.m_Drill );
 break;
 }
 }
 }
 }

 commit.Push( "Decrease Via Size" );
 }
 else
 {
 int sizeIndex = 0; // Assume we only have a single via size entry

 // If there are more, cycle through them backwards
 if( designSettings.m_ViasDimensionsList.size() > 0 )
 {
 sizeIndex = designSettings.GetViaSizeIndex() - 1;

 // If we get to the lowest entry start over at the highest
 if( sizeIndex < 0 )
 sizeIndex = designSettings.m_ViasDimensionsList.size() - 1;
 }

 designSettings.SetViaSizeIndex( sizeIndex );
 designSettings.UseCustomTrackViaSize( false );

 m_toolMgr->RunAction( PCB_ACTIONS::trackViaSizeChanged, true );
 }

 return 0;
}

References EOT, TOOL_MANAGER::GetTool(), BOARD_DESIGN_SETTINGS::GetViaSizeIndex(), VIA_DIMENSION::m_Diameter, VIA_DIMENSION::m_Drill, m_frame, TOOL_BASE::m_toolMgr, BOARD_DESIGN_SETTINGS::m_ViasDimensionsList, COMMIT::Modify(), SELECTION_CONDITIONS::OnlyTypes(), PCB_TRACE_T, PCB_VIA_T, BOARD_COMMIT::Push(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), BOARD_DESIGN_SETTINGS::SetViaSizeIndex(), TOOLS_HOLDER::ToolStackIsEmpty(), PCB_ACTIONS::trackViaSizeChanged, BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize(), and via.

Referenced by setTransitions().

ViaSizeInc()

int BOARD_EDITOR_CONTROL::ViaSizeInc

(

const TOOL_EVENT &

aEvent

)

Definition at line 878 of file board_editor_control.cpp.

{
 BOARD_DESIGN_SETTINGS& designSettings = getModel<BOARD>()->GetDesignSettings();
 constexpr KICAD_T types[] = { PCB_TRACE_T, PCB_VIA_T, EOT };
 PCB_SELECTION& selection = m_toolMgr->GetTool<PCB_SELECTION_TOOL>()->GetSelection();

 if( m_frame->ToolStackIsEmpty() && SELECTION_CONDITIONS::OnlyTypes( types )( selection ) )
 {
 BOARD_COMMIT commit( this );

 for( EDA_ITEM* item : selection )
 {
 if( item->Type() == PCB_VIA_T )
 {
 PCB_VIA* via = static_cast<PCB_VIA*>( item );

 for( VIA_DIMENSION candidate : designSettings.m_ViasDimensionsList )
 {
 if( candidate.m_Diameter > via->GetWidth() )
 {
 commit.Modify( via );
 via->SetWidth( candidate.m_Diameter );
 via->SetDrill( candidate.m_Drill );
 break;
 }
 }
 }
 }

 commit.Push( wxT( "Increase Via Size" ) );
 }
 else
 {
 int sizeIndex = designSettings.GetViaSizeIndex() + 1;

 // If we go past the last via entry in the list, start over at the beginning
 if( sizeIndex >= (int) designSettings.m_ViasDimensionsList.size() )
 sizeIndex = 0;

 designSettings.SetViaSizeIndex( sizeIndex );
 designSettings.UseCustomTrackViaSize( false );

 m_toolMgr->RunAction( PCB_ACTIONS::trackViaSizeChanged, true );
 }

 return 0;
}

References EOT, TOOL_MANAGER::GetTool(), BOARD_DESIGN_SETTINGS::GetViaSizeIndex(), VIA_DIMENSION::m_Diameter, VIA_DIMENSION::m_Drill, m_frame, TOOL_BASE::m_toolMgr, BOARD_DESIGN_SETTINGS::m_ViasDimensionsList, COMMIT::Modify(), SELECTION_CONDITIONS::OnlyTypes(), PCB_TRACE_T, PCB_VIA_T, BOARD_COMMIT::Push(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), BOARD_DESIGN_SETTINGS::SetViaSizeIndex(), TOOLS_HOLDER::ToolStackIsEmpty(), PCB_ACTIONS::trackViaSizeChanged, BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize(), and via.

Referenced by setTransitions().

view()

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

inlineprotectedinherited

Definition at line 150 of file pcb_tool_base.h.

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

References TOOL_BASE::getView().

Referenced by AUTOPLACE_TOOL::autoplace(), PCB_SELECTION_TOOL::ClearSelection(), PCB_TOOL_BASE::doInteractiveItemPlacement(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawVia(), PCB_CONTROL::FlipPcbView(), PCB_SELECTION_TOOL::getCollectorsGuide(), ROUTER_TOOL::handleLayerSwitch(), PCB_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), BOARD_INSPECTION_TOOL::highlightNet(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), PlaceTarget(), PCB_SELECTION_TOOL::Reset(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::selectMultiple(), PCB_CONTROL::TrackDisplayMode(), PCB_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), and PCB_SELECTION_TOOL::zoomFitSelection().

Wait()

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

inherited

Suspend execution of the tool until an event specified in aEventList arrives.

No parameters means waiting for any event.

Definition at line 57 of file tool_interactive.cpp.

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

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

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), 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(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), ZOOM_TOOL::Main(), PCB_PICKER_TOOL::Main(), EE_POINT_EDITOR::Main(), PL_EDIT_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), CVPCB_CONTROL::Main(), PL_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), SCH_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), PlaceTarget(), DRAWING_TOOL::PlaceText(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ZOOM_TOOL::selectRegion(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

ZoneDuplicate()

int BOARD_EDITOR_CONTROL::ZoneDuplicate

(

const TOOL_EVENT &

aEvent

)

Definition at line 1484 of file board_editor_control.cpp.

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

 // because this pops up the zone editor, it would be confusing to handle multiple zones,
 // so just handle single selections containing exactly one zone
 if( selection.Size() != 1 )
 return 0;

 ZONE* oldZone = dyn_cast<ZONE*>( selection[0] );

 if( !oldZone )
 return 0;

 ZONE_SETTINGS zoneSettings;
 zoneSettings << *oldZone;
 int dialogResult;

 if( oldZone->GetIsRuleArea() )
 dialogResult = InvokeRuleAreaEditor( m_frame, &zoneSettings );
 else if( oldZone->IsOnCopperLayer() )
 dialogResult = InvokeCopperZonesEditor( m_frame, &zoneSettings );
 else
 dialogResult = InvokeNonCopperZonesEditor( m_frame, &zoneSettings );

 if( dialogResult != wxID_OK )
 return 0;

 // duplicate the zone
 BOARD_COMMIT commit( m_frame );

 std::unique_ptr<ZONE> newZone = std::make_unique<ZONE>( *oldZone );
 newZone->ClearSelected();
 newZone->UnFill();
 zoneSettings.ExportSetting( *newZone );

 // If the new zone is on the same layer(s) as the initial zone,
 // offset it a bit so it can more easily be picked.
 if( oldZone->GetIsRuleArea() && ( oldZone->GetLayerSet() == zoneSettings.m_Layers ) )
 newZone->Move( wxPoint( IU_PER_MM, IU_PER_MM ) );
 else if( !oldZone->GetIsRuleArea() && zoneSettings.m_Layers.test( oldZone->GetLayer() ) )
 newZone->Move( wxPoint( IU_PER_MM, IU_PER_MM ) );

 commit.Add( newZone.release() );
 commit.Push( _( "Duplicate zone" ) );

 return 0;
}

References _, COMMIT::Add(), ZONE_SETTINGS::ExportSetting(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), InvokeCopperZonesEditor(), InvokeNonCopperZonesEditor(), InvokeRuleAreaEditor(), IU_PER_MM, m_frame, ZONE_SETTINGS::m_Layers, TOOL_BASE::m_toolMgr, BOARD_COMMIT::Push(), PCB_TOOL_BASE::selection(), and SELECTION::Size().

Referenced by setTransitions().

ZoneMerge()

int BOARD_EDITOR_CONTROL::ZoneMerge

(

const TOOL_EVENT &

aEvent

)

Duplicate a zone onto a layer (prompts for new layer)

Definition at line 1411 of file board_editor_control.cpp.

{
 const PCB_SELECTION& selection = m_toolMgr->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
 BOARD* board = getModel<BOARD>();
 BOARD_COMMIT commit( m_frame );

 if( selection.Size() < 2 )
 return 0;

 int netcode = -1;

 ZONE* firstZone = nullptr;
 std::vector<ZONE*> toMerge, merged;

 for( EDA_ITEM* item : selection )
 {
  ZONE* curr_area = dynamic_cast<ZONE*>( item );

 if( !curr_area )
 continue;

 if( !firstZone )
 firstZone = curr_area;

 netcode = curr_area->GetNetCode();

 if( firstZone->GetNetCode() != netcode )
 {
 wxLogMessage( _( "Some zone netcodes did not match and were not merged." ) );
 continue;
 }

 if( curr_area->GetPriority() != firstZone->GetPriority() )
 {
 wxLogMessage( _( "Some zone priorities did not match and were not merged." ) );
 continue;
 }

 if( curr_area->GetIsRuleArea() != firstZone->GetIsRuleArea() )
 {
 wxLogMessage( _( "Some zones were rule areas and were not merged." ) );
 continue;
 }

 if( curr_area->GetLayer() != firstZone->GetLayer() )
 {
 wxLogMessage( _( "Some zone layer sets did not match and were not merged." ) );
 continue;
 }

 if( !board->TestZoneIntersection( curr_area, firstZone ) )
 {
 wxLogMessage( _( "Some zones did not intersect and were not merged." ) );
 continue;
 }

 toMerge.push_back( curr_area );
 }

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

 if( mergeZones( m_frame, commit, toMerge, merged ) )
 {
 commit.Push( wxT( "Merge zones" ) );

 for( EDA_ITEM* item : merged )
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, item );
 }

 return 0;
}

References _, PCB_TOOL_BASE::board(), ZONE::GetIsRuleArea(), ZONE::GetLayer(), BOARD_CONNECTED_ITEM::GetNetCode(), ZONE::GetPriority(), TOOL_MANAGER::GetTool(), m_frame, TOOL_BASE::m_toolMgr, mergeZones(), BOARD_COMMIT::Push(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItem, SELECTION::Size(), and BOARD::TestZoneIntersection().

Referenced by setTransitions().

Member Data Documentation

m_frame

PCB_EDIT_FRAME* BOARD_EDITOR_CONTROL::m_frame

private

Definition at line 136 of file board_editor_control.h.

Referenced by DrillOrigin(), ExportNetlist(), ExportSpecctraDSN(), Find(), FindNext(), GenerateFabFiles(), Init(), modifyLockSelected(), New(), Open(), PageSettings(), PlaceFootprint(), PlaceTarget(), Plot(), RepairBoard(), Reset(), Save(), SaveAs(), SaveCopyAs(), setTransitions(), ShowEeschema(), TogglePythonConsole(), TrackWidthDec(), TrackWidthInc(), UpdatePCBFromSchematic(), UpdateSchematicFromPCB(), ViaSizeDec(), ViaSizeInc(), ZoneDuplicate(), and ZoneMerge().

m_inPlaceFootprint

bool BOARD_EDITOR_CONTROL::m_inPlaceFootprint

private

Definition at line 137 of file board_editor_control.h.

Referenced by PlaceFootprint().

m_inPlaceTarget

bool BOARD_EDITOR_CONTROL::m_inPlaceTarget

private

Definition at line 139 of file board_editor_control.h.

Referenced by PlaceTarget().

m_isFootprintEditor

bool PCB_TOOL_BASE::m_isFootprintEditor

protectedinherited

Definition at line 181 of file pcb_tool_base.h.

Referenced by ZONE_CREATE_HELPER::commitZone(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), ZONE_CREATE_HELPER::createNewZone(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_CONTROL::GridSetOrigin(), GROUP_TOOL::Group(), PAD_TOOL::Init(), EDIT_TOOL::Init(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_TOOL_BASE::IsFootprintEditor(), PCB_POINT_EDITOR::makePoints(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelative(), PCB_CONTROL::Print(), PCB_SELECTION_TOOL::RebuildSelection(), SCRIPTING_TOOL::reloadPlugins(), EDIT_TOOL::Rotate(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectPoint(), DRAWING_TOOL::SetAnchor(), PCB_TOOL_BASE::SetIsFootprintEditor(), and GROUP_TOOL::Ungroup().

m_menu

TOOL_MENU TOOL_INTERACTIVE::m_menu

protectedinherited

The functions below are not yet implemented - their interface may change.

Definition at line 125 of file tool_interactive.h.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), TOOL_INTERACTIVE::GetToolMenu(), ROUTER_TOOL::Init(), LENGTH_TUNER_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), PL_EDIT_TOOL::Init(), SCH_EDIT_TOOL::Init(), PAD_TOOL::Init(), PL_DRAWING_TOOLS::Init(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SYMBOL_EDITOR_CONTROL::Init(), PCB_VIEWER_TOOLS::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), PL_SELECTION_TOOL::Init(), SCH_DRAWING_TOOLS::Init(), Init(), GERBVIEW_SELECTION_TOOL::Init(), EDA_3D_CONTROLLER::Init(), DRAWING_TOOL::Init(), EE_SELECTION_TOOL::Init(), EE_TOOL_BASE< SCH_BASE_FRAME >::Init(), PCB_SELECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), PCB_TOOL_BASE::Init(), PICKER_TOOL::Init(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_PICKER_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), EDA_3D_CONTROLLER::Main(), PL_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

m_placeOrigin

std::unique_ptr<KIGFX::ORIGIN_VIEWITEM> BOARD_EDITOR_CONTROL::m_placeOrigin

private

Definition at line 141 of file board_editor_control.h.

Referenced by BOARD_EDITOR_CONTROL(), DrillOrigin(), and Reset().

m_placingFootprint

bool BOARD_EDITOR_CONTROL::m_placingFootprint

private

Definition at line 138 of file board_editor_control.h.

Referenced by PlaceFootprint(), and PlacingFootprint().

m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Name of the tool.

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

Definition at line 209 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 214 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), PL_SELECTION_TOOL::AddItemsToSel(), EE_SELECTION_TOOL::AddItemsToSel(), PL_SELECTION_TOOL::AddItemToSel(), PCB_SELECTION_TOOL::AddItemToSel(), EE_SELECTION_TOOL::AddItemToSel(), SCH_MOVE_TOOL::AlignElements(), SCH_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), TOOL_BASE::attachManager(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::BreakWire(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_TOOL::ChangeTextType(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), GERBVIEW_CONTROL::ClearAllLayers(), BOARD_INSPECTION_TOOL::ClearHighlight(), SCH_EDITOR_CONTROL::ClearHighlight(), PL_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), GERBVIEW_SELECTION_TOOL::clearSelection(), EE_SELECTION_TOOL::ClearSelection(), SCH_EDIT_TOOL::ConvertDeMorgan(), PL_EDIT_TOOL::Copy(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), MICROWAVE_TOOL::createInductorBetween(), DRC_TOOL::CrossProbe(), BOARD_INSPECTION_TOOL::CrossProbePcbToSch(), COMMON_TOOLS::CursorControl(), SCH_EDITOR_CONTROL::Cut(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), BOARD_INSPECTION_TOOL::doHideNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::drawSegment(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), EditFpInFpEditor(), PAD_TOOL::EditPad(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), GROUP_TOOL::EnterGroup(), SCH_NAVIGATE_TOOL::EnterSheet(), SCH_EDITOR_CONTROL::EnterSheet(), PAD_TOOL::EnumeratePads(), EE_INSPECTION_TOOL::ExcludeMarker(), PCB_SELECTION_TOOL::expandConnection(), PAD_TOOL::explodePad(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), TOOL_BASE::GetManager(), TOOL_BASE::getModelInt(), DRAWING_TOOL::getSourceZoneForAction(), TOOL_BASE::getToolHolderInt(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_INTERACTIVE::goInternal(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), PCB_CONTROL::GridSetOrigin(), GROUP_TOOL::Group(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::HighlightNet(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PL_EDIT_TOOL::ImportDrawingSheetContent(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), BOARD_REANNOTATE_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), PL_EDIT_TOOL::Init(), SCH_EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), CONVERT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), GLOBAL_EDIT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), PL_POINT_EDITOR::Init(), BOARD_INSPECTION_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), PCB_POINT_EDITOR::Init(), Init(), POSITION_RELATIVE_TOOL::Init(), EE_TOOL_BASE< SCH_BASE_FRAME >::Init(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), TOOL_BASE::IsToolActive(), GROUP_TOOL::LeaveGroup(), SCH_NAVIGATE_TOOL::LeaveSheet(), SCH_EDITOR_CONTROL::LeaveSheet(), COMMON_CONTROL::ListHotKeys(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PCB_PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), CVPCB_CONTROL::Main(), PL_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), SCH_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), modifyLockSelected(), EDIT_TOOL::MoveExact(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), PL_SELECTION_TOOL::onDisambiguationExpire(), EE_SELECTION_TOOL::onDisambiguationExpire(), PCB_SELECTION_TOOL::onDisambiguationExpire(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), PCB_CONTROL::placeBoardItems(), PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_CONTROL::Print(), GERBVIEW_CONTROL::Print(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EE_SELECTION_TOOL::RebuildSelection(), SYMBOL_EDITOR_EDIT_TOOL::Redo(), SCH_EDITOR_CONTROL::Redo(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), PL_SELECTION_TOOL::RemoveItemFromSel(), EE_SELECTION_TOOL::RemoveItemFromSel(), PCB_SELECTION_TOOL::RemoveItemFromSel(), PL_SELECTION_TOOL::RemoveItemsFromSel(), EE_SELECTION_TOOL::RemoveItemsFromSel(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem(), EE_SELECTION_TOOL::RequestSelection(), PCB_SELECTION_TOOL::RequestSelection(), PAD_TOOL::Reset(), COMMON_TOOLS::Reset(), PNS::TOOL_BASE::Reset(), EDA_3D_CONTROLLER::Reset(), COMMON_TOOLS::ResetLocalCoords(), TOOL_INTERACTIVE::resetTransitions(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), TOOL_INTERACTIVE::RunMainStack(), DRC_TOOL::RunTests(), EE_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::SelectConnection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), GERBVIEW_SELECTION_TOOL::SelectItems(), PCB_SELECTION_TOOL::SelectItems(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectNet(), PL_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE::SetContextMenu(), EDA_3D_CONTROLLER::SetMaterial(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), EDA_3D_CONTROLLER::ToggleVisibility(), TrackWidthDec(), TrackWidthInc(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_EDIT_TOOL::Undo(), SCH_EDITOR_CONTROL::Undo(), GROUP_TOOL::Ungroup(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), PCB_SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), EE_POINT_EDITOR::updateParentItem(), BOARD_INSPECTION_TOOL::UpdateSelectionRatsnest(), PNS::TOOL_BASE::updateStartItem(), ViaSizeDec(), ViaSizeInc(), TOOL_INTERACTIVE::Wait(), ZoneDuplicate(), and ZoneMerge().

m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Definition at line 213 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

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

Definition at line 206 of file tool_base.h.

Referenced by TOOL_BASE::GetType(), and BOARD_COMMIT::Push().

WIDTH_STEP

const int BOARD_EDITOR_CONTROL::WIDTH_STEP = 100000

staticprivate

How does line width change after one -/+ key press.

Definition at line 143 of file board_editor_control.h.

Referenced by PlaceTarget().

---

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

• board_editor_control.h
• dialog_gendrill.cpp
• gen_footprints_placefile.cpp
• board_editor_control.cpp