EDIT_TOOL Class Reference

The interactive edit tool. More...

#include <edit_tool.h>

Inheritance diagram for EDIT_TOOL:

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

Public Member Functions
	EDIT_TOOL ()
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state. More...
bool	Init () override
	Init() is called once upon a registration of the tool. More...
int	GetAndPlace (const TOOL_EVENT &aEvent)
int	Move (const TOOL_EVENT &aEvent)
	Main loop in which events are handled. More...
int	Drag (const TOOL_EVENT &aEvent)
	Invoke the PNS router to drag tracks or do an offline resizing of an arc track if a single arc track is selected. More...
int	DragArcTrack (const TOOL_EVENT &aTrack)
	Drag-resize an arc (and change end points of connected straight segments). More...
int	Properties (const TOOL_EVENT &aEvent)
	Display properties window for the selected object. More...
int	Rotate (const TOOL_EVENT &aEvent)
	Rotate currently selected items. More...
int	Flip (const TOOL_EVENT &aEvent)
	Rotate currently selected items. More...
int	Mirror (const TOOL_EVENT &aEvent)
	Mirror the current selection. More...
int	Swap (const TOOL_EVENT &aEvent)
	Swap currently selected items' positions. More...
int	PackAndMoveFootprints (const TOOL_EVENT &aEvent)
	Try to fit selected footprints inside a minimal area and start movement. More...
int	ChangeTrackWidth (const TOOL_EVENT &aEvent)
int	FilletTracks (const TOOL_EVENT &aEvent)
	Fillet (i.e. More...
int	FilletLines (const TOOL_EVENT &aEvent)
	Fillet (i.e. More...
int	Remove (const TOOL_EVENT &aEvent)
	Delete currently selected items. More...
void	DeleteItems (const PCB_SELECTION &aItems, bool aIsCut)
int	Duplicate (const TOOL_EVENT &aEvent)
	Duplicate the current selection and starts a move action. More...
int	MoveExact (const TOOL_EVENT &aEvent)
	Invoke a dialog box to allow moving of the item by an exact amount. More...
int	CreateArray (const TOOL_EVENT &aEvent)
	Create an array of the selected items, invoking the array editor dialog to set the options. More...
BOARD_COMMIT *	GetCurrentCommit () 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

Static Public Member Functions
static void	FootprintFilter (const VECTOR2I &, GENERAL_COLLECTOR &aCollector, PCB_SELECTION_TOOL *sTool)
	A selection filter which prunes the selection to contain only items of type #PCB_MODULE_T. More...
static void	PadFilter (const VECTOR2I &, GENERAL_COLLECTOR &aCollector, PCB_SELECTION_TOOL *sTool)
	A selection filter which prunes the selection to contain only items of type PCB_PAD_T. More...

Static Public Attributes
static const std::vector< KICAD_T >	MirrorableItems

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	setTransitions () override
	< Set up handlers for various events. More...
int	copyToClipboard (const TOOL_EVENT &aEvent)
	Send the current selection to the clipboard by formatting it as a fake pcb see #AppendBoardFromClipboard for importing. More...
int	cutToClipboard (const TOOL_EVENT &aEvent)
	Cut the current selection to the clipboard by formatting it as a fake pcb see #AppendBoardFromClipboard for importing. More...
bool	updateModificationPoint (PCB_SELECTION &aSelection)
bool	invokeInlineRouter (int aDragMode)
bool	isRouterActive () const
int	doMoveSelection (const TOOL_EVENT &aEvent, const wxString &aCommitMessage)
VECTOR2I	getSafeMovement (const VECTOR2I &aMovement, const BOX2I &aSourceBBox, const VECTOR2D &aBBoxOffset)
bool	pickReferencePoint (const wxString &aTooltip, const wxString &aSuccessMessage, const wxString &aCanceledMessage, VECTOR2I &aReferencePoint)
	Rebuilds the ratsnest for operations that require it outside the commit rebuild. More...
void	rebuildConnectivity ()
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_SELECTION_TOOL *	m_selectionTool
std::unique_ptr< BOARD_COMMIT >	m_commit
bool	m_dragging
VECTOR2I	m_cursor
std::unique_ptr< STATUS_TEXT_POPUP >	m_statusPopup

Static Private Attributes
static const unsigned int	COORDS_PADDING = pcbIUScale.mmToIU( 20 )

Detailed Description

The interactive edit tool.

Allows one to move, rotate, flip and change properties of items selected using the pcbnew.InteractiveSelection tool.

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

EDIT_TOOL()

EDIT_TOOL::EDIT_TOOL

(

)

Definition at line 73 of file edit_tool.cpp.

 :
 PCB_TOOL_BASE( "pcbnew.InteractiveEdit" ),
 m_selectionTool( nullptr ),
 m_dragging( false )
{
}

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(), 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(), doMoveSelection(), DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridSetOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), GROUP_TOOL::PickNewMember(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), 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(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ChangeTrackWidth(), ZONE_FILLER_TOOL::CheckAllZones(), BOARD_INSPECTION_TOOL::ClearHighlight(), copyToClipboard(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), MICROWAVE_TOOL::createInductorBetween(), ROUTER_TOOL::CustomTrackWidthDialog(), PCB_CONTROL::DeleteItemCursor(), PCB_TOOL_BASE::doInteractiveItemPlacement(), doMoveSelection(), DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportNetlist(), ZONE_FILLER_TOOL::FillAllZones(), FilletTracks(), PCB_TOOL_BASE::footprint(), GROUP_TOOL::Group(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::highlightNet(), ROUTER_TOOL::Init(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_CONTROL::LayerNext(), PCB_CONTROL::LayerPrev(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), MoveExact(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlaceText(), PCB_CONTROL::pruneItemLayers(), 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().

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(), DeleteItems(), doMoveSelection(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), ZONE_FILLER_TOOL::FillAllZones(), Init(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), LENGTH_TUNER_TOOL::performTuning(), pickReferencePoint(), PCB_CONTROL::RatsnestModeCycle(), rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::refresh(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), 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().

ChangeTrackWidth()

int EDIT_TOOL::ChangeTrackWidth

(

const TOOL_EVENT &

aEvent

)

Definition at line 784 of file edit_tool.cpp.

{
 const PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 // Iterate from the back so we don't have to worry about removals.
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[ i ];
 
 if( !dynamic_cast<PCB_TRACK*>( item ) )
 aCollector.Remove( item );
 }
 },
 true /* prompt user regarding locked items */ );
 
 for( EDA_ITEM* item : selection )
 {
 if( item->Type() == PCB_VIA_T )
 {
 PCB_VIA* via = static_cast<PCB_VIA*>( item );
 
 m_commit->Modify( via );
 
 int new_width;
 int new_drill;
 
 if( via->GetViaType() == VIATYPE::MICROVIA )
  {
 NETCLASS* netClass = via->GetEffectiveNetClass();
 
 new_width = netClass->GetuViaDiameter();
 new_drill = netClass->GetuViaDrill();
 }
 else
 {
 new_width = board()->GetDesignSettings().GetCurrentViaSize();
 new_drill = board()->GetDesignSettings().GetCurrentViaDrill();
 }
 
 via->SetDrill( new_drill );
 via->SetWidth( new_width );
 }
 else if( item->Type() == PCB_TRACE_T || item->Type() == PCB_ARC_T )
 {
 PCB_TRACK* track = dynamic_cast<PCB_TRACK*>( item );
 
 wxCHECK( track, 0 );
 
 m_commit->Modify( track );
 
 int new_width = board()->GetDesignSettings().GetCurrentTrackWidth();
 track->SetWidth( new_width );
 }
 }
 
 m_commit->Push( _( "Edit track width/via size" ) );
 
 if( selection.IsHover() )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 // Notify other tools of the changes -- This updates the visual ratsnest
 m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 }
 
 return 0;
}

References _, PCB_TOOL_BASE::board(), COLLECTOR::GetCount(), BOARD_DESIGN_SETTINGS::GetCurrentTrackWidth(), BOARD_DESIGN_SETTINGS::GetCurrentViaDrill(), BOARD_DESIGN_SETTINGS::GetCurrentViaSize(), BOARD::GetDesignSettings(), NETCLASS::GetuViaDiameter(), NETCLASS::GetuViaDrill(), SELECTION::IsHover(), m_commit, m_selectionTool, TOOL_BASE::m_toolMgr, MICROVIA, PCB_ARC_T, PCB_TRACE_T, PCB_VIA_T, TOOL_MANAGER::ProcessEvent(), PCB_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_TRACK::SetWidth(), and via.

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

copyToClipboard()

int EDIT_TOOL::copyToClipboard ( const TOOL_EVENT &  aEvent )

private

Send the current selection to the clipboard by formatting it as a fake pcb see #AppendBoardFromClipboard for importing.

Definition at line 2497 of file edit_tool.cpp.

{
 CLIPBOARD_IO io;
 PCB_GRID_HELPER grid( m_toolMgr,
 getEditFrame<PCB_BASE_EDIT_FRAME>()->GetMagneticItemsSettings() );
 TOOL_EVENT selectReferencePoint( aEvent.Category(), aEvent.Action(),
 "pcbnew.InteractiveEdit.selectReferencePoint",
 TOOL_ACTION_SCOPE::AS_GLOBAL );
 
 frame()->PushTool( selectReferencePoint );
 Activate();
 
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 // We can't copy both a footprint and its text in the same operation, so if
 // both are selected, remove the text
 if( item->Type() == PCB_FP_TEXT_T && aCollector.HasItem( item->GetParent() ) )
 aCollector.Remove( item );
 }
 },
 
 // Prompt user regarding locked items.
 aEvent.IsAction( &ACTIONS::cut ) && !m_isFootprintEditor );
 
 if( !selection.Empty() )
 {
 std::vector<BOARD_ITEM*> items;
 
 for( EDA_ITEM* item : selection )
 items.push_back( static_cast<BOARD_ITEM*>( item ) );
 
 VECTOR2I refPoint;
 
 if( aEvent.IsAction( &PCB_ACTIONS::copyWithReference ) )
 {
 if( !pickReferencePoint( _( "Select reference point for the copy..." ),
 _( "Selection copied" ),
 _( "Copy canceled" ),
 refPoint ) )
 {
 frame()->PopTool( selectReferencePoint );
 return 0;
 }
 }
 else
 {
 refPoint = grid.BestDragOrigin( getViewControls()->GetCursorPosition(), items );
 }
 
 selection.SetReferencePoint( refPoint );
 
 io.SetBoard( board() );
 io.SaveSelection( selection, m_isFootprintEditor );
 frame()->SetStatusText( _( "Selection copied" ) );
 }
 
 frame()->PopTool( selectReferencePoint );
 
 if( selection.IsHover() )
 m_selectionTool->ClearSelection();
 
 return 0;
}

References _, TOOL_EVENT::Action(), TOOL_INTERACTIVE::Activate(), AS_GLOBAL, PCB_TOOL_BASE::board(), TOOL_EVENT::Category(), PCB_SELECTION_TOOL::ClearSelection(), PCB_ACTIONS::copyWithReference, ACTIONS::cut, SELECTION::Empty(), PCB_TOOL_BASE::frame(), COLLECTOR::GetCount(), TOOL_BASE::getViewControls(), grid, TOOL_EVENT::IsAction(), SELECTION::IsHover(), PCB_TOOL_BASE::m_isFootprintEditor, m_selectionTool, TOOL_BASE::m_toolMgr, pickReferencePoint(), TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), PCB_SELECTION_TOOL::RequestSelection(), CLIPBOARD_IO::SaveSelection(), PCB_TOOL_BASE::selection(), CLIPBOARD_IO::SetBoard(), and SELECTION::SetReferencePoint().

Referenced by cutToClipboard(), and setTransitions().

CreateArray()

int EDIT_TOOL::CreateArray

(

const TOOL_EVENT &

aEvent

)

Create an array of the selected items, invoking the array editor dialog to set the options.

Definition at line 2334 of file edit_tool.cpp.

{
 if( isRouterActive() )
 {
 wxBell();
 return 0;
 }
 
 // Be sure that there is at least one item that we can modify
 const PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I&, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 } );
 
 if( selection.Empty() )
 return 0;
 
 // we have a selection to work on now, so start the tool process
 PCB_BASE_FRAME* editFrame = getEditFrame<PCB_BASE_FRAME>();
 ARRAY_CREATOR array_creator( *editFrame, m_isFootprintEditor, selection, m_toolMgr );
 array_creator.Invoke();
 
 return 0;
}

References SELECTION::Empty(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), ARRAY_CREATOR::Invoke(), isRouterActive(), PCB_TOOL_BASE::m_isFootprintEditor, m_selectionTool, TOOL_BASE::m_toolMgr, PCB_SELECTION_TOOL::RequestSelection(), and PCB_TOOL_BASE::selection().

Referenced by setTransitions().

cutToClipboard()

int EDIT_TOOL::cutToClipboard ( const TOOL_EVENT &  aEvent )

private

Cut the current selection to the clipboard by formatting it as a fake pcb see #AppendBoardFromClipboard for importing.

Return the right modification point (e.g. for rotation), depending on the number of selected items.

Definition at line 2567 of file edit_tool.cpp.

{
 if( !copyToClipboard( aEvent ) )
 {
 // N.B. Setting the CUT flag prevents lock filtering as we only want to delete the items
 // that were copied to the clipboard, no more, no fewer. Filtering for locked item, if
 // any will be done in the copyToClipboard() routine
 TOOL_EVENT evt = aEvent;
 evt.SetParameter( PCB_ACTIONS::REMOVE_FLAGS::CUT );
 Remove( evt );
 }
 
 return 0;
}

References copyToClipboard(), ACTIONS::CUT, Remove(), and TOOL_EVENT::SetParameter().

Referenced by setTransitions().

DeleteItems()

void EDIT_TOOL::DeleteItems	(	const PCB_SELECTION &	aItems,
		bool	aIsCut
	)

Definition at line 1814 of file edit_tool.cpp.

{
 // As we are about to remove items, they have to be removed from the selection first
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 for( EDA_ITEM* item : aItems )
 {
 PCB_GROUP* parentGroup = static_cast<BOARD_ITEM*>( item )->GetParentGroup();
 
 if( parentGroup )
 {
 m_commit->Modify( parentGroup );
 parentGroup->RemoveItem( static_cast<BOARD_ITEM*>( item ) );
 }
 
 switch( item->Type() )
 {
 case PCB_FP_TEXT_T:
 {
 FP_TEXT* text = static_cast<FP_TEXT*>( item );
 FOOTPRINT* parent = static_cast<FOOTPRINT*>( item->GetParent() );
 
 switch( text->GetType() )
 {
 case FP_TEXT::TEXT_is_VALUE:
 case FP_TEXT::TEXT_is_REFERENCE:
 m_commit->Modify( parent );
 text->SetVisible( false );
 getView()->Update( text );
 break;
 case FP_TEXT::TEXT_is_DIVERS:
 m_commit->Modify( parent );
 getView()->Remove( text );
 parent->Remove( text );
 break;
 default:
 wxFAIL; // Shouldn't get here
 break;
 }
 
 break;
 }
 
 case PCB_FP_TEXTBOX_T:
 {
 FP_TEXTBOX* textbox = static_cast<FP_TEXTBOX*>( item );
 FOOTPRINT* parent = static_cast<FOOTPRINT*>( item->GetParent() );
 
 m_commit->Modify( parent );
 getView()->Remove( textbox );
 parent->Remove( textbox );
 break;
 }
 
 case PCB_BITMAP_T:
 if( IsFootprintEditor() )
 {
 PCB_BITMAP* fp_bitmap = static_cast<PCB_BITMAP*>( item );
 FOOTPRINT* parent = static_cast<FOOTPRINT*>( item->GetParent() );
 
 m_commit->Modify( parent );
 getView()->Remove( fp_bitmap );
 parent->Remove( fp_bitmap );
 }
 else
 m_commit->Remove( item );
 
 break;
 
 case PCB_PAD_T:
 if( IsFootprintEditor() || frame()->GetPcbNewSettings()->m_AllowFreePads )
 {
 PAD* pad = static_cast<PAD*>( item );
 FOOTPRINT* parent = static_cast<FOOTPRINT*>( item->GetParent() );
 
 m_commit->Modify( parent );
 getView()->Remove( pad );
 parent->Remove( pad );
 }
 
 break;
 
 case PCB_FP_ZONE_T:
 {
 FP_ZONE* zone = static_cast<FP_ZONE*>( item );
 FOOTPRINT* parent = static_cast<FOOTPRINT*>( item->GetParent() );
 
 m_commit->Modify( parent );
 getView()->Remove( zone );
 parent->Remove( zone );
 break;
 }
 
 case PCB_ZONE_T:
 // We process the zones special so that cutouts can be deleted when the delete tool
 // is called from inside a cutout when the zone is selected.
 {
 // Only interact with cutouts when deleting and a single item is selected
 if( !aIsCut && aItems.GetSize() == 1 )
 {
 VECTOR2I curPos = getViewControls()->GetCursorPosition();
  ZONE* zone = static_cast<ZONE*>( item );
 
 int outlineIdx, holeIdx;
 
 if( zone->HitTestCutout( curPos, &outlineIdx, &holeIdx ) )
 {
 // Remove the cutout
 m_commit->Modify( zone );
 zone->RemoveCutout( outlineIdx, holeIdx );
 zone->UnFill();
 
 // TODO Refill zone when KiCad supports auto re-fill
 
 // Update the display
 zone->HatchBorder();
 canvas()->Refresh();
 
 // Restore the selection on the original zone
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, zone );
 
 break;
 }
 }
 
 // Remove the entire zone otherwise
 m_commit->Remove( item );
 break;
 }
 
 case PCB_GROUP_T:
 {
 PCB_GROUP* group = static_cast<PCB_GROUP*>( item );
 
 auto removeItem =
 [&]( BOARD_ITEM* bItem )
 {
 if( bItem->GetParent() && bItem->GetParent()->Type() == PCB_FOOTPRINT_T )
 {
 // Silently ignore delete of Reference or Value if they happen to be
 // in group.
 if( bItem->Type() == PCB_FP_TEXT_T )
 {
 FP_TEXT* textItem = static_cast<FP_TEXT*>( bItem );
 
 if( textItem->GetType() != FP_TEXT::TEXT_is_DIVERS )
 return;
 }
 else if( bItem->Type() == PCB_PAD_T )
 {
 if( !IsFootprintEditor()
 && !frame()->GetPcbNewSettings()->m_AllowFreePads )
 {
 return;
 }
 }
 
 m_commit->Modify( bItem->GetParent() );
 getView()->Remove( bItem );
 bItem->GetParent()->Remove( bItem );
 }
 else
 {
 m_commit->Remove( bItem );
 }
 };
 
 removeItem( group );
 
 group->RunOnDescendants( [&]( BOARD_ITEM* aDescendant )
 {
 removeItem( aDescendant );
 });
 break;
 }
 
 default:
 m_commit->Remove( item );
 break;
 }
 }
 
 // If the entered group has been emptied then leave it.
 PCB_GROUP* enteredGroup = m_selectionTool->GetEnteredGroup();
 
 if( enteredGroup && enteredGroup->GetItems().empty() )
 m_selectionTool->ExitGroup();
 
 if( aIsCut )
 m_commit->Push( _( "Cut" ) );
 else
 m_commit->Push( _( "Delete" ) );
}

