PL_SELECTION_TOOL Class Reference

#include <pl_selection_tool.h>

Inheritance diagram for PL_SELECTION_TOOL:

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
	PL_SELECTION_TOOL ()
	~PL_SELECTION_TOOL () override
bool	Init () override
	Init() is called once upon a registration of the tool.
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state.
int	Main (const TOOL_EVENT &aEvent)
	The main loop.
PL_SELECTION &	GetSelection ()
	Return the set of currently selected items.
PL_SELECTION &	RequestSelection ()
	Return either an existing selection (filtered), or the selection at the current cursor if the existing selection is empty.
void	SelectPoint (const VECTOR2I &aWhere, bool *aSelectionCancelledFlag=nullptr)
	Select an item pointed by the parameter aWhere.
int	ClearSelection (const TOOL_EVENT &aEvent)
void	ClearSelection ()
void	RebuildSelection ()
	Rebuild the selection from the flags in the view items.
int	UpdateMenu (const TOOL_EVENT &aEvent)
	Update a menu's state based on the current selection.
int	AddItemToSel (const TOOL_EVENT &aEvent)
void	AddItemToSel (EDA_ITEM *aItem, bool aQuietMode=false)
int	AddItemsToSel (const TOOL_EVENT &aEvent)
void	AddItemsToSel (EDA_ITEMS *aList, bool aQuietMode=false)
int	RemoveItemFromSel (const TOOL_EVENT &aEvent)
void	RemoveItemFromSel (EDA_ITEM *aItem, bool aQuietMode=false)
int	RemoveItemsFromSel (const TOOL_EVENT &aEvent)
void	RemoveItemsFromSel (EDA_ITEMS *aList, bool aQuietMode=false)
void	RemoveItemsFromSel (std::vector< KIID > *aList, bool aQuietMode=false)
	A safer version of RemoveItemsFromSel( EDA_ITEMS ) which doesn't require the items to still exist.
int	ReselectItem (const TOOL_EVENT &aEvent)
void	BrightenItem (EDA_ITEM *aItem)
void	UnbrightenItem (EDA_ITEM *aItem)
int	SelectionMenu (const TOOL_EVENT &aEvent)
	Show a popup menu to trim the COLLECTOR passed as aEvent's parameter down to a single item.
virtual void	EnterGroup ()
virtual void	ExitGroup (bool aSelectGroup=false)
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

Protected Member Functions
SELECTION &	selection () override
	Return a reference to the selection.
void	onDisambiguationExpire (wxTimerEvent &aEvent)
	Start the process to show our disambiguation menu once the user has kept the mouse down for the minimum time.
void	setModifiersState (bool aShiftState, bool aCtrlState, bool aAltState)
	Set the configuration of m_additive, m_subtractive, m_exclusive_or, m_skip_heuristics from the state of modifier keys SHIFT, CTRL, ALT and depending on the OS.
bool	hasModifier ()
	True if a selection modifier is enabled, false otherwise.
virtual bool	ctrlClickHighlights ()
	Determine if ctrl-click is highlight net or XOR selection.
bool	doSelectionMenu (COLLECTOR *aCollector)
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_additive
	Items should be added to sel (instead of replacing).
bool	m_subtractive
	Items should be removed from selection.
bool	m_exclusive_or
	Items' selection state should be toggled.
bool	m_multiple
	Multiple selection mode is active.
bool	m_skip_heuristics
	Show disambiguation menu for all items under the cursor rather than trying to narrow them down first using heuristics.
bool	m_highlight_modifier
	Select highlight net on left click.
bool	m_drag_additive
	Add multiple items to selection.
bool	m_drag_subtractive
	Remove multiple from selection.
bool	m_canceledMenu
	Sets to true if the disambiguation menu was canceled.
wxTimer	m_disambiguateTimer
	Timer to show the disambiguate menu.
VECTOR2I	m_originalCursor
	Location of original cursor when starting click.
std::unique_ptr< TOOL_MENU >	m_menu
	The functions below are not yet implemented - their interface may change.
TOOL_TYPE	m_type
TOOL_ID	m_toolId
	Unique id, assigned by a TOOL_MANAGER instance.
