#include <sch_move_tool.h>

Inheritance diagram for SCH_MOVE_TOOL:

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

Public Member Functions
	SCH_MOVE_TOOL ()

	~SCH_MOVE_TOOL () override

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

int	Main (const TOOL_EVENT &aEvent)
	Run an interactive move of the selected items, or the item under the cursor. More...

int	AlignElements (const TOOL_EVENT &aEvent)
	Align selected elements to the grid. More...

void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state. More...

void	Activate ()
	Run the tool. More...

TOOL_MENU &	GetToolMenu ()

void	SetContextMenu (ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
	Assign a context menu and tells when it should be activated. More...

void	RunMainStack (std::function< void()> aFunc)
	Call a function using the main stack. More...

template<class T >
void	Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
	Define which state (aStateFunc) to go when a certain event arrives (aConditions). More...

TOOL_EVENT *	Wait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
	Suspend execution of the tool until an event specified in aEventList arrives. More...

TOOL_TYPE	GetType () const
	Return the type of the tool. More...

TOOL_ID	GetId () const
	Return the unique identifier of the tool. More...

const std::string &	GetName () const
	Return the name of the tool. More...

TOOL_MANAGER *	GetManager () const
	Return the instance of TOOL_MANAGER that takes care of the tool. More...

bool	IsToolActive () const

Protected Member Functions
void	updateItem (EDA_ITEM *aItem, bool aUpdateRTree) const
	Similar to getView()->Update(), but handles items that are redrawn by their parents and updating the SCH_SCREEN's RTree. More...

void	saveCopyInUndoList (EDA_ITEM *aItem, UNDO_REDO aType, bool aAppend=false)

void	attachManager (TOOL_MANAGER *aManager)
	Set the TOOL_MANAGER the tool will belong to. More...

KIGFX::VIEW *	getView () const
	Returns the instance of #VIEW object used in the application. More...

KIGFX::VIEW_CONTROLS *	getViewControls () const
	Return the instance of VIEW_CONTROLS object used in the application. More...

template<typename T >
T *	getEditFrame () const
	Return the application window object, casted to requested user type. More...

template<typename T >
T *	getModel () const
	Return the model object if it matches the requested type. More...

Protected Attributes
SCH_EDIT_FRAME *	m_frame

KIGFX::SCH_VIEW *	m_view

EE_SELECTION_TOOL *	m_selectionTool

bool	m_isSymbolEditor

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

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

TOOL_ID	m_toolId
	Name of the tool. More...

std::string	m_toolName

TOOL_MANAGER *	m_toolMgr

Private Member Functions
void	moveItem (EDA_ITEM *aItem, const VECTOR2I &aDelta)
	Find additional items for a drag operation. More...

void	getConnectedDragItems (SCH_ITEM *aOriginalItem, const wxPoint &aPoint, EDA_ITEMS &aList)
	Set up handlers for various events. More...

void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events. More...

Private Attributes
bool	m_moveInProgress
	< Flag determining if anything is being dragged right now More...

bool	m_isDrag
	Items (such as wires) which were added to the selection for a drag. More...

std::vector< KIID >	m_dragAdditions
	Used for chaining commands. More...

VECTOR2I	m_moveOffset
	Last cursor position (needed for getModificationPoint() to avoid changes of edit reference point). More...

VECTOR2I	m_cursor

boost::optional< VECTOR2I >	m_anchorPos

std::map< SCH_TEXT *, SPECIAL_CASE_LABEL_INFO >	m_specialCaseLabels

Detailed Description

Definition at line 50 of file sch_move_tool.h.

Member Enumeration Documentation

◆ RESET_REASON

enum TOOL_BASE::RESET_REASON

inherited

Determine the reason of reset for a tool.

Enumerator
RUN	Tool is invoked after being inactive.
MODEL_RELOAD	Model changes (required full reload)
GAL_SWITCH	Rendering engine changes.

Definition at line 77 of file tool_base.h.

  {
  RUN, 
  MODEL_RELOAD, 
  GAL_SWITCH 
  };

Constructor & Destructor Documentation

◆ SCH_MOVE_TOOL()

SCH_MOVE_TOOL::SCH_MOVE_TOOL ( )

Definition at line 48 of file sch_move_tool.cpp.

  :
  EE_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.InteractiveMove" ),
  m_moveInProgress( false ),
  m_isDrag( false ),
  m_moveOffset( 0, 0 )
 {
 }

◆ ~SCH_MOVE_TOOL()

SCH_MOVE_TOOL::~SCH_MOVE_TOOL ( )

inlineoverride

Definition at line 54 of file sch_move_tool.h.

54 { }

Member Function Documentation

◆ Activate()

void TOOL_INTERACTIVE::Activate ( )

inherited

Run the tool.

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

Definition at line 51 of file tool_interactive.cpp.

 {
  m_toolMgr->InvokeTool( m_toolId );
 }

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

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

◆ AlignElements()

int SCH_MOVE_TOOL::AlignElements ( const TOOL_EVENT & aEvent )

Align selected elements to the grid.

Parameters

aEvent current event that activated the tool

Returns: 0

Definition at line 819 of file sch_move_tool.cpp.

 {
  EE_GRID_HELPER grid( m_toolMgr);
  EE_SELECTION& selection = m_selectionTool->RequestSelection( EE_COLLECTOR::MovableItems );
  bool append_undo = false;
 
  auto doMoveItem =
  [&]( EDA_ITEM* item, const VECTOR2I& delta )
  {
  saveCopyInUndoList( item, UNDO_REDO::CHANGED, append_undo );
  append_undo = true;
 
  moveItem( item, delta );
  item->ClearFlags( IS_MOVING );
  updateItem( item, true );
  };
 
  for( SCH_ITEM* it : m_frame->GetScreen()->Items() )
  {
  if( !it->IsSelected() )
  it->ClearFlags( STARTPOINT | ENDPOINT );
 
  if( !selection.IsHover() && it->IsSelected() )
  it->SetFlags( STARTPOINT | ENDPOINT );
 
  it->SetStoredPos( it->GetPosition() );
 
  if( it->Type() == SCH_SHEET_T )
  {
  for( SCH_SHEET_PIN* pin : static_cast<SCH_SHEET*>( it )->GetPins() )
  pin->SetStoredPos( pin->GetPosition() );
  }
  }
 
  for( EDA_ITEM* item : selection )
  {
  if( item->Type() == SCH_LINE_T )
  {
  SCH_LINE* line = static_cast<SCH_LINE*>( item );
  std::vector<int> flags{ STARTPOINT, ENDPOINT };
  std::vector<wxPoint> pts{ line->GetStartPoint(), line->GetEndPoint() };
 
  for( int ii = 0; ii < 2; ++ii )
  {
  EDA_ITEMS drag_items{ item };
  line->ClearFlags();
  line->SetFlags( SELECTED );
  line->SetFlags( flags[ii] );
  getConnectedDragItems( line, pts[ii], drag_items );
  std::set<EDA_ITEM*> unique_items( drag_items.begin(), drag_items.end() );
 
  VECTOR2I gridpt = grid.AlignGrid( pts[ii] ) - pts[ii];
 
  if( gridpt != VECTOR2I( 0, 0 ) )
  {
  for( EDA_ITEM* dragItem : unique_items )
  {
  if( dragItem->GetParent() && dragItem->GetParent()->IsSelected() )
  continue;
 
  doMoveItem( dragItem, gridpt );
  }
  }
  }
  }
  else if( item->Type() == SCH_FIELD_T )
  {
  VECTOR2I gridpt = grid.AlignGrid( item->GetPosition() ) - item->GetPosition();
 
  if( gridpt != VECTOR2I( 0, 0 ) )
  doMoveItem( item, gridpt );
  }
  else if( item->Type() == SCH_SHEET_T )
  {
  SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
  VECTOR2I topRight = sheet->GetPosition();
  VECTOR2I bottomRight = topRight + sheet->GetSize();
  VECTOR2I tl_gridpt = grid.AlignGrid( topRight ) - topRight;
  VECTOR2I br_gridpt = grid.AlignGrid( bottomRight ) - bottomRight;
 
  if( tl_gridpt != VECTOR2I( 0, 0 ) || br_gridpt != VECTOR2I( 0, 0 ) )
  {
  doMoveItem( sheet, tl_gridpt );
 
  VECTOR2I newSize = (VECTOR2I) sheet->GetSize() - tl_gridpt + br_gridpt;
  sheet->SetSize( wxSize( newSize.x, newSize.y ) );
  updateItem( sheet, true );
 
  for( SCH_SHEET_PIN* pin : sheet->GetPins() )
  {
  VECTOR2I gridpt;
 
  if( pin->GetSide() == SHEET_SIDE::TOP || pin->GetSide() == SHEET_SIDE::LEFT )
  gridpt = tl_gridpt;
  else
  gridpt = br_gridpt;
 
  if( gridpt != VECTOR2I( 0, 0 ) )
  {
  EDA_ITEMS drag_items;
  getConnectedDragItems( pin, pin->GetConnectionPoints()[0], drag_items );
 
  doMoveItem( pin, gridpt );
 
  for( EDA_ITEM* dragItem : drag_items )
  {
  if( dragItem->GetParent() && dragItem->GetParent()->IsSelected() )
  continue;
 
  doMoveItem( dragItem, gridpt );
  }
  }
  }
  }
  }
  else
  {
  std::vector<wxPoint> connections;
  EDA_ITEMS drag_items{ item };
  connections = static_cast<SCH_ITEM*>( item )->GetConnectionPoints();
 
  for( const wxPoint& point : connections )
  getConnectedDragItems( static_cast<SCH_ITEM*>( item ), point, drag_items );
 
  std::map<VECTOR2I, int> shifts;
  VECTOR2I most_common( 0, 0 );
  int max_count = 0;
 
  for( const wxPoint& conn : connections )
  {
  VECTOR2I gridpt = grid.AlignGrid( conn ) - conn;
 
  shifts[gridpt]++;
 
  if( shifts[gridpt] > max_count )
  {
  most_common = gridpt;
  max_count = shifts[most_common];
  }
  }
 
  if( most_common != VECTOR2I( 0, 0 ) )
  {
  for( EDA_ITEM* dragItem : drag_items )
  {
  if( dragItem->GetParent() && dragItem->GetParent()->IsSelected() )
  continue;
 
  doMoveItem( dragItem, most_common );
  }
  }
  }
  }
 
  m_toolMgr->PostEvent( EVENTS::SelectedItemsMoved );
  m_toolMgr->RunAction( EE_ACTIONS::trimOverlappingWires, true, &selection );
  m_toolMgr->RunAction( EE_ACTIONS::addNeededJunctions, true, &selection );
 
  m_frame->RecalculateConnections( LOCAL_CLEANUP );
  m_frame->TestDanglingEnds();
 
  m_frame->OnModify();
  return 0;
 }

References EE_ACTIONS::addNeededJunctions, CHANGED, EDA_ITEM::ClearFlags(), delta, ENDPOINT, getConnectedDragItems(), SCH_LINE::GetEndPoint(), SCH_SHEET::GetPins(), EDA_ITEM::GetPosition(), SCH_SHEET::GetPosition(), SCH_EDIT_FRAME::GetScreen(), SCH_SHEET::GetSize(), SCH_LINE::GetStartPoint(), grid, IS_MOVING, SELECTION::IsHover(), SCH_SCREEN::Items(), LEFT, LOCAL_CLEANUP, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, EE_COLLECTOR::MovableItems, moveItem(), SCH_EDIT_FRAME::OnModify(), pin, TOOL_MANAGER::PostEvent(), SCH_EDIT_FRAME::RecalculateConnections(), EE_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EE_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList(), SCH_FIELD_T, SCH_LINE_T, SCH_SHEET_T, SELECTED, EVENTS::SelectedItemsMoved, EDA_ITEM::SetFlags(), SCH_SHEET::SetSize(), STARTPOINT, SCH_EDIT_FRAME::TestDanglingEnds(), TOP, EE_ACTIONS::trimOverlappingWires, EDA_ITEM::Type(), EE_TOOL_BASE< SCH_EDIT_FRAME >::updateItem(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

◆ attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER * aManager )

protectedinherited

Set the TOOL_MANAGER the tool will belong to.

Called by TOOL_MANAGER::RegisterTool()

Definition at line 60 of file tool_base.cpp.

 {
  m_toolMgr = aManager;
 }

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

◆ getConnectedDragItems()

void SCH_MOVE_TOOL::getConnectedDragItems	(	SCH_ITEM *	aOriginalItem,
		const wxPoint &	aPoint,
		EDA_ITEMS &	aList
	)

private

Set up handlers for various events.

Definition at line 541 of file sch_move_tool.cpp.

 {
  EE_RTREE& items = m_frame->GetScreen()->Items();
  EE_RTREE::EE_TYPE itemsOverlapping = items.Overlapping( aOriginalItem->GetBoundingBox() );
  bool ptHasUnselectedJunction = false;
 
  for( SCH_ITEM* item : itemsOverlapping )
  {
  if( item->Type() == SCH_JUNCTION_T && item->IsConnected( aPoint ) && !item->IsSelected() )
  {
  ptHasUnselectedJunction = true;
  break;
  }
  }
 
  for( SCH_ITEM* test : itemsOverlapping )
  {
  if( test == aOriginalItem || test->IsSelected() || !test->CanConnect( aOriginalItem ) )
  continue;
 
  KICAD_T testType = test->Type();
 
  switch( testType )
  {
  case SCH_LINE_T:
  {
  // Select the connected end of wires/bus connections that don't have an unselected
  // junction isolating them from the drag
  if( ptHasUnselectedJunction )
  break;
 
  SCH_LINE* line = static_cast<SCH_LINE*>( test );
 
  if( line->GetStartPoint() == aPoint )
  {
  if( !line->HasFlag(TEMP_SELECTED ) )
  aList.push_back( line );
 
  line->SetFlags(STARTPOINT | TEMP_SELECTED );
  }
  else if( line->GetEndPoint() == aPoint )
  {
  if( !line->HasFlag(TEMP_SELECTED ) )
  aList.push_back( line );
 
  line->SetFlags(ENDPOINT | TEMP_SELECTED );
  }
  else
  {
  break;
  }
 
  // Since only one end is going to move, the movement vector of any labels attached
  // to it is scaled by the proportion of the line length the label is from the moving
  // end.
  for( SCH_ITEM* item : itemsOverlapping )
  {
  if( item->Type() == SCH_LABEL_T )
  {
  SCH_TEXT* label = static_cast<SCH_TEXT*>( item );
 
  if( label->IsSelected() )
  continue; // These will be moved on their own because they're selected
 
  if( label->HasFlag( TEMP_SELECTED ) )
  continue;
 
  if( label->CanConnect( line ) && line->HitTest( label->GetPosition(), 1 ) )
  {
  label->SetFlags( TEMP_SELECTED );
  aList.push_back( label );
 
  SPECIAL_CASE_LABEL_INFO info;
  info.attachedLine = line;
  info.originalLabelPos = label->GetPosition();
  m_specialCaseLabels[label] = info;
  }
  }
  }
 
  break;
  }
 
  case SCH_SHEET_T:
  case SCH_SYMBOL_T:
  case SCH_JUNCTION_T:
  if( test->IsConnected( aPoint ) )
  {
  // Add a new wire between the symbol or junction and the selected item so
  // the selected item can be dragged.
  SCH_LINE* newWire = nullptr;
 
  if( test->GetLayer() == LAYER_BUS_JUNCTION ||
  aOriginalItem->GetLayer() == LAYER_BUS )
  {
  newWire = new SCH_LINE( aPoint, LAYER_BUS );
  }
  else
  newWire = new SCH_LINE( aPoint, LAYER_WIRE );
 
  newWire->SetFlags( IS_NEW );
  m_frame->AddToScreen( newWire, m_frame->GetScreen() );
 
  newWire->SetFlags( TEMP_SELECTED | STARTPOINT );
  aList.push_back( newWire );
  }
  break;
 
  case SCH_NO_CONNECT_T:
  // Select no-connects that are connected to items being moved.
  if( !test->HasFlag( TEMP_SELECTED ) && test->IsConnected( aPoint ) )
  {
  aList.push_back( test );
  test->SetFlags( TEMP_SELECTED );
  }
 
  break;
 
  case SCH_LABEL_T:
  case SCH_GLOBAL_LABEL_T:
  case SCH_HIER_LABEL_T:
  // Performance optimization:
  if( test->HasFlag( TEMP_SELECTED ) )
  break;
 
  // Select labels that are connected to a wire (or bus) being moved.
  if( aOriginalItem->Type() == SCH_LINE_T && test->CanConnect( aOriginalItem ) )
  {
  SCH_TEXT* label = static_cast<SCH_TEXT*>( test );
  SCH_LINE* line = static_cast<SCH_LINE*>( aOriginalItem );
  bool oneEndFixed = !line->HasFlag( STARTPOINT ) || !line->HasFlag( ENDPOINT );
 
  if( line->HitTest( label->GetTextPos(), 1 ) )
  {
  label->SetFlags( TEMP_SELECTED );
  aList.push_back( label );
 
  if( oneEndFixed )
  {
  SPECIAL_CASE_LABEL_INFO info;
  info.attachedLine = line;
  info.originalLabelPos = label->GetPosition();
  m_specialCaseLabels[ label ] = info;
  }
  }
  }
 
  break;
 
  case SCH_BUS_WIRE_ENTRY_T:
  case SCH_BUS_BUS_ENTRY_T:
  // Performance optimization:
  if( test->HasFlag( TEMP_SELECTED ) )
  break;
 
  // Select bus entries that are connected to a bus being moved.
  if( aOriginalItem->Type() == SCH_LINE_T && test->CanConnect( aOriginalItem ) )
  {
  SCH_LINE* line = static_cast<SCH_LINE*>( aOriginalItem );
  bool oneEndFixed = !line->HasFlag( STARTPOINT ) || !line->HasFlag( ENDPOINT );
 
  if( oneEndFixed )
  {
  // This is only going to end in tears, so don't go there
  continue;
  }
 
  for( wxPoint& point : test->GetConnectionPoints() )
  {
  if( line->HitTest( point, 1 ) )
  {
  test->SetFlags( TEMP_SELECTED );
  aList.push_back( test );
 
  // A bus entry needs its wire & label as well
  std::vector<wxPoint> ends = test->GetConnectionPoints();
  wxPoint otherEnd;
 
  if( ends[0] == point )
  otherEnd = ends[1];
  else
  otherEnd = ends[0];
 
  getConnectedDragItems( test, otherEnd, aList );
 
  // No need to test the other end of the bus entry
  break;
  }
  }
  }
 
  break;
 
  default:
  break;
  }
  }
 }

References SCH_BASE_FRAME::AddToScreen(), SCH_ITEM::CanConnect(), ENDPOINT, EDA_ITEM::GetBoundingBox(), SCH_LINE::GetEndPoint(), SCH_ITEM::GetLayer(), SCH_TEXT::GetPosition(), SCH_EDIT_FRAME::GetScreen(), SCH_LINE::GetStartPoint(), EDA_TEXT::GetTextPos(), EDA_ITEM::HasFlag(), SCH_LINE::HitTest(), info, IS_NEW, EDA_ITEM::IsSelected(), SCH_SCREEN::Items(), LAYER_BUS, LAYER_BUS_JUNCTION, LAYER_WIRE, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, m_specialCaseLabels, EE_RTREE::Overlapping(), SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_SHEET_T, SCH_SYMBOL_T, EDA_ITEM::SetFlags(), STARTPOINT, TEMP_SELECTED, and EDA_ITEM::Type().

Referenced by AlignElements(), and Main().

◆ getEditFrame()

template<typename T >

T* TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 184 of file tool_base.h.

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

References TOOL_BASE::getToolHolderInt().

Referenced by ZONE_CREATE_HELPER::createNewZone().

◆ GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Return the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns: Identifier of the tool.

Definition at line 120 of file tool_base.h.

  {
  return m_toolId;
  }

References TOOL_BASE::m_toolId.

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

◆ GetManager()

TOOL_MANAGER* TOOL_BASE::GetManager ( ) const

inlineinherited

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

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

Definition at line 143 of file tool_base.h.

  {
  return m_toolMgr;
  }

References TOOL_BASE::m_toolMgr.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), 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