References _, PCB_TOOL_BASE::canvas(), PCB_SELECTION_TOOL::ExitGroup(), PCB_TOOL_BASE::frame(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), PCB_SELECTION_TOOL::GetEnteredGroup(), PCB_GROUP::GetItems(), PCB_BASE_FRAME::GetPcbNewSettings(), SELECTION::GetSize(), FP_TEXT::GetType(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), group, ZONE::HatchBorder(), ZONE::HitTestCutout(), PCB_TOOL_BASE::IsFootprintEditor(), PCBNEW_SETTINGS::m_AllowFreePads, m_commit, m_selectionTool, TOOL_BASE::m_toolMgr, pad, PCB_BITMAP_T, PCB_FOOTPRINT_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_PAD_T, PCB_ZONE_T, EDA_DRAW_PANEL_GAL::Refresh(), FOOTPRINT::Remove(), KIGFX::VIEW::Remove(), ZONE::RemoveCutout(), PCB_GROUP::RemoveItem(), TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItem, text, FP_TEXT::TEXT_is_DIVERS, FP_TEXT::TEXT_is_REFERENCE, FP_TEXT::TEXT_is_VALUE, ZONE::UnFill(), and KIGFX::VIEW::Update().

Referenced by PCB_CONTROL::DeleteItemCursor(), and Remove().

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 BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PCB_CONTROL::RatsnestModeCycle(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), and PCB_CONTROL::ViaDisplayMode().

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

doMoveSelection()

int EDIT_TOOL::doMoveSelection ( const TOOL_EVENT &  aEvent, const wxString &  aCommitMessage  )

private

Definition at line 279 of file edit_tool_move_fct.cpp.

{
 bool moveWithReference = aEvent.IsAction( &PCB_ACTIONS::moveWithReference );
 bool moveIndividually = aEvent.IsAction( &PCB_ACTIONS::moveIndividually );
 
 PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
 PCBNEW_SETTINGS* cfg = editFrame->GetPcbNewSettings();
 BOARD* board = editFrame->GetBoard();
 KIGFX::VIEW_CONTROLS* controls = getViewControls();
 VECTOR2I originalCursorPos = controls->GetCursorPosition();
 STATUS_TEXT_POPUP statusPopup( frame() );
 wxString status;
 size_t itemIdx = 0;
 
 editFrame->PushTool( aEvent );
 
 // Be sure that there is at least one item that we can modify. If nothing was selected before,
 // try looking for the stuff under mouse cursor (i.e. KiCad old-style hover selection)
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 },
 // Prompt user regarding locked items if in board editor and in free-pad-mode (if
 // we're not in free-pad mode we delay this until the second RequestSelection()).
 !m_isFootprintEditor && cfg->m_AllowFreePads );
 
 if( m_dragging || selection.Empty() )
 {
 editFrame->PopTool( aEvent );
 return 0;
 }
 
 LSET item_layers = selection.GetSelectionLayers();
 bool is_hover = selection.IsHover(); // N.B. This must be saved before the second call
 // to RequestSelection() below
 VECTOR2I pickedReferencePoint;
 
 // Now filter out pads if not in free pads mode. We cannot do this in the first
 // RequestSelection() as we need the item_layers when a pad is the selection front.
 if( !m_isFootprintEditor && !cfg->m_AllowFreePads )
 {
 selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 sTool->FilterCollectorForFreePads( aCollector );
 },
 true /* prompt user regarding locked items */ );
 }
 
 if( selection.Empty() )
 {
 editFrame->PopTool( aEvent );
 return 0;
 }
 
 Activate();
 // Must be done after Activate() so that it gets set into the correct context
 controls->ShowCursor( true );
 controls->SetAutoPan( true );
 controls->ForceCursorPosition( false );
 
 auto displayConstraintsMessage =
 [editFrame]( bool constrained )
 {
 editFrame->DisplayConstraintsMsg( constrained ? _( "Constrain to H, V, 45" )
 : wxString( wxT( "" ) ) );
 };
 
 auto updateStatusPopup =
 [&]( EDA_ITEM* item, size_t ii, size_t count )
 {
 wxString popuptext = _( "Click to place %s (item %ld of %ld)\n"
 "Press <esc> to cancel all; double-click to finish" );
 wxString msg;
 
 if( item->Type() == PCB_FOOTPRINT_T )
 {
 FOOTPRINT* fp = static_cast<FOOTPRINT*>( item );
 msg = fp->GetReference();
 }
 else if( item->Type() == PCB_PAD_T )
 {
 PAD* pad = static_cast<PAD*>( item );
 FOOTPRINT* fp = static_cast<FOOTPRINT*>( pad->GetParentFootprint() );
 msg = wxString::Format( _( "%s pad %s" ), fp->GetReference(), pad->GetNumber() );
 }
 else
 {
 msg = item->GetTypeDesc().Lower();
 }
 
 statusPopup.SetText( wxString::Format( popuptext, msg, ii, count ) );
 };
 
 std::vector<BOARD_ITEM*> sel_items; // All the items operated on by the move below
 std::vector<BOARD_ITEM*> orig_items; // All the original items in the selection
 
 for( EDA_ITEM* item : selection )
 {
 BOARD_ITEM* boardItem = dynamic_cast<BOARD_ITEM*>( item );
 FOOTPRINT* footprint = dynamic_cast<FOOTPRINT*>( item );
 
 if( boardItem )
 {
 if( !is_hover )
 orig_items.push_back( boardItem );
 
 sel_items.push_back( boardItem );
 }
 
 if( footprint )
 {
 for( PAD* pad : footprint->Pads() )
 sel_items.push_back( pad );
 
 // Clear this flag here; it will be set by the netlist updater if the footprint is new
 // so that it was skipped in the initial connectivity update in OnNetlistChanged
 footprint->SetAttributes( footprint->GetAttributes() & ~FP_JUST_ADDED );
 }
 }
 
 if( moveWithReference && !pickReferencePoint( _( "Select reference point for move..." ), "", "",
 pickedReferencePoint ) )
 {
 if( is_hover )
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 editFrame->PopTool( aEvent );
 return 0;
 }
 
 if( moveIndividually )
 {
 orig_items.clear();
 
 for( EDA_ITEM* item : selection.GetItemsSortedBySelectionOrder() )
 orig_items.push_back( static_cast<BOARD_ITEM*>( item ) );
 
 updateStatusPopup( orig_items[ itemIdx ], itemIdx + 1, orig_items.size() );
 statusPopup.Popup();
 statusPopup.Move( wxGetMousePosition() + wxPoint( 20, 20 ) );
 canvas()->SetStatusPopup( statusPopup.GetPanel() );
 
 m_selectionTool->ClearSelection();
 m_selectionTool->AddItemToSel( orig_items[ itemIdx ] );
 
 sel_items.clear();
 sel_items.push_back( orig_items[ itemIdx ] );
 }
 
 bool restore_state = false;
 VECTOR2I originalPos;
 VECTOR2I totalMovement;
 VECTOR2D bboxMovement;
 BOX2I originalBBox;
 bool updateBBox = true;
 PCB_GRID_HELPER grid( m_toolMgr, editFrame->GetMagneticItemsSettings() );
 TOOL_EVENT copy = aEvent;
 TOOL_EVENT* evt = &copy;
 VECTOR2I prevPos;
 
 bool hv45Mode = false;
 bool eatFirstMouseUp = true;
 bool hasRedrawn3D = false;
 bool allowRedraw3D = cfg->m_Display.m_Live3DRefresh;
 bool showCourtyardConflicts = !m_isFootprintEditor && cfg->m_ShowCourtyardCollisions;
 
 // Used to test courtyard overlaps
 std::unique_ptr<DRC_INTERACTIVE_COURTYARD_CLEARANCE> drc_on_move = nullptr;
 
 if( showCourtyardConflicts )
 {
 std::shared_ptr<DRC_ENGINE> drcEngine = m_toolMgr->GetTool<DRC_TOOL>()->GetDRCEngine();
 drc_on_move.reset( new DRC_INTERACTIVE_COURTYARD_CLEARANCE( drcEngine ) );
 drc_on_move->Init( board );
 }
 
 displayConstraintsMessage( hv45Mode );
 
 // Prime the pump
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 
 // Main loop: keep receiving events
 do
 {
 VECTOR2I movement;
 editFrame->GetCanvas()->SetCurrentCursor( KICURSOR::MOVING );
 grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
 grid.SetUseGrid( getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
 
 bool isSkip = evt->IsAction( &PCB_ACTIONS::skip ) && moveIndividually;
 
 if( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) )
 eatFirstMouseUp = false;
 
 if( evt->IsAction( &PCB_ACTIONS::move ) || evt->IsMotion() || evt->IsDrag( BUT_LEFT )
 || evt->IsAction( &ACTIONS::refreshPreview )
 || evt->IsAction( &PCB_ACTIONS::moveWithReference )
 || evt->IsAction( &PCB_ACTIONS::moveIndividually ) )
 {
 if( m_dragging && evt->Category() == TC_MOUSE )
 {
 bool redraw3D = false;
 
 VECTOR2I mousePos( controls->GetMousePosition() );
 
 m_cursor = grid.BestSnapAnchor( mousePos, item_layers, sel_items );
 
 if( controls->GetSettings().m_lastKeyboardCursorPositionValid )
 {
 long action = controls->GetSettings().m_lastKeyboardCursorCommand;
 
 // The arrow keys are by definition SINGLE AXIS. Do not allow the other
 // axis to be snapped to the grid.
 if( action == ACTIONS::CURSOR_LEFT || action == ACTIONS::CURSOR_RIGHT )
 m_cursor.y = prevPos.y;
 else if( action == ACTIONS::CURSOR_UP || action == ACTIONS::CURSOR_DOWN )
 m_cursor.x = prevPos.x;
 }
 
 if( !selection.HasReferencePoint() )
 originalPos = m_cursor;
 
 if( hv45Mode )
 {
 VECTOR2I moveVector = m_cursor - originalPos;
 m_cursor = originalPos + GetVectorSnapped45( moveVector );
 }
 
 if( updateBBox )
 {
 originalBBox = BOX2I();
 bboxMovement = VECTOR2D();
 
 for( EDA_ITEM* item : sel_items )
 {
 BOX2I viewBBOX = item->ViewBBox();
 
 if( originalBBox.GetWidth() == 0 && originalBBox.GetHeight() == 0 )
 originalBBox = viewBBOX;
 else
 originalBBox.Merge( viewBBOX );
 }
 
 updateBBox = false;
 }
 
 // Constrain selection bounding box to coordinates limits
 movement = getSafeMovement( m_cursor - prevPos, originalBBox, bboxMovement );
 
 // Apply constrained movement
 m_cursor = prevPos + movement;
 
 controls->ForceCursorPosition( true, m_cursor );
 selection.SetReferencePoint( m_cursor );
 
 prevPos = m_cursor;
 totalMovement += movement;
 bboxMovement += movement;
 
 // Drag items to the current cursor position
 for( EDA_ITEM* item : sel_items )
 {
 // Don't double move footprint pads, fields, etc.
 //
 // For PCB_GROUP_T, we make sure the selection includes only the top level
 // group and not its descendants.
 if( !item->GetParent() || !item->GetParent()->IsSelected() )
 static_cast<BOARD_ITEM*>( item )->Move( movement );
 
 if( !redraw3D && item->Type() == PCB_FOOTPRINT_T )
 redraw3D = true;
 }
 
 if( redraw3D && allowRedraw3D )
 {
 editFrame->Update3DView( false, true );
 hasRedrawn3D = true;
 }
 
 if( showCourtyardConflicts && drc_on_move->m_FpInMove.size() )
 {
 drc_on_move->Run();
 drc_on_move->UpdateConflicts( m_toolMgr->GetView(), true );
 }
 
 m_toolMgr->PostEvent( EVENTS::SelectedItemsMoved );
 }
 else if( !m_dragging && !evt->IsAction( &ACTIONS::refreshPreview ) )
 {
 // Prepare to start dragging
 editFrame->HideSolderMask();
 
 m_dragging = true;
 
 // When editing footprints, all items have the same parent
 if( IsFootprintEditor() )
 {
 m_commit->Modify( selection.Front() );
 }
 else
 {
 // Save items, so changes can be undone
 for( EDA_ITEM* item : selection )
 {
 // Don't double move footprint pads, fields, etc.
 //
 // For PCB_GROUP_T, the parent is the board.
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 m_commit->Modify( item );
 
 // If moving a group, record position of all the descendants for undo
 if( item->Type() == PCB_GROUP_T )
 {
 PCB_GROUP* group = static_cast<PCB_GROUP*>( item );
 group->RunOnDescendants( [&]( BOARD_ITEM* bItem )
 {
 m_commit->Modify( bItem );
 });
 }
 }
 }
 
 editFrame->UndoRedoBlock( true );
 m_cursor = controls->GetCursorPosition();
 
 if( selection.HasReferencePoint() )
 {
 // start moving with the reference point attached to the cursor
 grid.SetAuxAxes( false );
 
 if( hv45Mode )
 {
 VECTOR2I moveVector = m_cursor - originalPos;
 m_cursor = originalPos + GetVectorSnapped45( moveVector );
 }
 
 movement = m_cursor - selection.GetReferencePoint();
 
 // Drag items to the current cursor position
 for( EDA_ITEM* item : selection )
 {
 // Don't double move footprint pads, fields, etc.
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 static_cast<BOARD_ITEM*>( item )->Move( movement );
 }
 
 selection.SetReferencePoint( m_cursor );
 }
 else
 {
 for( BOARD_ITEM* item : sel_items )
 {
 if( showCourtyardConflicts && item->Type() == PCB_FOOTPRINT_T )
 drc_on_move->m_FpInMove.push_back( static_cast<FOOTPRINT*>( item ) );
 }
 
 m_cursor = grid.BestDragOrigin( originalCursorPos, sel_items,
 &m_selectionTool->GetFilter() );
 
 // Set the current cursor position to the first dragged item origin, so the
 // movement vector could be computed later
 if( moveWithReference )
 {
 selection.SetReferencePoint( pickedReferencePoint );
 controls->ForceCursorPosition( true, pickedReferencePoint );
 m_cursor = pickedReferencePoint;
 }
 else
 {
 // Check if user wants to warp the mouse to origin of moved object
 if( !editFrame->GetMoveWarpsCursor() )
 m_cursor = originalCursorPos; // No, so use original mouse pos instead
 
 selection.SetReferencePoint( m_cursor );
 grid.SetAuxAxes( true, m_cursor );
 }
 
 originalPos = m_cursor;
  }
 
 // Update variables for bounding box collision calculations
 updateBBox = true;
 
 controls->SetCursorPosition( m_cursor, false );
 
 prevPos = m_cursor;
 controls->SetAutoPan( true );
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 }
 
 statusPopup.Move( wxGetMousePosition() + wxPoint( 20, 20 ) );
 
 m_toolMgr->RunAction( PCB_ACTIONS::updateLocalRatsnest, false, new VECTOR2I( movement ) );
 }
 else if( evt->IsCancelInteractive() || evt->IsActivate() )
 {
 if( m_dragging && evt->IsCancelInteractive() )
 evt->SetPassEvent( false );
 
 restore_state = true; // Canceling the tool means that items have to be restored
 break; // Finish
 }
 else if( evt->IsAction( &ACTIONS::undo ) )
 {
 restore_state = true; // Perform undo locally
 break; // Finish
 }
 else if( evt->IsAction( &ACTIONS::doDelete ) || evt->IsAction( &ACTIONS::cut ) )
 {
 // Dispatch TOOL_ACTIONs
 evt->SetPassEvent();
 break; // finish -- there is no further processing for removed items
 }
 else if( evt->IsAction( &ACTIONS::duplicate ) )
 {
 evt->SetPassEvent();
 break; // finish -- Duplicate tool will start a new Move with the dup'ed items
 }
 else if( evt->IsAction( &PCB_ACTIONS::rotateCw )
 || evt->IsAction( &PCB_ACTIONS::rotateCcw )
 || evt->IsAction( &PCB_ACTIONS::flip )
 || evt->IsAction( &PCB_ACTIONS::mirrorH )
 || evt->IsAction( &PCB_ACTIONS::mirrorV ) )
 {
 updateBBox = true;
 eatFirstMouseUp = false;
 evt->SetPassEvent();
 }
 else if( evt->IsAction( &PCB_ACTIONS::moveExact ) )
 {
 // Reset positions so the Move Exactly is from the start.
 for( EDA_ITEM* item : selection )
 {
 BOARD_ITEM* i = static_cast<BOARD_ITEM*>( item );
 i->Move( -totalMovement );
 }
 
 break; // finish -- we moved exactly, so we are finished
 }
 else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) || isSkip )
 {
 // Eat mouse-up/-click events that leaked through from the lock dialog
 if( eatFirstMouseUp && evt->Parameter<intptr_t>() != ACTIONS::CURSOR_CLICK )
 {
 eatFirstMouseUp = false;
 continue;
 }
 else if( moveIndividually && m_dragging )
 {
 // Put skipped items back where they started
 if( isSkip )
 orig_items[itemIdx]->SetPosition( originalPos );
 
 rebuildConnectivity();
 
 if( ++itemIdx < orig_items.size() )
 {
 BOARD_ITEM* nextItem = orig_items[itemIdx];
 
 m_selectionTool->ClearSelection();
 
 originalPos = nextItem->GetPosition();
 m_selectionTool->AddItemToSel( nextItem );
 selection.SetReferencePoint( originalPos );
 
 sel_items.clear();
 sel_items.push_back( nextItem );
 updateStatusPopup( nextItem, itemIdx + 1, orig_items.size() );
 
 // Pick up new item
 m_commit->Modify( nextItem );
 nextItem->SetPosition( controls->GetMousePosition( true ) );
 
 continue;
 }
 }
 
 break; // finish
 }
 else if( evt->IsDblClick( BUT_LEFT ) )
 {
 // The first click will move the new item, so put it back
 if( moveIndividually )
 orig_items[itemIdx]->SetPosition( originalPos );
 
 break; // finish
 }
 else if( evt->IsAction( &PCB_ACTIONS::toggleHV45Mode ) )
 {
 hv45Mode = !hv45Mode;
 displayConstraintsMessage( hv45Mode );
 evt->SetPassEvent( false );
 }
 else if( ZONE_FILLER_TOOL::IsZoneFillAction( evt ) )
 {
 wxBell();
 }
 else
 {
 evt->SetPassEvent();
 }
 
 } while( ( evt = Wait() ) ); // Assignment (instead of equality test) is intentional
 
 // Clear temporary COURTYARD_CONFLICT flag and ensure the conflict shadow is cleared
 if( showCourtyardConflicts )
 drc_on_move->ClearConflicts( m_toolMgr->GetView() );
 
 controls->ForceCursorPosition( false );
 controls->ShowCursor( false );
 controls->SetAutoPan( false );
 
 m_dragging = false;
 editFrame->UndoRedoBlock( false );
 
  // Discard reference point when selection is "dropped" onto the board
 selection.ClearReferencePoint();
 
 // Unselect all items to clear selection flags and then re-select the originally selected
 // items (after the potential Revert()).
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 // TODO: there's an encapsulation leak here: this commit often has more than just the move
 // in it; for instance it might have a paste, append board, etc. as well.
 if( restore_state )
 {
 m_commit->Revert();
 m_selectionTool->RebuildSelection();
 
 // Mainly for point editor, but there might be other clients that need to adjust to
 // reverted state.
 m_toolMgr->PostEvent( EVENTS::SelectedItemsMoved );
 
 // Property panel needs to know about the reselect
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 
 if( hasRedrawn3D )
 editFrame->Update3DView( false, true );
 }
 else
 {
 m_commit->Push( aCommitMessage );
 m_toolMgr->RunAction( PCB_ACTIONS::selectItems, true, &orig_items );
 }
 
 m_toolMgr->GetTool<DRAWING_TOOL>()->UpdateStatusBar();
 // Remove the dynamic ratsnest from the screen
 m_toolMgr->RunAction( PCB_ACTIONS::hideLocalRatsnest, true );
 
 editFrame->PopTool( aEvent );
 editFrame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 
 return restore_state ? -1 : 0;
}