std::string	m_toolName
	Names are expected to obey the format application.ToolName (eg.
TOOL_MANAGER *	m_toolMgr

Private Member Functions
bool	selectMultiple ()
	Handle drawing a selection box that allows one to select many items at the same time.
void	guessSelectionCandidates (COLLECTOR &collector, const VECTOR2I &aWhere)
	Apply heuristics to try and determine a single object when multiple are found under the cursor.
int	disambiguateCursor (const TOOL_EVENT &aEvent)
	Handle disambiguation actions including displaying the menu.
void	select (EDA_ITEM *aItem) override
	Takes necessary action mark an item as selected.
void	unselect (EDA_ITEM *aItem) override
	Take necessary action mark an item as unselected.
void	highlight (EDA_ITEM *aItem, int aHighlightMode, SELECTION *aGroup=nullptr) override
	Highlight the item visually.
void	unhighlight (EDA_ITEM *aItem, int aHighlightMode, SELECTION *aGroup=nullptr) override
	Unhighlight the item visually.
bool	selectionContains (const VECTOR2I &aPoint) const
	Set up handlers for various events.
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events.
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
PL_EDITOR_FRAME *	m_frame
PL_SELECTION	m_selection

Detailed Description

Definition at line 43 of file pl_selection_tool.h.

Member Enumeration Documentation

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

PL_SELECTION_TOOL()

PL_SELECTION_TOOL::PL_SELECTION_TOOL

(

)

Definition at line 47 of file pl_selection_tool.cpp.

~PL_SELECTION_TOOL()

PL_SELECTION_TOOL::~PL_SELECTION_TOOL ( )

inlineoverride

Definition at line 47 of file pl_selection_tool.h.

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

Referenced by AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::copyToClipboard(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_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(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridPlaceOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), SCH_EDIT_TOOL::InteractiveDelete(), SYMBOL_EDITOR_EDIT_TOOL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), SCH_POINT_EDITOR::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_GROUP_TOOL::PickNewMember(), PCB_GROUP_TOOL::PickNewMember(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), 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(), DRC_TOOL::ShowDRCDialog(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

AddItemsToSel() [1/2]

int SELECTION_TOOL::AddItemsToSel ( const TOOL_EVENT &  aEvent )

inherited

Definition at line 141 of file selection_tool.cpp.

References SELECTION_TOOL::AddItemsToSel(), TOOL_EVENT::Parameter(), SELECTION_TOOL::selection(), and SELECTION::SetIsHover().

Referenced by SELECTION_TOOL::AddItemsToSel(), API_HANDLER_PCB::handleAddToSelection(), SCH_DRAWING_TOOLS::ImportSheet(), SCH_SELECTION_TOOL::Main(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), PCB_EDIT_FRAME::RebuildAndRefresh(), SCH_SELECTION_TOOL::setTransitions(), setTransitions(), and PCB_SELECTION_TOOL::setTransitions().

AddItemsToSel() [2/2]

void SELECTION_TOOL::AddItemsToSel ( EDA_ITEMS *  aList, bool  aQuietMode = false  )

inherited

Definition at line 149 of file selection_tool.cpp.

References TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::select(), and EVENTS::SelectedEvent.

AddItemToSel() [1/2]

int SELECTION_TOOL::AddItemToSel ( const TOOL_EVENT &  aEvent )

inherited

Definition at line 108 of file selection_tool.cpp.

References SELECTION_TOOL::AddItemToSel(), TOOL_EVENT::Parameter(), SELECTION_TOOL::selection(), and SELECTION::SetIsHover().

Referenced by SELECTION_TOOL::AddItemToSel(), GROUP_TOOL::AddToGroup(), SCH_EDIT_TOOL::BreakWire(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), SCH_EDIT_TOOL::EditField(), EDIT_TOOL::FilletTracks(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_DRAWING_TOOLS::ImportSheet(), SCH_EDIT_TOOL::InteractiveDelete(), SYMBOL_EDITOR_EDIT_TOOL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), DIALOG_INSPECTOR::onCellClicked(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceTuningPattern(), SELECTION_TOOL::ReselectItem(), SCH_SELECTION_TOOL::setTransitions(), setTransitions(), PCB_SELECTION_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

AddItemToSel() [2/2]

void SELECTION_TOOL::AddItemToSel ( EDA_ITEM *  aItem, bool  aQuietMode = false  )

inherited

Definition at line 116 of file selection_tool.cpp.

References TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::select(), and EVENTS::SelectedEvent.

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 TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

BrightenItem()

void SELECTION_TOOL::BrightenItem ( EDA_ITEM *  aItem )

inherited

Definition at line 220 of file selection_tool.cpp.

References BRIGHTENED, and SELECTION_TOOL::highlight().

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_EDIT_TOOL::InteractiveDelete(), SYMBOL_EDITOR_EDIT_TOOL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), PANEL_COMPONENT_CLASS_ASSIGNMENT::OnHighlightItemsClick(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

ClearSelection() [1/2]

void PL_SELECTION_TOOL::ClearSelection

(

)

Definition at line 470 of file pl_selection_tool.cpp.

References EVENTS::ClearedEvent, SELECTION::ClearReferencePoint(), SELECTION::Empty(), SELECTION::Front(), SELECTION::GetSize(), TOOL_BASE::getView(), m_selection, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SELECTED, SELECTION::SetIsHover(), unhighlight(), and KIGFX::VIEW::Update().

Referenced by ClearSelection(), Main(), RequestSelection(), selectMultiple(), SelectPoint(), and setTransitions().

ClearSelection() [2/2]

int PL_SELECTION_TOOL::ClearSelection

(

const TOOL_EVENT &

aEvent

)

Definition at line 448 of file pl_selection_tool.cpp.

References ClearSelection().

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), DIALOG_INSPECTOR::onCellClicked(), PL_EDIT_TOOL::Paste(), and PL_EDITOR_FRAME::RollbackFromUndo().

ctrlClickHighlights()

virtual bool SELECTION_TOOL::ctrlClickHighlights ( )

inlineprotectedvirtualinherited

Determine if ctrl-click is highlight net or XOR selection.

Reimplemented in PCB_SELECTION_TOOL.

Definition at line 146 of file selection_tool.h.

Referenced by SELECTION_TOOL::setModifiersState().

disambiguateCursor()

int PL_SELECTION_TOOL::disambiguateCursor ( const TOOL_EVENT &  aEvent )

private

Handle disambiguation actions including displaying the menu.

Definition at line 218 of file pl_selection_tool.cpp.

References SELECTION_TOOL::m_canceledMenu, SELECTION_TOOL::m_originalCursor, SELECTION_TOOL::m_skip_heuristics, SelectPoint(), and SELECTION_TOOL::setModifiersState().

Referenced by setTransitions().

doSelectionMenu()

bool SELECTION_TOOL::doSelectionMenu ( COLLECTOR *  aCollector )

protectedinherited

The user has requested the full, non-limited list of selection items

Definition at line 258 of file selection_tool.cpp.

References _, ACTION_MENU::Add(), KIGFX::VIEW::Add(), COLLECTOR::Append(), BRIGHTENED, CMENU_NOW, COLLECTOR::Combine(), ACTION_MENU::DisplayTitle(), COLLECTOR::Empty(), COLLECTOR::GetCount(), EDA_ITEM::GetItemDescription(), EDA_ITEM::GetMenuImage(), TOOL_BASE::getView(), COLLECTOR::HasAdditionalItems(), SELECTION_TOOL::highlight(), LAYER_SELECT_OVERLAY, COLLECTOR::m_MenuTitle, KIGFX::VIEW::Remove(), TOOL_INTERACTIVE::SetContextMenu(), ACTION_MENU::SetIcon(), KIGFX::VIEW_GROUP::SetLayer(), ACTION_MENU::SetTitle(), TA_CHOICE_MENU_CHOICE, TA_CHOICE_MENU_CLOSED, TA_CHOICE_MENU_UPDATE, SELECTION_TOOL::unhighlight(), KIGFX::VIEW::UpdateItems(), and TOOL_INTERACTIVE::Wait().

Referenced by SELECTION_TOOL::SelectionMenu(), GERBVIEW_SELECTION_TOOL::selectPoint(), SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), and SCH_SELECTION_TOOL::selectPoint().

EnterGroup()

virtual void SELECTION_TOOL::EnterGroup ( )

inlinevirtualinherited

Reimplemented in SCH_SELECTION_TOOL, and PCB_SELECTION_TOOL.

Definition at line 89 of file selection_tool.h.

Referenced by GROUP_TOOL::EnterGroup().

ExitGroup()

virtual void SELECTION_TOOL::ExitGroup ( bool  aSelectGroup = false )

inlinevirtualinherited

Reimplemented in SCH_SELECTION_TOOL, and PCB_SELECTION_TOOL.

Definition at line 90 of file selection_tool.h.

Referenced by GROUP_TOOL::LeaveGroup().

getEditFrame()

template<typename T >

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 186 of file tool_base.h.

References TOOL_BASE::getToolHolderInternal(), and T.

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

GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Return the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns

Identifier of the tool.

Definition at line 123 of file tool_base.h.

References TOOL_BASE::m_toolId.

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

GetManager()

TOOL_MANAGER * TOOL_BASE::GetManager ( ) const

inlineinherited

Return the instance of TOOL_MANAGER that takes care of the tool.

Returns

Instance of the TOOL_MANAGER or NULL if there is no associated tool manager.

Definition at line 146 of file tool_base.h.

References TOOL_BASE::m_toolMgr.

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

getModel()

template<typename T >

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Definition at line 198 of file tool_base.h.

References TOOL_BASE::getModelInternal(), and T.

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

getModelInternal()

EDA_ITEM * TOOL_BASE::getModelInternal ( ) const

privateinherited

Definition at line 56 of file tool_base.cpp.

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

Referenced by TOOL_BASE::getModel().

GetName()

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

inlineinherited

Return the name of the tool.

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

Returns

The name of the tool.

Definition at line 136 of file tool_base.h.

References TOOL_BASE::m_toolName.

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

GetSelection()

PL_SELECTION & PL_SELECTION_TOOL::GetSelection

(

)

Return the set of currently selected items.

Definition at line 233 of file pl_selection_tool.cpp.

References m_selection.

Referenced by PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), PL_DRAWING_TOOLS::DrawShape(), PL_EDITOR_FRAME::HardRedraw(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PROPERTIES_FRAME::OnAcceptPrms(), PL_EDIT_TOOL::Paste(), PL_DRAWING_TOOLS::PlaceItem(), and PL_EDITOR_CONTROL::UpdateMessagePanel().

getToolHolderInternal()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInternal ( ) const

privateinherited

Definition at line 50 of file tool_base.cpp.

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

Referenced by TOOL_BASE::getEditFrame().

GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inherited

Definition at line 112 of file tool_interactive.cpp.

References TOOL_INTERACTIVE::m_menu.

Referenced by EDIT_TOOL::doMoveSelection(), GROUP_TOOL::Init(), SCH_EDIT_TABLE_TOOL::Init(), SCH_INSPECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_MOVE_TOOL::Init(), SCH_POINT_EDITOR::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), CONVERT_TOOL::Init(), EDIT_TOOL::Init(), FOOTPRINT_CHOOSER_SELECTION_TOOL::Init(), GENERATOR_TOOL::Init(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), and PCB_POINT_EDITOR::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 TOOL_BASE::m_type.

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