Return the model object if it matches the requested type.

Store the type of the tool.

Definition at line 196 of file tool_base.h.

References TOOL_BASE::getModelInt().

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

◆ GetName()

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

inlineinherited

Return the name of the tool.

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

Returns: The name of the tool.

Definition at line 133 of file tool_base.h.

  {
  return m_toolName;
  }

References TOOL_BASE::m_toolName.

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

◆ GetToolMenu()

TOOL_MENU& TOOL_INTERACTIVE::GetToolMenu ( )

inlineinherited

Definition at line 77 of file tool_interactive.h.

77 { return m_menu; }

TOOL_INTERACTIVE::m_menu

TOOL_MENU m_menu

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

Definition: tool_interactive.h:125

References TOOL_INTERACTIVE::m_menu.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), SCH_EDIT_TOOL::Init(), EE_INSPECTION_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), CONVERT_TOOL::Init(), EE_POINT_EDITOR::Init(), BOARD_INSPECTION_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), PCB_POINT_EDITOR::Init(), Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), and LIB_TREE::onContextMenu().

◆ GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns: The type of the tool.

Definition at line 108 of file tool_base.h.

  {
  return m_type;
  }

References TOOL_BASE::m_type.

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

◆ getView()

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

protectedinherited

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

It allows tools to draw.