References _, TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::AddItemToSel(), ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, PCB_TOOL_BASE::canvas(), TOOL_EVENT::Category(), SELECTION::ClearReferencePoint(), PCB_SELECTION_TOOL::ClearSelection(), PCB_TOOL_BASE::controls(), copy, ACTIONS::CURSOR_CLICK, ACTIONS::CURSOR_DOWN, ACTIONS::CURSOR_LEFT, ACTIONS::CURSOR_RIGHT, ACTIONS::CURSOR_UP, ACTIONS::cut, TOOL_EVENT::DisableGridSnapping(), EDA_DRAW_FRAME::DisplayConstraintsMsg(), ACTIONS::doDelete, ACTIONS::duplicate, SELECTION::Empty(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), PCB_ACTIONS::flip, PCB_TOOL_BASE::footprint(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), Format(), PCB_TOOL_BASE::frame(), SELECTION::Front(), FOOTPRINT::GetAttributes(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), PCB_SELECTION_TOOL::GetFilter(), BOX2< Vec >::GetHeight(), SELECTION::GetItemsSortedBySelectionOrder(), PCB_BASE_FRAME::GetMagneticItemsSettings(), KIGFX::VIEW_CONTROLS::GetMousePosition(), TOOLS_HOLDER::GetMoveWarpsCursor(), STATUS_POPUP::GetPanel(), EDA_ITEM::GetParent(), PCB_BASE_FRAME::GetPcbNewSettings(), EDA_ITEM::GetPosition(), FOOTPRINT::GetReference(), SELECTION::GetReferencePoint(), getSafeMovement(), PCB_SELECTION::GetSelectionLayers(), KIGFX::VIEW_CONTROLS::GetSettings(), TOOL_MANAGER::GetTool(), EDA_ITEM::GetTypeDesc(), GetVectorSnapped45(), TOOL_BASE::getView(), TOOL_MANAGER::GetView(), TOOL_BASE::getViewControls(), BOX2< Vec >::GetWidth(), grid, group, SELECTION::HasReferencePoint(), PCB_ACTIONS::hideLocalRatsnest, PCB_BASE_FRAME::HideSolderMask(), TOOL_EVENT::IsAction(), TOOL_EVENT::IsActivate(), TOOL_EVENT::IsCancelInteractive(), TOOL_EVENT::IsClick(), TOOL_EVENT::IsDblClick(), TOOL_EVENT::IsDrag(), PCB_TOOL_BASE::IsFootprintEditor(), SELECTION::IsHover(), TOOL_EVENT::IsMotion(), TOOL_EVENT::IsMouseUp(), EDA_ITEM::IsSelected(), ZONE_FILLER_TOOL::IsZoneFillAction(), PCBNEW_SETTINGS::m_AllowFreePads, m_commit, m_cursor, PCBNEW_SETTINGS::m_Display, m_dragging, PCB_TOOL_BASE::m_isFootprintEditor, KIGFX::VC_SETTINGS::m_lastKeyboardCursorCommand, KIGFX::VC_SETTINGS::m_lastKeyboardCursorPositionValid, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_Live3DRefresh, m_selectionTool, PCBNEW_SETTINGS::m_ShowCourtyardCollisions, TOOL_BASE::m_toolMgr, MD_SHIFT, BOX2< Vec >::Merge(), PCB_ACTIONS::mirrorH, PCB_ACTIONS::mirrorV, TOOL_EVENT::Modifier(), Move(), BOARD_ITEM::Move(), STATUS_POPUP::Move(), PCB_ACTIONS::move, PCB_ACTIONS::moveExact, PCB_ACTIONS::moveIndividually, PCB_ACTIONS::moveWithReference, MOVING, pad, FOOTPRINT::Pads(), TOOL_EVENT::Parameter(), PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_PAD_T, pickReferencePoint(), TOOLS_HOLDER::PopTool(), STATUS_POPUP::Popup(), TOOL_MANAGER::PostEvent(), TOOLS_HOLDER::PushTool(), rebuildConnectivity(), PCB_SELECTION_TOOL::RebuildSelection(), ACTIONS::refreshPreview, PCB_SELECTION_TOOL::RequestSelection(), PCB_ACTIONS::rotateCcw, PCB_ACTIONS::rotateCw, TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, EVENTS::SelectedItemsMoved, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItems, FOOTPRINT::SetAttributes(), KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), KIGFX::VIEW_CONTROLS::SetCursorPosition(), TOOL_EVENT::SetPassEvent(), EDA_ITEM::SetPosition(), SELECTION::SetReferencePoint(), EDA_DRAW_PANEL_GAL::SetStatusPopup(), STATUS_TEXT_POPUP::SetText(), KIGFX::VIEW_CONTROLS::ShowCursor(), PCB_ACTIONS::skip, TC_MOUSE, PCB_ACTIONS::toggleHV45Mode, EDA_ITEM::Type(), ACTIONS::undo, PCB_BASE_EDIT_FRAME::UndoRedoBlock(), PCB_BASE_FRAME::Update3DView(), PCB_ACTIONS::updateLocalRatsnest, EDA_ITEM::ViewBBox(), TOOL_INTERACTIVE::Wait(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Move(), and PackAndMoveFootprints().

Drag()

int EDIT_TOOL::Drag

(

const TOOL_EVENT &

aEvent

)

Invoke the PNS router to drag tracks or do an offline resizing of an arc track if a single arc track is selected.

Definition at line 335 of file edit_tool.cpp.

{
 if( !m_toolMgr->GetTool<ROUTER_TOOL>() )
 return false; // don't drag when no router tool (i.e. fp editor)
 
 if( m_toolMgr->GetTool<ROUTER_TOOL>()->IsToolActive() )
 return false; // don't drag when router is already active
 
 int mode = PNS::DM_ANY;
 
 if( aEvent.IsAction( &PCB_ACTIONS::dragFreeAngle ) )
 mode |= PNS::DM_FREE_ANGLE;
 
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForFreePads( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 
 if( aCollector.GetCount() > 1 )
 sTool->GuessSelectionCandidates( aCollector, aPt );
 
 /*
 * If we have a knee between two segments, or a via attached to two segments,
 * then drop the selection to a single item.
 */
 
 std::vector<PCB_TRACK*> tracks;
 std::vector<PCB_TRACK*> vias;
 
 for( EDA_ITEM* item : aCollector )
 {
 if( PCB_TRACK* track = dynamic_cast<PCB_TRACK*>( item ) )
 {
 if( track->Type() == PCB_VIA_T )
 vias.push_back( track );
 else
 tracks.push_back( track );
 }
 }
 
 auto connected = []( PCB_TRACK* track, const VECTOR2I& pt )
 {
 return track->GetStart() == pt || track->GetEnd() == pt;
 };
 
 if( tracks.size() == 2 && vias.size() == 0 )
 {
 if( connected( tracks[0], tracks[1]->GetStart() )
 || connected( tracks[0], tracks[1]->GetEnd() ) )
 {
 aCollector.Remove( tracks[1] );
 }
 }
 else if( tracks.size() == 2 && vias.size() == 1 )
 {
 if( connected( tracks[0], vias[0]->GetPosition() )
 && connected( tracks[1], vias[0]->GetPosition() ) )
 {
 aCollector.Remove( tracks[0] );
 aCollector.Remove( tracks[1] );
 }
 }
 },
 true /* prompt user regarding locked items */ );
 
 if( selection.Empty() )
 return 0;
 
 if( selection.Size() == 1 && selection.Front()->Type() == PCB_ARC_T )
 {
 // TODO: This really should be done in PNS to ensure DRC is maintained, but for now
 // it allows interactive editing of an arc track
 return DragArcTrack( aEvent );
 }
 else
 {
 invokeInlineRouter( mode );
 }
 
 return 0;
}

References PNS::DM_ANY, PNS::DM_FREE_ANGLE, PCB_ACTIONS::dragFreeAngle, PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), COLLECTOR::GetCount(), PCB_TRACK::GetEnd(), PCB_TRACK::GetStart(), TOOL_MANAGER::GetTool(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), TOOL_EVENT::IsAction(), TOOL_BASE::IsToolActive(), m_selectionTool, TOOL_BASE::m_toolMgr, COLLECTOR::Remove(), PCB_SELECTION_TOOL::RequestSelection(), and PCB_TOOL_BASE::selection().

Referenced by setTransitions().

DragArcTrack()

int EDIT_TOOL::DragArcTrack

(

const TOOL_EVENT &

aTrack

)

Drag-resize an arc (and change end points of connected straight segments).

Definition at line 419 of file edit_tool.cpp.

