BOARD_INSPECTION_TOOL Class Reference

Tool for pcb inspection. More...

#include <board_inspection_tool.h>

Inheritance diagram for BOARD_INSPECTION_TOOL:

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

Public Member Functions
	BOARD_INSPECTION_TOOL ()
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	ShowBoardStatistics (const TOOL_EVENT &aEvent)
	Show dialog with board statistics. More...
int	HighlightNet (const TOOL_EVENT &aEvent)
	Clear all board highlights. More...
int	ClearHighlight (const TOOL_EVENT &aEvent)
	Perform the appropriate action in response to an Eeschema cross-probe. More...
int	HighlightItem (const TOOL_EVENT &aEvent)
	Update ratsnest for selected items. More...
int	UpdateLocalRatsnest (const TOOL_EVENT &aEvent)
	Hide ratsnest for selected items. Called when there are no items selected. More...
int	HideLocalRatsnest (const TOOL_EVENT &aEvent)
	Show local ratsnest of a component. More...
int	LocalRatsnestTool (const TOOL_EVENT &aEvent)
int	ListNets (const TOOL_EVENT &aEvent)
	Hide the ratsnest for a given net. More...
int	HideNetInRatsnest (const TOOL_EVENT &aEvent)
	Show the ratsnest for a given net. More...
int	ShowNetInRatsnest (const TOOL_EVENT &aEvent)
void	InspectDRCError (const std::shared_ptr< RC_ITEM > &aDRCItem)
	Show the clearance resolution for two selected items. More...
int	InspectClearance (const TOOL_EVENT &aEvent)
int	InspectConstraints (const TOOL_EVENT &aEvent)
bool	IsNetHighlightSet () const
void	SetIsFootprintEditor (bool aEnabled)
	Function SetIsFootprintEditor() More...
bool	IsFootprintEditor () const
void	SetIsBoardEditor (bool aEnabled)
bool	IsBoardEditor () const
virtual bool	Is45Limited () const
	Should the tool use its 45° mode option? 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...
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 Types
enum	INTERACTIVE_PLACEMENT_OPTIONS { IPO_ROTATE = 0x01 , IPO_FLIP = 0x02 , IPO_SINGLE_CLICK = 0x04 , IPO_REPEAT = 0x08 }
	Options for placing items interactively. More...