Returns: The instance of VIEW.

Definition at line 36 of file tool_base.cpp.

 {
  return m_toolMgr->GetView();
 }

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

◆ getViewControls()

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

protectedinherited

Return the instance of VIEW_CONTROLS object used in the application.

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

Returns: The instance of VIEW_CONTROLS.

Definition at line 42 of file tool_base.cpp.

 {
  return m_toolMgr->GetViewControls();
 }

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

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

◆ Go()

template<class T >

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

inherited

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

No conditions means any event.

Definition at line 147 of file tool_interactive.h.

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

References TOOL_INTERACTIVE::goInternal().

◆ Init()

bool SCH_MOVE_TOOL::Init ( )

overridevirtual

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

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

Reimplemented from TOOL_BASE.

Definition at line 57 of file sch_move_tool.cpp.

 {
  EE_TOOL_BASE::Init();
 
  auto moveCondition =
  []( const SELECTION& aSel )
  {
  if( aSel.Empty() || SELECTION_CONDITIONS::OnlyType( SCH_MARKER_T )( aSel ) )
  return false;
 
  if( SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus( aSel ) )
  return false;
 
  return true;
  };
 
  // Add move actions to the selection tool menu
  //
  CONDITIONAL_MENU& selToolMenu = m_selectionTool->GetToolMenu().GetMenu();
 
  selToolMenu.AddItem( EE_ACTIONS::move, moveCondition, 150 );
  selToolMenu.AddItem( EE_ACTIONS::drag, moveCondition, 150 );
  selToolMenu.AddItem( EE_ACTIONS::alignToGrid, moveCondition, 150 );
 
  return true;
 }

