PCB_VIEWER_TOOLS Class Reference

Tool useful for viewing footprints. More...

#include <pcb_viewer_tools.h>

Inheritance diagram for PCB_VIEWER_TOOLS:

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

Public Member Functions
	PCB_VIEWER_TOOLS ()
	~PCB_VIEWER_TOOLS () override
bool	Init () override
	Init() is called once upon a registration of the tool. More...
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state. More...
int	MeasureTool (const TOOL_EVENT &aEvent)
int	ShowPadNumbers (const TOOL_EVENT &aEvent)
int	PadDisplayMode (const TOOL_EVENT &aEvent)
int	GraphicOutlines (const TOOL_EVENT &aEvent)
int	TextOutlines (const TOOL_EVENT &aEvent)
int	Show3DViewer (const TOOL_EVENT &aEvent)
	Show the 3D viewer. More...
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events. More...
void	SetFootprintFrame (bool aIsFrame)
	Toggle edit footprint mode. More...
bool	IsFootprintFrame () const
void	Activate ()
	Run the tool. More...
TOOL_MENU &	GetToolMenu ()
void	SetContextMenu (ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
	Assign a context menu and tells when it should be activated. More...
void	RunMainStack (std::function< void()> aFunc)
	Call a function using the main stack. More...
template<class T >
void	Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
	Define which state (aStateFunc) to go when a certain event arrives (aConditions). More...
TOOL_EVENT *	Wait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
	Suspend execution of the tool until an event specified in aEventList arrives. More...
TOOL_TYPE	GetType () const
	Return the type of the tool. More...
TOOL_ID	GetId () const
	Return the unique identifier of the tool. More...
const std::string &	GetName () const
	Return the name of the tool. More...
TOOL_MANAGER *	GetManager () const
	Return the instance of TOOL_MANAGER that takes care of the tool. More...
bool	IsToolActive () const

Protected Member Functions
PCB_BASE_FRAME *	frame () const
KIGFX::PCB_VIEW *	view () const
PCBNEW_SETTINGS::DISPLAY_OPTIONS &	displayOptions () const
PCB_DRAW_PANEL_GAL *	canvas () const
BOARD *	board () const
FOOTPRINT *	footprint () const
void	attachManager (TOOL_MANAGER *aManager)
	Set the TOOL_MANAGER the tool will belong to. More...
KIGFX::VIEW *	getView () const
	Returns the instance of #VIEW object used in the application. More...
KIGFX::VIEW_CONTROLS *	getViewControls () const
	Return the instance of VIEW_CONTROLS object used in the application. More...
template<typename T >
T *	getEditFrame () const
	Return the application window object, casted to requested user type. More...
template<typename T >
T *	getModel () const
	Return the model object if it matches the requested type. More...

Protected Attributes
bool	m_footprintFrame
	Is this tool associated with a footprint frame. More...
TOOL_MENU	m_menu
	The functions below are not yet implemented - their interface may change. More...
TOOL_TYPE	m_type
	Unique identifier for the tool, assigned by a TOOL_MANAGER instance. More...
TOOL_ID	m_toolId
	Name of the tool. More...
std::string	m_toolName
TOOL_MANAGER *	m_toolMgr

Private Member Functions
void	resetTransitions ()
	Clear the current transition map and restores the default one created by setTransitions(). More...
void	goInternal (TOOL_STATE_FUNC &aState, const TOOL_EVENT_LIST &aConditions)
EDA_ITEM *	getModelInt () const
TOOLS_HOLDER *	getToolHolderInt () const

Detailed Description

Tool useful for viewing footprints.

This tool is designed to be lighter-weight so that it doesn't bring in as many PcbNew dependencies (since it is used in cvpcb).

Definition at line 39 of file pcb_viewer_tools.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 (required full reload)
GAL_SWITCH	Rendering engine changes.
REDRAW	Full drawing refresh.

Definition at line 77 of file tool_base.h.

 {
 RUN, 
 MODEL_RELOAD, 
 GAL_SWITCH, 
 REDRAW 
 };

Constructor & Destructor Documentation

PCB_VIEWER_TOOLS()

PCB_VIEWER_TOOLS::PCB_VIEWER_TOOLS ( )

inline

Definition at line 42 of file pcb_viewer_tools.h.

 :
 TOOL_INTERACTIVE( "pcbnew.PCBViewerTools" ),
 m_footprintFrame( false )
 {}

~PCB_VIEWER_TOOLS()

PCB_VIEWER_TOOLS::~PCB_VIEWER_TOOLS ( )

inlineoverride

Definition at line 47 of file pcb_viewer_tools.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 51 of file tool_interactive.cpp.

{
 m_toolMgr->InvokeTool( m_toolId );
}

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

Referenced by AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::copyToClipboard(), SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridSetOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), GROUP_TOOL::PickNewMember(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), DRAWING_TOOL::SetAnchor(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER *  aManager )