Protected Member Functions
void	doInteractiveItemPlacement (const TOOL_EVENT &aTool, INTERACTIVE_PLACER_BASE *aPlacer, const wxString &aCommitMessage, int aOptions=IPO_ROTATE|IPO_FLIP|IPO_REPEAT)
	Helper function for performing a common interactive idiom: wait for a left click, place an item there (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc. More...
KIGFX::PCB_VIEW *	view () const
KIGFX::VIEW_CONTROLS *	controls () const
PCB_BASE_EDIT_FRAME *	frame () const
BOARD *	board () const
FOOTPRINT *	footprint () const
PCBNEW_SETTINGS::DISPLAY_OPTIONS &	displayOptions () const
PCB_DRAW_PANEL_GAL *	canvas () const
const PCB_SELECTION &	selection () const
PCB_SELECTION &	selection ()
void	attachManager (TOOL_MANAGER *aManager)
	Set the TOOL_MANAGER the tool will belong to. 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_isFootprintEditor
bool	m_isBoardEditor
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	calculateSelectionRatsnest (const VECTOR2I &aDelta)
	< Recalculate dynamic ratsnest for the current selection. More...
bool	highlightNet (const VECTOR2D &aPosition, bool aUseSelection)
	Look for a BOARD_CONNECTED_ITEM in a given spot and if one is found - it enables highlight for its net. More...
void	doHideRatsnestNet (int aNetCode, bool aHide)
	Bind handlers to corresponding TOOL_ACTIONs. More...
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events. More...
void	onListNetsDialogClosed (wxCommandEvent &aEvent)
void	onInspectClearanceDialogClosed (wxCommandEvent &aEvent)
void	onInspectConstraintsDialogClosed (wxCommandEvent &aEvent)
DRC_ENGINE	makeDRCEngine (bool *aCompileError, bool *aCourtyardError=nullptr)
wxString	getItemDescription (BOARD_ITEM *aItem)
void	reportCompileError (REPORTER *r)
void	reportHeader (const wxString &aTitle, BOARD_ITEM *a, REPORTER *r)
void	reportHeader (const wxString &aTitle, BOARD_ITEM *a, BOARD_ITEM *b, REPORTER *r)
void	reportHeader (const wxString &aTitle, BOARD_ITEM *a, BOARD_ITEM *b, PCB_LAYER_ID aLayer, REPORTER *r)
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
PCB_EDIT_FRAME *	m_frame
std::set< int >	m_currentlyHighlighted
std::set< int >	m_lastHighlighted
CONNECTIVITY_DATA *	m_dynamicData
std::unique_ptr< DIALOG_NET_INSPECTOR >	m_listNetsDialog
DIALOG_NET_INSPECTOR::SETTINGS	m_listNetsDialogSettings
std::unique_ptr< DIALOG_CONSTRAINTS_REPORTER >	m_inspectClearanceDialog
std::unique_ptr< DIALOG_CONSTRAINTS_REPORTER >	m_inspectConstraintsDialog

Detailed Description

Tool for pcb inspection.

Definition at line 42 of file board_inspection_tool.h.

Member Enumeration Documentation

INTERACTIVE_PLACEMENT_OPTIONS

enum PCB_TOOL_BASE::INTERACTIVE_PLACEMENT_OPTIONS

protectedinherited

Options for placing items interactively.

Enumerator
IPO_ROTATE	Handle the rotate action in the loop by calling the item's rotate method.
IPO_FLIP	Handle flip action in the loop by calling the item's flip method.
IPO_SINGLE_CLICK	Create an item immediately on placement starting, otherwise show the pencil cursor until the item is created.
IPO_REPEAT	Allow repeat placement of the item.

Definition at line 121 of file pcb_tool_base.h.

 {
 IPO_ROTATE = 0x01,
 
 IPO_FLIP = 0x02,
 
 IPO_SINGLE_CLICK = 0x04,
 
 IPO_REPEAT = 0x08
 };

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

BOARD_INSPECTION_TOOL()

BOARD_INSPECTION_TOOL::BOARD_INSPECTION_TOOL

(

)

Definition at line 45 of file board_inspection_tool.cpp.

  :
 PCB_TOOL_BASE( "pcbnew.InspectionTool" ),
 m_frame( nullptr )
{
 m_dynamicData = nullptr;
}

References m_dynamicData.

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

board()

BOARD * PCB_TOOL_BASE::board ( ) const

inlineprotectedinherited

Definition at line 170 of file pcb_tool_base.h.

{ return getModel<BOARD>(); }

Referenced by PCB_CONTROL::AppendBoard(), BOARD_EDITOR_CONTROL::AssignNetclass(), AUTOPLACE_TOOL::autoplace(), calculateSelectionRatsnest(), EDIT_TOOL::ChangeTrackWidth(), ZONE_FILLER_TOOL::CheckAllZones(), ClearHighlight(), EDIT_TOOL::copyToClipboard(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), MICROWAVE_TOOL::createInductorBetween(), ROUTER_TOOL::CustomTrackWidthDialog(), PCB_CONTROL::DeleteItemCursor(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportNetlist(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), PCB_TOOL_BASE::footprint(), GROUP_TOOL::Group(), ROUTER_TOOL::handleLayerSwitch(), highlightNet(), ROUTER_TOOL::Init(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_CONTROL::LayerNext(), PCB_CONTROL::LayerPrev(), LocalRatsnestTool(), EDIT_TOOL::MoveExact(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlaceText(), PCB_CONTROL::pruneItemLayers(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), PAD_TOOL::RecombinePad(), BOARD_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_CONTROL::RepairFootprint(), PNS::TOOL_BASE::Reset(), PAD_TOOL::Reset(), PCB_CONTROL::Reset(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::unfilledZoneCheck(), GROUP_TOOL::Ungroup(), ROUTER_TOOL::UpdateMessagePanel(), ROUTER_TOOL::updateSizesAfterLayerSwitch(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillDirty(), BOARD_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

calculateSelectionRatsnest()

void BOARD_INSPECTION_TOOL::calculateSelectionRatsnest ( const VECTOR2I &  aDelta )

private

< Recalculate dynamic ratsnest for the current selection.

Definition at line 1676 of file board_inspection_tool.cpp.

{
 PCB_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 SELECTION& selection = selectionTool->GetSelection();
 std::shared_ptr<CONNECTIVITY_DATA> connectivity = board()->GetConnectivity();
 std::vector<BOARD_ITEM*> items;
 std::deque<EDA_ITEM*> queued_items( selection.begin(), selection.end() );
 
 for( std::size_t i = 0; i < queued_items.size(); ++i )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( queued_items[i] );
 
 if( item->Type() == PCB_FOOTPRINT_T )
 {
 for( PAD* pad : static_cast<FOOTPRINT*>( item )->Pads() )
 {
 if( pad->GetLocalRatsnestVisible() || displayOptions().m_ShowModuleRatsnest )
 items.push_back( pad );
 }
 }
 else if( item->Type() == PCB_GROUP_T )
 {
 PCB_GROUP *group = static_cast<PCB_GROUP*>( item );
 group->RunOnDescendants( [ &queued_items ]( BOARD_ITEM *aItem )
 {
 queued_items.push_back( aItem );
 } );
 }
 else if( BOARD_CONNECTED_ITEM* boardItem = dyn_cast<BOARD_CONNECTED_ITEM*>( item ) )
 {
 if( boardItem->GetLocalRatsnestVisible() || displayOptions().m_ShowModuleRatsnest )
 items.push_back( boardItem );
 }
 }
 
 if( items.empty() || std::none_of( items.begin(), items.end(),
 []( const BOARD_ITEM* aItem )
 {
 return( aItem->Type() == PCB_TRACE_T
 || aItem->Type() == PCB_PAD_T
 || aItem->Type() == PCB_ARC_T
 || aItem->Type() == PCB_ZONE_T
 || aItem->Type() == PCB_FOOTPRINT_T
 || aItem->Type() == PCB_VIA_T );
 } ) )
 {
 return;
 }
 
 if( !m_dynamicData )
 {
 m_dynamicData = new CONNECTIVITY_DATA( items, true );
 connectivity->BlockRatsnestItems( items );
 }
 else
 {
 m_dynamicData->Move( aDelta );
 }
 
 connectivity->ComputeLocalRatsnest( items, m_dynamicData );
}

References SELECTION::begin(), PCB_TOOL_BASE::board(), PCB_TOOL_BASE::displayOptions(), SELECTION::end(), BOARD::GetConnectivity(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), group, m_dynamicData, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_ShowModuleRatsnest, TOOL_BASE::m_toolMgr, CONNECTIVITY_DATA::Move(), pad, FOOTPRINT::Pads(), PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_TOOL_BASE::selection(), and EDA_ITEM::Type().

Referenced by UpdateLocalRatsnest().

canvas()

PCB_DRAW_PANEL_GAL * PCB_TOOL_BASE::canvas ( ) const

protectedinherited

Definition at line 310 of file pcb_tool_base.cpp.

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

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

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), LENGTH_TUNER_TOOL::performTuning(), EDIT_TOOL::pickReferencePoint(), PCB_CONTROL::RatsnestModeCycle(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::refresh(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ZONE_FILLER_TOOL::singleShotRefocus(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), and ZONE_FILLER_TOOL::ZoneFillDirty().

ClearHighlight()

int BOARD_INSPECTION_TOOL::ClearHighlight

(

const TOOL_EVENT &

aEvent

)

Perform the appropriate action in response to an Eeschema cross-probe.

Definition at line 1533 of file board_inspection_tool.cpp.

{
 BOARD* board = static_cast<BOARD*>( m_toolMgr->GetModel() );
 KIGFX::RENDER_SETTINGS* settings = m_toolMgr->GetView()->GetPainter()->GetSettings();
 
 m_currentlyHighlighted.clear();
 m_lastHighlighted.clear();
 
 board->ResetNetHighLight();
 settings->SetHighlight( false );
 m_toolMgr->GetView()->UpdateAllLayersColor();
 m_frame->SetMsgPanel( board );
 m_frame->SendCrossProbeNetName( "" );
 return 0;
}

References PCB_TOOL_BASE::board(), TOOL_MANAGER::GetModel(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), TOOL_MANAGER::GetView(), m_currentlyHighlighted, m_frame, m_lastHighlighted, TOOL_BASE::m_toolMgr, BOARD::ResetNetHighLight(), PCB_EDIT_FRAME::SendCrossProbeNetName(), KIGFX::RENDER_SETTINGS::SetHighlight(), EDA_DRAW_FRAME::SetMsgPanel(), and KIGFX::VIEW::UpdateAllLayersColor().

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

controls()

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

inlineprotectedinherited

Definition at line 160 of file pcb_tool_base.h.

 {
 return getViewControls();
 }

References TOOL_BASE::getViewControls().

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawZone(), ROUTER_TOOL::finishInteractive(), ROUTER_TOOL::handleLayerSwitch(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), BOARD_EDITOR_CONTROL::PlaceFootprint(), ROUTER_TOOL::prepareInteractive(), ROUTER_TOOL::RouteSelected(), PCB_PICKER_TOOL::setControls(), PCB_POINT_EDITOR::setEditedPoint(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

displayOptions()

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

protectedinherited

Definition at line 305 of file pcb_tool_base.cpp.

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

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

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

doHideRatsnestNet()

void BOARD_INSPECTION_TOOL::doHideRatsnestNet ( int  aNetCode, bool  aHide  )

private

Bind handlers to corresponding TOOL_ACTIONs.

Definition at line 1812 of file board_inspection_tool.cpp.

{
 KIGFX::PCB_RENDER_SETTINGS* rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>(
 m_toolMgr->GetView()->GetPainter()->GetSettings() );
 
 PCB_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 SELECTION& selection = selectionTool->GetSelection();
 
 if( aNetCode <= 0 && !selection.Empty() )
 {
 for( EDA_ITEM* item : selection )
 {
 if( BOARD_CONNECTED_ITEM* bci = dynamic_cast<BOARD_CONNECTED_ITEM*>( item ) )
 {
 if( bci->GetNetCode() > 0 )
 doHideRatsnestNet( bci->GetNetCode(), aHide );
 }
 }
 
 return;
 }
 
 if( aHide )
 rs->GetHiddenNets().insert( aNetCode );
 else
 rs->GetHiddenNets().erase( aNetCode );
 
 m_frame->GetCanvas()->RedrawRatsnest();
 m_frame->GetCanvas()->Refresh();
 
 m_frame->GetAppearancePanel()->OnNetVisibilityChanged( aNetCode, !aHide );
}

References doHideRatsnestNet(), SELECTION::Empty(), PCB_BASE_EDIT_FRAME::GetAppearancePanel(), PCB_BASE_FRAME::GetCanvas(), KIGFX::PCB_RENDER_SETTINGS::GetHiddenNets(), KIGFX::VIEW::GetPainter(), PCB_SELECTION_TOOL::GetSelection(), KIGFX::PAINTER::GetSettings(), TOOL_MANAGER::GetTool(), TOOL_MANAGER::GetView(), m_frame, TOOL_BASE::m_toolMgr, APPEARANCE_CONTROLS::OnNetVisibilityChanged(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), EDA_DRAW_PANEL_GAL::Refresh(), and PCB_TOOL_BASE::selection().

Referenced by doHideRatsnestNet(), HideNetInRatsnest(), and ShowNetInRatsnest().

doInteractiveItemPlacement()

void PCB_TOOL_BASE::doInteractiveItemPlacement ( const TOOL_EVENT &  aTool, INTERACTIVE_PLACER_BASE *  aPlacer, const wxString &  aCommitMessage, int  aOptions = IPO_ROTATE | IPO_FLIP | IPO_REPEAT  )

protectedinherited

Helper function for performing a common interactive idiom: wait for a left click, place an item there (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc.

More complex interactive processes are not supported here, you should implement a customised event loop for those.

Parameters

aItemCreator	the callable that will attempt to create the item
aCommitMessage	the message used on a successful commit

Definition at line 41 of file pcb_tool_base.cpp.

{
 using namespace std::placeholders;
 std::unique_ptr<BOARD_ITEM> newItem;
 
 frame()->PushTool( aTool );
 
 BOARD_COMMIT commit( frame() );
 
 GetManager()->RunAction( PCB_ACTIONS::selectionClear, true );
 
 Activate();
 // Must be done after Activate() so that it gets set into the correct context
 controls()->ShowCursor( true );
 controls()->ForceCursorPosition( false );
 // do not capture or auto-pan until we start placing an item
 
 PCB_GRID_HELPER grid( m_toolMgr, frame()->GetMagneticItemsSettings() );
 
 // Add a VIEW_GROUP that serves as a preview for the new item
 PCB_SELECTION preview;
 view()->Add( &preview );
 
 aPlacer->m_board = board();
 aPlacer->m_frame = frame();
 aPlacer->m_modifiers = 0;
 
 auto makeNewItem =
 [&]( VECTOR2I aPosition )
 {
 if( frame()->GetModel() )
 newItem = aPlacer->CreateItem();
 
 if( newItem )
 {
 newItem->SetPosition( aPosition );
 preview.Add( newItem.get() );
 
 if( newItem->Type() == PCB_FOOTPRINT_T )
 {
 FOOTPRINT* fp = dyn_cast<FOOTPRINT*>( newItem.get() );
 
 // footprints have more drawable parts
 fp->RunOnChildren( std::bind( &KIGFX::VIEW_GROUP::Add, &preview, _1 ) );
 }
 }
 };
 
 if( aOptions & IPO_SINGLE_CLICK )
 makeNewItem( controls()->GetCursorPosition() );
 
 auto setCursor =
 [&]()
 {
 if( !newItem )
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
 else
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::PLACE );
 };
 
 // Set initial cursor
 setCursor();
 
 // Main loop: keep receiving events
 while( TOOL_EVENT* evt = Wait() )
 {
 setCursor();
 
 grid.SetSnap( false ); // Interactive placement tools need to set their own item snaps
 grid.SetUseGrid( getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
 VECTOR2I cursorPos = grid.BestSnapAnchor( controls()->GetMousePosition(), nullptr );
 
 aPlacer->m_modifiers = evt->Modifier();
 
 auto cleanup =
 [&] ()
 {
 newItem = nullptr;
 preview.Clear();
 view()->Update( &preview );
 controls()->SetAutoPan( false );
 controls()->CaptureCursor( false );
 controls()->ShowCursor( true );
 controls()->ForceCursorPosition( false );
 };
 
 if( evt->IsCancelInteractive() )
 {
 if( aOptions & IPO_SINGLE_CLICK )
 {
 cleanup();
 frame()->PopTool( aTool );
 break;
 }
 else if( newItem )
 {
 cleanup();
 }
 else
 {
 frame()->PopTool( aTool );
 break;
 }
 }
 else if( evt->IsActivate() )
 {
 if( newItem )
 cleanup();
 
 if( evt->IsPointEditor() )
 {
 // don't exit (the point editor runs in the background)
 }
 else if( evt->IsMoveTool() )
 {
 // leave ourselves on the stack so we come back after the move
 break;
 }
 else
 {
 frame()->PopTool( aTool );
 break;
 }
 }
 else if( evt->IsClick( BUT_LEFT ) || evt->IsDblClick( BUT_LEFT ) )
 {
 if( !newItem )
 {
 // create the item if possible
 makeNewItem( cursorPos );
 
 // no item created, so wait for another click
 if( !newItem )
 continue;
 
 controls()->CaptureCursor( true );
 controls()->SetAutoPan( true );
 }
 else
 {
 BOARD_ITEM* newBoardItem = newItem.release();
 EDA_ITEM_FLAGS oldFlags = newBoardItem->GetFlags();
 
 newBoardItem->ClearFlags();
 
 if( !aPlacer->PlaceItem( newBoardItem, commit ) )
 {
 newBoardItem->SetFlags( oldFlags );
 newItem.reset( newBoardItem );
 continue;
 }
 
 preview.Clear();
 commit.Push( aCommitMessage );
 
 controls()->CaptureCursor( false );
 controls()->SetAutoPan( false );
 controls()->ShowCursor( true );
 
 if( !( aOptions & IPO_REPEAT ) )
 break;
 
 if( aOptions & IPO_SINGLE_CLICK )
 makeNewItem( controls()->GetCursorPosition() );
 
 setCursor();
 }
 }
 else if( evt->IsClick( BUT_RIGHT ) )
 {
 m_menu.ShowContextMenu( selection() );
 }
 else if( evt->IsAction( &PCB_ACTIONS::trackViaSizeChanged ) )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else if( newItem && evt->Category() == TC_COMMAND )
 {
 /*
 * Handle any events that can affect the item as we move it around
 */
 if( TOOL_EVT_UTILS::IsRotateToolEvt( *evt ) && ( aOptions & IPO_ROTATE ) )
 {
 EDA_ANGLE rotationAngle = TOOL_EVT_UTILS::GetEventRotationAngle( *frame(), *evt );
 newItem->Rotate( newItem->GetPosition(), rotationAngle );
 view()->Update( &preview );
 }
 else if( evt->IsAction( &PCB_ACTIONS::flip ) && ( aOptions & IPO_FLIP ) )
 {
 newItem->Flip( newItem->GetPosition(), frame()->GetPcbNewSettings()->m_FlipLeftRight );
 view()->Update( &preview );
 }
 else if( evt->IsAction( &PCB_ACTIONS::properties ) )
 {
 frame()->OnEditItemRequest( newItem.get() );
 
 // Notify other tools of the changes
 m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 }
 else if( evt->IsAction( &ACTIONS::refreshPreview ) )
 {
 preview.Clear();
 newItem.reset();
 
 makeNewItem( cursorPos );
 aPlacer->SnapItem( newItem.get() );
 view()->Update( &preview );
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 else if( newItem && evt->IsMotion() )
 {
 // track the cursor
 newItem->SetPosition( cursorPos );
 aPlacer->SnapItem( newItem.get() );
 
 // Show a preview of the item
 view()->Update( &preview );
 }
 else
 {
 evt->SetPassEvent();
 }
 }
 
 view()->Remove( &preview );
 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 controls()->SetAutoPan( false );
 controls()->CaptureCursor( false );
 controls()->ForceCursorPosition( false );
}

References TOOL_INTERACTIVE::Activate(), SELECTION::Add(), KIGFX::VIEW_GROUP::Add(), KIGFX::PCB_VIEW::Add(), ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), EDA_ITEM::ClearFlags(), PCB_TOOL_BASE::controls(), INTERACTIVE_PLACER_BASE::CreateItem(), PCB_ACTIONS::flip, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), TOOL_EVT_UTILS::GetEventRotationAngle(), EDA_ITEM::GetFlags(), TOOL_BASE::GetManager(), PCB_BASE_FRAME::GetModel(), TOOL_BASE::getView(), grid, PCB_TOOL_BASE::IPO_FLIP, PCB_TOOL_BASE::IPO_REPEAT, PCB_TOOL_BASE::IPO_ROTATE, PCB_TOOL_BASE::IPO_SINGLE_CLICK, TOOL_EVT_UTILS::IsRotateToolEvt(), INTERACTIVE_PLACER_BASE::m_board, INTERACTIVE_PLACER_BASE::m_frame, TOOL_INTERACTIVE::m_menu, INTERACTIVE_PLACER_BASE::m_modifiers, TOOL_BASE::m_toolMgr, PCB_BASE_EDIT_FRAME::OnEditItemRequest(), PCB_FOOTPRINT_T, PENCIL, PLACE, INTERACTIVE_PLACER_BASE::PlaceItem(), TOOLS_HOLDER::PopTool(), TOOL_MANAGER::ProcessEvent(), PCB_ACTIONS::properties, BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), ACTIONS::refreshPreview, KIGFX::PCB_VIEW::Remove(), TOOL_MANAGER::RunAction(), FOOTPRINT::RunOnChildren(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), EDA_ITEM::SetFlags(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), INTERACTIVE_PLACER_BASE::SnapItem(), TC_COMMAND, PCB_ACTIONS::trackViaSizeChanged, KIGFX::PCB_VIEW::Update(), PCB_TOOL_BASE::view(), and TOOL_INTERACTIVE::Wait().

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

footprint()

FOOTPRINT * PCB_TOOL_BASE::footprint ( ) const

inlineprotectedinherited

Definition at line 172 of file pcb_tool_base.h.

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

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

Referenced by PCB_CONTROL::AppendBoard(), MICROWAVE_TOOL::createBaseFootprint(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawSpecificationStackup(), DRAWING_TOOL::DrawVia(), FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), BOARD_EDITOR_CONTROL::ExportNetlist(), ROUTER_TOOL::InlineDrag(), makeDRCEngine(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), FOOTPRINT_EDITOR_CONTROL::Properties(), PAD_TOOL::pushPadSettings(), PAD_TOOL::RecombinePad(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), BOARD_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_CONTROL::RepairFootprint(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), and DRAWING_TOOL::SetAnchor().

frame()

PCB_BASE_EDIT_FRAME * PCB_TOOL_BASE::frame ( ) const

inlineprotectedinherited

Definition at line 165 of file pcb_tool_base.h.

 {
 return getEditFrame<PCB_BASE_EDIT_FRAME>();
 }

Referenced by PCB_POINT_EDITOR::addCorner(), AUTOPLACE_TOOL::autoplace(), PCB_TOOL_BASE::canvas(), ZONE_FILLER_TOOL::CheckAllZones(), PNS::TOOL_BASE::checkSnap(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), ROUTER_TOOL::CustomTrackWidthDialog(), FOOTPRINT_EDITOR_CONTROL::DeleteFootprint(), EDIT_TOOL::DeleteItems(), PCB_TOOL_BASE::displayOptions(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::DpDimensionsDialog(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), ROUTER_TOOL::finishInteractive(), EDIT_TOOL::Flip(), PCB_CONTROL::FlipPcbView(), GLOBAL_EDIT_TOOL::GlobalDeletions(), ROUTER_TOOL::handleLayerSwitch(), PCB_CONTROL::HighContrastMode(), PCB_CONTROL::HighContrastModeCycle(), HighlightItem(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), SCRIPTING_TOOL::Init(), ROUTER_TOOL::Init(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_TOOL_BASE::Is45Limited(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::meanderSettingsDialog(), EDIT_TOOL::MoveExact(), PCB_CONTROL::NetColorModeCycle(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::onViaCommand(), PCB_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), GROUP_TOOL::PickNewMember(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), PCB_CONTROL::pruneItemLayers(), PAD_TOOL::pushPadSettings(), PCB_CONTROL::RatsnestModeCycle(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SCRIPTING_TOOL::reloadPlugins(), PCB_POINT_EDITOR::removeCorner(), PNS::TOOL_BASE::Reset(), PAD_TOOL::Reset(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), ROUTER_TOOL::SelectCopperLayerPair(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), PCB_POINT_EDITOR::setEditedPoint(), ROUTER_TOOL::SettingsDialog(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), ROUTER_TOOL::switchLayerOnViaPlacement(), DRAWING_TOOL::ToggleHV45Mode(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::unfilledZoneCheck(), PCB_POINT_EDITOR::updateItem(), ROUTER_TOOL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillAll(), and ZONE_FILLER_TOOL::ZoneFillDirty().

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

getItemDescription()

wxString BOARD_INSPECTION_TOOL::getItemDescription ( BOARD_ITEM *  aItem )

private

Definition at line 152 of file board_inspection_tool.cpp.

{
 // Null items have no description
 if( !aItem )
 return wxString();
 
 wxString msg = aItem->GetItemDescription( m_frame );
 
 if( aItem->IsConnected() && !isNPTHPad( aItem ) )
 {
 BOARD_CONNECTED_ITEM* cItem = static_cast<BOARD_CONNECTED_ITEM*>( aItem );
 
 msg += wxS( " " ) + wxString::Format( _( "[netclass %s]" ),
 cItem->GetEffectiveNetClass()->GetName() );
 }
 
 return msg;
};

References _, Format(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), EDA_ITEM::GetItemDescription(), NETCLASS::GetName(), BOARD_ITEM::IsConnected(), isNPTHPad(), and m_frame.

Referenced by InspectClearance(), and reportHeader().

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

HideLocalRatsnest()

int BOARD_INSPECTION_TOOL::HideLocalRatsnest

(

const TOOL_EVENT &

aEvent

)

Show local ratsnest of a component.

Definition at line 1666 of file board_inspection_tool.cpp.

{
 getModel<BOARD>()->GetConnectivity()->ClearLocalRatsnest();
 delete m_dynamicData;
 m_dynamicData = nullptr;
 
 return 0;
}

References m_dynamicData.

Referenced by setTransitions().

HideNetInRatsnest()

int BOARD_INSPECTION_TOOL::HideNetInRatsnest

(

const TOOL_EVENT &

aEvent

)

Show the ratsnest for a given net.

Definition at line 1798 of file board_inspection_tool.cpp.

{
 doHideRatsnestNet( aEvent.Parameter<intptr_t>(), true );
 return 0;
}

References doHideRatsnestNet(), and TOOL_EVENT::Parameter().

Referenced by setTransitions().

HighlightItem()

int BOARD_INSPECTION_TOOL::HighlightItem

(

const TOOL_EVENT &

aEvent

)

Update ratsnest for selected items.

Definition at line 1319 of file board_inspection_tool.cpp.

{
 BOARD_ITEM* item = aEvent.Parameter<BOARD_ITEM*>();
 
 m_frame->m_probingSchToPcb = true; // recursion guard
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 if( item )
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, (void*) item );
 }
 m_frame->m_probingSchToPcb = false;
 
 bool request3DviewRedraw = frame()->GetPcbNewSettings()->m_Display.m_Live3DRefresh;
 
 if( item && item->Type() != PCB_FOOTPRINT_T )
 request3DviewRedraw = false;
 
 // Update 3D viewer highlighting
 if( request3DviewRedraw )
 m_frame->Update3DView( false, true );
 
 return 0;
}

References PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetPcbNewSettings(), PCBNEW_SETTINGS::m_Display, m_frame, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_Live3DRefresh, PCB_EDIT_FRAME::m_probingSchToPcb, TOOL_BASE::m_toolMgr, TOOL_EVENT::Parameter(), PCB_FOOTPRINT_T, TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItem, EDA_ITEM::Type(), and PCB_BASE_FRAME::Update3DView().

Referenced by setTransitions().

HighlightNet()

int BOARD_INSPECTION_TOOL::HighlightNet

(

const TOOL_EVENT &

aEvent

)

Clear all board highlights.

Definition at line 1491 of file board_inspection_tool.cpp.

{
 int netcode = aEvent.Parameter<intptr_t>();
 KIGFX::RENDER_SETTINGS* settings = m_toolMgr->GetView()->GetPainter()->GetSettings();
 const std::set<int>& highlighted = settings->GetHighlightNetCodes();
 
 if( netcode > 0 )
 {
 m_lastHighlighted = highlighted;
 settings->SetHighlight( true, netcode );
 m_toolMgr->GetView()->UpdateAllLayersColor();
 m_currentlyHighlighted.clear();
 m_currentlyHighlighted.insert( netcode );
 }
 else if( aEvent.IsAction( &PCB_ACTIONS::highlightNetSelection ) )
 {
 // Highlight selection (cursor position will be ignored)
 highlightNet( getViewControls()->GetMousePosition(), true );
 }
 else if( aEvent.IsAction( &PCB_ACTIONS::toggleLastNetHighlight ) )
 {
 std::set<int> temp = highlighted;
 settings->SetHighlight( m_lastHighlighted );
 m_toolMgr->GetView()->UpdateAllLayersColor();
 m_currentlyHighlighted = m_lastHighlighted;
 m_lastHighlighted = temp;
 }
 else if( aEvent.IsAction( &PCB_ACTIONS::toggleNetHighlight ) )
 {
 bool turnOn = highlighted.empty() && !m_currentlyHighlighted.empty();
 settings->SetHighlight( m_currentlyHighlighted, turnOn );
 m_toolMgr->GetView()->UpdateAllLayersColor();
 }
 else // Highlight the net belonging to the item under the cursor
 {
 highlightNet( getViewControls()->GetMousePosition(), false );
 }
 
 return 0;
}

References KIGFX::RENDER_SETTINGS::GetHighlightNetCodes(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), TOOL_MANAGER::GetView(), TOOL_BASE::getViewControls(), highlightNet(), PCB_ACTIONS::highlightNetSelection, TOOL_EVENT::IsAction(), m_currentlyHighlighted, m_lastHighlighted, TOOL_BASE::m_toolMgr, TOOL_EVENT::Parameter(), PCB_ACTIONS::toggleLastNetHighlight, PCB_ACTIONS::toggleNetHighlight, and KIGFX::VIEW::UpdateAllLayersColor().

Referenced by setTransitions().

highlightNet()

bool BOARD_INSPECTION_TOOL::highlightNet ( const VECTOR2D &  aPosition, bool  aUseSelection  )

private

Look for a BOARD_CONNECTED_ITEM in a given spot and if one is found - it enables highlight for its net.

Parameters

aPosition	is the point where an item is expected (world coordinates).
aUseSelection	is true if we should use the current selection to pick the netcode

Definition at line 1345 of file board_inspection_tool.cpp.

{
 BOARD* board = static_cast<BOARD*>( m_toolMgr->GetModel() );
 KIGFX::RENDER_SETTINGS* settings = getView()->GetPainter()->GetSettings();
 PCB_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 
 int net = -1;
 bool enableHighlight = false;
 
 if( aUseSelection )
 {
 const PCB_SELECTION& selection = selectionTool->GetSelection();
 std::set<int> netcodes;
 
 for( EDA_ITEM* item : selection )
 {
 if( BOARD_CONNECTED_ITEM* ci = dynamic_cast<BOARD_CONNECTED_ITEM*>( item ) )
 netcodes.insert( ci->GetNetCode() );
 }
 
 enableHighlight = !netcodes.empty();
 
 if( enableHighlight && netcodes.size() > 1 )
 {
 // If we are doing a multi-highlight, cross-probing back and other stuff is not
 // yet supported
 settings->SetHighlight( netcodes );
 board->ResetNetHighLight();
 
 for( int multiNet : netcodes )
 board->SetHighLightNet( multiNet, true );
 
 board->HighLightON();
 m_toolMgr->GetView()->UpdateAllLayersColor();
 m_currentlyHighlighted = netcodes;
 return true;
 }
 else if( enableHighlight )
 {
 net = *netcodes.begin();
 }
 }
 
 // If we didn't get a net to highlight from the selection, use the cursor
 if( net < 0 )
 {
 GENERAL_COLLECTORS_GUIDE guide = m_frame->GetCollectorsGuide();
 guide.SetIgnoreZoneFills( false );
 
 PCB_LAYER_ID activeLayer = static_cast<PCB_LAYER_ID>( view()->GetTopLayer() );
 guide.SetPreferredLayer( activeLayer );
 
 GENERAL_COLLECTOR collector;
 collector.Collect( board, { PCB_PAD_T, PCB_VIA_T, PCB_TRACE_T, PCB_ARC_T }, aPosition,
 guide );
 
 if( collector.GetCount() == 0 )
 collector.Collect( board, { PCB_ZONE_T, PCB_FP_ZONE_T }, aPosition, guide );
 
 // Apply the active selection filter, except we want to allow picking locked items for
 // highlighting even if the user has disabled them for selection
 SELECTION_FILTER_OPTIONS& filter = selectionTool->GetFilter();
 
 bool saved = filter.lockedItems;
 filter.lockedItems = true;
 
 selectionTool->FilterCollectedItems( collector, true );
 
 filter.lockedItems = saved;
 
 // Clear the previous highlight
 //m_frame->SendMessageToEESCHEMA( nullptr );
 
 bool highContrast = settings->GetHighContrast();
 PCB_LAYER_ID contrastLayer = settings->GetPrimaryHighContrastLayer();
 
 for( int i = collector.GetCount() - 1; i >= 0; i-- )
 {
 LSET itemLayers = collector[i]->GetLayerSet();
 
 if( ( itemLayers & LSET::AllCuMask() ).none() ||
 ( highContrast && !itemLayers.Contains( contrastLayer ) ) )
 {
 collector.Remove( i );
 continue;
 }
 }
 
 enableHighlight = ( collector.GetCount() > 0 );
 
 // Obtain net code for the clicked item
 if( enableHighlight )
 {
 BOARD_CONNECTED_ITEM* targetItem = static_cast<BOARD_CONNECTED_ITEM*>( collector[0] );
 
 if( targetItem->Type() == PCB_PAD_T )
 m_frame->SendCrossProbeItem( targetItem );
 
 net = targetItem->GetNetCode();
 }
 }
 
 const std::set<int>& netcodes = settings->GetHighlightNetCodes();
 
 // Toggle highlight when the same net was picked
 if( netcodes.count( net ) )
 enableHighlight = !settings->IsHighlightEnabled();
 
 if( enableHighlight != settings->IsHighlightEnabled() || !netcodes.count( net ) )
 {
 if( !netcodes.empty() )
 m_lastHighlighted = netcodes;
 
 settings->SetHighlight( enableHighlight, net );
 m_toolMgr->GetView()->UpdateAllLayersColor();
 }
 
 // Store the highlighted netcode in the current board (for dialogs for instance)
 if( enableHighlight && net >= 0 )
 {
 m_currentlyHighlighted = netcodes;
 board->SetHighLightNet( net );
 board->HighLightON();
 
 NETINFO_ITEM* netinfo = board->FindNet( net );
 
 if( netinfo )
 {
 std::vector<MSG_PANEL_ITEM> items;
 netinfo->GetMsgPanelInfo( m_frame, items );
 m_frame->SetMsgPanel( items );
 m_frame->SendCrossProbeNetName( netinfo->GetNetname() );
 }
 }
 else
 {
 m_currentlyHighlighted.clear();
 board->ResetNetHighLight();
 m_frame->SetMsgPanel( board );
 m_frame->SendCrossProbeNetName( "" );
 }
 
 return true;
}

References LSET::AllCuMask(), PCB_TOOL_BASE::board(), GENERAL_COLLECTOR::Collect(), LSET::Contains(), filter, PCB_SELECTION_TOOL::FilterCollectedItems(), PCB_BASE_FRAME::GetCollectorsGuide(), COLLECTOR::GetCount(), PCB_SELECTION_TOOL::GetFilter(), KIGFX::RENDER_SETTINGS::GetHighContrast(), TOOL_MANAGER::GetModel(), BOARD_CONNECTED_ITEM::GetNetCode(), KIGFX::VIEW::GetPainter(), KIGFX::RENDER_SETTINGS::GetPrimaryHighContrastLayer(), PCB_SELECTION_TOOL::GetSelection(), KIGFX::PAINTER::GetSettings(), TOOL_MANAGER::GetTool(), KIGFX::VIEW::GetTopLayer(), TOOL_BASE::getView(), TOOL_MANAGER::GetView(), BOARD::HighLightON(), m_currentlyHighlighted, m_frame, TOOL_BASE::m_toolMgr, PCB_ARC_T, PCB_FP_ZONE_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, BOARD::ResetNetHighLight(), PCB_TOOL_BASE::selection(), PCB_EDIT_FRAME::SendCrossProbeItem(), KIGFX::RENDER_SETTINGS::SetHighlight(), BOARD::SetHighLightNet(), GENERAL_COLLECTORS_GUIDE::SetIgnoreZoneFills(), GENERAL_COLLECTORS_GUIDE::SetPreferredLayer(), EDA_ITEM::Type(), KIGFX::VIEW::UpdateAllLayersColor(), and PCB_TOOL_BASE::view().

Referenced by HighlightNet().

Init()

bool BOARD_INSPECTION_TOOL::Init ( )

overridevirtual

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

Returns

True if the initialization went fine, false - otherwise.

Reimplemented from PCB_TOOL_BASE.

Definition at line 76 of file board_inspection_tool.cpp.

{
 PCB_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 
 std::shared_ptr<NET_CONTEXT_MENU> netSubMenu = std::make_shared<NET_CONTEXT_MENU>();
 netSubMenu->SetTool( this );
 
 static std::vector<KICAD_T> connectedTypes = { PCB_TRACE_T,
 PCB_VIA_T,
 PCB_ARC_T,
 PCB_PAD_T,
 PCB_ZONE_T };
 
 CONDITIONAL_MENU& menu = selectionTool->GetToolMenu().GetMenu();
 
 selectionTool->GetToolMenu().RegisterSubMenu( netSubMenu );
 
 menu.AddMenu( netSubMenu.get(), SELECTION_CONDITIONS::OnlyTypes( connectedTypes ), 100 );
 
 return true;
}

References CONDITIONAL_MENU::AddMenu(), connectedTypes, TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOL_INTERACTIVE::GetToolMenu(), TOOL_BASE::m_toolMgr, SELECTION_CONDITIONS::OnlyTypes(), PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, and TOOL_MENU::RegisterSubMenu().

InspectClearance()

int BOARD_INSPECTION_TOOL::InspectClearance

(

const TOOL_EVENT &

aEvent

)

Definition at line 547 of file board_inspection_tool.cpp.

{
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 const PCB_SELECTION& selection = selTool->GetSelection();
 
 if( selection.Size() != 2 )
 {
 m_frame->ShowInfoBarError( _( "Select two items for a clearance resolution report." ) );
 return 0;
 }
 
 BOARD_ITEM* a = static_cast<BOARD_ITEM*>( selection.GetItem( 0 ) );
 BOARD_ITEM* b = static_cast<BOARD_ITEM*>( selection.GetItem( 1 ) );
 
 wxCHECK( a && b, 0 );
 
 if( a->Type() == PCB_GROUP_T )
 {
 PCB_GROUP* ag = static_cast<PCB_GROUP*>( a );
 
 if( ag->GetItems().empty() )
 {
 m_frame->ShowInfoBarError( _( "Cannot generate clearance report on empty group." ) );
 return 0;
 }
 
 a = *ag->GetItems().begin();
 }
 
 if( b->Type() == PCB_GROUP_T )
 {
 PCB_GROUP* bg = static_cast<PCB_GROUP*>( b );
 
 if( bg->GetItems().empty() )
 {
 m_frame->ShowInfoBarError( _( "Cannot generate clearance report on empty group." ) );
 return 0;
 }
 
 b = *bg->GetItems().begin();
 }
 
 // a and b could be null after group tests above.
 wxCHECK( a && b, 0 );
 
 if( m_inspectClearanceDialog == nullptr )
 {
 m_inspectClearanceDialog = std::make_unique<DIALOG_CONSTRAINTS_REPORTER>( m_frame );
 m_inspectClearanceDialog->SetTitle( _( "Clearance Report" ) );
 
 m_inspectClearanceDialog->Connect( wxEVT_CLOSE_WINDOW,
 wxCommandEventHandler( BOARD_INSPECTION_TOOL::onInspectClearanceDialogClosed ),
 nullptr, this );
 }
 
 m_inspectClearanceDialog->DeleteAllPages();
 
 if( a->Type() != PCB_ZONE_T && b->Type() == PCB_ZONE_T )
 std::swap( a, b );
 else if( !a->IsConnected() && b->IsConnected() )
 std::swap( a, b );
 
 WX_HTML_REPORT_BOX* r = nullptr;
 PCB_LAYER_ID active = m_frame->GetActiveLayer();
 LSET layerIntersection = a->GetLayerSet() & b->GetLayerSet();
 LSET copperIntersection = layerIntersection & LSET::AllCuMask();
 BOARD_CONNECTED_ITEM* ac = dynamic_cast<BOARD_CONNECTED_ITEM*>( a );
 BOARD_CONNECTED_ITEM* bc = dynamic_cast<BOARD_CONNECTED_ITEM*>( b );
 ZONE* zone = dynamic_cast<ZONE*>( a );
 PAD* pad = dynamic_cast<PAD*>( b );
 FOOTPRINT* aFP = dynamic_cast<FOOTPRINT*>( a );
 FOOTPRINT* bFP = dynamic_cast<FOOTPRINT*>( b );
 
 bool compileError = false;
 DRC_ENGINE drcEngine = makeDRCEngine( &compileError );
 DRC_CONSTRAINT constraint;
 int clearance = 0;
 
 if( copperIntersection.any() && zone && pad && zone->GetNetCode() == pad->GetNetCode() )
 {
 PCB_LAYER_ID layer = UNDEFINED_LAYER;
 
 if( zone->IsOnLayer( active ) )
 layer = active;
 else if( zone->GetLayerSet().count() > 0 )
 layer = zone->GetLayerSet().Seq().front();
 
 r = m_inspectClearanceDialog->AddPage( _( "Zone" ) );
 reportHeader( _( "Zone connection resolution for:" ), a, b, layer, r );
 
 constraint = drcEngine.EvalZoneConnection( pad, zone, layer, r );
 
 if( constraint.m_ZoneConnection == ZONE_CONNECTION::THERMAL )
 {
 r->Report( "" );
 r->Report( "" );
 reportHeader( _( "Thermal relief gap resolution for:" ), a, b, layer, r );
 
 constraint = drcEngine.EvalRules( THERMAL_RELIEF_GAP_CONSTRAINT, pad, zone, layer, r );
 int gap = constraint.m_Value.Min();
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved thermal relief gap: %s." ),
 m_frame->StringFromValue( gap, true ) ) );
 
 r->Report( "" );
 r->Report( "" );
 reportHeader( _( "Spoke width resolution for:" ), a, b, layer, r );
 
 constraint = drcEngine.EvalRules( THERMAL_SPOKE_WIDTH_CONSTRAINT, pad, zone, layer, r );
 int width = constraint.m_Value.Opt();
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved thermal relief spoke width: %s." ),
 m_frame->StringFromValue( width, true ) ) );
 
 r->Report( "" );
 r->Report( "" );
 reportHeader( _( "Spoke count resolution for:" ), a, b, layer, r );
 
 constraint = drcEngine.EvalRules( MIN_RESOLVED_SPOKES_CONSTRAINT, pad, zone, layer, r );
 int minSpokes = constraint.m_Value.Min();
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved min thermal relief spoke count: %d." ),
 minSpokes ) );
 
 std::shared_ptr<CONNECTIVITY_DATA> connectivity = pad->GetBoard()->GetConnectivity();
 }
 else if( constraint.m_ZoneConnection == ZONE_CONNECTION::NONE )
 {
 r->Report( "" );
 r->Report( "" );
 reportHeader( _( "Zone clearance resolution for:" ), a, b, layer, r );
 
 clearance = zone->GetLocalClearance();
 r->Report( "" );
 r->Report( wxString::Format( _( "Zone clearance: %s." ),
 m_frame->StringFromValue( clearance, true ) ) );
 
 constraint = drcEngine.EvalRules( PHYSICAL_CLEARANCE_CONSTRAINT, pad, zone, layer, r );
 
 if( constraint.m_Value.Min() > clearance )
 {
 clearance = constraint.m_Value.Min();
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Overridden by larger physical clearance from %s;"
 "clearance: %s." ),
 EscapeHTML( constraint.GetName() ),
 m_frame->StringFromValue( clearance, true ) ) );
 }
 
 if( !pad->FlashLayer( layer ) )
 {
 constraint = drcEngine.EvalRules( PHYSICAL_HOLE_CLEARANCE_CONSTRAINT, pad, zone,
 layer, r );
 
 if( constraint.m_Value.Min() > clearance )
 {
 clearance = constraint.m_Value.Min();
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Overridden by larger physical hole clearance from %s;"
 "clearance: %s." ),
 EscapeHTML( constraint.GetName() ),
 m_frame->StringFromValue( clearance, true ) ) );
 }
 }
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ),
 m_frame->StringFromValue( clearance, true ) ) );
 }
 else
 {
 r->Report( "" );
 r->Report( "" );
 reportHeader( _( "Zone clearance resolution for:" ), a, b, layer, r );
 
 if( compileError )
 reportCompileError( r );
 
 // Report a 0 clearance for solid connections
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ),
 m_frame->StringFromValue( 0, true ) ) );
 }
 
 r->Flush();
 }
 else if( copperIntersection.any() && !aFP && !bFP )
 {
 PCB_LAYER_ID layer = active;
 
 if( !copperIntersection.test( layer ) )
 layer = copperIntersection.Seq().front();
 
 r = m_inspectClearanceDialog->AddPage( m_frame->GetBoard()->GetLayerName( layer ) );
 reportHeader( _( "Clearance resolution for:" ), a, b, layer, r );
 
 if( ac && bc && ac->GetNetCode() > 0 && ac->GetNetCode() == bc->GetNetCode() )
 {
 // Same nets....
 r->Report( _( "Items belong to the same net. Clearance is 0." ) );
 }
 else
 {
 // Different nets (or one or both unconnected)....
 constraint = drcEngine.EvalRules( CLEARANCE_CONSTRAINT, a, b, layer, r );
 clearance = constraint.m_Value.Min();
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 
 if( clearance < 0 )
 {
 r->Report( wxString::Format( _( "Resolved clearance: %s; clearance will not be tested." ),
 m_frame->StringFromValue( clearance, true ) ) );
 }
 else
 {
 r->Report( wxString::Format( _( "Resolved clearance: %s." ),
 m_frame->StringFromValue( clearance, true ) ) );
 }
 }
 
 r->Flush();
 }
 
 if( ac && bc )
 {
 NETINFO_ITEM* refNet = ac->GetNet();
 wxString coupledNet;
 wxString dummy;
 
 if( DRC_ENGINE::MatchDpSuffix( refNet->GetNetname(), coupledNet, dummy )
 && bc->GetNetname() == coupledNet )
 {
 r = m_inspectClearanceDialog->AddPage( _( "Diff Pair" ) );
 reportHeader( _( "Diff pair gap resolution for:" ), ac, bc, active, r );
 
 constraint = drcEngine.EvalRules( DIFF_PAIR_GAP_CONSTRAINT, ac, bc, active, r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved gap constraints: min %s; opt %s; max %s." ),
 reportMin( m_frame, constraint ),
 reportOpt( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 
 r->Report( "" );
 r->Report( "" );
 r->Report( "" );
 reportHeader( _( "Diff pair max uncoupled length resolution for:" ), ac, bc, active, r );
 
 if( !drcEngine.HasRulesForConstraintType( DIFF_PAIR_MAX_UNCOUPLED_CONSTRAINT ) )
 {
 r->Report( "" );
 r->Report( _( "No 'diff_pair_uncoupled' constraints defined." ) );
 }
 else
 {
 constraint = drcEngine.EvalRules( DIFF_PAIR_MAX_UNCOUPLED_CONSTRAINT, ac, bc,
 active, r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved max uncoupled length: %s." ),
 reportMax( m_frame, constraint ) ) );
 }
 r->Flush();
 }
 }
 
 auto isOnCorrespondingLayer=
 [&]( BOARD_ITEM* aItem, PCB_LAYER_ID aLayer, wxString* aWarning )
 {
 if( aItem->IsOnLayer( aLayer ) )
 return true;
 
 PCB_LAYER_ID correspondingMask = IsFrontLayer( aLayer ) ? F_Mask : B_Mask;
 PCB_LAYER_ID correspondingCopper = IsFrontLayer( aLayer ) ? F_Cu : B_Cu;
 
 if( aItem->IsOnLayer( aLayer ) )
 return true;
 
 if( aItem->IsOnLayer( correspondingMask ) )
 return true;
 
 if( aItem->IsTented() && aItem->IsOnLayer( correspondingCopper ) )
 {
 *aWarning = wxString::Format( _( "Note: %s is tented; clearance will only be "
 "applied to holes." ),
 getItemDescription( aItem ) );
 return true;
 }
 
 return false;
 };
 
 for( PCB_LAYER_ID layer : { F_SilkS, B_SilkS } )
 {
 wxString warning;
 
 if( ( a->IsOnLayer( layer ) && isOnCorrespondingLayer( b, layer, &warning ) )
 || ( b->IsOnLayer( layer ) && isOnCorrespondingLayer( a, layer, &warning ) ) )
 {
 r = m_inspectClearanceDialog->AddPage( m_frame->GetBoard()->GetLayerName( layer ) );
 reportHeader( _( "Silkscreen clearance resolution for:" ), a, b, layer, r );
 
 constraint = drcEngine.EvalRules( SILK_CLEARANCE_CONSTRAINT, a, b, layer, r );
 clearance = constraint.m_Value.Min();
 
 if( compileError )
  reportCompileError( r );
 
 r->Report( "" );
 
 if( !warning.IsEmpty() )
 r->Report( warning );
 
 r->Report( wxString::Format( _( "Resolved clearance: %s." ),
 m_frame->StringFromValue( clearance, true ) ) );
 
 r->Flush();
 }
 }
 
 for( PCB_LAYER_ID layer : { F_CrtYd, B_CrtYd } )
 {
 bool aCourtyard = aFP && !aFP->GetCourtyard( layer ).IsEmpty();
 bool bCourtyard = bFP && !bFP->GetCourtyard( layer ).IsEmpty();
 
 if( aCourtyard && bCourtyard )
 {
 r = m_inspectClearanceDialog->AddPage( m_frame->GetBoard()->GetLayerName( layer ) );
 reportHeader( _( "Courtyard clearance resolution for:" ), a, b, layer, r );
 
 constraint = drcEngine.EvalRules( COURTYARD_CLEARANCE_CONSTRAINT, a, b, layer, r );
 clearance = constraint.m_Value.Min();
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ),
 m_frame->StringFromValue( clearance, true ) ) );
 
 r->Flush();
 }
 }
 
 if( a->HasHole() || b->HasHole() )
 {
 PCB_LAYER_ID layer = UNDEFINED_LAYER;
 bool pageAdded = false;
 
 if( a->HasHole() && b->IsOnLayer( active ) && IsCopperLayer( active ) )
 layer = active;
 else if( b->HasHole() && a->IsOnLayer( active ) && IsCopperLayer( active ) )
 layer = active;
 else if( a->HasHole() && b->IsOnCopperLayer() )
 layer = b->GetLayer();
 else if( b->HasHole() && b->IsOnCopperLayer() )
 layer = a->GetLayer();
 
 if( layer >= 0 )
 {
 if( !pageAdded )
 {
 r = m_inspectClearanceDialog->AddPage( _( "Hole" ) );
 pageAdded = true;
 }
 else
 {
 r->Report( "" );
 r->Report( "" );
 r->Report( "" );
 }
 
 reportHeader( _( "Hole clearance resolution for:" ), a, b, layer, r );
 
 constraint = drcEngine.EvalRules( HOLE_CLEARANCE_CONSTRAINT, a, b, layer, r );
 clearance = constraint.m_Value.Min();
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ),
 m_frame->StringFromValue( clearance, true ) ) );
 
 r->Flush();
 }
 
 if( a->HasHole() && b->HasHole() )
 {
 if( !pageAdded )
 {
 r = m_inspectClearanceDialog->AddPage( _( "Hole" ) );
 pageAdded = true;
 }
 else
 {
 r->Report( "" );
 r->Report( "" );
 r->Report( "" );
 }
 
 reportHeader( _( "Hole to hole clearance resolution for:" ), a, b, r );
 
 constraint = drcEngine.EvalRules( HOLE_TO_HOLE_CONSTRAINT, a, b, UNDEFINED_LAYER, r );
 clearance = constraint.m_Value.Min();
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ),
 m_frame->StringFromValue( clearance, true ) ) );
 
 r->Flush();
 }
 }
 
 for( PCB_LAYER_ID edgeLayer : { Edge_Cuts, Margin } )
 {
 PCB_LAYER_ID layer = UNDEFINED_LAYER;
 
 if( a->IsOnLayer( edgeLayer ) && b->Type() != PCB_FOOTPRINT_T )
 {
 if( b->IsOnLayer( active ) && IsCopperLayer( active ) )
 layer = active;
 else if( IsCopperLayer( b->GetLayer() ) )
 layer = b->GetLayer();
 }
 else if( b->IsOnLayer( edgeLayer ) && a->Type() != PCB_FOOTPRINT_T )
 {
 if( a->IsOnLayer( active ) && IsCopperLayer( active ) )
 layer = active;
 else if( IsCopperLayer( a->GetLayer() ) )
 layer = a->GetLayer();
 }
 
 if( layer >= 0 )
 {
 wxString layerName = m_frame->GetBoard()->GetLayerName( edgeLayer );
 r = m_inspectClearanceDialog->AddPage( layerName + wxS( " " ) + _( "Clearance" ) );
 reportHeader( _( "Edge clearance resolution for:" ), a, b, layer, r );
 
 constraint = drcEngine.EvalRules( EDGE_CLEARANCE_CONSTRAINT, a, b, layer, r );
 clearance = constraint.m_Value.Min();
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ),
 m_frame->StringFromValue( clearance, true ) ) );
 
 r->Flush();
 }
 }
 
 r = m_inspectClearanceDialog->AddPage( _( "Physical Clearances" ) );
 
 auto reportPhysicalClearance =
 [&]( PCB_LAYER_ID aLayer )
 {
 reportHeader( _( "Physical clearance resolution for:" ), a, b, aLayer, r );
 
 constraint = drcEngine.EvalRules( PHYSICAL_CLEARANCE_CONSTRAINT, a, b, aLayer, r );
 clearance = constraint.m_Value.Min();
 
 if( compileError )
 {
 reportCompileError( r );
 }
 else if( !drcEngine.HasRulesForConstraintType( PHYSICAL_CLEARANCE_CONSTRAINT ) )
 {
 r->Report( "" );
 r->Report( _( "No 'physical_clearance' constraints defined." ) );
 }
 else
 {
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ),
 m_frame->StringFromValue( clearance, true ) ) );
 }
 
 r->Report( "" );
 r->Report( "" );
 r->Report( "" );
 };
 
 if( layerIntersection.any() )
 {
 PCB_LAYER_ID layer = active;
 
 if( !layerIntersection.test( layer ) )
 layer = layerIntersection.Seq().front();
 
 reportPhysicalClearance( layer );
 }
 
 if( aFP && b->IsOnLayer( Edge_Cuts ) )
 {
 if( !aFP->GetCourtyard( F_CrtYd ).IsEmpty() )
 reportPhysicalClearance( F_CrtYd );
 
 if( !aFP->GetCourtyard( B_CrtYd ).IsEmpty() )
 reportPhysicalClearance( B_CrtYd );
 }
 else if( bFP && a->IsOnLayer( Edge_Cuts ) )
 {
 if( !bFP->GetCourtyard( F_CrtYd ).IsEmpty() )
 reportPhysicalClearance( F_CrtYd );
 
 if( !bFP->GetCourtyard( B_CrtYd ).IsEmpty() )
 reportPhysicalClearance( B_CrtYd );
 }
 
 if( a->HasHole() || b->HasHole() )
 {
 PCB_LAYER_ID layer;
 
 if( a->HasHole() && b->IsOnLayer( active ) )
 layer = active;
 else if( b->HasHole() && a->IsOnLayer( active ) )
 layer = active;
 else if( a->HasHole() )
 layer = b->GetLayer();
 else
 layer = a->GetLayer();
 
 reportHeader( _( "Physical hole clearance resolution for:" ), a, b, layer, r );
 
 constraint = drcEngine.EvalRules( PHYSICAL_HOLE_CLEARANCE_CONSTRAINT, a, b, layer, r );
 clearance = constraint.m_Value.Min();
 
 if( compileError )
 {
 reportCompileError( r );
 }
 else if( !drcEngine.HasRulesForConstraintType( PHYSICAL_HOLE_CLEARANCE_CONSTRAINT ) )
 {
 r->Report( "" );
 r->Report( _( "No 'physical_hole_clearance' constraints defined." ) );
 }
 else
 {
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ),
 m_frame->StringFromValue( clearance, true ) ) );
 }
 }
 
 r->Flush();
 
 m_inspectClearanceDialog->Raise();
 m_inspectClearanceDialog->Show( true );
 return 0;
}