{
 PCB_SELECTION& selection = m_selectionTool->GetSelection();
 
 if( selection.Size() != 1 || selection.Front()->Type() != PCB_ARC_T )
 return 0;
 
 PCB_ARC* theArc = static_cast<PCB_ARC*>( selection.Front() );
 EDA_ANGLE maxTangentDeviation( ADVANCED_CFG::GetCfg().m_MaxTangentAngleDeviation, DEGREES_T );
 
 if( theArc->GetAngle() + maxTangentDeviation >= ANGLE_180 )
 {
 wxString msg = wxString::Format( _( "Unable to resize arc tracks of %s or greater." ),
 EDA_UNIT_UTILS::UI::MessageTextFromValue( ANGLE_180 - maxTangentDeviation ) );
 frame()->ShowInfoBarError( msg );
 
 return 0; // don't bother with > 180 degree arcs
 }
 
 KIGFX::VIEW_CONTROLS* controls = getViewControls();
 
 Activate();
 // Must be done after Activate() so that it gets set into the correct context
 controls->ShowCursor( true );
 controls->SetAutoPan( true );
 
 bool restore_state = false;
 VECTOR2I arcCenter = theArc->GetCenter();
 SEG tanStart = SEG( arcCenter, theArc->GetStart() ).PerpendicularSeg( theArc->GetStart() );
 SEG tanEnd = SEG( arcCenter, theArc->GetEnd() ).PerpendicularSeg( theArc->GetEnd() );
 
 //Ensure the tangent segments are in the correct orientation
 OPT_VECTOR2I tanIntersect = tanStart.IntersectLines( tanEnd );
 
 if( !tanIntersect )
 return 0;
 
 tanStart.A = *tanIntersect;
 tanStart.B = theArc->GetStart();
 tanEnd.A = *tanIntersect;
 tanEnd.B = theArc->GetEnd();
 
 auto getUniqueTrackAtAnchorCollinear =
 [&]( const VECTOR2I& aAnchor, const SEG& aCollinearSeg ) -> PCB_TRACK*
 {
 std::shared_ptr<CONNECTIVITY_DATA> conn = board()->GetConnectivity();
 
 // Allow items at a distance within the width of the arc track
 int allowedDeviation = theArc->GetWidth();
 
 std::vector<BOARD_CONNECTED_ITEM*> itemsOnAnchor;
 
 for( int i = 0; i < 3; i++ )
 {
 itemsOnAnchor = conn->GetConnectedItemsAtAnchor( theArc, aAnchor,
 { PCB_PAD_T, PCB_VIA_T,
 PCB_TRACE_T, PCB_ARC_T },
 allowedDeviation );
 allowedDeviation /= 2;
 
 if( itemsOnAnchor.size() == 1 )
 break;
 }
 
 PCB_TRACK* retval = nullptr;
 
 if( itemsOnAnchor.size() == 1 && itemsOnAnchor.front()->Type() == PCB_TRACE_T )
 {
 retval = static_cast<PCB_TRACK*>( itemsOnAnchor.front() );
 SEG trackSeg( retval->GetStart(), retval->GetEnd() );
 
 // Allow deviations in colinearity as defined in ADVANCED_CFG
 if( trackSeg.Angle( aCollinearSeg ) > maxTangentDeviation )
 retval = nullptr;
 }
 
 if( !retval )
 {
 retval = new PCB_TRACK( theArc->GetParent() );
 retval->SetStart( aAnchor );
 retval->SetEnd( aAnchor );
 retval->SetNet( theArc->GetNet() );
 retval->SetLayer( theArc->GetLayer() );
 retval->SetWidth( theArc->GetWidth() );
 retval->SetLocked( theArc->IsLocked() );
 retval->SetFlags( IS_NEW );
 getView()->Add( retval );
 }
 
 return retval;
 };
 
 PCB_TRACK* trackOnStart = getUniqueTrackAtAnchorCollinear( theArc->GetStart(), tanStart);
 PCB_TRACK* trackOnEnd = getUniqueTrackAtAnchorCollinear( theArc->GetEnd(), tanEnd );
 
 // Make copies of items to be edited
 PCB_ARC* theArcCopy = new PCB_ARC( *theArc );
 PCB_TRACK* trackOnStartCopy = new PCB_TRACK( *trackOnStart );
 PCB_TRACK* trackOnEndCopy = new PCB_TRACK( *trackOnEnd );
 
 if( trackOnStart->GetLength() != 0 )
 {
 tanStart.A = trackOnStart->GetStart();
 tanStart.B = trackOnStart->GetEnd();
 }
 
 if( trackOnEnd->GetLength() != 0 )
 {
 tanEnd.A = trackOnEnd->GetStart();
 tanEnd.B = trackOnEnd->GetEnd();
 }
 
 // Recalculate intersection point
 if( tanIntersect = tanStart.IntersectLines( tanEnd ); !tanIntersect )
 return 0;
 
 auto isTrackStartClosestToArcStart =
 [&]( PCB_TRACK* aTrack ) -> bool
 {
 double trackStartToArcStart = GetLineLength( aTrack->GetStart(), theArc->GetStart() );
 double trackEndToArcStart = GetLineLength( aTrack->GetEnd(), theArc->GetStart() );
 
 return trackStartToArcStart < trackEndToArcStart;
 };
 
 bool isStartTrackOnStartPt = isTrackStartClosestToArcStart( trackOnStart );
 bool isEndTrackOnStartPt = isTrackStartClosestToArcStart( trackOnEnd );
 
 // Calculate constraints
 //======================
 // maxTanCircle is the circle with maximum radius that is tangent to the two adjacent straight
 // tracks and whose tangent points are constrained within the original tracks and their
 // projected intersection points.
 //
 // The cursor will be constrained first within the isosceles triangle formed by the segments
 // cSegTanStart, cSegTanEnd and cSegChord. After that it will be constrained to be outside
 // maxTanCircle.
 //
 //
 // ____________ <-cSegTanStart
 // / * . ' *
 // cSegTanEnd-> / * . ' *
 // /* . ' <-cSegChord *
 // /. '
 // /* *
 //
 // *  c * <-maxTanCircle
 //
 // * *
 //
 // * *
 // * *
 // * *
 //
 
 auto getFurthestPointToTanInterstect =
 [&]( VECTOR2I& aPointA, VECTOR2I& aPointB ) -> VECTOR2I
 {
 if( ( aPointA - *tanIntersect ).EuclideanNorm()
 > ( aPointB - *tanIntersect ).EuclideanNorm() )
 {
 return aPointA;
 }
 else
 {
 return aPointB;
 }
 };
 
 CIRCLE maxTanCircle;
 VECTOR2I tanStartPoint = getFurthestPointToTanInterstect( tanStart.A, tanStart.B );
 VECTOR2I tanEndPoint = getFurthestPointToTanInterstect( tanEnd.A, tanEnd.B );
 VECTOR2I tempTangentPoint = tanEndPoint;
 
 if( getFurthestPointToTanInterstect( tanStartPoint, tanEndPoint ) == tanEndPoint )
 tempTangentPoint = tanStartPoint;
 
 maxTanCircle.ConstructFromTanTanPt( tanStart, tanEnd, tempTangentPoint );
 VECTOR2I maxTanPtStart = tanStart.LineProject( maxTanCircle.Center );
 VECTOR2I maxTanPtEnd = tanEnd.LineProject( maxTanCircle.Center );
 
 SEG cSegTanStart( maxTanPtStart, *tanIntersect );
 SEG cSegTanEnd( maxTanPtEnd, *tanIntersect );
 SEG cSegChord( maxTanPtStart, maxTanPtEnd );
 
 int cSegTanStartSide = cSegTanStart.Side( theArc->GetMid() );
 int cSegTanEndSide = cSegTanEnd.Side( theArc->GetMid() );
 int cSegChordSide = cSegChord.Side( theArc->GetMid() );
 
 bool eatFirstMouseUp = true;
 
 // Start the tool loop
 while( TOOL_EVENT* evt = Wait() )
 {
 m_cursor = controls->GetMousePosition();
 
 // Constrain cursor within the isosceles triangle
 if( cSegTanStartSide != cSegTanStart.Side( m_cursor )
 || cSegTanEndSide != cSegTanEnd.Side( m_cursor )
 || cSegChordSide != cSegChord.Side( m_cursor ) )
 {
 std::vector<VECTOR2I> possiblePoints;
 
 possiblePoints.push_back( cSegTanEnd.NearestPoint( m_cursor ) );
 possiblePoints.push_back( cSegChord.NearestPoint( m_cursor ) );
 
 VECTOR2I closest = cSegTanStart.NearestPoint( m_cursor );
 
 for( VECTOR2I candidate : possiblePoints )
 {
 if( ( candidate - m_cursor ).SquaredEuclideanNorm()
 < ( closest - m_cursor ).SquaredEuclideanNorm() )
 {
 closest = candidate;
 }
 }
 
 m_cursor = closest;
 }
 
 // Constrain cursor to be outside maxTanCircle
 if( ( m_cursor - maxTanCircle.Center ).EuclideanNorm() < maxTanCircle.Radius )
 m_cursor = maxTanCircle.NearestPoint( m_cursor );
 
 controls->ForceCursorPosition( true, m_cursor );
 
 // Calculate resulting object coordinates
 CIRCLE circlehelper;
 circlehelper.ConstructFromTanTanPt( cSegTanStart, cSegTanEnd, m_cursor );
 
 VECTOR2I newCenter = circlehelper.Center;
 VECTOR2I newStart = cSegTanStart.LineProject( newCenter );
 VECTOR2I newEnd = cSegTanEnd.LineProject( newCenter );
 VECTOR2I newMid = CalcArcMid( newStart, newEnd, newCenter );
 
 // Update objects
 theArc->SetStart( newStart );
 theArc->SetEnd( newEnd );
 theArc->SetMid( newMid );
 
 if( isStartTrackOnStartPt )
 trackOnStart->SetStart( newStart );
 else
 trackOnStart->SetEnd( newStart );
 
 if( isEndTrackOnStartPt )
 trackOnEnd->SetStart( newEnd );
 else
 trackOnEnd->SetEnd( newEnd );
 
 // Update view
 getView()->Update( trackOnStart );
 getView()->Update( trackOnEnd );
 getView()->Update( theArc );
 
 // Handle events
 if( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) )
 {
 eatFirstMouseUp = false;
 }
 else if( evt->IsCancelInteractive() || evt->IsActivate() )
 {
 restore_state = true; // Canceling the tool means that items have to be restored
 break; // Finish
 }
 else if( evt->IsAction( &ACTIONS::undo ) )
 {
 restore_state = true; // Perform undo locally
 break; // Finish
 }
 else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT )
 || evt->IsDblClick( BUT_LEFT ) )
 {
 // Eat mouse-up/-click events that leaked through from the lock dialog
 if( eatFirstMouseUp && evt->Parameter<intptr_t>() != ACTIONS::CURSOR_CLICK )
 {
 eatFirstMouseUp = false;
 continue;
 }
 
 break; // Finish
 }
 }
 
 // Ensure we only do one commit operation on each object
 auto processTrack =
 [&]( PCB_TRACK* aTrack, PCB_TRACK* aTrackCopy, int aMaxLengthIU ) -> bool
 {
 if( aTrack->IsNew() )
 {
 getView()->Remove( aTrack );
 
 if( aTrack->GetLength() <= aMaxLengthIU )
 {
 aTrack->SetParentGroup( nullptr );
 delete aTrack;
 aTrack = nullptr;
 
 aTrackCopy->SetParentGroup( nullptr );
 delete aTrackCopy;
 aTrackCopy = nullptr;
 
 return false;
 }
 else
 {
 m_commit->Add( aTrack );
 
 aTrackCopy->SetParentGroup( nullptr );
 delete aTrackCopy;
 aTrackCopy = nullptr;
 
 return true;
 }
 }
 else if( aTrack->GetLength() <= aMaxLengthIU )
 {
 aTrack->SwapItemData( aTrackCopy ); //restore the original before notifying COMMIT
 m_commit->Remove( aTrack );
 
 aTrackCopy->SetParentGroup( nullptr );
 delete aTrackCopy;
 aTrackCopy = nullptr;
 
 return false;
 }
 else
 {
 m_commit->Modified( aTrack, aTrackCopy );
 }
 
 return true;
 };
 
 // Amend the end points of the arc if we delete the joining tracks
 VECTOR2I newStart = trackOnStart->GetStart();
 VECTOR2I newEnd = trackOnEnd->GetStart();
 
 if( isStartTrackOnStartPt )
 newStart = trackOnStart->GetEnd();
 
 if( isEndTrackOnStartPt )
 newEnd = trackOnEnd->GetEnd();
 
 int maxLengthIU =
 KiROUND( ADVANCED_CFG::GetCfg().m_MaxTrackLengthToKeep * pcbIUScale.IU_PER_MM );
 
 if( !processTrack( trackOnStart, trackOnStartCopy, maxLengthIU ) )
 theArc->SetStart( newStart );
 
 if( !processTrack( trackOnEnd, trackOnEndCopy, maxLengthIU ) )
 theArc->SetEnd( newEnd );
 
 processTrack( theArc, theArcCopy, 0 ); // only delete the arc if start and end points coincide
 
 // Should we commit?
 if( restore_state )
 m_commit->Revert();
 else
 m_commit->Push( _( "Drag Arc Track" ) );
 
 return 0;
}

References _, SEG::A, TOOL_INTERACTIVE::Activate(), KIGFX::VIEW::Add(), SEG::Angle(), ANGLE_180, SEG::B, PCB_TOOL_BASE::board(), BUT_LEFT, CalcArcMid(), CIRCLE::Center, CIRCLE::ConstructFromTanTanPt(), PCB_TOOL_BASE::controls(), ACTIONS::CURSOR_CLICK, DEGREES_T, EuclideanNorm(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), Format(), PCB_TOOL_BASE::frame(), SELECTION::Front(), PCB_ARC::GetAngle(), PCB_ARC::GetCenter(), ADVANCED_CFG::GetCfg(), BOARD::GetConnectivity(), PCB_TRACK::GetEnd(), BOARD_ITEM::GetLayer(), PCB_TRACK::GetLength(), GetLineLength(), PCB_ARC::GetMid(), KIGFX::VIEW_CONTROLS::GetMousePosition(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_ITEM::GetParent(), PCB_SELECTION_TOOL::GetSelection(), PCB_TRACK::GetStart(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), PCB_TRACK::GetWidth(), SEG::IntersectLines(), IS_NEW, BOARD_ITEM::IsLocked(), EDA_ITEM::IsNew(), EDA_IU_SCALE::IU_PER_MM, KiROUND(), SEG::LineProject(), m_commit, m_cursor, m_selectionTool, EDA_UNIT_UTILS::UI::MessageTextFromValue(), CIRCLE::NearestPoint(), SEG::NearestPoint(), PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, pcbIUScale, SEG::PerpendicularSeg(), CIRCLE::Radius, KIGFX::VIEW::Remove(), PCB_TOOL_BASE::selection(), KIGFX::VIEW_CONTROLS::SetAutoPan(), PCB_TRACK::SetEnd(), EDA_ITEM::SetFlags(), BOARD_ITEM::SetLayer(), BOARD_ITEM::SetLocked(), PCB_ARC::SetMid(), BOARD_CONNECTED_ITEM::SetNet(), BOARD_ITEM::SetParentGroup(), PCB_TRACK::SetStart(), PCB_TRACK::SetWidth(), KIGFX::VIEW_CONTROLS::ShowCursor(), EDA_BASE_FRAME::ShowInfoBarError(), SEG::Side(), SELECTION::Size(), BOARD_ITEM::SwapItemData(), EDA_ITEM::Type(), ACTIONS::undo, KIGFX::VIEW::Update(), and TOOL_INTERACTIVE::Wait().

Duplicate()

int EDIT_TOOL::Duplicate

(

const TOOL_EVENT &

aEvent

)

Duplicate the current selection and starts a move action.

Definition at line 2190 of file edit_tool.cpp.

{
 if( isRouterActive() )
 {
 wxBell();
 return 0;
 }
 
 bool increment = aEvent.IsAction( &PCB_ACTIONS::duplicateIncrement );
 
 // Be sure that there is at least one item that we can modify
 const PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I&, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 } );
 
 if( selection.Empty() )
 return 0;
 
 // we have a selection to work on now, so start the tool process
 PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
 
 // If the selection was given a hover, we do not keep the selection after completion
 bool is_hover = selection.IsHover();
 
 std::vector<BOARD_ITEM*> new_items;
 new_items.reserve( selection.Size() );
 
 // Each selected item is duplicated and pushed to new_items list
 // Old selection is cleared, and new items are then selected.
 for( EDA_ITEM* item : selection )
 {
 BOARD_ITEM* dupe_item = nullptr;
 BOARD_ITEM* orig_item = static_cast<BOARD_ITEM*>( item );
 
 if( m_isFootprintEditor )
 {
 FOOTPRINT* parentFootprint = editFrame->GetBoard()->GetFirstFootprint();
 dupe_item = parentFootprint->DuplicateItem( orig_item );
 
 if( increment && dupe_item->Type() == PCB_PAD_T
 && static_cast<PAD*>( dupe_item )->CanHaveNumber() )
 {
 PAD_TOOL* padTool = m_toolMgr->GetTool<PAD_TOOL>();
 wxString padNumber = padTool->GetLastPadNumber();
 padNumber = parentFootprint->GetNextPadNumber( padNumber );
 padTool->SetLastPadNumber( padNumber );
 static_cast<PAD*>( dupe_item )->SetNumber( padNumber );
 }
 }
 else if( orig_item->GetParent() && orig_item->GetParent()->Type() == PCB_FOOTPRINT_T )
 {
 FOOTPRINT* parentFootprint = static_cast<FOOTPRINT*>( orig_item->GetParent() );
 
 m_commit->Modify( parentFootprint );
 dupe_item = parentFootprint->DuplicateItem( orig_item, true /* add to parent */ );
 }
 else
 {
 switch( orig_item->Type() )
 {
 case PCB_FOOTPRINT_T:
 case PCB_TEXT_T:
 case PCB_TEXTBOX_T:
 case PCB_BITMAP_T:
 case PCB_SHAPE_T:
 case PCB_TRACE_T:
 case PCB_ARC_T:
 case PCB_VIA_T:
 case PCB_ZONE_T:
 case PCB_TARGET_T:
 case PCB_DIM_ALIGNED_T:
 case PCB_DIM_CENTER_T:
 case PCB_DIM_RADIAL_T:
 case PCB_DIM_ORTHOGONAL_T:
 case PCB_DIM_LEADER_T:
 dupe_item = orig_item->Duplicate();
 break;
 
 case PCB_GROUP_T:
 dupe_item = static_cast<PCB_GROUP*>( orig_item )->DeepDuplicate();
 break;
 
 default:
 wxASSERT_MSG( false, wxString::Format( wxT( "Unhandled item type %d" ),
 orig_item->Type() ) );
 break;
 }
 }
 
 if( dupe_item )
 {
 if( dupe_item->Type() == PCB_GROUP_T )
 {
 static_cast<PCB_GROUP*>( dupe_item )->RunOnDescendants(
 [&]( BOARD_ITEM* bItem )
 {
 m_commit->Add( bItem );
 });
 }
 
 // Clear the selection flag here, otherwise the PCB_SELECTION_TOOL
 // will not properly select it later on
 dupe_item->ClearSelected();
 
 new_items.push_back( dupe_item );
 m_commit->Add( dupe_item );
 }
 }
 
 // Clear the old selection first
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 // Select the new items
 m_toolMgr->RunAction( PCB_ACTIONS::selectItems, true, &new_items );
 
 // record the new items as added
 if( !selection.Empty() )
 {
 editFrame->DisplayToolMsg( wxString::Format( _( "Duplicated %d item(s)" ),
 (int) new_items.size() ) );
 
 // TODO(ISM): This line can't be used to activate the tool until we allow multiple
 // activations.
 // m_toolMgr->RunAction( PCB_ACTIONS::move, true );
 // Instead we have to create the event and call the tool's function
 // directly
 
 // If items were duplicated, pick them up
 // this works well for "dropping" copies around and pushes the commit
 TOOL_EVENT evt = PCB_ACTIONS::move.MakeEvent();
 Move( evt );
 
 // Deslect the duplicated item if we originally started as a hover selection
 if( is_hover )
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 }
 
 return 0;
}

References _, EDA_ITEM::ClearSelected(), EDA_DRAW_FRAME::DisplayToolMsg(), BOARD_ITEM::Duplicate(), PCB_ACTIONS::duplicateIncrement, FOOTPRINT::DuplicateItem(), SELECTION::Empty(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), Format(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), PAD_TOOL::GetLastPadNumber(), FOOTPRINT::GetNextPadNumber(), BOARD_ITEM::GetParent(), TOOL_MANAGER::GetTool(), TOOL_EVENT::IsAction(), SELECTION::IsHover(), isRouterActive(), m_commit, PCB_TOOL_BASE::m_isFootprintEditor, m_selectionTool, TOOL_BASE::m_toolMgr, TOOL_ACTION::MakeEvent(), Move(), PCB_ACTIONS::move, PCB_ARC_T, PCB_BITMAP_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, PCB_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItems, PAD_TOOL::SetLastPadNumber(), SELECTION::Size(), and EDA_ITEM::Type().

Referenced by setTransitions().

FilletLines()

int EDIT_TOOL::FilletLines

(

const TOOL_EVENT &

aEvent

)

Fillet (i.e.

adds an arc tangent to) all selected straight lines by a user defined radius.

Definition at line 1058 of file edit_tool.cpp.

