SELECTION_TOOL Class Reference

#include <selection_tool.h>

Inheritance diagram for 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
	SELECTION_TOOL (const std::string &aName)
	~SELECTION_TOOL ()
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)
int	ReselectItem (const TOOL_EVENT &aEvent)
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.
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.
SELECTION &	GetSelection ()
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.
virtual bool	Init ()
	Init() is called once upon a registration of the tool.
virtual void	Reset (RESET_REASON aReason)=0
	Bring the tool to a known, initial state.
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
virtual SELECTION &	selection ()=0
	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.
virtual void	select (EDA_ITEM *aItem)=0
	Take necessary action mark an item as selected.
virtual void	unselect (EDA_ITEM *aItem)=0
	Take necessary action mark an item as unselected.
virtual void	highlight (EDA_ITEM *aItem, int aHighlightMode, SELECTION *aGroup=nullptr)=0
	Highlight the item visually.
virtual void	unhighlight (EDA_ITEM *aItem, int aHighlightMode, SELECTION *aGroup=nullptr)=0
	Unhighlight the item visually.
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
virtual void	setTransitions ()=0
	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

Detailed Description

Definition at line 45 of file 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

SELECTION_TOOL()

SELECTION_TOOL::SELECTION_TOOL

(

const std::string &

aName

)

Definition at line 35 of file selection_tool.cpp.

References m_additive, m_canceledMenu, m_drag_additive, m_drag_subtractive, m_exclusive_or, m_highlight_modifier, m_multiple, m_skip_heuristics, m_subtractive, and TOOL_INTERACTIVE::TOOL_INTERACTIVE().

Referenced by GERBVIEW_SELECTION_TOOL::GERBVIEW_SELECTION_TOOL(), PCB_SELECTION_TOOL::PCB_SELECTION_TOOL(), PCB_TEST_SELECTION_TOOL::PCB_TEST_SELECTION_TOOL(), PL_SELECTION_TOOL::PL_SELECTION_TOOL(), and SCH_SELECTION_TOOL::SCH_SELECTION_TOOL().

~SELECTION_TOOL()

SELECTION_TOOL::~SELECTION_TOOL ( )

inline

Definition at line 49 of file 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_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().

AddItemsToSel() [1/2]

int SELECTION_TOOL::AddItemsToSel

(

const TOOL_EVENT &

aEvent

)

Definition at line 141 of file selection_tool.cpp.

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

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

AddItemsToSel() [2/2]

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

Definition at line 149 of file selection_tool.cpp.

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

AddItemToSel() [1/2]

int SELECTION_TOOL::AddItemToSel

(

const TOOL_EVENT &

aEvent

)

Definition at line 108 of file selection_tool.cpp.

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

Referenced by AddItemToSel(), SCH_DRAWING_TOOLS::ImportSheet(), PL_EDIT_TOOL::InteractiveDelete(), SCH_TOOL_BASE< T >::InteractiveDelete(), DIALOG_INSPECTOR::onCellClicked(), PCB_EDIT_FRAME::OnCrossProbeFlashTimer(), SCH_EDIT_FRAME::OnCrossProbeFlashTimer(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceTuningPattern(), ReselectItem(), PCB_SELECTION_TOOL::setTransitions(), PL_SELECTION_TOOL::setTransitions(), SCH_SELECTION_TOOL::setTransitions(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow().

AddItemToSel() [2/2]

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

Definition at line 116 of file selection_tool.cpp.

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

Referenced by TOOL_MANAGER::RegisterTool().

BrightenItem()

void SELECTION_TOOL::BrightenItem

(

EDA_ITEM *

aItem

)

Definition at line 220 of file selection_tool.cpp.

References BRIGHTENED, and highlight().

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), PCB_CONTROL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), SCH_TOOL_BASE< T >::InteractiveDelete(), PANEL_COMPONENT_CLASS_ASSIGNMENT::OnHighlightItemsClick(), SCH_EDITOR_CONTROL::SimProbe(), and SCH_EDITOR_CONTROL::SimTune().

ctrlClickHighlights()

virtual bool SELECTION_TOOL::ctrlClickHighlights ( )

inlineprotectedvirtual

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

Reimplemented in PCB_SELECTION_TOOL.

Definition at line 145 of file selection_tool.h.

Referenced by setModifiersState().

doSelectionMenu()

