Handle actions that are shared between different frames in PcbNew. More...

#include <pcb_control.h>

Inheritance diagram for PCB_CONTROL:

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

Public Member Functions
	PCB_CONTROL ()

	~PCB_CONTROL ()

void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state.

int	AddLibrary (const TOOL_EVENT &aEvent)

int	Print (const TOOL_EVENT &aEvent)

int	Quit (const TOOL_EVENT &aEvent)

int	ToggleRatsnest (const TOOL_EVENT &aEvent)

int	ZoneDisplayMode (const TOOL_EVENT &aEvent)

int	TrackDisplayMode (const TOOL_EVENT &aEvent)

int	ViaDisplayMode (const TOOL_EVENT &aEvent)

int	HighContrastMode (const TOOL_EVENT &aEvent)

int	ContrastModeFeedback (const TOOL_EVENT &aEvent)

int	HighContrastModeCycle (const TOOL_EVENT &aEvent)

int	NetColorModeCycle (const TOOL_EVENT &aEvent)

int	RatsnestModeCycle (const TOOL_EVENT &aEvent)

int	LayerSwitch (const TOOL_EVENT &aEvent)

int	LayerNext (const TOOL_EVENT &aEvent)

int	LayerPrev (const TOOL_EVENT &aEvent)

int	LayerToggle (const TOOL_EVENT &aEvent)

int	LayerAlphaInc (const TOOL_EVENT &aEvent)

int	LayerAlphaDec (const TOOL_EVENT &aEvent)

int	CycleLayerPresets (const TOOL_EVENT &aEvent)

int	LayerPresetFeedback (const TOOL_EVENT &aEvent)

int	GridPlaceOrigin (const TOOL_EVENT &aEvent)

int	GridResetOrigin (const TOOL_EVENT &aEvent)

int	Undo (const TOOL_EVENT &aEvent)

int	Redo (const TOOL_EVENT &aEvent)

int	SnapMode (const TOOL_EVENT &aEvent)

int	SnapModeFeedback (const TOOL_EVENT &aEvent)

int	InteractiveDelete (const TOOL_EVENT &aEvent)

int	Paste (const TOOL_EVENT &aEvent)

int	AppendBoardFromFile (const TOOL_EVENT &aEvent)

int	AppendBoard (PCB_IO &pi, wxString &fileName)

int	UpdateMessagePanel (const TOOL_EVENT &aEvent)

int	FlipPcbView (const TOOL_EVENT &aEvent)

int	DdAppendBoard (const TOOL_EVENT &aEvent)

int	DdAddLibrary (const TOOL_EVENT &aEvent)

int	DdImportFootprint (const TOOL_EVENT &aEvent)

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

void	SetIsFootprintEditor (bool aEnabled)
	Function SetIsFootprintEditor()

bool	IsFootprintEditor () const

void	SetIsBoardEditor (bool aEnabled)

bool	IsBoardEditor () const

virtual bool	Is45Limited () const
	Should the tool use its 45° mode option?

void	Activate ()
	Run the tool.

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.

void	RunMainStack (std::function< void()> aFunc)
	Call a function using the main stack.

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

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.

TOOL_TYPE	GetType () const
	Return the type of the tool.

TOOL_ID	GetId () const
	Return the unique identifier of the tool.

const std::string &	GetName () const
	Return the name of the tool.

TOOL_MANAGER *	GetManager () const
	Return the instance of TOOL_MANAGER that takes care of the tool.

bool	IsToolActive () const