{
 // Store last used fillet radius to allow pressing "enter" if repeat fillet is required
 static long long filletRadiusIU = 0;
 
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 
 std::vector<VECTOR2I> pts;
 
 // Iterate from the back so we don't have to worry about removals.
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 // We've converted the polygon and rectangle to segments, so drop everything
 // that isn't a segment at this point
 if( !item->IsType( { PCB_SHAPE_LOCATE_SEGMENT_T,
 PCB_SHAPE_LOCATE_POLY_T,
 PCB_SHAPE_LOCATE_RECT_T } ) )
 {
 aCollector.Remove( item );
 }
 }
 },
 true /* prompt user regarding locked items */ );
 
 std::set<PCB_SHAPE*> lines_to_add;
 std::vector<PCB_SHAPE*> items_to_remove;
 
 for( EDA_ITEM* item : selection )
 {
 std::vector<VECTOR2I> pts;
 PCB_SHAPE *graphic = static_cast<PCB_SHAPE*>( item );
 PCB_LAYER_ID layer = graphic->GetLayer();
 int width = graphic->GetWidth();
 
 if( graphic->GetShape() == SHAPE_T::RECT )
 {
 items_to_remove.push_back( graphic );
 VECTOR2I start( graphic->GetStart() );
 VECTOR2I end( graphic->GetEnd() );
 pts.emplace_back( start );
 pts.emplace_back( VECTOR2I( end.x, start.y ) );
 pts.emplace_back( end );
 pts.emplace_back( VECTOR2I( start.x, end.y ) );
 }
 
 if( graphic->GetShape() == SHAPE_T::POLY )
 {
 items_to_remove.push_back( graphic );
 
 for( int jj = 0; jj < graphic->GetPolyShape().VertexCount(); ++jj )
 pts.emplace_back( graphic->GetPolyShape().CVertex( jj ) );
 }
 
 for( size_t jj = 1; jj < pts.size(); ++jj )
 {
 PCB_SHAPE *line;
 
 if( m_isFootprintEditor )
 line = new FP_SHAPE( static_cast<FOOTPRINT*>( frame()->GetModel() ), SHAPE_T::SEGMENT );
 else
 line = new PCB_SHAPE( frame()->GetModel(), SHAPE_T::SEGMENT );
 
 line->SetStart( pts[jj - 1] );
 line->SetEnd( pts[jj] );
 line->SetWidth( width );
 line->SetLayer( layer );
 lines_to_add.insert( line );
 }
 
 if( pts.size() > 1 )
 {
 PCB_SHAPE *line;
 
 if( m_isFootprintEditor )
 line = new FP_SHAPE( static_cast<FOOTPRINT*>( frame()->GetModel() ), SHAPE_T::SEGMENT );
 else
 line = new PCB_SHAPE( frame()->GetModel(), SHAPE_T::SEGMENT );
 
 line->SetStart( pts.back() );
 line->SetEnd( pts.front() );
 line->SetWidth( width );
 line->SetLayer( layer );
 lines_to_add.insert( line );
 }
 }
 
 for( PCB_SHAPE* item : lines_to_add )
 selection.Add( item );
 
 for( PCB_SHAPE* item : items_to_remove )
 selection.Remove( item );
 
 if( selection.CountType( PCB_SHAPE_LOCATE_SEGMENT_T ) < 2 )
 {
 frame()->ShowInfoBarMsg( _( "A shape with least two lines must be selected." ) );
 return 0;
 }
 
 WX_UNIT_ENTRY_DIALOG dia( frame(), _( "Enter fillet radius:" ), _( "Fillet Lines" ),
 filletRadiusIU );
 
 if( dia.ShowModal() == wxID_CANCEL )
 return 0;
 
 filletRadiusIU = dia.GetValue();
 
 if( filletRadiusIU == 0 )
 {
 frame()->ShowInfoBarMsg( _( "A radius of zero was entered.\n"
 "The fillet operation was not performed." ) );
 return 0;
 }
 
 bool operationPerformedOnAtLeastOne = false;
 bool didOneAttemptFail = false;
 std::vector<BOARD_ITEM*> itemsToAddToSelection;
 
 // Only modify one parent in FP editor
 if( m_isFootprintEditor )
 m_commit->Modify( selection.Front() );
 
 alg::for_all_pairs( selection.begin(), selection.end(), [&]( EDA_ITEM* a, EDA_ITEM* b )
 {
 PCB_SHAPE* line_a = static_cast<PCB_SHAPE*>( a );
 PCB_SHAPE* line_b = static_cast<PCB_SHAPE*>( b );
 
 if( line_a->GetLength() == 0.0 || line_b->GetLength() == 0 )
 return;
 
 SEG seg_a( line_a->GetStart(), line_a->GetEnd() );
 SEG seg_b( line_b->GetStart(), line_b->GetEnd() );
 VECTOR2I* a_pt;
 VECTOR2I* b_pt;
 
 if (seg_a.A == seg_b.A)
 {
 a_pt = &seg_a.A;
 b_pt = &seg_b.A;
 }
 else if (seg_a.A == seg_b.B)
 {
 a_pt = &seg_a.A;
 b_pt = &seg_b.B;
 }
 else if (seg_a.B == seg_b.A)
 {
 a_pt = &seg_a.B;
 b_pt = &seg_b.A;
 }
 else if (seg_a.B == seg_b.B)
 {
 a_pt = &seg_a.B;
 b_pt = &seg_b.B;
 }
 else
 return;
 
 
 SHAPE_ARC sArc( seg_a, seg_b, filletRadiusIU );
 VECTOR2I t1newPoint, t2newPoint;
 
 auto setIfPointOnSeg =
 []( VECTOR2I& aPointToSet, SEG aSegment, VECTOR2I aVecToTest )
 {
 VECTOR2I segToVec = aSegment.NearestPoint( aVecToTest ) - aVecToTest;
 
 // Find out if we are on the segment (minimum precision)
 if( segToVec.EuclideanNorm() < SHAPE_ARC::MIN_PRECISION_IU )
 {
 aPointToSet.x = aVecToTest.x;
 aPointToSet.y = aVecToTest.y;
 return true;
 }
 
 return false;
 };
 
 //Do not draw a fillet if the end points of the arc are not within the track segments
 if( !setIfPointOnSeg( t1newPoint, seg_a, sArc.GetP0() )
 && !setIfPointOnSeg( t2newPoint, seg_b, sArc.GetP0() ) )
 {
 didOneAttemptFail = true;
 return;
 }
 
 if( !setIfPointOnSeg( t1newPoint, seg_a, sArc.GetP1() )
 && !setIfPointOnSeg( t2newPoint, seg_b, sArc.GetP1() ) )
 {
 didOneAttemptFail = true;
 return;
 }
 
 PCB_SHAPE* tArc;
 
 if( m_isFootprintEditor )
 tArc = new FP_SHAPE( static_cast<FOOTPRINT*>( frame()->GetModel() ), SHAPE_T::ARC );
 else
 tArc = new PCB_SHAPE( frame()->GetBoard(), SHAPE_T::ARC );
 
 tArc->SetArcGeometry( sArc.GetP0(), sArc.GetArcMid(), sArc.GetP1() );
 tArc->SetWidth( line_a->GetWidth() );
 tArc->SetLayer( line_a->GetLayer() );
 tArc->SetLocked( line_a->IsLocked() );
 
 if( lines_to_add.count( line_a ) )
 {
 lines_to_add.erase( line_a );
 itemsToAddToSelection.push_back( line_a );
 }
 else if( !m_isFootprintEditor )
 {
 m_commit->Modify( line_a );
 }
 
 if( lines_to_add.count( line_b ) )
 {
 lines_to_add.erase( line_b );
 itemsToAddToSelection.push_back( line_b );
 }
 else if( !m_isFootprintEditor )
 {
 m_commit->Modify( line_b );
 }
 
 itemsToAddToSelection.push_back( tArc );
 *a_pt = t1newPoint;
 *b_pt = t2newPoint;
 line_a->SetStart( seg_a.A );
 line_a->SetEnd( seg_a.B );
 line_b->SetStart( seg_b.A );
 line_b->SetEnd( seg_b.B );
 
 if( m_isFootprintEditor )
 {
 static_cast<FP_SHAPE*>( line_a )->SetLocalCoord();
 static_cast<FP_SHAPE*>( line_b )->SetLocalCoord();
 static_cast<FP_SHAPE*>( tArc )->SetLocalCoord();
 }
 
 operationPerformedOnAtLeastOne = true;
 
 } );
 
 for( auto item : items_to_remove )
 {
 m_commit->Remove( item );
 m_selectionTool->RemoveItemFromSel( item, true );
 }
 
 //select the newly created arcs
 for( BOARD_ITEM* item : itemsToAddToSelection )
 {
 m_commit->Add( item );
 m_selectionTool->AddItemToSel( item, true );
 }
 
 if( !items_to_remove.empty() )
 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
 
 if( !itemsToAddToSelection.empty() )
 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
 
 // Notify other tools of the changes
 m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 
 m_commit->Push( _( "Fillet Lines" ) );
 
 if( !operationPerformedOnAtLeastOne )
 frame()->ShowInfoBarMsg( _( "Unable to fillet the selected lines." ) );
 else if( didOneAttemptFail )
 frame()->ShowInfoBarMsg( _( "Some of the lines could not be filleted." ) );
 
 return 0;
}

References COLLECTOR::GetCount(), m_selectionTool, COLLECTOR::Remove(), PCB_SELECTION_TOOL::RequestSelection(), and PCB_TOOL_BASE::selection().

Referenced by setTransitions().

FilletTracks()

int EDIT_TOOL::FilletTracks

(

const TOOL_EVENT &

aEvent

)

Fillet (i.e.

adds an arc tangent to) all selected straight tracks by a user defined radius.

Definition at line 854 of file edit_tool.cpp.

{
 // Store last used fillet radius to allow pressing "enter" if repeat fillet is required
 static long long filletRadiusIU = 0;
 
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 // Iterate from the back so we don't have to worry about removals.
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 if( !dynamic_cast<PCB_TRACK*>( item ) )
 aCollector.Remove( item );
 }
 },
 true /* prompt user regarding locked items */ );
 
 if( selection.Size() < 2 )
 {
 frame()->ShowInfoBarMsg( _( "At least two straight track segments must be selected." ) );
 return 0;
 }
 
 WX_UNIT_ENTRY_DIALOG dia( frame(), _( "Enter fillet radius:" ), _( "Fillet Tracks" ),
 filletRadiusIU );
 
 if( dia.ShowModal() == wxID_CANCEL )
 return 0;
 
 filletRadiusIU = dia.GetValue();
 
 if( filletRadiusIU == 0 )
 {
 frame()->ShowInfoBarMsg( _( "A radius of zero was entered.\n"
 "The fillet operation was not performed." ) );
 return 0;
 }
 
 struct FILLET_OP
 {
 PCB_TRACK* t1;
 PCB_TRACK* t2;
 // Start point of track is modified after PCB_ARC is added, otherwise the end point:
 bool t1Start = true;
 bool t2Start = true;
 };
 
 std::vector<FILLET_OP> filletOperations;
 bool operationPerformedOnAtLeastOne = false;
 bool didOneAttemptFail = false;
 std::set<PCB_TRACK*> processedTracks;
 
 for( EDA_ITEM* item : selection )
 {
 PCB_TRACK* track = dyn_cast<PCB_TRACK*>( item );
 
 if( !track || track->Type() != PCB_TRACE_T || track->GetLength() == 0 )
 {
 continue;
 }
 
 auto processFilletOp =
 [&]( bool aStartPoint )
 {
 std::shared_ptr<CONNECTIVITY_DATA> c = board()->GetConnectivity();
 VECTOR2I anchor = aStartPoint ? track->GetStart()
 : track->GetEnd();
 std::vector<BOARD_CONNECTED_ITEM*> itemsOnAnchor;
 
 itemsOnAnchor = c->GetConnectedItemsAtAnchor( track, anchor,
 { PCB_PAD_T, PCB_VIA_T,
 PCB_TRACE_T, PCB_ARC_T } );
 
 if( itemsOnAnchor.size() > 0
 && selection.Contains( itemsOnAnchor.at( 0 ) )
 && itemsOnAnchor.at( 0 )->Type() == PCB_TRACE_T )
 {
 PCB_TRACK* trackOther = dyn_cast<PCB_TRACK*>( itemsOnAnchor.at( 0 ) );
 
 // Make sure we don't fillet the same pair of tracks twice
 if( processedTracks.find( trackOther ) == processedTracks.end() )
 {
 if( itemsOnAnchor.size() == 1 )
 {
 FILLET_OP filletOp;
 filletOp.t1 = track;
 filletOp.t2 = trackOther;
 filletOp.t1Start = aStartPoint;
 filletOp.t2Start = track->IsPointOnEnds( filletOp.t2->GetStart() );
 filletOperations.push_back( filletOp );
 }
 else
 {
 // User requested to fillet these two tracks but not possible as
 // there are other elements connected at that point
 didOneAttemptFail = true;
 }
 }
 }
 };
 
 processFilletOp( true ); // on the start point of track
 processFilletOp( false ); // on the end point of track
 
 processedTracks.insert( track );
 }
 
 std::vector<BOARD_ITEM*> itemsToAddToSelection;
 
 for( FILLET_OP filletOp : filletOperations )
 {
 PCB_TRACK* track1 = filletOp.t1;
 PCB_TRACK* track2 = filletOp.t2;
 
 bool trackOnStart = track1->IsPointOnEnds( track2->GetStart() );
 bool trackOnEnd = track1->IsPointOnEnds( track2->GetEnd() );
 
 if( trackOnStart && trackOnEnd )
 continue; // Ignore duplicate tracks
 
 if( ( trackOnStart || trackOnEnd ) && track1->GetLayer() == track2->GetLayer() )
 {
 SEG t1Seg( track1->GetStart(), track1->GetEnd() );
 SEG t2Seg( track2->GetStart(), track2->GetEnd() );
 
 if( t1Seg.ApproxCollinear( t2Seg ) )
 continue;
 
 SHAPE_ARC sArc( t1Seg, t2Seg, filletRadiusIU );
 VECTOR2I t1newPoint, t2newPoint;
 
 auto setIfPointOnSeg =
 []( VECTOR2I& aPointToSet, SEG aSegment, VECTOR2I aVecToTest )
 {
 VECTOR2I segToVec = aSegment.NearestPoint( aVecToTest ) - aVecToTest;
 
 // Find out if we are on the segment (minimum precision)
 if( segToVec.EuclideanNorm() < SHAPE_ARC::MIN_PRECISION_IU )
 {
 aPointToSet.x = aVecToTest.x;
 aPointToSet.y = aVecToTest.y;
 return true;
 }
 
 return false;
 };
 
 //Do not draw a fillet if the end points of the arc are not within the track segments
 if( !setIfPointOnSeg( t1newPoint, t1Seg, sArc.GetP0() )
 && !setIfPointOnSeg( t2newPoint, t2Seg, sArc.GetP0() ) )
 {
 didOneAttemptFail = true;
 continue;
 }
 
 if( !setIfPointOnSeg( t1newPoint, t1Seg, sArc.GetP1() )
 && !setIfPointOnSeg( t2newPoint, t2Seg, sArc.GetP1() ) )
 {
 didOneAttemptFail = true;
 continue;
 }
 
 PCB_ARC* tArc = new PCB_ARC( frame()->GetBoard(), &sArc );
 tArc->SetLayer( track1->GetLayer() );
 tArc->SetWidth( track1->GetWidth() );
 tArc->SetNet( track1->GetNet() );
 tArc->SetLocked( track1->IsLocked() );
  m_commit->Add( tArc );
 itemsToAddToSelection.push_back( tArc );
 
 m_commit->Modify( track1 );
 m_commit->Modify( track2 );
 
 if( filletOp.t1Start )
 track1->SetStart( t1newPoint );
 else
 track1->SetEnd( t1newPoint );
 
 if( filletOp.t2Start )
 track2->SetStart( t2newPoint );
 else
 track2->SetEnd( t2newPoint );
 
 operationPerformedOnAtLeastOne = true;
 }
 }
 
 m_commit->Push( _( "Fillet Tracks" ) );
 
 //select the newly created arcs
 for( BOARD_ITEM* item : itemsToAddToSelection )
 m_selectionTool->AddItemToSel( item );
 
 if( !operationPerformedOnAtLeastOne )
 frame()->ShowInfoBarMsg( _( "Unable to fillet the selected track segments." ) );
 else if( didOneAttemptFail )
 frame()->ShowInfoBarMsg( _( "Some of the track segments could not be filleted." ) );
 
 return 0;
}

References _, SELECTION_TOOL::AddItemToSel(), anchor, SEG::ApproxCollinear(), PCB_TOOL_BASE::board(), SELECTION::Contains(), VECTOR2< T >::EuclideanNorm(), PCB_TOOL_BASE::frame(), GetBoard(), BOARD::GetConnectivity(), COLLECTOR::GetCount(), PCB_TRACK::GetEnd(), BOARD_ITEM::GetLayer(), PCB_TRACK::GetLength(), BOARD_CONNECTED_ITEM::GetNet(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), PCB_TRACK::GetStart(), WX_UNIT_ENTRY_DIALOG::GetValue(), PCB_TRACK::GetWidth(), BOARD_ITEM::IsLocked(), PCB_TRACK::IsPointOnEnds(), m_commit, m_selectionTool, SHAPE::MIN_PRECISION_IU, PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PCB_SELECTION_TOOL::RequestSelection(), PCB_TOOL_BASE::selection(), PCB_TRACK::SetEnd(), BOARD_ITEM::SetLayer(), BOARD_ITEM::SetLocked(), BOARD_CONNECTED_ITEM::SetNet(), PCB_TRACK::SetStart(), PCB_TRACK::SetWidth(), EDA_BASE_FRAME::ShowInfoBarMsg(), SELECTION::Size(), EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

Flip()

int EDIT_TOOL::Flip

(

const TOOL_EVENT &

aEvent

)

Rotate currently selected items.

The rotation point is the current cursor position.

Definition at line 1730 of file edit_tool.cpp.

{
 if( isRouterActive() )
 {
 wxBell();
 return 0;
 }
 
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 sTool->FilterCollectorForFreePads( aCollector );
 },
 !m_dragging /* prompt user regarding locked items */ );
 
 if( selection.Empty() )
 return 0;
 
 std::optional<VECTOR2I> oldRefPt;
 
 if( selection.HasReferencePoint() )
 oldRefPt = selection.GetReferencePoint();
 
 updateModificationPoint( selection );
 
 // Flip around the anchor for footprints, and the bounding box center for board items
 VECTOR2I refPt = IsFootprintEditor() ? VECTOR2I( 0, 0 ) : selection.GetCenter();
 
 // If only one item selected, flip around the selection or item anchor point (instead
 // of the bounding box center) to avoid moving the item anchor
 if( selection.GetSize() == 1 )
 {
 if( m_dragging && selection.HasReferencePoint() )
 refPt = selection.GetReferencePoint();
 else
 refPt = static_cast<BOARD_ITEM*>( selection.GetItem( 0 ) )->GetPosition();
 }
 
 bool leftRight = frame()->GetPcbNewSettings()->m_FlipLeftRight;
 
 // When editing footprints, all items have the same parent
 if( IsFootprintEditor() )
 m_commit->Modify( selection.Front() );
 
 for( EDA_ITEM* item : selection )
 {
 if( !item->IsNew() && !IsFootprintEditor() )
 m_commit->Modify( item );
 
 if( item->Type() == PCB_GROUP_T )
 {
 static_cast<PCB_GROUP*>( item )->RunOnDescendants( [&]( BOARD_ITEM* bItem )
 {
 m_commit->Modify( bItem );
 });
 }
 
 static_cast<BOARD_ITEM*>( item )->Flip( refPt, leftRight );
 }
 
 if( !m_dragging )
 m_commit->Push( _( "Change Side / Flip" ) );
 
 if( selection.IsHover() && !m_dragging )
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 
 if( m_dragging )
 m_toolMgr->RunAction( PCB_ACTIONS::updateLocalRatsnest, false );
 
 // Restore the old reference so any mouse dragging that occurs doesn't make the selection jump
 // to this now invalid reference
 if( oldRefPt )
 selection.SetReferencePoint( *oldRefPt );
 else
 selection.ClearReferencePoint();
 
 return 0;
}