References CONDITIONAL_MENU::AddItem(), EE_ACTIONS::alignToGrid, EE_ACTIONS::drag, TOOL_MENU::GetMenu(), TOOL_INTERACTIVE::GetToolMenu(), EE_TOOL_BASE< T >::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, EE_ACTIONS::move, SELECTION_CONDITIONS::OnlyType(), and SCH_MARKER_T.

◆ IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 31 of file tool_base.cpp.

 {
  return m_toolMgr->IsToolActive( m_toolId );
 }

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

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

◆ Main()

int SCH_MOVE_TOOL::Main ( const TOOL_EVENT & aEvent )

Run an interactive move of the selected items, or the item under the cursor.

Definition at line 85 of file sch_move_tool.cpp.

 {
  EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
  KIGFX::VIEW_CONTROLS* controls = getViewControls();
  EE_GRID_HELPER grid( m_toolMgr );
  bool wasDragging = m_moveInProgress && m_isDrag;
  SCH_MOVE_TOOL_PARAMS* params = aEvent.Parameter<SCH_MOVE_TOOL_PARAMS*>();
 
  m_anchorPos.reset();
 
  if( aEvent.IsAction( &EE_ACTIONS::move ) )
  m_isDrag = false;
  else if( aEvent.IsAction( &EE_ACTIONS::drag ) )
  m_isDrag = true;
  else if( aEvent.IsAction( &EE_ACTIONS::moveActivate ) )
  m_isDrag = !cfg->m_Input.drag_is_move;
  else
  return 0;
 
  if( m_moveInProgress )
  {
  if( m_isDrag != wasDragging )
  {
  EDA_ITEM* sel = m_selectionTool->GetSelection().Front();
 
  if( sel && !sel->IsNew() )
  {
  // Reset the selected items so we can start again with the current m_isDrag
  // state.
  m_frame->RollbackSchematicFromUndo();
  m_selectionTool->RemoveItemsFromSel( &m_dragAdditions, QUIET_MODE );
  m_anchorPos = m_cursor - m_moveOffset;
  m_moveInProgress = false;
  controls->SetAutoPan( false );
 
  // And give it a kick so it doesn't have to wait for the first mouse movement
  // to refresh.
  m_toolMgr->RunAction( EE_ACTIONS::restartMove );
  }
  }
 
  return 0;
  }
 
  // Be sure that there is at least one item that we can move. If there's no selection try
  // looking for the stuff under mouse cursor (i.e. Kicad old-style hover selection).
  EE_SELECTION& selection = m_selectionTool->RequestSelection( EE_COLLECTOR::MovableItems );
  bool unselect = selection.IsHover();
 
  // Keep an original copy of the starting points for cleanup after the move
  std::vector<DANGLING_END_ITEM> internalPoints;
 
  Activate();
  // Must be done after Activate() so that it gets set into the correct context
  controls->ShowCursor( true );
 
  std::string tool = aEvent.GetCommandStr().get();
  m_frame->PushTool( tool );
 
  if( selection.Empty() )
  {
  // Note that it's important to go through push/pop even when the selection is empty.
  // This keeps other tools from having to special-case an empty move.
  m_frame->PopTool( tool );
  return 0;
  }
 
  bool restore_state = false;
  bool chain_commands = false;
  TOOL_EVENT* evt = const_cast<TOOL_EVENT*>( &aEvent );
  VECTOR2I prevPos;
  int snapLayer = UNDEFINED_LAYER;
 
  m_cursor = controls->GetCursorPosition();
 
  // Main loop: keep receiving events
  do
  {
  m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::MOVING );
  grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
  grid.SetUseGrid( getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
 
  if( evt->IsAction( &EE_ACTIONS::moveActivate )
  || evt->IsAction( &EE_ACTIONS::restartMove )
  || evt->IsAction( &EE_ACTIONS::move )
  || evt->IsAction( &EE_ACTIONS::drag )
  || evt->IsMotion()
  || evt->IsDrag( BUT_LEFT )
  || evt->IsAction( &ACTIONS::refreshPreview ) )
  {
  if( !m_moveInProgress ) // Prepare to start moving/dragging
  {
  SCH_ITEM* sch_item = (SCH_ITEM*) selection.Front();
  bool appendUndo =
  params ? params->appendToLastUndo : ( sch_item && sch_item->IsNew() );
  bool placingNewItems =
  params ? params->placingNewItems : ( sch_item && sch_item->IsNew() );
 
 
  //------------------------------------------------------------------------
  // Setup a drag or a move
  //
  m_dragAdditions.clear();
  m_specialCaseLabels.clear();
  internalPoints.clear();
 
  for( SCH_ITEM* it : m_frame->GetScreen()->Items() )
  {
  it->ClearFlags( TEMP_SELECTED );
 
  if( !it->IsSelected() )
  it->ClearFlags( STARTPOINT | ENDPOINT );
 
  if( !selection.IsHover() && it->IsSelected() )
  it->SetFlags( STARTPOINT | ENDPOINT );
  }
 
  if( m_isDrag )
  {
  EDA_ITEMS connectedDragItems;
 
  // Add connections to the selection for a drag.
  //
  for( EDA_ITEM* edaItem : selection )
  {
  SCH_ITEM* item = static_cast<SCH_ITEM*>( edaItem );
  std::vector<wxPoint> connections;
 
  if( item->Type() == SCH_LINE_T )
  static_cast<SCH_LINE*>( item )->GetSelectedPoints( connections );
  else
  connections = item->GetConnectionPoints();
 
  for( wxPoint point : connections )
  getConnectedDragItems( item, point, connectedDragItems );
  }
 
  for( EDA_ITEM* item : connectedDragItems )
  {
  m_dragAdditions.push_back( item->m_Uuid );
  m_selectionTool->AddItemToSel( item, QUIET_MODE );
  }
  }
  else
  {
  // Mark the edges of the block with dangling flags for a move.
  for( EDA_ITEM* item : selection )
  static_cast<SCH_ITEM*>( item )->GetEndPoints( internalPoints );
 
  for( EDA_ITEM* item : selection )
  static_cast<SCH_ITEM*>( item )->UpdateDanglingState( internalPoints );
  }
  // Generic setup
  //
  for( EDA_ITEM* item : selection )
  {
  if( static_cast<SCH_ITEM*>( item )->IsConnectable() )
  {
  if( snapLayer == LAYER_GRAPHICS )
  snapLayer = LAYER_ANY;
  else
  snapLayer = LAYER_CONNECTABLE;
  }
  else
  {
  if( snapLayer == LAYER_CONNECTABLE )
  snapLayer = LAYER_ANY;
  else
  snapLayer = LAYER_GRAPHICS;
  }
 
  if( item->IsNew() )
  {
  if( item->HasFlag( TEMP_SELECTED ) && m_isDrag )
  {
  // Item was added in getConnectedDragItems
  saveCopyInUndoList( (SCH_ITEM*) item, UNDO_REDO::NEWITEM, appendUndo );
  appendUndo = true;
  }
  else
  {
  // Item was added in a previous command (and saved to undo by
  // that command)
  }
  }
  else if( item->GetParent() && item->GetParent()->IsSelected() )
  {
  // Item will be (or has been) saved to undo by parent
  }
  else
  {
  saveCopyInUndoList( (SCH_ITEM*) item, UNDO_REDO::CHANGED, appendUndo );
  appendUndo = true;
  }
 
  SCH_ITEM* schItem = (SCH_ITEM*) item;
  schItem->SetStoredPos( schItem->GetPosition() );
  }
 
  // Set up the starting position and move/drag offset
  //
  m_cursor = controls->GetCursorPosition();
 
  if( evt->IsAction( &EE_ACTIONS::restartMove ) )
  {
  wxASSERT_MSG( m_anchorPos, wxT( "Should be already set from previous cmd" ) );
  }
  else if( placingNewItems )
  {
  m_anchorPos = selection.GetReferencePoint();
  }
 
  if( m_anchorPos )
  {
  VECTOR2I delta = m_cursor - (*m_anchorPos);
  bool isPasted = false;
 
  // Drag items to the current cursor position
  for( EDA_ITEM* item : selection )
  {
  // Don't double move pins, fields, etc.
  if( item->GetParent() && item->GetParent()->IsSelected() )
  continue;
 
  moveItem( item, delta );
  updateItem( item, false );
 
  isPasted |= ( item->GetFlags() & IS_PASTED ) != 0;
  item->ClearFlags( IS_PASTED );
  }
 
  // The first time pasted items are moved we need to store
  // the position of the cursor so that rotate while moving
  // works as expected (instead of around the original anchor
  // point
  if( isPasted )
  selection.SetReferencePoint( m_cursor );
 
  m_anchorPos = m_cursor;
  }
  // For some items, moving the cursor to anchor is not good (for instance large
  // hierarchical sheets or symbols can have the anchor outside the view)
  else if( selection.Size() == 1 && !sch_item->IsMovableFromAnchorPoint() )
  {
  m_cursor = getViewControls()->GetCursorPosition( true );
  m_anchorPos = m_cursor;
  }
  else
  {
  if( m_frame->GetMoveWarpsCursor() )
  {
  // User wants to warp the mouse
  m_cursor = grid.BestDragOrigin( m_cursor, snapLayer, selection );
  selection.SetReferencePoint( m_cursor );
  }
  else
  {
  // User does not want to warp the mouse
  m_cursor = getViewControls()->GetCursorPosition( true );
  }
  }
 
  controls->SetCursorPosition( m_cursor, false );
  m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 
  prevPos = m_cursor;
  controls->SetAutoPan( true );
  m_moveInProgress = true;
  }
 
  //------------------------------------------------------------------------
  // Follow the mouse
  //
  m_cursor = grid.BestSnapAnchor( controls->GetCursorPosition( false ),
  snapLayer, selection );
 
  VECTOR2I delta( m_cursor - prevPos );
  m_anchorPos = m_cursor;
 
  m_moveOffset += delta;
  prevPos = m_cursor;
 
  for( EDA_ITEM* item : selection )
  {
  // Don't double move pins, fields, etc.
  if( item->GetParent() && item->GetParent()->IsSelected() )
  continue;
 
  moveItem( item, delta );
  updateItem( item, false );
  }
 
  if( selection.HasReferencePoint() )
  selection.SetReferencePoint( selection.GetReferencePoint() + delta );
 
  m_toolMgr->PostEvent( EVENTS::SelectedItemsMoved );
  }
  //------------------------------------------------------------------------
  // Handle cancel
  //
  else if( evt->IsCancelInteractive() || evt->IsActivate() )
  {
  if( evt->IsCancelInteractive() )
  m_frame->GetInfoBar()->Dismiss();
 
  if( m_moveInProgress )
  {
  if( evt->IsActivate() )
  {
  // Allowing other tools to activate during a move runs the risk of race
  // conditions in which we try to spool up both event loops at once.
 
  if( m_isDrag )
  m_frame->ShowInfoBarMsg( _( "Press <ESC> to cancel drag." ) );
  else
  m_frame->ShowInfoBarMsg( _( "Press <ESC> to cancel move." ) );
 
  evt->SetPassEvent( false );
  continue;
  }
 
  evt->SetPassEvent( false );
  restore_state = true;
  }
 
  break;
  }
  //------------------------------------------------------------------------
  // Handle TOOL_ACTION special cases
  //
  else if( evt->Action() == TA_UNDO_REDO_PRE )
  {
  unselect = true;
  break;
  }
  else if( evt->IsAction( &ACTIONS::doDelete ) )
  {
  evt->SetPassEvent();
  // Exit on a delete; there will no longer be anything to drag.
  break;
  }
  else if( evt->IsAction( &ACTIONS::duplicate ) )
  {
  if( selection.Front()->IsNew() )
  {
  // This doesn't really make sense; we'll just end up dragging a stack of
  // objects so we ignore the duplicate and just carry on.
  continue;
  }
 
  // Move original back and exit. The duplicate will run in its own loop.
  restore_state = true;
  unselect = false;
  chain_commands = true;
  break;
  }
  else if( evt->Action() == TA_CHOICE_MENU_CHOICE )
  {
  if( evt->GetCommandId().get() >= ID_POPUP_SCH_SELECT_UNIT_CMP
  && evt->GetCommandId().get() <= ID_POPUP_SCH_SELECT_UNIT_SYM_MAX )
  {
  SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( selection.Front() );
  int unit = evt->GetCommandId().get() - ID_POPUP_SCH_SELECT_UNIT_CMP;
 
  if( symbol )
  {
  m_frame->SelectUnit( symbol, unit );
  m_toolMgr->RunAction( ACTIONS::refreshPreview );
  }
  }
  }
  else if( evt->IsAction( &EE_ACTIONS::highlightNet )
  || evt->IsAction( &EE_ACTIONS::explicitCrossProbe ) )
  {
  // These don't make any sense during a move. Eat them.
  }
  //------------------------------------------------------------------------
  // Handle context menu
  //
  else if( evt->IsClick( BUT_RIGHT ) )
  {
  m_menu.ShowContextMenu( m_selectionTool->GetSelection() );
  }
  //------------------------------------------------------------------------
  // Handle drop
  //
  else if( evt->IsMouseUp( BUT_LEFT )
  || evt->IsClick( BUT_LEFT )
  || evt->IsDblClick( BUT_LEFT ) )
  {
  break; // Finish
  }
  else
  {
  evt->SetPassEvent();
  }
 
  controls->SetAutoPan( m_moveInProgress );
 
  } while( ( evt = Wait() ) ); //Should be assignment not equality test
 
  controls->ForceCursorPosition( false );
  controls->ShowCursor( false );
  controls->SetAutoPan( false );
 
  if( !chain_commands )
  m_moveOffset = { 0, 0 };
 
  m_anchorPos.reset();
 
  for( EDA_ITEM* item : selection )
  item->ClearEditFlags();
 
  if( restore_state )
  {
  m_selectionTool->RemoveItemsFromSel( &m_dragAdditions, QUIET_MODE );
  m_frame->RollbackSchematicFromUndo();
  }
  else
  {
  // One last update after exiting loop (for slower stuff, such as updating SCREEN's RTree).
  for( EDA_ITEM* item : selection )
  updateItem( item, true );
 
  EE_SELECTION selectionCopy( selection );
  m_selectionTool->RemoveItemsFromSel( &m_dragAdditions, QUIET_MODE );
 
  // If we move items away from a junction, we _may_ want to add a junction there
  // to denote the state.
  for( const DANGLING_END_ITEM& it : internalPoints )
   {
  if( m_frame->GetScreen()->IsExplicitJunctionNeeded( it.GetPosition()) )
  m_frame->AddJunction( m_frame->GetScreen(), it.GetPosition(), true, false );
  }
 
  m_toolMgr->RunAction( EE_ACTIONS::trimOverlappingWires, true, &selectionCopy );
  m_toolMgr->RunAction( EE_ACTIONS::addNeededJunctions, true, &selectionCopy );
 
  m_frame->RecalculateConnections( LOCAL_CLEANUP );
  m_frame->TestDanglingEnds();
 
  m_frame->OnModify();
  }
 
  if( unselect )
  m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
  else
  m_selectionTool->RebuildSelection(); // Schematic cleanup might have merged lines, etc.
 
  m_dragAdditions.clear();
  m_moveInProgress = false;
  m_frame->PopTool( tool );
  return 0;
 }

