KiCad PCB EDA Suite
EDIT_TOOL Class Reference

EDIT_TOOL. More...

#include <edit_tool.h>

Inheritance diagram for EDIT_TOOL:
PCB_TOOL_BASE TOOL_INTERACTIVE TOOL_BASE

Public Types

enum  RESET_REASON { RUN, MODEL_RELOAD, GAL_SWITCH }
 

Determines the reason of reset for a tool

More...
 

Public Member Functions

 EDIT_TOOL ()
 
void Reset (RESET_REASON aReason) override
 Function Reset() Brings the tool to a known, initial state. More...
 
bool Init () override
 Function Init() Init() is called once upon a registration of the tool. More...
 
int GetAndPlace (const TOOL_EVENT &aEvent)
 

Find an item and start moving.

More...
 
int Move (const TOOL_EVENT &aEvent)
 Function Move() Main loop in which events are handled. More...
 
int Drag (const TOOL_EVENT &aEvent)
 Function Drag() Invoke the PNS router to drag tracks. More...
 
int Properties (const TOOL_EVENT &aEvent)
 Function Properties() Displays properties window for the selected object. More...
 
int Rotate (const TOOL_EVENT &aEvent)
 Function Rotate() Rotates currently selected items. More...
 
int Flip (const TOOL_EVENT &aEvent)
 Function Flip() Rotates currently selected items. More...
 
int Mirror (const TOOL_EVENT &aEvent)
 Function Mirror Mirrors the current selection. More...
 
int ChangeTrackWidth (const TOOL_EVENT &aEvent)
 
int FilletTracks (const TOOL_EVENT &aEvent)
 Function FilletTracks() Fillets (i.e. More...
 
int Remove (const TOOL_EVENT &aEvent)
 Function Remove() Deletes currently selected items. More...
 
int Duplicate (const TOOL_EVENT &aEvent)
 Function Duplicate() Duplicates the current selection and starts a move action. More...
 
int MoveExact (const TOOL_EVENT &aEvent)
 Function MoveExact() Invokes a dialog box to allow moving of the item by an exact amount. More...
 
int MoveWithReference (const TOOL_EVENT &aEvent)
 Moves an item but with a reference point selected first. More...
 
int CreateArray (const TOOL_EVENT &aEvent)
 Function CreateArray() Creates an array of the selected items, invoking the array editor dialog to set the options. More...
 
void setTransitions () override
 

Sets up handlers for various events.

More...
 
int copyToClipboard (const TOOL_EVENT &aEvent)
 Function copyToClipboard() Sends the current selection to the clipboard by formatting it as a fake pcb see AppendBoardFromClipboard for importing. More...
 
int cutToClipboard (const TOOL_EVENT &aEvent)
 Function cutToClipboard() Cuts the current selection to the clipboard by formatting it as a fake pcb see AppendBoardFromClipboard for importing. More...
 
BOARD_COMMITGetCurrentCommit () const
 
void SetIsFootprintEditor (bool aEnabled)
 Function SetIsFootprintEditor() More...
 
bool IsFootprintEditor () const
 
void Activate ()
 Function Activate() Runs the tool. More...
 
TOOL_MENUGetToolMenu ()
 
void SetContextMenu (ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
 Function SetContextMenu() More...
 
void RunMainStack (std::function< void()> aFunc)
 Function RunMainStack() More...
 
template<class T >
void Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
 Function Go() More...
 
TOOL_EVENTWait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
 Function Wait() More...
 
TOOL_TYPE GetType () const
 Function GetType() Returns the type of the tool. More...
 
TOOL_ID GetId () const
 Function GetId() Returns the unique identifier of the tool. More...
 
const std::string & GetName () const
 Function GetName() Returns the name of the tool. More...
 
TOOL_MANAGERGetManager () const
 Function GetManager() Returns 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, SELECTION_TOOL *sTool)
 Function FootprintFilter() 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, SELECTION_TOOL *sTool)
 Function PadFilter() A selection filter which prunes the selection to contain only items of type PCB_PAD_T. More...
 

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 std::string &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_VIEWview () const
 
KIGFX::VIEW_CONTROLScontrols () const
 
PCB_BASE_EDIT_FRAMEframe () const
 
BOARDboard () const
 
FOOTPRINTfootprint () const
 
const PCB_DISPLAY_OPTIONSdisplayOptions () const
 
PCB_DRAW_PANEL_GALcanvas () const
 
const PCBNEW_SELECTIONselection () const
 
PCBNEW_SELECTIONselection ()
 
void attachManager (TOOL_MANAGER *aManager)
 Function attachManager() More...
 
KIGFX::VIEWgetView () const
 Function getView() More...
 
KIGFX::VIEW_CONTROLSgetViewControls () const
 Function getViewControls() More...
 
template<typename T >
T * getEditFrame () const
 Function getEditFrame() More...
 
template<typename T >
T * getModel () const
 Function getModel() More...
 

Protected Attributes

bool m_isFootprintEditor
 
TOOL_MENU m_menu
 functions below are not yet implemented - their interface may change More...
 
TOOL_TYPE m_type
 

Stores the type of the tool.

More...
 
TOOL_ID m_toolId
 

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

More...
 
std::string m_toolName
 

Name of the tool.

More...
 
TOOL_MANAGERm_toolMgr
 

Private Member Functions

bool updateModificationPoint (PCBNEW_SELECTION &aSelection)
 

Returns the right modification point (e.g.

More...
 
bool invokeInlineRouter (int aDragMode)
 
bool isInteractiveDragEnabled () const
 
bool isRouterActive () const
 
int doMoveSelection (TOOL_EVENT aEvent, bool aPickReference=false)
 
bool pickReferencePoint (const wxString &aTooltip, const wxString &aSuccessMessage, const wxString &aCanceledMessage, VECTOR2I &aReferencePoint)
 

Private Attributes

SELECTION_TOOLm_selectionTool
 
bool m_dragging
 
bool m_lockedSelected
 
VECTOR2I m_cursor
 
std::unique_ptr< BOARD_COMMITm_commit
 
std::unique_ptr< STATUS_TEXT_POPUPm_statusPopup
 

Detailed Description

EDIT_TOOL.

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

Definition at line 74 of file edit_tool.h.

Member Enumeration Documentation

◆ INTERACTIVE_PLACEMENT_OPTIONS

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 111 of file pcb_tool_base.h.

111  {
113  IPO_ROTATE = 0x01,
114 
116  IPO_FLIP = 0x02,
117 
120  IPO_SINGLE_CLICK = 0x04,
121 
123  IPO_REPEAT = 0x08
124  };
Handle flip action in the loop by calling the item's flip method.
Allow repeat placement of the item.
Create an item immediately on placement starting, otherwise show the pencil cursor until the item is ...
Handle the rotate action in the loop by calling the item's rotate method.

◆ RESET_REASON

enum TOOL_BASE::RESET_REASON
inherited

Determines 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.

Definition at line 79 of file tool_base.h.

80  {
81  RUN,
82  MODEL_RELOAD,
83  GAL_SWITCH
84  };
Model changes (required full reload)
Definition: tool_base.h:82
Tool is invoked after being inactive.
Definition: tool_base.h:81
Rendering engine changes.
Definition: tool_base.h:83

Constructor & Destructor Documentation

◆ EDIT_TOOL()

EDIT_TOOL::EDIT_TOOL ( )

Definition at line 124 of file edit_tool.cpp.

124  :
125  PCB_TOOL_BASE( "pcbnew.InteractiveEdit" ),
127  m_dragging( false ),
128  m_lockedSelected( false )
129 {
130 }
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
bool m_lockedSelected
Definition: edit_tool.h:210
#define NULL
bool m_dragging
Definition: edit_tool.h:209
PCB_TOOL_BASE(TOOL_ID aId, const std::string &aName)
Constructor.
Definition: pcb_tool_base.h:78

Member Function Documentation

◆ Activate()

void TOOL_INTERACTIVE::Activate ( )
inherited

Function Activate() Runs the tool.

After activation, the tool starts receiving events until it is finished.

Definition at line 51 of file tool_interactive.cpp.

52 {
54 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
TOOL_ID m_toolId
Unique identifier for the tool, assigned by a TOOL_MANAGER instance.
Definition: tool_base.h:214
bool InvokeTool(TOOL_ID aToolId)
Function InvokeTool() Calls a tool by sending a tool activation event to tool of given ID.

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

Referenced by AUTOPLACE_TOOL::autoplace(), copyToClipboard(), LIB_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), PCBNEW_CONTROL::DeleteItemCursor(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PCB_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EnumeratePads(), PCBNEW_CONTROL::GridSetOrigin(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PCB_INSPECTION_TOOL::HighlightNetTool(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_INSPECTION_TOOL::LocalRatsnestTool(), PL_EDIT_TOOL::Main(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), LIB_TREE::onContextMenu(), POINT_EDITOR::OnSelectionChange(), GROUP_TOOL::PickNewMember(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), Remove(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), DRAWING_TOOL::SetAnchor(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER aManager)
protectedinherited

Function attachManager()

Sets the TOOL_MANAGER the tool will belong to. Called by TOOL_MANAGER::RegisterTool()

Definition at line 60 of file tool_base.cpp.

61 {
62  m_toolMgr = aManager;
63 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

◆ board()

BOARD* PCB_TOOL_BASE::board ( ) const
inlineprotectedinherited

Definition at line 160 of file pcb_tool_base.h.

160 { return getModel<BOARD>(); }

Referenced by PCBNEW_CONTROL::AppendBoard(), AUTOPLACE_TOOL::autoplace(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), ChangeTrackWidth(), ZONE_FILLER_TOOL::CheckAllZones(), PCB_INSPECTION_TOOL::ClearHighlight(), copyToClipboard(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), MICROWAVE_TOOL::createInductorBetween(), ROUTER_TOOL::CustomTrackWidthDialog(), PCBNEW_CONTROL::DeleteItemCursor(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), ZONE_FILLER_TOOL::FillAllZones(), FilletTracks(), SELECTION_TOOL::filterSelection(), PCB_TOOL_BASE::footprint(), SELECTION_TOOL::GetBoard(), SELECTION_TOOL::getCollectorsGuide(), GROUP_TOOL::Group(), PCB_INSPECTION_TOOL::highlightNet(), PCBNEW_CONTROL::LayerNext(), PCBNEW_CONTROL::LayerPrev(), PCB_INSPECTION_TOOL::LocalRatsnestTool(), MoveExact(), FOOTPRINT_EDITOR_TOOLS::NewFootprint(), ROUTER_TOOL::onViaCommand(), PCBNEW_CONTROL::Paste(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDITOR_CONTROL::PlaceModule(), PAD_TOOL::PlacePad(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), SELECTION_TOOL::RebuildSelection(), PAD_TOOL::recombinePad(), Remove(), PCB_EDITOR_CONTROL::RepairBoard(), PNS::TOOL_BASE::Reset(), PCBNEW_CONTROL::Reset(), SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectAllItemsOnNet(), SELECTION_TOOL::selectAllItemsOnSheet(), SELECTION_TOOL::selectConnectedTracks(), SELECTION_TOOL::selectPoint(), PCBNEW_CONTROL::TrackDisplayMode(), GROUP_TOOL::Ungroup(), PCBNEW_CONTROL::ViaDisplayMode(), PCBNEW_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), PCB_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

◆ canvas()

◆ ChangeTrackWidth()

int EDIT_TOOL::ChangeTrackWidth ( const TOOL_EVENT aEvent)

Definition at line 661 of file edit_tool.cpp.

662 {
664  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
665  {
666  EditToolSelectionFilter( aCollector, EXCLUDE_TRANSIENTS, sTool );
667  } );
668 
669  for( EDA_ITEM* item : selection )
670  {
671  if( auto via = dyn_cast<VIA*>( item ) )
672  {
673  m_commit->Modify( item );
674 
675  int new_width;
676  int new_drill;
677 
678  if( via->GetViaType() == VIATYPE::MICROVIA )
679  {
680  NETINFO_ITEM* net = via->GetNet();
681 
682  new_width = net->GetMicroViaSize();
683  new_drill = net->GetMicroViaDrillSize();
684  }
685  else
686  {
687  new_width = board()->GetDesignSettings().GetCurrentViaSize();
688  new_drill = board()->GetDesignSettings().GetCurrentViaDrill();
689  }
690 
691  via->SetDrill( new_drill );
692  via->SetWidth( new_width );
693  }
694  else if ( TRACK* track = dyn_cast<TRACK*>( item ) )
695  {
696  m_commit->Modify( item );
697 
698  int new_width = board()->GetDesignSettings().GetCurrentTrackWidth();
699  track->SetWidth( new_width );
700  }
701  }
702 
703  m_commit->Push( _("Edit track width/via size") );
704 
705  if( selection.IsHover() )
706  {
708 
709  // Notify other tools of the changes -- This updates the visual ratsnest
711  }
712 
713  return 0;
714 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:62
bool IsHover() const
Definition: selection.h:70
BOARD * board() const
int GetCurrentViaDrill() const
Function GetCurrentViaDrill.
int GetCurrentTrackWidth() const
Function GetCurrentTrackWidth.
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags, SELECTION_TOOL *selectionTool)
Definition: edit_tool.cpp:66
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:213
SELECTION_TOOL.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:559
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
static const TOOL_EVENT SelectedItemsModified
Definition: actions.h:213
const PCBNEW_SELECTION & selection() const
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
int GetCurrentViaSize() const
Function GetCurrentViaSize.
NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:65
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
int GetNet() const
Function GetNet.
Definition: netinfo.h:223
#define _(s)
Definition: 3d_actions.cpp:33
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:241
EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148
int GetMicroViaDrillSize()
Function GetViaDrillSize returns the size of via drills used to route this net.
Definition: netinfo.h:188
int GetMicroViaSize()
Function GetMicroViaSize returns the size of vias used to route this net.
Definition: netinfo.h:168
Definition: track.h:83

References _, PCB_TOOL_BASE::board(), EditToolSelectionFilter(), EXCLUDE_TRANSIENTS, BOARD_DESIGN_SETTINGS::GetCurrentTrackWidth(), BOARD_DESIGN_SETTINGS::GetCurrentViaDrill(), BOARD_DESIGN_SETTINGS::GetCurrentViaSize(), BOARD::GetDesignSettings(), NETINFO_ITEM::GetMicroViaDrillSize(), NETINFO_ITEM::GetMicroViaSize(), NETINFO_ITEM::GetNet(), SELECTION::IsHover(), m_commit, m_selectionTool, TOOL_BASE::m_toolMgr, MICROVIA, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), and PCB_ACTIONS::selectionClear.

Referenced by setTransitions().

◆ controls()

◆ copyToClipboard()

int EDIT_TOOL::copyToClipboard ( const TOOL_EVENT aEvent)

Function copyToClipboard() Sends the current selection to the clipboard by formatting it as a fake pcb see AppendBoardFromClipboard for importing.

Definition at line 1845 of file edit_tool.cpp.

1846 {
1847  std::string tool = "pcbnew.InteractiveEdit.selectReferencePoint";
1848  CLIPBOARD_IO io;
1849  GRID_HELPER grid( m_toolMgr, getEditFrame<PCB_BASE_EDIT_FRAME>()->GetMagneticItemsSettings() );
1850 
1851  frame()->PushTool( tool );
1852  Activate();
1853 
1855  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
1856  {
1858  sTool );
1859  } );
1860 
1861  if( !selection.Empty() )
1862  {
1863  std::vector<BOARD_ITEM*> items;
1864 
1865  for( EDA_ITEM* item : selection )
1866  items.push_back( static_cast<BOARD_ITEM*>( item ) );
1867 
1868  VECTOR2I refPoint;
1869 
1870  if( aEvent.IsAction( &PCB_ACTIONS::copyWithReference ) )
1871  {
1872  if( !pickReferencePoint( _( "Select reference point for the copy..." ),
1873  _( "Selection copied" ),
1874  _( "Copy cancelled" ),
1875  refPoint ) )
1876  return 0;
1877  }
1878  else
1879  {
1880  refPoint = grid.BestDragOrigin( getViewControls()->GetCursorPosition( false ), items );
1881  }
1882 
1883  selection.SetReferencePoint( refPoint );
1884 
1885  io.SetBoard( board() );
1887  frame()->SetStatusText( _( "Selection copied" ) );
1888  }
1889 
1890  frame()->PopTool( tool );
1891 
1892  return 0;
1893 }
BOARD * board() const
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags, SELECTION_TOOL *selectionTool)
Definition: edit_tool.cpp:66
SELECTION_TOOL.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
virtual void PushTool(const std::string &actionName)
NB: the definition of "tool" is different at the user level.
void SaveSelection(const PCBNEW_SELECTION &selected, bool isFootprintEditor)
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
void SetBoard(BOARD *aBoard)
bool IsAction(const TOOL_ACTION *aAction) const
Function IsAction() Tests if the event contains an action issued upon activation of the given TOOL_AC...
Definition: tool_event.cpp:67
bool pickReferencePoint(const wxString &aTooltip, const wxString &aSuccessMessage, const wxString &aCanceledMessage, VECTOR2I &aReferencePoint)
Definition: edit_tool.cpp:1767
PCB_BASE_EDIT_FRAME * frame() const
void SetReferencePoint(const VECTOR2I &aP)
Definition: selection.h:262
const PCBNEW_SELECTION & selection() const
virtual void PopTool(const std::string &actionName)
static TOOL_ACTION copyWithReference
copy command with manual reference point selection
Definition: pcb_actions.h:101
bool m_isFootprintEditor
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
#define _(s)
Definition: 3d_actions.cpp:33
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:241
EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148
void Activate()
Function Activate() Runs the tool.
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:42
#define EXCLUDE_LOCKED_PADS
Definition: edit_tool.h:54

References _, TOOL_INTERACTIVE::Activate(), GRID_HELPER::BestDragOrigin(), PCB_TOOL_BASE::board(), PCB_ACTIONS::copyWithReference, EditToolSelectionFilter(), SELECTION::Empty(), EXCLUDE_LOCKED_PADS, EXCLUDE_TRANSIENTS, PCB_TOOL_BASE::frame(), TOOL_BASE::getViewControls(), TOOL_EVENT::IsAction(), PCB_TOOL_BASE::m_isFootprintEditor, m_selectionTool, TOOL_BASE::m_toolMgr, pickReferencePoint(), TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), 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)

Function CreateArray() Creates an array of the selected items, invoking the array editor dialog to set the options.

Definition at line 1694 of file edit_tool.cpp.

1695 {
1696  if( isRouterActive() )
1697  {
1698  wxBell();
1699  return 0;
1700  }
1701 
1703  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
1704  {
1706  } );
1707 
1708  if( selection.Empty() )
1709  return 0;
1710 
1711  // we have a selection to work on now, so start the tool process
1712  PCB_BASE_FRAME* editFrame = getEditFrame<PCB_BASE_FRAME>();
1713  ARRAY_CREATOR array_creator( *editFrame, m_isFootprintEditor, selection );
1714  array_creator.Invoke();
1715 
1716  return 0;
1717 }
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags, SELECTION_TOOL *selectionTool)
Definition: edit_tool.cpp:66
SELECTION_TOOL.
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
const PCBNEW_SELECTION & selection() const
bool m_isFootprintEditor
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:241
bool isRouterActive() const
Definition: edit_tool.cpp:289
#define EXCLUDE_LOCKED_PADS
Definition: edit_tool.h:54
PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.

References EditToolSelectionFilter(), SELECTION::Empty(), EXCLUDE_LOCKED_PADS, EXCLUDE_TRANSIENTS, ARRAY_CREATOR::Invoke(), isRouterActive(), PCB_TOOL_BASE::m_isFootprintEditor, m_selectionTool, SELECTION_TOOL::RequestSelection(), and PCB_TOOL_BASE::selection().

Referenced by setTransitions().

◆ cutToClipboard()

int EDIT_TOOL::cutToClipboard ( const TOOL_EVENT aEvent)