protectedinherited

Set the TOOL_MANAGER the tool will belong to.

Called by TOOL_MANAGER::RegisterTool()

Definition at line 60 of file tool_base.cpp.

{
 m_toolMgr = aManager;
}

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

board()

BOARD * PCB_VIEWER_TOOLS::board ( ) const

inlineprotected

Definition at line 108 of file pcb_viewer_tools.h.

 {
 return getModel<BOARD>();
 }

Referenced by footprint(), GraphicOutlines(), PadDisplayMode(), ShowPadNumbers(), and TextOutlines().

canvas()

PCB_DRAW_PANEL_GAL * PCB_VIEWER_TOOLS::canvas ( ) const

inlineprotected

Definition at line 103 of file pcb_viewer_tools.h.

 {
 return static_cast<PCB_DRAW_PANEL_GAL*>( frame()->GetCanvas() );
 }

References frame(), and PCB_BASE_FRAME::GetCanvas().

Referenced by GraphicOutlines(), MeasureTool(), PadDisplayMode(), ShowPadNumbers(), and TextOutlines().

displayOptions()

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

inlineprotected

Definition at line 98 of file pcb_viewer_tools.h.

 {
 return frame()->GetPcbNewSettings()->m_Display;
 }

References frame(), PCB_BASE_FRAME::GetPcbNewSettings(), and PCBNEW_SETTINGS::m_Display.

Referenced by MeasureTool().

footprint()

FOOTPRINT * PCB_VIEWER_TOOLS::footprint ( ) const

inlineprotected

Definition at line 113 of file pcb_viewer_tools.h.

 {
 return board()->GetFirstFootprint();
 }

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

frame()

PCB_BASE_FRAME * PCB_VIEWER_TOOLS::frame ( ) const

inlineprotected

Definition at line 88 of file pcb_viewer_tools.h.

 {
 return getEditFrame<PCB_BASE_FRAME>();
 }

Referenced by canvas(), displayOptions(), GraphicOutlines(), Init(), MeasureTool(), PadDisplayMode(), Show3DViewer(), ShowPadNumbers(), and TextOutlines().

getEditFrame()

template<typename T >

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 185 of file tool_base.h.

 {
#if !defined( QA_TEST ) // Dynamic casts give the linker a seizure in the test framework
 wxASSERT( dynamic_cast<T*>( getToolHolderInt() ) );
#endif
 return static_cast<T*>( getToolHolderInt() );
 }

References TOOL_BASE::getToolHolderInt().

Referenced by ZONE_CREATE_HELPER::createNewZone(), 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 121 of file tool_base.h.

 {
 return m_toolId;
 }

References TOOL_BASE::m_toolId.

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

GetManager()

TOOL_MANAGER * TOOL_BASE::GetManager ( ) const

inlineinherited

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

Returns

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

Definition at line 144 of file tool_base.h.

 {
 return m_toolMgr;
 }

References TOOL_BASE::m_toolMgr.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), PNS_KICAD_IFACE::DisplayItem(), PCB_TOOL_BASE::doInteractiveItemPlacement(), ACTION_MENU::getToolManager(), PNS_KICAD_IFACE::GetUnits(), ZONE_CREATE_HELPER::OnFirstPoint(), ACTION_MENU::OnMenuEvent(), and ZONE_CREATE_HELPER::performZoneCutout().

getModel()

template<typename T >

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Store the type of the tool.

Definition at line 197 of file tool_base.h.

References TOOL_BASE::getModelInt().

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

getModelInt()

EDA_ITEM * TOOL_BASE::getModelInt ( ) const

privateinherited

Definition at line 54 of file tool_base.cpp.

{
 return m_toolMgr->GetModel();
}

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

Referenced by TOOL_BASE::getModel().

GetName()

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

inlineinherited

Return the name of the tool.

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

Returns

The name of the tool.

Definition at line 134 of file tool_base.h.

 {
 return m_toolName;
 }

References TOOL_BASE::m_toolName.