References _, SELECTION::ClearReferencePoint(), SELECTION::Empty(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), Flip(), PCB_TOOL_BASE::frame(), SELECTION::Front(), SELECTION::GetCenter(), SELECTION::GetItem(), PCB_BASE_FRAME::GetPcbNewSettings(), SELECTION::GetReferencePoint(), SELECTION::GetSize(), SELECTION::HasReferencePoint(), PCB_TOOL_BASE::IsFootprintEditor(), SELECTION::IsHover(), isRouterActive(), m_commit, m_dragging, PCBNEW_SETTINGS::m_FlipLeftRight, m_selectionTool, TOOL_BASE::m_toolMgr, PCB_GROUP_T, TOOL_MANAGER::ProcessEvent(), PCB_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, SELECTION::SetReferencePoint(), PCB_ACTIONS::updateLocalRatsnest, and updateModificationPoint().

Referenced by Flip(), and setTransitions().

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(), doMoveSelection(), DRAWING_TOOL::DrawSpecificationStackup(), DRAWING_TOOL::DrawVia(), FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), BOARD_EDITOR_CONTROL::ExportNetlist(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::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().

FootprintFilter()

void EDIT_TOOL::FootprintFilter ( const VECTOR2I &  , GENERAL_COLLECTOR &  aCollector, PCB_SELECTION_TOOL *  sTool  )

static

A selection filter which prunes the selection to contain only items of type #PCB_MODULE_T.

Definition at line 2375 of file edit_tool.cpp.

{
 for( int i = aCollector.GetCount() - 1; i >= 0; i-- )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( aCollector[i] );
 
 if( item->Type() != PCB_FOOTPRINT_T )
 aCollector.Remove( i );
 }
}

References COLLECTOR::GetCount(), PCB_FOOTPRINT_T, COLLECTOR::Remove(), and EDA_ITEM::Type().

Referenced by BOARD_EDITOR_CONTROL::EditFpInFpEditor(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), and BOARD_INSPECTION_TOOL::LocalRatsnestTool().

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(), copyToClipboard(), ROUTER_TOOL::CustomTrackWidthDialog(), FOOTPRINT_EDITOR_CONTROL::DeleteFootprint(), DeleteItems(), PCB_TOOL_BASE::displayOptions(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), PCB_TOOL_BASE::doInteractiveItemPlacement(), doMoveSelection(), ROUTER_TOOL::DpDimensionsDialog(), 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(), FilletTracks(), ROUTER_TOOL::finishInteractive(), Flip(), PCB_CONTROL::FlipPcbView(), GLOBAL_EDIT_TOOL::GlobalDeletions(), ROUTER_TOOL::handleLayerSwitch(), PCB_CONTROL::HighContrastMode(), PCB_CONTROL::HighContrastModeCycle(), BOARD_INSPECTION_TOOL::HighlightItem(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), SCRIPTING_TOOL::Init(), ROUTER_TOOL::Init(), 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(), 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(), 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(), updateModificationPoint(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillAll(), and ZONE_FILLER_TOOL::ZoneFillDirty().

GetAndPlace()

int EDIT_TOOL::GetAndPlace

(

const TOOL_EVENT &

aEvent

)

Definition at line 274 of file edit_tool.cpp.

{
 // GetAndPlace makes sense only in board editor, although it is also called
 // in fpeditor, that shares the same EDIT_TOOL list
 if( !getEditFrame<PCB_BASE_FRAME>()->IsType( FRAME_PCB_EDITOR ) )
 return 0;
 
 PCB_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 FOOTPRINT* fp = getEditFrame<PCB_BASE_FRAME>()->GetFootprintFromBoardByReference();
 
 if( fp )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, (void*) fp );
 
 selectionTool->GetSelection().SetReferencePoint( fp->GetPosition() );
 m_toolMgr->RunAction( PCB_ACTIONS::move, false );
 }
 
 return 0;
}

References FRAME_PCB_EDITOR, PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), TOOL_BASE::m_toolMgr, PCB_ACTIONS::move, TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItem, and SELECTION::SetReferencePoint().

Referenced by setTransitions().

GetCurrentCommit()

BOARD_COMMIT * EDIT_TOOL::GetCurrentCommit ( ) const

inline

Definition at line 172 of file edit_tool.h.

{ return m_commit.get(); }

References m_commit.

getEditFrame()

template<typename T >

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 185 of file tool_base.h.

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

References TOOL_BASE::getToolHolderInt().

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

GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Return the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns

Identifier of the tool.

Definition at line 121 of file tool_base.h.

 {
 return m_toolId;
 }

References TOOL_BASE::m_toolId.

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

GetManager()

TOOL_MANAGER * TOOL_BASE::GetManager ( ) const

inlineinherited

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

Returns

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

Definition at line 144 of file tool_base.h.

 {
 return m_toolMgr;
 }

References TOOL_BASE::m_toolMgr.

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

getModel()

template<typename T >

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Store the type of the tool.

Definition at line 197 of file tool_base.h.

References TOOL_BASE::getModelInt().

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

getModelInt()

EDA_ITEM * TOOL_BASE::getModelInt ( ) const

privateinherited

Definition at line 54 of file tool_base.cpp.

{
 return m_toolMgr->GetModel();
}

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

Referenced by TOOL_BASE::getModel().

GetName()

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

inlineinherited

Return the name of the tool.

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

Returns

The name of the tool.

Definition at line 134 of file tool_base.h.

 {
 return m_toolName;
 }

References TOOL_BASE::m_toolName.

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

getSafeMovement()

VECTOR2I EDIT_TOOL::getSafeMovement ( const VECTOR2I &  aMovement, const BOX2I &  aSourceBBox, const VECTOR2D &  aBBoxOffset  )

private

Definition at line 245 of file edit_tool_move_fct.cpp.

{
 typedef std::numeric_limits<int> coord_limits;
 
 int max = coord_limits::max();
 int min = -max;
 
 double left = aBBoxOffset.x + aSourceBBox.GetPosition().x;
 double top = aBBoxOffset.y + aSourceBBox.GetPosition().y;
 
 double right = left + aSourceBBox.GetSize().x;
 double bottom = top + aSourceBBox.GetSize().y;
 
 // Do not restrict movement if bounding box is already out of bounds
 if( left < min || top < min || right > max || bottom > max )
 return aMovement;
 
 // Constrain moving bounding box to coordinates limits
 VECTOR2D tryMovement( aMovement );
 VECTOR2D bBoxOrigin( aSourceBBox.GetPosition() + aBBoxOffset );
 VECTOR2D clampedBBoxOrigin = GetClampedCoords( bBoxOrigin + tryMovement, COORDS_PADDING );
 
 tryMovement = clampedBBoxOrigin - bBoxOrigin;
 
 VECTOR2D bBoxEnd( aSourceBBox.GetEnd() + aBBoxOffset );
 VECTOR2D clampedBBoxEnd = GetClampedCoords( bBoxEnd + tryMovement, COORDS_PADDING );
 
 tryMovement = clampedBBoxEnd - bBoxEnd;
 
 return GetClampedCoords<double, int>( tryMovement );
}

References COORDS_PADDING, GetClampedCoords(), BOX2< Vec >::GetEnd(), BOX2< Vec >::GetPosition(), BOX2< Vec >::GetSize(), left, right, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by doMoveSelection().

getToolHolderInt()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInt ( ) const

privateinherited

Definition at line 48 of file tool_base.cpp.

{
 return m_toolMgr->GetToolHolder();
}

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

Referenced by TOOL_BASE::getEditFrame().

GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inlineinherited

Definition at line 77 of file tool_interactive.h.

{ return m_menu; }

References TOOL_INTERACTIVE::m_menu.

Referenced by EE_INSPECTION_TOOL::Init(), EE_POINT_EDITOR::Init(), SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_MOVE_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), CONVERT_TOOL::Init(), 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(), DeleteItems(), PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), EE_SELECTION_TOOL::GetNode(), ROUTER_TOOL::getStartLayer(), PCB_CONTROL::GridResetOrigin(), PCB_CONTROL::GridSetOrigin(), EE_SELECTION_TOOL::GuessSelectionCandidates(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), ROUTER_TOOL::handleCommonEvents(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), 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(), 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(), 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(), copyToClipboard(), COMMON_TOOLS::CursorControl(), DeleteItems(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomToPreset(), DragArcTrack(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_EDIT_TOOL::Init(), 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(), Properties(), SCH_EDIT_TOOL::RepeatDrawItem(), PL_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), PCB_SELECTION_TOOL::selectCursor(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectNode(), ZOOM_TOOL::selectRegion(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), PCB_PICKER_TOOL::setControls(), EE_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), PCB_POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateItem(), PL_EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

Go()

template<class T >

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

inherited

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

No conditions means any event.

Definition at line 147 of file tool_interactive.h.

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

References TOOL_INTERACTIVE::goInternal().

Referenced by EDA_3D_CONTROLLER::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), EE_INSPECTION_TOOL::setTransitions(), EE_POINT_EDITOR::setTransitions(), EE_SELECTION_TOOL::setTransitions(), SCH_DRAWING_TOOLS::setTransitions(), SCH_EDIT_TOOL::setTransitions(), SCH_EDITOR_CONTROL::setTransitions(), SCH_FIND_REPLACE_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::setTransitions(), SCH_MOVE_TOOL::setTransitions(), SCH_NAVIGATE_TOOL::setTransitions(), SIMULATOR_CONTROL::setTransitions(), SYMBOL_EDITOR_CONTROL::setTransitions(), SYMBOL_EDITOR_DRAWING_TOOLS::setTransitions(), SYMBOL_EDITOR_EDIT_TOOL::setTransitions(), SYMBOL_EDITOR_MOVE_TOOL::setTransitions(), SYMBOL_EDITOR_PIN_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), COMMON_CONTROL::setTransitions(), COMMON_TOOLS::setTransitions(), PICKER_TOOL::setTransitions(), ZOOM_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), PL_EDIT_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), PL_POINT_EDITOR::setTransitions(), PL_SELECTION_TOOL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), MICROWAVE_TOOL::setTransitions(), SCRIPTING_TOOL::setTransitions(), LENGTH_TUNER_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), CONVERT_TOOL::setTransitions(), DRAWING_TOOL::setTransitions(), DRC_TOOL::setTransitions(), 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().

Init()

bool EDIT_TOOL::Init ( )

overridevirtual

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

Returns

True if the initialization went fine, false - otherwise. Find an item and start moving.

Reimplemented from PCB_TOOL_BASE.

Definition at line 105 of file edit_tool.cpp.

{
 // Find the selection tool, so they can cooperate
 m_selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 
 auto positioningToolsSubMenu = std::make_shared<POSITIONING_TOOLS_MENU>( this );
 m_selectionTool->GetToolMenu().RegisterSubMenu( positioningToolsSubMenu );
 
 auto propertiesCondition =
 [&]( const SELECTION& aSel )
 {
 if( aSel.GetSize() == 0 )
 {
 if( getView()->IsLayerVisible( LAYER_SCHEMATIC_DRAWINGSHEET ) )
 {
 DS_PROXY_VIEW_ITEM* ds = canvas()->GetDrawingSheet();
 VECTOR2D cursor = getViewControls()->GetCursorPosition( false );
 
 if( ds && ds->HitTestDrawingSheetItems( getView(), cursor ) )
 return true;
 }
 
 return false;
 }
 
 if( aSel.GetSize() == 1 )
 return true;
 
 for( EDA_ITEM* item : aSel )
 {
 if( !dynamic_cast<PCB_TRACK*>( item ) )
 return false;
 }
 
 return true;
 };
 
 auto inFootprintEditor =
 [ this ]( const SELECTION& aSelection )
 {
 return m_isFootprintEditor;
 };
 
 auto canMirror =
 [ this ]( const SELECTION& aSelection )
 {
 if( !m_isFootprintEditor
 && SELECTION_CONDITIONS::OnlyTypes( { PCB_PAD_T } )( aSelection ) )
 {
 return false;
 }
 
 return SELECTION_CONDITIONS::HasTypes( EDIT_TOOL::MirrorableItems )( aSelection );
 };
 
 auto singleFootprintCondition = SELECTION_CONDITIONS::OnlyTypes( { PCB_FOOTPRINT_T } )
 && SELECTION_CONDITIONS::Count( 1 );
 
 auto noActiveToolCondition =
 [ this ]( const SELECTION& aSelection )
 {
 return frame()->ToolStackIsEmpty();
 };
 
 auto notMovingCondition =
 [ this ]( const SELECTION& aSelection )
 {
 return !frame()->IsCurrentTool( PCB_ACTIONS::move )
 && !frame()->IsCurrentTool( PCB_ACTIONS::moveWithReference )
 && !frame()->IsCurrentTool( PCB_ACTIONS::moveIndividually );
 };
 
 auto noItemsCondition =
 [ this ]( const SELECTION& aSelections ) -> bool
 {
 return frame()->GetBoard() && !frame()->GetBoard()->IsEmpty();
 };
 
 auto isSkippable =
 [ this ]( const SELECTION& aSelection )
 {
 return frame()->IsCurrentTool( PCB_ACTIONS::moveIndividually );
 };
 
 static std::vector<KICAD_T> connectedTypes = { PCB_TRACE_T,
 PCB_ARC_T,
 PCB_VIA_T,
 PCB_PAD_T,
 PCB_ZONE_T };
 
 static std::vector<KICAD_T> unroutableTypes = { PCB_TRACE_T,
 PCB_ARC_T,
 PCB_VIA_T,
 PCB_PAD_T,
 PCB_FOOTPRINT_T };
 
 static std::vector<KICAD_T> trackTypes = { PCB_TRACE_T,
 PCB_ARC_T,
 PCB_VIA_T };
 
 static std::vector<KICAD_T> filletTypes = { PCB_SHAPE_LOCATE_POLY_T,
 PCB_SHAPE_LOCATE_RECT_T,
 PCB_SHAPE_LOCATE_SEGMENT_T };
 
 
 // Add context menu entries that are displayed when selection tool is active
 CONDITIONAL_MENU& menu = m_selectionTool->GetToolMenu().GetMenu();
 
 menu.AddItem( PCB_ACTIONS::move, SELECTION_CONDITIONS::NotEmpty
 && notMovingCondition );
 menu.AddItem( PCB_ACTIONS::unrouteSelected, SELECTION_CONDITIONS::NotEmpty
 && SELECTION_CONDITIONS::OnlyTypes( unroutableTypes )
 && notMovingCondition
 && !inFootprintEditor );
 menu.AddItem( PCB_ACTIONS::moveIndividually, SELECTION_CONDITIONS::MoreThan( 1 )
 && notMovingCondition );
 menu.AddItem( PCB_ACTIONS::skip, isSkippable );
 menu.AddItem( PCB_ACTIONS::breakTrack, SELECTION_CONDITIONS::Count( 1 )
 && SELECTION_CONDITIONS::OnlyTypes( trackTypes ) );
 menu.AddItem( PCB_ACTIONS::drag45Degree, SELECTION_CONDITIONS::Count( 1 )
 && SELECTION_CONDITIONS::OnlyTypes( GENERAL_COLLECTOR::DraggableItems ) );
 menu.AddItem( PCB_ACTIONS::dragFreeAngle, SELECTION_CONDITIONS::Count( 1 )
 && SELECTION_CONDITIONS::OnlyTypes( GENERAL_COLLECTOR::DraggableItems )
 && !SELECTION_CONDITIONS::OnlyTypes( { PCB_FOOTPRINT_T } ) );
 menu.AddItem( PCB_ACTIONS::filletTracks, SELECTION_CONDITIONS::OnlyTypes( trackTypes ) );
 menu.AddItem( PCB_ACTIONS::filletLines, SELECTION_CONDITIONS::OnlyTypes( filletTypes ) );
 menu.AddItem( PCB_ACTIONS::rotateCcw, SELECTION_CONDITIONS::NotEmpty );
 menu.AddItem( PCB_ACTIONS::rotateCw, SELECTION_CONDITIONS::NotEmpty );
 menu.AddItem( PCB_ACTIONS::flip, SELECTION_CONDITIONS::NotEmpty );
 menu.AddItem( PCB_ACTIONS::mirrorH, canMirror );
 menu.AddItem( PCB_ACTIONS::mirrorV, canMirror );
 menu.AddItem( PCB_ACTIONS::swap, SELECTION_CONDITIONS::MoreThan( 1 ) );
 menu.AddItem( PCB_ACTIONS::packAndMoveFootprints, SELECTION_CONDITIONS::MoreThan( 1 )
 && SELECTION_CONDITIONS::HasType( PCB_FOOTPRINT_T ) );
 
 menu.AddItem( PCB_ACTIONS::properties, propertiesCondition );
 
 menu.AddItem( PCB_ACTIONS::assignNetClass, SELECTION_CONDITIONS::OnlyTypes( connectedTypes )
 && !inFootprintEditor );
 menu.AddItem( PCB_ACTIONS::inspectClearance, SELECTION_CONDITIONS::Count( 2 ) );
 
 // Footprint actions
 menu.AddSeparator();
 menu.AddItem( PCB_ACTIONS::editFpInFpEditor, singleFootprintCondition );
 menu.AddItem( PCB_ACTIONS::updateFootprint, singleFootprintCondition );
 menu.AddItem( PCB_ACTIONS::changeFootprint, singleFootprintCondition );
 
 // Add the submenu for the special positioning tools
 menu.AddSeparator( 100 );
 menu.AddMenu( positioningToolsSubMenu.get(), SELECTION_CONDITIONS::NotEmpty, 100 );
 
 menu.AddSeparator( 150 );
 menu.AddItem( ACTIONS::cut, SELECTION_CONDITIONS::NotEmpty, 150 );
 menu.AddItem( ACTIONS::copy, SELECTION_CONDITIONS::NotEmpty, 150 );
 
 // Selection tool handles the context menu for some other tools, such as the Picker.
 // Don't add things like Paste when another tool is active.
 menu.AddItem( ACTIONS::paste, noActiveToolCondition, 150 );
 menu.AddItem( ACTIONS::pasteSpecial, noActiveToolCondition && !inFootprintEditor, 150 );
 menu.AddItem( ACTIONS::duplicate, SELECTION_CONDITIONS::NotEmpty, 150 );
 menu.AddItem( ACTIONS::doDelete, SELECTION_CONDITIONS::NotEmpty, 150 );
 
 menu.AddSeparator( 150 );
 menu.AddItem( ACTIONS::selectAll, noItemsCondition, 150 );
 
 return true;
}