References _, TOOL_EVENT::Action(), TOOL_INTERACTIVE::Activate(), EE_SELECTION_TOOL::AddItemToSel(), SCH_EDIT_FRAME::AddJunction(), EE_ACTIONS::addNeededJunctions, SCH_MOVE_TOOL_PARAMS::appendToLastUndo, BUT_LEFT, BUT_RIGHT, CHANGED, EE_ACTIONS::clearSelection, delta, TOOL_EVENT::DisableGridSnapping(), WX_INFOBAR::Dismiss(), ACTIONS::doDelete, EE_ACTIONS::drag, EESCHEMA_SETTINGS::INPUT::drag_is_move, ACTIONS::duplicate, SELECTION::Empty(), ENDPOINT, EE_ACTIONS::explicitCrossProbe, SELECTION::Front(), SCH_BASE_FRAME::GetCanvas(), TOOL_EVENT::GetCommandId(), TOOL_EVENT::GetCommandStr(), getConnectedDragItems(), SCH_ITEM::GetConnectionPoints(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), EDA_BASE_FRAME::GetInfoBar(), TOOLS_HOLDER::GetMoveWarpsCursor(), EDA_ITEM::GetPosition(), SCH_EDIT_FRAME::GetScreen(), EE_SELECTION_TOOL::GetSelection(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), grid, EE_ACTIONS::highlightNet, ID_POPUP_SCH_SELECT_UNIT_CMP, ID_POPUP_SCH_SELECT_UNIT_SYM_MAX, IS_PASTED, TOOL_EVENT::IsAction(), TOOL_EVENT::IsActivate(), TOOL_EVENT::IsCancelInteractive(), TOOL_EVENT::IsClick(), TOOL_EVENT::IsDblClick(), TOOL_EVENT::IsDrag(), SCH_SCREEN::IsExplicitJunctionNeeded(), SELECTION::IsHover(), TOOL_EVENT::IsMotion(), TOOL_EVENT::IsMouseUp(), SCH_ITEM::IsMovableFromAnchorPoint(), EDA_ITEM::IsNew(), SCH_SCREEN::Items(), LAYER_ANY, LAYER_CONNECTABLE, LAYER_GRAPHICS, LOCAL_CLEANUP, m_anchorPos, m_cursor, m_dragAdditions, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EESCHEMA_SETTINGS::m_Input, m_isDrag, TOOL_INTERACTIVE::m_menu, m_moveInProgress, m_moveOffset, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, m_specialCaseLabels, TOOL_BASE::m_toolMgr, MD_SHIFT, TOOL_EVENT::Modifier(), EE_COLLECTOR::MovableItems, EE_ACTIONS::move, EE_ACTIONS::moveActivate, moveItem(), MOVING, NEWITEM, SCH_EDIT_FRAME::OnModify(), TOOL_EVENT::Parameter(), Pgm(), SCH_MOVE_TOOL_PARAMS::placingNewItems, TOOLS_HOLDER::PopTool(), TOOL_MANAGER::PostEvent(), TOOLS_HOLDER::PushTool(), QUIET_MODE, EE_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_FRAME::RecalculateConnections(), ACTIONS::refreshPreview, EE_SELECTION_TOOL::RemoveItemsFromSel(), EE_SELECTION_TOOL::RequestSelection(), EE_ACTIONS::restartMove, SCH_EDIT_FRAME::RollbackSchematicFromUndo(), TOOL_MANAGER::RunAction(), EE_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList(), SCH_LINE_T, EVENTS::SelectedItemsModified, EVENTS::SelectedItemsMoved, SCH_EDIT_FRAME::SelectUnit(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), TOOL_EVENT::SetPassEvent(), SCH_ITEM::SetStoredPos(), TOOL_MENU::ShowContextMenu(), EDA_BASE_FRAME::ShowInfoBarMsg(), STARTPOINT, TA_CHOICE_MENU_CHOICE, TA_UNDO_REDO_PRE, TEMP_SELECTED, SCH_EDIT_FRAME::TestDanglingEnds(), EE_ACTIONS::trimOverlappingWires, EDA_ITEM::Type(), UNDEFINED_LAYER, EE_TOOL_BASE< SCH_EDIT_FRAME >::updateItem(), and TOOL_INTERACTIVE::Wait().