getView()

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

protectedinherited

Returns the instance of #VIEW object used in the application.

It allows tools to draw.

Returns

The instance of VIEW.

Definition at line 38 of file tool_base.cpp.

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

Referenced by SCH_POINT_EDITOR::addCornerCondition(), ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), SCH_INSPECTION_TOOL::CheckSymbol(), GERBVIEW_CONTROL::ClearAllLayers(), ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::CollectHits(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), COMMON_TOOLS::doCenter(), PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_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(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), 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(), highlight(), PCB_SELECTION_TOOL::highlight(), SCH_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineDrag(), SCH_EDIT_TOOL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), SCH_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), ROUTER_TOOL::prepareInteractive(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), SCH_SELECTION_TOOL::Reset(), SCH_TOOL_BASE< T >::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PNS::TOOL_BASE::Reset(), BOARD_EDITOR_CONTROL::Reset(), DRAWING_TOOL::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), PCB_CONTROL::Reset(), PCB_SELECTION_TOOL::Reset(), SCH_EDIT_TOOL::Rotate(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), SCH_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::selectionContains(), selectionContains(), PCB_SELECTION_TOOL::selectionContains(), SCH_SELECTION_TOOL::selectMultiple(), selectMultiple(), PCB_SELECTION_TOOL::SelectMultiple(), SelectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDITOR_CONTROL::ToggleDirectiveLabels(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SYMBOL_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), SYMBOL_EDITOR_CONTROL::ToggleHiddenPins(), SCH_EDITOR_CONTROL::ToggleOPCurrents(), SCH_EDITOR_CONTROL::ToggleOPVoltages(), SCH_EDITOR_CONTROL::TogglePinAltIcons(), SYMBOL_EDITOR_CONTROL::TogglePinAltIcons(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), unhighlight(), PCB_SELECTION_TOOL::unhighlight(), PCB_TEST_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), SCH_SELECTION_TOOL::UnselectAll(), PCB_SELECTION_TOOL::UnselectAll(), GERBVIEW_SELECTION_TOOL::unselectVisually(), SCH_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), SCH_FIND_REPLACE_TOOL::UpdateFind(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), SCH_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SCH_SELECTION_TOOL::updateSelection(), PCB_SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_SELECTION_TOOL::view(), PCB_TOOL_BASE::view(), PCB_VIEWER_TOOLS::view(), PCB_TEST_SELECTION_TOOL::view(), SCH_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_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 TOOL_MANAGER::GetViewControls(), and TOOL_BASE::m_toolMgr.

Referenced by SCH_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), SCH_POINT_EDITOR::addCornerCondition(), SCH_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), PCB_POINT_EDITOR::chamferCorner(), PCB_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), PCB_TEST_SELECTION_TOOL::controls(), EDIT_TOOL::copyToClipboard(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), EDIT_TOOL::Init(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_POINT_EDITOR::makePoints(), SCH_POINT_EDITOR::makePointsAndBehavior(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDIT_TOOL::RepeatDrawItem(), 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::selectMultiple(), 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(), PICKER_TOOL::setControls(), PCB_PICKER_TOOL::setControls(), SCH_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), PCB_POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::SyncSheetsPins(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), PL_EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

Go()

template<class T >

void TOOL_INTERACTIVE::Go ( int(T::*)(const TOOL_EVENT &)  aStateFunc, const TOOL_EVENT_LIST &  aConditions = TOOL_EVENT( TC_ANY, TA_ANY )  )

inherited

Define which state (aStateFunc) to go when a certain event arrives (aConditions).

No conditions means any event.

Definition at line 147 of file tool_interactive.h.

References TOOL_INTERACTIVE::goInternal(), and T.

Referenced by EDA_3D_CONTROLLER::setTransitions(), BITMAP2CMP_CONTROL::setTransitions(), DESIGN_BLOCK_CONTROL::setTransitions(), GROUP_TOOL::setTransitions(), LIBRARY_EDITOR_CONTROL::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), SCH_DESIGN_BLOCK_CONTROL::setTransitions(), SCH_DRAWING_TOOLS::setTransitions(), SCH_EDIT_TABLE_TOOL::setTransitions(), SCH_EDIT_TOOL::setTransitions(), SCH_EDITOR_CONTROL::setTransitions(), SCH_FIND_REPLACE_TOOL::setTransitions(), SCH_INSPECTION_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::setTransitions(), SCH_MOVE_TOOL::setTransitions(), SCH_NAVIGATE_TOOL::setTransitions(), SCH_POINT_EDITOR::setTransitions(), SCH_SELECTION_TOOL::setTransitions(), SIMULATOR_CONTROL::setTransitions(), SYMBOL_EDITOR_CONTROL::setTransitions(), SYMBOL_EDITOR_DRAWING_TOOLS::setTransitions(), SYMBOL_EDITOR_EDIT_TOOL::setTransitions(), SYMBOL_EDITOR_MOVE_TOOL::setTransitions(), SYMBOL_EDITOR_PIN_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), COMMON_CONTROL::setTransitions(), COMMON_TOOLS::setTransitions(), EMBED_TOOL::setTransitions(), PICKER_TOOL::setTransitions(), PROPERTIES_TOOL::setTransitions(), ZOOM_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), PL_EDIT_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), PL_POINT_EDITOR::setTransitions(), setTransitions(), PCB_CALCULATOR_CONTROL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), MICROWAVE_TOOL::setTransitions(), SCRIPTING_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), ALIGN_DISTRIBUTE_TOOL::setTransitions(), ARRAY_TOOL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), CONVERT_TOOL::setTransitions(), DRAWING_TOOL::setTransitions(), DRC_TOOL::setTransitions(), EDIT_TOOL::setTransitions(), FOOTPRINT_CHOOSER_SELECTION_TOOL::setTransitions(), FOOTPRINT_EDITOR_CONTROL::setTransitions(), FOOTPRINT_WIZARD_TOOLS::setTransitions(), GENERATOR_TOOL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), MULTICHANNEL_TOOL::setTransitions(), PAD_TOOL::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_VIEWER_TOOLS::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), ZONE_FILLER_TOOL::setTransitions(), and PCB_TEST_SELECTION_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.

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