References CONDITIONAL_MENU::AddItem(), CONDITIONAL_MENU::AddMenu(), CONDITIONAL_MENU::AddSeparator(), PCB_ACTIONS::assignNetClass, PCB_ACTIONS::breakTrack, PCB_TOOL_BASE::canvas(), PCB_ACTIONS::changeFootprint, connectedTypes, ACTIONS::copy, SELECTION_CONDITIONS::Count(), cursor, ACTIONS::cut, ACTIONS::doDelete, PCB_ACTIONS::drag45Degree, PCB_ACTIONS::dragFreeAngle, GENERAL_COLLECTOR::DraggableItems, ACTIONS::duplicate, PCB_ACTIONS::editFpInFpEditor, PCB_ACTIONS::filletLines, PCB_ACTIONS::filletTracks, PCB_ACTIONS::flip, PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetBoard(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), PCB_DRAW_PANEL_GAL::GetDrawingSheet(), TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOL_INTERACTIVE::GetToolMenu(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), SELECTION_CONDITIONS::HasType(), SELECTION_CONDITIONS::HasTypes(), DS_PROXY_VIEW_ITEM::HitTestDrawingSheetItems(), PCB_ACTIONS::inspectClearance, TOOLS_HOLDER::IsCurrentTool(), BOARD::IsEmpty(), KIGFX::VIEW::IsLayerVisible(), LAYER_SCHEMATIC_DRAWINGSHEET, PCB_TOOL_BASE::m_isFootprintEditor, m_selectionTool, TOOL_BASE::m_toolMgr, MirrorableItems, PCB_ACTIONS::mirrorH, PCB_ACTIONS::mirrorV, SELECTION_CONDITIONS::MoreThan(), PCB_ACTIONS::move, PCB_ACTIONS::moveIndividually, PCB_ACTIONS::moveWithReference, SELECTION_CONDITIONS::NotEmpty(), SELECTION_CONDITIONS::OnlyTypes(), PCB_ACTIONS::packAndMoveFootprints, ACTIONS::paste, ACTIONS::pasteSpecial, PCB_ARC_T, PCB_FOOTPRINT_T, PCB_PAD_T, PCB_SHAPE_LOCATE_POLY_T, PCB_SHAPE_LOCATE_RECT_T, PCB_SHAPE_LOCATE_SEGMENT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, PCB_ACTIONS::properties, TOOL_MENU::RegisterSubMenu(), PCB_ACTIONS::rotateCcw, PCB_ACTIONS::rotateCw, ACTIONS::selectAll, PCB_ACTIONS::skip, PCB_ACTIONS::swap, TOOLS_HOLDER::ToolStackIsEmpty(), PCB_ACTIONS::unrouteSelected, and PCB_ACTIONS::updateFootprint.

invokeInlineRouter()

bool EDIT_TOOL::invokeInlineRouter ( int  aDragMode )

private

Definition at line 297 of file edit_tool.cpp.

{
 ROUTER_TOOL* theRouter = m_toolMgr->GetTool<ROUTER_TOOL>();
 
 if( !theRouter )
 return false;
 
 // don't allow switch from moving to dragging
 if( m_dragging )
 {
 wxBell();
 return false;
 }
 
 // make sure we don't accidentally invoke inline routing mode while the router is already
 // active!
 if( theRouter->IsToolActive() )
 return false;
 
 if( theRouter->CanInlineDrag( aDragMode ) )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::routerInlineDrag, true,
 static_cast<intptr_t>( aDragMode ) );
 return true;
 }
 
 return false;
}

References TOOL_MANAGER::GetTool(), m_dragging, TOOL_BASE::m_toolMgr, PCB_ACTIONS::routerInlineDrag, TOOL_MANAGER::RunAction(), and PNS::theRouter.

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(), DeleteItems(), doMoveSelection(), Flip(), Mirror(), MoveExact(), PCB_GRID_HELPER::queryVisible(), and Rotate().

isRouterActive()

bool EDIT_TOOL::isRouterActive ( ) const

private

Definition at line 327 of file edit_tool.cpp.

{
 ROUTER_TOOL* router = m_toolMgr->GetTool<ROUTER_TOOL>();
 
 return router && router->RoutingInProgress();
}

References TOOL_MANAGER::GetTool(), TOOL_BASE::m_toolMgr, and ROUTER_TOOL::RoutingInProgress().

Referenced by CreateArray(), Duplicate(), Flip(), Mirror(), Move(), MoveExact(), Remove(), Rotate(), and Swap().

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 Drag(), ROUTER_TOOL::handleLayerSwitch(), PCB_SELECTION_TOOL::Main(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

Mirror()

int EDIT_TOOL::Mirror

(

const TOOL_EVENT &

aEvent

)

Mirror the current selection.

The mirror axis passes through the current point.

Definition at line 1617 of file edit_tool.cpp.

{
 if( isRouterActive() )
 {
 wxBell();
 return 0;
 }
 
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 sTool->FilterCollectorForFreePads( aCollector );
 },
 !m_dragging /* prompt user regarding locked items */ );
 
 if( selection.Empty() )
 return 0;
 
 updateModificationPoint( selection );
 VECTOR2I mirrorPoint = selection.GetReferencePoint();
 
 // When editing footprints, all items have the same parent
 if( IsFootprintEditor() )
 m_commit->Modify( selection.Front() );
 
 // Set the mirroring options.
 // Unfortunately, the mirror function do not have the same parameter for all items
 // So we need these 2 parameters to avoid mistakes
 bool mirrorLeftRight = true;
 bool mirrorAroundXaxis = false;
 
 if( aEvent.IsAction( &PCB_ACTIONS::mirrorV ) )
 {
 mirrorLeftRight = false;
 mirrorAroundXaxis = true;
 }
 
 for( EDA_ITEM* item : selection )
 {
 if( !item->IsType( MirrorableItems ) )
 continue;
 
 if( !item->IsNew() && !IsFootprintEditor() )
 m_commit->Modify( item );
 
 // modify each object as necessary
 switch( item->Type() )
 {
 case PCB_FP_SHAPE_T:
 case PCB_SHAPE_T:
 static_cast<PCB_SHAPE*>( item )->Mirror( mirrorPoint, mirrorAroundXaxis );
 break;
 
 case PCB_FP_ZONE_T:
 case PCB_ZONE_T:
 static_cast<FP_ZONE*>( item )->Mirror( mirrorPoint, mirrorLeftRight );
 break;
 
 case PCB_FP_TEXT_T:
 static_cast<FP_TEXT*>( item )->Mirror( mirrorPoint, mirrorAroundXaxis );
 break;
 
 case PCB_TEXT_T:
 static_cast<PCB_TEXT*>( item )->Mirror( mirrorPoint, mirrorAroundXaxis );
 break;
 
 case PCB_FP_TEXTBOX_T:
 static_cast<FP_TEXTBOX*>( item )->Mirror( mirrorPoint, mirrorAroundXaxis );
 break;
 
 case PCB_TEXTBOX_T:
 static_cast<PCB_TEXTBOX*>( item )->Mirror( mirrorPoint, mirrorAroundXaxis );
 break;
 
 case PCB_PAD_T:
 if( mirrorLeftRight )
 mirrorPadX( *static_cast<PAD*>( item ), mirrorPoint );
 else
 mirrorPadY( *static_cast<PAD*>( item ), mirrorPoint );
 
 break;
 
 case PCB_TRACE_T:
 case PCB_ARC_T:
 case PCB_VIA_T:
 static_cast<PCB_TRACK*>( item )->Mirror( mirrorPoint, mirrorAroundXaxis );
 break;
 
 default:
 // it's likely the commit object is wrong if you get here
 // Unsure if PCB_GROUP_T needs special attention here.
 assert( false );
 break;
 }
 }
 
 if( !m_dragging )
 m_commit->Push( _( "Mirror" ) );
 
 if( selection.IsHover() && !m_dragging )
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 
 if( m_dragging )
 m_toolMgr->RunAction( PCB_ACTIONS::updateLocalRatsnest, false );
 
 return 0;
}

References _, SELECTION::Empty(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), SELECTION::Front(), SELECTION::GetReferencePoint(), TOOL_EVENT::IsAction(), PCB_TOOL_BASE::IsFootprintEditor(), SELECTION::IsHover(), isRouterActive(), m_commit, m_dragging, m_selectionTool, TOOL_BASE::m_toolMgr, Mirror(), MirrorableItems, mirrorPadX(), mirrorPadY(), PCB_ACTIONS::mirrorV, PCB_ARC_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, PCB_FP_ZONE_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, TOOL_MANAGER::ProcessEvent(), PCB_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::updateLocalRatsnest, and updateModificationPoint().

Referenced by Mirror(), and setTransitions().

Move()

int EDIT_TOOL::Move

(

const TOOL_EVENT &

aEvent

)

Main loop in which events are handled.

Definition at line 233 of file edit_tool_move_fct.cpp.

{
 if( isRouterActive() )
 {
 wxBell();
 return 0;
 }
 
 return doMoveSelection( aEvent, _( "Move" ) );
}

References _, doMoveSelection(), and isRouterActive().

Referenced by doMoveSelection(), Duplicate(), and setTransitions().

MoveExact()

int EDIT_TOOL::MoveExact

(

const TOOL_EVENT &

aEvent

)

Invoke a dialog box to allow moving of the item by an exact amount.

Definition at line 2087 of file edit_tool.cpp.

{
 if( isRouterActive() )
 {
 wxBell();
 return 0;
 }
 
 const PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 },
 true /* prompt user regarding locked items */ );
 
 if( selection.Empty() )
 return 0;
 
 VECTOR2I translation;
 EDA_ANGLE rotation;
 ROTATION_ANCHOR rotationAnchor = selection.Size() > 1 ? ROTATE_AROUND_SEL_CENTER
 : ROTATE_AROUND_ITEM_ANCHOR;
 
 // TODO: Implement a visible bounding border at the edge
 BOX2I sel_box = selection.GetBoundingBox();
 
 DIALOG_MOVE_EXACT dialog( frame(), translation, rotation, rotationAnchor, sel_box );
 int ret = dialog.ShowModal();
 
 if( ret == wxID_OK )
 {
 EDA_ANGLE angle = rotation;
 VECTOR2I rp = selection.GetCenter();
 VECTOR2I selCenter( rp.x, rp.y );
 
 // Make sure the rotation is from the right reference point
 selCenter += translation;
 
 if( !frame()->GetPcbNewSettings()->m_Display.m_DisplayInvertYAxis )
 rotation = -rotation;
 
 // When editing footprints, all items have the same parent
 if( IsFootprintEditor() )
 m_commit->Modify( selection.Front() );
 
 for( EDA_ITEM* selItem : selection )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( selItem );
 
 if( !item->IsNew() && !IsFootprintEditor() )
 {
 m_commit->Modify( item );
 
 if( item->Type() == PCB_GROUP_T )
 {
 PCB_GROUP* group = static_cast<PCB_GROUP*>( item );
 
 group->RunOnDescendants( [&]( BOARD_ITEM* bItem )
 {
 m_commit->Modify( bItem );
 });
 }
 }
 
 if( !item->GetParent() || !item->GetParent()->IsSelected() )
 item->Move( translation );
 
 switch( rotationAnchor )
 {
 case ROTATE_AROUND_ITEM_ANCHOR:
 item->Rotate( item->GetPosition(), angle );
 break;
 case ROTATE_AROUND_SEL_CENTER:
 item->Rotate( selCenter, angle );
 break;
 case ROTATE_AROUND_USER_ORIGIN:
 item->Rotate( frame()->GetScreen()->m_LocalOrigin, angle );
 break;
 case ROTATE_AROUND_AUX_ORIGIN:
 item->Rotate( board()->GetDesignSettings().GetAuxOrigin(), angle );
 break;
 }
 
 if( !m_dragging )
 getView()->Update( item );
 }
 
 m_commit->Push( _( "Move exact" ) );
 
 if( selection.IsHover() )
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 
 if( m_dragging )
 m_toolMgr->RunAction( PCB_ACTIONS::updateLocalRatsnest, false );
 }
 
 return 0;
}

References _, PNS::angle(), PCB_TOOL_BASE::board(), SELECTION::Empty(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), PCB_TOOL_BASE::frame(), SELECTION::Front(), BOARD_DESIGN_SETTINGS::GetAuxOrigin(), SELECTION::GetBoundingBox(), SELECTION::GetCenter(), BOARD::GetDesignSettings(), BOARD_ITEM::GetParent(), EDA_ITEM::GetPosition(), PCB_BASE_FRAME::GetScreen(), TOOL_BASE::getView(), group, PCB_TOOL_BASE::IsFootprintEditor(), SELECTION::IsHover(), EDA_ITEM::IsNew(), isRouterActive(), EDA_ITEM::IsSelected(), m_commit, m_dragging, BASE_SCREEN::m_LocalOrigin, m_selectionTool, TOOL_BASE::m_toolMgr, BOARD_ITEM::Move(), PCB_GROUP_T, TOOL_MANAGER::ProcessEvent(), PCB_SELECTION_TOOL::RequestSelection(), BOARD_ITEM::Rotate(), ROTATE_AROUND_AUX_ORIGIN, ROTATE_AROUND_ITEM_ANCHOR, ROTATE_AROUND_SEL_CENTER, ROTATE_AROUND_USER_ORIGIN, TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, SELECTION::Size(), EDA_ITEM::Type(), KIGFX::VIEW::Update(), PCB_ACTIONS::updateLocalRatsnest, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

PackAndMoveFootprints()

int EDIT_TOOL::PackAndMoveFootprints

(

const TOOL_EVENT &

aEvent

)

Try to fit selected footprints inside a minimal area and start movement.

Definition at line 191 of file edit_tool_move_fct.cpp.

{
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 sTool->FilterCollectorForFreePads( aCollector );
 
 // Iterate from the back so we don't have to worry about removals.
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 if( !dynamic_cast<FOOTPRINT*>( item ) )
 aCollector.Remove( item );
 }
 },
 true /* prompt user regarding locked items */ );
 
 std::vector<FOOTPRINT*> footprintsToPack;
 
 for( EDA_ITEM* item : selection )
 footprintsToPack.push_back( static_cast<FOOTPRINT*>( item ) );
 
 if( footprintsToPack.empty() )
 return 0;
 
 BOX2I footprintsBbox;
 
 for( FOOTPRINT* item : footprintsToPack )
 {
 m_commit->Modify( item );
 footprintsBbox.Merge( item->GetBoundingBox( false, false ) );
 }
 
 SpreadFootprints( &footprintsToPack, footprintsBbox.Normalize().GetOrigin(), false );
 
 return doMoveSelection( aEvent, _( "Pack footprints" ) );
}

References _, doMoveSelection(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), COLLECTOR::GetCount(), BOX2< Vec >::GetOrigin(), m_commit, m_selectionTool, BOX2< Vec >::Merge(), BOX2< Vec >::Normalize(), PCB_SELECTION_TOOL::RequestSelection(), PCB_TOOL_BASE::selection(), and SpreadFootprints().

Referenced by setTransitions().

PadFilter()

void EDIT_TOOL::PadFilter ( const VECTOR2I &  , GENERAL_COLLECTOR &  aCollector, PCB_SELECTION_TOOL *  sTool  )

static

A selection filter which prunes the selection to contain only items of type PCB_PAD_T.

Definition at line 2362 of file edit_tool.cpp.

{
 for( int i = aCollector.GetCount() - 1; i >= 0; i-- )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( aCollector[i] );
 
 if( item->Type() != PCB_PAD_T )
 aCollector.Remove( i );
 }
}

References COLLECTOR::GetCount(), PCB_PAD_T, COLLECTOR::Remove(), and EDA_ITEM::Type().

Referenced by BOARD_INSPECTION_TOOL::LocalRatsnestTool().

pickReferencePoint()

bool EDIT_TOOL::pickReferencePoint ( const wxString &  aTooltip, const wxString &  aSuccessMessage, const wxString &  aCanceledMessage, VECTOR2I &  aReferencePoint  )

private

Rebuilds the ratsnest for operations that require it outside the commit rebuild.

This allow the option of snapping in the tool

Definition at line 2415 of file edit_tool.cpp.

{
 PCB_PICKER_TOOL* picker = m_toolMgr->GetTool<PCB_PICKER_TOOL>();
 std::optional<VECTOR2I> pickedPoint;
 bool done = false;
 
 m_statusPopup->SetText( aTooltip );
 
 picker->SetSnapping( true );
 
 picker->SetClickHandler(
 [&]( const VECTOR2D& aPoint ) -> bool
 {
 pickedPoint = aPoint;
 
 if( !aSuccessMessage.empty() )
 {
 m_statusPopup->SetText( aSuccessMessage );
 m_statusPopup->Expire( 800 );
 }
 else
 {
 m_statusPopup->Hide();
 }
 
 return false; // we don't need any more points
 } );
 
 picker->SetMotionHandler(
 [&]( const VECTOR2D& aPos )
 {
 m_statusPopup->Move( wxGetMousePosition() + wxPoint( 20, -50 ) );
 } );
 
 picker->SetCancelHandler(
 [&]()
 {
 if( !aCanceledMessage.empty() )
 {
 m_statusPopup->SetText( aCanceledMessage );
 m_statusPopup->Expire( 800 );
 }
 else
 {
 m_statusPopup->Hide();
 }
 } );
 
 picker->SetFinalizeHandler(
 [&]( const int& aFinalState )
 {
 done = true;
 } );
 
 m_statusPopup->Move( wxGetMousePosition() + wxPoint( 20, -50 ) );
 m_statusPopup->Popup();
 canvas()->SetStatusPopup( m_statusPopup->GetPanel() );
 
 m_toolMgr->RunAction( ACTIONS::pickerSubTool, true );
 
 while( !done )
 {
 // Pass events unless we receive a null event, then we must shut down
 if( TOOL_EVENT* evt = Wait() )
 evt->SetPassEvent();
 else
 break;
 }
 
 // Ensure statusPopup is hidden after use and before deleting it:
 canvas()->SetStatusPopup( nullptr );
 m_statusPopup->Hide();
 
 if( pickedPoint )
 aReferencePoint = *pickedPoint;
 
 return pickedPoint.has_value();
}

