GERBVIEW_CONTROL Class Reference

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

#include <gerbview_control.h>

Inheritance diagram for GERBVIEW_CONTROL:

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

Public Member Functions
	GERBVIEW_CONTROL ()
	~GERBVIEW_CONTROL () override
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state. More...
int	DisplayControl (const TOOL_EVENT &aEvent)
int	LayerNext (const TOOL_EVENT &aEvent)
int	LayerPrev (const TOOL_EVENT &aEvent)
int	MoveLayerUp (const TOOL_EVENT &aEvent)
int	MoveLayerDown (const TOOL_EVENT &aEvent)
int	ClearLayer (const TOOL_EVENT &aEvent)
int	ClearAllLayers (const TOOL_EVENT &aEvent)
int	ReloadAllLayers (const TOOL_EVENT &aEvent)
int	OpenAutodetected (const TOOL_EVENT &aEvent)
int	OpenGerber (const TOOL_EVENT &aEvent)
int	OpenDrillFile (const TOOL_EVENT &aEvent)
int	OpenJobFile (const TOOL_EVENT &aEvent)
int	OpenZipFile (const TOOL_EVENT &aEvent)
int	ToggleLayerManager (const TOOL_EVENT &aEvent)
int	HighlightControl (const TOOL_EVENT &aEvent)
int	ExportToPcbnew (const TOOL_EVENT &aEvent)
int	UpdateMessagePanel (const TOOL_EVENT &aEvent)
int	Print (const TOOL_EVENT &aEvent)
int	LoadZipfile (const TOOL_EVENT &aEvent)
int	LoadGerbFiles (const TOOL_EVENT &aEvent)
	Set up handlers for various events. More...
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events. More...
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...
virtual bool	Init ()
	Init() is called once upon a registration of the tool. 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
EDA_DRAW_PANEL_GAL *	canvas ()
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
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

Private Attributes
GERBVIEW_FRAME *	m_frame

Detailed Description

Handle actions that are shared between different frames in Pcbnew.

Definition at line 33 of file gerbview_control.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

GERBVIEW_CONTROL()

GERBVIEW_CONTROL::GERBVIEW_CONTROL

(

)

Definition at line 43 of file gerbview_control.cpp.

 : TOOL_INTERACTIVE( "gerbview.Control" ), m_frame( nullptr )
{
}

~GERBVIEW_CONTROL()

GERBVIEW_CONTROL::~GERBVIEW_CONTROL ( )

inlineoverride

Definition at line 37 of file gerbview_control.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(), PCB_VIEWER_TOOLS::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().

canvas()

EDA_DRAW_PANEL_GAL * GERBVIEW_CONTROL::canvas ( )

inlineprotected

Definition at line 79 of file gerbview_control.h.

 {
 return m_frame->GetCanvas();
 }

References EDA_DRAW_FRAME::GetCanvas(), and m_frame.

Referenced by ClearAllLayers(), HighlightControl(), LoadZipfile(), OpenJobFile(), and OpenZipFile().

ClearAllLayers()

int GERBVIEW_CONTROL::ClearAllLayers

(

const TOOL_EVENT &

aEvent

)

Definition at line 401 of file gerbview_control.cpp.

{
 m_frame->Clear_DrawLayers( false );
 m_toolMgr->RunAction( ACTIONS::zoomFitScreen, true );
 canvas()->Refresh();
 m_frame->ClearMsgPanel();
 
 // Clear pending highlight selections, now outdated
 KIGFX::GERBVIEW_RENDER_SETTINGS* settings =
 static_cast<KIGFX::GERBVIEW_PAINTER*>( getView()->GetPainter() )->GetSettings();
 settings->ClearHighlightSelections();
 
 return 0;
}

References canvas(), GERBVIEW_FRAME::Clear_DrawLayers(), KIGFX::GERBVIEW_RENDER_SETTINGS::ClearHighlightSelections(), EDA_DRAW_FRAME::ClearMsgPanel(), KIGFX::VIEW::GetPainter(), TOOL_BASE::getView(), m_frame, TOOL_BASE::m_toolMgr, EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), and ACTIONS::zoomFitScreen.

Referenced by setTransitions().

ClearLayer()

int GERBVIEW_CONTROL::ClearLayer

(

const TOOL_EVENT &

aEvent

)

Definition at line 392 of file gerbview_control.cpp.

{
 m_frame->Erase_Current_DrawLayer( true );
 m_frame->ClearMsgPanel();
 
 return 0;
}

References EDA_DRAW_FRAME::ClearMsgPanel(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), and m_frame.

Referenced by setTransitions().

DisplayControl()

int GERBVIEW_CONTROL::DisplayControl

(

const TOOL_EVENT &

aEvent

)

Definition at line 233 of file gerbview_control.cpp.