References _, LSET::AllCuMask(), B_CrtYd, B_Cu, B_Mask, B_SilkS, CLEARANCE_CONSTRAINT, COURTYARD_CLEARANCE_CONSTRAINT, DIFF_PAIR_GAP_CONSTRAINT, DIFF_PAIR_MAX_UNCOUPLED_CONSTRAINT, dummy, EDGE_CLEARANCE_CONSTRAINT, Edge_Cuts, EscapeHTML(), DRC_ENGINE::EvalRules(), DRC_ENGINE::EvalZoneConnection(), F_CrtYd, F_Cu, F_Mask, F_SilkS, WX_HTML_REPORT_BOX::Flush(), Format(), PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetBoard(), FOOTPRINT::GetCourtyard(), SELECTION::GetItem(), getItemDescription(), PCB_GROUP::GetItems(), BOARD_ITEM::GetLayer(), BOARD::GetLayerName(), BOARD_ITEM::GetLayerSet(), ZONE::GetLayerSet(), ZONE::GetLocalClearance(), DRC_CONSTRAINT::GetName(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), NETINFO_ITEM::GetNetname(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), BOARD_ITEM::HasHole(), DRC_ENGINE::HasRulesForConstraintType(), HOLE_CLEARANCE_CONSTRAINT, HOLE_TO_HOLE_CONSTRAINT, BOARD_ITEM::IsConnected(), IsCopperLayer(), SHAPE_POLY_SET::IsEmpty(), IsFrontLayer(), BOARD_ITEM::IsOnCopperLayer(), BOARD_ITEM::IsOnLayer(), ZONE::IsOnLayer(), BOARD_ITEM::IsTented(), m_frame, m_inspectClearanceDialog, TOOL_BASE::m_toolMgr, DRC_CONSTRAINT::m_Value, DRC_CONSTRAINT::m_ZoneConnection, makeDRCEngine(), Margin, DRC_ENGINE::MatchDpSuffix(), MINOPTMAX< T >::Min(), MIN_RESOLVED_SPOKES_CONSTRAINT, NONE, onInspectClearanceDialogClosed(), MINOPTMAX< T >::Opt(), pad, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_ZONE_T, PHYSICAL_CLEARANCE_CONSTRAINT, PHYSICAL_HOLE_CLEARANCE_CONSTRAINT, WX_HTML_REPORT_BOX::Report(), reportCompileError(), reportHeader(), reportMax(), reportMin(), reportOpt(), PCB_TOOL_BASE::selection(), LSET::Seq(), EDA_BASE_FRAME::ShowInfoBarError(), SILK_CLEARANCE_CONSTRAINT, SELECTION::Size(), UNITS_PROVIDER::StringFromValue(), THERMAL, THERMAL_RELIEF_GAP_CONSTRAINT, THERMAL_SPOKE_WIDTH_CONSTRAINT, EDA_ITEM::Type(), and UNDEFINED_LAYER.