Referenced by TOOL_INTERACTIVE::Go().

guessSelectionCandidates()

void PL_SELECTION_TOOL::guessSelectionCandidates ( COLLECTOR &  collector, const VECTOR2I &  aWhere  )

private

Apply heuristics to try and determine a single object when multiple are found under the cursor.

Definition at line 312 of file pl_selection_tool.cpp.

References COLLECTOR::GetCount(), EDA_ITEM::HitTest(), and COLLECTOR::Transfer().

Referenced by SelectPoint().

hasModifier()

bool SELECTION_TOOL::hasModifier ( )

protectedinherited

True if a selection modifier is enabled, false otherwise.

Definition at line 87 of file selection_tool.cpp.

References SELECTION_TOOL::m_additive, SELECTION_TOOL::m_exclusive_or, and SELECTION_TOOL::m_subtractive.

Referenced by SCH_SELECTION_TOOL::Main(), Main(), PCB_SELECTION_TOOL::Main(), and SELECTION_TOOL::onDisambiguationExpire().

highlight()

void PL_SELECTION_TOOL::highlight ( EDA_ITEM *  aItem, int  aHighlightMode, SELECTION *  aGroup = nullptr  )

overrideprivatevirtual

Highlight the item visually.

Parameters

aItem	is an item to be be highlighted.
aHighlightMode	should be either SELECTED or BRIGHTENED
aGroup	is the group to add the item to in the BRIGHTENED mode.

Implements SELECTION_TOOL.

Definition at line 500 of file pl_selection_tool.cpp.

References SELECTION::Add(), BRIGHTENED, TOOL_BASE::getView(), SELECTED, EDA_ITEM::SetBrightened(), EDA_ITEM::SetSelected(), and KIGFX::VIEW::Update().

Referenced by select().

Init()

bool PL_SELECTION_TOOL::Init ( )

overridevirtual

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

Returns

True if the initialization went fine, false - otherwise.

Reimplemented from TOOL_BASE.

Definition at line 54 of file pl_selection_tool.cpp.

References EDA_DRAW_FRAME::AddStandardSubMenus(), PL_ACTIONS::drawLine, PL_ACTIONS::drawRectangle, SELECTION_CONDITIONS::Empty(), SELECTION_TOOL::m_disambiguateTimer, m_frame, TOOL_INTERACTIVE::m_menu, SELECTION_TOOL::onDisambiguationExpire(), PL_ACTIONS::placeImage, and PL_ACTIONS::placeText.

IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 32 of file tool_base.cpp.

References TOOL_MANAGER::IsToolActive(), TOOL_BASE::m_toolId, and TOOL_BASE::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().

Main()

int PL_SELECTION_TOOL::Main

(

const TOOL_EVENT &

aEvent

)

The main loop.

Definition at line 84 of file pl_selection_tool.cpp.

References BUT_LEFT, BUT_MIDDLE, BUT_RIGHT, ClearSelection(), SELECTION::Empty(), EDA_DRAW_PANEL_GAL::ForceRefresh(), PL_EDITOR_FRAME::GetCanvas(), ADVANCED_CFG::GetCfg(), TOOLS_HOLDER::GetDragAction(), TOOL_MANAGER::GetMousePosition(), TOOL_MANAGER::GetTool(), SELECTION_TOOL::hasModifier(), PL_POINT_EDITOR::HasPoint(), SELECTION_TOOL::m_additive, SELECTION_TOOL::m_disambiguateTimer, ADVANCED_CFG::m_DisambiguationMenuDelay, SELECTION_TOOL::m_exclusive_or, m_frame, TOOL_INTERACTIVE::m_menu, SELECTION_TOOL::m_originalCursor, m_selection, SELECTION_TOOL::m_subtractive, TOOL_BASE::m_toolMgr, MD_ALT, MD_CTRL, MD_SHIFT, TOOL_MANAGER::RunAction(), selectionContains(), selectMultiple(), SelectPoint(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), SELECTION::SetIsHover(), SELECTION_TOOL::setModifiersState(), TA_UNDO_REDO_PRE, TOOLS_HOLDER::ToolStackIsEmpty(), TOOL_INTERACTIVE::Wait(), and ACTIONS::zoomFitScreen.

Referenced by setTransitions().

onDisambiguationExpire()

void SELECTION_TOOL::onDisambiguationExpire ( wxTimerEvent &  aEvent )

protectedinherited

Start the process to show our disambiguation menu once the user has kept the mouse down for the minimum time.

Parameters

aEvent

Definition at line 232 of file selection_tool.cpp.

References EVENTS::DisambiguatePoint, SELECTION_TOOL::hasModifier(), TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), and SELECTION_TOOL::selection().

Referenced by SCH_SELECTION_TOOL::Init(), Init(), PCB_SELECTION_TOOL::Init(), and PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL().

RebuildSelection()

void PL_SELECTION_TOOL::RebuildSelection

(

)

Rebuild the selection from the flags in the view items.

Useful after a hard redraw or an undo or redo operation.

Definition at line 455 of file pl_selection_tool.cpp.

References SELECTION::Clear(), DS_DATA_MODEL::GetTheInstance(), m_selection, and select().

Referenced by PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), PL_EDIT_TOOL::Paste(), and PL_EDITOR_FRAME::RollbackFromUndo().

RemoveItemFromSel() [1/2]

int SELECTION_TOOL::RemoveItemFromSel ( const TOOL_EVENT &  aEvent )

inherited

Definition at line 163 of file selection_tool.cpp.