Function cutToClipboard() Cuts the current selection to the clipboard by formatting it as a fake pcb see AppendBoardFromClipboard for importing.

Definition at line 1896 of file edit_tool.cpp.

1897 {
1898  if( !copyToClipboard( aEvent ) )
1899  {
1900  // N.B. Setting the CUT flag prevents lock filtering as we only want to delete the items that
1901  // were copied to the clipboard, no more, no fewer. Filtering for locked item, if any will be done
1902  // in the copyToClipboard() routine
1903  TOOL_EVENT evt( aEvent.Category(), aEvent.Action(), TOOL_ACTION_SCOPE::AS_GLOBAL );
1905  Remove( evt );
1906  }
1907 
1908  return 0;
1909 }
TOOL_ACTIONS Action() const
Returns more specific information about the type of an event.
Definition: tool_event.h:250
TOOL_EVENT_CATEGORY Category() const
Returns the category (eg. mouse/keyboard/action) of an event..
Definition: tool_event.h:247
void SetParameter(T aParam)
Function SetParameter() Sets a non-standard parameter assigned to the event.
Definition: tool_event.h:453
TOOL_EVENT.
Definition: tool_event.h:171
All active tools
Definition: tool_event.h:147
int Remove(const TOOL_EVENT &aEvent)
Function Remove() Deletes currently selected items.
Definition: edit_tool.cpp:1238
int copyToClipboard(const TOOL_EVENT &aEvent)
Function copyToClipboard() Sends the current selection to the clipboard by formatting it as a fake pc...
Definition: edit_tool.cpp:1845

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

Referenced by setTransitions().

◆ displayOptions()

const PCB_DISPLAY_OPTIONS & PCB_TOOL_BASE::displayOptions ( ) const
protectedinherited

◆ doInteractiveItemPlacement()