Referenced by setTransitions().

◆ moveItem()

void SCH_MOVE_TOOL::moveItem	(	EDA_ITEM *	aItem,
		const VECTOR2I &	aDelta
	)

private

Find additional items for a drag operation.

Connected items with no wire are included (as there is no wire to adjust for the drag). Connected wires are included with any un-connected ends flagged (STARTPOINT or ENDPOINT).

Definition at line 742 of file sch_move_tool.cpp.

 {
  switch( aItem->Type() )
  {
  case SCH_LINE_T:
  {
  SCH_LINE* line = static_cast<SCH_LINE*>( aItem );
 
  if( aItem->HasFlag( STARTPOINT ) )
  line->MoveStart( (wxPoint) aDelta );
 
  if( aItem->HasFlag( ENDPOINT ) )
  line->MoveEnd( (wxPoint) aDelta );
 
  break;
  }
 
  case SCH_PIN_T:
  case SCH_FIELD_T:
  {
  SCH_ITEM* parent = (SCH_ITEM*) aItem->GetParent();
  wxPoint delta( aDelta );
 
  if( parent && parent->Type() == SCH_SYMBOL_T )
  {
  SCH_SYMBOL* symbol = (SCH_SYMBOL*) aItem->GetParent();
  TRANSFORM transform = symbol->GetTransform().InverseTransform();
 
  delta = transform.TransformCoordinate( delta );
  }
 
  static_cast<SCH_ITEM*>( aItem )->Move( delta );
 
  // If we're moving a field with respect to its parent then it's no longer auto-placed
  if( aItem->Type() == SCH_FIELD_T && parent && !parent->IsSelected() )
  parent->ClearFieldsAutoplaced();
 
  break;
  }
 
  case SCH_SHEET_PIN_T:
  {
  SCH_SHEET_PIN* pin = (SCH_SHEET_PIN*) aItem;
 
  pin->SetStoredPos( pin->GetStoredPos() + (wxPoint) aDelta );
  pin->ConstrainOnEdge( pin->GetStoredPos() );
  break;
  }
 
  case SCH_LABEL_T:
  {
  SCH_TEXT* label = static_cast<SCH_TEXT*>( aItem );
 
  if( m_specialCaseLabels.count( label ) )
  {
  SPECIAL_CASE_LABEL_INFO info = m_specialCaseLabels[ label ];
  SEG currentLine( info.attachedLine->GetStartPoint(), info.attachedLine->GetEndPoint() );
  label->SetPosition( (wxPoint) currentLine.NearestPoint( info.originalLabelPos ) );
  }
  else
  {
  label->Move( (wxPoint) aDelta );
  }
 
  break;
  }
 
  default:
  static_cast<SCH_ITEM*>( aItem )->Move( (wxPoint) aDelta );
  break;
  }
 
  getView()->Hide( aItem, false );
  aItem->SetFlags( IS_MOVING );
 }