Referenced by setTransitions().

InspectConstraints()

int BOARD_INSPECTION_TOOL::InspectConstraints

(

const TOOL_EVENT &

aEvent

)

Definition at line 1125 of file board_inspection_tool.cpp.

{
#define EVAL_RULES( constraint, a, b, layer, r ) drcEngine.EvalRules( constraint, a, b, layer, r )
 
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 const PCB_SELECTION& selection = selTool->GetSelection();
 
 if( selection.Size() != 1 )
 {
 m_frame->ShowInfoBarError( _( "Select an item for a constraints resolution report." ) );
 return 0;
 }
 
 if( m_inspectConstraintsDialog == nullptr )
 {
 m_inspectConstraintsDialog = std::make_unique<DIALOG_CONSTRAINTS_REPORTER>( m_frame );
 m_inspectConstraintsDialog->SetTitle( _( "Constraints Report" ) );
 
 m_inspectConstraintsDialog->Connect( wxEVT_CLOSE_WINDOW,
 wxCommandEventHandler( BOARD_INSPECTION_TOOL::onInspectConstraintsDialogClosed ),
 nullptr, this );
 }
 
 m_inspectConstraintsDialog->DeleteAllPages();
 
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( selection.GetItem( 0 ) );
 bool compileError = false;
 bool courtyardError = false;
 DRC_ENGINE drcEngine = makeDRCEngine( &compileError, &courtyardError );
 DRC_CONSTRAINT constraint;
 
 WX_HTML_REPORT_BOX* r = nullptr;
 
 if( item->Type() == PCB_TRACE_T )
 {
 r = m_inspectConstraintsDialog->AddPage( _( "Track Width" ) );
 reportHeader( _( "Track width resolution for:" ), item, r );
 
 constraint = EVAL_RULES( TRACK_WIDTH_CONSTRAINT, item, nullptr, item->GetLayer(), r );
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Width constraints: min %s; opt %s; max %s." ),
 reportMin( m_frame, constraint ),
 reportOpt( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 
 r->Flush();
 }
 
 if( item->Type() == PCB_VIA_T )
 {
 r = m_inspectConstraintsDialog->AddPage( _( "Via Diameter" ) );
 reportHeader( _( "Via diameter resolution for:" ), item, r );
 
 // PADSTACKS TODO: once we have padstacks we'll need to run this per-layer....
 constraint = EVAL_RULES( VIA_DIAMETER_CONSTRAINT, item, nullptr, UNDEFINED_LAYER, r );
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Diameter constraints: min %s; opt %s; max %s." ),
 reportMin( m_frame, constraint ),
  reportOpt( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 
 r->Flush();
 
 r = m_inspectConstraintsDialog->AddPage( _( "Via Annular Width" ) );
 reportHeader( _( "Via annular width resolution for:" ), item, r );
 
 // PADSTACKS TODO: once we have padstacks we'll need to run this per-layer....
 constraint = EVAL_RULES( ANNULAR_WIDTH_CONSTRAINT, item, nullptr, UNDEFINED_LAYER, r );
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Annular width constraints: min %s; opt %s; max %s." ),
 reportMin( m_frame, constraint ),
 reportOpt( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 
 r->Flush();
 }
 
 if( ( item->Type() == PCB_PAD_T && static_cast<PAD*>( item )->GetDrillSize().x > 0 )
 || item->Type() == PCB_VIA_T )
 {
 r = m_inspectConstraintsDialog->AddPage( _( "Hole Size" ) );
 reportHeader( _( "Hole diameter resolution for:" ), item, r );
 
 // PADSTACKS TODO: once we have padstacks we'll need to run this per-layer....
 constraint = EVAL_RULES( HOLE_SIZE_CONSTRAINT, item, nullptr, UNDEFINED_LAYER, r );
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Diameter constraints: min %s; opt %s; max %s." ),
 reportMin( m_frame, constraint ),
 reportOpt( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 
 r->Flush();
 }
 
 if( item->Type() == PCB_TEXT_T
 || item->Type() == PCB_TEXTBOX_T
 || item->Type() == PCB_FP_TEXT_T )
 {
 r = m_inspectConstraintsDialog->AddPage( _( "Text Size" ) );
 reportHeader( _( "Text height resolution for:" ), item, r );
 
 constraint = EVAL_RULES( TEXT_HEIGHT_CONSTRAINT, item, nullptr, UNDEFINED_LAYER, r );
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Text height constraints: min %s; opt %s; max %s." ),
 reportMin( m_frame, constraint ),
 reportOpt( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 
 r->Report( "" );
 r->Report( "" );
 r->Report( "" );
 reportHeader( _( "Text thickness resolution for:" ), item, r );
 
 constraint = EVAL_RULES( TEXT_THICKNESS_CONSTRAINT, item, nullptr, UNDEFINED_LAYER, r );
 
 if( compileError )
 reportCompileError( r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Text thickness constraints: min %s; opt %s; max %s." ),
 reportMin( m_frame, constraint ),
 reportOpt( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 
 r->Flush();
 }
 
 r = m_inspectConstraintsDialog->AddPage( _( "Keepouts" ) );
 reportHeader( _( "Keepout resolution for:" ), item, r );
 
 constraint = EVAL_RULES( DISALLOW_CONSTRAINT, item, nullptr, item->GetLayer(), r );
 
 if( compileError )
 reportCompileError( r );
 
 if( courtyardError )
 {
 r->Report( "" );
 r->Report( _( "Report may be incomplete: some footprint courtyards are malformed." )
 + wxT( " <a href='drc'>" ) + _( "Run DRC for a full analysis." ) + wxT( "</a>" ) );
 }
 
 r->Report( "" );
 
 if( constraint.m_DisallowFlags )
 r->Report( _( "Item <b>disallowed</b> at current location." ) );
 else
 r->Report( _( "Item allowed at current location." ) );
 
 r->Flush();
 
 r = m_inspectConstraintsDialog->AddPage( _( "Assertions" ) );
 reportHeader( _( "Assertions for:" ), item, r );
 
 if( compileError )
 reportCompileError( r );
 
 if( courtyardError )
 {
 r->Report( "" );
 r->Report( _( "Report may be incomplete: some footprint courtyards are malformed." )
 + wxT( " <a href='drc'>" ) + _( "Run DRC for a full analysis." ) + wxT( "</a>" ) );
 }
 
 drcEngine.ProcessAssertions( item, []( const DRC_CONSTRAINT* c ){}, r );
 r->Flush();
 
 m_inspectConstraintsDialog->FinishInitialization();
 m_inspectConstraintsDialog->Raise();
 m_inspectConstraintsDialog->Show( true );
 return 0;
}

References _, ANNULAR_WIDTH_CONSTRAINT, DISALLOW_CONSTRAINT, EVAL_RULES, WX_HTML_REPORT_BOX::Flush(), Format(), PAD::GetDrillSize(), SELECTION::GetItem(), BOARD_ITEM::GetLayer(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), HOLE_SIZE_CONSTRAINT, DRC_CONSTRAINT::m_DisallowFlags, m_frame, m_inspectConstraintsDialog, TOOL_BASE::m_toolMgr, makeDRCEngine(), onInspectConstraintsDialogClosed(), PCB_FP_TEXT_T, PCB_PAD_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, DRC_ENGINE::ProcessAssertions(), WX_HTML_REPORT_BOX::Report(), reportCompileError(), reportHeader(), reportMax(), reportMin(), reportOpt(), PCB_TOOL_BASE::selection(), EDA_BASE_FRAME::ShowInfoBarError(), SELECTION::Size(), TEXT_HEIGHT_CONSTRAINT, TEXT_THICKNESS_CONSTRAINT, TRACK_WIDTH_CONSTRAINT, EDA_ITEM::Type(), UNDEFINED_LAYER, VIA_DIAMETER_CONSTRAINT, and VECTOR2< T >::x.

Referenced by setTransitions().

InspectDRCError()

void BOARD_INSPECTION_TOOL::InspectDRCError

(

const std::shared_ptr< RC_ITEM > &

aDRCItem

)

Show the clearance resolution for two selected items.

Definition at line 235 of file board_inspection_tool.cpp.

{
 BOARD_ITEM* a = m_frame->GetBoard()->GetItem( aDRCItem->GetMainItemID() );
 BOARD_ITEM* b = m_frame->GetBoard()->GetItem( aDRCItem->GetAuxItemID() );
 BOARD_CONNECTED_ITEM* ac = dynamic_cast<BOARD_CONNECTED_ITEM*>( a );
 BOARD_CONNECTED_ITEM* bc = dynamic_cast<BOARD_CONNECTED_ITEM*>( b );
 PCB_LAYER_ID layer = m_frame->GetActiveLayer();
 
 if( m_inspectClearanceDialog == nullptr )
 {
 m_inspectClearanceDialog = std::make_unique<DIALOG_CONSTRAINTS_REPORTER>( m_frame );
 m_inspectClearanceDialog->SetTitle( _( "Violation Report" ) );
 
 m_inspectClearanceDialog->Connect( wxEVT_CLOSE_WINDOW,
 wxCommandEventHandler( BOARD_INSPECTION_TOOL::onInspectClearanceDialogClosed ),
 nullptr, this );
 }
 
 WX_HTML_REPORT_BOX* r = nullptr;
 bool compileError = false;
 DRC_ENGINE drcEngine = makeDRCEngine( &compileError );
 DRC_CONSTRAINT constraint;
 int clearance = 0;
 wxString clearanceStr;
 
 switch( aDRCItem->GetErrorCode() )
 {
 case DRCE_DIFF_PAIR_UNCOUPLED_LENGTH_TOO_LONG:
 {
 for( KIID id : aDRCItem->GetIDs() )
 {
 bc = dynamic_cast<BOARD_CONNECTED_ITEM*>( m_frame->GetBoard()->GetItem( id ) );
 
 if( ac && bc && ac->GetNetCode() != bc->GetNetCode() )
 break;
 }
 
 r = m_inspectClearanceDialog->AddPage( _( "Uncoupled Length" ) );
 reportHeader( _( "Diff pair uncoupled length resolution for:" ), ac, bc, r );
 
 if( compileError )
 reportCompileError( r );
 
 constraint = drcEngine.EvalRules( DIFF_PAIR_MAX_UNCOUPLED_CONSTRAINT, a, b, layer, r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved max uncoupled length: %s." ),
 reportMax( m_frame, constraint ) ) );
 break;
 }
 
 case DRCE_TEXT_HEIGHT:
 r = m_inspectClearanceDialog->AddPage( _( "Text Height" ) );
 reportHeader( _( "Text height resolution for:" ), a, r );
 
 if( compileError )
 reportCompileError( r );
 
 constraint = drcEngine.EvalRules( TEXT_HEIGHT_CONSTRAINT, a, b, layer, r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved height constraints: min %s; max %s." ),
 reportMin( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 break;
 
 case DRCE_TEXT_THICKNESS:
 r = m_inspectClearanceDialog->AddPage( _( "Text Thickness" ) );
 reportHeader( _( "Text thickness resolution for:" ), a, r );
 
 if( compileError )
 reportCompileError( r );
 
 constraint = drcEngine.EvalRules( TEXT_THICKNESS_CONSTRAINT, a, b, layer, r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved thickness constraints: min %s; max %s." ),
 reportMin( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 break;
 
 case DRCE_TRACK_WIDTH:
 r = m_inspectClearanceDialog->AddPage( _( "Track Width" ) );
 reportHeader( _( "Track width resolution for:" ), a, r );
 
 if( compileError )
 reportCompileError( r );
 
 constraint = drcEngine.EvalRules( TRACK_WIDTH_CONSTRAINT, a, b, layer, r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved width constraints: min %s; max %s." ),
 reportMin( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 break;
 
 case DRCE_CONNECTION_WIDTH:
 r = m_inspectClearanceDialog->AddPage( _( "Connection Width" ) );
 reportHeader( _( "Connection width resolution for:" ), a, b, r );
 
 if( compileError )
 reportCompileError( r );
 
 constraint = drcEngine.EvalRules( CONNECTION_WIDTH_CONSTRAINT, a, b, layer, r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved min connection width constraint: %s." ),
 reportMin( m_frame, constraint ) ) );
 break;
 
 case DRCE_VIA_DIAMETER:
 r = m_inspectClearanceDialog->AddPage( _( "Via Diameter" ) );
 reportHeader( _( "Via diameter resolution for:" ), a, r );
 
 if( compileError )
 reportCompileError( r );
 
 constraint = drcEngine.EvalRules( VIA_DIAMETER_CONSTRAINT, a, b, layer, r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved diameter constraints: min %s; max %s." ),
 reportMin( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 break;
 
 case DRCE_ANNULAR_WIDTH:
 r = m_inspectClearanceDialog->AddPage( _( "Via Annulus" ) );
 reportHeader( _( "Via annular width resolution for:" ), a, r );
 
 if( compileError )
 reportCompileError( r );
 
 constraint = drcEngine.EvalRules( ANNULAR_WIDTH_CONSTRAINT, a, b, layer, r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved annular width constraints: min %s; max %s." ),
 reportMin( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 break;
 
 case DRCE_DRILL_OUT_OF_RANGE:
 case DRCE_MICROVIA_DRILL_OUT_OF_RANGE:
 r = m_inspectClearanceDialog->AddPage( _( "Hole Size" ) );
 reportHeader( _( "Hole diameter resolution for:" ), a, r );
 
 if( compileError )
 reportCompileError( r );
 
 constraint = drcEngine.EvalRules( HOLE_SIZE_CONSTRAINT, a, b, layer, r );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved diameter constraints: min %s; max %s." ),
 reportMin( m_frame, constraint ),
 reportMax( m_frame, constraint ) ) );
 break;
 
 case DRCE_HOLE_CLEARANCE:
 r = m_inspectClearanceDialog->AddPage( _( "Hole Clearance" ) );
 reportHeader( _( "Hole clearance resolution for:" ), a, b, r );
 
 if( compileError )
 reportCompileError( r );
 
 if( ac && bc && ac->GetNetCode() == bc->GetNetCode() )
 {
 r->Report( "" );
 r->Report( _( "Items belong to the same net. Clearance is 0." ) );
 }
 else
 {
 constraint = drcEngine.EvalRules( HOLE_CLEARANCE_CONSTRAINT, a, b, layer, r );
 clearance = constraint.m_Value.Min();
 clearanceStr = m_frame->StringFromValue( clearance, true );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ), clearanceStr ) );
 }
 
 r->Report( "" );
 r->Report( "" );
 r->Report( "" );
 reportHeader( _( "Physical hole clearance resolution for:" ), a, b, layer, r );
 
 constraint = drcEngine.EvalRules( PHYSICAL_HOLE_CLEARANCE_CONSTRAINT, a, b, layer, r );
 clearance = constraint.m_Value.Min();
 clearanceStr = m_frame->StringFromValue( clearance, true );
 
 if( !drcEngine.HasRulesForConstraintType( PHYSICAL_HOLE_CLEARANCE_CONSTRAINT ) )
 {
 r->Report( "" );
 r->Report( _( "No 'physical_hole_clearance' constraints defined." ) );
 }
 else
 {
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ), clearanceStr ) );
 }
 
 break;
 
 case DRCE_DRILLED_HOLES_TOO_CLOSE:
 r = m_inspectClearanceDialog->AddPage( _( "Hole to Hole" ) );
 reportHeader( _( "Hole to hole clearance resolution for:" ), a, b, r );
 
 if( compileError )
 reportCompileError( r );
 
 constraint = drcEngine.EvalRules( HOLE_TO_HOLE_CONSTRAINT, a, b, UNDEFINED_LAYER, r );
 clearance = constraint.m_Value.Min();
 clearanceStr = m_frame->StringFromValue( clearance, true );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ), clearanceStr ) );
 break;
 
 case DRCE_EDGE_CLEARANCE:
 r = m_inspectClearanceDialog->AddPage( _( "Edge Clearance" ) );
 reportHeader( _( "Edge clearance resolution for:" ), a, b, r );
 
 if( compileError )
 reportCompileError( r );
 
 constraint = drcEngine.EvalRules( EDGE_CLEARANCE_CONSTRAINT, a, b, layer, r );
 clearance = constraint.m_Value.Min();
 clearanceStr = m_frame->StringFromValue( clearance, true );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ), clearanceStr ) );
 break;
 
 case DRCE_CLEARANCE:
 if( a->Type() == PCB_TRACE_T || a->Type() == PCB_ARC_T )
 {
 layer = a->GetLayer();
 }
 else if( b->Type() == PCB_TRACE_T || b->Type() == PCB_ARC_T )
 {
 layer = b->GetLayer();
 }
 else if( a->Type() == PCB_PAD_T && static_cast<PAD*>( a )->GetAttribute() == PAD_ATTRIB::SMD )
 {
 PAD* pad = static_cast<PAD*>( a );
 
 if( pad->IsOnLayer( F_Cu ) )
 layer = F_Cu;
 else
 layer = B_Cu;
 }
 else if( b->Type() == PCB_PAD_T && static_cast<PAD*>( a )->GetAttribute() == PAD_ATTRIB::SMD )
 {
 PAD* pad = static_cast<PAD*>( b );
 
 if( pad->IsOnLayer( F_Cu ) )
 layer = F_Cu;
 else
 layer = B_Cu;
 }
 
 r = m_inspectClearanceDialog->AddPage( _( "Clearance" ) );
 reportHeader( _( "Clearance resolution for:" ), a, b, layer, r );
 
 if( compileError )
 reportCompileError( r );
 
 if( ac && bc && ac->GetNetCode() == bc->GetNetCode() )
 {
 r->Report( "" );
 r->Report( _( "Items belong to the same net. Clearance is 0." ) );
 }
 else
 {
 constraint = drcEngine.EvalRules( CLEARANCE_CONSTRAINT, a, a, layer, r );
 clearance = constraint.m_Value.Min();
 clearanceStr = m_frame->StringFromValue( clearance, true );
 
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ), clearanceStr ) );
 }
 
 r->Report( "" );
 r->Report( "" );
 r->Report( "" );
 reportHeader( _( "Physical clearance resolution for:" ), a, b, layer, r );
 
 constraint = drcEngine.EvalRules( PHYSICAL_CLEARANCE_CONSTRAINT, a, b, layer, r );
 clearance = constraint.m_Value.Min();
 clearanceStr = m_frame->StringFromValue( clearance, true );
 
 if( !drcEngine.HasRulesForConstraintType( PHYSICAL_CLEARANCE_CONSTRAINT ) )
 {
 r->Report( "" );
 r->Report( _( "No 'physical_clearance' constraints defined." ) );
 }
 else
 {
 r->Report( "" );
 r->Report( wxString::Format( _( "Resolved clearance: %s." ), clearanceStr ) );
 }
 
 break;
 
 default:
 return;
 }
 
 r->Flush();
 
 m_inspectClearanceDialog->Raise();
 m_inspectClearanceDialog->Show( true );
}