{
 GERBVIEW_SETTINGS* cfg = m_frame->gvconfig();
 KIGFX::VIEW* view = m_frame->GetCanvas()->GetView();
 
 if( aEvent.IsAction( &GERBVIEW_ACTIONS::linesDisplayOutlines ) )
 {
 cfg->m_Display.m_DisplayLinesFill = !cfg->m_Display.m_DisplayLinesFill;
 
 view->UpdateAllItemsConditionally( KIGFX::REPAINT,
 []( KIGFX::VIEW_ITEM* aItem )
 {
 GERBER_DRAW_ITEM* item = static_cast<GERBER_DRAW_ITEM*>( aItem );
 
 switch( item->m_ShapeType )
 {
 case GBR_CIRCLE:
 case GBR_ARC:
 case GBR_SEGMENT:
 return true;
 
 default:
 return false;
 }
 } );
 }
 else if( aEvent.IsAction( &GERBVIEW_ACTIONS::flashedDisplayOutlines ) )
 {
 cfg->m_Display.m_DisplayFlashedItemsFill = !cfg->m_Display.m_DisplayFlashedItemsFill;
 
 view->UpdateAllItemsConditionally( KIGFX::REPAINT,
 []( KIGFX::VIEW_ITEM* aItem )
 {
 GERBER_DRAW_ITEM* item = static_cast<GERBER_DRAW_ITEM*>( aItem );
 
 switch( item->m_ShapeType )
 {
 case GBR_SPOT_CIRCLE:
 case GBR_SPOT_RECT:
 case GBR_SPOT_OVAL:
 case GBR_SPOT_POLY:
 case GBR_SPOT_MACRO:
 return true;
 
 default:
 return false;
 }
 } );
 }
 else if( aEvent.IsAction( &GERBVIEW_ACTIONS::polygonsDisplayOutlines ) )
 {
 cfg->m_Display.m_DisplayPolygonsFill = !cfg->m_Display.m_DisplayPolygonsFill;
 
 view->UpdateAllItemsConditionally( KIGFX::REPAINT,
 []( KIGFX::VIEW_ITEM* aItem )
 {
 GERBER_DRAW_ITEM* item = static_cast<GERBER_DRAW_ITEM*>( aItem );
 
 return ( item->m_ShapeType == GBR_POLYGON );
 } );
 }
 else if( aEvent.IsAction( &GERBVIEW_ACTIONS::negativeObjectDisplay ) )
 {
 m_frame->SetElementVisibility( LAYER_NEGATIVE_OBJECTS, !cfg->m_Appearance.show_negative_objects );
 }
 else if( aEvent.IsAction( &GERBVIEW_ACTIONS::dcodeDisplay ) )
 {
 m_frame->SetElementVisibility( LAYER_DCODES, !cfg->m_Appearance.show_dcodes );
 }
 else if( aEvent.IsAction( &ACTIONS::highContrastMode )
 || aEvent.IsAction( &ACTIONS::highContrastModeCycle ) )
 {
 cfg->m_Display.m_HighContrastMode = !cfg->m_Display.m_HighContrastMode;
 }
 else if( aEvent.IsAction( &GERBVIEW_ACTIONS::toggleDiffMode ) )
 {
 cfg->m_Display.m_DiffMode = !cfg->m_Display.m_DiffMode;
 
 if( cfg->m_Display.m_DiffMode && cfg->m_Display.m_XORMode )
 cfg->m_Display.m_XORMode = false;
 
 m_frame->UpdateXORLayers();
 }
 else if( aEvent.IsAction( &GERBVIEW_ACTIONS::toggleXORMode ) )
 {
 cfg->m_Display.m_XORMode = !cfg->m_Display.m_XORMode;
 
 if( cfg->m_Display.m_XORMode && cfg->m_Display.m_DiffMode )
 cfg->m_Display.m_DiffMode = false;
 
 m_frame->UpdateXORLayers();
 }
 else if( aEvent.IsAction( &GERBVIEW_ACTIONS::flipGerberView ) )
 {
 cfg->m_Display.m_FlipGerberView = !cfg->m_Display.m_FlipGerberView;
 view->SetMirror( cfg->m_Display.m_FlipGerberView, false );
 }
 
 m_frame->ApplyDisplaySettingsToGAL();
 
 view->UpdateAllItems( KIGFX::COLOR );
 m_frame->GetCanvas()->Refresh();
 
 return 0;
}

References GERBVIEW_FRAME::ApplyDisplaySettingsToGAL(), KIGFX::COLOR, GERBVIEW_ACTIONS::dcodeDisplay, GERBVIEW_ACTIONS::flashedDisplayOutlines, GERBVIEW_ACTIONS::flipGerberView, GBR_ARC, GBR_CIRCLE, GBR_POLYGON, GBR_SEGMENT, GBR_SPOT_CIRCLE, GBR_SPOT_MACRO, GBR_SPOT_OVAL, GBR_SPOT_POLY, GBR_SPOT_RECT, EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), GERBVIEW_FRAME::gvconfig(), ACTIONS::highContrastMode, ACTIONS::highContrastModeCycle, TOOL_EVENT::IsAction(), LAYER_DCODES, LAYER_NEGATIVE_OBJECTS, GERBVIEW_ACTIONS::linesDisplayOutlines, GERBVIEW_SETTINGS::m_Appearance, GBR_DISPLAY_OPTIONS::m_DiffMode, GERBVIEW_SETTINGS::m_Display, GBR_DISPLAY_OPTIONS::m_DisplayFlashedItemsFill, GBR_DISPLAY_OPTIONS::m_DisplayLinesFill, GBR_DISPLAY_OPTIONS::m_DisplayPolygonsFill, GBR_DISPLAY_OPTIONS::m_FlipGerberView, m_frame, GBR_DISPLAY_OPTIONS::m_HighContrastMode, GERBER_DRAW_ITEM::m_ShapeType, GBR_DISPLAY_OPTIONS::m_XORMode, GERBVIEW_ACTIONS::negativeObjectDisplay, GERBVIEW_ACTIONS::polygonsDisplayOutlines, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, GERBVIEW_FRAME::SetElementVisibility(), KIGFX::VIEW::SetMirror(), GERBVIEW_SETTINGS::APPEARANCE::show_dcodes, GERBVIEW_SETTINGS::APPEARANCE::show_negative_objects, GERBVIEW_ACTIONS::toggleDiffMode, GERBVIEW_ACTIONS::toggleXORMode, KIGFX::VIEW::UpdateAllItems(), KIGFX::VIEW::UpdateAllItemsConditionally(), and GERBVIEW_FRAME::UpdateXORLayers().