References SCH_ITEM::ClearFieldsAutoplaced(), delta, ENDPOINT, EDA_ITEM::GetParent(), SCH_SYMBOL::GetTransform(), TOOL_BASE::getView(), EDA_ITEM::HasFlag(), KIGFX::VIEW::Hide(), info, TRANSFORM::InverseTransform(), IS_MOVING, EDA_ITEM::IsSelected(), m_specialCaseLabels, SCH_TEXT::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), pin, SCH_FIELD_T, SCH_LABEL_T, SCH_LINE_T, SCH_PIN_T, SCH_SHEET_PIN_T, SCH_SYMBOL_T, EDA_ITEM::SetFlags(), SCH_TEXT::SetPosition(), STARTPOINT, TRANSFORM::TransformCoordinate(), and EDA_ITEM::Type().

Referenced by AlignElements(), and Main().

◆ Reset()

void EE_TOOL_BASE< SCH_EDIT_FRAME >::Reset ( RESET_REASON aReason )

inlineoverridevirtualinherited

Bring the tool to a known, initial state.

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

Parameters

aReason contains information about the reason of tool reset.

Implements TOOL_BASE.

Definition at line 86 of file ee_tool_base.h.

  {
  if( aReason == MODEL_RELOAD )
  {
  // Init variables used by every drawing tool
  m_frame = getEditFrame<T>();
  m_isSymbolEditor = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame ) != nullptr;
  }
 
  m_view = static_cast<KIGFX::SCH_VIEW*>( getView() );
  }

◆ RunMainStack()

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

inherited

Call a function using the main stack.

Parameters

aFunc is the function to be calls.

Definition at line 87 of file tool_interactive.cpp.

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

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

Referenced by DRAWING_TOOL::PlaceText().

◆ saveCopyInUndoList()

void EE_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList	(	EDA_ITEM *	aItem,
		UNDO_REDO	aType,
		bool	aAppend = `false`
	)

inlineprotectedinherited

Definition at line 134 of file ee_tool_base.h.

  {
  wxASSERT( aItem );
 
  KICAD_T itemType = aItem->Type();
  bool selected = aItem->IsSelected();
 
  // IS_SELECTED flag should not be set on undo items which were added for
  // a drag operation.
  if( selected && aItem->HasFlag( TEMP_SELECTED ) )
  aItem->ClearSelected();
 
  if( m_isSymbolEditor )
  {
  SYMBOL_EDIT_FRAME* editFrame = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame );
  wxASSERT( editFrame );
 
  editFrame->SaveCopyInUndoList( static_cast<LIB_ITEM*>( aItem ), aType, aAppend );
  }
  else
  {
  SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
  wxASSERT( editFrame );
 
  if( itemType == SCH_PIN_T || itemType == SCH_FIELD_T || itemType == SCH_SHEET_PIN_T )
  {
  editFrame->SaveCopyInUndoList( editFrame->GetScreen(),
  static_cast<SCH_ITEM*>( aItem->GetParent() ),
  UNDO_REDO::CHANGED, aAppend );
  }
  else
  {
  editFrame->SaveCopyInUndoList( editFrame->GetScreen(),
  static_cast<SCH_ITEM*>( aItem ),
  aType, aAppend );
  }
  }
 
  if( selected && aItem->HasFlag( TEMP_SELECTED ) )
  aItem->SetSelected();
  }