Referenced by TOOL_MANAGER::dispatchInternal(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::invokeTool(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::runTool(), and TOOL_MANAGER::ShutdownTool().

getToolHolderInt()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInt ( ) const

privateinherited

Definition at line 48 of file tool_base.cpp.

{
 return m_toolMgr->GetToolHolder();
}

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

Referenced by TOOL_BASE::getEditFrame().

GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inlineinherited

Definition at line 77 of file tool_interactive.h.

{ return m_menu; }

References TOOL_INTERACTIVE::m_menu.

Referenced by EE_INSPECTION_TOOL::Init(), EE_POINT_EDITOR::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_MOVE_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), CONVERT_TOOL::Init(), EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_POINT_EDITOR::Init(), and ALIGN_DISTRIBUTE_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 109 of file tool_base.h.

 {
 return m_type;
 }

References TOOL_BASE::m_type.

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

getView()

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

protectedinherited

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

It allows tools to draw.

Returns

The instance of VIEW.

Definition at line 36 of file tool_base.cpp.

{
 return m_toolMgr->GetView();
}

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

Referenced by EE_POINT_EDITOR::addCornerCondition(), ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), COMMON_TOOLS::CenterContents(), SCH_EDIT_TOOL::ChangeTextType(), EE_INSPECTION_TOOL::CheckSymbol(), GERBVIEW_CONTROL::ClearAllLayers(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::CollectHits(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), COMMON_TOOLS::CursorControl(), SCH_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::DeleteItems(), PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), 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(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), EE_SELECTION_TOOL::GetNode(), ROUTER_TOOL::getStartLayer(), PCB_CONTROL::GridResetOrigin(), PCB_CONTROL::GridSetOrigin(), EE_SELECTION_TOOL::GuessSelectionCandidates(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), ROUTER_TOOL::handleCommonEvents(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineDrag(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), 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(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), EE_SELECTION_TOOL::Reset(), EE_TOOL_BASE< T >::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PNS::TOOL_BASE::Reset(), BOARD_EDITOR_CONTROL::Reset(), DRAWING_TOOL::Reset(), PCB_CONTROL::Reset(), PCB_SELECTION_TOOL::Reset(), SCH_EDIT_TOOL::Rotate(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), EE_SELECTION_TOOL::selectPoint(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCExclusions(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), SCH_EDITOR_CONTROL::ToggleOPCurrents(), SCH_EDITOR_CONTROL::ToggleOPVoltages(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), GERBVIEW_SELECTION_TOOL::unselectVisually(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), SCH_FIND_REPLACE_TOOL::UpdateFind(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< T >::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), PCB_SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_SELECTION_TOOL::view(), PCB_TOOL_BASE::view(), view(), EE_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::zoomFitSelection(), EE_SELECTION_TOOL::~EE_SELECTION_TOOL(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), and PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL().

getViewControls()

KIGFX::VIEW_CONTROLS * TOOL_BASE::getViewControls ( ) const

protectedinherited

Return the instance of VIEW_CONTROLS object used in the application.

It allows tools to read & modify user input and its settings (eg. show cursor, enable snapping to grid, etc.).

Returns

The instance of VIEW_CONTROLS.

Definition at line 42 of file tool_base.cpp.

{
 return m_toolMgr->GetViewControls();
}

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

Referenced by EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), PCB_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), EDIT_TOOL::copyToClipboard(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EDIT_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), LENGTH_TUNER_TOOL::performTuning(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDIT_TOOL::RepeatDrawItem(), PL_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), PCB_SELECTION_TOOL::selectCursor(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectNode(), ZOOM_TOOL::selectRegion(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), PCB_PICKER_TOOL::setControls(), EE_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), PCB_POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateItem(), PL_EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

Go()

template<class T >

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

inherited

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

No conditions means any event.

Definition at line 147 of file tool_interactive.h.

{
 TOOL_STATE_FUNC sptr = std::bind( aStateFunc, static_cast<T*>( this ), std::placeholders::_1 );
 
 goInternal( sptr, aConditions );
}

References TOOL_INTERACTIVE::goInternal().

Referenced by EDA_3D_CONTROLLER::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), EE_INSPECTION_TOOL::setTransitions(), EE_POINT_EDITOR::setTransitions(), EE_SELECTION_TOOL::setTransitions(), SCH_DRAWING_TOOLS::setTransitions(), SCH_EDIT_TOOL::setTransitions(), SCH_EDITOR_CONTROL::setTransitions(), SCH_FIND_REPLACE_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::setTransitions(), SCH_MOVE_TOOL::setTransitions(), SCH_NAVIGATE_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(), PICKER_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(), PL_SELECTION_TOOL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), MICROWAVE_TOOL::setTransitions(), SCRIPTING_TOOL::setTransitions(), LENGTH_TUNER_TOOL::setTransitions(), ROUTER_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_EDITOR_CONTROL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), GROUP_TOOL::setTransitions(), PAD_TOOL::setTransitions(), PCB_CONTROL::setTransitions(), PCB_PICKER_TOOL::setTransitions(), PCB_POINT_EDITOR::setTransitions(), PCB_SELECTION_TOOL::setTransitions(), setTransitions(), ALIGN_DISTRIBUTE_TOOL::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), PROPERTIES_TOOL::setTransitions(), and ZONE_FILLER_TOOL::setTransitions().