References TOOL_EVENT::Parameter(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::selection(), and SELECTION::SetIsHover().

Referenced by SCHEMATIC::CleanUp(), PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::ReselectItem(), SCH_SELECTION_TOOL::setTransitions(), setTransitions(), and PCB_SELECTION_TOOL::setTransitions().

RemoveItemFromSel() [2/2]

void SELECTION_TOOL::RemoveItemFromSel ( EDA_ITEM *  aItem, bool  aQuietMode = false  )

inherited

Definition at line 171 of file selection_tool.cpp.

References TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::unselect(), and EVENTS::UnselectedEvent.

RemoveItemsFromSel() [1/3]

int SELECTION_TOOL::RemoveItemsFromSel ( const TOOL_EVENT &  aEvent )

inherited

Definition at line 184 of file selection_tool.cpp.

References TOOL_EVENT::Parameter(), SELECTION_TOOL::RemoveItemsFromSel(), SELECTION_TOOL::selection(), and SELECTION::SetIsHover().

Referenced by SCH_MOVE_TOOL::doMoveSelection(), API_HANDLER_PCB::handleRemoveFromSelection(), PCB_EDIT_FRAME::RebuildAndRefresh(), SELECTION_TOOL::RemoveItemsFromSel(), SCH_SELECTION_TOOL::setTransitions(), setTransitions(), and PCB_SELECTION_TOOL::setTransitions().

RemoveItemsFromSel() [2/3]

void SELECTION_TOOL::RemoveItemsFromSel ( EDA_ITEMS *  aList, bool  aQuietMode = false  )

inherited

Definition at line 192 of file selection_tool.cpp.

References TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::unselect(), and EVENTS::UnselectedEvent.

RemoveItemsFromSel() [3/3]

void SELECTION_TOOL::RemoveItemsFromSel ( std::vector< KIID > *  aList, bool  aQuietMode = false  )

inherited

A safer version of RemoveItemsFromSel( EDA_ITEMS ) which doesn't require the items to still exist.

Definition at line 206 of file selection_tool.cpp.

References alg::contains(), SELECTION_TOOL::RemoveItemsFromSel(), and SELECTION_TOOL::selection().

RequestSelection()

PL_SELECTION & PL_SELECTION_TOOL::RequestSelection

(

)

Return either an existing selection (filtered), or the selection at the current cursor if the existing selection is empty.

Definition at line 328 of file pl_selection_tool.cpp.

References ClearSelection(), SELECTION::Empty(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_BASE::getViewControls(), m_selection, SelectPoint(), and SELECTION::SetIsHover().

Referenced by PL_EDIT_TOOL::Copy(), PL_EDIT_TOOL::DoDelete(), and PL_EDIT_TOOL::Main().

ReselectItem()

int SELECTION_TOOL::ReselectItem ( const TOOL_EVENT &  aEvent )

inherited

Definition at line 129 of file selection_tool.cpp.

References SELECTION_TOOL::AddItemToSel(), TOOL_EVENT::Parameter(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::selection(), and SELECTION::SetIsHover().

Referenced by PCB_SELECTION_TOOL::setTransitions().

Reset()

void PL_SELECTION_TOOL::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.

Implements TOOL_BASE.

Definition at line 77 of file pl_selection_tool.cpp.

References m_frame, and TOOL_BASE::MODEL_RELOAD.

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.

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

RunMainStack()

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

inherited

Call a function using the main stack.

Parameters

aFunc

is the function to be calls.

Definition at line 106 of file tool_interactive.cpp.

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

Referenced by DRAWING_TOOL::PlaceText().

select()

void PL_SELECTION_TOOL::select ( EDA_ITEM *  aItem )

overrideprivatevirtual

Takes necessary action mark an item as selected.

Parameters

aItem

is an item to be selected.

Implements SELECTION_TOOL.

Definition at line 488 of file pl_selection_tool.cpp.

References highlight(), m_selection, and SELECTED.

Referenced by RebuildSelection(), selectMultiple(), and SelectPoint().

selection()

SELECTION & PL_SELECTION_TOOL::selection ( )

inlineoverrideprotectedvirtual

Return a reference to the selection.

Implements SELECTION_TOOL.

Definition at line 92 of file pl_selection_tool.h.

References m_selection.

selectionContains()

bool PL_SELECTION_TOOL::selectionContains ( const VECTOR2I &  aPoint ) const

private

Set up handlers for various events.

Returns

True if the given point is contained in any of selected items' bounding box.

Definition at line 528 of file pl_selection_tool.cpp.

References BOX2< Vec >::Contains(), TOOL_BASE::getView(), BOX2< Vec >::Inflate(), m_selection, KIGFX::VIEW::ToWorld(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Main().

SelectionMenu()

int SELECTION_TOOL::SelectionMenu ( const TOOL_EVENT &  aEvent )

inherited

Show a popup menu to trim the COLLECTOR passed as aEvent's parameter down to a single item.

Note

This routine does not modify the selection.

Definition at line 247 of file selection_tool.cpp.

References SELECTION_TOOL::doSelectionMenu(), COLLECTOR::m_MenuCancelled, and TOOL_EVENT::Parameter().

Referenced by SCH_SELECTION_TOOL::setTransitions(), setTransitions(), and PCB_SELECTION_TOOL::setTransitions().

selectMultiple()

bool PL_SELECTION_TOOL::selectMultiple ( )

private

Handle drawing a selection box that allows one to select many items at the same time.

Returns

true if the function was canceled (i.e. CancelEvent was received).

Definition at line 344 of file pl_selection_tool.cpp.

References KIGFX::VIEW::Add(), BUT_LEFT, SELECTION::ClearReferencePoint(), ClearSelection(), PL_EDITOR_FRAME::GetCanvas(), KIGFX::PREVIEW::SELECTION_AREA::GetEnd(), KIGFX::PREVIEW::SELECTION_AREA::GetOrigin(), DS_DATA_MODEL::GetTheInstance(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), SELECTION_TOOL::m_drag_additive, SELECTION_TOOL::m_drag_subtractive, SELECTION_TOOL::m_exclusive_or, m_frame, SELECTION_TOOL::m_multiple, m_selection, SELECTION_TOOL::m_subtractive, TOOL_BASE::m_toolMgr, BOX2< Vec >::Normalize(), TOOL_MANAGER::ProcessEvent(), KIGFX::VIEW::Remove(), select(), EVENTS::SelectedEvent, KIGFX::PREVIEW::SELECTION_AREA::SetAdditive(), KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), KIGFX::PREVIEW::SELECTION_AREA::SetEnd(), KIGFX::PREVIEW::SELECTION_AREA::SetExclusiveOr(), KIGFX::PREVIEW::SELECTION_AREA::SetMode(), KIGFX::PREVIEW::SELECTION_AREA::SetOrigin(), KIGFX::PREVIEW::SELECTION_AREA::SetSubtractive(), KIGFX::VIEW::SetVisible(), unselect(), EVENTS::UnselectedEvent, KIGFX::VIEW::Update(), KIGFX::PREVIEW::SELECTION_AREA::ViewBBox(), TOOL_INTERACTIVE::Wait(), and VECTOR2< T >::x.

Referenced by Main().

SelectPoint()

void PL_SELECTION_TOOL::SelectPoint	(	const VECTOR2I &	aWhere,
		bool *	aSelectionCancelledFlag = nullptr
	)

Select an item pointed by the parameter aWhere.

If there is more than one item at that place, there is a menu displayed that allows one to choose the item.

Parameters

aWhere	is the place where the item should be selected.
aSelectionCancelledFlag	allows the function to inform its caller that a selection was canceled (for instance, by clicking outside of the disambiguation menu).

Definition at line 239 of file pl_selection_tool.cpp.

References COLLECTOR::Append(), SELECTION::ClearReferencePoint(), ClearSelection(), SELECTION_TOOL::doSelectionMenu(), COLLECTOR::GetCount(), DS_DATA_MODEL::GetTheInstance(), TOOL_BASE::getView(), guessSelectionCandidates(), HITTEST_THRESHOLD_PIXELS, KiROUND(), SELECTION_TOOL::m_additive, SELECTION_TOOL::m_exclusive_or, COLLECTOR::m_MenuCancelled, m_selection, SELECTION_TOOL::m_skip_heuristics, SELECTION_TOOL::m_subtractive, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ProcessEvent(), select(), EVENTS::SelectedEvent, unselect(), and EVENTS::UnselectedEvent.

Referenced by disambiguateCursor(), Main(), and RequestSelection().

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, TOOL_MANAGER::ScheduleContextMenu(), and ACTION_MENU::SetTool().

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

setModifiersState()

void SELECTION_TOOL::setModifiersState ( bool  aShiftState, bool  aCtrlState, bool  aAltState  )

protectedinherited

Set the configuration of m_additive, m_subtractive, m_exclusive_or, m_skip_heuristics from the state of modifier keys SHIFT, CTRL, ALT and depending on the OS.

Definition at line 49 of file selection_tool.cpp.

References SELECTION_TOOL::ctrlClickHighlights(), SELECTION_TOOL::m_additive, SELECTION_TOOL::m_drag_additive, SELECTION_TOOL::m_drag_subtractive, SELECTION_TOOL::m_exclusive_or, SELECTION_TOOL::m_highlight_modifier, SELECTION_TOOL::m_skip_heuristics, and SELECTION_TOOL::m_subtractive.

Referenced by SCH_SELECTION_TOOL::disambiguateCursor(), disambiguateCursor(), PCB_SELECTION_TOOL::disambiguateCursor(), SCH_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), Main(), PCB_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::OnIdle(), and PCB_SELECTION_TOOL::OnIdle().

setTransitions()

void PL_SELECTION_TOOL::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.

Implements TOOL_INTERACTIVE.

Definition at line 547 of file pl_selection_tool.cpp.

References SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), ClearSelection(), disambiguateCursor(), EVENTS::DisambiguatePoint, TOOL_INTERACTIVE::Go(), Main(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), ACTIONS::selectionActivate, ACTIONS::selectionClear, ACTIONS::selectionMenu, SELECTION_TOOL::SelectionMenu(), ACTIONS::selectItem, ACTIONS::selectItems, ACTIONS::unselectItem, ACTIONS::unselectItems, ACTIONS::updateMenu, and SELECTION_TOOL::UpdateMenu().

UnbrightenItem()

void SELECTION_TOOL::UnbrightenItem ( EDA_ITEM *  aItem )

inherited

Definition at line 226 of file selection_tool.cpp.

References BRIGHTENED, and SELECTION_TOOL::unhighlight().

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_DRAWING_TOOLS::doSyncSheetsPins(), SCH_EDIT_TOOL::InteractiveDelete(), SYMBOL_EDITOR_EDIT_TOOL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), PANEL_COMPONENT_CLASS_ASSIGNMENT::OnHighlightItemsClick(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), SCH_FIND_REPLACE_TOOL::UpdateFind(), and PANEL_ASSIGN_COMPONENT_CLASSES::~PANEL_ASSIGN_COMPONENT_CLASSES().