bool SELECTION_TOOL::doSelectionMenu ( COLLECTOR * aCollector )

protected

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(), TOOL_BASE::getEditFrame(), EDA_ITEM::GetItemDescription(), EDA_ITEM::GetMenuImage(), TOOL_BASE::getView(), COLLECTOR::HasAdditionalItems(), highlight(), info, INVALID_BITMAP, 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, unhighlight(), KIGFX::VIEW::UpdateItems(), and TOOL_INTERACTIVE::Wait().

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

EnterGroup()

virtual void SELECTION_TOOL::EnterGroup ( )

inlinevirtual

Reimplemented in PCB_SELECTION_TOOL, and SCH_SELECTION_TOOL.

Definition at line 88 of file selection_tool.h.

ExitGroup()

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

inlinevirtual

Reimplemented in PCB_SELECTION_TOOL, and SCH_SELECTION_TOOL.

Definition at line 89 of file selection_tool.h.

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

GetSelection()

SELECTION & SELECTION_TOOL::GetSelection ( )

inline

Definition at line 86 of file selection_tool.h.

References selection().

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

hasModifier()

bool SELECTION_TOOL::hasModifier ( )

protected

True if a selection modifier is enabled, false otherwise.

Definition at line 87 of file selection_tool.cpp.

References m_additive, m_exclusive_or, and m_subtractive.

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

highlight()

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

protectedpure virtual

Highlight the item visually.

Parameters

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

Implemented in GERBVIEW_SELECTION_TOOL, PCB_SELECTION_TOOL, PCB_TEST_SELECTION_TOOL, PL_SELECTION_TOOL, and SCH_SELECTION_TOOL.

Referenced by BrightenItem(), and doSelectionMenu().

Init()

virtual bool TOOL_BASE::Init ( )

inlinevirtualinherited

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

Returns

True if the initialization went fine, false - otherwise.

Reimplemented in ALIGN_DISTRIBUTE_TOOL, ARRAY_TOOL, BITMAP2CMP_CONTROL, BOARD_EDITOR_CONTROL, BOARD_INSPECTION_TOOL, BOARD_REANNOTATE_TOOL, CONVERT_TOOL, CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL, DRAWING_TOOL, EDA_3D_CONTROLLER, EDIT_TOOL, EMBED_TOOL, FOOTPRINT_CHOOSER_SELECTION_TOOL, FOOTPRINT_EDITOR_CONTROL, FOOTPRINT_WIZARD_TOOLS, GENERATOR_TOOL, GERBVIEW_INSPECTION_TOOL, GERBVIEW_SELECTION_TOOL, GLOBAL_EDIT_TOOL, GROUP_TOOL, PAD_TOOL, PCB_CALCULATOR_CONTROL, PCB_DESIGN_BLOCK_CONTROL, PCB_EDIT_TABLE_TOOL, PCB_PICKER_TOOL, PCB_POINT_EDITOR, PCB_SELECTION_TOOL, PCB_TEST_SELECTION_TOOL, PCB_TOOL_BASE, PCB_VIEWER_TOOLS, PICKER_TOOL, PL_DRAWING_TOOLS, PL_EDIT_TOOL, PL_EDITOR_CONTROL, PL_POINT_EDITOR, PL_SELECTION_TOOL, POSITION_RELATIVE_TOOL, ROUTER_TOOL, SCH_DESIGN_BLOCK_CONTROL, SCH_DRAWING_TOOLS, SCH_EDIT_TABLE_TOOL, SCH_EDIT_TOOL, SCH_INSPECTION_TOOL, SCH_LINE_WIRE_BUS_TOOL, SCH_MOVE_TOOL, SCH_POINT_EDITOR, SCH_SELECTION_TOOL, SCH_TOOL_BASE< T >, SCH_TOOL_BASE< SCH_BASE_FRAME >, SCH_TOOL_BASE< SCH_EDIT_FRAME >, SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >, SCRIPTING_TOOL, SIMULATOR_CONTROL, SYMBOL_EDITOR_CONTROL, SYMBOL_EDITOR_DRAWING_TOOLS, SYMBOL_EDITOR_EDIT_TOOL, SYMBOL_EDITOR_MOVE_TOOL, SYMBOL_EDITOR_PIN_TOOL, and ZOOM_TOOL.

Definition at line 92 of file tool_base.h.

Referenced by TOOL_MANAGER::InitTools().

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

onDisambiguationExpire()