goInternal()

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

privateinherited

Definition at line 70 of file tool_interactive.cpp.

{
 m_toolMgr->ScheduleNextState( this, aState, aConditions );
}

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

Referenced by TOOL_INTERACTIVE::Go().

GraphicOutlines()

int PCB_VIEWER_TOOLS::GraphicOutlines

(

const TOOL_EVENT &

aEvent

)

Definition at line 123 of file pcb_viewer_tools.cpp.

{
 PCB_VIEWERS_SETTINGS_BASE* cfg = frame()->GetViewerSettingsBase();
 Flip( cfg->m_ViewersDisplay.m_DisplayGraphicsFill );
 
 for( FOOTPRINT* fp : board()->Footprints() )
 {
 for( BOARD_ITEM* item : fp->GraphicalItems() )
 {
 KICAD_T t = item->Type();
 
 if( t == PCB_FP_SHAPE_T || BaseType( t ) == PCB_DIMENSION_T )
 view()->Update( item, KIGFX::REPAINT );
 }
 }
 
 for( BOARD_ITEM* item : board()->Drawings() )
 {
 KICAD_T t = item->Type();
 
 if( t == PCB_SHAPE_T || BaseType( t ) == PCB_DIMENSION_T || t == PCB_TARGET_T )
 view()->Update( item, KIGFX::REPAINT );
 }
 
 canvas()->Refresh();
 
 return 0;
}

References BaseType(), board(), canvas(), Flip(), frame(), PCB_BASE_FRAME::GetViewerSettingsBase(), PCB_VIEWERS_SETTINGS_BASE::VIEWERS_DISPLAY_OPTIONS::m_DisplayGraphicsFill, PCB_VIEWERS_SETTINGS_BASE::m_ViewersDisplay, PCB_DIMENSION_T, PCB_FP_SHAPE_T, PCB_SHAPE_T, PCB_TARGET_T, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, KIGFX::PCB_VIEW::Update(), and view().

Referenced by setTransitions().

Init()

bool PCB_VIEWER_TOOLS::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 38 of file pcb_viewer_tools.cpp.

{
 // Populate the context menu displayed during the tool (primarily the measure tool)
 auto activeToolCondition =
 [ this ] ( const SELECTION& aSel )
 {
 return !frame()->ToolStackIsEmpty();
 };
 
 CONDITIONAL_MENU& ctxMenu = m_menu.GetMenu();
 
 // "Cancel" goes at the top of the context menu when a tool is active
 ctxMenu.AddItem( ACTIONS::cancelInteractive, activeToolCondition, 1 );
 ctxMenu.AddSeparator( 1 );
 
 frame()->AddStandardSubMenus( m_menu );
 
 return true;
}

References CONDITIONAL_MENU::AddItem(), CONDITIONAL_MENU::AddSeparator(), EDA_DRAW_FRAME::AddStandardSubMenus(), ACTIONS::cancelInteractive, frame(), TOOL_MENU::GetMenu(), TOOL_INTERACTIVE::m_menu, and TOOLS_HOLDER::ToolStackIsEmpty().

IsFootprintFrame()

bool PCB_VIEWER_TOOLS::IsFootprintFrame ( ) const

inline

Definition at line 82 of file pcb_viewer_tools.h.

 {
 return m_footprintFrame;
 }

References m_footprintFrame.

Referenced by MeasureTool().

IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 31 of file tool_base.cpp.

{
 return m_toolMgr->IsToolActive( m_toolId );
}

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

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

MeasureTool()

int PCB_VIEWER_TOOLS::MeasureTool

(

const TOOL_EVENT &

aEvent

)

Definition at line 187 of file pcb_viewer_tools.cpp.