unhighlight()

void PL_SELECTION_TOOL::unhighlight ( EDA_ITEM *  aItem, int  aHighlightMode, SELECTION *  aGroup = nullptr  )

overrideprivatevirtual

Unhighlight the item visually.

Parameters

aItem	is an item to be be highlighted.
aHighlightMode	should be either SELECTED or BRIGHTENED
aGroup	is the group to remove the item from.

Implements SELECTION_TOOL.

Definition at line 514 of file pl_selection_tool.cpp.

References BRIGHTENED, EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearSelected(), TOOL_BASE::getView(), SELECTION::Remove(), SELECTED, and KIGFX::VIEW::Update().

Referenced by ClearSelection(), and unselect().

unselect()

void PL_SELECTION_TOOL::unselect ( EDA_ITEM *  aItem )

overrideprivatevirtual

Take necessary action mark an item as unselected.

Parameters

aItem

is an item to be unselected.

Implements SELECTION_TOOL.

Definition at line 494 of file pl_selection_tool.cpp.

References m_selection, SELECTED, and unhighlight().

Referenced by selectMultiple(), and SelectPoint().

UpdateMenu()

int SELECTION_TOOL::UpdateMenu ( const TOOL_EVENT &  aEvent )

inherited

Update a menu's state based on the current selection.

The menu is passed in aEvent's parameter.

Definition at line 93 of file selection_tool.cpp.

References CONDITIONAL_MENU::Evaluate(), TOOL_EVENT::Parameter(), SELECTION_TOOL::selection(), and ACTION_MENU::UpdateAll().

Referenced by SCH_SELECTION_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), setTransitions(), and PCB_SELECTION_TOOL::setTransitions().

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

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), ROUTER_TOOL::InlineDrag(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PCB_TEST_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), SCH_SELECTION_TOOL::selectMultiple(), selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

Member Data Documentation

m_additive

bool SELECTION_TOOL::m_additive

protectedinherited

Items should be added to sel (instead of replacing).

Definition at line 151 of file selection_tool.h.

Referenced by SCH_SELECTION_TOOL::disambiguateCursor(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), SELECTION_TOOL::hasModifier(), SCH_SELECTION_TOOL::Main(), Main(), SCH_SELECTION_TOOL::OnIdle(), PCB_SELECTION_TOOL::OnIdle(), SCH_SELECTION_TOOL::SelectCellsBetween(), GERBVIEW_SELECTION_TOOL::selectPoint(), SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::selectTableCells(), and SELECTION_TOOL::setModifiersState().

m_canceledMenu

bool SELECTION_TOOL::m_canceledMenu

protectedinherited

Sets to true if the disambiguation menu was canceled.

Definition at line 163 of file selection_tool.h.

Referenced by SCH_SELECTION_TOOL::disambiguateCursor(), disambiguateCursor(), PCB_SELECTION_TOOL::disambiguateCursor(), and PCB_SELECTION_TOOL::Main().