References _, ANNULAR_WIDTH_CONSTRAINT, B_Cu, CLEARANCE_CONSTRAINT, CONNECTION_WIDTH_CONSTRAINT, DIFF_PAIR_MAX_UNCOUPLED_CONSTRAINT, DRCE_ANNULAR_WIDTH, DRCE_CLEARANCE, DRCE_CONNECTION_WIDTH, DRCE_DIFF_PAIR_UNCOUPLED_LENGTH_TOO_LONG, DRCE_DRILL_OUT_OF_RANGE, DRCE_DRILLED_HOLES_TOO_CLOSE, DRCE_EDGE_CLEARANCE, DRCE_HOLE_CLEARANCE, DRCE_MICROVIA_DRILL_OUT_OF_RANGE, DRCE_TEXT_HEIGHT, DRCE_TEXT_THICKNESS, DRCE_TRACK_WIDTH, DRCE_VIA_DIAMETER, EDGE_CLEARANCE_CONSTRAINT, DRC_ENGINE::EvalRules(), F_Cu, WX_HTML_REPORT_BOX::Flush(), Format(), PCB_BASE_FRAME::GetActiveLayer(), PAD::GetAttribute(), PCB_BASE_FRAME::GetBoard(), BOARD::GetItem(), BOARD_ITEM::GetLayer(), BOARD_CONNECTED_ITEM::GetNetCode(), DRC_ENGINE::HasRulesForConstraintType(), HOLE_CLEARANCE_CONSTRAINT, HOLE_SIZE_CONSTRAINT, HOLE_TO_HOLE_CONSTRAINT, m_frame, m_inspectClearanceDialog, DRC_CONSTRAINT::m_Value, makeDRCEngine(), MINOPTMAX< T >::Min(), onInspectClearanceDialogClosed(), pad, PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PHYSICAL_CLEARANCE_CONSTRAINT, PHYSICAL_HOLE_CLEARANCE_CONSTRAINT, WX_HTML_REPORT_BOX::Report(), reportCompileError(), reportHeader(), reportMax(), reportMin(), SMD, UNITS_PROVIDER::StringFromValue(), TEXT_HEIGHT_CONSTRAINT, TEXT_THICKNESS_CONSTRAINT, TRACK_WIDTH_CONSTRAINT, EDA_ITEM::Type(), UNDEFINED_LAYER, and VIA_DIAMETER_CONSTRAINT.