void PCB_TOOL_BASE::doInteractiveItemPlacement ( const std::string &  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
aItemCreatorthe callable that will attempt to create the item
aCommitMessagethe message used on a successful commit

Definition at line 36 of file pcb_tool_base.cpp.

39 {
40  using namespace std::placeholders;
41  std::unique_ptr<BOARD_ITEM> newItem;
42 
43  frame()->PushTool( aTool );
44  Activate();
45 
46  BOARD_COMMIT commit( frame() );
47 
49 
50  // do not capture or auto-pan until we start placing an item
51  controls()->ShowCursor( true );
52 
53  // Add a VIEW_GROUP that serves as a preview for the new item
54  PCBNEW_SELECTION preview;
55  view()->Add( &preview );
56 
57  aPlacer->m_board = board();
58  aPlacer->m_frame = frame();
59  aPlacer->m_modifiers = 0;
60 
61  auto makeNewItem =
62  [&]( VECTOR2I aPosition )
63  {
64  if( frame()->GetModel() )
65  newItem = aPlacer->CreateItem();
66 
67  if( newItem )
68  {
69  newItem->SetPosition( (wxPoint) aPosition );
70  preview.Add( newItem.get() );
71 
72  if( newItem->Type() == PCB_FOOTPRINT_T )
73  {
74  FOOTPRINT* fp = dyn_cast<FOOTPRINT*>( newItem.get() );
75 
76  // footprints have more drawable parts
77  fp->RunOnChildren( std::bind( &KIGFX::VIEW_GROUP::Add, &preview, _1 ) );
78  }
79  }
80  };
81 
82  if( aOptions & IPO_SINGLE_CLICK )
83  makeNewItem( controls()->GetCursorPosition() );
84 
85  auto setCursor =
86  [&]()
87  {
88  if( !newItem )
90  else
92  };
93 
94  // Set initial cursor
95  setCursor();
96 
97  // Main loop: keep receiving events
98  while( TOOL_EVENT* evt = Wait() )
99  {
100  setCursor();
101 
102  VECTOR2I cursorPos = controls()->GetCursorPosition();
103  aPlacer->m_modifiers = evt->Modifier();
104 
105  auto cleanup =
106  [&] ()
107  {
108  newItem = nullptr;
109  preview.Clear();
110  view()->Update( &preview );
111  controls()->SetAutoPan( false );
112  controls()->CaptureCursor( false );
113  controls()->ShowCursor( true );
114  };
115 
116  if( evt->IsCancelInteractive() )
117  {
118  if( aOptions & IPO_SINGLE_CLICK )
119  {
120  cleanup();
121  frame()->PopTool( aTool );
122  break;
123  }
124  else if( newItem )
125  cleanup();
126  else
127  {
128  frame()->PopTool( aTool );
129  break;
130  }
131  }
132  else if( evt->IsActivate() )
133  {
134  if( newItem )
135  cleanup();
136 
137  if( evt->IsPointEditor() )
138  {
139  // don't exit (the point editor runs in the background)
140  }
141  else if( evt->IsMoveTool() )
142  {
143  // leave ourselves on the stack so we come back after the move
144  break;
145  }
146  else
147  {
148  frame()->PopTool( aTool );
149  break;
150  }
151  }
152  else if( evt->IsClick( BUT_LEFT ) )
153  {
154  if( !newItem )
155  {
156  // create the item if possible
157  makeNewItem( cursorPos );
158 
159  // no item created, so wait for another click
160  if( !newItem )
161  continue;
162 
163  controls()->CaptureCursor( true );
164  controls()->SetAutoPan( true );
165  }
166  else
167  {
168  auto oldFlags = newItem->GetFlags();
169  newItem->ClearFlags();
170 
171  if( !aPlacer->PlaceItem( newItem.get(), commit ) )
172  {
173  newItem->SetFlags( oldFlags );
174  continue;
175  }
176 
177  preview.Clear();
178  newItem.release();
179  commit.Push( aCommitMessage );
180 
181  controls()->CaptureCursor( false );
182  controls()->SetAutoPan( false );
183  controls()->ShowCursor( true );
184 
185  if( !( aOptions & IPO_REPEAT ) )
186  break;
187 
188  if( aOptions & IPO_SINGLE_CLICK )
189  makeNewItem( controls()->GetCursorPosition() );
190 
191  setCursor();
192  }
193  }
194  else if( evt->IsClick( BUT_RIGHT ) )
195  {
197  }
198  else if( evt->IsAction( &PCB_ACTIONS::trackViaSizeChanged ) )
199  {
201  }
202  else if( newItem && evt->Category() == TC_COMMAND )
203  {
204  /*
205  * Handle any events that can affect the item as we move it around
206  */
207  if( TOOL_EVT_UTILS::IsRotateToolEvt( *evt ) && ( aOptions & IPO_ROTATE ) )
208  {
209  const int rotationAngle = TOOL_EVT_UTILS::GetEventRotationAngle( *frame(), *evt );
210  newItem->Rotate( newItem->GetPosition(), rotationAngle );
211  view()->Update( &preview );
212  }
213  else if( evt->IsAction( &PCB_ACTIONS::flip ) && ( aOptions & IPO_FLIP ) )
214  {
215  newItem->Flip( newItem->GetPosition(), frame()->Settings().m_FlipLeftRight );
216  view()->Update( &preview );
217  }
218  else if( evt->IsAction( &PCB_ACTIONS::viaSizeInc )
219  || evt->IsAction( &PCB_ACTIONS::viaSizeDec ) )
220  {
221  // Refresh preview after event runs
223  }
224  else if( evt->IsAction( &ACTIONS::refreshPreview ) )
225  {
226  preview.Clear();
227  newItem.release();
228 
229  makeNewItem( (wxPoint) cursorPos );
230  aPlacer->SnapItem( newItem.get() );
231  view()->Update( &preview );
232  }
233  }
234  else if( newItem && evt->IsMotion() )
235  {
236  // track the cursor
237  newItem->SetPosition( (wxPoint) cursorPos );
238  aPlacer->SnapItem( newItem.get() );
239 
240  // Show a preview of the item
241  view()->Update( &preview );
242  }
243  else
244  {
245  evt->SetPassEvent();
246  }
247  }
248 
249  view()->Remove( &preview );
251 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:62
virtual void ShowCursor(bool aEnabled)
Function ShowCursor() Enables or disables display of cursor.
TOOL_MENU m_menu
functions below are not yet implemented - their interface may change
virtual void Clear() override
Function Clear() Removes all the stored items from the group.
Definition: selection.h:94
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
virtual bool PlaceItem(BOARD_ITEM *aItem, BOARD_COMMIT &aCommit)
Handle flip action in the loop by calling the item's flip method.
BOARD * board() const
static TOOL_ACTION viaSizeInc
Definition: pcb_actions.h:296
virtual std::unique_ptr< BOARD_ITEM > CreateItem()=0
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
virtual void PushTool(const std::string &actionName)
NB: the definition of "tool" is different at the user level.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
static TOOL_ACTION trackViaSizeChanged
Definition: pcb_actions.h:299
bool IsRotateToolEvt(const TOOL_EVENT &aEvt)
Function isRotateToolEvt()
void SetCurrentCursor(KICURSOR cursor)
Function SetCurrentCursor Set the current cursor shape for this panel.
virtual void Remove(VIEW_ITEM *aItem) override
Function Remove() Removes a VIEW_ITEM from the view.
Definition: pcb_view.cpp:76
virtual void Add(EDA_ITEM *aItem)
Definition: selection.h:75
TOOL_MANAGER * GetManager() const
Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool.
Definition: tool_base.h:143
PCB_BASE_EDIT_FRAME * frame() const
virtual void SnapItem(BOARD_ITEM *aItem)
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: pcb_view.cpp:94
const PCBNEW_SELECTION & selection() const
Allow repeat placement of the item.
virtual void PopTool(const std::string &actionName)
virtual void CaptureCursor(bool aEnabled)
Function CaptureCursor() Forces the cursor to stay within the drawing panel area.
TOOL_EVENT.
Definition: tool_event.h:171
KIGFX::PCB_VIEW * view() const
Create an item immediately on placement starting, otherwise show the pencil cursor until the item is ...
virtual void Add(VIEW_ITEM *aItem)
Function Add() Adds an item to the group.
Definition: view_group.cpp:55
virtual void SetAutoPan(bool aEnabled)
Function SetAutoPan Turns on/off auto panning (this feature is used when there is a tool active (eg.
class FOOTPRINT, a footprint
Definition: typeinfo.h:89
virtual BOARD_ITEM_CONTAINER * GetModel() const =0
Function GetModel()
static TOOL_ACTION flip
Flipping of selected objects.
Definition: pcb_actions.h:108
Handle the rotate action in the loop by calling the item's rotate method.
KIGFX::VIEW_CONTROLS * controls() const
PCBNEW_SETTINGS & Settings()
void Activate()
Function Activate() Runs the tool.
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction) const
Function RunOnChildren.
Definition: footprint.cpp:1089
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1) override
Function Add() Adds a VIEW_ITEM to the view.
Definition: pcb_view.cpp:59
PCB_BASE_EDIT_FRAME * m_frame
Definition: pcb_tool_base.h:65
int GetEventRotationAngle(const PCB_BASE_EDIT_FRAME &aFrame, const TOOL_EVENT &aEvt)
Function getEventRotationAngle()
void ShowContextMenu(SELECTION &aSelection)
Function ShowContextMenu.
Definition: tool_menu.cpp:59
static TOOL_ACTION viaSizeDec
Definition: pcb_actions.h:297
static TOOL_ACTION refreshPreview
Definition: actions.h:104
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.

References TOOL_INTERACTIVE::Activate(), KIGFX::PCB_VIEW::Add(), KIGFX::VIEW_GROUP::Add(), SELECTION::Add(), ARROW, PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), PCB_TOOL_BASE::controls(), INTERACTIVE_PLACER_BASE::CreateItem(), PCB_ACTIONS::flip, PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_EVT_UTILS::GetEventRotationAngle(), TOOL_BASE::GetManager(), PCB_BASE_FRAME::GetModel(), 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, PCBNEW_SETTINGS::m_FlipLeftRight, INTERACTIVE_PLACER_BASE::m_frame, TOOL_INTERACTIVE::m_menu, INTERACTIVE_PLACER_BASE::m_modifiers, TOOL_BASE::m_toolMgr, PCB_FOOTPRINT_T, PENCIL, PLACE, INTERACTIVE_PLACER_BASE::PlaceItem(), TOOLS_HOLDER::PopTool(), BOARD_COMMIT::Push(), TOOLS_HOLDER::PushTool(), ACTIONS::refreshPreview, KIGFX::PCB_VIEW::Remove(), TOOL_MANAGER::RunAction(), FOOTPRINT::RunOnChildren(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), PCB_BASE_FRAME::Settings(), TOOL_MENU::ShowContextMenu(), KIGFX::VIEW_CONTROLS::ShowCursor(), INTERACTIVE_PLACER_BASE::SnapItem(), TC_COMMAND, PCB_ACTIONS::trackViaSizeChanged, KIGFX::PCB_VIEW::Update(), PCB_ACTIONS::viaSizeDec, PCB_ACTIONS::viaSizeInc, 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 ( TOOL_EVENT  aEvent,
bool  aPickReference = false 
)
private

Definition at line 342 of file edit_tool.cpp.

343 {
344  PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
346  VECTOR2I originalCursorPos = controls->GetCursorPosition();
347 
348  // Be sure that there is at least one item that we can modify. If nothing was selected before,
349  // try looking for the stuff under mouse cursor (i.e. Kicad old-style hover selection)
351  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
352  {
353  EditToolSelectionFilter( aCollector, EXCLUDE_TRANSIENTS, sTool );
354  } );
355 
356  if( m_dragging || selection.Empty() )
357  return 0;
358 
359  LSET item_layers = selection.GetSelectionLayers();
360  bool unselect = selection.IsHover(); // N.B. This must be saved before the re-selection below
361  VECTOR2I pickedReferencePoint;
362 
363  // Now filter out locked pads. We cannot do this in the first RequestSelection() as we need
364  // the item_layers when a pad is the selection front (ie: will become curr_tiem).
366  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
367  {
368  EditToolSelectionFilter( aCollector, EXCLUDE_LOCKED_PADS, sTool );
369  } );
370 
371  if( selection.Empty() )
372  return 0;
373 
374  std::string tool = aEvent.GetCommandStr().get();
375  editFrame->PushTool( tool );
376  Activate();
377  controls->ShowCursor( true );
378  controls->SetAutoPan( true );
379 
380  if( aPickReference && !pickReferencePoint( _( "Select reference point for move..." ), "", "",
381  pickedReferencePoint ) )
382  {
383  if( unselect )
385 
386  editFrame->PopTool( tool );
387  return 0;
388  }
389 
390  std::vector<BOARD_ITEM*> sel_items;
391 
392  for( EDA_ITEM* item : selection )
393  {
394  BOARD_ITEM* boardItem = dynamic_cast<BOARD_ITEM*>( item );
395  FOOTPRINT* footprint = dynamic_cast<FOOTPRINT*>( item );
396 
397  if( boardItem )
398  sel_items.push_back( boardItem );
399 
400  if( footprint )
401  {
402  for( PAD* pad : footprint->Pads() )
403  sel_items.push_back( pad );
404  }
405  }
406 
407  bool restore_state = false;
408  VECTOR2I totalMovement;
409  GRID_HELPER grid( m_toolMgr, editFrame->GetMagneticItemsSettings() );
410  TOOL_EVENT* evt = const_cast<TOOL_EVENT*>( &aEvent );
411  VECTOR2I prevPos;
412 
413  // Prime the pump
415 
416  // Main loop: keep receiving events
417  do
418  {
419  VECTOR2I movement;
421  grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
422  grid.SetUseGrid( !evt->Modifier( MD_ALT ) );
423 
424  if( evt->IsAction( &PCB_ACTIONS::move ) || evt->IsMotion() || evt->IsDrag( BUT_LEFT )
425  || evt->IsAction( &ACTIONS::refreshPreview )
426  || evt->IsAction( &PCB_ACTIONS::moveWithReference ) )
427  {
428  if( m_dragging && evt->Category() == TC_MOUSE )
429  {
430  bool requestRedraw3Dview = false;
431 
432  VECTOR2I mousePos( controls->GetMousePosition() );
433 
434  m_cursor = grid.BestSnapAnchor( mousePos, item_layers, sel_items );
435 
437  {
439 
440  // The arrow keys are by definition SINGLE AXIS. Do not allow the other
441  // axis to be snapped to the grid.
442  if( action == ACTIONS::CURSOR_LEFT || action == ACTIONS::CURSOR_RIGHT )
443  m_cursor.y = prevPos.y;
444  else if( action == ACTIONS::CURSOR_UP || action == ACTIONS::CURSOR_DOWN )
445  m_cursor.x = prevPos.x;
446  }
447 
450 
451  movement = m_cursor - prevPos;
452  prevPos = m_cursor;
453  totalMovement += movement;
454 
455  // Drag items to the current cursor position
456  for( EDA_ITEM* item : sel_items )
457  {
458  // Don't double move footprint pads, fields, etc.
459  //
460  // For PCB_GROUP_T, we make sure the selection includes only the top level
461  // group and not its descendants.
462  if( !item->GetParent() || !item->GetParent()->IsSelected() )
463  static_cast<BOARD_ITEM*>( item )->Move( movement );
464 
465  if( item->Type() == PCB_FOOTPRINT_T )
466  requestRedraw3Dview = true;
467  }
468 
469  if( requestRedraw3Dview )
470  editFrame->Redraw3Dview();
471 
473  }
474  else if( !m_dragging && !evt->IsAction( &ACTIONS::refreshPreview ) )
475  {
476  // Prepare to start dragging
477 
478  // deal with locked items (override lock or abort the operation)
480 
481  if( lockFlags == SELECTION_LOCKED )
482  break;
483 
484  if( !( evt->IsAction( &PCB_ACTIONS::move )
485  || evt->IsAction( &PCB_ACTIONS::moveWithReference ) )
487  {
489  break;
490  }
491 
492  m_dragging = true;
493 
494  // When editing footprints, all items have the same parent
495  if( IsFootprintEditor() )
496  {
497  m_commit->Modify( selection.Front() );
498  }
499  else
500  {
501  // Save items, so changes can be undone
502  for( EDA_ITEM* item : selection )
503  {
504  // Don't double move footprint pads, fields, etc.
505  //
506  // For PCB_GROUP_T, the parent is the board.
507  if( item->GetParent() && item->GetParent()->IsSelected() )
508  continue;
509 
510  m_commit->Modify( item );
511 
512  // If moving a group, record position of all the descendants for undo
513  if( item->Type() == PCB_GROUP_T )
514  {
515  PCB_GROUP* group = static_cast<PCB_GROUP*>( item );
516  group->RunOnDescendants( [&]( BOARD_ITEM* bItem )
517  {
518  m_commit->Modify( bItem );
519  });
520  }
521  }
522  }
523 
524  editFrame->UndoRedoBlock( true );
526 
528  {
529  // start moving with the reference point attached to the cursor
530  grid.SetAuxAxes( false );
531 
532  movement = m_cursor - selection.GetReferencePoint();
533 
534  // Drag items to the current cursor position
535  for( EDA_ITEM* item : selection )
536  {
537  // Don't double move footprint pads, fields, etc.
538  if( item->GetParent() && item->GetParent()->IsSelected() )
539  continue;
540 
541  static_cast<BOARD_ITEM*>( item )->Move( movement );
542  }
543 
545  }
546  else
547  {
548  std::vector<BOARD_ITEM*> items;
549 
550  for( EDA_ITEM* item : selection )
551  items.push_back( static_cast<BOARD_ITEM*>( item ) );
552 
553  m_cursor = grid.BestDragOrigin( originalCursorPos, items );
554 
555  // Set the current cursor position to the first dragged item origin, so the
556  // movement vector could be computed later
557  if( aPickReference )
558  {
559  selection.SetReferencePoint( pickedReferencePoint );
560  controls->ForceCursorPosition( true, pickedReferencePoint );
561  m_cursor = pickedReferencePoint;
562  }
563  else
564  {
565  // Check if user wants to warp the mouse to origin of moved object
566  if( !editFrame->GetMoveWarpsCursor() )
567  m_cursor = originalCursorPos; // No, so use original mouse pos instead
568 
570  grid.SetAuxAxes( true, m_cursor );
571  }
572  }
573 
575 
576  prevPos = m_cursor;
577  controls->SetAutoPan( true );
579  }
580 
581  m_toolMgr->RunAction( PCB_ACTIONS::updateLocalRatsnest, false, new VECTOR2I( movement ) );
582  }
583 
584  else if( evt->IsCancelInteractive() || evt->IsActivate() )
585  {
586  if( m_dragging && evt->IsCancelInteractive() )
587  evt->SetPassEvent( false );
588 
589  restore_state = true; // Canceling the tool means that items have to be restored
590  break; // Finish
591  }
592 
593  else if( evt->IsAction( &ACTIONS::undo ) )
594  {
595  restore_state = true; // Perform undo locally
596  break; // Finish
597  }
598 
599  // Dispatch TOOL_ACTIONs
600  else if( evt->IsAction( &ACTIONS::doDelete ) )
601  {
602  break; // finish -- there is no further processing for removed items
603  }
604  else if( evt->IsAction( &ACTIONS::duplicate ) )
605  {
606  break; // finish -- Duplicate tool will start a new Move with the dup'ed items
607  }
608  else if( evt->IsAction( &PCB_ACTIONS::moveExact ) )
609  {
610  // Reset positions so the Move Exactly is from the start.
611  for( EDA_ITEM* item : selection )
612  {
613  BOARD_ITEM* i = static_cast<BOARD_ITEM*>( item );
614  i->Move( -totalMovement );
615  }
616 
617  break; // finish -- we moved exactly, so we are finished
618  }
619 
620  else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) )
621  {
622  break; // finish
623  }
624 
625  else
626  {
627  evt->SetPassEvent();
628  }
629 
630  } while( ( evt = Wait() ) ); // Assignment (instead of equality test) is intentional
631 
632  m_lockedSelected = false;
633  controls->ForceCursorPosition( false );
634  controls->ShowCursor( false );
635  controls->SetAutoPan( false );
636 
637  m_dragging = false;
638  editFrame->UndoRedoBlock( false );
639 
640  // Discard reference point when selection is "dropped" onto the board
642 
643  // TODO: there's an ecapsulation leak here: this commit often has more than just the move
644  // in it; for instance it might have a paste, append board, etc. as well.
645  if( restore_state )
646  m_commit->Revert();
647  else
648  m_commit->Push( _( "Drag" ) );
649 
650  // Remove the dynamic ratsnest from the screen
652 
653  if( unselect )
655 
656  editFrame->PopTool( tool );
657  return 0;
658 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:62
VECTOR2I GetReferencePoint() const
Definition: selection.h:257
virtual void ShowCursor(bool aEnabled)
Function ShowCursor() Enables or disables display of cursor.
VECTOR2I m_cursor
Definition: edit_tool.h:211
void ClearReferencePoint()
Definition: selection.h:267
static TOOL_ACTION move
move or drag an item
Definition: pcb_actions.h:95
bool IsHover() const
Definition: selection.h:70
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
virtual VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Function GetMousePosition() Returns the current mouse pointer position.
void Redraw3Dview()
Request a redraw of 3D-Viewer canvas.
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags, SELECTION_TOOL *selectionTool)
Definition: edit_tool.cpp:66
static TOOL_ACTION doDelete
Definition: actions.h:75
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:109
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:213
PCB_GROUP is a set of BOARD_ITEMs (i.e., without duplicates)
Definition: pcb_group.h:50
SELECTION_TOOL.
SELECTION_LOCK_FLAGS CheckLock()
Checks if the user has agreed to modify locked items for the given selection.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
virtual void PushTool(const std::string &actionName)
NB: the definition of "tool" is different at the user level.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
virtual void SetCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true, bool aTriggeredByArrows=false, long aArrowCommand=0)=0
Moves cursor to the requested position expressed in world coordinates.
void UndoRedoBlock(bool aBlock=true)
Function UndoRedoBlock Enables/disable undo and redo operations.
virtual MAGNETIC_SETTINGS * GetMagneticItemsSettings()
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
void SetCurrentCursor(KICURSOR cursor)
Function SetCurrentCursor Set the current cursor shape for this panel.
static const TOOL_EVENT SelectedItemsModified
Definition: actions.h:213
PADS & Pads()
Definition: footprint.h:182
const VC_SETTINGS & GetSettings() const
Returns the current VIEW_CONTROLS settings
static TOOL_ACTION moveExact
Activation of the exact move tool.
Definition: pcb_actions.h:123
bool pickReferencePoint(const wxString &aTooltip, const wxString &aSuccessMessage, const wxString &aCanceledMessage, VECTOR2I &aReferencePoint)
Definition: edit_tool.cpp:1767
const LSET GetSelectionLayers()
bool m_lockedSelected
Definition: edit_tool.h:210
void SetReferencePoint(const VECTOR2I &aP)
Definition: selection.h:262
bool isInteractiveDragEnabled() const
Definition: edit_tool.cpp:281
LSET is a set of PCB_LAYER_IDs.
const PCBNEW_SELECTION & selection() const
bool m_dragging
Definition: edit_tool.h:209
virtual void Move(const wxPoint &aMoveVector)
Function Move move this object.
Definition: board_item.h:292
virtual void PopTool(const std::string &actionName)
SELECTION_LOCK_FLAGS
Definition: selection.h:296
TOOL_EVENT.
Definition: tool_event.h:171
FOOTPRINT * footprint() const
VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (such a...
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
static const TOOL_EVENT SelectedItemsMoved
Definition: actions.h:216
void RunOnDescendants(const std::function< void(BOARD_ITEM *)> &aFunction) const
Invokes a function on all descendents of the group.
Definition: pcb_group.cpp:327
static TOOL_ACTION hideDynamicRatsnest
Definition: pcb_actions.h:452
virtual void SetAutoPan(bool aEnabled)
Function SetAutoPan Turns on/off auto panning (this feature is used when there is a tool active (eg.
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
class FOOTPRINT, a footprint
Definition: typeinfo.h:89
OPT< std::string > GetCommandStr() const
Definition: tool_event.h:463
bool invokeInlineRouter(int aDragMode)
Definition: edit_tool.cpp:253
bool HasReferencePoint() const
Definition: selection.h:252
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
KIGFX::VIEW_CONTROLS * controls() const
Common, abstract interface for edit frames.
#define _(s)
Definition: 3d_actions.cpp:33
long m_lastKeyboardCursorCommand
ACTIONS::CURSOR_UP, ACTIONS::CURSOR_DOWN, etc.
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:241
bool m_lastKeyboardCursorPositionValid
Is last cursor motion event coming from keyboard arrow cursor motion action
EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148
bool IsFootprintEditor() const
bool GetMoveWarpsCursor() const
Indicates that a move operation should warp the mouse pointer to the origin of the move object.
Definition: tools_holder.h:159
void Activate()
Function Activate() Runs the tool.
static TOOL_ACTION undo
Definition: actions.h:67
static TOOL_ACTION updateLocalRatsnest
Definition: pcb_actions.h:453
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:42
Definition: pad.h:59
#define EXCLUDE_LOCKED_PADS
Definition: edit_tool.h:54
static TOOL_ACTION moveWithReference
move with a reference point
Definition: pcb_actions.h:98
void PostEvent(const TOOL_EVENT &aEvent)
Puts an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:274
static TOOL_ACTION duplicate
Definition: actions.h:74
static TOOL_ACTION refreshPreview
Definition: actions.h:104
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
EDA_ITEM * Front() const
Definition: selection.h:201

References _, TOOL_INTERACTIVE::Activate(), BUT_LEFT, SELECTION_TOOL::CheckLock(), SELECTION::ClearReferencePoint(), PCB_TOOL_BASE::controls(), ACTIONS::CURSOR_DOWN, ACTIONS::CURSOR_LEFT, ACTIONS::CURSOR_RIGHT, ACTIONS::CURSOR_UP, PNS::DM_ANY, ACTIONS::doDelete, ACTIONS::duplicate, EditToolSelectionFilter(), SELECTION::Empty(), EXCLUDE_LOCKED_PADS, EXCLUDE_TRANSIENTS, PCB_TOOL_BASE::footprint(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), SELECTION::Front(), PCB_BASE_FRAME::GetCanvas(), TOOL_EVENT::GetCommandStr(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), PCB_BASE_FRAME::GetMagneticItemsSettings(), KIGFX::VIEW_CONTROLS::GetMousePosition(), TOOLS_HOLDER::GetMoveWarpsCursor(), SELECTION::GetReferencePoint(), PCBNEW_SELECTION::GetSelectionLayers(), KIGFX::VIEW_CONTROLS::GetSettings(), TOOL_BASE::getViewControls(), SELECTION::HasReferencePoint(), PCB_ACTIONS::hideDynamicRatsnest, invokeInlineRouter(), PCB_TOOL_BASE::IsFootprintEditor(), SELECTION::IsHover(), isInteractiveDragEnabled(), m_commit, m_cursor, m_dragging, KIGFX::VC_SETTINGS::m_lastKeyboardCursorCommand, KIGFX::VC_SETTINGS::m_lastKeyboardCursorPositionValid, m_lockedSelected, m_selectionTool, TOOL_BASE::m_toolMgr, MD_ALT, MD_SHIFT, PCB_ACTIONS::move, BOARD_ITEM::Move(), PCB_ACTIONS::moveExact, PCB_ACTIONS::moveWithReference, MOVING, FOOTPRINT::Pads(), PCB_FOOTPRINT_T, PCB_GROUP_T, pickReferencePoint(), TOOLS_HOLDER::PopTool(), TOOL_MANAGER::PostEvent(), TOOLS_HOLDER::PushTool(), PCB_BASE_FRAME::Redraw3Dview(), ACTIONS::refreshPreview, SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), PCB_GROUP::RunOnDescendants(), EVENTS::SelectedItemsModified, EVENTS::SelectedItemsMoved, PCB_TOOL_BASE::selection(), SELECTION_LOCKED, PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), KIGFX::VIEW_CONTROLS::SetCursorPosition(), SELECTION::SetReferencePoint(), KIGFX::VIEW_CONTROLS::ShowCursor(), TC_MOUSE, ACTIONS::undo, PCB_BASE_EDIT_FRAME::UndoRedoBlock(), PCB_ACTIONS::updateLocalRatsnest, TOOL_INTERACTIVE::Wait(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Move(), and MoveWithReference().

◆ Drag()

int EDIT_TOOL::Drag ( const TOOL_EVENT aEvent)

Function Drag() Invoke the PNS router to drag tracks.

Definition at line 297 of file edit_tool.cpp.

298 {
299  int mode = PNS::DM_ANY;
300 
301  if( aEvent.IsAction( &PCB_ACTIONS::dragFreeAngle ) )
302  mode |= PNS::DM_FREE_ANGLE;
303 
304  // deal with locked items (override lock or abort the operation)
306 
307  if( lockFlags == SELECTION_LOCKED )
308  return 0;
309 
310  invokeInlineRouter( mode );
311 
312  return 0;
313 }
SELECTION_LOCK_FLAGS CheckLock()
Checks if the user has agreed to modify locked items for the given selection.
static TOOL_ACTION dragFreeAngle
Definition: pcb_actions.h:141
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
bool IsAction(const TOOL_ACTION *aAction) const
Function IsAction() Tests if the event contains an action issued upon activation of the given TOOL_AC...
Definition: tool_event.cpp:67
SELECTION_LOCK_FLAGS
Definition: selection.h:296
bool invokeInlineRouter(int aDragMode)
Definition: edit_tool.cpp:253

References SELECTION_TOOL::CheckLock(), PNS::DM_ANY, PNS::DM_FREE_ANGLE, PCB_ACTIONS::dragFreeAngle, invokeInlineRouter(), TOOL_EVENT::IsAction(), m_selectionTool, and SELECTION_LOCKED.

Referenced by setTransitions().

◆ Duplicate()

int EDIT_TOOL::Duplicate ( const TOOL_EVENT aEvent)

Function Duplicate() Duplicates the current selection and starts a move action.

Definition at line 1559 of file edit_tool.cpp.

1560 {
1561  if( isRouterActive() )
1562  {
1563  wxBell();
1564  return 0;
1565  }
1566 
1567  bool increment = aEvent.IsAction( &PCB_ACTIONS::duplicateIncrement );
1568 
1569  // Be sure that there is at least one item that we can modify
1571  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
1572  {
1574  } );
1575 
1576  if( selection.Empty() )
1577  return 0;
1578 
1579  // we have a selection to work on now, so start the tool process
1580  PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
1581 
1582  // If the selection was given a hover, we do not keep the selection after completion
1583  bool is_hover = selection.IsHover();
1584 
1585  std::vector<BOARD_ITEM*> new_items;
1586  new_items.reserve( selection.Size() );
1587 
1588 
1589  // Each selected item is duplicated and pushed to new_items list
1590  // Old selection is cleared, and new items are then selected.
1591  for( EDA_ITEM* item : selection )
1592  {
1593  BOARD_ITEM* dupe_item = nullptr;
1594  BOARD_ITEM* orig_item = static_cast<BOARD_ITEM*>( item );
1595 
1596  if( m_isFootprintEditor )
1597  {
1598  FOOTPRINT* parentFootprint = editFrame->GetBoard()->GetFirstFootprint();
1599  dupe_item = parentFootprint->DuplicateItem( orig_item );
1600 
1601  if( increment && item->Type() == PCB_PAD_T
1602  && PAD_NAMING::PadCanHaveName( *static_cast<PAD*>( dupe_item ) ) )
1603  {
1604  PAD_TOOL* padTool = m_toolMgr->GetTool<PAD_TOOL>();
1605  wxString padName = padTool->GetLastPadName();
1606  padName = parentFootprint->GetNextPadName( padName );
1607  padTool->SetLastPadName( padName );
1608  static_cast<PAD*>( dupe_item )->SetName( padName );
1609  }
1610  }
1611  else if( orig_item->GetParent() && orig_item->GetParent()->Type() == PCB_FOOTPRINT_T )
1612  {
1613  FOOTPRINT* parentFootprint = static_cast<FOOTPRINT*>( orig_item->GetParent() );
1614 
1615  m_commit->Modify( parentFootprint );
1616  dupe_item = parentFootprint->DuplicateItem( orig_item, true /* add to parent */ );
1617  }
1618  else
1619  {
1620  switch( orig_item->Type() )
1621  {
1622  case PCB_FOOTPRINT_T:
1623  case PCB_TEXT_T:
1624  case PCB_SHAPE_T:
1625  case PCB_TRACE_T:
1626  case PCB_VIA_T:
1627  case PCB_ZONE_T:
1628  case PCB_TARGET_T:
1629  case PCB_DIM_ALIGNED_T:
1630  case PCB_DIM_CENTER_T:
1631  case PCB_DIM_ORTHOGONAL_T:
1632  case PCB_DIM_LEADER_T:
1633  dupe_item = orig_item->Duplicate();
1634  break;
1635 
1636  case PCB_GROUP_T:
1637  dupe_item = static_cast<PCB_GROUP*>( orig_item )->DeepDuplicate();
1638  break;
1639 
1640  default:
1641  // Silently drop other items (such as footprint texts) from duplication
1642  break;
1643  }
1644  }
1645 
1646  if( dupe_item )
1647  {
1648  if( dupe_item->Type() == PCB_GROUP_T )
1649  {
1650  static_cast<PCB_GROUP*>( dupe_item )->RunOnDescendants(
1651  [&]( BOARD_ITEM* bItem )
1652  {
1653  m_commit->Add( bItem );
1654  });
1655  }
1656 
1657  // Clear the selection flag here, otherwise the SELECTION_TOOL
1658  // will not properly select it later on
1659  dupe_item->ClearSelected();
1660 
1661  new_items.push_back( dupe_item );
1662  m_commit->Add( dupe_item );
1663  }
1664  }
1665 
1666  // Clear the old selection first
1668 
1669  // Select the new items
1670  m_toolMgr->RunAction( PCB_ACTIONS::selectItems, true, &new_items );
1671 
1672  // record the new items as added
1673  if( !selection.Empty() )
1674  {
1675  editFrame->DisplayToolMsg( wxString::Format( _( "Duplicated %d item(s)" ),
1676  (int) new_items.size() ) );
1677 
1678  // If items were duplicated, pick them up
1679  // this works well for "dropping" copies around and pushes the commit
1681  Move( evt );
1682 
1683  // After moving the new items, we need to refresh the group and view flags
1685 
1686  if( !is_hover )
1687  m_toolMgr->RunAction( PCB_ACTIONS::selectItems, true, &new_items );
1688  }
1689 
1690  return 0;
1691 }
static TOOL_ACTION selectItems
Selects a list of items (specified as the event parameter)
Definition: pcb_actions.h:69
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:62
BOARD_ITEM * DuplicateItem(const BOARD_ITEM *aItem, bool aAddToFootprint=false)
Function DuplicateItem Duplicate a given item within the footprint, optionally adding it to the board...
Definition: footprint.cpp:1498
static TOOL_ACTION move
move or drag an item
Definition: pcb_actions.h:95
class ALIGNED_DIMENSION, a linear dimension (graphic item)
Definition: typeinfo.h:101
class LEADER, a leader dimension (graphic item)
Definition: typeinfo.h:102
bool IsHover() const
Definition: selection.h:70
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags, SELECTION_TOOL *selectionTool)
Definition: edit_tool.cpp:66
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:109
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:213
void ClearSelected()
Definition: eda_item.h:199
SELECTION_TOOL.
class CENTER_DIMENSION, a center point marking (graphic item)
Definition: typeinfo.h:103
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
PAD_TOOL.
Definition: pad_tool.h:37
class PCB_TEXT, text on a layer
Definition: typeinfo.h:92
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
class PAD, a pad in a footprint
Definition: typeinfo.h:90
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
bool IsAction(const TOOL_ACTION *aAction) const
Function IsAction() Tests if the event contains an action issued upon activation of the given TOOL_AC...
Definition: tool_event.cpp:67
static TOOL_ACTION duplicateIncrement
Activation of the duplication tool with incrementing (e.g. pad number)
Definition: pcb_actions.h:126
const PCBNEW_SELECTION & selection() const
void SetLastPadName(const wxString &aPadName)
Definition: pad_tool.h:67
FOOTPRINT * GetFirstFootprint() const
Gets the first footprint on the board or nullptr.
Definition: board.h:348
wxString GetLastPadName() const
Definition: pad_tool.h:66
bool PadCanHaveName(const PAD &aPad)
Check if a pad should be named.
Definition: pad_naming.cpp:26
TOOL_EVENT.
Definition: tool_event.h:171
class ZONE, a copper pour area
Definition: typeinfo.h:106
bool m_isFootprintEditor
int Move(const TOOL_EVENT &aEvent)
Function Move() Main loop in which events are handled.
Definition: edit_tool.cpp:316
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:105
class FOOTPRINT, a footprint
Definition: typeinfo.h:89
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
Common, abstract interface for edit frames.
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetNextPadName(const wxString &aLastPadName) const
Function GetNextPadName returns the next available pad name in the footprint.
Definition: footprint.cpp:1583
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:241
TOOL_EVENT MakeEvent() const
Returns the event associated with the action (i.e.
Definition: tool_action.h:113
int Size() const
Returns the number of selected parts.
Definition: selection.h:126
bool isRouterActive() const
Definition: edit_tool.cpp:289
EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148
virtual BOARD_ITEM * Duplicate() const
Function Duplicate creates a copy of a BOARD_ITEM.
Definition: board_item.h:215
class ORTHOGONAL_DIMENSION, a linear dimension constrained to x/y
Definition: typeinfo.h:104
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
BOARD * GetBoard() const
#define EXCLUDE_LOCKED_PADS
Definition: edit_tool.h:54
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:179
class PCB_SHAPE, a segment not on copper layers
Definition: typeinfo.h:91
void DisplayToolMsg(const wxString &msg) override
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

References _, EDA_ITEM::ClearSelected(), EDA_DRAW_FRAME::DisplayToolMsg(), BOARD_ITEM::Duplicate(), PCB_ACTIONS::duplicateIncrement, FOOTPRINT::DuplicateItem(), EditToolSelectionFilter(), SELECTION::Empty(), EXCLUDE_LOCKED_PADS, EXCLUDE_TRANSIENTS, Format(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), PAD_TOOL::GetLastPadName(), FOOTPRINT::GetNextPadName(), 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, PAD_NAMING::PadCanHaveName(), PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItems, PAD_TOOL::SetLastPadName(), SELECTION::Size(), and EDA_ITEM::Type().

Referenced by setTransitions().

◆ FilletTracks()

int EDIT_TOOL::FilletTracks ( const TOOL_EVENT aEvent)

Function FilletTracks() Fillets (i.e.

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

Definition at line 717 of file edit_tool.cpp.

718 {
719  // Store last used fillet radius to allow pressing "enter" if repeat fillet is required
720  static long long filletRadiusIU = 0;
721 
723  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
724  {
726  aCollector, EXCLUDE_LOCKED | EXCLUDE_LOCKED_PADS | EXCLUDE_TRANSIENTS, sTool );
727  },
728  nullptr, !m_dragging );
729 
730  if( selection.Size() < 2 )
731  {
733  _( "A minimum of two straight track segments must be selected." ) );
734  return 0;
735  }
736 
738  frame(), _( "Enter fillet radius:" ), _( "Fillet Tracks" ), filletRadiusIU );
739 
740  if( dia.ShowModal() == wxID_CANCEL )
741  return 0;
742 
743  filletRadiusIU = dia.GetValue();
744 
745  if( filletRadiusIU == 0 )
746  {
747  frame()->ShowInfoBarMsg( _( "A radius of zero was entered.\n"
748  "The fillet operation was not performed." ) );
749  return 0;
750  }
751 
752 
753  struct FILLET_OP
754  {
755  TRACK* t1;
756  TRACK* t2;
757  //If true, start point of track is modified after ARC is added, otherwise the end point:
758  bool t1Start = true;
759  bool t2Start = true;
760  };
761 
762  std::vector<FILLET_OP> filletOperations;
763  KICAD_T track_types[] = { PCB_PAD_T, PCB_VIA_T, PCB_TRACE_T, PCB_ARC_T, EOT };
764  bool operationPerformedOnAtLeastOne = false;
765  bool didOneAttemptFail = false;
766  std::set<TRACK*> processedTracks;
767 
768  for( auto it = selection.begin(); it != selection.end(); it++ )
769  {
770  TRACK* track = dyn_cast<TRACK*>( *it );
771 
772  if( !track || track->Type() != PCB_TRACE_T || track->IsLocked()
773  || track->GetLength() == 0 )
774  {
775  continue;
776  }
777 
778  auto processFilletOp =
779  [&]( bool aStartPoint )
780  {
781  wxPoint anchor = ( aStartPoint ) ? track->GetStart() : track->GetEnd();
782 
783  std::vector<BOARD_CONNECTED_ITEM*> itemsOnAnchor =
784  board()->GetConnectivity()->GetConnectedItemsAtAnchor( track, VECTOR2I( anchor ),
785  track_types );
786 
787  if( itemsOnAnchor.size() > 0 && selection.Contains( itemsOnAnchor.at( 0 ) )
788  && itemsOnAnchor.at( 0 )->Type() == PCB_TRACE_T )
789  {
790  TRACK* trackOther = dyn_cast<TRACK*>( itemsOnAnchor.at( 0 ) );
791 
792  // Make sure we don't fillet the same pair of tracks twice
793  if( processedTracks.find( trackOther ) == processedTracks.end() )
794  {
795  if( itemsOnAnchor.size() == 1 )
796  {
797  FILLET_OP filletOp;
798  filletOp.t1 = track;
799  filletOp.t2 = trackOther;
800  filletOp.t1Start = aStartPoint;
801  filletOp.t2Start = track->IsPointOnEnds( filletOp.t2->GetStart() );
802  filletOperations.push_back( filletOp );
803  }
804  else
805  {
806  // User requested to fillet these two tracks but not possible as there are other
807  // elements connected at that point
808  didOneAttemptFail = true;
809  }
810  }
811  }
812  };
813 
814  processFilletOp( true ); // on the start point of track
815  processFilletOp( false ); // on the end point of track
816 
817  processedTracks.insert( track );
818  }
819 
820  std::vector<BOARD_ITEM*> itemsToAddToSelection;
821 
822  for( FILLET_OP filletOp : filletOperations )
823  {
824  TRACK* track1 = filletOp.t1;
825  TRACK* track2 = filletOp.t2;
826 
827  bool trackOnStart = track1->IsPointOnEnds( track2->GetStart() );
828  bool trackOnEnd = track1->IsPointOnEnds( track2->GetEnd() );
829 
830  if( trackOnStart && trackOnEnd )
831  continue; // Ignore duplicate tracks
832 
833  if( ( trackOnStart || trackOnEnd ) && track1->GetLayer() == track2->GetLayer() )
834  {
835  SEG t1Seg( track1->GetStart(), track1->GetEnd() );
836  SEG t2Seg( track2->GetStart(), track2->GetEnd() );
837 
838  if( t1Seg.ApproxCollinear( t2Seg ) )
839  continue;
840 
841  SHAPE_ARC sArc( t1Seg, t2Seg, filletRadiusIU );
842 
843  wxPoint t1newPoint, t2newPoint;
844 
845  auto setIfPointOnSeg = []( wxPoint& aPointToSet, SEG aSegment, VECTOR2I aVecToTest )
846  {
847  VECTOR2I segToVec = aSegment.NearestPoint( aVecToTest ) - aVecToTest;
848 
849  // Find out if we are on the segment (minimum precision)
850  if( segToVec.EuclideanNorm() < SHAPE_ARC::MIN_PRECISION_IU )
851  {
852  aPointToSet.x = aVecToTest.x;
853  aPointToSet.y = aVecToTest.y;
854  return true;
855  }
856 
857  return false;
858  };
859 
860  //Do not draw a fillet if the end points of the arc are not within the track segments
861  if( !setIfPointOnSeg( t1newPoint, t1Seg, sArc.GetP0() )
862  && !setIfPointOnSeg( t2newPoint, t2Seg, sArc.GetP0() ) )
863  {
864  didOneAttemptFail = true;
865  continue;
866  }
867 
868  if( !setIfPointOnSeg( t1newPoint, t1Seg, sArc.GetP1() )
869  && !setIfPointOnSeg( t2newPoint, t2Seg, sArc.GetP1() ) )
870  {
871  didOneAttemptFail = true;
872  continue;
873  }
874 
875  ARC* tArc = new ARC( frame()->GetBoard(), &sArc );
876  tArc->SetLayer( track1->GetLayer() );
877  tArc->SetWidth( track1->GetWidth() );
878  tArc->SetNet( track1->GetNet() );
879  m_commit->Add( tArc );
880  itemsToAddToSelection.push_back( tArc );
881 
882  m_commit->Modify( track1 );
883  m_commit->Modify( track2 );
884 
885  if( filletOp.t1Start )
886  track1->SetStart( t1newPoint );
887  else
888  track1->SetEnd( t1newPoint );
889 
890  if( filletOp.t2Start )
891  track2->SetStart( t2newPoint );
892  else
893  track2->SetEnd( t2newPoint );
894 
895  operationPerformedOnAtLeastOne = true;
896  }
897  }
898 
899  m_commit->Push( _( "Fillet Tracks" ) );
900 
901  //select the newly created arcs
902  for( BOARD_ITEM* item : itemsToAddToSelection )
903  {
904  m_selectionTool->AddItemToSel( item );
905  }
906 
907  if( !operationPerformedOnAtLeastOne )
908  {
909  frame()->ShowInfoBarMsg( _( "Unable to fillet the selected track segments." ) );
910  }
911  else if( didOneAttemptFail )
912  {
913  frame()->ShowInfoBarMsg( _( "Some of the track segments could not be filleted." ) );
914  }
915 
916  return 0;
917 }
bool IsLocked() const override
Function IsLocked.
Definition: track.h:136
BOARD * board() const
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags, SELECTION_TOOL *selectionTool)
Definition: edit_tool.cpp:66
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
Definition: board_item.h:206
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
void SetEnd(const wxPoint &aEnd)
Definition: track.h:112
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:213
NETINFO_ITEM * GetNet() const
Function GetNet Returns NET_INFO object for a given item.
const wxPoint & GetStart() const
Definition: track.h:116
SELECTION_TOOL.
ITER end()
Definition: selection.h:61
void ShowInfoBarMsg(const wxString &aMsg)
class ARC, an arc track segment on a copper layer
Definition: typeinfo.h:98
class PAD, a pad in a footprint
Definition: typeinfo.h:90
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
void SetWidth(int aWidth)
Definition: track.h:109
PCB_BASE_EDIT_FRAME * frame() const
ITER begin()
Definition: selection.h:60
const PCBNEW_SELECTION & selection() const
An extension of WX_TEXT_ENTRY_DIALOG that uses UNIT_BINDER to request a dimension (e....
bool m_dragging
Definition: edit_tool.h:209
void AddItemToSel(BOARD_ITEM *aItem, bool aQuietMode=false)
bool Contains(EDA_ITEM *aItem) const
Definition: selection.h:112
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:382
static const int MIN_PRECISION_IU
This is the minimum precision for all the points in the arc shape.
Definition: shape_arc.h:41
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
BOARD * GetBoard()
Definition: seg.h:39
void SetNet(NETINFO_ITEM *aNetInfo)
Function SetNet Sets a NET_INFO object for the item.
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
int GetWidth() const
Definition: track.h:110
STATUS_FLAGS IsPointOnEnds(const wxPoint &point, int min_dist=0) const
Function IsPointOnEnds returns STARTPOINT if point if near (dist = min_dist) start point,...
Definition: track.cpp:185
Definition: track.h:272
#define _(s)
Definition: 3d_actions.cpp:33
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:241
int Size() const
Returns the number of selected parts.
Definition: selection.h:126
const wxPoint & GetEnd() const
Definition: track.h:113
virtual double GetLength() const
Function GetLength returns the length of the track using the hypotenuse calculation.
Definition: track.h:151
void SetStart(const wxPoint &aStart)
Definition: track.h:115
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
T EuclideanNorm() const
Destructor.
Definition: vector2d.h:299
#define EXCLUDE_LOCKED
Function EditToolSelectionFilter.
Definition: edit_tool.h:53
#define EXCLUDE_LOCKED_PADS
Definition: edit_tool.h:54
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
Definition: board_item.h:185
Definition: track.h:83
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

References _, SELECTION_TOOL::AddItemToSel(), ARC, SELECTION::begin(), PCB_TOOL_BASE::board(), SELECTION::Contains(), EditToolSelectionFilter(), SELECTION::end(), EOT, VECTOR2< T >::EuclideanNorm(), EXCLUDE_LOCKED, EXCLUDE_LOCKED_PADS, EXCLUDE_TRANSIENTS, PCB_TOOL_BASE::frame(), GetBoard(), BOARD::GetConnectivity(), TRACK::GetEnd(), BOARD_ITEM::GetLayer(), TRACK::GetLength(), BOARD_CONNECTED_ITEM::GetNet(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), TRACK::GetStart(), WX_UNIT_ENTRY_DIALOG::GetValue(), TRACK::GetWidth(), TRACK::IsLocked(), TRACK::IsPointOnEnds(), m_commit, m_dragging, m_selectionTool, SHAPE_ARC::MIN_PRECISION_IU, PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, SELECTION_TOOL::RequestSelection(), PCB_TOOL_BASE::selection(), TRACK::SetEnd(), BOARD_ITEM::SetLayer(), BOARD_CONNECTED_ITEM::SetNet(), TRACK::SetStart(), TRACK::SetWidth(), EDA_BASE_FRAME::ShowInfoBarMsg(), SELECTION::Size(), EDA_ITEM::Type(), and VECTOR2< T >::x.

Referenced by setTransitions().

◆ Flip()

int EDIT_TOOL::Flip ( const TOOL_EVENT aEvent)

Function Flip() Rotates currently selected items.

The rotation point is the current cursor position.

Definition at line 1168 of file edit_tool.cpp.

1169 {
1170  if( isRouterActive() )
1171  {
1172  wxBell();
1173  return 0;
1174  }
1175 
1177  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
1178  {
1180  },
1181  nullptr, !m_dragging );
1182 
1183  if( selection.Empty() )
1184  return 0;
1185 
1187 
1188  // Flip around the anchor for footprints, and the bounding box center for board items
1189  VECTOR2I modPoint = IsFootprintEditor() ? VECTOR2I( 0, 0 ) : selection.GetCenter();
1190 
1191  // If only one item selected, flip around the selection or item anchor point (instead
1192  // of the bounding box center) to avoid moving the item anchor
1193  if( selection.GetSize() == 1 )
1194  {
1196  modPoint = selection.GetReferencePoint();
1197  else
1198  modPoint = static_cast<BOARD_ITEM*>( selection.GetItem( 0 ) )->GetPosition();
1199  }
1200 
1201  bool leftRight = frame()->Settings().m_FlipLeftRight;
1202 
1203  // When editing footprints, all items have the same parent
1204  if( IsFootprintEditor() )
1205  m_commit->Modify( selection.Front() );
1206 
1207  for( EDA_ITEM* item : selection )
1208  {
1209  if( !item->IsNew() && !IsFootprintEditor() )
1210  m_commit->Modify( item );
1211 
1212  if( item->Type() == PCB_GROUP_T )
1213  {
1214  static_cast<PCB_GROUP*>( item )->RunOnDescendants( [&]( BOARD_ITEM* bItem )
1215  {
1216  m_commit->Modify( bItem );
1217  });
1218  }
1219 
1220  static_cast<BOARD_ITEM*>( item )->Flip( modPoint, leftRight );
1221  }
1222 
1223  if( !m_dragging )
1224  m_commit->Push( _( "Flip" ) );
1225 
1226  if( selection.IsHover() && !m_dragging )
1228 
1230 
1231  if( m_dragging )
1233 
1234  return 0;
1235 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:62
VECTOR2I GetReferencePoint() const
Definition: selection.h:257
bool IsHover() const
Definition: selection.h:70
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags, SELECTION_TOOL *selectionTool)
Definition: edit_tool.cpp:66
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:109
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:213
SELECTION_TOOL.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
static const TOOL_EVENT SelectedItemsModified
Definition: actions.h:213
PCB_BASE_EDIT_FRAME * frame() const
const PCBNEW_SELECTION & selection() const
bool m_dragging
Definition: edit_tool.h:209
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
virtual KIGFX::VIEW_ITEM * GetItem(unsigned int aIdx) const override
Definition: selection.h:104
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
virtual unsigned int GetSize() const override
Function GetSize() Returns the number of stored items.
Definition: selection.h:99
bool HasReferencePoint() const
Definition: selection.h:252
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
#define _(s)
Definition: 3d_actions.cpp:33
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:241
PCBNEW_SETTINGS & Settings()
bool isRouterActive() const
Definition: edit_tool.cpp:289
EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148
bool IsFootprintEditor() const
static TOOL_ACTION updateLocalRatsnest
Definition: pcb_actions.h:453
#define EXCLUDE_LOCKED_PADS
Definition: edit_tool.h:54
bool updateModificationPoint(PCBNEW_SELECTION &aSelection)
Returns the right modification point (e.g.
Definition: edit_tool.cpp:1744
EDA_ITEM * Front() const
Definition: selection.h:201

References _, EditToolSelectionFilter(), SELECTION::Empty(), EXCLUDE_LOCKED_PADS, EXCLUDE_TRANSIENTS, PCB_TOOL_BASE::frame(), SELECTION::Front(), SELECTION::GetCenter(), SELECTION::GetItem(), 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(), SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_BASE_FRAME::Settings(), PCB_ACTIONS::updateLocalRatsnest, and updateModificationPoint().

Referenced by setTransitions().

◆ footprint()

◆ FootprintFilter()

void EDIT_TOOL::FootprintFilter ( const VECTOR2I ,
GENERAL_COLLECTOR aCollector,
SELECTION_TOOL sTool 
)
static

Function FootprintFilter() A selection filter which prunes the selection to contain only items of type PCB_MODULE_T.

Definition at line 1732 of file edit_tool.cpp.

1733 {
1734  for( int i = aCollector.GetCount() - 1; i >= 0; i-- )
1735  {
1736  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( aCollector[i] );
1737 
1738  if( item->Type() != PCB_FOOTPRINT_T )
1739  aCollector.Remove( i );
1740  }
1741 }
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
void Remove(int aIndex)
Function Remove removes the item at aIndex (first position is 0);.
Definition: collector.h:133
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:104
class FOOTPRINT, a footprint
Definition: typeinfo.h:89
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

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

Referenced by PCB_EDITOR_CONTROL::EditFpInFpEditor(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), and PCB_INSPECTION_TOOL::LocalRatsnestTool().

◆ frame()

PCB_BASE_EDIT_FRAME* PCB_TOOL_BASE::frame ( ) const
inlineprotectedinherited

Definition at line 155 of file pcb_tool_base.h.

156  {
157  return getEditFrame<PCB_BASE_EDIT_FRAME>();
158  }

Referenced by 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_TOOLS::DeleteFootprint(), PCB_TOOL_BASE::displayOptions(), PCB_TOOL_BASE::doInteractiveItemPlacement(), ROUTER_TOOL::DpDimensionsDialog(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), PCB_EDITOR_CONTROL::ExportSpecctraDSN(), ZONE_FILLER_TOOL::FillAllZones(), FilletTracks(), ROUTER_TOOL::finishInteractive(), Flip(), PCB_EDITOR_CONTROL::FlipPcbView(), GLOBAL_EDIT_TOOL::GlobalDeletions(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), PCB_EDITOR_CONTROL::ImportSpecctraSession(), ROUTER_TOOL::Init(), SELECTION_TOOL::Init(), Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCBNEW_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::meanderSettingsDialog(), MoveExact(), POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::onViaCommand(), PCBNEW_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), GROUP_TOOL::PickNewMember(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), PAD_TOOL::pushPadSettings(), PAD_TOOL::recombinePad(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), Remove(), POINT_EDITOR::removeCorner(), PNS::TOOL_BASE::Reset(), ROUTER_TOOL::SelectCopperLayerPair(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), POINT_EDITOR::setEditedPoint(), ROUTER_TOOL::SettingsDialog(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), ROUTER_TOOL::switchLayerOnViaPlacement(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), ZONE_FILLER_TOOL::ZoneFill(), and ZONE_FILLER_TOOL::ZoneFillAll().