m_disambiguateTimer

wxTimer SELECTION_TOOL::m_disambiguateTimer

protectedinherited

Timer to show the disambiguate menu.

Definition at line 165 of file selection_tool.h.

Referenced by SCH_SELECTION_TOOL::Init(), Init(), PCB_SELECTION_TOOL::Init(), SCH_SELECTION_TOOL::Main(), Main(), PCB_SELECTION_TOOL::Main(), and PCB_TEST_SELECTION_TOOL::Main().

m_drag_additive

bool SELECTION_TOOL::m_drag_additive

protectedinherited

Add multiple items to selection.

Definition at line 160 of file selection_tool.h.

Referenced by SCH_SELECTION_TOOL::selectMultiple(), selectMultiple(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), and SELECTION_TOOL::setModifiersState().

m_drag_subtractive

bool SELECTION_TOOL::m_drag_subtractive

protectedinherited

Remove multiple from selection.

Definition at line 161 of file selection_tool.h.

Referenced by SCH_SELECTION_TOOL::selectMultiple(), selectMultiple(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), and SELECTION_TOOL::setModifiersState().

m_exclusive_or

bool SELECTION_TOOL::m_exclusive_or

protectedinherited

Items' selection state should be toggled.

Definition at line 153 of file selection_tool.h.

Referenced by SCH_SELECTION_TOOL::disambiguateCursor(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), SELECTION_TOOL::hasModifier(), SCH_SELECTION_TOOL::Main(), Main(), SCH_SELECTION_TOOL::OnIdle(), PCB_SELECTION_TOOL::OnIdle(), SCH_SELECTION_TOOL::SelectCellsBetween(), SCH_SELECTION_TOOL::selectMultiple(), selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), PCB_SELECTION_TOOL::selectTableCells(), and SELECTION_TOOL::setModifiersState().

m_frame

PL_EDITOR_FRAME* PL_SELECTION_TOOL::m_frame

private

Definition at line 154 of file pl_selection_tool.h.

Referenced by Init(), Main(), Reset(), and selectMultiple().

m_highlight_modifier

bool SELECTION_TOOL::m_highlight_modifier

protectedinherited

Select highlight net on left click.

Definition at line 159 of file selection_tool.h.

Referenced by PCB_SELECTION_TOOL::Main(), and SELECTION_TOOL::setModifiersState().

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 SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), TOOL_INTERACTIVE::GetToolMenu(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), EDA_3D_CONTROLLER::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SCH_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_SELECTION_TOOL::Init(), SCH_TOOL_BASE< T >::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), GERBVIEW_SELECTION_TOOL::Init(), PICKER_TOOL::Init(), ZOOM_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), Init(), ROUTER_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), DRAWING_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::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(), EDA_3D_CONTROLLER::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), TOOL_INTERACTIVE::TOOL_INTERACTIVE(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

m_multiple

bool SELECTION_TOOL::m_multiple

protectedinherited

Multiple selection mode is active.

Definition at line 154 of file selection_tool.h.

Referenced by SCH_SELECTION_TOOL::OnIdle(), PCB_SELECTION_TOOL::OnIdle(), SCH_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::selectMultiple(), selectMultiple(), PCB_SELECTION_TOOL::SelectRectArea(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), and SCH_SELECTION_TOOL::UnselectAll().

m_originalCursor

VECTOR2I SELECTION_TOOL::m_originalCursor

protectedinherited

Location of original cursor when starting click.

Definition at line 167 of file selection_tool.h.

Referenced by SCH_SELECTION_TOOL::disambiguateCursor(), disambiguateCursor(), PCB_SELECTION_TOOL::disambiguateCursor(), SCH_SELECTION_TOOL::Main(), Main(), and PCB_SELECTION_TOOL::Main().

m_selection

PL_SELECTION PL_SELECTION_TOOL::m_selection

private

Definition at line 155 of file pl_selection_tool.h.

Referenced by ClearSelection(), GetSelection(), Main(), RebuildSelection(), RequestSelection(), select(), selection(), selectionContains(), selectMultiple(), SelectPoint(), and unselect().

m_skip_heuristics

bool SELECTION_TOOL::m_skip_heuristics

protectedinherited

Show disambiguation menu for all items under the cursor rather than trying to narrow them down first using heuristics.

Definition at line 158 of file selection_tool.h.

Referenced by SCH_SELECTION_TOOL::disambiguateCursor(), disambiguateCursor(), PCB_SELECTION_TOOL::disambiguateCursor(), SCH_SELECTION_TOOL::narrowSelection(), PCB_SELECTION_TOOL::Selectable(), SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), and SELECTION_TOOL::setModifiersState().

m_subtractive

bool SELECTION_TOOL::m_subtractive

protectedinherited

Items should be removed from selection.

Definition at line 152 of file selection_tool.h.

Referenced by SCH_SELECTION_TOOL::disambiguateCursor(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), SELECTION_TOOL::hasModifier(), SCH_SELECTION_TOOL::Main(), Main(), SCH_SELECTION_TOOL::OnIdle(), PCB_SELECTION_TOOL::OnIdle(), SCH_SELECTION_TOOL::SelectCellsBetween(), SCH_SELECTION_TOOL::selectMultiple(), selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), PCB_SELECTION_TOOL::selectTableCells(), and SELECTION_TOOL::setModifiersState().

m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Unique id, assigned by a TOOL_MANAGER instance.

Definition at line 215 of file tool_base.h.

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