Referenced by DIALOG_DRC::OnDRCItemRClick().

Is45Limited()

bool PCB_TOOL_BASE::Is45Limited ( ) const

virtualinherited

Should the tool use its 45° mode option?

Returns

True if set to use 45°

Definition at line 332 of file pcb_tool_base.cpp.

{
 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 
 if( frame()->IsType( FRAME_PCB_EDITOR ) )
 return mgr.GetAppSettings<PCBNEW_SETTINGS>()->m_Use45DegreeLimit;
 else
 return mgr.GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>()->m_Use45Limit;
}

References PCB_TOOL_BASE::frame(), FRAME_PCB_EDITOR, SETTINGS_MANAGER::GetAppSettings(), and Pgm().

Referenced by DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), and ZONE_CREATE_HELPER::OnFirstPoint().

IsBoardEditor()

bool PCB_TOOL_BASE::IsBoardEditor ( ) const

inlineinherited

Definition at line 109 of file pcb_tool_base.h.

{ return m_isBoardEditor; }

References PCB_TOOL_BASE::m_isBoardEditor.

Referenced by BOARD_COMMIT::BOARD_COMMIT().

IsFootprintEditor()

bool PCB_TOOL_BASE::IsFootprintEditor ( ) const

inlineinherited

Definition at line 106 of file pcb_tool_base.h.