void SELECTION_TOOL::onDisambiguationExpire ( wxTimerEvent & aEvent )

protected

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

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

RemoveItemFromSel() [1/2]

int SELECTION_TOOL::RemoveItemFromSel

(

const TOOL_EVENT &

aEvent

)

Definition at line 163 of file selection_tool.cpp.

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

Referenced by SCHEMATIC::CleanUp(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), RemoveItemFromSel(), ReselectItem(), PCB_SELECTION_TOOL::setTransitions(), PL_SELECTION_TOOL::setTransitions(), and SCH_SELECTION_TOOL::setTransitions().

RemoveItemFromSel() [2/2]

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

Definition at line 171 of file selection_tool.cpp.

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

RemoveItemsFromSel() [1/3]

int SELECTION_TOOL::RemoveItemsFromSel

(

const TOOL_EVENT &

aEvent

)

Definition at line 184 of file selection_tool.cpp.

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

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

RemoveItemsFromSel() [2/3]

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

Definition at line 192 of file selection_tool.cpp.

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

RemoveItemsFromSel() [3/3]

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

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(), RemoveItemsFromSel(), and selection().

ReselectItem()

int SELECTION_TOOL::ReselectItem

(

const TOOL_EVENT &

aEvent

)

Definition at line 129 of file selection_tool.cpp.

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

Referenced by PCB_SELECTION_TOOL::setTransitions().

Reset()

virtual void TOOL_BASE::Reset ( RESET_REASON aReason )

pure virtualinherited

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.

Implemented in ALIGN_DISTRIBUTE_TOOL, ARRAY_TOOL, BITMAP2CMP_CONTROL, BOARD_EDITOR_CONTROL, BOARD_INSPECTION_TOOL, BOARD_REANNOTATE_TOOL, COMMON_CONTROL, COMMON_TOOLS, CONVERT_TOOL, CVPCB_ASSOCIATION_TOOL, CVPCB_CONTROL, CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL, DESIGN_BLOCK_CONTROL, DRAWING_TOOL, DRC_TOOL, EDA_3D_CONTROLLER, EDIT_TOOL, EMBED_TOOL, FOOTPRINT_CHOOSER_SELECTION_TOOL, FOOTPRINT_EDITOR_CONTROL, FOOTPRINT_WIZARD_TOOLS, GENERATOR_TOOL, GENERATOR_TOOL_PNS_PROXY, GERBVIEW_CONTROL, GERBVIEW_INSPECTION_TOOL, GERBVIEW_SELECTION_TOOL, GLOBAL_EDIT_TOOL, GROUP_TOOL, KI_TEST::DUMMY_TOOL, KICAD_MANAGER_CONTROL, LIBRARY_EDITOR_CONTROL, MICROWAVE_TOOL, PAD_TOOL, PCB_CALCULATOR_CONTROL, PCB_CONTROL, PCB_POINT_EDITOR, PCB_SELECTION_TOOL, PCB_TEST_SELECTION_TOOL, PCB_TOOL_BASE, PCB_VIEWER_TOOLS, PICKER_TOOL, PL_DRAWING_TOOLS, PL_EDIT_TOOL, PL_EDITOR_CONTROL, PL_POINT_EDITOR, PL_SELECTION_TOOL, PNS::TOOL_BASE, POSITION_RELATIVE_TOOL, PROPERTIES_TOOL, ROUTER_TOOL, SCH_INSPECTION_TOOL, SCH_POINT_EDITOR, SCH_SELECTION_TOOL, SCH_TOOL_BASE< T >, SCH_TOOL_BASE< SCH_BASE_FRAME >, SCH_TOOL_BASE< SCH_EDIT_FRAME >, SCH_TOOL_BASE< SYMBOL_EDIT_FRAME >, SCRIPTING_TOOL, SIMULATOR_CONTROL, SYMBOL_EDITOR_MOVE_TOOL, ZONE_FILLER_TOOL, and ZOOM_TOOL.

Referenced by ROUTER_TOOL::Reset(), TOOL_MANAGER::ResetTools(), and TOOL_MANAGER::runTool().

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.

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

select()

virtual void SELECTION_TOOL::select ( EDA_ITEM * aItem )

protectedpure virtual

Take necessary action mark an item as selected.