References PCB_TOOL_BASE::canvas(), TOOL_MANAGER::GetTool(), m_statusPopup, TOOL_BASE::m_toolMgr, ACTIONS::pickerSubTool, TOOL_MANAGER::RunAction(), PICKER_TOOL_BASE::SetCancelHandler(), PICKER_TOOL_BASE::SetClickHandler(), PICKER_TOOL_BASE::SetFinalizeHandler(), PICKER_TOOL_BASE::SetMotionHandler(), PICKER_TOOL_BASE::SetSnapping(), EDA_DRAW_PANEL_GAL::SetStatusPopup(), and TOOL_INTERACTIVE::Wait().

Referenced by copyToClipboard(), and doMoveSelection().

Properties()

int EDIT_TOOL::Properties

(

const TOOL_EVENT &

aEvent

)

Display properties window for the selected object.

Definition at line 1338 of file edit_tool.cpp.

{
 PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
 const PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 } );
 
 // Tracks & vias are treated in a special way:
 if( ( SELECTION_CONDITIONS::OnlyTypes( { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T } ) )( selection ) )
 {
 DIALOG_TRACK_VIA_PROPERTIES dlg( editFrame, selection, *m_commit );
 dlg.ShowQuasiModal(); // QuasiModal required for NET_SELECTOR
 }
 else if( selection.Size() == 1 )
 {
 // Display properties dialog
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( selection.Front() );
 
 // Do not handle undo buffer, it is done by the properties dialogs
 editFrame->OnEditItemRequest( item );
 
 // Notify other tools of the changes
 m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 }
 else if( selection.Size() == 0 && getView()->IsLayerVisible( LAYER_DRAWINGSHEET ) )
 {
 DS_PROXY_VIEW_ITEM* ds = editFrame->GetCanvas()->GetDrawingSheet();
 VECTOR2D cursorPos = getViewControls()->GetCursorPosition( false );
 
 if( ds && ds->HitTestDrawingSheetItems( getView(), cursorPos ) )
 m_toolMgr->RunAction( ACTIONS::pageSettings );
 else
 m_toolMgr->RunAction( PCB_ACTIONS::footprintProperties, true );
 }
 
 if( selection.IsHover() )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 }
 else
 {
 // Check for items becoming invisible and drop them from the selection.
 
 PCB_SELECTION selCopy = selection;
 LSET visible = editFrame->GetBoard()->GetVisibleLayers();
 
 for( EDA_ITEM* eda_item : selCopy )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( eda_item );
 
 if( !( item->GetLayerSet() & visible ).any() )
 m_selectionTool->RemoveItemFromSel( item );
 }
 }
 
 return 0;
}

References PCB_ACTIONS::footprintProperties, SELECTION::Front(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), PCB_DRAW_PANEL_GAL::GetDrawingSheet(), BOARD_ITEM::GetLayerSet(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), BOARD::GetVisibleLayers(), DS_PROXY_VIEW_ITEM::HitTestDrawingSheetItems(), SELECTION::IsHover(), KIGFX::VIEW::IsLayerVisible(), LAYER_DRAWINGSHEET, m_commit, m_selectionTool, TOOL_BASE::m_toolMgr, PCB_BASE_EDIT_FRAME::OnEditItemRequest(), SELECTION_CONDITIONS::OnlyTypes(), ACTIONS::pageSettings, PCB_ARC_T, PCB_TRACE_T, PCB_VIA_T, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::RemoveItemFromSel(), PCB_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, DIALOG_SHIM::ShowQuasiModal(), and SELECTION::Size().

Referenced by setTransitions().

rebuildConnectivity()

void EDIT_TOOL::rebuildConnectivity ( )

private

Definition at line 2583 of file edit_tool.cpp.

{
 board()->BuildConnectivity();
 m_toolMgr->PostEvent( EVENTS::ConnectivityChangedEvent );
 canvas()->RedrawRatsnest();
}

References PCB_TOOL_BASE::board(), BOARD::BuildConnectivity(), PCB_TOOL_BASE::canvas(), EVENTS::ConnectivityChangedEvent, TOOL_BASE::m_toolMgr, TOOL_MANAGER::PostEvent(), and PCB_DRAW_PANEL_GAL::RedrawRatsnest().

Referenced by doMoveSelection().

Remove()

int EDIT_TOOL::Remove

(

const TOOL_EVENT &

aEvent

)

Delete currently selected items.

Definition at line 2009 of file edit_tool.cpp.

{
 PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
 
 if( isRouterActive() )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::routerUndoLastSegment, true );
 return 0;
 }
 
 editFrame->PushTool( aEvent );
 
 std::vector<BOARD_ITEM*> lockedItems;
 Activate();
 
 // get a copy instead of reference (as we're going to clear the selection before removing items)
 PCB_SELECTION selectionCopy;
 bool isCut = aEvent.Parameter<PCB_ACTIONS::REMOVE_FLAGS>() == PCB_ACTIONS::REMOVE_FLAGS::CUT;
 bool isAlt = aEvent.Parameter<PCB_ACTIONS::REMOVE_FLAGS>() == PCB_ACTIONS::REMOVE_FLAGS::ALT;
 
 // If we are in a "Cut" operation, then the copied selection exists already and we want to
 // delete exactly that; no more, no fewer. Any filtering for locked items must be done in
 // the copyToClipboard() routine.
 if( isCut )
 {
 selectionCopy = m_selectionTool->GetSelection();
 }
 else
 {
 // When not in free-pad mode we normally auto-promote selected pads to their parent
 // footprints. But this is probably a little too dangerous for a destructive operation,
 // so we just do the promotion but not the deletion (allowing for a second delete to do
 // it if that's what the user wanted).
 selectionCopy = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 } );
 
 size_t beforeFPCount = selectionCopy.CountType( PCB_FOOTPRINT_T );
 
 m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForFreePads( aCollector );
 } );
 
 if( !selectionCopy.IsHover()
 && m_selectionTool->GetSelection().CountType( PCB_FOOTPRINT_T ) > beforeFPCount )
 {
 wxBell();
 canvas()->Refresh();
 editFrame->PopTool( aEvent );
 return 0;
 }
 
 // In "alternative" mode, we expand selected track items to their full connection.
 if( isAlt && ( selectionCopy.HasType( PCB_TRACE_T ) || selectionCopy.HasType( PCB_VIA_T ) ) )
 {
 m_toolMgr->RunAction( PCB_ACTIONS::selectConnection, true );
 }
 
 // Finally run RequestSelection() one more time to find out what user wants to do about
 // locked objects.
 selectionCopy = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForFreePads( aCollector );
 },
 true /* prompt user regarding locked items */ );
 }
 
 DeleteItems( selectionCopy, isCut );
 
 editFrame->PopTool( aEvent );
 return 0;
}

References TOOL_INTERACTIVE::Activate(), ACTIONS::ALT, PCB_TOOL_BASE::canvas(), SELECTION::CountType(), ACTIONS::CUT, DeleteItems(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::GetSelection(), SELECTION::HasType(), SELECTION::IsHover(), isRouterActive(), m_selectionTool, TOOL_BASE::m_toolMgr, TOOL_EVENT::Parameter(), PCB_FOOTPRINT_T, PCB_TRACE_T, PCB_VIA_T, TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), EDA_DRAW_PANEL_GAL::Refresh(), PCB_SELECTION_TOOL::RequestSelection(), PCB_ACTIONS::routerUndoLastSegment, TOOL_MANAGER::RunAction(), and PCB_ACTIONS::selectConnection.

Referenced by cutToClipboard(), and setTransitions().

Reset()

void EDIT_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 81 of file edit_tool.cpp.

{
 m_dragging = false;
 
 m_statusPopup = std::make_unique<STATUS_TEXT_POPUP>( getEditFrame<PCB_BASE_EDIT_FRAME>() );
 
 if( aReason != RUN )
 m_commit.reset( new BOARD_COMMIT( this ) );
}

References m_commit, m_dragging, m_statusPopup, and TOOL_BASE::RUN.

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

Rotate()

int EDIT_TOOL::Rotate

(

const TOOL_EVENT &

aEvent

)

Rotate currently selected items.

Definition at line 1398 of file edit_tool.cpp.

{
 if( isRouterActive() )
 {
 wxBell();
 return 0;
 }
 
 PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
 
 // Be sure that there is at least one item that we can modify. If nothing was selected before,
 // try looking for the stuff under mouse cursor (i.e. KiCad old-style hover selection)
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForHierarchy( aCollector, true );
 sTool->FilterCollectorForMarkers( aCollector );
 },
 // Prompt user regarding locked items if in board editor and in free-pad-mode (if
 // we're not in free-pad mode we delay this until the second RequestSelection()).
 frame()->GetPcbNewSettings()->m_AllowFreePads && !m_isFootprintEditor );
 
 if( selection.Empty() )
 return 0;
 
 std::optional<VECTOR2I> oldRefPt;
 bool is_hover = selection.IsHover(); // N.B. This must be saved before the second
 // call to RequestSelection() below
 
 if( selection.HasReferencePoint() )
 oldRefPt = selection.GetReferencePoint();
 
 // Now filter out pads if not in free pads mode. We cannot do this in the first
 // RequestSelection() as we need the reference point when a pad is the selection front.
 if( !m_isFootprintEditor && !frame()->GetPcbNewSettings()->m_AllowFreePads )
 {
 selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 sTool->FilterCollectorForFreePads( aCollector );
 },
 true /* prompt user regarding locked items */ );
 }
 
 // Did we filter everything out? If so, don't try to operate further
 if( selection.Empty() )
 return 0;
 
 updateModificationPoint( selection );
 
 VECTOR2I refPt = selection.GetReferencePoint();
 EDA_ANGLE rotateAngle = TOOL_EVT_UTILS::GetEventRotationAngle( *editFrame, aEvent );
 
 // Calculate view bounding box
 BOX2I viewBBox = selection.Front()->ViewBBox();
 
 for( EDA_ITEM* item : selection )
 viewBBox.Merge( item->ViewBBox() );
 
 // Check if the view bounding box will go out of bounds
 VECTOR2D rotPos = viewBBox.GetPosition();
 VECTOR2D rotEnd = viewBBox.GetEnd();
 
 RotatePoint( &rotPos.x, &rotPos.y, refPt.x, refPt.y, rotateAngle );
 RotatePoint( &rotEnd.x, &rotEnd.y, refPt.x, refPt.y, rotateAngle );
 
 typedef std::numeric_limits<int> coord_limits;
 
 int max = coord_limits::max() - COORDS_PADDING;
 int min = -max;
 
 bool outOfBounds = rotPos.x < min || rotPos.x > max || rotPos.y < min || rotPos.y > max
 || rotEnd.x < min || rotEnd.x > max || rotEnd.y < min || rotEnd.y > max;
 
 if( !outOfBounds )
 {
 // When editing footprints, all items have the same parent
 if( IsFootprintEditor() )
 m_commit->Modify( selection.Front() );
 
 for( EDA_ITEM* item : selection )
 {
 if( !item->IsNew() && !IsFootprintEditor() )
 {
 m_commit->Modify( item );
 
 // If rotating a group, record position of all the descendants for undo
 if( item->Type() == PCB_GROUP_T )
 {
 static_cast<PCB_GROUP*>( item )->RunOnDescendants( [&]( BOARD_ITEM* bItem )
 {
 m_commit->Modify( bItem );
 });
 }
 }
 
 static_cast<BOARD_ITEM*>( item )->Rotate( refPt, rotateAngle );
 }
 
 if( !m_dragging )
 m_commit->Push( _( "Rotate" ) );
 
 if( is_hover && !m_dragging )
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 
 if( m_dragging )
 m_toolMgr->RunAction( PCB_ACTIONS::updateLocalRatsnest, false );
 }
 
 // Restore the old reference so any mouse dragging that occurs doesn't make the selection jump
 // to this now invalid reference
 if( oldRefPt )
 selection.SetReferencePoint( *oldRefPt );
 else
 selection.ClearReferencePoint();
 
 return 0;
}

References _, SELECTION::ClearReferencePoint(), COORDS_PADDING, SELECTION::Empty(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), PCB_TOOL_BASE::frame(), SELECTION::Front(), BOX2< Vec >::GetEnd(), TOOL_EVT_UTILS::GetEventRotationAngle(), PCB_BASE_FRAME::GetPcbNewSettings(), BOX2< Vec >::GetPosition(), SELECTION::GetReferencePoint(), SELECTION::HasReferencePoint(), PCB_TOOL_BASE::IsFootprintEditor(), SELECTION::IsHover(), isRouterActive(), PCBNEW_SETTINGS::m_AllowFreePads, m_commit, m_dragging, PCB_TOOL_BASE::m_isFootprintEditor, m_selectionTool, TOOL_BASE::m_toolMgr, BOX2< Vec >::Merge(), PCB_GROUP_T, TOOL_MANAGER::ProcessEvent(), PCB_SELECTION_TOOL::RequestSelection(), Rotate(), RotatePoint(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, SELECTION::SetReferencePoint(), PCB_ACTIONS::updateLocalRatsnest, updateModificationPoint(), EDA_ITEM::ViewBBox(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Rotate(), and 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(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), ChangeTrackWidth(), PAD_TOOL::copyPadSettings(), copyToClipboard(), CreateArray(), DRC_TOOL::CrossProbe(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), doMoveSelection(), Drag(), DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), GROUP_TOOL::EnterGroup(), PAD_TOOL::EnumeratePads(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), FilletLines(), FilletTracks(), Flip(), DRAWING_TOOL::getSourceZoneForAction(), GROUP_TOOL::Group(), BOARD_INSPECTION_TOOL::highlightNet(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), DRAWING_TOOL::InteractivePlaceWithPreview(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), MoveExact(), PCB_POINT_EDITOR::OnSelectionChange(), 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(), Properties(), PAD_TOOL::pushPadSettings(), BOARD_REANNOTATE_TOOL::ReannotateDuplicatesInSelection(), GROUP_TOOL::RemoveFromGroup(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), Rotate(), ROUTER_TOOL::RouteSelected(), DRAWING_TOOL::SetAnchor(), Swap(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), GROUP_TOOL::Ungroup(), BOARD_INSPECTION_TOOL::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 EDIT_TOOL::setTransitions ( )

overrideprivatevirtual

< Set up handlers for various events.

Reimplemented from PCB_TOOL_BASE.

Definition at line 2591 of file edit_tool.cpp.

{
 Go( &EDIT_TOOL::GetAndPlace, PCB_ACTIONS::getAndPlace.MakeEvent() );
 Go( &EDIT_TOOL::Move, PCB_ACTIONS::move.MakeEvent() );
 Go( &EDIT_TOOL::Move, PCB_ACTIONS::moveIndividually.MakeEvent() );
 Go( &EDIT_TOOL::Drag, PCB_ACTIONS::drag45Degree.MakeEvent() );
 Go( &EDIT_TOOL::Drag, PCB_ACTIONS::dragFreeAngle.MakeEvent() );
 Go( &EDIT_TOOL::Rotate, PCB_ACTIONS::rotateCw.MakeEvent() );
 Go( &EDIT_TOOL::Rotate, PCB_ACTIONS::rotateCcw.MakeEvent() );
 Go( &EDIT_TOOL::Flip, PCB_ACTIONS::flip.MakeEvent() );
 Go( &EDIT_TOOL::Remove, ACTIONS::doDelete.MakeEvent() );
 Go( &EDIT_TOOL::Remove, PCB_ACTIONS::deleteFull.MakeEvent() );
 Go( &EDIT_TOOL::Properties, PCB_ACTIONS::properties.MakeEvent() );
 Go( &EDIT_TOOL::MoveExact, PCB_ACTIONS::moveExact.MakeEvent() );
 Go( &EDIT_TOOL::Move, PCB_ACTIONS::moveWithReference.MakeEvent() );
 Go( &EDIT_TOOL::Duplicate, ACTIONS::duplicate.MakeEvent() );
 Go( &EDIT_TOOL::Duplicate, PCB_ACTIONS::duplicateIncrement.MakeEvent() );
 Go( &EDIT_TOOL::CreateArray, PCB_ACTIONS::createArray.MakeEvent() );
 Go( &EDIT_TOOL::Mirror, PCB_ACTIONS::mirrorH.MakeEvent() );
 Go( &EDIT_TOOL::Mirror, PCB_ACTIONS::mirrorV.MakeEvent() );
 Go( &EDIT_TOOL::Swap, PCB_ACTIONS::swap.MakeEvent() );
 Go( &EDIT_TOOL::PackAndMoveFootprints, PCB_ACTIONS::packAndMoveFootprints.MakeEvent() );
 Go( &EDIT_TOOL::ChangeTrackWidth, PCB_ACTIONS::changeTrackWidth.MakeEvent() );
 Go( &EDIT_TOOL::FilletTracks, PCB_ACTIONS::filletTracks.MakeEvent() );
 Go( &EDIT_TOOL::FilletLines, PCB_ACTIONS::filletLines.MakeEvent() );
 
 Go( &EDIT_TOOL::copyToClipboard, ACTIONS::copy.MakeEvent() );
 Go( &EDIT_TOOL::copyToClipboard, PCB_ACTIONS::copyWithReference.MakeEvent() );
 Go( &EDIT_TOOL::cutToClipboard, ACTIONS::cut.MakeEvent() );
}