{ return m_isFootprintEditor; }

References PCB_TOOL_BASE::m_isFootprintEditor.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Flip(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), PCB_GRID_HELPER::queryVisible(), and EDIT_TOOL::Rotate().

IsNetHighlightSet()

bool BOARD_INSPECTION_TOOL::IsNetHighlightSet ( ) const

inline

Returns

true if a net or nets to highlight have been set

Definition at line 94 of file board_inspection_tool.h.

 {
 return !m_currentlyHighlighted.empty();
 }

References m_currentlyHighlighted.

Referenced by PCB_EDIT_FRAME::setupUIConditions().

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

ListNets()

int BOARD_INSPECTION_TOOL::ListNets

(

const TOOL_EVENT &

aEvent

)

Hide the ratsnest for a given net.

Definition at line 1739 of file board_inspection_tool.cpp.

{
 if( m_listNetsDialog == nullptr )
 {
 m_listNetsDialog =
 std::make_unique<DIALOG_NET_INSPECTOR>( m_frame, m_listNetsDialogSettings );
 
 m_listNetsDialog->Connect( wxEVT_CLOSE_WINDOW,
 wxCommandEventHandler( BOARD_INSPECTION_TOOL::onListNetsDialogClosed ), nullptr,
 this );
 
 m_listNetsDialog->Connect( wxEVT_BUTTON,
 wxCommandEventHandler( BOARD_INSPECTION_TOOL::onListNetsDialogClosed ), nullptr,
 this );
 }
 
 m_listNetsDialog->Raise();
 m_listNetsDialog->Show( true );
 return 0;
}

References m_frame, m_listNetsDialog, m_listNetsDialogSettings, and onListNetsDialogClosed().

Referenced by setTransitions().

LocalRatsnestTool()

int BOARD_INSPECTION_TOOL::LocalRatsnestTool

(

const TOOL_EVENT &

aEvent

)

Definition at line 1550 of file board_inspection_tool.cpp.

{
 PCB_PICKER_TOOL* picker = m_toolMgr->GetTool<PCB_PICKER_TOOL>();
 BOARD* board = getModel<BOARD>();
 
 // Deactivate other tools; particularly important if another PICKER is currently running
 Activate();
 
 picker->SetCursor( KICURSOR::BULLSEYE );
 
 picker->SetClickHandler(
 [this, board]( const VECTOR2D& pt ) -> bool
 {
 PCB_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 m_toolMgr->RunAction( PCB_ACTIONS::selectionCursor, true, EDIT_TOOL::PadFilter );
 PCB_SELECTION& selection = selectionTool->GetSelection();
 
 if( selection.Empty() )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectionCursor, true,
 EDIT_TOOL::FootprintFilter );
 selection = selectionTool->GetSelection();
 }
 
 if( selection.Empty() )
 {
 // Clear the previous local ratsnest if we click off all items
 for( FOOTPRINT* fp : board->Footprints() )
 {
 for( PAD* pad : fp->Pads() )
 pad->SetLocalRatsnestVisible( displayOptions().m_ShowGlobalRatsnest );
 }
 }
 else
 {
 for( EDA_ITEM* item : selection )
 {
 if( PAD* pad = dyn_cast<PAD*>( item) )
 {
 pad->SetLocalRatsnestVisible( !pad->GetLocalRatsnestVisible() );
 }
 else if( FOOTPRINT* fp = dyn_cast<FOOTPRINT*>( item) )
 {
 if( !fp->Pads().empty() )
 {
 bool enable = !fp->Pads()[0]->GetLocalRatsnestVisible();
 
 for( PAD* childPad : fp->Pads() )
 childPad->SetLocalRatsnestVisible( enable );
 }
 }
 }
 }
 
 m_toolMgr->GetView()->MarkTargetDirty( KIGFX::TARGET_OVERLAY );
 
 return true;
 } );
 
 picker->SetFinalizeHandler(
 [this, board]( int aCondition )
 {
 if( aCondition != PCB_PICKER_TOOL::END_ACTIVATE )
 {
 for( FOOTPRINT* fp : board->Footprints() )
 {
 for( PAD* pad : fp->Pads() )
 pad->SetLocalRatsnestVisible( displayOptions().m_ShowGlobalRatsnest );
 }
 }
 } );
 
 m_toolMgr->RunAction( ACTIONS::pickerTool, true );
 
 return 0;
}

References TOOL_INTERACTIVE::Activate(), PCB_TOOL_BASE::board(), BULLSEYE, PCB_TOOL_BASE::displayOptions(), SELECTION::Empty(), PICKER_TOOL_BASE::END_ACTIVATE, EDIT_TOOL::FootprintFilter(), BOARD::Footprints(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), TOOL_MANAGER::GetView(), TOOL_BASE::m_toolMgr, KIGFX::VIEW::MarkTargetDirty(), pad, EDIT_TOOL::PadFilter(), ACTIONS::pickerTool, TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectionCursor, PICKER_TOOL_BASE::SetClickHandler(), PICKER_TOOL_BASE::SetCursor(), PICKER_TOOL_BASE::SetFinalizeHandler(), and KIGFX::TARGET_OVERLAY.

Referenced by setTransitions().

makeDRCEngine()

DRC_ENGINE BOARD_INSPECTION_TOOL::makeDRCEngine ( bool *  aCompileError, bool *  aCourtyardError = nullptr  )

private

Definition at line 113 of file board_inspection_tool.cpp.

{
 DRC_ENGINE engine( m_frame->GetBoard(), &m_frame->GetBoard()->GetDesignSettings() );
 
 try
 {
 engine.InitEngine( m_frame->GetDesignRulesPath() );
 }
 catch( PARSE_ERROR& )
 {
 if( aCompileError )
 *aCompileError = true;
 }
 
 for( ZONE* zone : m_frame->GetBoard()->Zones() )
 zone->CacheBoundingBox();
 
 for( FOOTPRINT* footprint : m_frame->GetBoard()->Footprints() )
 {
 for( ZONE* zone : footprint->Zones() )
 zone->CacheBoundingBox();
 
 footprint->BuildCourtyardCaches();
 
 if( aCourtyardError && ( footprint->GetFlags() & MALFORMED_COURTYARDS ) != 0 )
 *aCourtyardError = true;
 }
 
 return engine;
}

References FOOTPRINT::BuildCourtyardCaches(), PCB_TOOL_BASE::footprint(), BOARD::Footprints(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), BOARD::GetDesignSettings(), EDA_ITEM::GetFlags(), DRC_ENGINE::InitEngine(), m_frame, MALFORMED_COURTYARDS, BOARD::Zones(), and FOOTPRINT::Zones().

Referenced by InspectClearance(), InspectConstraints(), and InspectDRCError().

onInspectClearanceDialogClosed()

void BOARD_INSPECTION_TOOL::onInspectClearanceDialogClosed ( wxCommandEvent &  aEvent )

private

Definition at line 1776 of file board_inspection_tool.cpp.

{
 m_inspectClearanceDialog->Disconnect( wxEVT_CLOSE_WINDOW,
 wxCommandEventHandler( BOARD_INSPECTION_TOOL::onInspectClearanceDialogClosed ),
 nullptr, this );
 
 m_inspectClearanceDialog->Destroy();
 m_inspectClearanceDialog.release();
}

References m_inspectClearanceDialog, and onInspectClearanceDialogClosed().

Referenced by InspectClearance(), InspectDRCError(), and onInspectClearanceDialogClosed().

onInspectConstraintsDialogClosed()

void BOARD_INSPECTION_TOOL::onInspectConstraintsDialogClosed ( wxCommandEvent &  aEvent )

private

Definition at line 1787 of file board_inspection_tool.cpp.

{
 m_inspectConstraintsDialog->Disconnect( wxEVT_CLOSE_WINDOW,
 wxCommandEventHandler( BOARD_INSPECTION_TOOL::onInspectConstraintsDialogClosed ),
 nullptr, this );
 
 m_inspectConstraintsDialog->Destroy();
 m_inspectConstraintsDialog.release();
}

References m_inspectConstraintsDialog, and onInspectConstraintsDialogClosed().

Referenced by InspectConstraints(), and onInspectConstraintsDialogClosed().

onListNetsDialogClosed()

void BOARD_INSPECTION_TOOL::onListNetsDialogClosed ( wxCommandEvent &  aEvent )

private

Definition at line 1761 of file board_inspection_tool.cpp.

{
 m_listNetsDialogSettings = m_listNetsDialog->Settings();
 
 m_listNetsDialog->Disconnect( wxEVT_CLOSE_WINDOW,
 wxCommandEventHandler( BOARD_INSPECTION_TOOL::onListNetsDialogClosed ), nullptr, this );
 
 m_listNetsDialog->Disconnect( wxEVT_BUTTON,
 wxCommandEventHandler( BOARD_INSPECTION_TOOL::onListNetsDialogClosed ), nullptr, this );
 
 m_listNetsDialog->Destroy();
 m_listNetsDialog.release();
}

References m_listNetsDialog, m_listNetsDialogSettings, and onListNetsDialogClosed().

Referenced by ListNets(), and onListNetsDialogClosed().

reportCompileError()

void BOARD_INSPECTION_TOOL::reportCompileError ( REPORTER *  r )

private

Definition at line 172 of file board_inspection_tool.cpp.

{
 r->Report( "" );
 r->Report( _( "Report incomplete: could not compile custom design rules. " )
 + wxT( "<a href='boardsetup'>" ) + _( "Show design rules." ) + wxT( "</a>" ) );
}

References _, and REPORTER::Report().

Referenced by InspectClearance(), InspectConstraints(), and InspectDRCError().

reportHeader() [1/3]

void BOARD_INSPECTION_TOOL::reportHeader ( const wxString &  aTitle, BOARD_ITEM *  a, BOARD_ITEM *  b, PCB_LAYER_ID  aLayer, REPORTER *  r  )

private

Definition at line 196 of file board_inspection_tool.cpp.

{
 wxString layerStr = _( "Layer" ) + wxS( " " ) + m_frame->GetBoard()->GetLayerName( aLayer );
 
 r->Report( wxT( "<h7>" ) + EscapeHTML( aTitle ) + wxT( "</h7>" ) );
 r->Report( wxT( "<ul><li>" ) + EscapeHTML( layerStr ) + wxT( "</li>" )
 + wxT( "<li>" ) + EscapeHTML( getItemDescription( a ) ) + wxT( "</li>" )
 + wxT( "<li>" ) + EscapeHTML( getItemDescription( b ) ) + wxT( "</li></ul>" ) );
}

References _, EscapeHTML(), PCB_BASE_FRAME::GetBoard(), getItemDescription(), BOARD::GetLayerName(), m_frame, and REPORTER::Report().

reportHeader() [2/3]

void BOARD_INSPECTION_TOOL::reportHeader ( const wxString &  aTitle, BOARD_ITEM *  a, BOARD_ITEM *  b, REPORTER *  r  )

private

Definition at line 187 of file board_inspection_tool.cpp.

{
 r->Report( wxT( "<h7>" ) + EscapeHTML( aTitle ) + wxT( "</h7>" ) );
 r->Report( wxT( "<ul><li>" ) + EscapeHTML( getItemDescription( a ) ) + wxT( "</li>" )
 + wxT( "<li>" ) + EscapeHTML( getItemDescription( b ) ) + wxT( "</li></ul>" ) );
}