◆ GetAndPlace()

int EDIT_TOOL::GetAndPlace ( const TOOL_EVENT aEvent)

Find an item and start moving.

Definition at line 235 of file edit_tool.cpp.

236 {
237  SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<SELECTION_TOOL>();
238  FOOTPRINT* fp = getEditFrame<PCB_BASE_FRAME>()->GetFootprintFromBoardByReference();
239 
240  if( fp )
241  {
243  m_toolMgr->RunAction( PCB_ACTIONS::selectItem, true, (void*) fp );
244 
245  selectionTool->GetSelection().SetReferencePoint( fp->GetPosition() );
247  }
248 
249  return 0;
250 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:62
static TOOL_ACTION move
move or drag an item
Definition: pcb_actions.h:95
SELECTION_TOOL.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
PCBNEW_SELECTION & GetSelection()
Function GetSelection()
void SetReferencePoint(const VECTOR2I &aP)
Definition: selection.h:262
static TOOL_ACTION selectItem
Selects an item (specified as the event parameter).
Definition: pcb_actions.h:65

References 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 190 of file edit_tool.h.

190 { return m_commit.get(); }
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:213

References m_commit.

◆ getEditFrame()

template<typename T >
T* TOOL_BASE::getEditFrame ( ) const
inlineprotectedinherited

Function getEditFrame()

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

Definition at line 187 of file tool_base.h.

188  {
189 #if !defined( QA_TEST ) // Dynamic casts give the linker a siezure in the test framework
190  wxASSERT( dynamic_cast<T*>( getToolHolderInt() ) );
191 #endif
192  return static_cast<T*>( getToolHolderInt() );
193  }
TOOLS_HOLDER * getToolHolderInt() const
Definition: tool_base.cpp:48

References TOOL_BASE::getToolHolderInt().

Referenced by ZONE_CREATE_HELPER::createNewZone().

◆ GetId()

TOOL_ID TOOL_BASE::GetId ( ) const
inlineinherited

Function GetId() Returns 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.

122  {
123  return m_toolId;
124  }
TOOL_ID m_toolId
Unique identifier for the tool, assigned by a TOOL_MANAGER instance.
Definition: tool_base.h:214

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

Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool.

Returns
Instance of the TOOL_MANAGER. If there is no TOOL_MANAGER associated, it returns NULL.

Definition at line 143 of file tool_base.h.

144  {
145  return m_toolMgr;
146  }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219

References TOOL_BASE::m_toolMgr.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), PCB_TOOL_BASE::doInteractiveItemPlacement(), ACTION_MENU::getToolManager(), LIB_TREE::onContextMenu(), ZONE_CREATE_HELPER::OnFirstPoint(), ACTION_MENU::OnMenuEvent(), and ZONE_CREATE_HELPER::performZoneCutout().