m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 220 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), SCH_POINT_EDITOR::addCorner(), SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), GROUP_TOOL::AddToGroup(), SYMBOL_EDITOR_MOVE_TOOL::AlignElements(), SCH_MOVE_TOOL::AlignToGrid(), PCB_CONTROL::AppendBoard(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), TOOL_BASE::attachManager(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_TOOL::ChangeBodyStyle(), SCH_EDITOR_CONTROL::ChangeLineMode(), SCH_EDIT_TOOL::ChangeSymbols(), SCH_EDIT_TOOL::ChangeTextType(), EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), GERBVIEW_CONTROL::ClearAllLayers(), SCH_EDITOR_CONTROL::ClearHighlight(), BOARD_INSPECTION_TOOL::ClearHighlight(), GERBVIEW_SELECTION_TOOL::clearSelection(), ClearSelection(), SCH_EDIT_TABLE_TOOL::clearSelection(), PCB_EDIT_TABLE_TOOL::clearSelection(), SCH_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), SCH_EDITOR_CONTROL::CopyAsText(), SYMBOL_EDITOR_EDIT_TOOL::CopyAsText(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), ARRAY_TOOL::CreateArray(), SCH_GROUP_TOOL::createCommit(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createInductorBetween(), SCH_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), COMMON_TOOLS::CursorControl(), SCH_EDITOR_CONTROL::Cut(), PCB_CONTROL::CycleLayerPresets(), SCH_EDIT_TOOL::DdAppendFile(), EDIT_TOOL::DeleteItems(), BOARD_INSPECTION_TOOL::DiffFootprint(), SCH_EDITOR_CONTROL::doCopy(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), SCH_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::doSyncSelection(), SCH_DRAWING_TOOLS::doSyncSheetsPins(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), SCH_EDIT_TOOL::EditPageNumber(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SCH_EDIT_TABLE_TOOL::EditTable(), PCB_EDIT_TABLE_TOOL::EditTable(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SELECTION_TOOL::EnterGroup(), PCB_SELECTION_TOOL::EnterGroup(), SCH_NAVIGATE_TOOL::EnterSheet(), PAD_TOOL::EnumeratePads(), SCH_INSPECTION_TOOL::ExcludeMarker(), KICAD_MANAGER_CONTROL::Execute(), SCH_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::expandConnection(), EDA_3D_CONTROLLER::ExportImage(), ZONE_FILLER_TOOL::FillAllZones(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), TOOL_BASE::GetManager(), TOOL_BASE::getModelInternal(), DRAWING_TOOL::getSourceZoneForAction(), PCB_EDIT_TABLE_TOOL::getTableCellSelection(), TOOL_BASE::getToolHolderInternal(), SCH_EDIT_TABLE_TOOL::getToolMgr(), PCB_EDIT_TABLE_TOOL::getToolMgr(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_INTERACTIVE::goInternal(), PCB_SELECTION_TOOL::grabUnconnected(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), COMMON_TOOLS::GridFastCycle(), SCH_EDITOR_CONTROL::GridFeedback(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridOrigin(), PCB_CONTROL::GridPlaceOrigin(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), SCH_GROUP_TOOL::Group(), PCB_GROUP_TOOL::Group(), PCB_CONTROL::HighContrastModeCycle(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightItem(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PL_EDIT_TOOL::ImportDrawingSheetContent(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), SCH_EDIT_TOOL::Increment(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), EDIT_TOOL::Increment(), GROUP_TOOL::Init(), SCH_EDIT_TOOL::Init(), SCH_TOOL_BASE< T >::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_POINT_EDITOR::Init(), ROUTER_TOOL::Init(), 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(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), PCB_POINT_EDITOR::Init(), PCB_SELECTION_TOOL::Init(), POSITION_RELATIVE_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), SCH_INSPECTION_TOOL::InspectERCError(), SCH_EDIT_TOOL::InteractiveDelete(), SYMBOL_EDITOR_EDIT_TOOL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), TOOL_BASE::IsToolActive(), SCH_EDIT_TOOL::JustifyText(), EDIT_TOOL::JustifyText(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::Move(), EDIT_TOOL::MoveExact(), SCH_EDITOR_CONTROL::NextLineMode(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), ARRAY_TOOL::onDialogClosed(), SELECTION_TOOL::onDisambiguationExpire(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), SCH_GROUP_TOOL::PickNewMember(), PCB_GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_EDITOR_CONTROL::PlaceLinkedDesignBlock(), PCB_CONTROL::PlaceLinkedDesignBlock(), SCH_DRAWING_TOOLS::PlaceNextSymbolUnit(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), SCH_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDITOR_CONTROL::Redo(), SYMBOL_EDITOR_EDIT_TOOL::Redo(), GENERATOR_TOOL::RegenerateSelected(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDA_3D_CONTROLLER::ReloadBoard(), EDIT_TOOL::Remove(), SCH_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem(), MULTICHANNEL_TOOL::repeatLayout(), PCB_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), EDA_3D_CONTROLLER::Reset(), COMMON_TOOLS::Reset(), PNS::TOOL_BASE::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), COMMON_TOOLS::ResetLocalCoords(), TOOL_INTERACTIVE::resetTransitions(), ROUTER_TOOL::restoreSelection(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), TOOL_INTERACTIVE::RunMainStack(), DRC_TOOL::RunTests(), SCH_EDITOR_CONTROL::SaveToLinkedDesignBlock(), PCB_CONTROL::SaveToLinkedDesignBlock(), SCH_SELECTION_TOOL::Selectable(), SCH_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectColumns(), PCB_SELECTION_TOOL::SelectColumns(), SCH_SELECTION_TOOL::SelectConnection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), PCB_PICKER_TOOL::SelectItemInteractively(), GERBVIEW_SELECTION_TOOL::SelectItems(), SCH_SELECTION_TOOL::selectMultiple(), selectMultiple(), PCB_SELECTION_TOOL::SelectMultiple(), PCB_SELECTION_TOOL::selectNet(), SCH_SELECTION_TOOL::SelectNext(), GERBVIEW_SELECTION_TOOL::selectPoint(), PCB_TEST_SELECTION_TOOL::selectPoint(), SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_PICKER_TOOL::SelectPointInteractively(), PCB_SELECTION_TOOL::SelectPolyArea(), SCH_SELECTION_TOOL::SelectPrevious(), PCB_SELECTION_TOOL::SelectRectArea(), SCH_SELECTION_TOOL::SelectRows(), PCB_SELECTION_TOOL::SelectRows(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), SCH_SELECTION_TOOL::SelectTable(), PCB_SELECTION_TOOL::SelectTable(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), SCH_EDIT_TOOL::SetAttribute(), TOOL_INTERACTIVE::SetContextMenu(), EDA_3D_CONTROLLER::SetMaterial(), PCB_SELECTION_TOOL::SetSelectPoly(), PCB_SELECTION_TOOL::SetSelectRect(), DRC_TOOL::ShowDRCDialog(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), SCH_DRAWING_TOOLS::SingleClickPlace(), PCB_CONTROL::SnapMode(), SCH_EDIT_TOOL::Swap(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), EDIT_TOOL::Swap(), SCH_SELECTION_TOOL::SyncSelection(), COMMON_TOOLS::ToggleCursor(), COMMON_TOOLS::ToggleCursorStyle(), EDA_3D_CONTROLLER::ToggleLayersManager(), EDA_3D_CONTROLLER::ToggleRaytracing(), EDA_3D_CONTROLLER::ToggleVisibility(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), SCH_MOVE_TOOL::trimDanglingLines(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_EDITOR_CONTROL::Undo(), SYMBOL_EDITOR_EDIT_TOOL::Undo(), SCH_LINE_WIRE_BUS_TOOL::UnfoldBus(), GROUP_TOOL::Ungroup(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_SELECTION_TOOL::unrouteSelected(), SCH_SELECTION_TOOL::UnselectAll(), PCB_SELECTION_TOOL::UnselectAll(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), PCB_POINT_EDITOR::updateItem(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), SCH_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_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 TOOL_BASE::GetName().

m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

Definition at line 214 of file tool_base.h.

Referenced by TOOL_BASE::GetType().

---

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

• pl_selection_tool.h
• pl_selection_tool.cpp