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 , SUPERMODEL_RELOAD , GAL_SWITCH ,   REDRAW , SHUTDOWN }
	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.
bool	Init () override
	Init() is called once upon a registration of the tool.
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	SaveCopy (const TOOL_EVENT &aEvent)
int	Revert (const TOOL_EVENT &aEvent)
int	RescueAutosave (const TOOL_EVENT &aEvent)
int	OpenNonKicadBoard (const TOOL_EVENT &aEvent)
int	ExportFootprints (const TOOL_EVENT &aEvent)
int	PageSettings (const TOOL_EVENT &aEvent)
int	Plot (const TOOL_EVENT &aEvent)
int	Search (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	GenerateGerbers (const TOOL_EVENT &aEvent)
int	ExportGenCAD (const TOOL_EVENT &aEvent)
	Export GenCAD 1.4 format.
int	ExportVRML (const TOOL_EVENT &aEvent)
int	ExportIDF (const TOOL_EVENT &aEvent)
int	ExportSTEP (const TOOL_EVENT &aEvent)
int	ExportCmpFile (const TOOL_EVENT &aEvent)
int	ExportHyperlynx (const TOOL_EVENT &aEvent)
int	GenBOMFileFromBoard (const TOOL_EVENT &aEvent)
int	GenFootprintsReport (const TOOL_EVENT &aEvent)
int	GenD356File (const TOOL_EVENT &aEvent)
int	GenIPC2581File (const TOOL_EVENT &aEvent)
int	GenerateODBPPFiles (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	ToggleProperties (const TOOL_EVENT &aEvent)
int	ToggleNetInspector (const TOOL_EVENT &aEvent)
int	ToggleSearch (const TOOL_EVENT &aEvent)
int	TogglePythonConsole (const TOOL_EVENT &aEvent)
int	ToggleLibraryTree (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	AutoTrackWidth (const TOOL_EVENT &aEvent)
int	ZoneMerge (const TOOL_EVENT &aEvent)
	Duplicate a zone onto a layer (prompts for new layer)
int	ZoneDuplicate (const TOOL_EVENT &aEvent)
int	EditFpInFpEditor (const TOOL_EVENT &aEvent)
	Notify Eeschema about selected items.
int	CrossProbeToSch (const TOOL_EVENT &aEvent)
	Equivalent to the above, but initiated by the user.
int	ExplicitCrossProbeToSch (const TOOL_EVENT &aEvent)
	Assign a netclass to a labelled net.
int	AssignNetclass (const TOOL_EVENT &aEvent)
int	PlaceFootprint (const TOOL_EVENT &aEvent)
	Display a dialog to select a footprint to be added and allows the user to set its position.
bool	PlacingFootprint () const
	Re-entrancy checker for above.
int	ToggleLockSelected (const TOOL_EVENT &aEvent)
	Lock selected items.
int	LockSelected (const TOOL_EVENT &aEvent)
	Unlock selected items.
int	UnlockSelected (const TOOL_EVENT &aEvent)
	Run the drill origin tool for setting the origin for drill and pick-and-place files.
int	DrillOrigin (const TOOL_EVENT &aEvent)
	Low-level access (below undo) to setting the drill origin.
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?
virtual bool	Is90Limited () const
	Should the tool limit drawing to horizontal and vertical only?
LEADER_MODE	GetAngleSnapMode () const
	Get the current angle snapping mode.
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	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 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 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.
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events.
void	doCrossProbePcbToSch (const TOOL_EVENT &aEvent, bool aForce)
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_EDIT_FRAME *	m_frame
bool	m_inPlaceFootprint
bool	m_placingFootprint
std::unique_ptr< KIGFX::ORIGIN_VIEWITEM >	m_placeOrigin

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

MODIFY_MODE

enum BOARD_EDITOR_CONTROL::MODIFY_MODE

private

< How to modify a property for selected items.

Enumerator
ON
OFF
TOGGLE

Definition at line 153 of file board_editor_control.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

BOARD_EDITOR_CONTROL()

BOARD_EDITOR_CONTROL::BOARD_EDITOR_CONTROL

(

)

Definition at line 142 of file board_editor_control.cpp.

References KIGFX::ORIGIN_VIEWITEM::CIRCLE_CROSS, m_frame, m_inPlaceFootprint, m_placeOrigin, m_placingFootprint, and PCB_TOOL_BASE::PCB_TOOL_BASE().

~BOARD_EDITOR_CONTROL()

BOARD_EDITOR_CONTROL::~BOARD_EDITOR_CONTROL

(

)

Definition at line 153 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 65 of file tool_interactive.cpp.

References TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

Referenced by AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::copyToClipboard(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridPlaceOrigin(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_CONTROL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), SCH_TOOL_BASE< T >::InteractiveDelete(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PCB_PICKER_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), PCB_PICKER_TOOL::SelectItemInteractively(), PCB_PICKER_TOOL::SelectPointInteractively(), DRAWING_TOOL::SetAnchor(), and DRC_TOOL::ShowDRCDialog().

AssignNetclass()

int BOARD_EDITOR_CONTROL::AssignNetclass

(

const TOOL_EVENT &

aEvent

)

Definition at line 1609 of file board_editor_control.cpp.

References _, PCB_TOOL_BASE::board(), PCB_TOOL_BASE::canvas(), PCB_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::FilterCollectorForLockedItems(), EDA_DRAW_PANEL_GAL::ForceRefresh(), COLLECTOR::GetCount(), NETINFO_ITEM::GetNetCode(), BOARD::GetNetInfo(), NETINFO_LIST::GetNetItem(), NETINFO_ITEM::GetNetname(), NETINFO_ITEM::HasAutoGeneratedNetname(), m_frame, TOOL_BASE::m_toolMgr, COLLECTOR::Remove(), PCB_SELECTION_TOOL::RequestSelection(), PCB_SELECTION_TOOL::SelectAllItemsOnNet(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectNet, and BOARD::SynchronizeNetsAndNetClasses().

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

References m_toolMgr, and TOOL_MANAGER.

Referenced by TOOL_MANAGER::RegisterTool().

AutoTrackWidth()

int BOARD_EDITOR_CONTROL::AutoTrackWidth

(

const TOOL_EVENT &

aEvent

)

Definition at line 1074 of file board_editor_control.cpp.

References TOOL_BASE::getModel(), BOARD_DESIGN_SETTINGS::m_UseConnectedTrackWidth, and BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize().

Referenced by setTransitions().

board()

BOARD * PCB_TOOL_BASE::board ( ) const

inlineprotectedinherited

Definition at line 182 of file pcb_tool_base.h.

References TOOL_BASE::getModel().

Referenced by PCB_CONTROL::AppendBoard(), PCB_CONTROL::ApplyDesignBlockLayout(), BOARD_EDITOR_CONTROL::AssignNetclass(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), AUTOPLACE_TOOL::autoplace(), AUTOPLACE_TOOL::autoplaceOffboard(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), EDIT_TOOL::ChangeTrackWidth(), ZONE_FILLER_TOOL::CheckAllZones(), BOARD_INSPECTION_TOOL::ClearHighlight(), PCB_CONTROL::CollectAndEmbed3DModels(), MULTICHANNEL_TOOL::copyRuleAreaContents(), EDIT_TOOL::copyToClipboard(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), MICROWAVE_TOOL::createInductorBetween(), CONVERT_TOOL::CreatePolys(), ROUTER_TOOL::CustomTrackWidthDialog(), doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::drawShape(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportCmpFile(), BOARD_EDITOR_CONTROL::ExportHyperlynx(), BOARD_EDITOR_CONTROL::ExportIDF(), BOARD_EDITOR_CONTROL::ExportNetlist(), BOARD_EDITOR_CONTROL::ExportSTEP(), BOARD_EDITOR_CONTROL::ExportVRML(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), MULTICHANNEL_TOOL::findComponentsInRuleArea(), MULTICHANNEL_TOOL::FindExistingRuleAreas(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), MULTICHANNEL_TOOL::findRoutingInRuleArea(), MULTICHANNEL_TOOL::fixupNet(), footprint(), BOARD_EDITOR_CONTROL::GenBOMFileFromBoard(), GENERATOR_TOOL::GenEditAction(), MULTICHANNEL_TOOL::GeneratePotentialRuleAreas(), GENERATOR_TOOL::GENERATOR_TOOL(), BOARD_EDITOR_CONTROL::GenFootprintsReport(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::highlightNet(), ROUTER_TOOL::Init(), ROUTER_TOOL::InlineDrag(), PCB_CONTROL::InteractiveDelete(), PCB_CONTROL::LayerNext(), PCB_CONTROL::LayerPrev(), PCB_POINT_EDITOR::makePoints(), EDIT_TOOL::MoveExact(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PAD_TOOL::OnUndoRedo(), PAD_TOOL::PadTable(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), MULTICHANNEL_TOOL::pruneExistingGroups(), PCB_CONTROL::pruneItemLayers(), MULTICHANNEL_TOOL::queryComponentsInComponentClass(), MULTICHANNEL_TOOL::queryComponentsInGroup(), MULTICHANNEL_TOOL::queryComponentsInSheet(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), PAD_TOOL::RecombinePad(), GENERATOR_TOOL::RegenerateAllOfType(), GENERATOR_TOOL::RegenerateItem(), GENERATOR_TOOL::RegenerateSelected(), PCB_CONTROL::RehatchShapes(), BOARD_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_CONTROL::RepairFootprint(), MULTICHANNEL_TOOL::RepeatLayout(), GENERATOR_TOOL_PNS_PROXY::Reset(), PAD_TOOL::Reset(), PCB_CONTROL::Reset(), PNS::TOOL_BASE::Reset(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::unfilledZoneCheck(), ROUTER_TOOL::UpdateMessagePanel(), ROUTER_TOOL::updateSizesAfterRouterEvent(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillDirty(), BOARD_EDITOR_CONTROL::ZoneMerge(), GLOBAL_EDIT_TOOL::ZonesManager(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

BoardSetup()

int BOARD_EDITOR_CONTROL::BoardSetup

(

const TOOL_EVENT &

aEvent

)

Definition at line 356 of file board_editor_control.cpp.

References TOOL_BASE::getEditFrame().

Referenced by setTransitions().

canvas()

PCB_DRAW_PANEL_GAL * PCB_TOOL_BASE::canvas ( ) const

protectedinherited

Definition at line 309 of file pcb_tool_base.cpp.

References 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(), PCB_CONTROL::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(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), and ZONE_FILLER_TOOL::ZoneFillDirty().

controls()

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

inlineprotectedinherited

Definition at line 171 of file pcb_tool_base.h.

References TOOL_BASE::getViewControls().

Referenced by 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(), ROUTER_TOOL::performRouting(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), ROUTER_TOOL::prepareInteractive(), ROUTER_TOOL::RouteSelected(), PCB_PICKER_TOOL::setControls(), PCB_POINT_EDITOR::setEditedPoint(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

CrossProbeToSch()

int BOARD_EDITOR_CONTROL::CrossProbeToSch

(

const TOOL_EVENT &

aEvent

)

Equivalent to the above, but initiated by the user.

Definition at line 1575 of file board_editor_control.cpp.

References doCrossProbePcbToSch().

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

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

doCrossProbePcbToSch()

void BOARD_EDITOR_CONTROL::doCrossProbePcbToSch ( const TOOL_EVENT & aEvent, bool aForce )

private

Definition at line 1589 of file board_editor_control.cpp.

References PCB_TOOL_BASE::frame(), PCB_SELECTION_TOOL::GetSelection(), m_frame, TOOL_BASE::m_toolMgr, TOOL_EVENT::Matches(), EVENTS::PointSelectedEvent, and PCB_TOOL_BASE::selection().

Referenced by CrossProbeToSch(), and ExplicitCrossProbeToSch().

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(), KIGFX::PCB_VIEW::Add(), KIGFX::VIEW_GROUP::Add(), SELECTION::Add(), ARROW, board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), EDA_ITEM::ClearFlags(), controls(), INTERACTIVE_PLACER_BASE::CreateItem(), PCB_ACTIONS::flip, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), frame(), TOOL_EVT_UTILS::GetEventRotationAngle(), EDA_ITEM::GetFlags(), TOOL_BASE::GetManager(), TOOL_BASE::getView(), grid, IPO_FLIP, IPO_REPEAT, IPO_ROTATE, 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, NO_RECURSE, PENCIL, PLACE, INTERACTIVE_PLACER_BASE::PlaceItem(), PCB_ACTIONS::properties, BOARD_COMMIT::Push(), ACTIONS::refreshPreview, KIGFX::PCB_VIEW::Remove(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, selection(), 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(), view(), and TOOL_INTERACTIVE::Wait().

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

DoSetDrillOrigin()

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

static

Definition at line 1724 of file board_editor_control.cpp.

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

References TOOL_INTERACTIVE::Activate(), PICKER_TOOL_BASE::ClearHandlers(), DoSetDrillOrigin(), DRILLORIGIN, PCB_ACTIONS::drillResetOrigin, PCB_ACTIONS::drillSetOrigin, TOOL_BASE::getView(), GRIDORIGIN, TOOL_EVENT::IsAction(), m_frame, m_placeOrigin, TOOL_BASE::m_toolMgr, TOOL_EVENT::Parameter(), ACTIONS::pickerTool, PLACE, PICKER_TOOL_BASE::SetClickHandler(), and PICKER_TOOL_BASE::SetCursor().

Referenced by setTransitions().

EditFpInFpEditor()

int BOARD_EDITOR_CONTROL::EditFpInFpEditor

(

const TOOL_EVENT &

aEvent

)

Notify Eeschema about selected items.

Definition at line 1682 of file board_editor_control.cpp.

References PCB_ACTIONS::editFpInFpEditor, PCB_ACTIONS::editLibFpInFpEditor, PCB_TOOL_BASE::frame(), FRAME_FOOTPRINT_EDITOR, TOOL_BASE::getEditFrame(), FOOTPRINT::GetFPID(), TOOL_EVENT::IsAction(), KIWAY_HOLDER::Kiway(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), TOOL_BASE::m_toolMgr, KIWAY::Player(), PCB_SELECTION_TOOL::RequestSelection(), PCB_TOOL_BASE::selection(), and ACTIONS::selectionClear.

Referenced by setTransitions().

ExplicitCrossProbeToSch()

int BOARD_EDITOR_CONTROL::ExplicitCrossProbeToSch

(

const TOOL_EVENT &

aEvent

)

Assign a netclass to a labelled net.

Definition at line 1582 of file board_editor_control.cpp.

References doCrossProbePcbToSch().

Referenced by setTransitions().

ExportCmpFile()

int BOARD_EDITOR_CONTROL::ExportCmpFile

(

const TOOL_EVENT &

aEvent

)

Definition at line 66 of file export_footprint_associations.cpp.

References _, PCB_TOOL_BASE::board(), DisplayError(), FILEEXT::FootprintAssignmentFileExtension, FILEEXT::FootprintAssignmentFileWildcard(), m_frame, path, and RecreateCmpFile().

Referenced by setTransitions().

ExportFootprints()

int BOARD_EDITOR_CONTROL::ExportFootprints

(

const TOOL_EVENT &

aEvent

)

Definition at line 278 of file board_editor_control.cpp.

References m_frame.

Referenced by setTransitions().

ExportGenCAD()

int BOARD_EDITOR_CONTROL::ExportGenCAD

(

const TOOL_EVENT &

aEvent

)

Export GenCAD 1.4 format.

Definition at line 43 of file export_gencad.cpp.

References _, DisplayError(), FLIP_BOTTOM_PADS, GENCAD_EXPORTER::FlipBottomPads(), DIALOG_GENCAD_EXPORT_OPTIONS::GetFileName(), DIALOG_GENCAD_EXPORT_OPTIONS::GetOption(), INDIVIDUAL_SHAPES, m_frame, path, GENCAD_EXPORTER::SetPlotOffet(), DIALOG_SHIM::ShowModal(), STORE_ORIGIN_COORDS, GENCAD_EXPORTER::StoreOriginCoordsInFile(), UNIQUE_PIN_NAMES, USE_AUX_ORIGIN, GENCAD_EXPORTER::UseIndividualShapes(), GENCAD_EXPORTER::UsePinNamesUnique(), GENCAD_EXPORTER::WriteFile(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

ExportHyperlynx()

int BOARD_EDITOR_CONTROL::ExportHyperlynx

(

const TOOL_EVENT &

aEvent

)

Definition at line 669 of file export_hyperlynx.cpp.

References _, PCB_TOOL_BASE::board(), m_frame, HYPERLYNX_EXPORTER::Run(), BOARD_EXPORTER_BASE::SetBoard(), and BOARD_EXPORTER_BASE::SetOutputFilename().

Referenced by setTransitions().

ExportIDF()

int BOARD_EDITOR_CONTROL::ExportIDF

(

const TOOL_EVENT &

aEvent

)

Definition at line 87 of file dialog_export_idf.cpp.

References _, PCB_TOOL_BASE::board(), BOX2< Vec >::Centre(), dummy, DIALOG_EXPORT_IDF3::FilePicker(), DIALOG_EXPORT_IDF3::GetNoDNPOption(), DIALOG_EXPORT_IDF3::GetNoUnspecifiedOption(), DIALOG_EXPORT_IDF3::GetSetBoardReferencePoint(), DIALOG_EXPORT_IDF3::GetThouOption(), DIALOG_EXPORT_IDF3::GetXRefMM(), DIALOG_EXPORT_IDF3::GetYRefMM(), LAST_PATH_IDF, m_frame, path, pcbIUScale, DIALOG_SHIM::ShowModal(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

ExportNetlist()

int BOARD_EDITOR_CONTROL::ExportNetlist

(

const TOOL_EVENT &

aEvent

)

Definition at line 421 of file board_editor_control.cpp.

References _, AddFileExtListToFilter(), COMPONENT::AddNet(), PCB_TOOL_BASE::board(), COMPONENT, LEGACYFILEDLG_NETLIST_OPTIONS::Create(), DisplayErrorMessage(), PCB_TOOL_BASE::footprint(), LEGACYFILEDLG_NETLIST_OPTIONS::GetNetlistOptions(), m_frame, netlist, pad, and COMPONENT::SetFields().

Referenced by setTransitions().

ExportSpecctraDSN()

int BOARD_EDITOR_CONTROL::ExportSpecctraDSN

(

const TOOL_EVENT &

aEvent

)

Definition at line 392 of file board_editor_control.cpp.

References _, PCB_TOOL_BASE::frame(), TOOL_BASE::getEditFrame(), LAST_PATH_SPECCTRADSN, m_frame, FILEEXT::SpecctraDsnFileExtension, and FILEEXT::SpecctraDsnFileWildcard().

Referenced by setTransitions().

ExportSTEP()

int BOARD_EDITOR_CONTROL::ExportSTEP

(

const TOOL_EVENT &

aEvent

)

Definition at line 226 of file dialog_export_step.cpp.

References _, FILEEXT::AutoSaveFilePrefix, PCB_TOOL_BASE::board(), DisplayErrorMessage(), m_frame, and DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

ExportVRML()

int BOARD_EDITOR_CONTROL::ExportVRML

(

const TOOL_EVENT &

aEvent

)

Definition at line 73 of file dialog_export_vrml.cpp.

References _, PCB_TOOL_BASE::board(), DisplayErrorMessage(), dummy, DIALOG_EXPORT_VRML::FilePicker(), BOX2< Vec >::GetCenter(), DIALOG_EXPORT_VRML::GetCopyFilesOption(), DIALOG_EXPORT_VRML::GetNoDNPOption(), DIALOG_EXPORT_VRML::GetNoUnspecifiedOption(), DIALOG_EXPORT_VRML::GetScale(), DIALOG_EXPORT_VRML::GetSetUserDefinedOrigin(), DIALOG_EXPORT_VRML::GetSubdir3Dshapes(), DIALOG_EXPORT_VRML::GetUseRelativePathsOption(), DIALOG_EXPORT_VRML::GetXRefMM(), DIALOG_EXPORT_VRML::GetYRefMM(), LAST_PATH_VRML, m_frame, path, pcbIUScale, DIALOG_SHIM::ShowModal(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

Find()

int BOARD_EDITOR_CONTROL::Find

(

const TOOL_EVENT &

aEvent

)

Definition at line 342 of file board_editor_control.cpp.

References m_frame.

Referenced by setTransitions().

FindNext()

int BOARD_EDITOR_CONTROL::FindNext

(

const TOOL_EVENT &

aEvent

)

Definition at line 349 of file board_editor_control.cpp.

References ACTIONS::findPrevious, TOOL_EVENT::IsAction(), and m_frame.

Referenced by setTransitions().

footprint()

FOOTPRINT * PCB_TOOL_BASE::footprint ( ) const

inlineprotectedinherited

Definition at line 184 of file pcb_tool_base.h.

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

Referenced by PCB_CONTROL::AppendBoard(), AUTOPLACE_TOOL::autoplaceOffboard(), AUTOPLACE_TOOL::autoplaceSelected(), MICROWAVE_TOOL::createBaseFootprint(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), MICROWAVE_TOOL::createFootprint(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), MICROWAVE_TOOL::createPolygonShape(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawVia(), FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), FOOTPRINT_EDITOR_CONTROL::EditLibraryFootprint(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), BOARD_EDITOR_CONTROL::ExportNetlist(), BOARD_EDITOR_CONTROL::GenBOMFileFromBoard(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), BOARD_INSPECTION_TOOL::makeDRCEngine(), PAD_TOOL::PadTable(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), FOOTPRINT_EDITOR_CONTROL::Properties(), PAD_TOOL::pushPadSettings(), PCB_CONTROL::RehatchShapes(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), BOARD_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_CONTROL::RepairFootprint(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), DRAWING_TOOL::SetAnchor(), and FOOTPRINT_EDITOR_CONTROL::ShowDatasheet().

frame()

template<class T = PCB_BASE_EDIT_FRAME>

T * PCB_TOOL_BASE::frame ( ) const

inlineprotectedinherited

Definition at line 177 of file pcb_tool_base.h.

References TOOL_BASE::getEditFrame(), and T.

Referenced by PCB_POINT_EDITOR::addCorner(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::BooleanPolygons(), canvas(), PCB_POINT_EDITOR::chamferCorner(), EDIT_TOOL::ChangeTrackLayer(), ZONE_FILLER_TOOL::CheckAllZones(), PNS::TOOL_BASE::checkSnap(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), ROUTER_TOOL::CustomTrackWidthDialog(), FOOTPRINT_EDITOR_CONTROL::DeleteFootprint(), EDIT_TOOL::DeleteItems(), displayOptions(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), 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(), EDIT_TOOL::GetAndPlace(), GetAngleSnapMode(), GLOBAL_EDIT_TOOL::GlobalDeletions(), ROUTER_TOOL::handleLayerSwitch(), EDIT_TOOL::HealShapes(), BOARD_INSPECTION_TOOL::HighlightItem(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), EDIT_TOOL::Init(), PCB_PICKER_TOOL::Init(), ROUTER_TOOL::Init(), SCRIPTING_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), EDIT_TOOL::ModifyLines(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::onViaCommand(), CONVERT_TOOL::OutsetItems(), PAD_TOOL::PadTable(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlacePoint(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), ROUTER_TOOL::prepareInteractive(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), GENERATOR_TOOL::RegenerateAllOfType(), GENERATOR_TOOL::RegenerateItem(), GENERATOR_TOOL::RegenerateSelected(), SCRIPTING_TOOL::reloadPlugins(), PCB_POINT_EDITOR::removeCorner(), MULTICHANNEL_TOOL::RepeatLayout(), MULTICHANNEL_TOOL::RepeatLayout(), MULTICHANNEL_TOOL::repeatLayout(), GENERATOR_TOOL_PNS_PROXY::Reset(), PAD_TOOL::Reset(), PNS::TOOL_BASE::Reset(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), ROUTER_TOOL::saveRouterDebugLog(), CONVERT_TOOL::SegmentToArc(), ROUTER_TOOL::SelectCopperLayerPair(), PCB_PICKER_TOOL::SelectItemInteractively(), PCB_PICKER_TOOL::SelectPointInteractively(), PCB_POINT_EDITOR::setEditedPoint(), ROUTER_TOOL::SettingsDialog(), FOOTPRINT_EDITOR_CONTROL::ShowDatasheet(), BOARD_EDITOR_CONTROL::ShowEeschema(), GENERATOR_TOOL::ShowGeneratorsManager(), EDIT_TOOL::SimplifyPolygons(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), ROUTER_TOOL::switchLayerOnViaPlacement(), PCB_POINT_EDITOR::updateItem(), ROUTER_TOOL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillAll(), and ZONE_FILLER_TOOL::ZoneFillDirty().

GenBOMFileFromBoard()

int BOARD_EDITOR_CONTROL::GenBOMFileFromBoard

(

const TOOL_EVENT &

aEvent

)

Definition at line 71 of file build_BOM_from_board.cpp.

References _, PCB_TOOL_BASE::board(), FILEEXT::CsvFileExtension, FILEEXT::CsvFileWildcard(), DisplayError(), PCB_TOOL_BASE::footprint(), FP_EXCLUDE_FROM_BOM, From_UTF8(), BOM_ENTRY::m_Count, BOM_ENTRY::m_FPID, m_frame, BOM_ENTRY::m_Id, BOM_ENTRY::m_Ref, BOM_ENTRY::m_Val, and TO_UTF8.

Referenced by setTransitions().

GenD356File()

int BOARD_EDITOR_CONTROL::GenD356File

(

const TOOL_EVENT &

aEvent

)

Definition at line 432 of file export_d356.cpp.

References _, DisplayError(), DisplayInfoMessage(), D365_CUSTOMIZE_HOOK::GetDoNotExportUnconnectedPads(), FILEEXT::IpcD356FileExtension, FILEEXT::IpcD356FileWildcard(), m_frame, IPC356D_WRITER::SetDoNotExportUnconnectedPads(), and IPC356D_WRITER::Write().

Referenced by setTransitions().

GenerateDrillFiles()

int BOARD_EDITOR_CONTROL::GenerateDrillFiles

(

const TOOL_EVENT &

aEvent

)

Definition at line 58 of file dialog_gendrill.cpp.

References TOOL_BASE::getEditFrame(), and DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

GenerateGerbers()

int BOARD_EDITOR_CONTROL::GenerateGerbers

(

const TOOL_EVENT &

aEvent

)

Definition at line 487 of file board_editor_control.cpp.

References GERBER, m_frame, PCB_PLOT_PARAMS::SetFormat(), and DIALOG_SHIM::ShowQuasiModal().

Referenced by setTransitions().

GenerateODBPPFiles()

int BOARD_EDITOR_CONTROL::GenerateODBPPFiles

(

const TOOL_EVENT &

aEvent

)

Definition at line 1292 of file pcbnew/files.cpp.

References _, DisplayError(), DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), DIALOG_EXPORT_ODBPP::GetCompressFormat(), WX_STRING_REPORTER::GetMessages(), DIALOG_EXPORT_ODBPP::GetOutputPath(), DIALOG_EXPORT_ODBPP::GetPrecision(), DIALOG_EXPORT_ODBPP::GetUnitsString(), REPORTER::HasMessage(), JOB_EXPORT_PCB_ODB::INCH, JOB_EXPORT_PCB_ODB::m_compressionMode, JOB_EXPORT_PCB_ODB::m_filename, m_frame, JOB_EXPORT_PCB_ODB::m_precision, JOB_EXPORT_PCB_ODB::m_units, JOB_EXPORT_PCB_ODB::MM, PR_CAN_ABORT, JOB::SetConfiguredOutputPath(), and DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

GeneratePosFile()

int BOARD_EDITOR_CONTROL::GeneratePosFile

(

const TOOL_EVENT &

aEvent

)

Definition at line 473 of file dialog_gen_footprint_position.cpp.

References TOOL_BASE::getEditFrame(), and DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

GenFootprintsReport()

int BOARD_EDITOR_CONTROL::GenFootprintsReport

(

const TOOL_EVENT &

aEvent

)

Definition at line 517 of file dialog_gen_footprint_position.cpp.

References _, PCB_TOOL_BASE::board(), PLACE_FILE_EXPORTER::GenReportData(), m_frame, and MM.

Referenced by setTransitions().

GenIPC2581File()

int BOARD_EDITOR_CONTROL::GenIPC2581File

(

const TOOL_EVENT &

aEvent

)

Definition at line 1282 of file pcbnew/files.cpp.

References m_frame, and DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

GetAngleSnapMode()

LEADER_MODE PCB_TOOL_BASE::GetAngleSnapMode ( ) const

inherited

Get the current angle snapping mode.

Definition at line 341 of file pcb_tool_base.cpp.

References frame(), FRAME_PCB_EDITOR, and GetAppSettings().

Referenced by EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), Is45Limited(), Is90Limited(), PNS::TOOL_BASE::updateEndItem(), and DRAWING_TOOL::UpdateStatusBar().

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 getToolHolderInternal(), and T.

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_EDITOR_CONTROL::BoardSetup(), PCB_POINT_EDITOR::chamferCorner(), PCB_POINT_EDITOR::changeArcEditMode(), ZONE_FILLER_TOOL::CheckAllZones(), FOOTPRINT_EDITOR_CONTROL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupTracksAndVias(), EDIT_TOOL::copyToClipboard(), ARRAY_TOOL::CreateArray(), MICROWAVE_TOOL::createBaseFootprint(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createInductorBetween(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), FOOTPRINT_EDITOR_CONTROL::DefaultPadProperties(), FOOTPRINT_EDITOR_CONTROL::DeleteFootprint(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomFit(), MICROWAVE_TOOL::drawMicrowaveInductor(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PCB_SELECTION_TOOL::editFrame(), GLOBAL_EDIT_TOOL::EditTeardrops(), FOOTPRINT_EDITOR_CONTROL::EditTextAndGraphics(), GLOBAL_EDIT_TOOL::EditTextAndGraphics(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), ZONE_FILLER_TOOL::FillAllZones(), FOOTPRINT_WIZARD_TOOLS::frame(), PCB_SELECTION_TOOL::frame(), PCB_TEST_SELECTION_TOOL::frame(), PCB_TOOL_BASE::frame(), PCB_VIEWER_TOOLS::frame(), BOARD_EDITOR_CONTROL::GenerateDrillFiles(), BOARD_EDITOR_CONTROL::GeneratePosFile(), GLOBAL_EDIT_TOOL::GlobalDeletions(), PCB_CONTROL::GridPlaceOrigin(), BOARD_EDITOR_CONTROL::ImportNetlist(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), CONVERT_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), DRAWING_TOOL::Init(), GERBVIEW_SELECTION_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_DESIGN_BLOCK_CONTROL::Init(), PCB_PICKER_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_TOOL_BASE::Init(), PICKER_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_EDITOR_CONTROL::Init(), PL_POINT_EDITOR::Init(), PL_SELECTION_TOOL::Init(), ROUTER_TOOL::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SCH_SELECTION_TOOL::Init(), SCH_TOOL_BASE< T >::Init(), ZOOM_TOOL::Init(), ROUTER_TOOL::InlineDrag(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_POINT_EDITOR::movePoint(), ARRAY_TOOL::onDialogClosed(), SELECTION_TOOL::onDisambiguationExpire(), PCB_POINT_EDITOR::OnSelectionChange(), CONVERT_TOOL::OutsetItems(), ROUTER_TOOL::performRouting(), EDIT_TOOL::pickReferencePoint(), POSITION_RELATIVE_TOOL::PositionRelative(), ROUTER_TOOL::prepareInteractive(), EDIT_TOOL::Properties(), FOOTPRINT_EDITOR_CONTROL::Properties(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), BITMAP2CMP_CONTROL::Reset(), BOARD_EDITOR_CONTROL::Reset(), BOARD_INSPECTION_TOOL::Reset(), BOARD_REANNOTATE_TOOL::Reset(), COMMON_CONTROL::Reset(), COMMON_TOOLS::Reset(), CVPCB_ASSOCIATION_TOOL::Reset(), CVPCB_CONTROL::Reset(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Reset(), DESIGN_BLOCK_CONTROL::Reset(), DRAWING_TOOL::Reset(), DRC_TOOL::Reset(), EDIT_TOOL::Reset(), FOOTPRINT_EDITOR_CONTROL::Reset(), GERBVIEW_CONTROL::Reset(), GERBVIEW_INSPECTION_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), GROUP_TOOL::Reset(), KICAD_MANAGER_CONTROL::Reset(), LIBRARY_EDITOR_CONTROL::Reset(), PCB_CALCULATOR_CONTROL::Reset(), PCB_CONTROL::Reset(), PCB_POINT_EDITOR::Reset(), PCB_SELECTION_TOOL::Reset(), PL_DRAWING_TOOLS::Reset(), PL_EDIT_TOOL::Reset(), PL_EDITOR_CONTROL::Reset(), PL_POINT_EDITOR::Reset(), PL_SELECTION_TOOL::Reset(), SCH_SELECTION_TOOL::Reset(), SCH_TOOL_BASE< T >::Reset(), SIMULATOR_CONTROL::Reset(), ZOOM_TOOL::Reset(), FOOTPRINT_EDITOR_CONTROL::Revert(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), CONVERT_TOOL::SegmentToArc(), GERBVIEW_SELECTION_TOOL::selectable(), BOARD_EDITOR_CONTROL::ToggleLayersManager(), BOARD_EDITOR_CONTROL::ToggleLibraryTree(), BOARD_EDITOR_CONTROL::ToggleNetInspector(), BOARD_EDITOR_CONTROL::ToggleProperties(), BOARD_EDITOR_CONTROL::ToggleSearch(), PROPERTIES_TOOL::UpdateProperties(), ZONE_FILLER_TOOL::ZoneFillDirty(), and GLOBAL_EDIT_TOOL::ZonesManager().

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 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 m_toolMgr, and TOOL_MANAGER.

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), PCB_TOOL_BASE::doInteractiveItemPlacement(), PCB_TUNING_PATTERN::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_TUNING_PATTERN::EditStart(), makeShapeModificationMenu(), PAD_TOOL::PlacePad(), MULTICHANNEL_TOOL::RepeatLayout(), 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 getModelInternal(), and T.

Referenced by BOARD_EDITOR_CONTROL::AutoTrackWidth(), PCB_SELECTION_TOOL::board(), PCB_TEST_SELECTION_TOOL::board(), PCB_TOOL_BASE::board(), PCB_VIEWER_TOOLS::board(), COMMON_TOOLS::doCenter(), PCB_SELECTION_TOOL::filterSelection(), PCB_GROUP_TOOL::Group(), BOARD_INSPECTION_TOOL::HideLocalRatsnest(), EMBED_TOOL::Init(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PAD_TOOL::pushPadSettings(), BOARD_EDITOR_CONTROL::Reset(), DRAWING_TOOL::Reset(), EMBED_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::selectPoint(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), and BOARD_EDITOR_CONTROL::ZoneMerge().

getModelInternal()

EDA_ITEM * TOOL_BASE::getModelInternal ( ) const

privateinherited

Definition at line 56 of file tool_base.cpp.

References m_toolMgr.

Referenced by 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 m_toolName.

Referenced by PCB_CONTROL::AppendBoard(), TOOL_MANAGER::dispatchInternal(), COMMON_TOOLS::GridProperties(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::invokeTool(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::runTool(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::SetContextMenu(), and TOOL_MANAGER::ShutdownTool().

getToolHolderInternal()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInternal ( ) const

privateinherited

Definition at line 50 of file tool_base.cpp.

References m_toolMgr.

Referenced by getEditFrame().

GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inherited

Definition at line 112 of file tool_interactive.cpp.

References m_menu.

Referenced by BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), FOOTPRINT_CHOOSER_SELECTION_TOOL::Init(), GENERATOR_TOOL::Init(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), and SYMBOL_EDITOR_EDIT_TOOL::Init().

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

Referenced by TOOL_MANAGER::InvokeTool(), TOOL_MANAGER::InvokeTool(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::runTool(), TOOL_MANAGER::ShutdownTool(), 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 38 of file tool_base.cpp.

References m_toolMgr.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), GERBVIEW_CONTROL::ClearAllLayers(), PL_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::CollectHits(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), COMMON_TOOLS::doCenter(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), 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::drawOneBezier(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SCH_SELECTION_TOOL::EnterGroup(), PAD_TOOL::EnumeratePads(), SCH_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), SCH_SELECTION_TOOL::GetNode(), ROUTER_TOOL::getStartLayer(), PCB_CONTROL::GridPlaceOrigin(), PCB_CONTROL::GridResetOrigin(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), ROUTER_TOOL::handleCommonEvents(), PCB_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), SCH_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), PCB_SELECTION_TOOL::hitTestDistance(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineDrag(), PCB_CONTROL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), PCB_PICKER_TOOL::Main(), PL_POINT_EDITOR::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), PL_EDIT_TOOL::Paste(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), ROUTER_TOOL::prepareInteractive(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), BOARD_EDITOR_CONTROL::Reset(), DRAWING_TOOL::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PCB_CONTROL::Reset(), PCB_SELECTION_TOOL::Reset(), PNS::TOOL_BASE::Reset(), SCH_SELECTION_TOOL::Reset(), SCH_TOOL_BASE< T >::Reset(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::selectionContains(), SCH_SELECTION_TOOL::selectionContains(), SCH_SELECTION_TOOL::selectLasso(), PCB_SELECTION_TOOL::SelectMultiple(), SCH_SELECTION_TOOL::SelectMultiple(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), PCB_SELECTION_TOOL::unhighlight(), PCB_TEST_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), PCB_SELECTION_TOOL::UnselectAll(), SCH_SELECTION_TOOL::UnselectAll(), GERBVIEW_SELECTION_TOOL::unselectVisually(), PCB_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateItem(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_SELECTION_TOOL::updateSelection(), SCH_SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_SELECTION_TOOL::view(), PCB_TEST_SELECTION_TOOL::view(), PCB_TOOL_BASE::view(), PCB_VIEWER_TOOLS::view(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), SCH_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::zoomFitSelection(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL(), and SCH_SELECTION_TOOL::~SCH_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 44 of file tool_base.cpp.

References m_toolMgr.

Referenced by PCB_POINT_EDITOR::addCorner(), SCH_SELECTION_TOOL::autostartEvent(), PCB_POINT_EDITOR::chamferCorner(), PCB_SELECTION_TOOL::controls(), PCB_TEST_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), EDIT_TOOL::copyToClipboard(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), BOARD_INSPECTION_TOOL::HighlightNet(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_TOOL_BASE< T >::Increment(), EDIT_TOOL::Init(), PCB_PICKER_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_POINT_EDITOR::makePoints(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), EDIT_TOOL::Properties(), PL_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), PCB_SELECTION_TOOL::selectCursor(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::SelectNode(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PCB_PICKER_TOOL::setControls(), PICKER_TOOL::setControls(), PCB_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PL_EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

Go()

template<class T>

void TOOL_INTERACTIVE::Go ( int(T::* aStateFunc )(const TOOL_EVENT &), 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 goInternal(), and T.

Referenced by ALIGN_DISTRIBUTE_TOOL::setTransitions(), ARRAY_TOOL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), BITMAP2CMP_CONTROL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), COMMON_CONTROL::setTransitions(), COMMON_TOOLS::setTransitions(), CONVERT_TOOL::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), DESIGN_BLOCK_CONTROL::setTransitions(), DRAWING_TOOL::setTransitions(), DRC_TOOL::setTransitions(), EDA_3D_CONTROLLER::setTransitions(), EDIT_TOOL::setTransitions(), EMBED_TOOL::setTransitions(), FOOTPRINT_CHOOSER_SELECTION_TOOL::setTransitions(), FOOTPRINT_EDITOR_CONTROL::setTransitions(), FOOTPRINT_WIZARD_TOOLS::setTransitions(), GENERATOR_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), GROUP_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), LIBRARY_EDITOR_CONTROL::setTransitions(), MICROWAVE_TOOL::setTransitions(), MULTICHANNEL_TOOL::setTransitions(), PAD_TOOL::setTransitions(), PCB_CALCULATOR_CONTROL::setTransitions(), PCB_CONTROL::setTransitions(), PCB_DESIGN_BLOCK_CONTROL::setTransitions(), PCB_EDIT_TABLE_TOOL::setTransitions(), PCB_PICKER_TOOL::setTransitions(), PCB_POINT_EDITOR::setTransitions(), PCB_SELECTION_TOOL::setTransitions(), PCB_TEST_SELECTION_TOOL::setTransitions(), PCB_VIEWER_TOOLS::setTransitions(), PICKER_TOOL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), PL_EDIT_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), PL_POINT_EDITOR::setTransitions(), PL_SELECTION_TOOL::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), PROPERTIES_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), SCH_DESIGN_BLOCK_CONTROL::setTransitions(), SCH_SELECTION_TOOL::setTransitions(), SCRIPTING_TOOL::setTransitions(), SIMULATOR_CONTROL::setTransitions(), ZONE_FILLER_TOOL::setTransitions(), and ZOOM_TOOL::setTransitions().

goInternal()

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

privateinherited

Definition at line 84 of file tool_interactive.cpp.

Referenced by Go().

ImportNetlist()

int BOARD_EDITOR_CONTROL::ImportNetlist

(

const TOOL_EVENT &

aEvent

)

Definition at line 363 of file board_editor_control.cpp.

References TOOL_BASE::getEditFrame().

Referenced by setTransitions().

ImportSpecctraSession()

int BOARD_EDITOR_CONTROL::ImportSpecctraSession

(

const TOOL_EVENT &

aEvent

)

Definition at line 370 of file board_editor_control.cpp.

References _, PCB_TOOL_BASE::frame(), TOOL_BASE::getEditFrame(), name, path, FILEEXT::SpecctraSessionFileExtension, and FILEEXT::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 171 of file board_editor_control.cpp.

References CONDITIONAL_MENU::AddItem(), CONDITIONAL_MENU::AddMenu(), CONDITIONAL_MENU::AddSeparator(), ACTIONS::cancelInteractive, PCB_ACTIONS::getAndPlace, DRAWING_TOOL::GetDrawingMode(), TOOL_BASE::getEditFrame(), TOOL_MENU::GetMenu(), TOOL_INTERACTIVE::GetToolMenu(), m_frame, TOOL_INTERACTIVE::m_menu, TOOL_BASE::m_toolMgr, SELECTION_CONDITIONS::NotEmpty(), SELECTION_CONDITIONS::OnlyTypes(), PCB_ACTIONS::placeFootprint, TOOL_MENU::RegisterSubMenu(), 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 331 of file pcb_tool_base.cpp.

References DIRECT, and GetAngleSnapMode().

Referenced by PCB_POINT_EDITOR::OnSelectionChange().

Is90Limited()

bool PCB_TOOL_BASE::Is90Limited ( ) const

virtualinherited

Should the tool limit drawing to horizontal and vertical only?

Definition at line 336 of file pcb_tool_base.cpp.

References DEG90, and GetAngleSnapMode().

Referenced by PCB_POINT_EDITOR::OnSelectionChange(), and PCB_POINT_EDITOR::setAltConstraint().

IsBoardEditor()

bool PCB_TOOL_BASE::IsBoardEditor ( ) const

inlineinherited

Definition at line 110 of file pcb_tool_base.h.

References m_isBoardEditor.

IsFootprintEditor()

bool PCB_TOOL_BASE::IsFootprintEditor ( ) const

inlineinherited

Definition at line 107 of file pcb_tool_base.h.

References m_isFootprintEditor.

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

IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 32 of file tool_base.cpp.

References m_toolId, and m_toolMgr.

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

LockSelected()

int BOARD_EDITOR_CONTROL::LockSelected

(

const TOOL_EVENT &

aEvent

)

Unlock selected items.

Definition at line 1312 of file board_editor_control.cpp.

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

References _, EDA_GROUP::AsEdaItem(), CHT_MODIFY, COMMIT::Empty(), EDA_ITEM::GetParentGroup(), PCB_SELECTION_TOOL::GetSelection(), COMMIT::GetStatus(), m_frame, TOOL_BASE::m_toolMgr, COMMIT::Modify(), OFF, ON, PCB_GENERATOR_T, PCB_PAD_T, BOARD_COMMIT::Push(), EVENTS::SelectedEvent, PCB_TOOL_BASE::selection(), ACTIONS::selectionCursor, BOARD_ITEM::SetLocked(), PCB_GROUP::SetLocked(), SKIP_TEARDROPS, TOGGLE, and EDA_ITEM::Type().

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

New()

int BOARD_EDITOR_CONTROL::New

(

const TOOL_EVENT &

aEvent

)

Definition at line 345 of file pcbnew/files.cpp.

References _, HandleUnsavedChanges(), IsOK(), Kiface(), and m_frame.

Referenced by setTransitions().

Open()

int BOARD_EDITOR_CONTROL::Open

(

const TOOL_EVENT &

aEvent

)

Definition at line 269 of file pcbnew/files.cpp.

References AskLoadBoardFileName(), KICTL_KICAD_ONLY, Kiface(), and m_frame.

Referenced by setTransitions().

OpenNonKicadBoard()

int BOARD_EDITOR_CONTROL::OpenNonKicadBoard

(

const TOOL_EVENT &

aEvent

)

Definition at line 285 of file pcbnew/files.cpp.

References AskLoadBoardFileName(), KICTL_NONKICAD_ONLY, and m_frame.

Referenced by setTransitions().

PageSettings()

int BOARD_EDITOR_CONTROL::PageSettings

(

const TOOL_EVENT &

aEvent

)

Definition at line 285 of file board_editor_control.cpp.

References _, KIGFX::GEOMETRY, BASE_SCREEN::m_DrawingSheetFileName, m_frame, MAX_PAGE_SIZE_PCBNEW_MILS, PAGESETTINGS, pcbIUScale, PICKED_ITEMS_LIST::PushItem(), KIGFX::REPAINT, PICKED_ITEMS_LIST::SetDescription(), DIALOG_PAGES_SETTINGS::SetWksFileName(), DIALOG_SHIM::ShowModal(), and text.

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

References _, TOOL_INTERACTIVE::Activate(), COMMIT::Add(), ANGLE_0, ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, PCB_TOOL_BASE::controls(), FOOTPRINT::Flip(), PCB_TOOL_BASE::frame(), PGM_BASE::GetCommonSettings(), TOOL_BASE::getModel(), KIGFX::VIEW_CONTROLS::GetMousePosition(), FOOTPRINT::GetPosition(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_EVENT::HasPosition(), COMMON_SETTINGS::INPUT::immediate_actions, IS_NEW, FOOTPRINT::IsFlipped(), TOOL_EVENT::IsReactivate(), ZONE_FILLER_TOOL::IsZoneFillAction(), m_frame, m_inPlaceFootprint, COMMON_SETTINGS::m_Input, TOOL_INTERACTIVE::m_menu, m_placingFootprint, TOOL_BASE::m_toolMgr, niluuid, pad, FOOTPRINT::Pads(), TOOL_EVENT::Parameter(), PENCIL, Pgm(), KIGFX::VIEW_CONTROLS::PinCursorInsideNonAutoscrollArea(), TOOL_EVENT::Position(), PCB_ACTIONS::properties, BOARD_COMMIT::Push(), ACTIONS::redo, ACTIONS::refreshPreview, BOARD_COMMIT::Revert(), PCB_TOOL_BASE::selection(), ACTIONS::selectionClear, ACTIONS::selectItem, EDA_ITEM::SetFlags(), FOOTPRINT::SetLink(), FOOTPRINT::SetOrientation(), EDA_ITEM::SetParent(), FOOTPRINT::SetPosition(), SELECTION::SetReferencePoint(), ACTIONS::undo, undo, KIGFX::VIEW::Update(), TOOL_INTERACTIVE::Wait(), and KIGFX::VIEW_CONTROLS::WarpMouseCursor().

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

References m_frame, and DIALOG_SHIM::ShowQuasiModal().

Referenced by setTransitions().

RepairBoard()

int BOARD_EDITOR_CONTROL::RepairBoard

(

const TOOL_EVENT &

aEvent

)

Definition at line 502 of file board_editor_control.cpp.

References _, BOARD::Add(), PCB_TOOL_BASE::board(), DisplayInfoMessage(), PCB_TOOL_BASE::footprint(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetCode(), NETINFO_ITEM::GetNetname(), group, m_frame, pad, and TOOL_EVENT::Parameter().

Referenced by setTransitions().

RescueAutosave()

int BOARD_EDITOR_CONTROL::RescueAutosave

(

const TOOL_EVENT &

aEvent

)

Definition at line 298 of file pcbnew/files.cpp.

References _, FILEEXT::AutoSaveFilePrefix, DisplayError(), IsOK(), and m_frame.

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

References KIGFX::VIEW::Add(), TOOL_BASE::GAL_SWITCH, TOOL_BASE::getEditFrame(), TOOL_BASE::getModel(), TOOL_BASE::getView(), m_frame, m_placeOrigin, 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 77 of file tool_interactive.cpp.

Revert()

int BOARD_EDITOR_CONTROL::Revert

(

const TOOL_EVENT &

aEvent

)

Definition at line 328 of file pcbnew/files.cpp.

References _, IsOK(), KICTL_REVERT, and m_frame.

Referenced by 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 106 of file tool_interactive.cpp.

Referenced by DRAWING_TOOL::PlaceText().

Save()

int BOARD_EDITOR_CONTROL::Save

(

const TOOL_EVENT &

aEvent

)

Definition at line 257 of file board_editor_control.cpp.

References m_frame.

Referenced by setTransitions().

SaveAs()

int BOARD_EDITOR_CONTROL::SaveAs

(

const TOOL_EVENT &

aEvent

)

Definition at line 264 of file board_editor_control.cpp.

References m_frame.

Referenced by setTransitions().

SaveCopy()

int BOARD_EDITOR_CONTROL::SaveCopy

(

const TOOL_EVENT &

aEvent

)

Definition at line 271 of file board_editor_control.cpp.

References m_frame.

Referenced by setTransitions().

Search()

int BOARD_EDITOR_CONTROL::Search

(

const TOOL_EVENT &

aEvent

)

Definition at line 335 of file board_editor_control.cpp.

References m_frame.

Referenced by setTransitions().

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(), 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(), and TOOL_BASE::m_toolMgr.

Referenced by PCB_CONTROL::AppendBoard(), PCB_CONTROL::ApplyDesignBlockLayout(), BOARD_EDITOR_CONTROL::AssignNetclass(), AUTOPLACE_TOOL::autoplaceSelected(), EDIT_TOOL::BooleanPolygons(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::ChangeTrackWidth(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::copyToClipboardAsText(), ARRAY_TOOL::CreateArray(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), DRC_TOOL::CrossProbe(), BOARD_INSPECTION_TOOL::DiffFootprint(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), PCB_EDIT_TABLE_TOOL::EditTable(), PAD_TOOL::EnumeratePads(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), EDIT_TOOL::FilletTracks(), EDIT_TOOL::Flip(), DRAWING_TOOL::getSourceZoneForAction(), EDIT_TOOL::HealShapes(), BOARD_INSPECTION_TOOL::highlightNet(), EDIT_TOOL::Increment(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), EDIT_TOOL::JustifyText(), PCB_CONTROL::LayerPresetFeedback(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), ROUTER_TOOL::MainLoop(), EDIT_TOOL::Mirror(), EDIT_TOOL::ModifyLines(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), ARRAY_TOOL::onDialogClosed(), PCB_POINT_EDITOR::OnSelectionChange(), CONVERT_TOOL::OutsetItems(), EDIT_TOOL::PackAndMoveFootprints(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_CONTROL::PlaceLinkedDesignBlock(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelative(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), BOARD_REANNOTATE_TOOL::ReannotateDuplicatesInSelection(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), MULTICHANNEL_TOOL::repeatLayout(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), PCB_CONTROL::SaveToLinkedDesignBlock(), CONVERT_TOOL::SegmentToArc(), DRAWING_TOOL::SetAnchor(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), EDIT_TOOL::SimplifyPolygons(), EDIT_TOOL::Swap(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), PCB_CONTROL::UpdateMessagePanel(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), and BOARD_EDITOR_CONTROL::ZoneMerge().

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

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

Referenced by SELECTION_TOOL::doSelectionMenu(), and DRAWING_TOOL::DrawVia().

SetIsBoardEditor()

void PCB_TOOL_BASE::SetIsBoardEditor ( bool aEnabled )

inlineinherited

Definition at line 109 of file pcb_tool_base.h.

References 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 106 of file pcb_tool_base.h.

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

References AssignNetclass(), PCB_ACTIONS::assignNetClass, AutoTrackWidth(), PCB_ACTIONS::autoTrackWidth, BoardSetup(), PCB_ACTIONS::boardSetup, EVENTS::ClearedEvent, CrossProbeToSch(), ACTIONS::doNew, DrillOrigin(), PCB_ACTIONS::drillOrigin, PCB_ACTIONS::drillResetOrigin, PCB_ACTIONS::drillSetOrigin, EditFpInFpEditor(), PCB_ACTIONS::editFpInFpEditor, PCB_ACTIONS::editLibFpInFpEditor, ExplicitCrossProbeToSch(), ExportCmpFile(), PCB_ACTIONS::exportCmpFile, ExportFootprints(), PCB_ACTIONS::exportFootprints, ExportGenCAD(), PCB_ACTIONS::exportGenCAD, ExportHyperlynx(), PCB_ACTIONS::exportHyperlynx, ExportIDF(), PCB_ACTIONS::exportIDF, ExportNetlist(), ExportSpecctraDSN(), PCB_ACTIONS::exportSpecctraDSN, ExportSTEP(), PCB_ACTIONS::exportSTEP, ExportVRML(), PCB_ACTIONS::exportVRML, Find(), ACTIONS::find, FindNext(), ACTIONS::findNext, ACTIONS::findPrevious, GenBOMFileFromBoard(), GenD356File(), PCB_ACTIONS::generateBOM, PCB_ACTIONS::generateD356File, GenerateDrillFiles(), PCB_ACTIONS::generateDrillFiles, GenerateGerbers(), PCB_ACTIONS::generateGerbers, PCB_ACTIONS::generateIPC2581File, PCB_ACTIONS::generateODBPPFile, GenerateODBPPFiles(), GeneratePosFile(), PCB_ACTIONS::generatePosFile, PCB_ACTIONS::generateReportFile, GenFootprintsReport(), GenIPC2581File(), ADVANCED_CFG::GetCfg(), TOOL_INTERACTIVE::Go(), ImportNetlist(), PCB_ACTIONS::importNetlist, ImportSpecctraSession(), PCB_ACTIONS::importSpecctraSession, PCB_ACTIONS::lock, LockSelected(), m_frame, New(), Open(), ACTIONS::open, OpenNonKicadBoard(), PCB_ACTIONS::openNonKicadBoard, PageSettings(), ACTIONS::pageSettings, PlaceFootprint(), PCB_ACTIONS::placeFootprint, Plot(), ACTIONS::plot, EVENTS::PointSelectedEvent, RepairBoard(), PCB_ACTIONS::repairBoard, RescueAutosave(), PCB_ACTIONS::rescueAutosave, Revert(), ACTIONS::revert, Save(), ACTIONS::save, SaveAs(), ACTIONS::saveAs, SaveCopy(), ACTIONS::saveCopy, Search(), EVENTS::SelectedEvent, PCB_ACTIONS::selectOnSchematic, PCB_ACTIONS::showDesignBlockPanel, ShowEeschema(), PCB_ACTIONS::showEeschema, PCB_ACTIONS::showLayersManager, PCB_ACTIONS::showNetInspector, ACTIONS::showProperties, PCB_ACTIONS::showPythonConsole, ACTIONS::showSearch, ToggleLayersManager(), ToggleLibraryTree(), PCB_ACTIONS::toggleLock, ToggleLockSelected(), ToggleNetInspector(), ToggleProperties(), TogglePythonConsole(), ToggleSearch(), TrackWidthDec(), PCB_ACTIONS::trackWidthDec, TrackWidthInc(), PCB_ACTIONS::trackWidthInc, PCB_ACTIONS::unlock, UnlockSelected(), EVENTS::UnselectedEvent, 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 662 of file board_editor_control.cpp.

References _, DisplayErrorMessage(), EESCHEMA_EXE, ExecuteFile(), PCB_TOOL_BASE::frame(), FRAME_SCH, FILEEXT::KiCadSchematicFileExtension, Kiface(), KIWAY_HOLDER::Kiway(), FILEEXT::LegacySchematicFileExtension, m_frame, KIWAY::Player(), KIWAY_HOLDER::Prj(), project, and IO_ERROR::What().

Referenced by setTransitions(), and UpdateSchematicFromPCB().

ToggleLayersManager()

int BOARD_EDITOR_CONTROL::ToggleLayersManager

(

const TOOL_EVENT &

aEvent

)

Definition at line 749 of file board_editor_control.cpp.

References TOOL_BASE::getEditFrame().

Referenced by setTransitions().

ToggleLibraryTree()

int BOARD_EDITOR_CONTROL::ToggleLibraryTree

(

const TOOL_EVENT &

aEvent

)

Definition at line 770 of file board_editor_control.cpp.

References TOOL_BASE::getEditFrame().

Referenced by setTransitions().

ToggleLockSelected()

int BOARD_EDITOR_CONTROL::ToggleLockSelected

(

const TOOL_EVENT &

aEvent

)

Lock selected items.

Definition at line 1306 of file board_editor_control.cpp.

References modifyLockSelected(), and TOGGLE.

Referenced by setTransitions().

ToggleNetInspector()

int BOARD_EDITOR_CONTROL::ToggleNetInspector

(

const TOOL_EVENT &

aEvent

)

Definition at line 763 of file board_editor_control.cpp.

References TOOL_BASE::getEditFrame().

Referenced by setTransitions().

ToggleProperties()

int BOARD_EDITOR_CONTROL::ToggleProperties

(

const TOOL_EVENT &

aEvent

)

Definition at line 756 of file board_editor_control.cpp.

References TOOL_BASE::getEditFrame().

Referenced by setTransitions().

TogglePythonConsole()

int BOARD_EDITOR_CONTROL::TogglePythonConsole

(

const TOOL_EVENT &

aEvent

)

Definition at line 784 of file board_editor_control.cpp.

References m_frame.

Referenced by setTransitions().

ToggleSearch()

int BOARD_EDITOR_CONTROL::ToggleSearch

(

const TOOL_EVENT &

aEvent

)

Definition at line 777 of file board_editor_control.cpp.

References TOOL_BASE::getEditFrame().

Referenced by setTransitions().

TrackWidthDec()

int BOARD_EDITOR_CONTROL::TrackWidthDec

(

const TOOL_EVENT &

aEvent

)

Definition at line 874 of file board_editor_control.cpp.

References _, NET_SETTINGS::GetDefaultNetclass(), BOARD_DESIGN_SETTINGS::GetDiffPairIndex(), TOOL_BASE::getModel(), PNS::ROUTER::GetState(), NETCLASS::GetTrackWidth(), BOARD_DESIGN_SETTINGS::GetTrackWidthIndex(), TOOL_BASE::IsToolActive(), BOARD_DESIGN_SETTINGS::m_DiffPairDimensionsList, m_frame, BOARD_DESIGN_SETTINGS::m_NetSettings, 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(), PNS::PNS_MODE_ROUTE_DIFF_PAIR, BOARD_COMMIT::Push(), PNS::ROUTER::ROUTE_TRACK, PNS::TOOL_BASE::Router(), PCB_TOOL_BASE::selection(), BOARD_DESIGN_SETTINGS::SetDiffPairIndex(), BOARD_DESIGN_SETTINGS::SetTrackWidthIndex(), PCB_TRACK::SetWidth(), 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 792 of file board_editor_control.cpp.

References _, NET_SETTINGS::GetDefaultNetclass(), BOARD_DESIGN_SETTINGS::GetDiffPairIndex(), TOOL_BASE::getModel(), PNS::ROUTER::GetState(), NETCLASS::GetTrackWidth(), BOARD_DESIGN_SETTINGS::GetTrackWidthIndex(), PCB_TRACK::GetWidth(), TOOL_BASE::IsToolActive(), BOARD_DESIGN_SETTINGS::m_DiffPairDimensionsList, m_frame, BOARD_DESIGN_SETTINGS::m_NetSettings, 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(), PNS::PNS_MODE_ROUTE_DIFF_PAIR, BOARD_COMMIT::Push(), PNS::ROUTER::ROUTE_TRACK, PNS::TOOL_BASE::Router(), PCB_TOOL_BASE::selection(), BOARD_DESIGN_SETTINGS::SetDiffPairIndex(), BOARD_DESIGN_SETTINGS::SetTrackWidthIndex(), PCB_TRACK::SetWidth(), 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 1318 of file board_editor_control.cpp.

References modifyLockSelected(), and OFF.

Referenced by setTransitions().

UpdatePCBFromSchematic()

int BOARD_EDITOR_CONTROL::UpdatePCBFromSchematic

(

const TOOL_EVENT &

aEvent

)

Definition at line 619 of file board_editor_control.cpp.

References _, m_frame, netlist, and DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

UpdateSchematicFromPCB()

int BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB

(

const TOOL_EVENT &

aEvent

)

Definition at line 633 of file board_editor_control.cpp.

References _, DisplayErrorMessage(), dummy, PCB_TOOL_BASE::frame(), FRAME_SCH, Kiface(), m_frame, MAIL_SCH_UPDATE, and ShowEeschema().

Referenced by setTransitions().

ViaSizeDec()

int BOARD_EDITOR_CONTROL::ViaSizeDec

(

const TOOL_EVENT &

aEvent

)

Definition at line 1012 of file board_editor_control.cpp.

References PADSTACK::ALL_LAYERS, NET_SETTINGS::GetDefaultNetclass(), TOOL_BASE::getModel(), NETCLASS::GetViaDiameter(), NETCLASS::GetViaDrill(), BOARD_DESIGN_SETTINGS::GetViaSizeIndex(), VIA_DIMENSION::m_Diameter, VIA_DIMENSION::m_Drill, m_frame, BOARD_DESIGN_SETTINGS::m_NetSettings, TOOL_BASE::m_toolMgr, BOARD_DESIGN_SETTINGS::m_ViasDimensionsList, COMMIT::Modify(), SELECTION_CONDITIONS::OnlyTypes(), PCB_VIA_T, BOARD_COMMIT::Push(), PCB_TOOL_BASE::selection(), BOARD_DESIGN_SETTINGS::SetViaSizeIndex(), 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 956 of file board_editor_control.cpp.

References _, PADSTACK::ALL_LAYERS, NET_SETTINGS::GetDefaultNetclass(), TOOL_BASE::getModel(), NETCLASS::GetViaDiameter(), NETCLASS::GetViaDrill(), BOARD_DESIGN_SETTINGS::GetViaSizeIndex(), VIA_DIMENSION::m_Diameter, VIA_DIMENSION::m_Drill, m_frame, BOARD_DESIGN_SETTINGS::m_NetSettings, TOOL_BASE::m_toolMgr, BOARD_DESIGN_SETTINGS::m_ViasDimensionsList, COMMIT::Modify(), SELECTION_CONDITIONS::OnlyTypes(), PCB_VIA_T, BOARD_COMMIT::Push(), PCB_TOOL_BASE::selection(), BOARD_DESIGN_SETTINGS::SetViaSizeIndex(), 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 166 of file pcb_tool_base.h.

References TOOL_BASE::getView().

Referenced by AUTOPLACE_TOOL::autoplace(), doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PAD_TOOL::ExitPadEditMode(), PCB_CONTROL::FlipPcbView(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::highlightNet(), ROUTER_TOOL::InlineDrag(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), PAD_TOOL::OnUndoRedo(), ROUTER_TOOL::performDragging(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), PCB_CONTROL::rehatchBoardItem(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), PCB_CONTROL::TrackDisplayMode(), PCB_POINT_EDITOR::updateItem(), PCB_CONTROL::ViaDisplayMode(), and PCB_CONTROL::ZoneDisplayMode().

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

References TOOL_BASE::m_toolMgr.

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), GERBVIEW_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PCB_TEST_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), ZOOM_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), and DRAWING_TOOL::SetAnchor().

ZoneDuplicate()

int BOARD_EDITOR_CONTROL::ZoneDuplicate

(

const TOOL_EVENT &

aEvent

)

Definition at line 1526 of file board_editor_control.cpp.

References _, COMMIT::Add(), PCB_TOOL_BASE::board(), ZONE_SETTINGS::ExportSetting(), ZONE::GetIsRuleArea(), ZONE::GetLayerSet(), PCB_SELECTION_TOOL::GetSelection(), InvokeCopperZonesEditor(), InvokeNonCopperZonesEditor(), InvokeRuleAreaEditor(), ZONE::IsOnCopperLayer(), m_frame, ZONE_SETTINGS::m_Layers, TOOL_BASE::m_toolMgr, pcbIUScale, BOARD_COMMIT::Push(), and PCB_TOOL_BASE::selection().

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

References _, PCB_TOOL_BASE::board(), ZONE::GetAssignedPriority(), ZONE::GetIsRuleArea(), ZONE::GetLayerSet(), TOOL_BASE::getModel(), BOARD_CONNECTED_ITEM::GetNetCode(), m_frame, TOOL_BASE::m_toolMgr, mergeZones(), BOARD_COMMIT::Push(), PCB_TOOL_BASE::selection(), ACTIONS::selectionClear, and ACTIONS::selectItem.

Referenced by setTransitions().

Member Data Documentation

m_frame

PCB_EDIT_FRAME* BOARD_EDITOR_CONTROL::m_frame

private

Definition at line 163 of file board_editor_control.h.

Referenced by AssignNetclass(), BOARD_EDITOR_CONTROL(), doCrossProbePcbToSch(), DrillOrigin(), ExportCmpFile(), ExportFootprints(), ExportGenCAD(), ExportHyperlynx(), ExportIDF(), ExportNetlist(), ExportSpecctraDSN(), ExportSTEP(), ExportVRML(), Find(), FindNext(), GenBOMFileFromBoard(), GenD356File(), GenerateGerbers(), GenerateODBPPFiles(), GenFootprintsReport(), GenIPC2581File(), Init(), modifyLockSelected(), New(), Open(), OpenNonKicadBoard(), PageSettings(), PlaceFootprint(), Plot(), RepairBoard(), RescueAutosave(), Reset(), Revert(), Save(), SaveAs(), SaveCopy(), Search(), setTransitions(), ShowEeschema(), TogglePythonConsole(), TrackWidthDec(), TrackWidthInc(), UpdatePCBFromSchematic(), UpdateSchematicFromPCB(), ViaSizeDec(), ViaSizeInc(), ZoneDuplicate(), and ZoneMerge().

m_inPlaceFootprint

bool BOARD_EDITOR_CONTROL::m_inPlaceFootprint

private

Definition at line 164 of file board_editor_control.h.

Referenced by BOARD_EDITOR_CONTROL(), and PlaceFootprint().

m_isBoardEditor

bool PCB_TOOL_BASE::m_isBoardEditor

protectedinherited

Definition at line 199 of file pcb_tool_base.h.

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

m_isFootprintEditor

bool PCB_TOOL_BASE::m_isFootprintEditor

protectedinherited

Definition at line 198 of file pcb_tool_base.h.

Referenced by EDIT_TOOL::copyToClipboard(), ARRAY_TOOL::CreateArray(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), EDIT_TOOL::Duplicate(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridPlaceOrigin(), EDIT_TOOL::Increment(), EDIT_TOOL::Init(), PAD_TOOL::Init(), PCB_CONTROL::InteractiveDelete(), IsFootprintEditor(), PCB_POINT_EDITOR::makePoints(), ARRAY_TOOL::onDialogClosed(), PCB_POINT_EDITOR::OnSelectionChange(), PAD_TOOL::PadTable(), PCB_CONTROL::Paste(), PCB_TOOL_BASE(), PCB_TOOL_BASE(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlacePoint(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), PCB_CONTROL::Print(), PCB_CONTROL::pruneItemLayers(), SCRIPTING_TOOL::reloadPlugins(), EDIT_TOOL::Rotate(), DRAWING_TOOL::SetAnchor(), SetIsFootprintEditor(), PCB_CONTROL::SnapMode(), PCB_CONTROL::SnapModeFeedback(), and EDIT_TOOL::updateModificationPoint().

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.

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), GetToolMenu(), BOARD_EDITOR_CONTROL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), DRAWING_TOOL::Init(), EDA_3D_CONTROLLER::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), GERBVIEW_SELECTION_TOOL::Init(), PAD_TOOL::Init(), PCB_DESIGN_BLOCK_CONTROL::Init(), PCB_PICKER_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_TOOL_BASE::Init(), PCB_VIEWER_TOOLS::Init(), PICKER_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), ROUTER_TOOL::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SCH_SELECTION_TOOL::Init(), SCH_TOOL_BASE< T >::Init(), ZOOM_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), GERBVIEW_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), ZOOM_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE(), and TOOL_INTERACTIVE().

m_placeOrigin

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

private

Definition at line 167 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 165 of file board_editor_control.h.

Referenced by BOARD_EDITOR_CONTROL(), PlaceFootprint(), and PlacingFootprint().

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(), GetId(), IsToolActive(), and TOOL_BASE().

m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 220 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), GROUP_TOOL::AddToGroup(), PCB_CONTROL::AppendBoard(), PCB_CONTROL::ApplyDesignBlockLayout(), BOARD_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), attachManager(), SCH_SELECTION_TOOL::autostartEvent(), EDIT_TOOL::BooleanPolygons(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::ChangeTrackWidth(), GERBVIEW_CONTROL::ClearAllLayers(), BOARD_INSPECTION_TOOL::ClearHighlight(), PCB_SELECTION_TOOL::ClearSelection(), PL_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), GERBVIEW_SELECTION_TOOL::clearSelection(), PCB_EDIT_TABLE_TOOL::clearSelection(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), ARRAY_TOOL::CreateArray(), PCB_GROUP_TOOL::createCommit(), SCH_GROUP_TOOL::createCommit(), MICROWAVE_TOOL::createInductorBetween(), DRC_TOOL::CrossProbe(), COMMON_TOOLS::Cursor45Crosshairs(), COMMON_TOOLS::CursorControl(), COMMON_TOOLS::CursorFullCrosshairs(), COMMON_TOOLS::CursorSmallCrosshairs(), PCB_CONTROL::CycleLayerPresets(), EDIT_TOOL::DeleteItems(), BOARD_INSPECTION_TOOL::DiffFootprint(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::doSyncSelection(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::DrawRectangle(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), PCB_EDIT_TABLE_TOOL::EditTable(), PCB_SELECTION_TOOL::EnterGroup(), SCH_SELECTION_TOOL::EnterGroup(), PAD_TOOL::EnumeratePads(), KICAD_MANAGER_CONTROL::Execute(), PCB_SELECTION_TOOL::ExitGroup(), SCH_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::expandConnection(), EDA_3D_CONTROLLER::ExportImage(), ZONE_FILLER_TOOL::FillAllZones(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::FindItem(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), GetManager(), getModelInternal(), DRAWING_TOOL::getSourceZoneForAction(), PCB_EDIT_TABLE_TOOL::getTableCellSelection(), getToolHolderInternal(), PCB_EDIT_TABLE_TOOL::getToolMgr(), getView(), getViewControls(), PCB_SELECTION_TOOL::grabUnconnected(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), COMMON_TOOLS::GridFastCycle(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridOrigin(), PCB_CONTROL::GridPlaceOrigin(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), PCB_GROUP_TOOL::Group(), SCH_GROUP_TOOL::Group(), EDIT_TOOL::HealShapes(), PCB_CONTROL::HighContrastModeCycle(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), PL_EDIT_TOOL::ImportDrawingSheetContent(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), EDIT_TOOL::Increment(), SCH_TOOL_BASE< T >::Increment(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), BOARD_REANNOTATE_TOOL::Init(), CONVERT_TOOL::Init(), DRAWING_TOOL::Init(), EDIT_TOOL::Init(), FOOTPRINT_CHOOSER_SELECTION_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), GENERATOR_TOOL::Init(), GLOBAL_EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), PCB_POINT_EDITOR::Init(), PCB_SELECTION_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_POINT_EDITOR::Init(), POSITION_RELATIVE_TOOL::Init(), ROUTER_TOOL::Init(), SCH_TOOL_BASE< T >::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), PCB_CONTROL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), SCH_TOOL_BASE< T >::InteractiveDelete(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), IsToolActive(), EDIT_TOOL::JustifyText(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), GERBVIEW_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::Move(), EDIT_TOOL::MoveExact(), ARRAY_TOOL::onDialogClosed(), SELECTION_TOOL::onDisambiguationExpire(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), CONVERT_TOOL::OutsetItems(), PL_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_CONTROL::PlaceLinkedDesignBlock(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), SCH_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), GENERATOR_TOOL::RegenerateSelected(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDA_3D_CONTROLLER::ReloadBoard(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), MULTICHANNEL_TOOL::repeatLayout(), PCB_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), COMMON_TOOLS::Reset(), EDA_3D_CONTROLLER::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), PNS::TOOL_BASE::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::restoreSelection(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), DRC_TOOL::RunTests(), PCB_CONTROL::SaveToLinkedDesignBlock(), SCH_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectColumns(), SCH_SELECTION_TOOL::SelectColumns(), SCH_SELECTION_TOOL::SelectConnection(), PCB_TOOL_BASE::selection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), PCB_PICKER_TOOL::SelectItemInteractively(), GERBVIEW_SELECTION_TOOL::SelectItems(), SCH_SELECTION_TOOL::selectLasso(), PCB_SELECTION_TOOL::SelectMultiple(), SCH_SELECTION_TOOL::SelectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectNet(), SCH_SELECTION_TOOL::SelectNext(), PL_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::selectPoint(), PCB_TEST_SELECTION_TOOL::selectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_PICKER_TOOL::SelectPointInteractively(), PCB_SELECTION_TOOL::SelectPolyArea(), SCH_SELECTION_TOOL::SelectPrevious(), PCB_SELECTION_TOOL::SelectRectArea(), PCB_SELECTION_TOOL::SelectRows(), SCH_SELECTION_TOOL::SelectRows(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), PCB_SELECTION_TOOL::SelectTable(), SCH_SELECTION_TOOL::SelectTable(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE::SetContextMenu(), EDA_3D_CONTROLLER::SetMaterial(), PCB_SELECTION_TOOL::SetSelectPoly(), SCH_SELECTION_TOOL::SetSelectPoly(), PCB_SELECTION_TOOL::SetSelectRect(), SCH_SELECTION_TOOL::SetSelectRect(), DRC_TOOL::ShowDRCDialog(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), EDIT_TOOL::SimplifyPolygons(), PCB_CONTROL::SnapMode(), EDIT_TOOL::Swap(), SCH_SELECTION_TOOL::SyncSelection(), COMMON_TOOLS::ToggleCursor(), EDA_3D_CONTROLLER::ToggleLayersManager(), EDA_3D_CONTROLLER::ToggleRaytracing(), EDA_3D_CONTROLLER::ToggleVisibility(), TOOL_BASE(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), GROUP_TOOL::Ungroup(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_SELECTION_TOOL::unrouteSelected(), PCB_SELECTION_TOOL::UnselectAll(), SCH_SELECTION_TOOL::UnselectAll(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), PCB_POINT_EDITOR::updateItem(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), GERBVIEW_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), MULTICHANNEL_TOOL::UpdatePickedItem(), PNS::TOOL_BASE::updateStartItem(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), TOOL_INTERACTIVE::Wait(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), BOARD_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfill().

m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

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

pcbnew.InteractiveSelection).

Definition at line 219 of file tool_base.h.

Referenced by GetName(), and TOOL_BASE().

m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

Definition at line 214 of file tool_base.h.

Referenced by GetType(), and TOOL_BASE().

---

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

• board_editor_control.h
• build_BOM_from_board.cpp
• dialog_export_idf.cpp
• dialog_export_step.cpp
• dialog_export_vrml.cpp
• dialog_gen_footprint_position.cpp
• dialog_gendrill.cpp
• export_d356.cpp
• export_footprint_associations.cpp
• export_gencad.cpp
• export_hyperlynx.cpp
• pcbnew/files.cpp
• board_editor_control.cpp