◆ getModel()

template<typename T >
T* TOOL_BASE::getModel ( ) const
inlineprotectedinherited

Function getModel()

Returns the model object if it matches the requested type.

Definition at line 201 of file tool_base.h.

202  {
203  EDA_ITEM* m = getModelInt();
204 #if !defined( QA_TEST ) // Dynamic casts give the linker a siezure in the test framework
205  wxASSERT( dynamic_cast<T*>( m ) );
206 #endif
207  return static_cast<T*>( m );
208  }
EDA_ITEM * getModelInt() const
Definition: tool_base.cpp:54
EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148

References TOOL_BASE::getModelInt().

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

◆ GetName()

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

Function GetName() Returns 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 132 of file tool_base.h.

133  {
134  return m_toolName;
135  }
std::string m_toolName
Name of the tool.
Definition: tool_base.h:218

References TOOL_BASE::m_toolName.

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

◆ GetToolMenu()

◆ GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const
inlineinherited

Function GetType() Returns the type of the tool.

Returns
The type of the tool.

Definition at line 110 of file tool_base.h.

111  {
112  return m_type;
113  }
TOOL_TYPE m_type
Stores the type of the tool.
Definition: tool_base.h:211

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

Function getView()

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.

37 {
38  return m_toolMgr->GetView();
39 }
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:290
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219

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(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::collectHits(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), COMMON_TOOLS::CursorControl(), LIB_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), PCBNEW_CONTROL::DeleteItemCursor(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_EDIT_TOOL::DoDelete(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), MICROWAVE_TOOL::drawMicrowaveInductor(), PL_DRAWING_TOOLS::DrawShape(), PCB_EDITOR_CONTROL::DrillOrigin(), LIB_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), SCH_EDITOR_CONTROL::FindComponentAndItem(), EE_SELECTION_TOOL::GetNode(), ROUTER_TOOL::getStartLayer(), PCBNEW_CONTROL::GridResetOrigin(), PCBNEW_CONTROL::GridSetOrigin(), SELECTION_TOOL::GuessSelectionCandidates(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), PNS::TOOL_BASE::highlightNet(), PCB_INSPECTION_TOOL::highlightNet(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), MoveExact(), SCH_MOVE_TOOL::moveItem(), PL_EDIT_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), LIB_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), PNS::TOOL_BASE::pickSingleItem(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), SCH_EDIT_TOOL::Properties(), Properties(), Remove(), PCB_EDITOR_CONTROL::Reset(), PNS::TOOL_BASE::Reset(), PCBNEW_CONTROL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), DRAWING_TOOL::Reset(), EE_SELECTION_TOOL::Reset(), SELECTION_TOOL::Reset(), EE_TOOL_BASE< SCH_BASE_FRAME >::Reset(), SCH_EDIT_TOOL::Rotate(), GERBVIEW_SELECTION_TOOL::select(), GERBVIEW_SELECTION_TOOL::selectable(), SELECTION_TOOL::Selectable(), SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::SelectAll(), PL_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectionContains(), SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), GERBVIEW_SELECTION_TOOL::unselectVisually(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), POINT_EDITOR::updateEditedPoint(), SCH_EDITOR_CONTROL::UpdateFind(), PL_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updateParentItem(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_VIEWER_TOOLS::view(), PCB_TOOL_BASE::view(), SELECTION_TOOL::zoomFitSelection(), EE_SELECTION_TOOL::~EE_SELECTION_TOOL(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), and SELECTION_TOOL::~SELECTION_TOOL().

◆ getViewControls()

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

Function getViewControls()

Returns 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.

43 {
44  return m_toolMgr->GetViewControls();
45 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
KIGFX::VIEW_CONTROLS * GetViewControls() const
Definition: tool_manager.h:292

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

Referenced by EE_POINT_EDITOR::addCorner(), POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), SCH_EDITOR_CONTROL::AssignNetclass(), SCH_EDIT_TOOL::BreakWire(), PCB_TOOL_BASE::controls(), copyToClipboard(), SCH_DRAWING_TOOLS::createSheetPin(), COMMON_TOOLS::CursorControl(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomToPreset(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), LIB_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PCB_INSPECTION_TOOL::HighlightNet(), SCH_EDITOR_CONTROL::HighlightNet(), PCB_INSPECTION_TOOL::HighlightNetTool(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), PL_EDIT_TOOL::Main(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), LENGTH_TUNER_TOOL::performTuning(), LIB_DRAWING_TOOLS::PlaceAnchor(), PCBNEW_CONTROL::placeBoardItems(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), SCH_EDIT_TOOL::Properties(), Properties(), Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), PL_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), POINT_EDITOR::Reset(), DRAWING_TOOL::Reset(), COMMON_TOOLS::ResetLocalCoords(), GERBVIEW_SELECTION_TOOL::selectCursor(), SELECTION_TOOL::selectCursor(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectNode(), ZOOM_TOOL::selectRegion(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), PCBNEW_PICKER_TOOL::setControls(), EE_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), POINT_EDITOR::updateEditedPoint(), POINT_EDITOR::updateItem(), PL_EDIT_TOOL::updateModificationPoint(), 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_EVENTTC_ANYTA_ANY ) 
)
inherited

Function Go()

Defines which state (aStateFunc) to go when a certain event arrives (aConditions). No conditions means any event.

Definition at line 129 of file tool_interactive.h.

131 {
132  TOOL_STATE_FUNC sptr = std::bind( aStateFunc, static_cast<T*>( this ), std::placeholders::_1 );
133 
134  goInternal( sptr, aConditions );
135 }
std::function< int(const TOOL_EVENT &)> TOOL_STATE_FUNC
Definition: tool_base.h:58
void goInternal(TOOL_STATE_FUNC &aState, const TOOL_EVENT_LIST &aConditions)

References TOOL_INTERACTIVE::goInternal().

Referenced by ZOOM_TOOL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), LENGTH_TUNER_TOOL::setTransitions(), PCB_REANNOTATE_TOOL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), LIB_PIN_TOOL::setTransitions(), SCH_NAVIGATE_TOOL::setTransitions(), LIB_MOVE_TOOL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), EE_POINT_EDITOR::setTransitions(), PL_POINT_EDITOR::setTransitions(), COMMON_CONTROL::setTransitions(), ZONE_FILLER_TOOL::setTransitions(), EE_INSPECTION_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), CONVERT_TOOL::setTransitions(), DRC_TOOL::setTransitions(), PCB_VIEWER_TOOLS::setTransitions(), POINT_EDITOR::setTransitions(), LIB_DRAWING_TOOLS::setTransitions(), MICROWAVE_TOOL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), PAD_TOOL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), SCH_MOVE_TOOL::setTransitions(), GROUP_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), LIB_CONTROL::setTransitions(), LIB_EDIT_TOOL::setTransitions(), SCH_DRAWING_TOOLS::setTransitions(), PL_EDIT_TOOL::setTransitions(), FOOTPRINT_EDITOR_TOOLS::setTransitions(), SCH_EDIT_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), PCBNEW_CONTROL::setTransitions(), EDA_3D_CONTROLLER::setTransitions(), ALIGN_DISTRIBUTE_TOOL::setTransitions(), COMMON_TOOLS::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::setTransitions(), PCBNEW_PICKER_TOOL::setTransitions(), PICKER_TOOL::setTransitions(), PCB_INSPECTION_TOOL::setTransitions(), PCB_EDITOR_CONTROL::setTransitions(), DRAWING_TOOL::setTransitions(), setTransitions(), SELECTION_TOOL::setTransitions(), PL_SELECTION_TOOL::setTransitions(), SCH_EDITOR_CONTROL::setTransitions(), and EE_SELECTION_TOOL::setTransitions().

◆ Init()

bool EDIT_TOOL::Init ( void  )
overridevirtual

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

Returns
True if the initialization went fine, false - otherwise.

Reimplemented from PCB_TOOL_BASE.

Definition at line 157 of file edit_tool.cpp.

158 {
159  // Find the selection tool, so they can cooperate
160  m_selectionTool = static_cast<SELECTION_TOOL*>( m_toolMgr->FindTool( "pcbnew.InteractiveSelection" ) );
161  wxASSERT_MSG( m_selectionTool, "pcbnew.InteractiveSelection tool is not available" );
162 
163  auto inFootprintEditor =
164  [ this ] ( const SELECTION& aSelection )
165  {
166  return m_isFootprintEditor;
167  };
168 
169  auto singleFootprintCondition = SELECTION_CONDITIONS::OnlyType( PCB_FOOTPRINT_T )
171 
172  auto noActiveToolCondition =
173  [ this ] ( const SELECTION& aSelection )
174  {
175  return frame()->ToolStackIsEmpty();
176  };
177 
178  auto notMovingCondition =
179  [ this ] ( const SELECTION& aSelection )
180  {
183  };
184 
185  auto noItemsCondition =
186  [ this ] ( const SELECTION& aSelections ) -> bool
187  {
188  return frame()->GetBoard() && !frame()->GetBoard()->IsEmpty();
189  };
190 
191  // Add context menu entries that are displayed when selection tool is active
193 
194  menu.AddItem( PCB_ACTIONS::move, SELECTION_CONDITIONS::NotEmpty && notMovingCondition );
203  menu.AddItem( PCB_ACTIONS::mirror, inFootprintEditor && SELECTION_CONDITIONS::NotEmpty );
204 
208 
210 
211  // Add the submenu for create array and special move
212  auto specialToolsSubMenu = std::make_shared<SPECIAL_TOOLS_CONTEXT_MENU>( this );
213  menu.AddSeparator();
214  m_selectionTool->GetToolMenu().AddSubMenu( specialToolsSubMenu );
215  menu.AddMenu( specialToolsSubMenu.get(), SELECTION_CONDITIONS::NotEmpty, 100 );
216 
217  menu.AddSeparator( 150 );
220  // Selection tool handles the context menu for some other tools, such as the Picker.
221  // Don't add things like Paste when another tool is active.
222  menu.AddItem( ACTIONS::paste, noActiveToolCondition, 150 );
223  menu.AddItem( ACTIONS::selectAll, noItemsCondition, 150 );
224 
225  // Footprint actions
226  menu.AddSeparator( 150 );
227  menu.AddItem( PCB_ACTIONS::editFpInFpEditor, singleFootprintCondition, 150 );
228  menu.AddItem( PCB_ACTIONS::updateFootprint, singleFootprintCondition, 150 );
229  menu.AddItem( PCB_ACTIONS::changeFootprint, singleFootprintCondition, 150 );
230 
231  return true;
232 }
void AddMenu(ACTION_MENU *aMenu, const SELECTION_CONDITION &aCondition=SELECTION_CONDITIONS::ShowAlways, int aOrder=ANY_ORDER)
Adds a submenu to the menu.
bool IsCurrentTool(const TOOL_ACTION &aAction) const
static TOOL_ACTION move
move or drag an item
Definition: pcb_actions.h:95
static const KICAD_T Tracks[]
A scan list for only TRACKs.
Definition: collectors.h:299
static TOOL_ACTION editFpInFpEditor
Definition: pcb_actions.h:340
static TOOL_ACTION doDelete
Definition: actions.h:75
static SELECTION_CONDITION OnlyTypes(const KICAD_T aTypes[])
Creates a functor that tests if the selected items are only of given types.
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
static TOOL_ACTION dragFreeAngle
Definition: pcb_actions.h:141
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
static TOOL_ACTION properties
Activation of the edit tool.
Definition: pcb_actions.h:120
TOOL_MENU & GetToolMenu()
static TOOL_ACTION drag45Degree
Definition: pcb_actions.h:140
static TOOL_ACTION mirror
Mirroring of selected items.
Definition: pcb_actions.h:111
static TOOL_ACTION changeFootprint
Definition: pcb_actions.h:320
static TOOL_ACTION updateFootprint
Definition: pcb_actions.h:318
TOOL_BASE * FindTool(int aId) const
Function FindTool() Searches for a tool with given ID.
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
static SELECTION_CONDITION Count(int aNumber)
Creates a functor that tests if the number of selected items is equal to the value given as parameter...
static bool NotEmpty(const SELECTION &aSelection)
Tests if there are any items selected.
static TOOL_ACTION filletTracks
Fillets (i.e. adds an arc tangent to) all selected straight tracks by a user defined radius.
Definition: pcb_actions.h:117
PCB_BASE_EDIT_FRAME * frame() const
static TOOL_ACTION copy
Definition: actions.h:70
static TOOL_ACTION rotateCw
Rotation of selected objects.
Definition: pcb_actions.h:104
static TOOL_ACTION cut
Definition: actions.h:69
bool ToolStackIsEmpty()
Definition: tools_holder.h:136
bool m_isFootprintEditor
static TOOL_ACTION inlineBreakTrack
Breaks track when router is not activated.
Definition: pcb_actions.h:138
class FOOTPRINT, a footprint
Definition: typeinfo.h:89
void AddSeparator(int aOrder=ANY_ORDER)
Adds a separator to the menu.
static TOOL_ACTION rotateCcw
Definition: pcb_actions.h:105
static TOOL_ACTION flip
Flipping of selected objects.
Definition: pcb_actions.h:108
void AddSubMenu(std::shared_ptr< ACTION_MENU > aSubMenu)
Function CreateSubMenu.
Definition: tool_menu.cpp:52
static SELECTION_CONDITION OnlyType(KICAD_T aType)
Creates a functor that tests if the selected items are only of given type.
BOARD * GetBoard() const
static TOOL_ACTION moveWithReference
move with a reference point
Definition: pcb_actions.h:98
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Adds a menu entry to run a TOOL_ACTION on selected items.
static TOOL_ACTION selectAll
Definition: actions.h:73
bool IsEmpty() const
Definition: board.h:329
static TOOL_ACTION paste
Definition: actions.h:71
static TOOL_ACTION duplicate
Definition: actions.h:74

References CONDITIONAL_MENU::AddItem(), CONDITIONAL_MENU::AddMenu(), CONDITIONAL_MENU::AddSeparator(), TOOL_MENU::AddSubMenu(), PCB_ACTIONS::changeFootprint, ACTIONS::copy, SELECTION_CONDITIONS::Count(), ACTIONS::cut, ACTIONS::doDelete, PCB_ACTIONS::drag45Degree, PCB_ACTIONS::dragFreeAngle, ACTIONS::duplicate, PCB_ACTIONS::editFpInFpEditor, PCB_ACTIONS::filletTracks, TOOL_MANAGER::FindTool(), PCB_ACTIONS::flip, PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetBoard(), TOOL_MENU::GetMenu(), TOOL_INTERACTIVE::GetToolMenu(), PCB_ACTIONS::inlineBreakTrack, TOOLS_HOLDER::IsCurrentTool(), BOARD::IsEmpty(), PCB_TOOL_BASE::m_isFootprintEditor, m_selectionTool, TOOL_BASE::m_toolMgr, PCB_ACTIONS::mirror, PCB_ACTIONS::move, PCB_ACTIONS::moveWithReference, SELECTION_CONDITIONS::NotEmpty(), SELECTION_CONDITIONS::OnlyType(), SELECTION_CONDITIONS::OnlyTypes(), ACTIONS::paste, PCB_FOOTPRINT_T, PCB_ACTIONS::properties, PCB_ACTIONS::rotateCcw, PCB_ACTIONS::rotateCw, ACTIONS::selectAll, TOOLS_HOLDER::ToolStackIsEmpty(), GENERAL_COLLECTOR::Tracks, and PCB_ACTIONS::updateFootprint.

◆ invokeInlineRouter()

bool EDIT_TOOL::invokeInlineRouter ( int  aDragMode)
private

Definition at line 253 of file edit_tool.cpp.