Referenced by setTransitions().

ExportToPcbnew()

int GERBVIEW_CONTROL::ExportToPcbnew

(

const TOOL_EVENT &

aEvent

)

Definition at line 104 of file gerbview_control.cpp.

{
 int layercount = 0;
 
 GERBER_FILE_IMAGE_LIST* images = m_frame->GetGerberLayout()->GetImagesList();
 
 // Count the Gerber layers which are actually currently used
 for( int ii = 0; ii < (int) images->ImagesMaxCount(); ++ii )
 {
 if( images->GetGbrImage( ii ) )
 layercount++;
 }
 
 if( layercount == 0 )
 {
 DisplayInfoMessage( m_frame, _( "None of the Gerber layers contain any data" ) );
 return 0;
 }
 
 wxString fileDialogName( NAMELESS_PROJECT + wxT( "." ) + KiCadPcbFileExtension );
 wxString path = m_frame->GetMruPath();
 
 wxFileDialog filedlg( m_frame, _( "Board File Name" ), path, fileDialogName, PcbFileWildcard(),
 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
 if( filedlg.ShowModal() == wxID_CANCEL )
 return 0;
 
 wxFileName fileName = filedlg.GetPath();
 
 /* Install a dialog frame to choose the mapping
 * between gerber layers and Pcbnew layers
 */
 LAYERS_MAP_DIALOG* layerdlg = new LAYERS_MAP_DIALOG( m_frame );
 int ok = layerdlg->ShowModal();
 layerdlg->Destroy();
 
 if( ok != wxID_OK )
 return 0;
 
 // If no extension was entered, then force the extension to be a KiCad PCB file
 if( !fileName.HasExt() )
 fileName.SetExt( KiCadPcbFileExtension );
 
 m_frame->SetMruPath( fileName.GetPath() );
 
 GBR_TO_PCB_EXPORTER gbr_exporter( m_frame, fileName.GetFullPath() );
 
 gbr_exporter.ExportPcb( layerdlg->GetLayersLookUpTable(), layerdlg->GetCopperLayersCount() );
 
 return 0;
}

References _, DisplayInfoMessage(), GBR_TO_PCB_EXPORTER::ExportPcb(), LAYERS_MAP_DIALOG::GetCopperLayersCount(), GERBER_FILE_IMAGE_LIST::GetGbrImage(), GERBVIEW_FRAME::GetGerberLayout(), GBR_LAYOUT::GetImagesList(), LAYERS_MAP_DIALOG::GetLayersLookUpTable(), EDA_BASE_FRAME::GetMruPath(), GERBER_FILE_IMAGE_LIST::ImagesMaxCount(), KiCadPcbFileExtension, m_frame, NAMELESS_PROJECT, path, PcbFileWildcard(), and EDA_BASE_FRAME::SetMruPath().

Referenced by setTransitions().

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(), 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(), 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(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), 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(), PCB_VIEWER_TOOLS::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(), PCB_VIEWER_TOOLS::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(), 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(), PCB_VIEWER_TOOLS::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().

HighlightControl()

int GERBVIEW_CONTROL::HighlightControl

(

const TOOL_EVENT &

aEvent

)

Definition at line 158 of file gerbview_control.cpp.

{
 auto settings = static_cast<KIGFX::GERBVIEW_PAINTER*>( getView()->GetPainter() )->GetSettings();
 const auto& selection = m_toolMgr->GetTool<GERBVIEW_SELECTION_TOOL>()->GetSelection();
 GERBER_DRAW_ITEM* item = nullptr;
 
 if( selection.Size() == 1 )
 {
 item = static_cast<GERBER_DRAW_ITEM*>( selection[0] );
 }
 
 if( aEvent.IsAction( &GERBVIEW_ACTIONS::highlightClear ) )
 {
 m_frame->m_SelComponentBox->SetSelection( 0 );
 m_frame->m_SelNetnameBox->SetSelection( 0 );
 m_frame->m_SelAperAttributesBox->SetSelection( 0 );
 
 settings->ClearHighlightSelections();
 
 GERBER_FILE_IMAGE* gerber = m_frame->GetGbrImage( m_frame->GetActiveLayer() );
 
 if( gerber )
 gerber->m_Selected_Tool = settings->m_dcodeHighlightValue;
 }
 else if( item && aEvent.IsAction( &GERBVIEW_ACTIONS::highlightNet ) )
 {
 wxString net_name = item->GetNetAttributes().m_Netname;
 settings->m_netHighlightString = net_name;
 m_frame->m_SelNetnameBox->SetStringSelection( UnescapeString( net_name ) );
 }
 else if( item && aEvent.IsAction( &GERBVIEW_ACTIONS::highlightComponent ) )
 {
 wxString net_attr = item->GetNetAttributes().m_Cmpref;
 settings->m_componentHighlightString = net_attr;
 m_frame->m_SelComponentBox->SetStringSelection( net_attr );
 }
 else if( item && aEvent.IsAction( &GERBVIEW_ACTIONS::highlightAttribute ) )
 {
 D_CODE* apertDescr = item->GetDcodeDescr();
 
 if( apertDescr )
 {
 wxString ap_name = apertDescr->m_AperFunction;
 settings->m_attributeHighlightString = ap_name;
 m_frame->m_SelAperAttributesBox->SetStringSelection( ap_name );
 }
 }
 else if( item && aEvent.IsAction( &GERBVIEW_ACTIONS::highlightDCode ) )
 {
 D_CODE* apertDescr = item->GetDcodeDescr();
 
 if( apertDescr )
 {
 int dcodeSelected = -1;
 GERBER_FILE_IMAGE* gerber = m_frame->GetGbrImage( m_frame->GetActiveLayer() );
 
 if( gerber )
 dcodeSelected = apertDescr->m_Num_Dcode;
 
 if( dcodeSelected > 0 )
 {
 settings->m_dcodeHighlightValue = dcodeSelected;
 gerber->m_Selected_Tool = dcodeSelected;
 m_frame->syncLayerBox( false );
 }
 }
 }
 
 canvas()->GetView()->UpdateAllItems( KIGFX::COLOR );
 canvas()->Refresh();
 
 return 0;
}

References canvas(), KIGFX::COLOR, GERBVIEW_FRAME::GetActiveLayer(), GERBER_DRAW_ITEM::GetDcodeDescr(), GERBVIEW_FRAME::GetGbrImage(), GERBER_DRAW_ITEM::GetNetAttributes(), KIGFX::VIEW::GetPainter(), TOOL_MANAGER::GetTool(), EDA_DRAW_PANEL_GAL::GetView(), TOOL_BASE::getView(), GERBVIEW_ACTIONS::highlightAttribute, GERBVIEW_ACTIONS::highlightClear, GERBVIEW_ACTIONS::highlightComponent, GERBVIEW_ACTIONS::highlightDCode, GERBVIEW_ACTIONS::highlightNet, TOOL_EVENT::IsAction(), D_CODE::m_AperFunction, GBR_NETLIST_METADATA::m_Cmpref, m_frame, GBR_NETLIST_METADATA::m_Netname, D_CODE::m_Num_Dcode, GERBVIEW_FRAME::m_SelAperAttributesBox, GERBVIEW_FRAME::m_SelComponentBox, GERBER_FILE_IMAGE::m_Selected_Tool, GERBVIEW_FRAME::m_SelNetnameBox, TOOL_BASE::m_toolMgr, EDA_DRAW_PANEL_GAL::Refresh(), GERBVIEW_FRAME::syncLayerBox(), UnescapeString(), and KIGFX::VIEW::UpdateAllItems().

Referenced by setTransitions().

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 EDA_3D_CONTROLLER, CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL, EE_INSPECTION_TOOL, EE_POINT_EDITOR, EE_SELECTION_TOOL, EE_TOOL_BASE< T >, EE_TOOL_BASE< SCH_BASE_FRAME >, EE_TOOL_BASE< SCH_EDIT_FRAME >, EE_TOOL_BASE< SYMBOL_EDIT_FRAME >, SCH_DRAWING_TOOLS, SCH_EDIT_TOOL, SCH_LINE_WIRE_BUS_TOOL, SCH_MOVE_TOOL, SIMULATOR_CONTROL, SYMBOL_EDITOR_CONTROL, SYMBOL_EDITOR_DRAWING_TOOLS, SYMBOL_EDITOR_EDIT_TOOL, SYMBOL_EDITOR_MOVE_TOOL, SYMBOL_EDITOR_PIN_TOOL, GERBVIEW_INSPECTION_TOOL, GERBVIEW_SELECTION_TOOL, PICKER_TOOL, ZOOM_TOOL, PL_DRAWING_TOOLS, PL_EDIT_TOOL, PL_EDITOR_CONTROL, PL_POINT_EDITOR, PL_SELECTION_TOOL, SCRIPTING_TOOL, LENGTH_TUNER_TOOL, ROUTER_TOOL, BOARD_EDITOR_CONTROL, BOARD_INSPECTION_TOOL, BOARD_REANNOTATE_TOOL, CONVERT_TOOL, DRAWING_TOOL, EDIT_TOOL, FOOTPRINT_EDITOR_CONTROL, GLOBAL_EDIT_TOOL, GROUP_TOOL, PAD_TOOL, PCB_POINT_EDITOR, PCB_SELECTION_TOOL, PCB_TOOL_BASE, PCB_VIEWER_TOOLS, ALIGN_DISTRIBUTE_TOOL, and POSITION_RELATIVE_TOOL.

Definition at line 90 of file tool_base.h.

 {
 return true;
 }

Referenced by TOOL_MANAGER::InitTools().

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

LayerNext()

int GERBVIEW_CONTROL::LayerNext

(

const TOOL_EVENT &

aEvent

)

Definition at line 340 of file gerbview_control.cpp.

{
 int layer = m_frame->GetActiveLayer();
 
 if( layer < ( (int) GERBER_FILE_IMAGE_LIST::GetImagesList().GetLoadedImageCount() - 1 ) )
 m_frame->SetActiveLayer( layer + 1, true );
 
 return 0;
}

References GERBVIEW_FRAME::GetActiveLayer(), GERBER_FILE_IMAGE_LIST::GetImagesList(), m_frame, and GERBVIEW_FRAME::SetActiveLayer().

Referenced by setTransitions().

LayerPrev()

int GERBVIEW_CONTROL::LayerPrev

(

const TOOL_EVENT &

aEvent

)

Definition at line 351 of file gerbview_control.cpp.

{
 int layer = m_frame->GetActiveLayer();
 
 if( layer > 0 )
 m_frame->SetActiveLayer( layer - 1, true );
 
 return 0;
}

References GERBVIEW_FRAME::GetActiveLayer(), m_frame, and GERBVIEW_FRAME::SetActiveLayer().

Referenced by setTransitions().

LoadGerbFiles()

int GERBVIEW_CONTROL::LoadGerbFiles

(

const TOOL_EVENT &

aEvent

)

Set up handlers for various events.

Definition at line 485 of file gerbview_control.cpp.

{
 // The event parameter is a string containing names of dropped files.
 // Each file name has been enclosed with "", so file names with space character are allowed.
 wxString files = *aEvent.Parameter<wxString*>();
 // ie : files = "file1""another file""file3"...
 
 std::vector<wxString> aFileNameList;
 
 // Isolate each file name, deletting ""
 files = files.AfterFirst( '"' );
 
 // Gerber files are enclosed with "".
 // Load files names in array.
 while( !files.empty() )
 {
 wxString fileName = files.BeforeFirst( '"' );
 // Check if file exists. If not, keep on and ignore fileName
 if( wxFileName( fileName ).Exists() )
 aFileNameList.push_back( fileName );
 files = files.AfterFirst( '"' );
 files = files.AfterFirst( '"' );
 }
 
 if( !aFileNameList.empty() )
 m_frame->OpenProjectFiles( aFileNameList, KICTL_CREATE );
 
 return 0;
}

References KICTL_CREATE, m_frame, GERBVIEW_FRAME::OpenProjectFiles(), and TOOL_EVENT::Parameter().

Referenced by setTransitions().

LoadZipfile()

int GERBVIEW_CONTROL::LoadZipfile

(

const TOOL_EVENT &

aEvent

)

Definition at line 476 of file gerbview_control.cpp.

{
 m_frame->LoadZipArchiveFile( *aEvent.Parameter<wxString*>() );
 canvas()->Refresh();
 
 return 0;
}

References canvas(), GERBVIEW_FRAME::LoadZipArchiveFile(), m_frame, TOOL_EVENT::Parameter(), and EDA_DRAW_PANEL_GAL::Refresh().

Referenced by setTransitions().

MoveLayerDown()

int GERBVIEW_CONTROL::MoveLayerDown

(

const TOOL_EVENT &

aEvent

)

Definition at line 377 of file gerbview_control.cpp.

{
 int layer = m_frame->GetActiveLayer();
 GERBER_FILE_IMAGE_LIST& list = GERBER_FILE_IMAGE_LIST::GetImagesList();
 
 if( layer < ( (int) list.GetLoadedImageCount() - 1 ) )
 {
 m_frame->RemapLayers( list.SwapImages( layer, layer + 1 ) );
 m_frame->SetActiveLayer( layer + 1 );
 }
 
 return 0;
}

References GERBVIEW_FRAME::GetActiveLayer(), GERBER_FILE_IMAGE_LIST::GetImagesList(), GERBER_FILE_IMAGE_LIST::GetLoadedImageCount(), m_frame, GERBVIEW_FRAME::RemapLayers(), GERBVIEW_FRAME::SetActiveLayer(), and GERBER_FILE_IMAGE_LIST::SwapImages().

Referenced by setTransitions().

MoveLayerUp()

int GERBVIEW_CONTROL::MoveLayerUp

(

const TOOL_EVENT &

aEvent

)

Definition at line 362 of file gerbview_control.cpp.

{
 int layer = m_frame->GetActiveLayer();
 
 if( layer > 0 )
 {
 m_frame->RemapLayers(
 GERBER_FILE_IMAGE_LIST::GetImagesList().SwapImages( layer, layer - 1 ) );
 m_frame->SetActiveLayer( layer - 1 );
 }
 
 return 0;
}

References GERBVIEW_FRAME::GetActiveLayer(), GERBER_FILE_IMAGE_LIST::GetImagesList(), m_frame, GERBVIEW_FRAME::RemapLayers(), and GERBVIEW_FRAME::SetActiveLayer().

Referenced by setTransitions().

OpenAutodetected()

int GERBVIEW_CONTROL::OpenAutodetected

(

const TOOL_EVENT &

aEvent

)

Definition at line 54 of file gerbview_control.cpp.

{
 m_frame->LoadAutodetectedFiles( wxEmptyString );
 
 return 0;
}

References GERBVIEW_FRAME::LoadAutodetectedFiles(), and m_frame.

Referenced by setTransitions().

OpenDrillFile()

int GERBVIEW_CONTROL::OpenDrillFile

(

const TOOL_EVENT &

aEvent

)

Definition at line 70 of file gerbview_control.cpp.

{
 m_frame->LoadExcellonFiles( wxEmptyString );
 
 return 0;
}

References GERBVIEW_FRAME::LoadExcellonFiles(), and m_frame.

Referenced by setTransitions().

OpenGerber()

int GERBVIEW_CONTROL::OpenGerber

(

const TOOL_EVENT &

aEvent

)

Definition at line 62 of file gerbview_control.cpp.

{
 m_frame->LoadGerberFiles( wxEmptyString );
 
 return 0;
}

References GERBVIEW_FRAME::LoadGerberFiles(), and m_frame.

Referenced by setTransitions().

OpenJobFile()

int GERBVIEW_CONTROL::OpenJobFile

(

const TOOL_EVENT &

aEvent

)

Definition at line 78 of file gerbview_control.cpp.

{
 m_frame->LoadGerberJobFile( wxEmptyString );
 canvas()->Refresh();
 
 return 0;
}

References canvas(), GERBVIEW_FRAME::LoadGerberJobFile(), m_frame, and EDA_DRAW_PANEL_GAL::Refresh().

Referenced by setTransitions().

OpenZipFile()

int GERBVIEW_CONTROL::OpenZipFile

(

const TOOL_EVENT &

aEvent

)

Definition at line 87 of file gerbview_control.cpp.

{
 m_frame->LoadZipArchiveFile( wxEmptyString );
 canvas()->Refresh();
 
 return 0;
}

References canvas(), GERBVIEW_FRAME::LoadZipArchiveFile(), m_frame, and EDA_DRAW_PANEL_GAL::Refresh().

Referenced by setTransitions().

Print()

int GERBVIEW_CONTROL::Print

(

const TOOL_EVENT &

aEvent

)

Definition at line 308 of file dialog_print_gerbview.cpp.

{
 // Selection affects the original item visibility
 m_toolMgr->RunAction( GERBVIEW_ACTIONS::selectionClear, true );
 
 BOARD_PRINTOUT_SETTINGS settings( m_frame->GetPageSettings() );
 settings.m_colorSettings = m_frame->GetColorSettings();
 DIALOG_PRINT_GERBVIEW dlg( m_frame, &settings );
 dlg.ForcePrintBorder( false );
 dlg.ShowModal();
 
 return 0;
}

References DIALOG_PRINT_GENERIC::ForcePrintBorder(), GERBVIEW_FRAME::GetColorSettings(), GERBVIEW_FRAME::GetPageSettings(), PRINTOUT_SETTINGS::m_colorSettings, m_frame, TOOL_BASE::m_toolMgr, TOOL_MANAGER::RunAction(), and GERBVIEW_ACTIONS::selectionClear.

Referenced by setTransitions().

ReloadAllLayers()

int GERBVIEW_CONTROL::ReloadAllLayers

(

const TOOL_EVENT &

aEvent

)

Definition at line 417 of file gerbview_control.cpp.

{
 // Store filenames
 wxArrayString listOfGerberFiles;
 std::vector<int> fileType;
 GERBER_FILE_IMAGE_LIST* list = m_frame->GetImagesList();
 
 for( unsigned i = 0; i < list->ImagesMaxCount(); i++ )
 {
 if( list->GetGbrImage( i ) == nullptr )
 continue;
 
 if( !list->GetGbrImage( i )->m_InUse )
 continue;
 
 EXCELLON_IMAGE* drill_file = dynamic_cast<EXCELLON_IMAGE*>( list->GetGbrImage( i ) );
 
 if( drill_file )
 fileType.push_back( 1 );
 else
 fileType.push_back( 0 );
 
 listOfGerberFiles.Add( list->GetGbrImage( i )->m_FileName );
 }
 
 // Clear all layers
 m_frame->Clear_DrawLayers( false );
 m_frame->ClearMsgPanel();
 
 // Load the layers from stored paths
 wxBusyCursor wait;
 m_frame->LoadListOfGerberAndDrillFiles( wxEmptyString, listOfGerberFiles, &fileType );
 
 return 0;
}

References GERBVIEW_FRAME::Clear_DrawLayers(), EDA_DRAW_FRAME::ClearMsgPanel(), fileType(), GERBER_FILE_IMAGE_LIST::GetGbrImage(), GERBVIEW_FRAME::GetImagesList(), GERBER_FILE_IMAGE_LIST::ImagesMaxCount(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), GERBER_FILE_IMAGE::m_FileName, m_frame, and GERBER_FILE_IMAGE::m_InUse.

Referenced by setTransitions().

Reset()

void GERBVIEW_CONTROL::Reset ( RESET_REASON  aReason )

overridevirtual

Bring the tool to a known, initial state.

If the tool claimed anything from the model or the view, it must release it when its reset.

Parameters

aReason

contains information about the reason of tool reset.

Implements TOOL_BASE.

Definition at line 48 of file gerbview_control.cpp.

{
 m_frame = getEditFrame<GERBVIEW_FRAME>();
}

References m_frame.

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

setTransitions()

void GERBVIEW_CONTROL::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 516 of file gerbview_control.cpp.

{
 Go( &GERBVIEW_CONTROL::OpenAutodetected, GERBVIEW_ACTIONS::openAutodetected.MakeEvent() );
 Go( &GERBVIEW_CONTROL::OpenGerber, GERBVIEW_ACTIONS::openGerber.MakeEvent() );
 Go( &GERBVIEW_CONTROL::OpenDrillFile, GERBVIEW_ACTIONS::openDrillFile.MakeEvent() );
 Go( &GERBVIEW_CONTROL::OpenJobFile, GERBVIEW_ACTIONS::openJobFile.MakeEvent() );
 Go( &GERBVIEW_CONTROL::OpenZipFile, GERBVIEW_ACTIONS::openZipFile.MakeEvent() );
 Go( &GERBVIEW_CONTROL::ToggleLayerManager, GERBVIEW_ACTIONS::toggleLayerManager.MakeEvent() );
 Go( &GERBVIEW_CONTROL::ExportToPcbnew, GERBVIEW_ACTIONS::exportToPcbnew.MakeEvent() );
 Go( &GERBVIEW_CONTROL::Print, ACTIONS::print.MakeEvent() );
 
 Go( &GERBVIEW_CONTROL::HighlightControl, GERBVIEW_ACTIONS::highlightClear.MakeEvent() );
 Go( &GERBVIEW_CONTROL::HighlightControl, GERBVIEW_ACTIONS::highlightNet.MakeEvent() );
 Go( &GERBVIEW_CONTROL::HighlightControl, GERBVIEW_ACTIONS::highlightComponent.MakeEvent() );
 Go( &GERBVIEW_CONTROL::HighlightControl, GERBVIEW_ACTIONS::highlightAttribute.MakeEvent() );
 Go( &GERBVIEW_CONTROL::HighlightControl, GERBVIEW_ACTIONS::highlightDCode.MakeEvent() );
 
 Go( &GERBVIEW_CONTROL::LayerNext, GERBVIEW_ACTIONS::layerNext.MakeEvent() );
 Go( &GERBVIEW_CONTROL::LayerPrev, GERBVIEW_ACTIONS::layerPrev.MakeEvent() );
 Go( &GERBVIEW_CONTROL::MoveLayerUp, GERBVIEW_ACTIONS::moveLayerUp.MakeEvent() );
 Go( &GERBVIEW_CONTROL::MoveLayerDown, GERBVIEW_ACTIONS::moveLayerDown.MakeEvent() );
 Go( &GERBVIEW_CONTROL::ClearLayer, GERBVIEW_ACTIONS::clearLayer.MakeEvent() );
 Go( &GERBVIEW_CONTROL::ClearAllLayers, GERBVIEW_ACTIONS::clearAllLayers.MakeEvent() );
 Go( &GERBVIEW_CONTROL::ReloadAllLayers, GERBVIEW_ACTIONS::reloadAllLayers.MakeEvent() );
 
 Go( &GERBVIEW_CONTROL::DisplayControl, GERBVIEW_ACTIONS::linesDisplayOutlines.MakeEvent() );
 Go( &GERBVIEW_CONTROL::DisplayControl, GERBVIEW_ACTIONS::flashedDisplayOutlines.MakeEvent() );
 Go( &GERBVIEW_CONTROL::DisplayControl, GERBVIEW_ACTIONS::polygonsDisplayOutlines.MakeEvent() );
 Go( &GERBVIEW_CONTROL::DisplayControl, GERBVIEW_ACTIONS::negativeObjectDisplay.MakeEvent() );
 Go( &GERBVIEW_CONTROL::DisplayControl, GERBVIEW_ACTIONS::dcodeDisplay.MakeEvent() );
 Go( &GERBVIEW_CONTROL::DisplayControl, ACTIONS::highContrastMode.MakeEvent() );
 Go( &GERBVIEW_CONTROL::DisplayControl, ACTIONS::highContrastModeCycle.MakeEvent() );
 Go( &GERBVIEW_CONTROL::DisplayControl, GERBVIEW_ACTIONS::toggleDiffMode.MakeEvent() );
 Go( &GERBVIEW_CONTROL::DisplayControl, GERBVIEW_ACTIONS::toggleXORMode.MakeEvent() );
 Go( &GERBVIEW_CONTROL::DisplayControl, GERBVIEW_ACTIONS::flipGerberView.MakeEvent() );
 
 Go( &GERBVIEW_CONTROL::UpdateMessagePanel, EVENTS::SelectedEvent );
 Go( &GERBVIEW_CONTROL::UpdateMessagePanel, EVENTS::UnselectedEvent );
 Go( &GERBVIEW_CONTROL::UpdateMessagePanel, EVENTS::ClearedEvent );
 Go( &GERBVIEW_CONTROL::UpdateMessagePanel, ACTIONS::updateUnits.MakeEvent() );
 
 Go( &GERBVIEW_CONTROL::LoadZipfile, GERBVIEW_ACTIONS::loadZipFile.MakeEvent() );
 Go( &GERBVIEW_CONTROL::LoadGerbFiles, GERBVIEW_ACTIONS::loadGerbFiles.MakeEvent() );
}

References GERBVIEW_ACTIONS::clearAllLayers, ClearAllLayers(), EVENTS::ClearedEvent, GERBVIEW_ACTIONS::clearLayer, ClearLayer(), GERBVIEW_ACTIONS::dcodeDisplay, DisplayControl(), GERBVIEW_ACTIONS::exportToPcbnew, ExportToPcbnew(), GERBVIEW_ACTIONS::flashedDisplayOutlines, GERBVIEW_ACTIONS::flipGerberView, TOOL_INTERACTIVE::Go(), ACTIONS::highContrastMode, ACTIONS::highContrastModeCycle, GERBVIEW_ACTIONS::highlightAttribute, GERBVIEW_ACTIONS::highlightClear, GERBVIEW_ACTIONS::highlightComponent, HighlightControl(), GERBVIEW_ACTIONS::highlightDCode, GERBVIEW_ACTIONS::highlightNet, GERBVIEW_ACTIONS::layerNext, LayerNext(), GERBVIEW_ACTIONS::layerPrev, LayerPrev(), GERBVIEW_ACTIONS::linesDisplayOutlines, GERBVIEW_ACTIONS::loadGerbFiles, LoadGerbFiles(), GERBVIEW_ACTIONS::loadZipFile, LoadZipfile(), GERBVIEW_ACTIONS::moveLayerDown, MoveLayerDown(), GERBVIEW_ACTIONS::moveLayerUp, MoveLayerUp(), GERBVIEW_ACTIONS::negativeObjectDisplay, GERBVIEW_ACTIONS::openAutodetected, OpenAutodetected(), GERBVIEW_ACTIONS::openDrillFile, OpenDrillFile(), GERBVIEW_ACTIONS::openGerber, OpenGerber(), GERBVIEW_ACTIONS::openJobFile, OpenJobFile(), GERBVIEW_ACTIONS::openZipFile, OpenZipFile(), GERBVIEW_ACTIONS::polygonsDisplayOutlines, Print(), ACTIONS::print, GERBVIEW_ACTIONS::reloadAllLayers, ReloadAllLayers(), EVENTS::SelectedEvent, GERBVIEW_ACTIONS::toggleDiffMode, GERBVIEW_ACTIONS::toggleLayerManager, ToggleLayerManager(), GERBVIEW_ACTIONS::toggleXORMode, EVENTS::UnselectedEvent, UpdateMessagePanel(), and ACTIONS::updateUnits.

ToggleLayerManager()

int GERBVIEW_CONTROL::ToggleLayerManager

(

const TOOL_EVENT &

aEvent

)

Definition at line 96 of file gerbview_control.cpp.

{
 m_frame->ToggleLayerManager();
 
 return 0;
}

References m_frame, and GERBVIEW_FRAME::ToggleLayerManager().

Referenced by setTransitions().

UpdateMessagePanel()

int GERBVIEW_CONTROL::UpdateMessagePanel

(

const TOOL_EVENT &

aEvent

)

Definition at line 454 of file gerbview_control.cpp.

{
 GERBVIEW_SELECTION_TOOL* selTool = m_toolMgr->GetTool<GERBVIEW_SELECTION_TOOL>();
 GERBVIEW_SELECTION& selection = selTool->GetSelection();
 
 if( selection.GetSize() == 1 )
 {
 EDA_ITEM* item = (EDA_ITEM*) selection.Front();
 
 std::vector<MSG_PANEL_ITEM> msgItems;
 item->GetMsgPanelInfo( m_frame, msgItems );
 m_frame->SetMsgPanel( msgItems );
 }
 else
 {
 m_frame->EraseMsgBox();
 }
 
 return 0;
}

References EDA_DRAW_FRAME::EraseMsgBox(), EDA_ITEM::GetMsgPanelInfo(), GERBVIEW_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), m_frame, TOOL_BASE::m_toolMgr, and EDA_DRAW_FRAME::SetMsgPanel().

Referenced by 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 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(), PCB_VIEWER_TOOLS::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_frame

GERBVIEW_FRAME* GERBVIEW_CONTROL::m_frame

private

Definition at line 85 of file gerbview_control.h.

Referenced by canvas(), ClearAllLayers(), ClearLayer(), DisplayControl(), ExportToPcbnew(), HighlightControl(), LayerNext(), LayerPrev(), LoadGerbFiles(), LoadZipfile(), MoveLayerDown(), MoveLayerUp(), OpenAutodetected(), OpenDrillFile(), OpenGerber(), OpenJobFile(), OpenZipFile(), Print(), ReloadAllLayers(), Reset(), ToggleLayerManager(), and UpdateMessagePanel().

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(), PCB_VIEWER_TOOLS::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(), PCB_VIEWER_TOOLS::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(), 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(), 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(), PCB_VIEWER_TOOLS::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(), 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(), 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:

• gerbview_control.h
• dialog_print_gerbview.cpp
• gerbview_control.cpp