References EscapeHTML(), getItemDescription(), and REPORTER::Report().

reportHeader() [3/3]

void BOARD_INSPECTION_TOOL::reportHeader ( const wxString &  aTitle, BOARD_ITEM *  a, REPORTER *  r  )

private

Definition at line 180 of file board_inspection_tool.cpp.

{
 r->Report( wxT( "<h7>" ) + EscapeHTML( aTitle ) + wxT( "</h7>" ) );
 r->Report( wxT( "<ul><li>" ) + EscapeHTML( getItemDescription( a ) ) + wxT( "</li></ul>" ) );
}

References EscapeHTML(), getItemDescription(), and REPORTER::Report().

Referenced by InspectClearance(), InspectConstraints(), and InspectDRCError().

Reset()

void BOARD_INSPECTION_TOOL::Reset ( RESET_REASON  aReason )

overridevirtual

Bring the tool to a known, initial state.

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

Parameters

aReason

contains information about the reason of tool reset.

Reimplemented from PCB_TOOL_BASE.

Definition at line 99 of file board_inspection_tool.cpp.

{
 m_frame = getEditFrame<PCB_EDIT_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().

selection() [1/2]

PCB_SELECTION & PCB_TOOL_BASE::selection ( )

protectedinherited

Definition at line 324 of file pcb_tool_base.cpp.

{
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 
 return selTool->GetSelection();
}

References PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), and TOOL_BASE::m_toolMgr.

selection() [2/2]

const PCB_SELECTION & PCB_TOOL_BASE::selection ( ) const

protectedinherited

Definition at line 316 of file pcb_tool_base.cpp.

{
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 
 return selTool->GetSelection();
}

References PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), and TOOL_BASE::m_toolMgr.

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), AUTOPLACE_TOOL::autoplaceSelected(), calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), EDIT_TOOL::ChangeTrackWidth(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), DRC_TOOL::CrossProbe(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), GROUP_TOOL::EnterGroup(), PAD_TOOL::EnumeratePads(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), EDIT_TOOL::FilletLines(), EDIT_TOOL::FilletTracks(), EDIT_TOOL::Flip(), DRAWING_TOOL::getSourceZoneForAction(), GROUP_TOOL::Group(), highlightNet(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), InspectClearance(), InspectConstraints(), DRAWING_TOOL::InteractivePlaceWithPreview(), LocalRatsnestTool(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::OnSelectionChange(), EDIT_TOOL::PackAndMoveFootprints(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), BOARD_REANNOTATE_TOOL::ReannotateDuplicatesInSelection(), GROUP_TOOL::RemoveFromGroup(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), DRAWING_TOOL::SetAnchor(), EDIT_TOOL::Swap(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), GROUP_TOOL::Ungroup(), UpdateLocalRatsnest(), PCB_CONTROL::UpdateMessagePanel(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), BOARD_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfill().

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

SetIsBoardEditor()

void PCB_TOOL_BASE::SetIsBoardEditor ( bool  aEnabled )

inlineinherited

Definition at line 108 of file pcb_tool_base.h.

{ m_isBoardEditor = aEnabled; }

References PCB_TOOL_BASE::m_isBoardEditor.

SetIsFootprintEditor()

void PCB_TOOL_BASE::SetIsFootprintEditor ( bool  aEnabled )

inlineinherited

Function SetIsFootprintEditor()

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

Parameters

aEnabled

decides if the mode should be enabled.

Definition at line 105 of file pcb_tool_base.h.

{ m_isFootprintEditor = aEnabled; }

References PCB_TOOL_BASE::m_isFootprintEditor.

setTransitions()

void BOARD_INSPECTION_TOOL::setTransitions ( )

overrideprivatevirtual

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

It is called every time tool is reset or finished.

Reimplemented from PCB_TOOL_BASE.

Definition at line 1846 of file board_inspection_tool.cpp.

{
 Go( &BOARD_INSPECTION_TOOL::LocalRatsnestTool, PCB_ACTIONS::localRatsnestTool.MakeEvent() );
 Go( &BOARD_INSPECTION_TOOL::HideLocalRatsnest, PCB_ACTIONS::hideLocalRatsnest.MakeEvent() );
 Go( &BOARD_INSPECTION_TOOL::UpdateLocalRatsnest, PCB_ACTIONS::updateLocalRatsnest.MakeEvent() );
 
 Go( &BOARD_INSPECTION_TOOL::ListNets, PCB_ACTIONS::listNets.MakeEvent() );
 Go( &BOARD_INSPECTION_TOOL::ShowBoardStatistics, PCB_ACTIONS::boardStatistics.MakeEvent() );
 Go( &BOARD_INSPECTION_TOOL::InspectClearance, PCB_ACTIONS::inspectClearance.MakeEvent() );
 Go( &BOARD_INSPECTION_TOOL::InspectConstraints, PCB_ACTIONS::inspectConstraints.MakeEvent() );
 
 Go( &BOARD_INSPECTION_TOOL::HighlightNet, PCB_ACTIONS::highlightNet.MakeEvent() );
 Go( &BOARD_INSPECTION_TOOL::HighlightNet, PCB_ACTIONS::highlightNetSelection.MakeEvent() );
 Go( &BOARD_INSPECTION_TOOL::HighlightNet, PCB_ACTIONS::toggleLastNetHighlight.MakeEvent() );
 Go( &BOARD_INSPECTION_TOOL::ClearHighlight, PCB_ACTIONS::clearHighlight.MakeEvent() );
 Go( &BOARD_INSPECTION_TOOL::HighlightNet, PCB_ACTIONS::toggleNetHighlight.MakeEvent() );
 Go( &BOARD_INSPECTION_TOOL::HighlightItem, PCB_ACTIONS::highlightItem.MakeEvent() );
 
 Go( &BOARD_INSPECTION_TOOL::HideNetInRatsnest, PCB_ACTIONS::hideNetInRatsnest.MakeEvent() );
 Go( &BOARD_INSPECTION_TOOL::ShowNetInRatsnest, PCB_ACTIONS::showNetInRatsnest.MakeEvent() );
}

References PCB_ACTIONS::boardStatistics, ClearHighlight(), PCB_ACTIONS::clearHighlight, TOOL_INTERACTIVE::Go(), HideLocalRatsnest(), PCB_ACTIONS::hideLocalRatsnest, HideNetInRatsnest(), PCB_ACTIONS::hideNetInRatsnest, HighlightItem(), PCB_ACTIONS::highlightItem, HighlightNet(), PCB_ACTIONS::highlightNet, PCB_ACTIONS::highlightNetSelection, InspectClearance(), PCB_ACTIONS::inspectClearance, InspectConstraints(), PCB_ACTIONS::inspectConstraints, ListNets(), PCB_ACTIONS::listNets, LocalRatsnestTool(), PCB_ACTIONS::localRatsnestTool, ShowBoardStatistics(), ShowNetInRatsnest(), PCB_ACTIONS::showNetInRatsnest, PCB_ACTIONS::toggleLastNetHighlight, PCB_ACTIONS::toggleNetHighlight, UpdateLocalRatsnest(), and PCB_ACTIONS::updateLocalRatsnest.

ShowBoardStatistics()

int BOARD_INSPECTION_TOOL::ShowBoardStatistics

(

const TOOL_EVENT &

aEvent

)

Show dialog with board statistics.

Highlight net belonging to the item under the cursor.

Definition at line 105 of file board_inspection_tool.cpp.

{
 DIALOG_BOARD_STATISTICS dialog( m_frame );
 dialog.ShowModal();
 return 0;
}

References m_frame.

Referenced by setTransitions().

ShowNetInRatsnest()

int BOARD_INSPECTION_TOOL::ShowNetInRatsnest

(

const TOOL_EVENT &

aEvent

)

Definition at line 1805 of file board_inspection_tool.cpp.

{
 doHideRatsnestNet( aEvent.Parameter<intptr_t>(), false );
 return 0;
}

References doHideRatsnestNet(), and TOOL_EVENT::Parameter().

Referenced by setTransitions().

UpdateLocalRatsnest()

int BOARD_INSPECTION_TOOL::UpdateLocalRatsnest

(

const TOOL_EVENT &

aEvent

)

Hide ratsnest for selected items. Called when there are no items selected.

Definition at line 1630 of file board_inspection_tool.cpp.

{
 VECTOR2I delta;
 
 // If we have passed the simple move vector, we can update without recalculation
 if( aEvent.Parameter<VECTOR2I*>() )
 {
 delta = *aEvent.Parameter<VECTOR2I*>();
 delete aEvent.Parameter<VECTOR2I*>();
 }
 else
 {
 // We can delete the existing map to force a recalculation
 delete m_dynamicData;
 m_dynamicData = nullptr;
 }
 
 auto selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 auto& selection = selectionTool->GetSelection();
 auto connectivity = getModel<BOARD>()->GetConnectivity();
 
 if( selection.Empty() )
 {
 connectivity->ClearLocalRatsnest();
 delete m_dynamicData;
 m_dynamicData = nullptr;
 }
 else
 {
 calculateSelectionRatsnest( delta );
 }
 
 return 0;
}

References calculateSelectionRatsnest(), delta, SELECTION::Empty(), TOOL_MANAGER::GetTool(), m_dynamicData, TOOL_BASE::m_toolMgr, TOOL_EVENT::Parameter(), and PCB_TOOL_BASE::selection().

Referenced by setTransitions().

view()

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

inlineprotectedinherited

Definition at line 155 of file pcb_tool_base.h.

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

References TOOL_BASE::getView().

Referenced by AUTOPLACE_TOOL::autoplace(), PCB_TOOL_BASE::doInteractiveItemPlacement(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), PCB_CONTROL::FlipPcbView(), ROUTER_TOOL::handleLayerSwitch(), highlightNet(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), PCB_CONTROL::TrackDisplayMode(), PCB_POINT_EDITOR::updateItem(), PCB_CONTROL::ViaDisplayMode(), and PCB_CONTROL::ZoneDisplayMode().

Wait()

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

inherited

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

No parameters means waiting for any event.

Definition at line 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_currentlyHighlighted

std::set<int> BOARD_INSPECTION_TOOL::m_currentlyHighlighted

private

Definition at line 134 of file board_inspection_tool.h.

Referenced by ClearHighlight(), HighlightNet(), highlightNet(), and IsNetHighlightSet().

m_dynamicData

CONNECTIVITY_DATA* BOARD_INSPECTION_TOOL::m_dynamicData

private

Definition at line 137 of file board_inspection_tool.h.

Referenced by BOARD_INSPECTION_TOOL(), calculateSelectionRatsnest(), HideLocalRatsnest(), and UpdateLocalRatsnest().

m_frame

PCB_EDIT_FRAME* BOARD_INSPECTION_TOOL::m_frame

private

Definition at line 132 of file board_inspection_tool.h.

Referenced by ClearHighlight(), doHideRatsnestNet(), getItemDescription(), HighlightItem(), highlightNet(), InspectClearance(), InspectConstraints(), InspectDRCError(), ListNets(), makeDRCEngine(), reportHeader(), Reset(), and ShowBoardStatistics().

m_inspectClearanceDialog

std::unique_ptr<DIALOG_CONSTRAINTS_REPORTER> BOARD_INSPECTION_TOOL::m_inspectClearanceDialog

private

Definition at line 142 of file board_inspection_tool.h.

Referenced by InspectClearance(), InspectDRCError(), and onInspectClearanceDialogClosed().

m_inspectConstraintsDialog

std::unique_ptr<DIALOG_CONSTRAINTS_REPORTER> BOARD_INSPECTION_TOOL::m_inspectConstraintsDialog

private

Definition at line 143 of file board_inspection_tool.h.

Referenced by InspectConstraints(), and onInspectConstraintsDialogClosed().

m_isBoardEditor

bool PCB_TOOL_BASE::m_isBoardEditor

protectedinherited

Definition at line 187 of file pcb_tool_base.h.

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

m_isFootprintEditor

bool PCB_TOOL_BASE::m_isFootprintEditor

protectedinherited

Definition at line 186 of file pcb_tool_base.h.

Referenced by ZONE_CREATE_HELPER::commitZone(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), ZONE_CREATE_HELPER::createNewZone(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), EDIT_TOOL::Duplicate(), PCB_CONTROL::GridSetOrigin(), GROUP_TOOL::Group(), EDIT_TOOL::Init(), PAD_TOOL::Init(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_TOOL_BASE::IsFootprintEditor(), PCB_POINT_EDITOR::makePoints(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelative(), PCB_CONTROL::Print(), PCB_CONTROL::pruneItemLayers(), SCRIPTING_TOOL::reloadPlugins(), EDIT_TOOL::Rotate(), DRAWING_TOOL::SetAnchor(), PCB_TOOL_BASE::SetIsFootprintEditor(), and GROUP_TOOL::Ungroup().

m_lastHighlighted

std::set<int> BOARD_INSPECTION_TOOL::m_lastHighlighted

private

Definition at line 135 of file board_inspection_tool.h.

Referenced by ClearHighlight(), and HighlightNet().

m_listNetsDialog

std::unique_ptr<DIALOG_NET_INSPECTOR> BOARD_INSPECTION_TOOL::m_listNetsDialog

private

Definition at line 139 of file board_inspection_tool.h.

Referenced by ListNets(), and onListNetsDialogClosed().

m_listNetsDialogSettings

DIALOG_NET_INSPECTOR::SETTINGS BOARD_INSPECTION_TOOL::m_listNetsDialogSettings

private

Definition at line 140 of file board_inspection_tool.h.

Referenced by ListNets(), and onListNetsDialogClosed().

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(), 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(), 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(), 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(), HighlightItem(), SCH_EDITOR_CONTROL::HighlightNet(), HighlightNet(), 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(), 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(), InspectClearance(), InspectConstraints(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), TOOL_BASE::IsToolActive(), GROUP_TOOL::LeaveGroup(), 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(), 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(), 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:

• board_inspection_tool.h
• board_inspection_tool.cpp