254 {
256 
257  if( !theRouter )
258  return false;
259 
260  // don't allow switch from moving to dragging
261  if( m_dragging )
262  {
263  wxBell();
264  return false;
265  }
266 
267  // make sure we don't accidentally invoke inline routing mode while the router is already active!
268  if( theRouter->IsToolActive() )
269  return false;
270 
271  if( theRouter->CanInlineDrag() )
272  {
274  return true;
275  }
276 
277  return false;
278 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
bool m_dragging
Definition: edit_tool.h:209
static TOOL_ACTION routerInlineDrag
Activation of the Push and Shove router (inline dragging mode)
Definition: pcb_actions.h:205
static ROUTER * theRouter
Definition: pns_router.cpp:57

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

Referenced by doMoveSelection(), and Drag().

◆ IsFootprintEditor()

bool PCB_TOOL_BASE::IsFootprintEditor ( ) const
inlineinherited

◆ isInteractiveDragEnabled()

bool EDIT_TOOL::isInteractiveDragEnabled ( ) const
private

Definition at line 281 of file edit_tool.cpp.

282 {
284 
285  return router && router->Router()->Settings().InlineDragEnabled();
286 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
ROUTER * Router() const
ROUTING_SETTINGS & Settings()
Definition: pns_router.h:200

References TOOL_MANAGER::GetTool(), PNS::ROUTING_SETTINGS::InlineDragEnabled(), TOOL_BASE::m_toolMgr, PNS::TOOL_BASE::Router(), and PNS::ROUTER::Settings().

Referenced by doMoveSelection().

◆ isRouterActive()

bool EDIT_TOOL::isRouterActive ( ) const
private

Definition at line 289 of file edit_tool.cpp.

290 {
292 
293  return router && router->IsToolActive();
294 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
bool IsToolActive() const
Definition: tool_base.cpp:31

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

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

◆ IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const
inherited

Definition at line 31 of file tool_base.cpp.

32 {
33  return m_toolMgr->IsToolActive( m_toolId );
34 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
TOOL_ID m_toolId
Unique identifier for the tool, assigned by a TOOL_MANAGER instance.
Definition: tool_base.h:214
bool IsToolActive(TOOL_ID aId) const
Function IsToolActive() Returns true if a tool with given id is active (executing)

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

Referenced by isRouterActive(), and ROUTER_TOOL::onViaCommand().

◆ Mirror()

int EDIT_TOOL::Mirror ( const TOOL_EVENT aEvent)

Function Mirror Mirrors the current selection.

The mirror axis passes through the current point.

Definition at line 1070 of file edit_tool.cpp.

1071 {
1072  if( isRouterActive() )
1073  {
1074  wxBell();
1075  return 0;
1076  }
1077 
1079  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
1080  {
1082  },
1083  nullptr, !m_dragging );
1084 
1085  if( selection.Empty() )
1086  return 0;
1087 
1089  auto refPoint = selection.GetReferencePoint();
1090  wxPoint mirrorPoint( refPoint.x, refPoint.y );
1091 
1092  // When editing footprints, all items have the same parent
1093  if( IsFootprintEditor() )
1094  m_commit->Modify( selection.Front() );
1095 
1096  for( EDA_ITEM* item : selection )
1097  {
1098  // only modify items we can mirror
1099  switch( item->Type() )
1100  {
1101  case PCB_FP_SHAPE_T:
1102  case PCB_FP_TEXT_T:
1103  case PCB_FP_ZONE_T:
1104  case PCB_PAD_T:
1105  // Only create undo entry for items on the board
1106  if( !item->IsNew() && !IsFootprintEditor() )
1107  m_commit->Modify( item );
1108 
1109  break;
1110  default:
1111  continue;
1112  }
1113 
1114  // modify each object as necessary
1115  switch( item->Type() )
1116  {
1117  case PCB_FP_SHAPE_T:
1118  {
1119  FP_SHAPE* shape = static_cast<FP_SHAPE*>( item );
1120  shape->Mirror( mirrorPoint, false );
1121  break;
1122  }
1123 
1124  case PCB_FP_ZONE_T:
1125  {
1126  FP_ZONE* zone = static_cast<FP_ZONE*>( item );
1127  zone->Mirror( mirrorPoint, false );
1128  break;
1129  }
1130 
1131  case PCB_FP_TEXT_T:
1132  {
1133  FP_TEXT* text = static_cast<FP_TEXT*>( item );
1134  text->Mirror( mirrorPoint, false );
1135  break;
1136  }
1137 
1138  case PCB_PAD_T:
1139  {
1140  PAD* pad = static_cast<PAD*>( item );
1141  mirrorPadX( *pad, mirrorPoint );
1142  break;
1143  }
1144 
1145  default:
1146  // it's likely the commit object is wrong if you get here
1147  // Unsure if PCB_GROUP_T needs special attention here.
1148  assert( false );
1149  break;
1150  }
1151  }
1152 
1153  if( !m_dragging )
1154  m_commit->Push( _( "Mirror" ) );
1155 
1156  if( selection.IsHover() && !m_dragging )
1158 
1160 
1161  if( m_dragging )
1163 
1164  return 0;
1165 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:62
VECTOR2I GetReferencePoint() const
Definition: selection.h:257
bool IsHover() const
Definition: selection.h:70
class FP_TEXT, text in a footprint
Definition: typeinfo.h:93
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags, SELECTION_TOOL *selectionTool)
Definition: edit_tool.cpp:66
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:213
SELECTION_TOOL.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
static void mirrorPadX(PAD &aPad, const wxPoint &aMirrorPoint)
Mirror a pad in the vertical axis passing through a point (mirror left to right)
Definition: edit_tool.cpp:1048
class FP_SHAPE, a footprint edge
Definition: typeinfo.h:94
class PAD, a pad in a footprint
Definition: typeinfo.h:90
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
void Mirror(const wxPoint &aCentre, bool aMirrorAroundXAxis)
Mirror text position in footprint editing the text itself is not mirrored, and the layer not modified...
Definition: fp_text.cpp:172
static const TOOL_EVENT SelectedItemsModified
Definition: actions.h:213
const PCBNEW_SELECTION & selection() const
bool m_dragging
Definition: edit_tool.h:209
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
#define _(s)
Definition: 3d_actions.cpp:33
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:241
void Mirror(const wxPoint &aCentre, bool aMirrorAroundXAxis)
Mirror an edge of the footprint.
Definition: fp_shape.cpp:233
class ZONE, managed by a footprint
Definition: typeinfo.h:95
bool isRouterActive() const
Definition: edit_tool.cpp:289
void Mirror(const wxPoint &aMirrorRef, bool aMirrorLeftRight)
Function Mirror Mirror the outlines , relative to a given horizontal axis the layer is not changed.
Definition: zone.cpp:763
EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148
bool IsFootprintEditor() const
static TOOL_ACTION updateLocalRatsnest
Definition: pcb_actions.h:453
Definition: pad.h:59
#define EXCLUDE_LOCKED_PADS
Definition: edit_tool.h:54
bool updateModificationPoint(PCBNEW_SELECTION &aSelection)
Returns the right modification point (e.g.
Definition: edit_tool.cpp:1744
FP_ZONE is a specialization of ZONE for use in footprints.
Definition: zone.h:957
EDA_ITEM * Front() const
Definition: selection.h:201

References _, EditToolSelectionFilter(), SELECTION::Empty(), EXCLUDE_LOCKED_PADS, EXCLUDE_TRANSIENTS, SELECTION::Front(), SELECTION::GetReferencePoint(), PCB_TOOL_BASE::IsFootprintEditor(), SELECTION::IsHover(), isRouterActive(), m_commit, m_dragging, m_selectionTool, TOOL_BASE::m_toolMgr, FP_SHAPE::Mirror(), FP_TEXT::Mirror(), ZONE::Mirror(), mirrorPadX(), PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_PAD_T, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::updateLocalRatsnest, and updateModificationPoint().

Referenced by setTransitions().

◆ Move()

int EDIT_TOOL::Move ( const TOOL_EVENT aEvent)

Function Move() Main loop in which events are handled.

Definition at line 316 of file edit_tool.cpp.

317 {
318  if( isRouterActive() )
319  {
320  wxBell();
321  return 0;
322  }
323 
324  return doMoveSelection( aEvent );
325 }
int doMoveSelection(TOOL_EVENT aEvent, bool aPickReference=false)
Definition: edit_tool.cpp:342
bool isRouterActive() const
Definition: edit_tool.cpp:289

References doMoveSelection(), and isRouterActive().

Referenced by Duplicate(), and setTransitions().

◆ MoveExact()

int EDIT_TOOL::MoveExact ( const TOOL_EVENT aEvent)

Function MoveExact() Invokes a dialog box to allow moving of the item by an exact amount.

Definition at line 1462 of file edit_tool.cpp.

1463 {
1464  if( isRouterActive() )
1465  {
1466  wxBell();
1467  return 0;
1468  }
1469 
1471  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
1472  {
1473  EditToolSelectionFilter( aCollector,
1475  } );
1476 
1477  if( selection.Empty() )
1478  return 0;
1479 
1480  wxPoint translation;
1481  double rotation;
1482  ROTATION_ANCHOR rotationAnchor = selection.Size() > 1 ? ROTATE_AROUND_SEL_CENTER
1484 
1485  // TODO: Implement a visible bounding border at the edge
1486  auto sel_box = selection.GetBoundingBox();
1487 
1488  DIALOG_MOVE_EXACT dialog( frame(), translation, rotation, rotationAnchor, sel_box );
1489  int ret = dialog.ShowModal();
1490 
1491  if( ret == wxID_OK )
1492  {
1493  VECTOR2I rp = selection.GetCenter();
1494  wxPoint selCenter( rp.x, rp.y );
1495 
1496  // Make sure the rotation is from the right reference point
1497  selCenter += translation;
1498 
1499  // When editing footprints, all items have the same parent
1500  if( IsFootprintEditor() )
1501  m_commit->Modify( selection.Front() );
1502 
1503  for( EDA_ITEM* selItem : selection )
1504  {
1505  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( selItem );
1506 
1507  if( !item->IsNew() && !IsFootprintEditor() )
1508  {
1509  m_commit->Modify( item );
1510 
1511  if( item->Type() == PCB_GROUP_T )
1512  {
1513  PCB_GROUP* group = static_cast<PCB_GROUP*>( item );
1514 
1515  group->RunOnDescendants( [&]( BOARD_ITEM* bItem )
1516  {
1517  m_commit->Modify( bItem );
1518  });
1519  }
1520  }
1521 
1522  item->Move( translation );
1523 
1524  switch( rotationAnchor )
1525  {
1527  item->Rotate( item->GetPosition(), rotation );
1528  break;
1530  item->Rotate( selCenter, rotation );
1531  break;
1533  item->Rotate( (wxPoint) frame()->GetScreen()->m_LocalOrigin, rotation );
1534  break;
1536  item->Rotate( board()->GetDesignSettings().m_AuxOrigin, rotation );
1537  break;
1538  }
1539 
1540  if( !m_dragging )
1541  getView()->Update( item );
1542  }
1543 
1544  m_commit->Push( _( "Move exact" ) );
1545 
1546  if( selection.IsHover() )
1548 
1550 
1551  if( m_dragging )
1553  }
1554 
1555  return 0;
1556 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:62
bool IsHover() const
Definition: selection.h:70
BOARD * board() const
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags, SELECTION_TOOL *selectionTool)
Definition: edit_tool.cpp:66
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:109
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:213
PCB_GROUP is a set of BOARD_ITEMs (i.e., without duplicates)
Definition: pcb_group.h:50
SELECTION_TOOL.
virtual VECTOR2I GetCenter() const
Returns the center point of the selection area bounding box.
Definition: selection.h:137
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
virtual wxPoint GetPosition() const
Definition: eda_item.h:325
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
static const TOOL_EVENT SelectedItemsModified
Definition: actions.h:213
bool IsNew() const
Definition: eda_item.h:187
PCB_BASE_EDIT_FRAME * frame() const
const PCBNEW_SELECTION & selection() const
bool m_dragging
Definition: edit_tool.h:209
virtual EDA_RECT GetBoundingBox() const
Definition: selection.h:178
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
virtual void Move(const wxPoint &aMoveVector)
Function Move move this object.
Definition: board_item.h:292
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Function Rotate Rotate this object.
Definition: board_item.h:309
void RunOnDescendants(const std::function< void(BOARD_ITEM *)> &aFunction) const
Invokes a function on all descendents of the group.
Definition: pcb_group.cpp:327
ROTATION_ANCHOR
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
#define _(s)
Definition: 3d_actions.cpp:33
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:241
int Size() const
Returns the number of selected parts.
Definition: selection.h:126
bool isRouterActive() const
Definition: edit_tool.cpp:289
EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148
bool IsFootprintEditor() const
#define EXCLUDE_LOCKED
Function EditToolSelectionFilter.
Definition: edit_tool.h:53
static TOOL_ACTION updateLocalRatsnest
Definition: pcb_actions.h:453
#define EXCLUDE_LOCKED_PADS
Definition: edit_tool.h:54
EDA_ITEM * Front() const
Definition: selection.h:201
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1513
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

References _, PCB_TOOL_BASE::board(), EditToolSelectionFilter(), SELECTION::Empty(), EXCLUDE_LOCKED, EXCLUDE_LOCKED_PADS, EXCLUDE_TRANSIENTS, PCB_TOOL_BASE::frame(), SELECTION::Front(), SELECTION::GetBoundingBox(), SELECTION::GetCenter(), EDA_ITEM::GetPosition(), TOOL_BASE::getView(), PCB_TOOL_BASE::IsFootprintEditor(), SELECTION::IsHover(), EDA_ITEM::IsNew(), isRouterActive(), m_commit, m_dragging, m_selectionTool, TOOL_BASE::m_toolMgr, BOARD_ITEM::Move(), PCB_GROUP_T, TOOL_MANAGER::ProcessEvent(), 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(), PCB_GROUP::RunOnDescendants(), 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().

◆ MoveWithReference()

int EDIT_TOOL::MoveWithReference ( const TOOL_EVENT aEvent)

Moves an item but with a reference point selected first.

Definition at line 328 of file edit_tool.cpp.

329 {
330  if( isRouterActive() )
331  {
332  wxBell();
333  return 0;
334  }
335 
336  return doMoveSelection( aEvent, true );
337 }
int doMoveSelection(TOOL_EVENT aEvent, bool aPickReference=false)
Definition: edit_tool.cpp:342
bool isRouterActive() const
Definition: edit_tool.cpp:289

References doMoveSelection(), and isRouterActive().

Referenced by setTransitions().

◆ PadFilter()

void EDIT_TOOL::PadFilter ( const VECTOR2I ,
GENERAL_COLLECTOR aCollector,
SELECTION_TOOL sTool 
)
static

Function PadFilter() A selection filter which prunes the selection to contain only items of type PCB_PAD_T.

Definition at line 1720 of file edit_tool.cpp.

1721 {
1722  for( int i = aCollector.GetCount() - 1; i >= 0; i-- )
1723  {
1724  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( aCollector[i] );
1725 
1726  if( item->Type() != PCB_PAD_T )
1727  aCollector.Remove( i );
1728  }
1729 }
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
class PAD, a pad in a footprint
Definition: typeinfo.h:90
void Remove(int aIndex)
Function Remove removes the item at aIndex (first position is 0);.
Definition: collector.h:133
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:104
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

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

Referenced by PCB_INSPECTION_TOOL::LocalRatsnestTool().

◆ pickReferencePoint()

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

Definition at line 1767 of file edit_tool.cpp.

1769 {
1771  OPT<VECTOR2I> pickedPoint;
1772  bool done = false;
1773 
1774  m_statusPopup->SetText( aTooltip );
1775 
1776  picker->SetClickHandler(
1777  [&]( const VECTOR2D& aPoint ) -> bool
1778  {
1779  pickedPoint = aPoint;
1780 
1781  if( !aSuccessMessage.empty() )
1782  {
1783  m_statusPopup->SetText( aSuccessMessage );
1784  m_statusPopup->Expire( 800 );
1785  }
1786  else
1787  {
1788  m_statusPopup->Hide();
1789  }
1790 
1791  return false; // we don't need any more points
1792  } );
1793 
1794  picker->SetMotionHandler(
1795  [&]( const VECTOR2D& aPos )
1796  {
1797  m_statusPopup->Move( wxGetMousePosition() + wxPoint( 20, -50 ) );
1798  } );
1799 
1800  picker->SetCancelHandler(
1801  [&]()
1802  {
1803  if( !aCanceledMessage.empty() )
1804  {
1805  m_statusPopup->SetText( aCanceledMessage );
1806  m_statusPopup->Expire( 800 );
1807  }
1808  else
1809  {
1810  m_statusPopup->Hide();
1811  }
1812  } );
1813 
1814  picker->SetFinalizeHandler(
1815  [&]( const int& aFinalState )
1816  {
1817  done = true;
1818  } );
1819 
1820  m_statusPopup->Move( wxGetMousePosition() + wxPoint( 20, -50 ) );
1821  m_statusPopup->Popup();
1822 
1823  std::string tool = "";
1824  m_toolMgr->RunAction( ACTIONS::pickerTool, true, &tool );
1825 
1826  while( !done )
1827  {
1828  // Pass events unless we receive a null event, then we must shut down
1829  if( TOOL_EVENT* evt = Wait() )
1830  evt->SetPassEvent();
1831  else
1832  break;
1833  }
1834 
1835  // Ensure statusPopup is hidden after use and before deleting it:
1836  m_statusPopup->Hide();
1837 
1838  if( pickedPoint.is_initialized() )
1839  aReferencePoint = pickedPoint.get();
1840 
1841  return pickedPoint.is_initialized();
1842 }
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
void SetFinalizeHandler(FINALIZE_HANDLER aHandler)
Function SetFinalizeHandler() Sets a handler for the finalize event.
static TOOL_ACTION pickerTool
Definition: actions.h:153
Generic tool for picking a point.
TOOL_EVENT.
Definition: tool_event.h:171
std::unique_ptr< STATUS_TEXT_POPUP > m_statusPopup
Definition: edit_tool.h:215
void SetMotionHandler(MOTION_HANDLER aHandler)
Function SetMotionHandler() Sets a handler for mouse motion.
boost::optional< T > OPT
Definition: optional.h:7
void SetCancelHandler(CANCEL_HANDLER aHandler)
Function SetCancelHandler() Sets a handler for cancel events (ESC or context-menu Cancel).
void SetClickHandler(CLICK_HANDLER aHandler)
Function SetClickHandler() Sets a handler for mouse click event.

References TOOL_MANAGER::GetTool(), m_statusPopup, TOOL_BASE::m_toolMgr, ACTIONS::pickerTool, TOOL_MANAGER::RunAction(), PCBNEW_PICKER_TOOL::SetCancelHandler(), PCBNEW_PICKER_TOOL::SetClickHandler(), PCBNEW_PICKER_TOOL::SetFinalizeHandler(), PCBNEW_PICKER_TOOL::SetMotionHandler(), and TOOL_INTERACTIVE::Wait().

Referenced by copyToClipboard(), and doMoveSelection().

◆ Properties()

int EDIT_TOOL::Properties ( const TOOL_EVENT aEvent)

Function Properties() Displays properties window for the selected object.

Definition at line 920 of file edit_tool.cpp.

921 {
922  PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
924  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
925  {
926  EditToolSelectionFilter( aCollector, EXCLUDE_TRANSIENTS, sTool );
927  } );
928 
929  // Tracks & vias are treated in a special way:
931  {
932  DIALOG_TRACK_VIA_PROPERTIES dlg( editFrame, selection, *m_commit );
933  dlg.ShowQuasiModal(); // QuasiModal required for NET_SELECTOR
934  }
935  else if( selection.Size() == 1 )
936  {
937  // Display properties dialog
938  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( selection.Front() );
939 
940  // Do not handle undo buffer, it is done by the properties dialogs
941  editFrame->OnEditItemRequest( item );
942 
943  // Notify other tools of the changes
945  }
946  else if( selection.Size() == 0 && getView()->IsLayerVisible( LAYER_WORKSHEET ) )
947  {
948  KIGFX::WS_PROXY_VIEW_ITEM* worksheet = editFrame->GetCanvas()->GetWorksheet();
949  VECTOR2D cursorPos = getViewControls()->GetCursorPosition( false );
950 
951  if( worksheet && worksheet->HitTestWorksheetItems( getView(), (wxPoint) cursorPos ) )
953  }
954 
955  if( selection.IsHover() )
956  {
958 
959  // Notify other tools of the changes -- This updates the visual ratsnest
961  }
962 
963  return 0;
964 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:62
bool IsHover() const
Definition: selection.h:70
static const KICAD_T Tracks[]
A scan list for only TRACKs.
Definition: collectors.h:299
static TOOL_ACTION pageSettings
Definition: actions.h:59
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags, SELECTION_TOOL *selectionTool)
Definition: edit_tool.cpp:66
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:213
static SELECTION_CONDITION OnlyTypes(const KICAD_T aTypes[])
Creates a functor that tests if the selected items are only of given types.
SELECTION_TOOL.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
virtual void OnEditItemRequest(BOARD_ITEM *aItem)=0
Function OnEditItemRequest Install the corresponding dialog editor for the given item.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
static const TOOL_EVENT SelectedItemsModified
Definition: actions.h:213
bool HitTestWorksheetItems(VIEW *aView, const wxPoint &aPosition)
const PCBNEW_SELECTION & selection() const
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
KIGFX::WS_PROXY_VIEW_ITEM * GetWorksheet() const
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
Common, abstract interface for edit frames.
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:241
int Size() const
Returns the number of selected parts.
Definition: selection.h:126
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:42
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
EDA_ITEM * Front() const
Definition: selection.h:201
bool IsLayerVisible(int aLayer) const
Function IsLayerVisible() Returns information about visibility of a particular layer.
Definition: view.h:402

References EditToolSelectionFilter(), EXCLUDE_TRANSIENTS, SELECTION::Front(), PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), PCB_DRAW_PANEL_GAL::GetWorksheet(), KIGFX::WS_PROXY_VIEW_ITEM::HitTestWorksheetItems(), SELECTION::IsHover(), KIGFX::VIEW::IsLayerVisible(), LAYER_WORKSHEET, m_commit, m_selectionTool, TOOL_BASE::m_toolMgr, PCB_BASE_EDIT_FRAME::OnEditItemRequest(), SELECTION_CONDITIONS::OnlyTypes(), ACTIONS::pageSettings, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, DIALOG_SHIM::ShowQuasiModal(), SELECTION::Size(), and GENERAL_COLLECTOR::Tracks.

Referenced by setTransitions().

◆ Remove()

int EDIT_TOOL::Remove ( const TOOL_EVENT aEvent)

Function Remove() Deletes currently selected items.

The rotation point is the current cursor position.

Popup nag for deleting locked items

Definition at line 1238 of file edit_tool.cpp.

1239 {
1240  if( isRouterActive() )
1241  {
1242  wxBell();
1243  return 0;
1244  }
1245 
1246  std::vector<BOARD_ITEM*> lockedItems;
1247  Activate();
1248 
1249  // get a copy instead of reference (as we're going to clear the selection before removing items)
1250  PCBNEW_SELECTION selectionCopy;
1253 
1254  // If we are in a "Cut" operation, then the copied selection exists already
1255  if( isCut )
1256  {
1257  selectionCopy = m_selectionTool->GetSelection();
1258  }
1259  else
1260  {
1261  selectionCopy = m_selectionTool->RequestSelection(
1262  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
1263  {
1265  } );
1266  }
1267 
1268  bool isHover = selectionCopy.IsHover();
1269 
1270  // in "alternative" mode, deletion is not just a simple list of selected items,
1271  // it removes whole tracks, not just segments
1272  if( isAlt && isHover
1273  && ( selectionCopy.HasType( PCB_TRACE_T ) || selectionCopy.HasType( PCB_VIA_T ) ) )
1274  {
1276  }
1277 
1278  if( selectionCopy.Empty() )
1279  return 0;
1280 
1281  // N.B. Setting the CUT flag prevents lock filtering as we only want to delete the items that
1282  // were copied to the clipboard, no more, no fewer. Filtering for locked item, if any will be done
1283  // in the copyToClipboard() routine
1284  if( !isCut )
1285  {
1286  // Second RequestSelection removes locked items but keeps a copy of their pointers
1287  selectionCopy = m_selectionTool->RequestSelection(
1288  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
1289  {
1290  EditToolSelectionFilter( aCollector, EXCLUDE_LOCKED, sTool );
1291  },
1292  &lockedItems );
1293  }
1294 
1295 
1296  // As we are about to remove items, they have to be removed from the selection first
1298 
1299  for( EDA_ITEM* item : selectionCopy )
1300  {
1301  PCB_GROUP* parentGroup = static_cast<BOARD_ITEM*>( item )->GetParentGroup();
1302 
1303  if( parentGroup )
1304  parentGroup->RemoveItem( static_cast<BOARD_ITEM*>( item ) );
1305 
1306  switch( item->Type() )
1307  {
1308  case PCB_FP_TEXT_T:
1309  {
1310  FP_TEXT* text = static_cast<FP_TEXT*>( item );
1311  FOOTPRINT* parent = static_cast<FOOTPRINT*>( item->GetParent() );
1312 
1313  if( text->GetType() == FP_TEXT::TEXT_is_DIVERS )
1314  {
1315  m_commit->Modify( parent );
1316  getView()->Remove( text );
1317  parent->Remove( text );
1318  }
1319  }
1320  break;
1321 
1322  case PCB_PAD_T:
1323  {
1324  PAD* pad = static_cast<PAD*>( item );
1325  FOOTPRINT* parent = static_cast<FOOTPRINT*>( item->GetParent() );
1326 
1327  m_commit->Modify( parent );
1328  getView()->Remove( pad );
1329  parent->Remove( pad );
1330  }
1331  break;
1332 
1333  case PCB_FP_ZONE_T:
1334  {
1335  FP_ZONE* zone = static_cast<FP_ZONE*>( item );
1336  FOOTPRINT* parent = static_cast<FOOTPRINT*>( item->GetParent() );
1337 
1338  m_commit->Modify( parent );
1339  getView()->Remove( zone );
1340  parent->Remove( zone );
1341  }
1342  break;
1343 
1344  case PCB_ZONE_T:
1345  // We process the zones special so that cutouts can be deleted when the delete tool
1346  // is called from inside a cutout when the zone is selected.
1347  {
1348  // Only interact with cutouts when deleting and a single item is selected
1349  if( !isCut && selectionCopy.GetSize() == 1 )
1350  {
1352  ZONE* zone = static_cast<ZONE*>( item );
1353 
1354  int outlineIdx, holeIdx;
1355 
1356  if( zone->HitTestCutout( curPos, &outlineIdx, &holeIdx ) )
1357  {
1358  // Remove the cutout
1359  m_commit->Modify( zone );
1360  zone->RemoveCutout( outlineIdx, holeIdx );
1361 
1362  std::vector<ZONE*> toFill;
1363  toFill.emplace_back( zone );
1364 
1365  // Fill the modified zone
1366  ZONE_FILLER filler( board(), m_commit.get() );
1367  filler.InstallNewProgressReporter( frame(), _( "Fill Zone" ), 4 );
1368 
1369  if( !filler.Fill( toFill ) )
1370  {
1371  m_commit->Revert();
1372  return 1;
1373  }
1374 
1375  // Update the display
1376  zone->HatchBorder();
1377  canvas()->Refresh();
1378 
1379  // Restore the selection on the original zone
1381 
1382  break;
1383  }
1384  }
1385 
1386  // Remove the entire zone otherwise
1387  m_commit->Remove( item );
1388  }
1389  break;
1390 
1391  case PCB_GROUP_T:
1392  {
1393  PCB_GROUP* group = static_cast<PCB_GROUP*>( item );
1394 
1395  auto removeItem = [&]( BOARD_ITEM* bItem )
1396  {
1397  if( bItem->GetParent() && bItem->GetParent()->Type() == PCB_FOOTPRINT_T )
1398  {
1399  m_commit->Modify( bItem->GetParent() );
1400  getView()->Remove( group );
1401  bItem->GetParent()->Remove( group );
1402  }
1403  else
1404  {
1405  m_commit->Remove( bItem );
1406  }
1407  };
1408 
1409  removeItem( group );
1410 
1411  group->RunOnDescendants( [&]( BOARD_ITEM* aDescendant )
1412  {
1413  removeItem( aDescendant );
1414  });
1415  }
1416  break;
1417 
1418  default:
1419  m_commit->Remove( item );
1420  break;
1421  }
1422  }
1423 
1424  // If the entered group has been emptied then leave it.
1425  PCB_GROUP* enteredGroup = m_selectionTool->GetEnteredGroup();
1426 
1427  if( enteredGroup && enteredGroup->GetItems().empty() )
1429 
1430  if( isCut )
1431  m_commit->Push( _( "Cut" ) );
1432  else
1433  m_commit->Push( _( "Delete" ) );
1434 
1435  if( !m_lockedSelected && !lockedItems.empty() )
1436  {
1438  m_lockedSelected = true;
1439  m_toolMgr->RunAction( PCB_ACTIONS::selectItems, true, &lockedItems );
1440  m_statusPopup->SetText( _( "Locked items cannot be deleted" ) );
1441  m_statusPopup->PopupFor( 2000 );
1442  m_statusPopup->Move( wxGetMousePosition() + wxPoint( 20, 20 ) );
1443 
1444  Activate();
1445 
1446  while( m_lockedSelected && m_statusPopup->IsShown() )
1447  {
1448  m_statusPopup->Move( wxGetMousePosition() + wxPoint( 20, 20 ) );
1449  Wait();
1450  }
1451 
1452  // Ensure statusPopup is hidden after use
1453  m_statusPopup->Hide();
1454  }
1455 
1456  m_lockedSelected = false;
1457 
1458  return 0;
1459 }
static TOOL_ACTION selectItems
Selects a list of items (specified as the event parameter)
Definition: pcb_actions.h:69
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:62
PCB_GROUP * GetParentGroup() const
Definition: board_item.h:101
void RemoveCutout(int aOutlineIdx, int aHoleIdx)
Remove a cutout from the zone.
Definition: zone.cpp:808
bool IsHover() const
Definition: selection.h:70
class FP_TEXT, text in a footprint
Definition: typeinfo.h:93
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
BOARD * board() const
REMOVE_FLAGS
Remove event modifier flags
Definition: actions.h:196
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags, SELECTION_TOOL *selectionTool)
Definition: edit_tool.cpp:66
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
bool HasType(KICAD_T aType) const
Checks if there is at least one item of requested kind.
Definition: selection.h:231
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:109
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:213
PCB_GROUP is a set of BOARD_ITEMs (i.e., without duplicates)
Definition: pcb_group.h:50
SELECTION_TOOL.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:357
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
static TOOL_ACTION selectConnection
Selects tracks between junctions or expands an existing selection to pads or the entire connection.
Definition: pcb_actions.h:77
class PAD, a pad in a footprint
Definition: typeinfo.h:90
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
const std::unordered_set< BOARD_ITEM * > & GetItems() const
Definition: pcb_group.h:68
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
void InstallNewProgressReporter(wxWindow *aParent, const wxString &aTitle, int aNumPhases)
Definition: zone_filler.cpp:72
PCBNEW_SELECTION & GetSelection()
Function GetSelection()
PCB_BASE_EDIT_FRAME * frame() const
bool m_lockedSelected
Definition: edit_tool.h:210
bool HitTestCutout(const VECTOR2I &aRefPos, int *aOutlineIdx=nullptr, int *aHoleIdx=nullptr) const
Tests if the given point is contained within a cutout of the zone.
Definition: zone.cpp:518
void HatchBorder()
Function HatchBorder computes the hatch lines depending on the hatch parameters and stores it in the ...
Definition: zone.cpp:945
TEXT_TYPE GetType() const
Definition: fp_text.h:139
T Parameter() const
Function Parameter() Returns a non-standard parameter assigned to the event.
Definition: tool_event.h:435
bool RemoveItem(BOARD_ITEM *aItem)
Removes item from group.
Definition: pcb_group.cpp:50
std::unique_ptr< STATUS_TEXT_POPUP > m_statusPopup
Definition: edit_tool.h:215
ZONE handles a list of polygons defining a copper zone.
Definition: zone.h:57
class ZONE, a copper pour area
Definition: typeinfo.h:106
void RunOnDescendants(const std::function< void(BOARD_ITEM *)> &aFunction) const
Invokes a function on all descendents of the group.
Definition: pcb_group.cpp:327
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
class FOOTPRINT, a footprint
Definition: typeinfo.h:89
void Remove(BOARD_ITEM *aItem) override
Definition: footprint.cpp:495
PCB_GROUP * GetEnteredGroup()
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
#define _(s)
Definition: 3d_actions.cpp:33
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:241
static TOOL_ACTION selectItem
Selects an item (specified as the event parameter).
Definition: pcb_actions.h:65
class ZONE, managed by a footprint
Definition: typeinfo.h:95
bool isRouterActive() const
Definition: edit_tool.cpp:289
EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148
void Activate()
Function Activate() Runs the tool.
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
void ExitGroup(bool aSelectGroup=false)
Leave the currently entered group.
#define EXCLUDE_LOCKED
Function EditToolSelectionFilter.
Definition: edit_tool.h:53
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:42
Definition: pad.h:59
#define EXCLUDE_LOCKED_PADS
Definition: edit_tool.h:54
PCB_DRAW_PANEL_GAL * canvas() const
FP_ZONE is a specialization of ZONE for use in footprints.
Definition: zone.h:957
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.

References _, TOOL_INTERACTIVE::Activate(), ACTIONS::ALT, PCB_TOOL_BASE::board(), PCB_TOOL_BASE::canvas(), ACTIONS::CUT, EditToolSelectionFilter(), SELECTION::Empty(), EXCLUDE_LOCKED, EXCLUDE_LOCKED_PADS, EXCLUDE_TRANSIENTS, SELECTION_TOOL::ExitGroup(), PCB_TOOL_BASE::frame(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), SELECTION_TOOL::GetEnteredGroup(), PCB_GROUP::GetItems(), BOARD_ITEM::GetParentGroup(), SELECTION_TOOL::GetSelection(), FP_TEXT::GetType(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), SELECTION::HasType(), ZONE::HatchBorder(), ZONE::HitTestCutout(), ZONE_FILLER::InstallNewProgressReporter(), SELECTION::IsHover(), isRouterActive(), m_commit, m_lockedSelected, m_selectionTool, m_statusPopup, TOOL_BASE::m_toolMgr, TOOL_EVENT::Parameter(), PCB_FOOTPRINT_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::VIEW::Remove(), FOOTPRINT::Remove(), ZONE::RemoveCutout(), PCB_GROUP::RemoveItem(), SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), PCB_GROUP::RunOnDescendants(), PCB_ACTIONS::selectConnection, PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItem, PCB_ACTIONS::selectItems, FP_TEXT::TEXT_is_DIVERS, and TOOL_INTERACTIVE::Wait().