Implemented in GERBVIEW_SELECTION_TOOL, PCB_SELECTION_TOOL, PCB_TEST_SELECTION_TOOL, PL_SELECTION_TOOL, and SCH_SELECTION_TOOL.

Referenced by AddItemsToSel(), and AddItemToSel().

selection()

virtual SELECTION & SELECTION_TOOL::selection ( )

protectedpure virtual

Return a reference to the selection.

Implemented in GERBVIEW_SELECTION_TOOL, PCB_SELECTION_TOOL, PCB_TEST_SELECTION_TOOL, PL_SELECTION_TOOL, and SCH_SELECTION_TOOL.

Referenced by AddItemsToSel(), AddItemToSel(), GetSelection(), onDisambiguationExpire(), RemoveItemFromSel(), RemoveItemsFromSel(), RemoveItemsFromSel(), ReselectItem(), and UpdateMenu().

SelectionMenu()

int SELECTION_TOOL::SelectionMenu

(

const TOOL_EVENT &

aEvent

)

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 doSelectionMenu(), COLLECTOR::m_MenuCancelled, and TOOL_EVENT::Parameter().

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

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

setModifiersState()

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

protected

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 ctrlClickHighlights(), m_additive, m_drag_additive, m_drag_subtractive, m_exclusive_or, m_highlight_modifier, m_skip_heuristics, and m_subtractive.

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

setTransitions()

virtual void TOOL_INTERACTIVE::setTransitions ( )

privatepure virtualinherited

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

It is called every time tool is reset or finished.

Implemented in ALIGN_DISTRIBUTE_TOOL, ARRAY_TOOL, AUTOPLACE_TOOL, BITMAP2CMP_CONTROL, BOARD_EDITOR_CONTROL, BOARD_INSPECTION_TOOL, BOARD_REANNOTATE_TOOL, COMMON_CONTROL, COMMON_TOOLS, CONVERT_TOOL, CVPCB_ASSOCIATION_TOOL, CVPCB_CONTROL, CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL, DESIGN_BLOCK_CONTROL, DRAWING_TOOL, DRC_TOOL, EDA_3D_CONTROLLER, EDIT_TOOL, EMBED_TOOL, FOOTPRINT_CHOOSER_SELECTION_TOOL, FOOTPRINT_EDITOR_CONTROL, FOOTPRINT_WIZARD_TOOLS, GENERATOR_TOOL, GERBVIEW_CONTROL, GERBVIEW_INSPECTION_TOOL, GERBVIEW_SELECTION_TOOL, GLOBAL_EDIT_TOOL, GROUP_TOOL, KICAD_MANAGER_CONTROL, LIBRARY_EDITOR_CONTROL, MICROWAVE_TOOL, MULTICHANNEL_TOOL, PAD_TOOL, PCB_CALCULATOR_CONTROL, PCB_CONTROL, PCB_DESIGN_BLOCK_CONTROL, PCB_EDIT_TABLE_TOOL, PCB_PICKER_TOOL, PCB_POINT_EDITOR, PCB_SELECTION_TOOL, PCB_TEST_SELECTION_TOOL, PCB_TOOL_BASE, PCB_VIEWER_TOOLS, PICKER_TOOL, PL_DRAWING_TOOLS, PL_EDIT_TOOL, PL_EDITOR_CONTROL, PL_POINT_EDITOR, PL_SELECTION_TOOL, POSITION_RELATIVE_TOOL, PROPERTIES_TOOL, ROUTER_TOOL, SCH_DESIGN_BLOCK_CONTROL, SCH_DRAWING_TOOLS, SCH_EDIT_TABLE_TOOL, SCH_EDIT_TOOL, SCH_EDITOR_CONTROL, SCH_FIND_REPLACE_TOOL, SCH_INSPECTION_TOOL, SCH_LINE_WIRE_BUS_TOOL, SCH_MOVE_TOOL, SCH_NAVIGATE_TOOL, SCH_POINT_EDITOR, SCH_SELECTION_TOOL, SCRIPTING_TOOL, SIMULATOR_CONTROL, SYMBOL_EDITOR_CONTROL, SYMBOL_EDITOR_DRAWING_TOOLS, SYMBOL_EDITOR_EDIT_TOOL, SYMBOL_EDITOR_MOVE_TOOL, SYMBOL_EDITOR_PIN_TOOL, ZONE_FILLER_TOOL, and ZOOM_TOOL.

Referenced by SCH_TOOL_BASE< SCH_EDIT_FRAME >::GetToolMenu().