◆ SetContextMenu()

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

inherited

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

Parameters

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

Definition at line 76 of file tool_interactive.cpp.

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

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

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

◆ setTransitions()

void SCH_MOVE_TOOL::setTransitions ( )

overrideprivatevirtual

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

It is called every time tool is reset or finished.

Implements TOOL_INTERACTIVE.

Definition at line 985 of file sch_move_tool.cpp.

 {
  Go( &SCH_MOVE_TOOL::Main, EE_ACTIONS::moveActivate.MakeEvent() );
  Go( &SCH_MOVE_TOOL::Main, EE_ACTIONS::move.MakeEvent() );
  Go( &SCH_MOVE_TOOL::Main, EE_ACTIONS::drag.MakeEvent() );
  Go( &SCH_MOVE_TOOL::AlignElements, EE_ACTIONS::alignToGrid.MakeEvent() );
 }

References AlignElements(), EE_ACTIONS::alignToGrid, EE_ACTIONS::drag, TOOL_INTERACTIVE::Go(), Main(), EE_ACTIONS::move, and EE_ACTIONS::moveActivate.

◆ updateItem()

void EE_TOOL_BASE< SCH_EDIT_FRAME >::updateItem	(	EDA_ITEM *	aItem,
		bool	aUpdateRTree
	)		const

inlineprotectedinherited

Similar to getView()->Update(), but handles items that are redrawn by their parents and updating the SCH_SCREEN's RTree.

Similar to m_frame->SaveCopyInUndoList(), but handles items that are owned by their parents.

Definition at line 103 of file ee_tool_base.h.

◆ Wait()

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

inherited

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

No parameters means waiting for any event.

Definition at line 57 of file tool_interactive.cpp.

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

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

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), ZOOM_TOOL::Main(), PCB_PICKER_TOOL::Main(), EE_POINT_EDITOR::Main(), PL_EDIT_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), CVPCB_CONTROL::Main(), PL_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), Main(), GERBVIEW_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), ZOOM_TOOL::selectRegion(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

Member Data Documentation

◆ m_anchorPos

boost::optional<VECTOR2I> SCH_MOVE_TOOL::m_anchorPos

private

Definition at line 98 of file sch_move_tool.h.

Referenced by Main().

◆ m_cursor

VECTOR2I SCH_MOVE_TOOL::m_cursor

private

Definition at line 96 of file sch_move_tool.h.

Referenced by Main().

◆ m_dragAdditions

std::vector<KIID> SCH_MOVE_TOOL::m_dragAdditions

private

Used for chaining commands.

Definition at line 89 of file sch_move_tool.h.

Referenced by Main().

◆ m_frame

SCH_EDIT_FRAME * EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame

protectedinherited

Definition at line 177 of file ee_tool_base.h.

◆ m_isDrag

bool SCH_MOVE_TOOL::m_isDrag

private

Items (such as wires) which were added to the selection for a drag.

Definition at line 86 of file sch_move_tool.h.

Referenced by Main().

◆ m_isSymbolEditor

bool EE_TOOL_BASE< SCH_EDIT_FRAME >::m_isSymbolEditor

protectedinherited

Definition at line 180 of file ee_tool_base.h.

◆ m_menu

TOOL_MENU TOOL_INTERACTIVE::m_menu

protectedinherited

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

Definition at line 125 of file tool_interactive.h.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), SYMBOL_EDITOR_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(), PL_EDIT_TOOL::Init(), SCH_EDIT_TOOL::Init(), PAD_TOOL::Init(), PL_DRAWING_TOOLS::Init(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SYMBOL_EDITOR_CONTROL::Init(), PCB_VIEWER_TOOLS::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), PL_SELECTION_TOOL::Init(), SCH_DRAWING_TOOLS::Init(), BOARD_EDITOR_CONTROL::Init(), GERBVIEW_SELECTION_TOOL::Init(), EDA_3D_CONTROLLER::Init(), DRAWING_TOOL::Init(), EE_SELECTION_TOOL::Init(), EE_TOOL_BASE< SCH_BASE_FRAME >::Init(), PCB_SELECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), PCB_TOOL_BASE::Init(), PICKER_TOOL::Init(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_PICKER_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), EDA_3D_CONTROLLER::Main(), PL_SELECTION_TOOL::Main(), Main(), GERBVIEW_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PICKER_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(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ m_moveInProgress

bool SCH_MOVE_TOOL::m_moveInProgress

private

< Flag determining if anything is being dragged right now

Definition at line 85 of file sch_move_tool.h.

Referenced by Main().

◆ m_moveOffset

VECTOR2I SCH_MOVE_TOOL::m_moveOffset

private

Last cursor position (needed for getModificationPoint() to avoid changes of edit reference point).

Definition at line 92 of file sch_move_tool.h.

Referenced by Main().

◆ m_selectionTool

EE_SELECTION_TOOL* EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool

protectedinherited

Definition at line 179 of file ee_tool_base.h.

◆ m_specialCaseLabels

std::map<SCH_TEXT*, SPECIAL_CASE_LABEL_INFO> SCH_MOVE_TOOL::m_specialCaseLabels

private

Definition at line 102 of file sch_move_tool.h.

Referenced by getConnectedDragItems(), Main(), and moveItem().

◆ m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Name of the tool.

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

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

◆ m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Definition at line 213 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

◆ m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

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

Definition at line 206 of file tool_base.h.

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

◆ m_view

KIGFX::SCH_VIEW* EE_TOOL_BASE< SCH_EDIT_FRAME >::m_view

protectedinherited

Definition at line 178 of file ee_tool_base.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ RESET_REASON

Constructor & Destructor Documentation

◆ SCH_MOVE_TOOL()

◆ ~SCH_MOVE_TOOL()

Member Function Documentation

◆ Activate()

◆ AlignElements()

◆ attachManager()

◆ getConnectedDragItems()

◆ getEditFrame()

◆ GetId()

◆ GetManager()

◆ getModel()

◆ GetName()

◆ GetToolMenu()

◆ GetType()

◆ getView()

◆ getViewControls()

◆ Go()

◆ Init()

◆ IsToolActive()

◆ Main()

◆ moveItem()

◆ Reset()

◆ RunMainStack()

◆ saveCopyInUndoList()

◆ SetContextMenu()

◆ setTransitions()

◆ updateItem()

◆ Wait()

Member Data Documentation

◆ m_anchorPos

◆ m_cursor

◆ m_dragAdditions

◆ m_frame

◆ m_isDrag

◆ m_isSymbolEditor

◆ m_menu

◆ m_moveInProgress

◆ m_moveOffset

◆ m_selectionTool

◆ m_specialCaseLabels

◆ m_toolId

◆ m_toolMgr

◆ m_toolName

◆ m_type

◆ m_view