Static Public Member Functions
static void	DoSetGridOrigin (KIGFX::VIEW aView, PCB_BASE_FRAME aFrame, EDA_ITEM *originViewItem, 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 TOOL_EVENT &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.

KIGFX::PCB_VIEW *	view () const

KIGFX::VIEW_CONTROLS *	controls () const

template<class T = PCB_BASE_EDIT_FRAME>
T *	frame () const

BOARD *	board () const

FOOTPRINT *	footprint () const

PCBNEW_SETTINGS::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.

KIGFX::VIEW *	getView () const
	Returns the instance of #VIEW object used in the application.

KIGFX::VIEW_CONTROLS *	getViewControls () const
	Return the instance of VIEW_CONTROLS object used in the application.

template<typename T >
T *	getEditFrame () const
	Return the application window object, casted to requested user type.

template<typename T >
T *	getModel () const
	Return the model object if it matches the requested type.

Protected Attributes
bool	m_isFootprintEditor

bool	m_isBoardEditor

std::unique_ptr< TOOL_MENU >	m_menu
	The functions below are not yet implemented - their interface may change.

TOOL_TYPE	m_type

TOOL_ID	m_toolId
	Unique id, assigned by a TOOL_MANAGER instance.

std::string	m_toolName
	Names are expected to obey the format application.ToolName (eg.

TOOL_MANAGER *	m_toolMgr

Private Member Functions
void	setTransitions () override
	< Sets up handlers for various events.

void	unfilledZoneCheck ()
	We have bug reports indicating that some new users confuse zone filling/unfilling with the display modes.

void	pruneItemLayers (std::vector< BOARD_ITEM * > &aItems)
	Helper for pasting.

bool	placeBoardItems (BOARD_COMMIT aCommit, std::vector< BOARD_ITEM > &aItems, bool aIsNew, bool aAnchorAtOrigin, bool aReannotateDuplicates)
	Add and select or just select for move/place command a list of board items.

bool	placeBoardItems (BOARD_COMMIT aCommit, BOARD aBoard, bool aAnchorAtOrigin, bool aReannotateDuplicates)
	Pointer to the currently used edit frame.

void	resetTransitions ()
	Clear the current transition map and restores the default one created by setTransitions().

void	goInternal (TOOL_STATE_FUNC &aState, const TOOL_EVENT_LIST &aConditions)

EDA_ITEM *	getModelInternal () const

TOOLS_HOLDER *	getToolHolderInternal () const

Private Attributes
PCB_BASE_FRAME *	m_frame
	Grid origin marker.

std::unique_ptr< KIGFX::ORIGIN_VIEWITEM >	m_gridOrigin

BOARD_ITEM *	m_pickerItem

std::unique_ptr< STATUS_TEXT_POPUP >	m_statusPopup

Detailed Description

Handle actions that are shared between different frames in PcbNew.

Definition at line 46 of file pcb_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 121 of file pcb_tool_base.h.

◆ 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 (the sheet for a schematic)
SUPERMODEL_RELOAD	For schematics, the entire schematic changed, not just the sheet.
GAL_SWITCH	Rendering engine changes.
REDRAW	Full drawing refresh.
SHUTDOWN	Tool is being shut down.

Definition at line 77 of file tool_base.h.

Constructor & Destructor Documentation

◆ PCB_CONTROL()

PCB_CONTROL::PCB_CONTROL ( )

Definition at line 82 of file pcb_control.cpp.

References m_gridOrigin.

◆ ~PCB_CONTROL()

PCB_CONTROL::~PCB_CONTROL ( )

Definition at line 91 of file pcb_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 64 of file tool_interactive.cpp.

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

◆ AddLibrary()

int PCB_CONTROL::AddLibrary ( const TOOL_EVENT & aEvent )

Definition at line 110 of file pcb_control.cpp.

References ACTIONS::addLibrary, PCB_BASE_EDIT_FRAME::AddLibrary(), FRAME_FOOTPRINT_EDITOR, FRAME_PCB_EDITOR, TOOL_EVENT::IsAction(), EDA_BASE_FRAME::IsType(), m_frame, and ACTIONS::newLibrary.

Referenced by DdAddLibrary(), and setTransitions().

◆ AppendBoard()

int PCB_CONTROL::AppendBoard	(	PCB_IO &	pi,
		wxString &	fileName
	)

Definition at line 1434 of file pcb_control.cpp.

References _, PCB_TOOL_BASE::board(), BOARD::BuildConnectivity(), BOARD::BuildListOfNets(), DisplayErrorMessage(), KIDIALOG::DoNotShowCheckbox(), BOARD::Drawings(), PCB_TOOL_BASE::footprint(), BOARD::Footprints(), BOARD::Generators(), PCB_BASE_EDIT_FRAME::GetAppearancePanel(), BOARD::GetCopperLayerCount(), PCB_BASE_FRAME::GetDesignSettings(), BOARD::GetEnabledLayers(), BOARD::GetPageSettings(), PCB_BASE_FRAME::GetPageSizeIU(), BOARD::GetProperties(), BOARD::GetTitleBlock(), group, BOARD::Groups(), PCB_IO::LoadBoard(), m_frame, BOARD_DESIGN_SETTINGS::m_NetSettings, APPEARANCE_CONTROLS::OnBoardChanged(), placeBoardItems(), BOARD_COMMIT::Push(), BOARD_COMMIT::Revert(), BOARD::SetCopperLayerCount(), BOARD::SetEnabledLayers(), EDA_ITEM::SetFlags(), BOARD::SetPageSettings(), IO_BASE::SetProgressReporter(), BOARD::SetProperties(), PCB_IO::SetQueryUserCallback(), BOARD::SetTitleBlock(), BOARD::SetVisibleLayers(), KIDIALOG::ShowModal(), SKIP_STRUCT, BOARD::SynchronizeNetsAndNetClasses(), BOARD::Tracks(), IO_ERROR::What(), VECTOR2< T >::x, VECTOR2< T >::y, and BOARD::Zones().

Referenced by AppendBoardFromFile(), and DdAppendBoard().

◆ AppendBoardFromFile()

int PCB_CONTROL::AppendBoardFromFile ( const TOOL_EVENT & aEvent )

Definition at line 1239 of file pcb_control.cpp.

References AppendBoard(), AskLoadBoardFileName(), PCB_IO_MGR::FindPluginTypeFromBoardPath(), KICTL_KICAD_ONLY, m_frame, and PCB_IO_MGR::PluginFind().

Referenced by setTransitions().

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

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

◆ board()

BOARD * PCB_TOOL_BASE::board ( ) const

inlineprotectedinherited

Definition at line 171 of file pcb_tool_base.h.

◆ canvas()

PCB_DRAW_PANEL_GAL * PCB_TOOL_BASE::canvas ( ) const

protectedinherited

Definition at line 309 of file pcb_tool_base.cpp.

References PCB_TOOL_BASE::frame().

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), PAD_TOOL::enterPadEditMode(), PAD_TOOL::EnumeratePads(), PAD_TOOL::ExitPadEditMode(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), EDIT_TOOL::pickReferencePoint(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), RatsnestModeCycle(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::refresh(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), PCB_PICKER_TOOL::SelectItemInteractively(), PCB_PICKER_TOOL::SelectPointInteractively(), ZONE_FILLER_TOOL::singleShotRefocus(), ToggleRatsnest(), TrackDisplayMode(), ViaDisplayMode(), ZoneDisplayMode(), and ZONE_FILLER_TOOL::ZoneFillDirty().

◆ ContrastModeFeedback()

int PCB_CONTROL::ContrastModeFeedback ( const TOOL_EVENT & aEvent )

Definition at line 339 of file pcb_control.cpp.

References _, EDA_DRAW_FRAME::CreateHotkeyPopup(), PCB_TOOL_BASE::frame(), EDA_DRAW_FRAME::GetHotkeyPopup(), PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, m_frame, Pgm(), and HOTKEY_CYCLE_POPUP::Popup().

Referenced by setTransitions().

◆ controls()

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

inlineprotectedinherited

◆ CycleLayerPresets()

int PCB_CONTROL::CycleLayerPresets ( const TOOL_EVENT & aEvent )

Definition at line 614 of file pcb_control.cpp.

References LAYER_PAIR_SETTINGS::GetEnabledLayerPairs(), PCB_BASE_EDIT_FRAME::GetLayerPairSettings(), PCB_EVENTS::LayerPairPresetChangedByKeyEvent, m_frame, TOOL_BASE::m_toolMgr, TOOL_MANAGER::PostEvent(), and LAYER_PAIR_SETTINGS::SetCurrentLayerPair().

Referenced by setTransitions().

◆ DdAddLibrary()

int PCB_CONTROL::DdAddLibrary ( const TOOL_EVENT & aEvent )

Definition at line 124 of file pcb_control.cpp.

References AddLibrary(), m_frame, and TOOL_EVENT::Parameter().

Referenced by setTransitions().

◆ DdAppendBoard()

int PCB_CONTROL::DdAppendBoard ( const TOOL_EVENT & aEvent )

Definition at line 1880 of file pcb_control.cpp.

References AppendBoard(), PCB_IO_MGR::FindPluginTypeFromBoardPath(), m_frame, TOOL_EVENT::Parameter(), and PCB_IO_MGR::PluginFind().

Referenced by setTransitions().

◆ DdImportFootprint()

int PCB_CONTROL::DdImportFootprint ( const TOOL_EVENT & aEvent )

Definition at line 132 of file pcb_control.cpp.

References m_frame, TOOL_EVENT::Parameter(), and EDA_DRAW_FRAME::Zoom_Automatique().

Referenced by setTransitions().

◆ displayOptions()

PCBNEW_SETTINGS::DISPLAY_OPTIONS & PCB_TOOL_BASE::displayOptions ( ) const

protectedinherited

Definition at line 304 of file pcb_tool_base.cpp.

References PCB_TOOL_BASE::frame().

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), RatsnestModeCycle(), ToggleRatsnest(), TrackDisplayMode(), and ViaDisplayMode().

◆ doInteractiveItemPlacement()

void PCB_TOOL_BASE::doInteractiveItemPlacement	(	const TOOL_EVENT &	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 43 of file pcb_tool_base.cpp.

References TOOL_INTERACTIVE::Activate(), SELECTION::Add(), KIGFX::VIEW_GROUP::Add(), KIGFX::PCB_VIEW::Add(), PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), EDA_ITEM::ClearFlags(), PCB_TOOL_BASE::controls(), INTERACTIVE_PLACER_BASE::CreateItem(), PCB_ACTIONS::flip, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), TOOL_EVT_UTILS::GetEventRotationAngle(), EDA_ITEM::GetFlags(), TOOL_BASE::GetManager(), 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, INTERACTIVE_PLACER_BASE::m_frame, TOOL_INTERACTIVE::m_menu, INTERACTIVE_PLACER_BASE::m_modifiers, TOOL_BASE::m_toolMgr, INTERACTIVE_PLACER_BASE::PlaceItem(), TOOL_MANAGER::PostAction(), TOOL_MANAGER::ProcessEvent(), PCB_ACTIONS::properties, BOARD_COMMIT::Push(), ACTIONS::refreshPreview, KIGFX::PCB_VIEW::Remove(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_ITEM::SetFlags(), 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().

◆ DoSetGridOrigin()

void PCB_CONTROL::DoSetGridOrigin	(	KIGFX::VIEW *	aView,
		PCB_BASE_FRAME *	aFrame,
		EDA_ITEM *	originViewItem,
		const VECTOR2D &	aPoint
	)

static

Definition at line 696 of file pcb_control.cpp.

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

Referenced by GridPlaceOrigin(), GridResetOrigin(), and PCB_BASE_EDIT_FRAME::PutDataInPreviousState().

◆ FlipPcbView()

int PCB_CONTROL::FlipPcbView ( const TOOL_EVENT & aEvent )

Definition at line 1900 of file pcb_control.cpp.

References PCB_TOOL_BASE::frame(), KIGFX::VIEW::RecacheAllItems(), KIGFX::VIEW::SetMirror(), and PCB_TOOL_BASE::view().

Referenced by setTransitions().

◆ footprint()

FOOTPRINT * PCB_TOOL_BASE::footprint ( ) const

inlineprotectedinherited

Definition at line 173 of file pcb_tool_base.h.

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

◆ frame()

template<class T = PCB_BASE_EDIT_FRAME>

T * PCB_TOOL_BASE::frame ( ) const

inlineprotectedinherited

Definition at line 166 of file pcb_tool_base.h.

Referenced by PCB_POINT_EDITOR::addCorner(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), AUTOPLACE_TOOL::autoplace(), PCB_TOOL_BASE::canvas(), PCB_POINT_EDITOR::chamferCorner(), ZONE_FILLER_TOOL::CheckAllZones(), PNS::TOOL_BASE::checkSnap(), ContrastModeFeedback(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CONVERT_TOOL::CreatePolys(), ROUTER_TOOL::CustomTrackWidthDialog(), FOOTPRINT_EDITOR_CONTROL::DeleteFootprint(), EDIT_TOOL::DeleteItems(), PCB_TOOL_BASE::displayOptions(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::DpDimensionsDialog(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), PCB_EDIT_TABLE_TOOL::EditTable(), PAD_TOOL::enterPadEditMode(), PAD_TOOL::EnumeratePads(), PAD_TOOL::ExitPadEditMode(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), ROUTER_TOOL::finishInteractive(), EDIT_TOOL::Flip(), FlipPcbView(), EDIT_TOOL::GetAndPlace(), GLOBAL_EDIT_TOOL::GlobalDeletions(), ROUTER_TOOL::handleLayerSwitch(), HighContrastMode(), HighContrastModeCycle(), BOARD_INSPECTION_TOOL::HighlightItem(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), SCRIPTING_TOOL::Init(), ROUTER_TOOL::Init(), EDIT_TOOL::Init(), PCB_PICKER_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_TOOL_BASE::Is45Limited(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), EDIT_TOOL::MoveExact(), NetColorModeCycle(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::onViaCommand(), CONVERT_TOOL::OutsetItems(), Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), GROUP_TOOL::PickNewMember(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), ROUTER_TOOL::prepareInteractive(), EDIT_TOOL::Properties(), pruneItemLayers(), PAD_TOOL::pushPadSettings(), RatsnestModeCycle(), GENERATOR_TOOL::RegenerateAllOfType(), GENERATOR_TOOL::RegenerateItem(), GENERATOR_TOOL::RegenerateSelected(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SCRIPTING_TOOL::reloadPlugins(), PCB_POINT_EDITOR::removeCorner(), MULTICHANNEL_TOOL::repeatLayout(), MULTICHANNEL_TOOL::RepeatLayout(), PNS::TOOL_BASE::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), PAD_TOOL::Reset(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), ROUTER_TOOL::saveRouterDebugLog(), ROUTER_TOOL::SelectCopperLayerPair(), PCB_PICKER_TOOL::SelectItemInteractively(), PCB_PICKER_TOOL::SelectPointInteractively(), PCB_POINT_EDITOR::setEditedPoint(), ROUTER_TOOL::SettingsDialog(), FOOTPRINT_EDITOR_CONTROL::ShowDatasheet(), GENERATOR_TOOL::ShowGeneratorsManager(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), ROUTER_TOOL::switchLayerOnViaPlacement(), DRAWING_TOOL::ToggleHV45Mode(), ToggleRatsnest(), unfilledZoneCheck(), PCB_POINT_EDITOR::updateItem(), ROUTER_TOOL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillAll(), and ZONE_FILLER_TOOL::ZoneFillDirty().

◆ getEditFrame()

template<typename T >

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 186 of file tool_base.h.

References TOOL_BASE::getToolHolderInternal().

Referenced by ZONE_CREATE_HELPER::createNewZone(), and ZONE_CREATE_HELPER::setUniquePriority().

◆ 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 123 of file tool_base.h.

References TOOL_BASE::m_toolId.

Referenced by TOOL_MANAGER::finishTool(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::isActive(), TOOL_MANAGER::RegisterTool(), ACTION_MANAGER::RunHotKey(), 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 146 of file tool_base.h.

References TOOL_BASE::m_toolMgr.

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), PNS_KICAD_IFACE::DisplayItem(), PCB_TOOL_BASE::doInteractiveItemPlacement(), PCB_TUNING_PATTERN::EditPush(), PCB_TUNING_PATTERN::EditRevert(), PCB_TUNING_PATTERN::EditStart(), ACTION_MENU::getToolManager(), PNS_KICAD_IFACE::GetUnits(), makeShapeModificationMenu(), ZONE_CREATE_HELPER::OnFirstPoint(), ZONE_CREATE_HELPER::performZoneCutout(), PAD_TOOL::PlacePad(), MULTICHANNEL_TOOL::RepeatLayout(), SCH_COMMIT::SCH_COMMIT(), PCB_TUNING_PATTERN::Update(), and GLOBAL_EDIT_TOOL::ZonesManager().

◆ getModel()

template<typename T >

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Definition at line 198 of file tool_base.h.

References TOOL_BASE::getModelInternal().

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

◆ getModelInternal()

EDA_ITEM * TOOL_BASE::getModelInternal ( ) const

privateinherited

Definition at line 54 of file tool_base.cpp.

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

Referenced by TOOL_BASE::getModel().

◆ GetName()

const std::string & TOOL_BASE::GetName ( ) 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 136 of file tool_base.h.

References TOOL_BASE::m_toolName.

Referenced by TOOL_MANAGER::dispatchInternal(), TOOL_INTERACTIVE::goInternal(), COMMON_TOOLS::GridProperties(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::invokeTool(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::runTool(), and TOOL_MANAGER::ShutdownTool().

◆ getToolHolderInternal()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInternal ( ) const

privateinherited

Definition at line 48 of file tool_base.cpp.

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

Referenced by TOOL_BASE::getEditFrame().

◆ GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inherited

◆ GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns: The type of the tool.

Definition at line 111 of file tool_base.h.

References TOOL_BASE::m_type.

Referenced by TOOL_MANAGER::InvokeTool(), 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.

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

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

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

Referenced by EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), PCB_POINT_EDITOR::chamferCorner(), PCB_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), PCB_TEST_SELECTION_TOOL::controls(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_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(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_POINT_EDITOR::makePoints(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDIT_TOOL::RepeatDrawItem(), PL_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), PCB_SELECTION_TOOL::selectCursor(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectNode(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), EE_SELECTION_TOOL::selectTableCells(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), PCB_PICKER_TOOL::setControls(), EE_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), PCB_POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::SyncSheetsPins(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), 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.

References TOOL_INTERACTIVE::goInternal().

◆ goInternal()

void TOOL_INTERACTIVE::goInternal	(	TOOL_STATE_FUNC &	aState,
		const TOOL_EVENT_LIST &	aConditions
	)

privateinherited

Definition at line 83 of file tool_interactive.cpp.

References TOOL_BASE::GetName(), kicadTraceToolStack, TOOL_BASE::m_toolMgr, TOOL_EVENT_LIST::Names(), and TOOL_MANAGER::ScheduleNextState().

Referenced by TOOL_INTERACTIVE::Go().

◆ GridPlaceOrigin()

int PCB_CONTROL::GridPlaceOrigin ( const TOOL_EVENT & aEvent )

Definition at line 707 of file pcb_control.cpp.

References TOOL_INTERACTIVE::Activate(), DoSetGridOrigin(), TOOL_MANAGER::GetTool(), TOOL_BASE::getView(), m_frame, m_gridOrigin, PCB_TOOL_BASE::m_isFootprintEditor, TOOL_BASE::m_toolMgr, TOOL_EVENT::Parameter(), ACTIONS::pickerTool, TOOL_MANAGER::RunAction(), PCB_BASE_FRAME::SaveCopyInUndoList(), and PICKER_TOOL_BASE::SetClickHandler().

Referenced by setTransitions().

◆ GridResetOrigin()

int PCB_CONTROL::GridResetOrigin ( const TOOL_EVENT & aEvent )

Definition at line 745 of file pcb_control.cpp.

References DoSetGridOrigin(), TOOL_BASE::getView(), m_frame, m_gridOrigin, and PCB_BASE_FRAME::SaveCopyInUndoList().

Referenced by setTransitions().

◆ HighContrastMode()

int PCB_CONTROL::HighContrastMode ( const TOOL_EVENT & aEvent )

Definition at line 308 of file pcb_control.cpp.

References PCB_TOOL_BASE::frame(), PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, m_frame, and PCB_BASE_FRAME::SetDisplayOptions().

Referenced by setTransitions().

◆ HighContrastModeCycle()

int PCB_CONTROL::HighContrastModeCycle ( const TOOL_EVENT & aEvent )

Definition at line 321 of file pcb_control.cpp.

References EVENTS::ContrastModeChangedByKeyEvent, PCB_TOOL_BASE::frame(), PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, m_frame, TOOL_BASE::m_toolMgr, TOOL_MANAGER::PostEvent(), and PCB_BASE_FRAME::SetDisplayOptions().

Referenced by setTransitions().

◆ Init()

bool PCB_TOOL_BASE::Init ( )

overridevirtualinherited

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

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

Reimplemented from TOOL_BASE.

Reimplemented in SCRIPTING_TOOL, ROUTER_TOOL, ARRAY_TOOL, BOARD_EDITOR_CONTROL, BOARD_INSPECTION_TOOL, BOARD_REANNOTATE_TOOL, CONVERT_TOOL, DRAWING_TOOL, EDIT_TOOL, FOOTPRINT_EDITOR_CONTROL, GENERATOR_TOOL, GLOBAL_EDIT_TOOL, GROUP_TOOL, PAD_TOOL, PCB_EDIT_TABLE_TOOL, PCB_PICKER_TOOL, PCB_POINT_EDITOR, and POSITION_RELATIVE_TOOL.

Definition at line 278 of file pcb_tool_base.cpp.

References CONDITIONAL_MENU::AddItem(), CONDITIONAL_MENU::AddSeparator(), ACTIONS::cancelInteractive, TOOL_INTERACTIVE::m_menu, and SELECTION_CONDITIONS::ShowAlways().

Referenced by PCB_EDIT_TABLE_TOOL::Init().

◆ InteractiveDelete()

int PCB_CONTROL::InteractiveDelete ( const TOOL_EVENT & aEvent )

Definition at line 756 of file pcb_control.cpp.

References TOOL_INTERACTIVE::Activate(), SELECTION::Add(), PCB_TOOL_BASE::board(), GENERAL_COLLECTOR::BoardLevelItems, SELECTION_TOOL::BrightenItem(), GENERAL_COLLECTOR::Collect(), EDIT_TOOL::DeleteItems(), PCB_SELECTION_TOOL::FilterCollectedItems(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), GENERAL_COLLECTOR::FootprintItems, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetCollectorsGuide(), COLLECTOR::GetCount(), BOARD::GetFirstFootprint(), TOOL_MANAGER::GetTool(), TOOL_BASE::getView(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), HITTEST_THRESHOLD_PIXELS, BOARD_ITEM::IsLocked(), KiROUND(), m_frame, PCB_TOOL_BASE::m_isFootprintEditor, m_pickerItem, m_statusPopup, COLLECTOR::m_Threshold, TOOL_BASE::m_toolMgr, ACTIONS::pickerTool, EDA_DRAW_PANEL_GAL::Refresh(), COLLECTOR::Remove(), TOOL_MANAGER::RunAction(), PCB_SELECTION_TOOL::Selectable(), PCB_ACTIONS::selectionClear, PICKER_TOOL_BASE::SetClickHandler(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), PICKER_TOOL_BASE::SetCursor(), PICKER_TOOL_BASE::SetFinalizeHandler(), PICKER_TOOL_BASE::SetMotionHandler(), and SELECTION_TOOL::UnbrightenItem().

Referenced by setTransitions().

◆ Is45Limited()

bool PCB_TOOL_BASE::Is45Limited ( ) const

virtualinherited

Should the tool use its 45° mode option?

Returns: True if set to use 45°

Definition at line 331 of file pcb_tool_base.cpp.

References PCB_TOOL_BASE::frame(), FRAME_PCB_EDITOR, SETTINGS_MANAGER::GetAppSettings(), PGM_BASE::GetSettingsManager(), and Pgm().

Referenced by DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), and ZONE_CREATE_HELPER::OnFirstPoint().

◆ IsBoardEditor()

bool PCB_TOOL_BASE::IsBoardEditor ( ) const

inlineinherited

Definition at line 109 of file pcb_tool_base.h.

References PCB_TOOL_BASE::m_isBoardEditor.

◆ IsFootprintEditor()

bool PCB_TOOL_BASE::IsFootprintEditor ( ) const

inlineinherited

Definition at line 106 of file pcb_tool_base.h.

References PCB_TOOL_BASE::m_isFootprintEditor.

Referenced by EDIT_TOOL::DeleteItems(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), and PCB_GRID_HELPER::queryVisible().

◆ IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 31 of file tool_base.cpp.

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

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

◆ LayerAlphaDec()

int PCB_CONTROL::LayerAlphaDec ( const TOOL_EVENT & aEvent )

Definition at line 586 of file pcb_control.cpp.

References KIGFX::COLOR4D::a, ALPHA_MIN, ALPHA_STEP, PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetCanvas(), COLOR_SETTINGS::GetColor(), PCB_BASE_FRAME::GetColorSettings(), GetNetnameLayer(), PCB_DRAW_PANEL_GAL::GetView(), IsCopperLayer(), m_frame, COLOR_SETTINGS::SetColor(), PCB_DRAW_PANEL_GAL::UpdateColors(), KIGFX::VIEW::UpdateLayerColor(), PCB_TOOL_BASE::view(), and ZONE_LAYER_FOR.

Referenced by setTransitions().

◆ LayerAlphaInc()

int PCB_CONTROL::LayerAlphaInc ( const TOOL_EVENT & aEvent )

Definition at line 558 of file pcb_control.cpp.

References KIGFX::COLOR4D::a, ALPHA_MAX, ALPHA_STEP, PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetCanvas(), COLOR_SETTINGS::GetColor(), PCB_BASE_FRAME::GetColorSettings(), GetNetnameLayer(), PCB_DRAW_PANEL_GAL::GetView(), IsCopperLayer(), m_frame, COLOR_SETTINGS::SetColor(), PCB_DRAW_PANEL_GAL::UpdateColors(), KIGFX::VIEW::UpdateLayerColor(), PCB_TOOL_BASE::view(), and ZONE_LAYER_FOR.

Referenced by setTransitions().

◆ LayerNext()

int PCB_CONTROL::LayerNext ( const TOOL_EVENT & aEvent )

Definition at line 417 of file pcb_control.cpp.

References LSET::AllCuMask(), B_Cu, PCB_TOOL_BASE::board(), PCB_BASE_FRAME::GetActiveLayer(), BOARD::GetCopperLayerCount(), IsCopperLayer(), BOARD::IsLayerVisible(), m_frame, PCB_BASE_FRAME::SwitchLayer(), and LSET::UIOrder().

Referenced by setTransitions().

◆ LayerPresetFeedback()

int PCB_CONTROL::LayerPresetFeedback ( const TOOL_EVENT & aEvent )

Definition at line 648 of file pcb_control.cpp.

References _, EDA_DRAW_FRAME::CreateHotkeyPopup(), LAYER_PAIR_SETTINGS::GetEnabledLayerPairs(), EDA_DRAW_FRAME::GetHotkeyPopup(), PCB_LAYER_PRESENTATION::getLayerPairName(), PCB_BASE_EDIT_FRAME::GetLayerPairSettings(), m_frame, Pgm(), HOTKEY_CYCLE_POPUP::Popup(), and PCB_TOOL_BASE::selection().

Referenced by setTransitions().

◆ LayerPrev()

int PCB_CONTROL::LayerPrev ( const TOOL_EVENT & aEvent )

Definition at line 477 of file pcb_control.cpp.

References LSET::AllCuMask(), PCB_TOOL_BASE::board(), F_Cu, PCB_BASE_FRAME::GetActiveLayer(), BOARD::GetCopperLayerCount(), IsCopperLayer(), BOARD::IsLayerVisible(), m_frame, PCB_BASE_FRAME::SwitchLayer(), and LSET::UIOrder().

Referenced by setTransitions().

◆ LayerSwitch()

int PCB_CONTROL::LayerSwitch ( const TOOL_EVENT & aEvent )

Definition at line 409 of file pcb_control.cpp.

References m_frame, TOOL_EVENT::Parameter(), and PCB_BASE_FRAME::SwitchLayer().

Referenced by setTransitions().

◆ LayerToggle()

int PCB_CONTROL::LayerToggle ( const TOOL_EVENT & aEvent )

Definition at line 537 of file pcb_control.cpp.

References PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetScreen(), m_frame, PCB_SCREEN::m_Route_Layer_BOTTOM, PCB_SCREEN::m_Route_Layer_TOP, and PCB_BASE_FRAME::SwitchLayer().

Referenced by setTransitions().

◆ NetColorModeCycle()

int PCB_CONTROL::NetColorModeCycle ( const TOOL_EVENT & aEvent )

Definition at line 366 of file pcb_control.cpp.

References PCB_TOOL_BASE::frame(), m_frame, PCB_DISPLAY_OPTIONS::m_NetColorMode, and PCB_BASE_FRAME::SetDisplayOptions().

Referenced by setTransitions().

◆ Paste()

int PCB_CONTROL::Paste ( const TOOL_EVENT & aEvent )

Definition at line 1011 of file pcb_control.cpp.

References _, GENERAL_COLLECTOR::AllBoardItems, BOARD::AllConnectedItems(), PCB_TOOL_BASE::board(), EDA_DRAW_FRAME::DisplayToolMsg(), BOARD::Drawings(), PCB_TOOL_BASE::footprint(), BOARD::Footprints(), PCB_TOOL_BASE::frame(), FRAME_FOOTPRINT_EDITOR, FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetBoard(), DIALOG_PASTE_SPECIAL::GetClearNets(), GetClipboardUTF8(), BOARD::GetFirstFootprint(), GetImageFromClipboard(), PCB_BASE_FRAME::GetModel(), BOARD_ITEM::GetParentGroup(), group, BOARD::Groups(), DIALOG_PASTE_SPECIAL::HideClearNets(), TOOL_EVENT::IsAction(), m_frame, PCB_TOOL_BASE::m_isFootprintEditor, BOARD::MapNets(), NETINFO_LIST::OrphanedItem(), CLIPBOARD_IO::Parse(), pasteFootprintItemsToFootprintEditor(), ACTIONS::pasteSpecial, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_SHAPE_T, PCB_T, PCB_TABLE_T, PCB_TEXT_T, PCB_TEXTBOX_T, placeBoardItems(), pruneItemLayers(), BOARD_COMMIT::Push(), BOARD::RemoveAll(), PCB_GROUP::RemoveItem(), BOARD_COMMIT::Revert(), EDA_ITEM::SetParent(), FOOTPRINT::SetReference(), DIALOG_SHIM::ShowModal(), EDA_ITEM::Type(), and BOARD::Visit().

Referenced by setTransitions().

◆ placeBoardItems() [1/2]

bool PCB_CONTROL::placeBoardItems	(	BOARD_COMMIT *	aCommit,
		BOARD *	aBoard,
		bool	aAnchorAtOrigin,
		bool	aReannotateDuplicates
	)

private

Pointer to the currently used edit frame.

Definition at line 1297 of file pcb_control.cpp.

References PCB_TOOL_BASE::board(), BOARD::Drawings(), BOARD::Footprints(), BOARD::Generators(), BOARD::Groups(), moveUnflaggedItems(), placeBoardItems(), pruneItemLayers(), BOARD::RemoveAll(), BOARD::Tracks(), and BOARD::Zones().

◆ placeBoardItems() [2/2]

bool PCB_CONTROL::placeBoardItems	(	BOARD_COMMIT *	aCommit,
		std::vector< BOARD_ITEM * > &	aItems,
		bool	aIsNew,
		bool	aAnchorAtOrigin,
		bool	aReannotateDuplicates
	)

private

Add and select or just select for move/place command a list of board items.

Parameters

aItems	is the list of items
aIsNew	= true to add items to the current board, false to just select if items are already managed by the current board
aAnchorAtOrigin	= true if the items are translated so that the anchor is {0, 0} (if false, the top-left item's origin will be used)
aReannotateDuplicates	= true to reannotate any footprints with a designator that already exist in the board.

Definition at line 1335 of file pcb_control.cpp.

References COMMIT::Add(), COMMIT::Added(), PCB_GROUP::AddItem(), BaseType(), PCB_TOOL_BASE::board(), alg::contains(), PCB_TOOL_BASE::footprint(), PCB_SELECTION_TOOL::GetEnteredGroup(), BOARD_ITEM::GetParentGroup(), EDA_ITEM::GetPosition(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), PCB_SELECTION::GetTopLeftItem(), TOOL_BASE::getViewControls(), FOOTPRINT::GraphicalItems(), PCB_TOOL_BASE::m_isBoardEditor, TOOL_BASE::m_toolMgr, EDA_ITEM::m_Uuid, PCB_ACTIONS::move, PCB_DIMENSION_T, PCB_FOOTPRINT_T, TOOL_MANAGER::ProcessEvent(), TOOL_MANAGER::RunAction(), TOOL_MANAGER::RunSynchronousAction(), EVENTS::SelectedEvent, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItems, KIGFX::VIEW_CONTROLS::SetCursorPosition(), FOOTPRINT::SetPath(), SELECTION::SetReferencePoint(), and SELECTION::Size().

Referenced by AppendBoard(), Paste(), and placeBoardItems().

◆ Print()

int PCB_CONTROL::Print ( const TOOL_EVENT & aEvent )

Definition at line 471 of file dialog_print_pcbnew.cpp.

References DIALOG_PRINT_GENERIC::ForcePrintBorder(), PCB_BASE_FRAME::GetPageSettings(), m_frame, PCB_TOOL_BASE::m_isFootprintEditor, TOOL_BASE::m_toolMgr, TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectionClear, and DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

◆ pruneItemLayers()

void PCB_CONTROL::pruneItemLayers ( std::vector< BOARD_ITEM * > & aItems )

private

Helper for pasting.

Remove non-enabled layers from the items in aItems. If an item exists only on non-enabled layers, it will be removed entirely.

Definition at line 943 of file pcb_control.cpp.

References _, PCB_TOOL_BASE::board(), DisplayError(), PCB_TOOL_BASE::frame(), FRAME_FOOTPRINT_EDITOR, BOARD::GetCopperLayerCount(), BOARD::GetEnabledLayers(), BOARD_ITEM::GetParentGroup(), PCB_VIA::HasValidLayerPair(), m_frame, PCB_TOOL_BASE::m_isFootprintEditor, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, and PCB_VIA_T.

Referenced by Paste(), and placeBoardItems().

◆ Quit()

int PCB_CONTROL::Quit ( const TOOL_EVENT & aEvent )

Definition at line 141 of file pcb_control.cpp.

References m_frame.

Referenced by setTransitions().

◆ RatsnestModeCycle()

int PCB_CONTROL::RatsnestModeCycle ( const TOOL_EVENT & aEvent )

Definition at line 382 of file pcb_control.cpp.

References PCB_TOOL_BASE::canvas(), PCB_TOOL_BASE::displayOptions(), PCB_TOOL_BASE::frame(), LAYER_RATSNEST, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_RatsnestMode, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_ShowGlobalRatsnest, PCB_DRAW_PANEL_GAL::RedrawRatsnest(), and EDA_DRAW_PANEL_GAL::Refresh().

Referenced by setTransitions().

◆ Redo()

int PCB_CONTROL::Redo ( const TOOL_EVENT & aEvent )

Definition at line 1566 of file pcb_control.cpp.

References dummy, m_frame, and PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList().

Referenced by setTransitions().

◆ Reset()

void PCB_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 96 of file pcb_control.cpp.

References KIGFX::VIEW::Add(), PCB_TOOL_BASE::board(), TOOL_BASE::GAL_SWITCH, EDA_DRAW_FRAME::GetGridColor(), TOOL_BASE::getView(), m_frame, m_gridOrigin, TOOL_BASE::MODEL_RELOAD, TOOL_BASE::REDRAW, and KIGFX::VIEW::Remove().

◆ resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

Clear the current transition map and restores the default one created by setTransitions().

Definition at line 76 of file tool_interactive.cpp.

References TOOL_MANAGER::ClearTransitions(), TOOL_BASE::m_toolMgr, and TOOL_INTERACTIVE::setTransitions().

◆ 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 104 of file tool_interactive.cpp.

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

Referenced by DRAWING_TOOL::PlaceText().

◆ selection() [1/2]

PCB_SELECTION & PCB_TOOL_BASE::selection ( )

protectedinherited

Definition at line 323 of file pcb_tool_base.cpp.

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

◆ selection() [2/2]

const PCB_SELECTION & PCB_TOOL_BASE::selection ( ) const

protectedinherited

Definition at line 315 of file pcb_tool_base.cpp.

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 93 of file tool_interactive.cpp.

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

Referenced by SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::DrawVia(), TOOL_MENU::ShowContextMenu(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ SetIsBoardEditor()

void PCB_TOOL_BASE::SetIsBoardEditor ( bool aEnabled )

inlineinherited

Definition at line 108 of file pcb_tool_base.h.

References PCB_TOOL_BASE::m_isBoardEditor.

◆ 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 105 of file pcb_tool_base.h.

References PCB_TOOL_BASE::m_isFootprintEditor.

◆ setTransitions()

void PCB_CONTROL::setTransitions ( )

overrideprivatevirtual

< Sets up handlers for various events.

Reimplemented from PCB_TOOL_BASE.

Definition at line 1910 of file pcb_control.cpp.

◆ SnapMode()

int PCB_CONTROL::SnapMode ( const TOOL_EVENT & aEvent )

Definition at line 1578 of file pcb_control.cpp.

References MAGNETIC_SETTINGS::allLayers, PCB_BASE_FRAME::GetFootprintEditorSettings(), PCB_BASE_FRAME::GetPcbNewSettings(), TOOL_EVENT::IsAction(), m_frame, PCB_TOOL_BASE::m_isFootprintEditor, FOOTPRINT_EDITOR_SETTINGS::m_MagneticItems, PCBNEW_SETTINGS::m_MagneticItems, TOOL_BASE::m_toolMgr, PCB_ACTIONS::magneticSnapActiveLayer, PCB_ACTIONS::magneticSnapAllLayers, TOOL_MANAGER::PostEvent(), and PCB_EVENTS::SnappingModeChangedByKeyEvent.

Referenced by setTransitions().

◆ SnapModeFeedback()

int PCB_CONTROL::SnapModeFeedback ( const TOOL_EVENT & aEvent )

Definition at line 1598 of file pcb_control.cpp.

References _, MAGNETIC_SETTINGS::allLayers, EDA_DRAW_FRAME::CreateHotkeyPopup(), PCB_BASE_FRAME::GetFootprintEditorSettings(), EDA_DRAW_FRAME::GetHotkeyPopup(), PCB_BASE_FRAME::GetPcbNewSettings(), m_frame, PCB_TOOL_BASE::m_isFootprintEditor, FOOTPRINT_EDITOR_SETTINGS::m_MagneticItems, PCBNEW_SETTINGS::m_MagneticItems, Pgm(), and HOTKEY_CYCLE_POPUP::Popup().

Referenced by setTransitions().

◆ ToggleRatsnest()

int PCB_CONTROL::ToggleRatsnest ( const TOOL_EVENT & aEvent )

Definition at line 176 of file pcb_control.cpp.

References PCB_TOOL_BASE::canvas(), PCB_TOOL_BASE::displayOptions(), Flip(), PCB_TOOL_BASE::frame(), TOOL_EVENT::IsAction(), LAYER_RATSNEST, PCB_ACTIONS::ratsnestLineMode, PCB_DRAW_PANEL_GAL::RedrawRatsnest(), EDA_DRAW_PANEL_GAL::Refresh(), and PCB_ACTIONS::showRatsnest.

Referenced by setTransitions().

◆ TrackDisplayMode()

int PCB_CONTROL::TrackDisplayMode ( const TOOL_EVENT & aEvent )

Definition at line 154 of file pcb_control.cpp.

References PCB_TOOL_BASE::board(), PCB_TOOL_BASE::canvas(), PCB_TOOL_BASE::displayOptions(), Flip(), BOARD_ITEM::IsOnCopperLayer(), PCB_ARC_T, PCB_SHAPE_T, PCB_TRACE_T, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, KIGFX::PCB_VIEW::Update(), and PCB_TOOL_BASE::view().

Referenced by setTransitions().

◆ Undo()

int PCB_CONTROL::Undo ( const TOOL_EVENT & aEvent )

Definition at line 1554 of file pcb_control.cpp.

References dummy, m_frame, and PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList().

Referenced by setTransitions().

◆ unfilledZoneCheck()

void PCB_CONTROL::unfilledZoneCheck ( )

private

We have bug reports indicating that some new users confuse zone filling/unfilling with the display modes.

This will put up a warning if they show zone fills when one or more zones are unfilled.

Definition at line 220 of file pcb_control.cpp.

References _, WX_INFOBAR::AddButton(), PCB_TOOL_BASE::board(), PCB_TOOL_BASE::frame(), PGM_BASE::GetCommonSettings(), KeyNameFromKeyCode(), COMMON_SETTINGS::m_DoNotShowAgain, Pgm(), WX_INFOBAR::RemoveAllButtons(), WX_INFOBAR::ShowMessageFor(), COMMON_SETTINGS::DO_NOT_SHOW_AGAIN::zone_fill_warning, and PCB_ACTIONS::zoneFillAll.

Referenced by ZoneDisplayMode().

◆ UpdateMessagePanel()

int PCB_CONTROL::UpdateMessagePanel ( const TOOL_EVENT & aEvent )

Definition at line 1623 of file pcb_control.cpp.

References _, LSET::AllCuMask(), CLEARANCE_CONSTRAINT, LSET::CuStack(), DIFF_PAIR_GAP_CONSTRAINT, BOARD::DpCoupledNet(), VECTOR2< int32_t >::ECOORD_MAX, EDGE_CLEARANCE_CONSTRAINT, Edge_Cuts, SELECTION::Empty(), SELECTION::Front(), PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetBoard(), BOARD::GetDesignSettings(), BOARD_ITEM::GetEffectiveHoleShape(), BOARD_ITEM::GetEffectiveShape(), PCB_TRACK::GetEnd(), EDA_ITEM::GetItemDescription(), BOARD_ITEM::GetLayer(), BOARD_ITEM::GetLayerSet(), PCB_BASE_FRAME::GetModel(), EDA_ITEM::GetMsgPanelInfo(), BOARD::GetMsgPanelInfo(), FOOTPRINT::GetMsgPanelInfo(), DRC_CONSTRAINT::GetName(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetCode(), PCB_SELECTION_TOOL::GetSelection(), SELECTION::GetSize(), PCB_TRACK::GetStart(), TOOL_MANAGER::GetTool(), BOARD_ITEM::HasHole(), MINOPTMAX< T >::HasMax(), HOLE_CLEARANCE_CONSTRAINT, IsCopperLayer(), BOARD_ITEM::IsOnCopperLayer(), BOARD_ITEM::IsOnLayer(), BOARD_DESIGN_SETTINGS::m_DRCEngine, m_frame, PCB_TOOL_BASE::m_isBoardEditor, TOOL_BASE::m_toolMgr, DRC_CONSTRAINT::m_Value, Margin, MINOPTMAX< T >::Max(), MAX_UNCOUPLED_CONSTRAINT, UNITS_PROVIDER::MessageTextFromMinOptMax(), UNITS_PROVIDER::MessageTextFromValue(), MINOPTMAX< T >::Min(), PCB_FOOTPRINT_T, PCB_TOOL_BASE::selection(), EDA_DRAW_FRAME::SetMsgPanel(), SEG::SquaredDistance(), BOARD::Tracks(), EDA_ITEM::Type(), UNDEFINED_LAYER, UnescapeString(), and DRC_CONSTRAINT::Value().

Referenced by setTransitions().

◆ ViaDisplayMode()

int PCB_CONTROL::ViaDisplayMode ( const TOOL_EVENT & aEvent )

Definition at line 200 of file pcb_control.cpp.

References PCB_TOOL_BASE::board(), PCB_TOOL_BASE::canvas(), PCB_TOOL_BASE::displayOptions(), Flip(), PCB_VIA_T, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, KIGFX::PCB_VIEW::Update(), and PCB_TOOL_BASE::view().

Referenced by setTransitions().

◆ view()

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

inlineprotectedinherited

◆ 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 70 of file tool_interactive.cpp.

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

◆ ZoneDisplayMode()

int PCB_CONTROL::ZoneDisplayMode ( const TOOL_EVENT & aEvent )

Member Data Documentation

◆ m_frame

PCB_BASE_FRAME* PCB_CONTROL::m_frame

private

Grid origin marker.

Definition at line 149 of file pcb_control.h.

Referenced by AddLibrary(), AppendBoard(), AppendBoardFromFile(), ContrastModeFeedback(), CycleLayerPresets(), DdAddLibrary(), DdAppendBoard(), DdImportFootprint(), GridPlaceOrigin(), GridResetOrigin(), HighContrastMode(), HighContrastModeCycle(), InteractiveDelete(), LayerAlphaDec(), LayerAlphaInc(), LayerNext(), LayerPresetFeedback(), LayerPrev(), LayerSwitch(), LayerToggle(), NetColorModeCycle(), Paste(), Print(), pruneItemLayers(), Quit(), Redo(), Reset(), SnapMode(), SnapModeFeedback(), Undo(), UpdateMessagePanel(), and ZoneDisplayMode().

◆ m_gridOrigin

std::unique_ptr<KIGFX::ORIGIN_VIEWITEM> PCB_CONTROL::m_gridOrigin

private

Definition at line 152 of file pcb_control.h.

Referenced by GridPlaceOrigin(), GridResetOrigin(), PCB_CONTROL(), and Reset().

◆ m_isBoardEditor

bool PCB_TOOL_BASE::m_isBoardEditor

protectedinherited

Definition at line 188 of file pcb_tool_base.h.

Referenced by PCB_TOOL_BASE::IsBoardEditor(), placeBoardItems(), PCB_TOOL_BASE::SetIsBoardEditor(), and UpdateMessagePanel().

◆ m_isFootprintEditor

bool PCB_TOOL_BASE::m_isFootprintEditor

protectedinherited

Definition at line 187 of file pcb_tool_base.h.

◆ m_menu

std::unique_ptr<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.

◆ m_pickerItem

BOARD_ITEM* PCB_CONTROL::m_pickerItem

private

Definition at line 154 of file pcb_control.h.

Referenced by InteractiveDelete().

◆ m_statusPopup

std::unique_ptr<STATUS_TEXT_POPUP> PCB_CONTROL::m_statusPopup

private

Definition at line 156 of file pcb_control.h.

Referenced by InteractiveDelete().

◆ m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Unique id, assigned by a TOOL_MANAGER instance.

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

◆ m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

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

pcbnew.InteractiveSelection).

Definition at line 216 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

◆ m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

Definition at line 214 of file tool_base.h.

Referenced by TOOL_BASE::GetType().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ INTERACTIVE_PLACEMENT_OPTIONS

◆ RESET_REASON

Constructor & Destructor Documentation

◆ PCB_CONTROL()

◆ ~PCB_CONTROL()

Member Function Documentation

◆ Activate()

◆ AddLibrary()

◆ AppendBoard()

◆ AppendBoardFromFile()

◆ attachManager()

◆ board()

◆ canvas()

◆ ContrastModeFeedback()

◆ controls()

◆ CycleLayerPresets()

◆ DdAddLibrary()

◆ DdAppendBoard()

◆ DdImportFootprint()

◆ displayOptions()

◆ doInteractiveItemPlacement()

◆ DoSetGridOrigin()

◆ FlipPcbView()

◆ footprint()

◆ frame()

◆ getEditFrame()

◆ GetId()

◆ GetManager()

◆ getModel()

◆ getModelInternal()

◆ GetName()

◆ getToolHolderInternal()

◆ GetToolMenu()

◆ GetType()

◆ getView()

◆ getViewControls()

◆ Go()

◆ goInternal()

◆ GridPlaceOrigin()

◆ GridResetOrigin()

◆ HighContrastMode()

◆ HighContrastModeCycle()

◆ Init()

◆ InteractiveDelete()

◆ Is45Limited()

◆ IsBoardEditor()

◆ IsFootprintEditor()

◆ IsToolActive()

◆ LayerAlphaDec()

◆ LayerAlphaInc()

◆ LayerNext()

◆ LayerPresetFeedback()

◆ LayerPrev()

◆ LayerSwitch()

◆ LayerToggle()

◆ NetColorModeCycle()

◆ Paste()

◆ placeBoardItems() [1/2]

◆ placeBoardItems() [2/2]

◆ Print()

◆ pruneItemLayers()

◆ Quit()

◆ RatsnestModeCycle()

◆ Redo()

◆ Reset()

◆ resetTransitions()

◆ RunMainStack()

◆ selection() [1/2]

◆ selection() [2/2]

◆ SetContextMenu()