UnbrightenItem()

void SELECTION_TOOL::UnbrightenItem

(

EDA_ITEM *

aItem

)

Definition at line 226 of file selection_tool.cpp.

References BRIGHTENED, and unhighlight().

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_DRAWING_TOOLS::doSyncSheetsPins(), PCB_CONTROL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), SCH_TOOL_BASE< T >::InteractiveDelete(), PANEL_COMPONENT_CLASS_ASSIGNMENT::OnHighlightItemsClick(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), and PANEL_ASSIGN_COMPONENT_CLASSES::~PANEL_ASSIGN_COMPONENT_CLASSES().

unhighlight()

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

protectedpure virtual

Unhighlight the item visually.

Parameters

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

Implemented in GERBVIEW_SELECTION_TOOL, PCB_SELECTION_TOOL, PCB_TEST_SELECTION_TOOL, PL_SELECTION_TOOL, and SCH_SELECTION_TOOL.

Referenced by doSelectionMenu(), and UnbrightenItem().

unselect()

virtual void SELECTION_TOOL::unselect ( EDA_ITEM * aItem )

protectedpure virtual

Take necessary action mark an item as unselected.

Implemented in GERBVIEW_SELECTION_TOOL, PCB_SELECTION_TOOL, PCB_TEST_SELECTION_TOOL, PL_SELECTION_TOOL, and SCH_SELECTION_TOOL.

Referenced by RemoveItemFromSel(), and RemoveItemsFromSel().

UpdateMenu()

int SELECTION_TOOL::UpdateMenu

(

const TOOL_EVENT &

aEvent

)

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(), and ACTION_MENU::UpdateAll().

Referenced by GERBVIEW_SELECTION_TOOL::setTransitions(), PCB_SELECTION_TOOL::setTransitions(), PL_SELECTION_TOOL::setTransitions(), and SCH_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.

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

Member Data Documentation

m_additive

bool SELECTION_TOOL::m_additive

protected

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

Definition at line 150 of file selection_tool.h.

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

m_canceledMenu

bool SELECTION_TOOL::m_canceledMenu

protected

Sets to true if the disambiguation menu was canceled.

Definition at line 162 of file selection_tool.h.

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

m_disambiguateTimer

wxTimer SELECTION_TOOL::m_disambiguateTimer

protected

Timer to show the disambiguate menu.

Definition at line 164 of file selection_tool.h.

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

m_drag_additive

bool SELECTION_TOOL::m_drag_additive

protected

Add multiple items to selection.

Definition at line 159 of file selection_tool.h.

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

m_drag_subtractive

bool SELECTION_TOOL::m_drag_subtractive

protected

Remove multiple from selection.

Definition at line 160 of file selection_tool.h.

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

m_exclusive_or

bool SELECTION_TOOL::m_exclusive_or

protected

Items' selection state should be toggled.

Definition at line 152 of file selection_tool.h.

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

m_highlight_modifier

bool SELECTION_TOOL::m_highlight_modifier

protected

Select highlight net on left click.

Definition at line 158 of file selection_tool.h.

Referenced by PCB_SELECTION_TOOL::Main(), SELECTION_TOOL(), and 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 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_multiple

bool SELECTION_TOOL::m_multiple

protected

Multiple selection mode is active.

Definition at line 153 of file selection_tool.h.

Referenced by PCB_SELECTION_TOOL::OnIdle(), SCH_SELECTION_TOOL::OnIdle(), SCH_SELECTION_TOOL::SelectAll(), SELECTION_TOOL(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::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

protected

Location of original cursor when starting click.

Definition at line 166 of file selection_tool.h.

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

m_skip_heuristics

bool SELECTION_TOOL::m_skip_heuristics

protected

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

Definition at line 157 of file selection_tool.h.

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

m_subtractive

bool SELECTION_TOOL::m_subtractive

protected

Items should be removed from selection.

Definition at line 151 of file selection_tool.h.

Referenced by SCH_SELECTION_TOOL::disambiguateCursor(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), hasModifier(), PL_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::OnIdle(), SCH_SELECTION_TOOL::OnIdle(), SCH_SELECTION_TOOL::SelectCellsBetween(), SELECTION_TOOL(), PL_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), PCB_SELECTION_TOOL::selectTableCells(), and 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(), 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:

• selection_tool.h
• selection_tool.cpp