{
 if( IsFootprintFrame() && !frame()->GetModel() )
 return 0;
 
 if( frame()->IsCurrentTool( ACTIONS::measureTool ) )
 return 0;
 
 auto& view = *getView();
 auto& controls = *getViewControls();
 
 frame()->PushTool( aEvent );
 
 TWO_POINT_GEOMETRY_MANAGER twoPtMgr;
 PCB_GRID_HELPER grid( m_toolMgr, frame()->GetMagneticItemsSettings() );
 bool originSet = false;
 EDA_UNITS units = frame()->GetUserUnits();
 KIGFX::PREVIEW::RULER_ITEM ruler( twoPtMgr, pcbIUScale, units,
 displayOptions().m_DisplayInvertXAxis,
 displayOptions().m_DisplayInvertYAxis );
 
 view.Add( &ruler );
 view.SetVisible( &ruler, false );
 
 auto setCursor =
 [&]()
 {
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::MEASURE );
 };
 
 auto cleanup =
 [&] ()
 {
 view.SetVisible( &ruler, false );
 controls.SetAutoPan( false );
 controls.CaptureCursor( false );
 controls.ForceCursorPosition( false );
 originSet = false;
 };
 
 Activate();
 // Must be done after Activate() so that it gets set into the correct context
 controls.ShowCursor( true );
 controls.SetAutoPan( false );
 controls.CaptureCursor( false );
 controls.ForceCursorPosition( false );
 
 // Set initial cursor
 setCursor();
 
 while( TOOL_EVENT* evt = Wait() )
 {
 setCursor();
 grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
 grid.SetUseGrid( view.GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
 const VECTOR2I cursorPos = grid.BestSnapAnchor( controls.GetMousePosition(), nullptr );
 controls.ForceCursorPosition( true, cursorPos );
 
 if( evt->IsCancelInteractive() )
 {
 if( originSet )
 {
 cleanup();
 }
 else
 {
 frame()->PopTool( aEvent );
 break;
 }
 }
 else if( evt->IsActivate() )
 {
 if( originSet )
 cleanup();
 
 if( evt->IsMoveTool() )
 {
 // leave ourselves on the stack so we come back after the move
  break;
 }
 else
 {
 frame()->PopTool( aEvent );
 break;
 }
 }
 // click or drag starts
 else if( !originSet && ( evt->IsDrag( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) ) )
 {
 twoPtMgr.SetOrigin( cursorPos );
 twoPtMgr.SetEnd( cursorPos );
 
 controls.CaptureCursor( true );
 controls.SetAutoPan( true );
 
 originSet = true;
 }
 // second click or mouse up after drag ends
 else if( originSet && ( evt->IsClick( BUT_LEFT ) || evt->IsMouseUp( BUT_LEFT ) ) )
 {
 originSet = false;
 
 controls.SetAutoPan( false );
 controls.CaptureCursor( false );
 }
 // move or drag when origin set updates rules
 else if( originSet && ( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) ) )
 {
 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 bool force45Deg;
 
 if( frame()->IsType( FRAME_PCB_EDITOR ) )
 force45Deg = mgr.GetAppSettings<PCBNEW_SETTINGS>()->m_Use45DegreeLimit;
 else
 force45Deg = mgr.GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>()->m_Use45Limit;
 
 twoPtMgr.SetAngleSnap( force45Deg );
 twoPtMgr.SetEnd( cursorPos );
 
 view.SetVisible( &ruler, true );
 view.Update( &ruler, KIGFX::GEOMETRY );
 }
 else if( evt->IsAction( &ACTIONS::updateUnits ) )
 {
 if( frame()->GetUserUnits() != units )
 {
 units = frame()->GetUserUnits();
 ruler.SwitchUnits( units );
 view.Update( &ruler, KIGFX::GEOMETRY );
 canvas()->Refresh();
 }
 
 evt->SetPassEvent();
 }
 else if( evt->IsAction( &ACTIONS::updatePreferences ) )
 {
 ruler.UpdateDir( displayOptions().m_DisplayInvertXAxis,
 displayOptions().m_DisplayInvertYAxis );
 
 view.Update( &ruler, KIGFX::GEOMETRY );
 canvas()->Refresh();
 evt->SetPassEvent();
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu();
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 
 view.SetVisible( &ruler, false );
 view.Remove( &ruler );
 
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 controls.SetAutoPan( false );
 controls.CaptureCursor( false );
 controls.ForceCursorPosition( false );
 return 0;
}

References TOOL_INTERACTIVE::Activate(), KIGFX::PCB_VIEW::Add(), ARROW, BUT_LEFT, BUT_RIGHT, canvas(), displayOptions(), frame(), FRAME_PCB_EDITOR, KIGFX::GEOMETRY, SETTINGS_MANAGER::GetAppSettings(), PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW::GetGAL(), KIGFX::GAL::GetGridSnapping(), S3D::GetModel(), UNITS_PROVIDER::GetUserUnits(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), grid, IsFootprintFrame(), TOOL_INTERACTIVE::m_menu, TOOL_BASE::m_toolMgr, MD_SHIFT, MEASURE, ACTIONS::measureTool, pcbIUScale, Pgm(), TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::PCB_VIEW::Remove(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::SetAngleSnap(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::SetEnd(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::SetOrigin(), KIGFX::VIEW::SetVisible(), TOOL_MENU::ShowContextMenu(), KIGFX::PREVIEW::RULER_ITEM::SwitchUnits(), KIGFX::PCB_VIEW::Update(), KIGFX::PREVIEW::RULER_ITEM::UpdateDir(), ACTIONS::updatePreferences, ACTIONS::updateUnits, view(), and TOOL_INTERACTIVE::Wait().

Referenced by setTransitions().

PadDisplayMode()

int PCB_VIEWER_TOOLS::PadDisplayMode

(

const TOOL_EVENT &

aEvent

)

Definition at line 106 of file pcb_viewer_tools.cpp.

{
 PCB_VIEWERS_SETTINGS_BASE* cfg = frame()->GetViewerSettingsBase();
 Flip( cfg->m_ViewersDisplay.m_DisplayPadFill );
 
 for( FOOTPRINT* fp : board()->Footprints() )
 {
 for( PAD* pad : fp->Pads() )
 view()->Update( pad, KIGFX::REPAINT );
 }
 
 canvas()->Refresh();
 
 return 0;
}

References board(), canvas(), Flip(), frame(), PCB_BASE_FRAME::GetViewerSettingsBase(), PCB_VIEWERS_SETTINGS_BASE::VIEWERS_DISPLAY_OPTIONS::m_DisplayPadFill, PCB_VIEWERS_SETTINGS_BASE::m_ViewersDisplay, pad, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, KIGFX::PCB_VIEW::Update(), and view().

Referenced by setTransitions().

Reset()

void PCB_VIEWER_TOOLS::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. Launch a tool to measure between points.

Implements TOOL_BASE.

Definition at line 59 of file pcb_viewer_tools.cpp.

{
}

resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

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

Definition at line 63 of file tool_interactive.cpp.

{
 m_toolMgr->ClearTransitions( this );
 setTransitions();
}

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

{
 m_toolMgr->RunMainStack( this, std::move( aFunc ) );
}

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

Referenced by DRAWING_TOOL::PlaceText().

SetContextMenu()

void TOOL_INTERACTIVE::SetContextMenu ( ACTION_MENU *  aMenu, CONTEXT_MENU_TRIGGER  aTrigger = CMENU_BUTTON  )

inherited

Assign a context menu and tells when it should be activated.

Parameters

aMenu	is the menu to be assigned.
aTrigger	determines conditions upon which the context menu is activated.

Definition at line 76 of file tool_interactive.cpp.

{
 if( aMenu )
 aMenu->SetTool( this );
 else
 aTrigger = CMENU_OFF;
 
 m_toolMgr->ScheduleContextMenu( this, aMenu, aTrigger );
}

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

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

SetFootprintFrame()

void PCB_VIEWER_TOOLS::SetFootprintFrame ( bool  aIsFrame )

inline

Toggle edit footprint mode.

When enabled, one may select parts of footprints individually (graphics, pads, etc.), so they can be modified.

Parameters

aEnabled

decides if the mode should be enabled.

Definition at line 77 of file pcb_viewer_tools.h.

 {
 m_footprintFrame = aIsFrame;
 }

References m_footprintFrame.

setTransitions()

void PCB_VIEWER_TOOLS::setTransitions ( )

overridevirtual

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 351 of file pcb_viewer_tools.cpp.

{
 Go( &PCB_VIEWER_TOOLS::Show3DViewer, ACTIONS::show3DViewer.MakeEvent() );
 
 // Display modes
 Go( &PCB_VIEWER_TOOLS::ShowPadNumbers, PCB_ACTIONS::showPadNumbers.MakeEvent() );
 Go( &PCB_VIEWER_TOOLS::PadDisplayMode, PCB_ACTIONS::padDisplayMode.MakeEvent() );
 Go( &PCB_VIEWER_TOOLS::GraphicOutlines, PCB_ACTIONS::graphicsOutlines.MakeEvent() );
 Go( &PCB_VIEWER_TOOLS::TextOutlines, PCB_ACTIONS::textOutlines.MakeEvent() );
 
 Go( &PCB_VIEWER_TOOLS::MeasureTool, ACTIONS::measureTool.MakeEvent() );
}

References TOOL_INTERACTIVE::Go(), GraphicOutlines(), PCB_ACTIONS::graphicsOutlines, ACTIONS::measureTool, MeasureTool(), PCB_ACTIONS::padDisplayMode, PadDisplayMode(), ACTIONS::show3DViewer, Show3DViewer(), PCB_ACTIONS::showPadNumbers, ShowPadNumbers(), PCB_ACTIONS::textOutlines, and TextOutlines().

Show3DViewer()

int PCB_VIEWER_TOOLS::Show3DViewer

(

const TOOL_EVENT &

aEvent

)

Show the 3D viewer.

Set up handlers for various events.

Definition at line 64 of file pcb_viewer_tools.cpp.

{
 EDA_3D_VIEWER_FRAME* draw3DFrame = frame()->CreateAndShow3D_Frame();
 
 if( frame()->IsType( FRAME_FOOTPRINT_VIEWER )
 || frame()->IsType( FRAME_FOOTPRINT_VIEWER_MODAL )
 || frame()->IsType( FRAME_FOOTPRINT_WIZARD ) )
 {
 // A stronger version of Raise() which promotes the window to its parent's level.
 KIPLATFORM::UI::ReparentQuasiModal( draw3DFrame );
 }
 
 // And load or update the current board
 frame()->Update3DView( true, true );
 
 return 0;
}

References PCB_BASE_FRAME::CreateAndShow3D_Frame(), frame(), FRAME_FOOTPRINT_VIEWER, FRAME_FOOTPRINT_VIEWER_MODAL, FRAME_FOOTPRINT_WIZARD, KIPLATFORM::UI::ReparentQuasiModal(), and PCB_BASE_FRAME::Update3DView().

Referenced by setTransitions().

ShowPadNumbers()

int PCB_VIEWER_TOOLS::ShowPadNumbers

(

const TOOL_EVENT &

aEvent

)

Definition at line 89 of file pcb_viewer_tools.cpp.

{
 PCB_VIEWERS_SETTINGS_BASE* cfg = frame()->GetViewerSettingsBase();
 Flip( cfg->m_ViewersDisplay.m_DisplayPadNumbers );
 
 for( FOOTPRINT* fp : board()->Footprints() )
 {
 for( PAD* pad : fp->Pads() )
 view()->Update( pad, KIGFX::REPAINT );
 }
 
 canvas()->Refresh();
 
 return 0;
}

References board(), canvas(), Flip(), frame(), PCB_BASE_FRAME::GetViewerSettingsBase(), PCB_VIEWERS_SETTINGS_BASE::VIEWERS_DISPLAY_OPTIONS::m_DisplayPadNumbers, PCB_VIEWERS_SETTINGS_BASE::m_ViewersDisplay, pad, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, KIGFX::PCB_VIEW::Update(), and view().

Referenced by setTransitions().

TextOutlines()

int PCB_VIEWER_TOOLS::TextOutlines

(

const TOOL_EVENT &

aEvent

)

Definition at line 153 of file pcb_viewer_tools.cpp.

{
 PCB_VIEWERS_SETTINGS_BASE* cfg = frame()->GetViewerSettingsBase();
 Flip( cfg->m_ViewersDisplay.m_DisplayTextFill );
 
 for( FOOTPRINT* fp : board()->Footprints() )
 {
 view()->Update( &fp->Reference(), KIGFX::REPAINT );
 view()->Update( &fp->Value(), KIGFX::REPAINT );
 
 for( BOARD_ITEM* item : fp->GraphicalItems() )
 {
 if( item->Type() == PCB_FP_TEXT_T )
 view()->Update( item, KIGFX::REPAINT );
 }
 }
 
 for( BOARD_ITEM* item : board()->Drawings() )
 {
 KICAD_T t = item->Type();
 
 if( t == PCB_TEXT_T || t == PCB_TEXTBOX_T || BaseType( t ) == PCB_DIMENSION_T )
 view()->Update( item, KIGFX::REPAINT );
 }
 
 canvas()->Refresh();
 
 return 0;
}

References BaseType(), board(), canvas(), Flip(), frame(), PCB_BASE_FRAME::GetViewerSettingsBase(), PCB_VIEWERS_SETTINGS_BASE::VIEWERS_DISPLAY_OPTIONS::m_DisplayTextFill, PCB_VIEWERS_SETTINGS_BASE::m_ViewersDisplay, PCB_DIMENSION_T, PCB_FP_TEXT_T, PCB_TEXT_T, PCB_TEXTBOX_T, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, KIGFX::PCB_VIEW::Update(), and view().

Referenced by setTransitions().

view()

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

inlineprotected

Definition at line 93 of file pcb_viewer_tools.h.

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

References TOOL_BASE::getView().

Referenced by GraphicOutlines(), MeasureTool(), PadDisplayMode(), ShowPadNumbers(), and TextOutlines().

Wait()

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

inherited

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

No parameters means waiting for any event.

Definition at line 57 of file tool_interactive.cpp.

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

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

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ZOOM_TOOL::selectRegion(), 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_footprintFrame

bool PCB_VIEWER_TOOLS::m_footprintFrame

protected

Is this tool associated with a footprint frame.

Definition at line 118 of file pcb_viewer_tools.h.

Referenced by IsFootprintFrame(), and SetFootprintFrame().

m_menu

TOOL_MENU TOOL_INTERACTIVE::m_menu

protectedinherited

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

Definition at line 125 of file tool_interactive.h.

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

m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Name of the tool.

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

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

Referenced by TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), SCH_MOVE_TOOL::AlignElements(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), TOOL_BASE::attachManager(), SCH_EDIT_TOOL::AutoplaceFields(), EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), SCH_EDITOR_CONTROL::ChangeLineMode(), SCH_EDIT_TOOL::ChangeTextType(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), GERBVIEW_CONTROL::ClearAllLayers(), SCH_EDITOR_CONTROL::ClearHighlight(), BOARD_INSPECTION_TOOL::ClearHighlight(), GERBVIEW_SELECTION_TOOL::clearSelection(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), SCH_EDIT_TOOL::ConvertDeMorgan(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), PL_EDIT_TOOL::Copy(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), MICROWAVE_TOOL::createInductorBetween(), EE_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), COMMON_TOOLS::CursorControl(), SCH_EDITOR_CONTROL::Cut(), SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::DeleteItems(), 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(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::doSyncSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), PCB_SELECTION_TOOL::EnterGroup(), GROUP_TOOL::EnterGroup(), SCH_NAVIGATE_TOOL::EnterSheet(), PAD_TOOL::EnumeratePads(), EE_INSPECTION_TOOL::ExcludeMarker(), PCB_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::expandConnection(), PAD_TOOL::explodePad(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), TOOL_BASE::GetManager(), TOOL_BASE::getModelInt(), DRAWING_TOOL::getSourceZoneForAction(), TOOL_BASE::getToolHolderInt(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_INTERACTIVE::goInternal(), PCB_SELECTION_TOOL::grabUnconnected(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), PCB_CONTROL::GridSetOrigin(), GROUP_TOOL::Group(), 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(), EE_TOOL_BASE< T >::Init(), SCH_EDIT_TOOL::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(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), BOARD_REANNOTATE_TOOL::Init(), CONVERT_TOOL::Init(), DRAWING_TOOL::Init(), EDIT_TOOL::Init(), GLOBAL_EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_POINT_EDITOR::Init(), PCB_SELECTION_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), POSITION_RELATIVE_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), TOOL_BASE::IsToolActive(), GROUP_TOOL::LeaveGroup(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), MeasureTool(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), SCH_EDITOR_CONTROL::NextLineMode(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), 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(), GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), 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(), EE_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDITOR_CONTROL::Redo(), SYMBOL_EDITOR_EDIT_TOOL::Redo(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem(), PCB_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), EDA_3D_CONTROLLER::Reset(), COMMON_TOOLS::Reset(), PNS::TOOL_BASE::Reset(), PAD_TOOL::Reset(), COMMON_TOOLS::ResetLocalCoords(), TOOL_INTERACTIVE::resetTransitions(), SCH_EDITOR_CONTROL::Revert(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), TOOL_INTERACTIVE::RunMainStack(), DRC_TOOL::RunTests(), EE_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::SelectConnection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), GERBVIEW_SELECTION_TOOL::SelectItems(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectNet(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE::SetContextMenu(), EDA_3D_CONTROLLER::SetMaterial(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDIT_TOOL::Swap(), EE_SELECTION_TOOL::SyncSelection(), COMMON_TOOLS::ToggleCursor(), COMMON_TOOLS::ToggleCursorStyle(), 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(), GROUP_TOOL::Ungroup(), PCB_SELECTION_TOOL::unrouteSelected(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), EE_POINT_EDITOR::updateParentItem(), PNS::TOOL_BASE::updateStartItem(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), TOOL_INTERACTIVE::Wait(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), and BOARD_EDITOR_CONTROL::ZoneMerge().

m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Definition at line 214 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

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

Definition at line 207 of file tool_base.h.

Referenced by TOOL_BASE::GetType().

---

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

• pcb_viewer_tools.h
• pcb_viewer_tools.cpp