Referenced by cutToClipboard(), and setTransitions().

◆ Reset()

void EDIT_TOOL::Reset ( RESET_REASON  aReason)
overridevirtual

Function Reset() Brings 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
aReasoncontains information about the reason of tool reset.

Reimplemented from PCB_TOOL_BASE.

Definition at line 133 of file edit_tool.cpp.

134 {
135  m_dragging = false;
136 
137  m_statusPopup = std::make_unique<STATUS_TEXT_POPUP>( getEditFrame<PCB_BASE_EDIT_FRAME>() );
138 
139  if( aReason != RUN )
140  m_commit.reset( new BOARD_COMMIT( this ) );
141 }
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:213
Tool is invoked after being inactive.
Definition: tool_base.h:81
bool m_dragging
Definition: edit_tool.h:209
std::unique_ptr< STATUS_TEXT_POPUP > m_statusPopup
Definition: edit_tool.h:215

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

◆ Rotate()

int EDIT_TOOL::Rotate ( const TOOL_EVENT aEvent)

Function Rotate() Rotates currently selected items.

Definition at line 967 of file edit_tool.cpp.

968 {
969  if( isRouterActive() )
970  {
971  wxBell();
972  return 0;
973  }
974 
975  PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
976 
978  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, SELECTION_TOOL* sTool )
979  {
981  },
982  nullptr, ! m_dragging );
983 
984  if( selection.Empty() )
985  return 0;
986 
988  auto refPt = selection.GetReferencePoint();
989  const int rotateAngle = TOOL_EVT_UTILS::GetEventRotationAngle( *editFrame, aEvent );
990 
991  // When editing footprints, all items have the same parent
992  if( IsFootprintEditor() )
993  m_commit->Modify( selection.Front() );
994 
995  for( auto item : selection )
996  {
997  if( !item->IsNew() && !IsFootprintEditor() )
998  {
999  m_commit->Modify( item );
1000 
1001  // If rotating a group, record position of all the descendants for undo
1002  if( item->Type() == PCB_GROUP_T )
1003  {
1004  static_cast<PCB_GROUP*>( item )->RunOnDescendants(
1005  [&]( BOARD_ITEM* bItem )
1006  {
1007  m_commit->Modify( bItem );
1008  });
1009  }
1010  }
1011 
1012  static_cast<BOARD_ITEM*>( item )->Rotate( refPt, rotateAngle );
1013  }
1014 
1015  if( !m_dragging )
1016  m_commit->Push( _( "Rotate" ) );
1017 
1018  if( selection.IsHover() && !m_dragging )
1020 
1022 
1023  if( m_dragging )
1025 
1026  return 0;
1027 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:62
VECTOR2I GetReferencePoint() const
Definition: selection.h:257
bool IsHover() const
Definition: selection.h:70
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags, SELECTION_TOOL *selectionTool)
Definition: edit_tool.cpp:66
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:109
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:213
SELECTION_TOOL.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:208
static const TOOL_EVENT SelectedItemsModified
Definition: actions.h:213
const PCBNEW_SELECTION & selection() const
bool m_dragging
Definition: edit_tool.h:209
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:120
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
Common, abstract interface for edit frames.
#define _(s)
Definition: 3d_actions.cpp:33
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:241
bool isRouterActive() const
Definition: edit_tool.cpp:289
bool IsFootprintEditor() const
static TOOL_ACTION updateLocalRatsnest
Definition: pcb_actions.h:453
#define EXCLUDE_LOCKED_PADS
Definition: edit_tool.h:54
int GetEventRotationAngle(const PCB_BASE_EDIT_FRAME &aFrame, const TOOL_EVENT &aEvt)
Function getEventRotationAngle()
bool updateModificationPoint(PCBNEW_SELECTION &aSelection)
Returns the right modification point (e.g.
Definition: edit_tool.cpp:1744
EDA_ITEM * Front() const
Definition: selection.h:201

References _, EditToolSelectionFilter(), SELECTION::Empty(), EXCLUDE_LOCKED_PADS, EXCLUDE_TRANSIENTS, SELECTION::Front(), TOOL_EVT_UTILS::GetEventRotationAngle(), SELECTION::GetReferencePoint(), PCB_TOOL_BASE::IsFootprintEditor(), SELECTION::IsHover(), isRouterActive(), m_commit, m_dragging, m_selectionTool, TOOL_BASE::m_toolMgr, PCB_GROUP_T, TOOL_MANAGER::ProcessEvent(), SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::updateLocalRatsnest, and updateModificationPoint().

Referenced by setTransitions().

◆ RunMainStack()

void TOOL_INTERACTIVE::RunMainStack ( std::function< void()>  aFunc)
inherited

Function RunMainStack()

Calls a function using the main stack.

Parameters
aFuncis the function to be calls.

Definition at line 87 of file tool_interactive.cpp.

88 {
89  m_toolMgr->RunMainStack( this, std::move( aFunc ) );
90 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
void RunMainStack(TOOL_BASE *aTool, std::function< void()> aFunc)

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

Referenced by DRAWING_TOOL::PlaceText().

◆ selection() [1/2]

const PCBNEW_SELECTION & PCB_TOOL_BASE::selection ( ) const
protectedinherited

Definition at line 291 of file pcb_tool_base.cpp.

292 {
294 
295  return selTool->GetSelection();
296 }
SELECTION_TOOL.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
PCBNEW_SELECTION & GetSelection()
Function GetSelection()

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

Referenced by AUTOPLACE_TOOL::autoplaceSelected(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), ChangeTrackWidth(), PAD_TOOL::copyPadSettings(), copyToClipboard(), CreateArray(), PCB_INSPECTION_TOOL::CrossProbePcbToSch(), PCB_INSPECTION_TOOL::doHideNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawZone(), Duplicate(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), GROUP_TOOL::EnterGroup(), PAD_TOOL::EnumeratePads(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), FilletTracks(), SELECTION_TOOL::filterSelection(), Flip(), DRAWING_TOOL::getSourceZoneForAction(), GROUP_TOOL::Group(), PCB_INSPECTION_TOOL::highlightNet(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_INSPECTION_TOOL::InspectClearance(), PCB_INSPECTION_TOOL::InspectConstraints(), PCB_INSPECTION_TOOL::LocalRatsnestTool(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), Mirror(), PCB_EDITOR_CONTROL::modifyLockSelected(), MoveExact(), POINT_EDITOR::OnSelectionChange(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), PCBNEW_CONTROL::placeBoardItems(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelative(), Properties(), PAD_TOOL::pushPadSettings(), GROUP_TOOL::RemoveFromGroup(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), Rotate(), SELECTION_TOOL::selectNet(), DRAWING_TOOL::SetAnchor(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), GROUP_TOOL::Ungroup(), PCBNEW_CONTROL::UpdateMessagePanel(), PCB_INSPECTION_TOOL::UpdateSelectionRatsnest(), PCB_EDITOR_CONTROL::ViaSizeDec(), PCB_EDITOR_CONTROL::ViaSizeInc(), PCB_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), PCB_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfill().

◆ selection() [2/2]

PCBNEW_SELECTION & PCB_TOOL_BASE::selection ( )
protectedinherited

Definition at line 299 of file pcb_tool_base.cpp.

300 {
302 
303  return selTool->GetSelection();
304 }
SELECTION_TOOL.
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
PCBNEW_SELECTION & GetSelection()
Function GetSelection()

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

◆ SetContextMenu()

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

Function SetContextMenu()

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

Parameters
aMenuis the menu to be assigned.
aTriggerdetermines conditions upon which the context menu is activated.

Definition at line 76 of file tool_interactive.cpp.

77 {
78  if( aMenu )
79  aMenu->SetTool( this );
80  else
81  aTrigger = CMENU_OFF;
82 
83  m_toolMgr->ScheduleContextMenu( this, aMenu, aTrigger );
84 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
void SetTool(TOOL_INTERACTIVE *aTool)
Sets a tool that is the creator of the menu.
void ScheduleContextMenu(TOOL_BASE *aTool, ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger)
Sets behaviour of the tool's context popup menu.

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

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), TOOL_MENU::ShowContextMenu(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ 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
aEnableddecides if the mode should be enabled.

Definition at line 104 of file pcb_tool_base.h.

104 { m_isFootprintEditor = aEnabled; }
bool m_isFootprintEditor

References PCB_TOOL_BASE::m_isFootprintEditor.

◆ setTransitions()

void EDIT_TOOL::setTransitions ( )
overridevirtual

Sets up handlers for various events.

Reimplemented from PCB_TOOL_BASE.

Definition at line 1912 of file edit_tool.cpp.

1913 {
1915  Go( &EDIT_TOOL::Move, PCB_ACTIONS::move.MakeEvent() );
1916  Go( &EDIT_TOOL::Drag, PCB_ACTIONS::drag45Degree.MakeEvent() );
1918  Go( &EDIT_TOOL::Rotate, PCB_ACTIONS::rotateCw.MakeEvent() );
1919  Go( &EDIT_TOOL::Rotate, PCB_ACTIONS::rotateCcw.MakeEvent() );
1920  Go( &EDIT_TOOL::Flip, PCB_ACTIONS::flip.MakeEvent() );
1921  Go( &EDIT_TOOL::Remove, ACTIONS::doDelete.MakeEvent() );
1922  Go( &EDIT_TOOL::Remove, PCB_ACTIONS::deleteFull.MakeEvent() );
1926  Go( &EDIT_TOOL::Duplicate, ACTIONS::duplicate.MakeEvent() );
1929  Go( &EDIT_TOOL::Mirror, PCB_ACTIONS::mirror.MakeEvent() );
1932 
1933  Go( &EDIT_TOOL::copyToClipboard, ACTIONS::copy.MakeEvent() );
1935  Go( &EDIT_TOOL::cutToClipboard, ACTIONS::cut.MakeEvent() );
1936 }
int Properties(const TOOL_EVENT &aEvent)
Function Properties() Displays properties window for the selected object.
Definition: edit_tool.cpp:920
int Rotate(const TOOL_EVENT &aEvent)
Function Rotate() Rotates currently selected items.
Definition: edit_tool.cpp:967
static TOOL_ACTION move
move or drag an item
Definition: pcb_actions.h:95
static TOOL_ACTION deleteFull
Definition: pcb_actions.h:130
static TOOL_ACTION changeTrackWidth
Updates selected tracks & vias to the current track & via dimensions.
Definition: pcb_actions.h:114
static TOOL_ACTION doDelete
Definition: actions.h:75
int ChangeTrackWidth(const TOOL_EVENT &aEvent)
Definition: edit_tool.cpp:661
static TOOL_ACTION dragFreeAngle
Definition: pcb_actions.h:141
static TOOL_ACTION properties
Activation of the edit tool.
Definition: pcb_actions.h:120
static TOOL_ACTION getAndPlace
Find an item and start moving.
Definition: pcb_actions.h:459
static TOOL_ACTION drag45Degree
Definition: pcb_actions.h:140
static TOOL_ACTION mirror
Mirroring of selected items.
Definition: pcb_actions.h:111
void Go(int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
Function Go()
int Mirror(const TOOL_EVENT &aEvent)
Function Mirror Mirrors the current selection.
Definition: edit_tool.cpp:1070
static TOOL_ACTION moveExact
Activation of the exact move tool.
Definition: pcb_actions.h:123
int cutToClipboard(const TOOL_EVENT &aEvent)
Function cutToClipboard() Cuts the current selection to the clipboard by formatting it as a fake pcb ...
Definition: edit_tool.cpp:1896
static TOOL_ACTION filletTracks
Fillets (i.e. adds an arc tangent to) all selected straight tracks by a user defined radius.
Definition: pcb_actions.h:117
static TOOL_ACTION copy
Definition: actions.h:70
int Flip(const TOOL_EVENT &aEvent)
Function Flip() Rotates currently selected items.
Definition: edit_tool.cpp:1168
static TOOL_ACTION duplicateIncrement
Activation of the duplication tool with incrementing (e.g. pad number)
Definition: pcb_actions.h:126
int GetAndPlace(const TOOL_EVENT &aEvent)
Find an item and start moving.
Definition: edit_tool.cpp:235
static TOOL_ACTION rotateCw
Rotation of selected objects.
Definition: pcb_actions.h:104
static TOOL_ACTION createArray
Tool for creating an array of objects.
Definition: pcb_actions.h:383
static TOOL_ACTION cut
Definition: actions.h:69
int FilletTracks(const TOOL_EVENT &aEvent)
Function FilletTracks() Fillets (i.e.
Definition: edit_tool.cpp:717
int MoveWithReference(const TOOL_EVENT &aEvent)
Moves an item but with a reference point selected first.
Definition: edit_tool.cpp:328
int Drag(const TOOL_EVENT &aEvent)
Function Drag() Invoke the PNS router to drag tracks.
Definition: edit_tool.cpp:297
static TOOL_ACTION copyWithReference
copy command with manual reference point selection
Definition: pcb_actions.h:101
int Move(const TOOL_EVENT &aEvent)
Function Move() Main loop in which events are handled.
Definition: edit_tool.cpp:316
static TOOL_ACTION rotateCcw
Definition: pcb_actions.h:105
int MoveExact(const TOOL_EVENT &aEvent)
Function MoveExact() Invokes a dialog box to allow moving of the item by an exact amount.
Definition: edit_tool.cpp:1462
int Remove(const TOOL_EVENT &aEvent)
Function Remove() Deletes currently selected items.
Definition: edit_tool.cpp:1238
static TOOL_ACTION flip
Flipping of selected objects.
Definition: pcb_actions.h:108
int CreateArray(const TOOL_EVENT &aEvent)
Function CreateArray() Creates an array of the selected items, invoking the array editor dialog to se...
Definition: edit_tool.cpp:1694
int copyToClipboard(const TOOL_EVENT &aEvent)
Function copyToClipboard() Sends the current selection to the clipboard by formatting it as a fake pc...
Definition: edit_tool.cpp:1845
static TOOL_ACTION moveWithReference
move with a reference point
Definition: pcb_actions.h:98
int Duplicate(const TOOL_EVENT &aEvent)
Function Duplicate() Duplicates the current selection and starts a move action.
Definition: edit_tool.cpp:1559
static TOOL_ACTION duplicate
Definition: actions.h:74

References PCB_ACTIONS::changeTrackWidth, ChangeTrackWidth(), ACTIONS::copy, copyToClipboard(), PCB_ACTIONS::copyWithReference, CreateArray(), PCB_ACTIONS::createArray, ACTIONS::cut, cutToClipboard(), PCB_ACTIONS::deleteFull, ACTIONS::doDelete, Drag(), PCB_ACTIONS::drag45Degree, PCB_ACTIONS::dragFreeAngle, ACTIONS::duplicate, Duplicate(), PCB_ACTIONS::duplicateIncrement, PCB_ACTIONS::filletTracks, FilletTracks(), PCB_ACTIONS::flip, Flip(), GetAndPlace(), PCB_ACTIONS::getAndPlace, TOOL_INTERACTIVE::Go(), PCB_ACTIONS::mirror, Mirror(), Move(), PCB_ACTIONS::move, PCB_ACTIONS::moveExact, MoveExact(), PCB_ACTIONS::moveWithReference, MoveWithReference(), Properties(), PCB_ACTIONS::properties, Remove(), Rotate(), PCB_ACTIONS::rotateCcw, and PCB_ACTIONS::rotateCw.

◆ updateModificationPoint()

bool EDIT_TOOL::updateModificationPoint ( PCBNEW_SELECTION aSelection)
private

Returns the right modification point (e.g.

for rotation), depending on the number of selected items.

Definition at line 1744 of file edit_tool.cpp.

1745 {
1746  if( m_dragging && aSelection.HasReferencePoint() )
1747  return false;
1748 
1749  // When there is only one item selected, the reference point is its position...
1750  if( aSelection.Size() == 1 )
1751  {
1752  auto item = static_cast<BOARD_ITEM*>( aSelection.Front() );
1753  auto pos = item->GetPosition();
1754  aSelection.SetReferencePoint( VECTOR2I( pos.x, pos.y ) );
1755  }
1756  // ...otherwise modify items with regard to the grid-snapped cursor position
1757  else
1758  {
1760  aSelection.SetReferencePoint( m_cursor );
1761  }
1762 
1763  return true;
1764 }
VECTOR2I m_cursor
Definition: edit_tool.h:211
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
void SetReferencePoint(const VECTOR2I &aP)
Definition: selection.h:262
bool m_dragging
Definition: edit_tool.h:209
bool HasReferencePoint() const
Definition: selection.h:252
int Size() const
Returns the number of selected parts.
Definition: selection.h:126
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:42
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
EDA_ITEM * Front() const
Definition: selection.h:201

References SELECTION::Front(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_BASE::getViewControls(), SELECTION::HasReferencePoint(), m_cursor, m_dragging, SELECTION::SetReferencePoint(), and SELECTION::Size().

Referenced by Flip(), Mirror(), and Rotate().

◆ view()

◆ Wait()

TOOL_EVENT * TOOL_INTERACTIVE::Wait ( const TOOL_EVENT_LIST aEventList = TOOL_EVENTTC_ANYTA_ANY ))
inherited

Function Wait()

Suspends execution of the tool until an event specified in aEventList arrives. No parameters means waiting for any event.

Definition at line 57 of file tool_interactive.cpp.

58 {
59  return m_toolMgr->ScheduleWait( this, aEventList );
60 }
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
TOOL_EVENT * ScheduleWait(TOOL_BASE *aTool, const TOOL_EVENT_LIST &aConditions)
Pauses execution of a given tool until one or more events matching aConditions arrives.

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

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), doMoveSelection(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), CVPCB_CONTROL::Main(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), EDA_3D_CONTROLLER::Main(), PICKER_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), GROUP_TOOL::PickNewMember(), pickReferencePoint(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), Remove(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ZOOM_TOOL::selectRegion(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

Member Data Documentation

◆ m_commit

std::unique_ptr<BOARD_COMMIT> EDIT_TOOL::m_commit
private

◆ m_cursor

VECTOR2I EDIT_TOOL::m_cursor
private

Definition at line 211 of file edit_tool.h.

Referenced by doMoveSelection(), and updateModificationPoint().

◆ m_dragging

bool EDIT_TOOL::m_dragging
private

◆ m_isFootprintEditor

◆ m_lockedSelected

bool EDIT_TOOL::m_lockedSelected
private

Definition at line 210 of file edit_tool.h.

Referenced by doMoveSelection(), and Remove().

◆ m_menu

TOOL_MENU TOOL_INTERACTIVE::m_menu
protectedinherited

functions below are not yet implemented - their interface may change

Definition at line 108 of file tool_interactive.h.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), TOOL_INTERACTIVE::GetToolMenu(), ROUTER_TOOL::Init(), LENGTH_TUNER_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), SCH_EDIT_TOOL::Init(), PICKER_TOOL::Init(), PL_EDIT_TOOL::Init(), LIB_CONTROL::Init(), LIB_DRAWING_TOOLS::Init(), FOOTPRINT_EDITOR_TOOLS::Init(), PCB_VIEWER_TOOLS::Init(), PL_DRAWING_TOOLS::Init(), PCB_EDITOR_CONTROL::Init(), SCH_DRAWING_TOOLS::Init(), EDA_3D_CONTROLLER::Init(), GERBVIEW_SELECTION_TOOL::Init(), PL_SELECTION_TOOL::Init(), DRAWING_TOOL::Init(), EE_SELECTION_TOOL::Init(), EE_TOOL_BASE< SCH_BASE_FRAME >::Init(), SELECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), PCB_TOOL_BASE::Init(), PL_EDIT_TOOL::Main(), LIB_MOVE_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), EDA_3D_CONTROLLER::Main(), PICKER_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ m_selectionTool

◆ m_statusPopup

std::unique_ptr<STATUS_TEXT_POPUP> EDIT_TOOL::m_statusPopup
private

Definition at line 215 of file edit_tool.h.

Referenced by pickReferencePoint(), Remove(), and Reset().

◆ m_toolId

TOOL_ID TOOL_BASE::m_toolId
protectedinherited

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

Definition at line 214 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), TOOL_BASE::GetId(), and TOOL_BASE::IsToolActive().

◆ m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr
protectedinherited

Definition at line 219 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), PL_SELECTION_TOOL::AddItemsToSel(), EE_SELECTION_TOOL::AddItemsToSel(), PL_SELECTION_TOOL::AddItemToSel(), SELECTION_TOOL::AddItemToSel(), EE_SELECTION_TOOL::AddItemToSel(), SCH_MOVE_TOOL::AlignElements(), SCH_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), TOOL_BASE::attachManager(), SCH_EDIT_TOOL::AutoplaceFields(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_TOOL::ChangeTextType(), ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), GERBVIEW_CONTROL::ClearAllLayers(), PCB_INSPECTION_TOOL::ClearHighlight(), SCH_EDITOR_CONTROL::ClearHighlight(), SELECTION_TOOL::ClearSelection(), PL_SELECTION_TOOL::ClearSelection(), GERBVIEW_SELECTION_TOOL::clearSelection(), EE_SELECTION_TOOL::ClearSelection(), SCH_EDIT_TOOL::ConvertDeMorgan(), LIB_EDIT_TOOL::Copy(), PL_EDIT_TOOL::Copy(), PAD_TOOL::copyPadSettings(), copyToClipboard(), MICROWAVE_TOOL::createInductorBetween(), PCB_INSPECTION_TOOL::CrossProbePcbToSch(), COMMON_TOOLS::CursorControl(), SCH_EDITOR_CONTROL::Cut(), LIB_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), PCBNEW_CONTROL::DeleteItemCursor(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), LIB_EDIT_TOOL::DoDelete(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_INSPECTION_TOOL::doHideNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::drawSegment(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PCB_EDITOR_CONTROL::DrillOrigin(), LIB_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), Duplicate(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), LIB_EDIT_TOOL::editGraphicProperties(), PAD_TOOL::EditPad(), LIB_EDIT_TOOL::editSymbolProperties(), SCH_EDITOR_CONTROL::EditWithLibEdit(), GROUP_TOOL::EnterGroup(), SCH_NAVIGATE_TOOL::EnterSheet(), SCH_EDITOR_CONTROL::EnterSheet(), PAD_TOOL::EnumeratePads(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), SELECTION_TOOL::expandConnection(), PAD_TOOL::explodePad(), SELECTION_TOOL::filterSelection(), SELECTION_TOOL::findCallback(), SCH_EDITOR_CONTROL::FindComponentAndItem(), POINT_EDITOR::finishItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), Flip(), GetAndPlace(), TOOL_BASE::GetManager(), TOOL_BASE::getModelInt(), DRAWING_TOOL::getSourceZoneForAction(), TOOL_BASE::getToolHolderInt(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_INTERACTIVE::goInternal(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), PCBNEW_CONTROL::GridSetOrigin(), GROUP_TOOL::Group(), EE_SELECTION_TOOL::GuessSelectionCandidates(), GERBVIEW_CONTROL::HighlightControl(), PCB_INSPECTION_TOOL::HighlightItem(), PCB_INSPECTION_TOOL::HighlightNet(), SCH_EDITOR_CONTROL::HighlightNet(), PCB_INSPECTION_TOOL::highlightNet(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PCB_INSPECTION_TOOL::HighlightNetTool(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), PL_EDIT_TOOL::ImportWorksheetContent(), LIB_EDIT_TOOL::Init(), PL_EDIT_TOOL::Init(), SCH_EDIT_TOOL::Init(), GROUP_TOOL::Init(), CONVERT_TOOL::Init(), GLOBAL_EDIT_TOOL::Init(), LIB_CONTROL::Init(), PAD_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_POINT_EDITOR::Init(), PCB_EDITOR_CONTROL::Init(), POINT_EDITOR::Init(), POSITION_RELATIVE_TOOL::Init(), PCB_INSPECTION_TOOL::Init(), EE_TOOL_BASE< SCH_BASE_FRAME >::Init(), Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_INSPECTION_TOOL::InspectClearance(), PCB_INSPECTION_TOOL::InspectConstraints(), invokeInlineRouter(), isInteractiveDragEnabled(), isRouterActive(), TOOL_BASE::IsToolActive(), GROUP_TOOL::LeaveGroup(), SCH_NAVIGATE_TOOL::LeaveSheet(), SCH_EDITOR_CONTROL::LeaveSheet(), COMMON_CONTROL::ListHotKeys(), PCB_INSPECTION_TOOL::LocalRatsnestTool(), PL_EDIT_TOOL::Main(), CVPCB_CONTROL::Main(), LIB_MOVE_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), LIB_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), Mirror(), PCB_EDITOR_CONTROL::modifyLockSelected(), MoveExact(), LIB_CONTROL::OnDeMorgan(), COMMON_TOOLS::OnGridChanged(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), GROUP_TOOL::PickNewMember(), pickReferencePoint(), LIB_EDIT_TOOL::PinTable(), PCBNEW_CONTROL::placeBoardItems(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCBNEW_CONTROL::Print(), GERBVIEW_CONTROL::Print(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), Properties(), PAD_TOOL::pushPadSettings(), EE_SELECTION_TOOL::RebuildSelection(), LIB_EDIT_TOOL::Redo(), SCH_EDITOR_CONTROL::Redo(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), GERBVIEW_CONTROL::ReloadAllLayers(), Remove(), POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), PL_SELECTION_TOOL::RemoveItemFromSel(), EE_SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemFromSel(), PL_SELECTION_TOOL::RemoveItemsFromSel(), EE_SELECTION_TOOL::RemoveItemsFromSel(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_DRAWING_TOOLS::RepeatDrawItem(), EE_SELECTION_TOOL::RequestSelection(), SELECTION_TOOL::RequestSelection(), COMMON_TOOLS::Reset(), PNS::TOOL_BASE::Reset(), EDA_3D_CONTROLLER::Reset(), COMMON_TOOLS::ResetLocalCoords(), TOOL_INTERACTIVE::resetTransitions(), LIB_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), Rotate(), TOOL_INTERACTIVE::RunMainStack(), DRC_TOOL::RunTests(), EE_SELECTION_TOOL::SelectConnection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), GERBVIEW_SELECTION_TOOL::SelectItems(), SELECTION_TOOL::SelectItems(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectNet(), PL_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::selectPoint(), SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), SELECTION_TOOL::selectSameSheet(), SELECTION_TOOL::selectSheetContents(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE::SetContextMenu(), EDA_3D_CONTROLLER::SetMaterial(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), EDA_3D_CONTROLLER::ToggleVisibility(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), LIB_EDIT_TOOL::Undo(), SCH_EDITOR_CONTROL::Undo(), GROUP_TOOL::Ungroup(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCBNEW_CONTROL::UpdateMessagePanel(), PCB_INSPECTION_TOOL::UpdateSelectionRatsnest(), PNS::TOOL_BASE::updateStartItem(), PCB_EDITOR_CONTROL::ViaSizeDec(), PCB_EDITOR_CONTROL::ViaSizeInc(), TOOL_INTERACTIVE::Wait(), PCB_EDITOR_CONTROL::ZoneDuplicate(), and PCB_EDITOR_CONTROL::ZoneMerge().

◆ m_toolName

std::string TOOL_BASE::m_toolName
protectedinherited

Name of the tool.

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

Definition at line 218 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

◆ m_type

TOOL_TYPE TOOL_BASE::m_type
protectedinherited

Stores the type of the tool.

Definition at line 211 of file tool_base.h.

Referenced by TOOL_BASE::GetType(), and BOARD_COMMIT::Push().


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