SCH_EDIT_TOOL Class Reference

#include <sch_edit_tool.h>

Inheritance diagram for SCH_EDIT_TOOL:

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

Public Member Functions
	SCH_EDIT_TOOL ()
	~SCH_EDIT_TOOL () override
bool	Init () override
	Init() is called once upon a registration of the tool. More...
int	Rotate (const TOOL_EVENT &aEvent)
int	Mirror (const TOOL_EVENT &aEvent)
int	Swap (const TOOL_EVENT &aEvent)
int	RepeatDrawItem (const TOOL_EVENT &aEvent)
int	Properties (const TOOL_EVENT &aEvent)
int	EditField (const TOOL_EVENT &aEvent)
int	AutoplaceFields (const TOOL_EVENT &aEvent)
int	ChangeSymbols (const TOOL_EVENT &aEvent)
int	ConvertDeMorgan (const TOOL_EVENT &aEvent)
int	EditPageNumber (const TOOL_EVENT &aEvent)
int	ChangeTextType (const TOOL_EVENT &aEvent)
	Change a text type to another one. More...
int	BreakWire (const TOOL_EVENT &aEvent)
int	CleanupSheetPins (const TOOL_EVENT &aEvent)
int	GlobalEdit (const TOOL_EVENT &aEvent)
	Delete the selected items, or the item under the cursor. More...
int	DoDelete (const TOOL_EVENT &aEvent)
	Run the deletion tool. More...
int	DeleteItemCursor (const TOOL_EVENT &aEvent)
int	DdAppendFile (const TOOL_EVENT &aEvent)
	Drag and drop. 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

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

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, bool aDirtyConnectivity=true)
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	editFieldText (SCH_FIELD *aField)
	Set up handlers for various events. More...
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events. More...
void	resetTransitions ()
	Clear the current transition map and restores the default one created by setTransitions(). More...
void	goInternal (TOOL_STATE_FUNC &aState, const TOOL_EVENT_LIST &aConditions)
EDA_ITEM *	getModelInt () const
TOOLS_HOLDER *	getToolHolderInt () const

Private Attributes
EDA_ITEM *	m_pickerItem

Detailed Description

Definition at line 36 of file sch_edit_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.
REDRAW	Full drawing refresh.

Definition at line 77 of file tool_base.h.

 {
 RUN, 
 MODEL_RELOAD, 
 GAL_SWITCH, 
 REDRAW 
 };

Constructor & Destructor Documentation

SCH_EDIT_TOOL()

SCH_EDIT_TOOL::SCH_EDIT_TOOL

(

)

Definition at line 131 of file sch_edit_tool.cpp.

 :
 EE_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.InteractiveEdit" )
{
 m_pickerItem = nullptr;
}

References m_pickerItem.

~SCH_EDIT_TOOL()

SCH_EDIT_TOOL::~SCH_EDIT_TOOL ( )

inlineoverride

Definition at line 40 of file sch_edit_tool.h.

{ }

Member Function Documentation

Activate()

void TOOL_INTERACTIVE::Activate ( )

inherited

Run the tool.

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

Definition at line 51 of file tool_interactive.cpp.

{
 m_toolMgr->InvokeTool( m_toolId );
}

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

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

attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER *  aManager )

protectedinherited

Set the TOOL_MANAGER the tool will belong to.

Called by TOOL_MANAGER::RegisterTool()

Definition at line 60 of file tool_base.cpp.

{
 m_toolMgr = aManager;
}

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

AutoplaceFields()

int SCH_EDIT_TOOL::AutoplaceFields

(

const TOOL_EVENT &

aEvent

)

Definition at line 1452 of file sch_edit_tool.cpp.

{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( RotatableItems );
 SCH_ITEM* head = static_cast<SCH_ITEM*>( selection.Front() );
 bool moving = head && head->IsMoving();
 
 if( selection.Empty() )
 return 0;
 
 std::vector<SCH_ITEM*> autoplaceItems;
 
 for( unsigned ii = 0; ii < selection.GetSize(); ii++ )
 {
 SCH_ITEM* item = static_cast<SCH_ITEM*>( selection.GetItem( ii ) );
 
 if( item->IsType( EE_COLLECTOR::FieldOwners ) )
 autoplaceItems.push_back( item );
 else if( item->GetParent() && item->GetParent()->IsType( EE_COLLECTOR::FieldOwners ) )
 autoplaceItems.push_back( static_cast<SCH_ITEM*>( item->GetParent() ) );
 }
 
 bool appendUndo = false;
 
 for( SCH_ITEM* sch_item : autoplaceItems )
 {
 if( !moving && !sch_item->IsNew() )
 {
 saveCopyInUndoList( sch_item, UNDO_REDO::CHANGED, appendUndo, false );
 appendUndo = true;
 }
 
 sch_item->AutoplaceFields( m_frame->GetScreen(), /* aManual */ true );
 
 updateItem( sch_item, true );
 }
 
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 
 if( moving )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else
 {
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 
 m_frame->OnModify();
 }
 
 return 0;
}

References CHANGED, EE_ACTIONS::clearSelection, SELECTION::Empty(), EE_COLLECTOR::FieldOwners, SELECTION::Front(), SELECTION::GetItem(), EDA_ITEM::GetParent(), SCH_EDIT_FRAME::GetScreen(), SELECTION::GetSize(), SELECTION::IsHover(), EDA_ITEM::IsMoving(), EDA_ITEM::IsType(), SCH_ITEM::IsType(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, SCH_EDIT_FRAME::OnModify(), TOOL_MANAGER::PostEvent(), ACTIONS::refreshPreview, EE_SELECTION_TOOL::RequestSelection(), RotatableItems, TOOL_MANAGER::RunAction(), EE_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList(), EVENTS::SelectedItemsModified, and EE_TOOL_BASE< SCH_EDIT_FRAME >::updateItem().

Referenced by setTransitions().

BreakWire()

int SCH_EDIT_TOOL::BreakWire

(

const TOOL_EVENT &

aEvent

)

Definition at line 2210 of file sch_edit_tool.cpp.

{
 bool isSlice = aEvent.Matches( EE_ACTIONS::slice.MakeEvent() );
 VECTOR2I cursorPos = getViewControls()->GetCursorPosition( !aEvent.DisableGridSnapping() );
 EE_SELECTION& selection = m_selectionTool->RequestSelection( { SCH_LINE_T } );
 
 std::vector<SCH_LINE*> lines;
 
 for( EDA_ITEM* item : selection )
 {
 if( SCH_LINE* line = dyn_cast<SCH_LINE*>( item ) )
 {
 if( !line->IsEndPoint( cursorPos ) )
 lines.push_back( line );
 }
 }
 
 m_selectionTool->ClearSelection();
 m_frame->StartNewUndo();
 
 for( SCH_LINE* line : lines )
 {
 SCH_LINE* newLine;
 
 // We let the user select the break point if they're on a single line
 if( lines.size() == 1 && line->HitTest( cursorPos ) )
 m_frame->BreakSegment( line, cursorPos, &newLine );
 else
 m_frame->BreakSegment( line, line->GetMidPoint(), &newLine );
 
 // Make sure both endpoints are deselected
 newLine->ClearFlags();
 
 m_selectionTool->AddItemToSel( line );
 line->SetFlags( ENDPOINT );
 
 // If we're a break, we want to drag both wires.
 // Side note: the drag/move tool only checks whether the first item is
 // new to determine if it should append undo or not, someday this should
 // be cleaned up and explictly controlled but for now the newLine
 // selection addition must be after the existing line.
 if( !isSlice )
 {
 m_selectionTool->AddItemToSel( newLine );
 newLine->SetFlags( STARTPOINT );
 }
 }
 
 if( !lines.empty() )
 {
 m_frame->TestDanglingEnds();
 
 m_frame->OnModify();
 m_frame->GetCanvas()->Refresh();
 
 m_toolMgr->RunAction( EE_ACTIONS::drag, false, true );
 }
 
 return 0;
}

References SELECTION_TOOL::AddItemToSel(), SCH_EDIT_FRAME::BreakSegment(), EDA_ITEM::ClearFlags(), EE_SELECTION_TOOL::ClearSelection(), TOOL_EVENT::DisableGridSnapping(), EE_ACTIONS::drag, ENDPOINT, SCH_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_BASE::getViewControls(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, TOOL_EVENT::Matches(), SCH_EDIT_FRAME::OnModify(), EDA_DRAW_PANEL_GAL::Refresh(), EE_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_LINE_T, EDA_ITEM::SetFlags(), EE_ACTIONS::slice, SCH_EDIT_FRAME::StartNewUndo(), STARTPOINT, and SCH_EDIT_FRAME::TestDanglingEnds().

Referenced by setTransitions().

ChangeSymbols()

int SCH_EDIT_TOOL::ChangeSymbols

(

const TOOL_EVENT &

aEvent

)

Definition at line 1506 of file sch_edit_tool.cpp.

{
 SCH_SYMBOL* selectedSymbol = nullptr;
 EE_SELECTION& selection = m_selectionTool->RequestSelection( { SCH_SYMBOL_T } );
 
 if( !selection.Empty() )
 selectedSymbol = dynamic_cast<SCH_SYMBOL*>( selection.Front() );
 
 DIALOG_CHANGE_SYMBOLS::MODE mode = DIALOG_CHANGE_SYMBOLS::MODE::UPDATE;
 
 if( aEvent.IsAction( &EE_ACTIONS::changeSymbol )
 || aEvent.IsAction( &EE_ACTIONS::changeSymbols ) )
 {
 mode = DIALOG_CHANGE_SYMBOLS::MODE::CHANGE;
 }
 
 DIALOG_CHANGE_SYMBOLS dlg( m_frame, selectedSymbol, mode );
 
 dlg.ShowQuasiModal();
 
 return 0;
}

References DIALOG_CHANGE_SYMBOLS::CHANGE, EE_ACTIONS::changeSymbol, EE_ACTIONS::changeSymbols, SELECTION::Empty(), SELECTION::Front(), TOOL_EVENT::IsAction(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, EE_SELECTION_TOOL::RequestSelection(), SCH_SYMBOL_T, DIALOG_SHIM::ShowQuasiModal(), and DIALOG_CHANGE_SYMBOLS::UPDATE.

Referenced by setTransitions().

ChangeTextType()

int SCH_EDIT_TOOL::ChangeTextType

(

const TOOL_EVENT &

aEvent

)

Change a text type to another one.

The new text, label, hierarchical label, or global label is created from the old text and the old text object is deleted.

A tricky case is when the 'old" text is being edited (i.e. moving) because we must create a new text, and prepare the undo/redo command data for this change and the current move/edit command

Definition at line 1883 of file sch_edit_tool.cpp.

{
 KICAD_T convertTo = aEvent.Parameter<KICAD_T>();
 EE_SELECTION selection = m_selectionTool->RequestSelection( { SCH_LABEL_LOCATE_ANY_T,
 SCH_TEXT_T,
 SCH_TEXTBOX_T } );
 
 for( unsigned int i = 0; i < selection.GetSize(); ++i )
 {
 SCH_ITEM* item = dynamic_cast<SCH_ITEM*>( selection.GetItem( i ) );
 
 if( item && item->Type() != convertTo )
 {
  bool selected = item->IsSelected();
 SCH_ITEM* newtext = nullptr;
 VECTOR2I position = item->GetPosition();
 wxString txt;
 wxString href;
 TEXT_SPIN_STYLE orientation = TEXT_SPIN_STYLE::SPIN::RIGHT;
 LABEL_FLAG_SHAPE shape = LABEL_FLAG_SHAPE::L_UNSPECIFIED;
 
 switch( item->Type() )
 {
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 {
 SCH_TEXT* label = static_cast<SCH_LABEL_BASE*>( item );
 
 txt = UnescapeString( label->GetText() );
 orientation = label->GetTextSpinStyle();
 shape = label->GetShape();
 href = label->GetHyperlink();
 break;
 }
 
 case SCH_DIRECTIVE_LABEL_T:
 {
 SCH_DIRECTIVE_LABEL* dirlabel = static_cast<SCH_DIRECTIVE_LABEL*>( item );
 
 // a SCH_DIRECTIVE_LABEL has no text
 txt = _( "<empty>" );
 
 orientation = dirlabel->GetTextSpinStyle();
 href = dirlabel->GetHyperlink();
 break;
 }
 
 case SCH_TEXT_T:
 {
 SCH_TEXT* text = static_cast<SCH_TEXT*>( item );
 
 txt = text->GetText();
 orientation = text->GetTextSpinStyle();
 href = text->GetHyperlink();
 break;
 }
 
 case SCH_TEXTBOX_T:
 {
 SCH_TEXTBOX* textbox = static_cast<SCH_TEXTBOX*>( item );
 BOX2I bbox = textbox->GetBoundingBox();
 
 bbox.Inflate( -textbox->GetTextMargin() );
 
 if( convertTo == SCH_LABEL_T
 || convertTo == SCH_HIER_LABEL_T
 || convertTo == SCH_GLOBAL_LABEL_T )
 {
 EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( item );
 wxCHECK( text, 0 );
 int textSize = text->GetTextSize().y;
 bbox.Inflate( item->Schematic()->Settings().m_LabelSizeRatio * textSize );
 }
 
 txt = textbox->GetText();
 
 if( textbox->GetTextAngle().IsVertical() )
 {
 if( textbox->GetHorizJustify() == GR_TEXT_H_ALIGN_RIGHT )
 {
 orientation = TEXT_SPIN_STYLE::SPIN::BOTTOM;
 position = VECTOR2I( bbox.Centre().x, bbox.GetOrigin().y );
 }
 else
 {
 orientation = TEXT_SPIN_STYLE::SPIN::UP;
 position = VECTOR2I( bbox.Centre().x, bbox.GetEnd().y );
 }
 }
 else
 {
 if( textbox->GetHorizJustify() == GR_TEXT_H_ALIGN_RIGHT )
 {
 orientation = TEXT_SPIN_STYLE::SPIN::LEFT;
 position = VECTOR2I( bbox.GetEnd().x, bbox.Centre().y );
 }
 else
 {
 orientation = TEXT_SPIN_STYLE::SPIN::RIGHT;
 position = VECTOR2I( bbox.GetOrigin().x, bbox.Centre().y );
 }
 }
 
 position = m_frame->GetNearestGridPosition( position );
 href = textbox->GetHyperlink();
 break;
 }
 
 default:
 UNIMPLEMENTED_FOR( item->GetClass() );
 break;
 }
 
 auto getValidNetname =
 []( const wxString& aText )
 {
 wxString local_txt = aText;
 local_txt.Replace( "\n", "_" );
 local_txt.Replace( "\r", "_" );
 local_txt.Replace( "\t", "_" );
 
 // Bus groups can have spaces; bus vectors and signal names cannot
 if( !NET_SETTINGS::ParseBusGroup( aText, nullptr, nullptr ) )
 local_txt.Replace( " ", "_" );
 
 // label strings are "escaped" i.e. a '/' is replaced by "{slash}"
  local_txt = EscapeString( local_txt, CTX_NETNAME );
 
 if( local_txt.IsEmpty() )
 return _( "<empty>" );
 else
 return local_txt;
 };
 
 switch( convertTo )
 {
 case SCH_LABEL_T:
 {
 SCH_LABEL_BASE* new_label = new SCH_LABEL( position, getValidNetname( txt ) );
 
 new_label->SetShape( shape );
 new_label->SetTextSpinStyle( orientation );
 new_label->SetHyperlink( href );
 newtext = new_label;
 break;
 }
 
 case SCH_GLOBAL_LABEL_T:
 {
 SCH_LABEL_BASE* new_label = new SCH_GLOBALLABEL( position, getValidNetname( txt ) );
 
 new_label->SetShape( shape );
 new_label->SetTextSpinStyle( orientation );
 new_label->SetHyperlink( href );
 newtext = new_label;
 break;
 }
 
 case SCH_HIER_LABEL_T:
 {
 SCH_LABEL_BASE* new_label = new SCH_HIERLABEL( position, getValidNetname( txt ) );
 
 new_label->SetShape( shape );
 new_label->SetTextSpinStyle( orientation );
 new_label->SetHyperlink( href );
 newtext = new_label;
 break;
 }
 
 case SCH_DIRECTIVE_LABEL_T:
 {
 SCH_LABEL_BASE* new_label = new SCH_DIRECTIVE_LABEL( position );
 
 // A SCH_DIRECTIVE_LABEL usually has at least one field containing the net class
 // name. If we're copying from a text object assume the text is the netclass
 // name. Otherwise, we'll just copy the fields which will either have a netclass
 // or not.
 if( !dynamic_cast<SCH_LABEL_BASE*>( item ) )
 {
 SCH_FIELD netclass( position, 0, new_label, wxT( "Netclass" ) );
 netclass.SetText( txt );
 netclass.SetVisible( true );
 new_label->GetFields().push_back( netclass );
 }
 
 new_label->SetShape( LABEL_FLAG_SHAPE::F_ROUND );
 new_label->SetTextSpinStyle( orientation );
 new_label->SetHyperlink( href );
 newtext = new_label;
 break;
 }
 
 case SCH_TEXT_T:
 {
 SCH_TEXT* new_text = new SCH_TEXT( position, txt );
 
 new_text->SetTextSpinStyle( orientation );
 new_text->SetHyperlink( href );
 newtext = new_text;
 break;
 }
 
 case SCH_TEXTBOX_T:
 {
 SCH_TEXTBOX* new_textbox = new SCH_TEXTBOX( 0, FILL_T::NO_FILL, txt );
 BOX2I bbox = item->GetBoundingBox();
 
 if( SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( item ) )
 bbox.Inflate( -label->GetLabelBoxExpansion() );
 
 EDA_TEXT* textItem = dynamic_cast<EDA_TEXT*>( item );
 wxCHECK(textItem, 0 );
 
 // Careful: GetTextMargin() is dependent on font size...
 new_textbox->SetTextSize( textItem->GetTextSize() );
 
 int margin = new_textbox->GetTextMargin();
 bbox.Inflate( margin );
 
 // Add 1/20 of the margin at the end to reduce line-breaking changes.
 int slop = margin / 20;
 
 switch( orientation )
 {
 case TEXT_SPIN_STYLE::SPIN::RIGHT:
 new_textbox->SetPosition( bbox.GetPosition() );
 new_textbox->SetEnd( bbox.GetEnd() + VECTOR2I( slop, 0 ) );
 break;
 
 case TEXT_SPIN_STYLE::SPIN::LEFT:
 new_textbox->SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
 new_textbox->SetPosition( bbox.GetPosition() - VECTOR2I( slop, 0 ) );
 new_textbox->SetEnd( bbox.GetEnd() );
 break;
 
 case TEXT_SPIN_STYLE::SPIN::UP:
 new_textbox->SetTextAngle( ANGLE_VERTICAL );
 new_textbox->SetPosition( bbox.GetPosition() - VECTOR2I( 0, slop ) );
 new_textbox->SetEnd( bbox.GetEnd() );
 break;
 
 case TEXT_SPIN_STYLE::SPIN::BOTTOM:
 new_textbox->SetTextAngle( ANGLE_VERTICAL );
 new_textbox->SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
 new_textbox->SetPosition( bbox.GetPosition() );
 new_textbox->SetEnd( bbox.GetEnd() + VECTOR2I( 0, slop ) );
 break;
 }
 
 new_textbox->SetHyperlink( href );
 newtext = new_textbox;
 break;
 }
 
 default:
 UNIMPLEMENTED_FOR( wxString::Format( "%d.", convertTo ) );
 break;
 }
 
 wxCHECK2( newtext, continue );
 
 // Copy the old text item settings to the new one. Justifications are not copied
 // because they are not used in labels. Justifications will be set to default value
 // in the new text item type.
 //
 newtext->SetFlags( item->GetEditFlags() );
 
 EDA_TEXT* eda_text = dynamic_cast<EDA_TEXT*>( item );
 EDA_TEXT* new_eda_text = dynamic_cast<EDA_TEXT*>( newtext );
 
 wxCHECK2( eda_text && new_eda_text, continue );
 
 new_eda_text->SetFont( eda_text->GetFont() );
 new_eda_text->SetTextSize( eda_text->GetTextSize() );
 new_eda_text->SetTextThickness( eda_text->GetTextThickness() );
 new_eda_text->SetItalic( eda_text->IsItalic() );
 new_eda_text->SetBold( eda_text->IsBold() );
 
 newtext->AutoplaceFields( m_frame->GetScreen(), false );
 
 SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( item );
 SCH_LABEL_BASE* new_label = dynamic_cast<SCH_LABEL_BASE*>( newtext );
 
 if( label && new_label )
 new_label->SetFields( label->GetFields() );
 
 if( selected )
 m_toolMgr->RunAction( EE_ACTIONS::removeItemFromSel, true, item );
 
 if( !item->IsNew() )
 {
 saveCopyInUndoList( item, UNDO_REDO::DELETED, i != 0 );
 saveCopyInUndoList( newtext, UNDO_REDO::NEWITEM, true );
 
 m_frame->RemoveFromScreen( item, m_frame->GetScreen() );
 m_frame->AddToScreen( newtext, m_frame->GetScreen() );
 }
 
 if( selected )
 m_toolMgr->RunAction( EE_ACTIONS::addItemToSel, true, newtext );
 
 // Otherwise, pointer is owned by the undo stack
 if( item->IsNew() )
 delete item;
 
 if( convertTo == SCH_TEXT_T || convertTo == SCH_TEXTBOX_T )
 {
 if( newtext->IsDangling() )
 getView()->Update( newtext, KIGFX::REPAINT );
 }
 else
 {
 m_frame->TestDanglingEnds();
 }
 
 m_frame->OnModify();
 }
 }
 
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 
 return 0;
}

References _, EE_ACTIONS::addItemToSel, SCH_BASE_FRAME::AddToScreen(), ANGLE_VERTICAL, SCH_ITEM::AutoplaceFields(), BOX2< Vec >::Centre(), EE_ACTIONS::clearSelection, CTX_NETNAME, DELETED, EscapeString(), F_ROUND, Format(), EDA_ITEM::GetBoundingBox(), SCH_SHAPE::GetBoundingBox(), SCH_ITEM::GetClass(), EDA_ITEM::GetEditFlags(), BOX2< Vec >::GetEnd(), SCH_LABEL_BASE::GetFields(), EDA_TEXT::GetFont(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetHyperlink(), EDA_DRAW_FRAME::GetNearestGridPosition(), BOX2< Vec >::GetOrigin(), EDA_ITEM::GetPosition(), BOX2< Vec >::GetPosition(), SCH_EDIT_FRAME::GetScreen(), SCH_TEXT::GetShape(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), SCH_TEXTBOX::GetTextMargin(), EDA_TEXT::GetTextSize(), SCH_TEXT::GetTextSpinStyle(), EDA_TEXT::GetTextThickness(), TOOL_BASE::getView(), GR_TEXT_H_ALIGN_RIGHT, BOX2< Vec >::Inflate(), EDA_TEXT::IsBold(), SCH_ITEM::IsDangling(), EDA_TEXT::IsItalic(), EDA_ITEM::IsNew(), EDA_ITEM::IsSelected(), EDA_ANGLE::IsVertical(), L_UNSPECIFIED, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCHEMATIC_SETTINGS::m_LabelSizeRatio, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, NEWITEM, NO_FILL, SCH_EDIT_FRAME::OnModify(), TOOL_EVENT::Parameter(), NET_SETTINGS::ParseBusGroup(), SCH_BASE_FRAME::RemoveFromScreen(), EE_ACTIONS::removeItemFromSel, KIGFX::REPAINT, EE_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EE_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList(), SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_LOCATE_ANY_T, SCH_LABEL_T, SCH_TEXT_T, SCH_TEXTBOX_T, SCH_ITEM::Schematic(), EDA_TEXT::SetBold(), EDA_SHAPE::SetEnd(), SCH_LABEL_BASE::SetFields(), EDA_ITEM::SetFlags(), EDA_TEXT::SetFont(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetHyperlink(), EDA_TEXT::SetItalic(), SCH_SHAPE::SetPosition(), SCH_LABEL_BASE::SetShape(), EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextSize(), SCH_TEXT::SetTextSpinStyle(), EDA_TEXT::SetTextThickness(), SCHEMATIC::Settings(), EDA_TEXT::SetVisible(), SCH_EDIT_FRAME::TestDanglingEnds(), text, EDA_ITEM::Type(), UnescapeString(), UNIMPLEMENTED_FOR, KIGFX::VIEW::Update(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

CleanupSheetPins()

int SCH_EDIT_TOOL::CleanupSheetPins

(

const TOOL_EVENT &

aEvent

)

Definition at line 2272 of file sch_edit_tool.cpp.

{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( { SCH_SHEET_T } );
 SCH_SHEET* sheet = (SCH_SHEET*) selection.Front();
 
 if( !sheet || !sheet->HasUndefinedPins() )
 return 0;
 
 if( !IsOK( m_frame, _( "Do you wish to delete the unreferenced pins from this sheet?" ) ) )
 return 0;
 
 saveCopyInUndoList( sheet, UNDO_REDO::CHANGED );
 
 sheet->CleanupSheet();
 
 updateItem( sheet, true );
 m_frame->OnModify();
 
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 
 return 0;
}

References _, CHANGED, SCH_SHEET::CleanupSheet(), EE_ACTIONS::clearSelection, SELECTION::Front(), SCH_SHEET::HasUndefinedPins(), SELECTION::IsHover(), IsOK(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, SCH_EDIT_FRAME::OnModify(), EE_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EE_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList(), SCH_SHEET_T, and EE_TOOL_BASE< SCH_EDIT_FRAME >::updateItem().

Referenced by setTransitions().

ConvertDeMorgan()

int SCH_EDIT_TOOL::ConvertDeMorgan

(

const TOOL_EVENT &

aEvent

)

Definition at line 1530 of file sch_edit_tool.cpp.

{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( { SCH_SYMBOL_T } );
 
 if( selection.Empty() )
 return 0;
 
 SCH_SYMBOL* symbol = (SCH_SYMBOL*) selection.Front();
 
 if( aEvent.IsAction( &EE_ACTIONS::showDeMorganStandard )
 && symbol->GetConvert() == LIB_ITEM::LIB_CONVERT::BASE )
 {
 return 0;
 }
 
 if( aEvent.IsAction( &EE_ACTIONS::showDeMorganAlternate )
 && symbol->GetConvert() != LIB_ITEM::LIB_CONVERT::DEMORGAN )
 {
 return 0;
 }
 
 if( !symbol->IsNew() )
 saveCopyInUndoList( symbol, UNDO_REDO::CHANGED );
 
 m_frame->ConvertPart( symbol );
 
 if( symbol->IsNew() )
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 
 return 0;
}

References CHANGED, EE_ACTIONS::clearSelection, SCH_EDIT_FRAME::ConvertPart(), SELECTION::Empty(), SELECTION::Front(), SCH_SYMBOL::GetConvert(), TOOL_EVENT::IsAction(), SELECTION::IsHover(), EDA_ITEM::IsNew(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, ACTIONS::refreshPreview, EE_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EE_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList(), SCH_SYMBOL_T, EE_ACTIONS::showDeMorganAlternate, and EE_ACTIONS::showDeMorganStandard.

Referenced by setTransitions().

DdAppendFile()

int SCH_EDIT_TOOL::DdAppendFile

(

const TOOL_EVENT &

aEvent

)

Drag and drop.

Definition at line 2366 of file sch_edit_tool.cpp.

{
 wxString aFileName = *aEvent.Parameter<wxString*>();
 return ( m_frame->AddSheetAndUpdateDisplay( aFileName ) ? 0 : 1 );
}

References SCH_EDIT_FRAME::AddSheetAndUpdateDisplay(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and TOOL_EVENT::Parameter().

Referenced by setTransitions().

DeleteItemCursor()

int SCH_EDIT_TOOL::DeleteItemCursor

(

const TOOL_EVENT &

aEvent

)

Definition at line 1294 of file sch_edit_tool.cpp.

{
 PICKER_TOOL* picker = m_toolMgr->GetTool<PICKER_TOOL>();
 
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 m_pickerItem = nullptr;
 
 // Deactivate other tools; particularly important if another PICKER is currently running
 Activate();
 
 picker->SetCursor( KICURSOR::REMOVE );
 picker->SetSnapping( false );
 
 picker->SetClickHandler(
 [this]( const VECTOR2D& aPosition ) -> bool
 {
 if( m_pickerItem )
 {
 EE_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<EE_SELECTION_TOOL>();
 selectionTool->UnbrightenItem( m_pickerItem );
 selectionTool->AddItemToSel( m_pickerItem, true /*quiet mode*/ );
 m_toolMgr->RunAction( ACTIONS::doDelete, true );
 m_pickerItem = nullptr;
 }
 
 return true;
 } );
 
 picker->SetMotionHandler(
 [this]( const VECTOR2D& aPos )
 {
 EE_COLLECTOR collector;
 collector.m_Threshold = KiROUND( getView()->ToWorld( HITTEST_THRESHOLD_PIXELS ) );
 collector.Collect( m_frame->GetScreen(), deletableItems, aPos );
 
 EE_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<EE_SELECTION_TOOL>();
 selectionTool->GuessSelectionCandidates( collector, aPos );
 
 EDA_ITEM* item = collector.GetCount() == 1 ? collector[ 0 ] : nullptr;
 
 if( m_pickerItem != item )
 {
 if( m_pickerItem )
 selectionTool->UnbrightenItem( m_pickerItem );
 
 m_pickerItem = item;
 
 if( m_pickerItem )
 selectionTool->BrightenItem( m_pickerItem );
 }
 } );
 
 picker->SetFinalizeHandler(
 [this]( const int& aFinalState )
 {
 if( m_pickerItem )
 m_toolMgr->GetTool<EE_SELECTION_TOOL>()->UnbrightenItem( m_pickerItem );
 
 // Wake the selection tool after exiting to ensure the cursor gets updated
 m_toolMgr->RunAction( EE_ACTIONS::selectionActivate, false );
 } );
 
 m_toolMgr->RunAction( ACTIONS::pickerTool, true );
 
 return 0;
}

References TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::AddItemToSel(), SELECTION_TOOL::BrightenItem(), EE_ACTIONS::clearSelection, EE_COLLECTOR::Collect(), deletableItems, ACTIONS::doDelete, COLLECTOR::GetCount(), SCH_EDIT_FRAME::GetScreen(), TOOL_MANAGER::GetTool(), TOOL_BASE::getView(), EE_SELECTION_TOOL::GuessSelectionCandidates(), HITTEST_THRESHOLD_PIXELS, KiROUND(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, m_pickerItem, COLLECTOR::m_Threshold, TOOL_BASE::m_toolMgr, ACTIONS::pickerTool, REMOVE, TOOL_MANAGER::RunAction(), EE_ACTIONS::selectionActivate, PICKER_TOOL_BASE::SetClickHandler(), PICKER_TOOL_BASE::SetCursor(), PICKER_TOOL_BASE::SetFinalizeHandler(), PICKER_TOOL_BASE::SetMotionHandler(), PICKER_TOOL_BASE::SetSnapping(), and SELECTION_TOOL::UnbrightenItem().

Referenced by setTransitions().

DoDelete()

int SCH_EDIT_TOOL::DoDelete

(

const TOOL_EVENT &

aEvent

)

Run the deletion tool.

Definition at line 1198 of file sch_edit_tool.cpp.

{
 SCH_SCREEN* screen = m_frame->GetScreen();
 auto items = m_selectionTool->RequestSelection( deletableItems ).GetItems();
 bool appendToUndo = false;
 std::vector<VECTOR2I> pts;
 
 if( items.empty() )
 return 0;
 
 // Don't leave a freed pointer in the selection
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 
 for( EDA_ITEM* item : items )
 item->ClearFlags( STRUCT_DELETED );
 
 for( EDA_ITEM* item : items )
 {
 SCH_ITEM* sch_item = dynamic_cast<SCH_ITEM*>( item );
 
 if( !sch_item )
 continue;
 
 if( sch_item->IsConnectable() )
 {
 std::vector<VECTOR2I> tmp_pts = sch_item->GetConnectionPoints();
 pts.insert( pts.end(), tmp_pts.begin(), tmp_pts.end() );
 }
 
 if( sch_item->Type() == SCH_JUNCTION_T )
 {
 sch_item->SetFlags( STRUCT_DELETED );
 // clean up junctions at the end
 }
 else if( sch_item->Type() == SCH_SHEET_PIN_T )
 {
 SCH_SHEET_PIN* pin = (SCH_SHEET_PIN*) sch_item;
 SCH_SHEET* sheet = pin->GetParent();
 
 if( !alg::contains( items, sheet ) )
 {
 pin->SetFlags( STRUCT_DELETED );
 saveCopyInUndoList( item, UNDO_REDO::DELETED, appendToUndo );
 appendToUndo = true;
 
 updateItem( pin, false );
 
 sheet->RemovePin( pin );
 }
 }
 else if( sch_item->Type() == SCH_FIELD_T )
 {
 saveCopyInUndoList( item, UNDO_REDO::CHANGED, appendToUndo );
 static_cast<SCH_FIELD*>( sch_item )->SetVisible( false );
 appendToUndo = true;
 
 updateItem( sch_item, false );
 }
 else
 {
 sch_item->SetFlags( STRUCT_DELETED );
 saveCopyInUndoList( item, UNDO_REDO::DELETED, appendToUndo );
 appendToUndo = true;
 
 updateItem( sch_item, false );
 
 m_frame->RemoveFromScreen( sch_item, m_frame->GetScreen() );
 
 if( sch_item->Type() == SCH_SHEET_T )
 m_frame->UpdateHierarchyNavigator();
 }
 }
 
 for( const VECTOR2I& point : pts )
 {
 SCH_ITEM* junction = screen->GetItem( point, 0, SCH_JUNCTION_T );
 
 if( !junction )
 continue;
 
 if( junction->HasFlag( STRUCT_DELETED ) || !screen->IsExplicitJunction( point ) )
 m_frame->DeleteJunction( junction, appendToUndo );
 }
 
 m_frame->TestDanglingEnds();
 
 m_frame->GetCanvas()->Refresh();
 m_frame->OnModify();
 
 return 0;
}

References CHANGED, EE_ACTIONS::clearSelection, alg::contains(), deletableItems, DELETED, SCH_EDIT_FRAME::DeleteJunction(), SCH_BASE_FRAME::GetCanvas(), SCH_ITEM::GetConnectionPoints(), SCH_SCREEN::GetItem(), SELECTION::GetItems(), SCH_EDIT_FRAME::GetScreen(), EDA_ITEM::HasFlag(), SCH_ITEM::IsConnectable(), SCH_SCREEN::IsExplicitJunction(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, SCH_EDIT_FRAME::OnModify(), pin, EDA_DRAW_PANEL_GAL::Refresh(), SCH_BASE_FRAME::RemoveFromScreen(), SCH_SHEET::RemovePin(), EE_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EE_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList(), SCH_FIELD_T, SCH_JUNCTION_T, SCH_SHEET_PIN_T, SCH_SHEET_T, EDA_ITEM::SetFlags(), STRUCT_DELETED, SCH_EDIT_FRAME::TestDanglingEnds(), EDA_ITEM::Type(), SCH_EDIT_FRAME::UpdateHierarchyNavigator(), and EE_TOOL_BASE< SCH_EDIT_FRAME >::updateItem().

Referenced by setTransitions().

EditField()

int SCH_EDIT_TOOL::EditField

(

const TOOL_EVENT &

aEvent

)

Definition at line 1407 of file sch_edit_tool.cpp.

{
 EE_SELECTION sel;
 
 if( aEvent.IsAction( &EE_ACTIONS::editReference ) )
 sel = m_selectionTool->RequestSelection( { SCH_FIELD_LOCATE_REFERENCE_T, SCH_SYMBOL_T } );
 else if( aEvent.IsAction( &EE_ACTIONS::editValue ) )
 sel = m_selectionTool->RequestSelection( { SCH_FIELD_LOCATE_VALUE_T, SCH_SYMBOL_T } );
 else if( aEvent.IsAction( &EE_ACTIONS::editFootprint ) )
 sel = m_selectionTool->RequestSelection( { SCH_FIELD_LOCATE_FOOTPRINT_T, SCH_SYMBOL_T } );
 
 if( sel.Size() != 1 )
 return 0;
 
 bool clearSelection = sel.IsHover();
 EDA_ITEM* item = sel.Front();
 
 if( item->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
 
 if( aEvent.IsAction( &EE_ACTIONS::editReference ) )
 editFieldText( symbol->GetField( REFERENCE_FIELD ) );
 else if( aEvent.IsAction( &EE_ACTIONS::editValue ) )
 editFieldText( symbol->GetField( VALUE_FIELD ) );
 else if( aEvent.IsAction( &EE_ACTIONS::editFootprint ) )
 editFieldText( symbol->GetField( FOOTPRINT_FIELD ) );
 }
 else if( item->Type() == SCH_FIELD_T )
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( item );
 
 editFieldText( field );
 
 if( !field->IsVisible() )
 clearSelection = true;
 }
 
 if( clearSelection )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 
 return 0;
}

References EE_ACTIONS::clearSelection, editFieldText(), EE_ACTIONS::editFootprint, EE_ACTIONS::editReference, EE_ACTIONS::editValue, FOOTPRINT_FIELD, SELECTION::Front(), SCH_SYMBOL::GetField(), TOOL_EVENT::IsAction(), SELECTION::IsHover(), EDA_TEXT::IsVisible(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, REFERENCE_FIELD, EE_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_FIELD_LOCATE_FOOTPRINT_T, SCH_FIELD_LOCATE_REFERENCE_T, SCH_FIELD_LOCATE_VALUE_T, SCH_FIELD_T, SCH_SYMBOL_T, SELECTION::Size(), EDA_ITEM::Type(), and VALUE_FIELD.

Referenced by setTransitions().

editFieldText()

void SCH_EDIT_TOOL::editFieldText ( SCH_FIELD *  aField )

private

Set up handlers for various events.

Definition at line 1362 of file sch_edit_tool.cpp.

{
 KICAD_T parentType = aField->GetParent() ? aField->GetParent()->Type() : SCHEMATIC_T;
 
 // Save old symbol in undo list if not already in edit, or moving.
 if( aField->GetEditFlags() == 0 ) // i.e. not edited, or moved
 saveCopyInUndoList( aField, UNDO_REDO::CHANGED );
 
 if( parentType == SCH_SYMBOL_T && aField->GetId() == REFERENCE_FIELD )
 static_cast<SCH_ITEM*>( aField->GetParent() )->SetConnectivityDirty();
 
 wxString caption;
 
 // Use title caps for mandatory fields. "Edit Sheet name Field" looks dorky.
 if( parentType == SCH_SYMBOL_T && aField->GetId() < MANDATORY_FIELDS )
 {
 wxString translated_fieldname;
 translated_fieldname = TEMPLATE_FIELDNAME::GetDefaultFieldName( aField->GetId(),
 DO_TRANSLATE );
 caption.Printf( _( "Edit %s Field" ), TitleCaps( translated_fieldname ) );
 }
 else if( parentType == SCH_SHEET_T && aField->GetId() < SHEET_MANDATORY_FIELDS )
 caption.Printf( _( "Edit %s Field" ), TitleCaps( aField->GetName() ) );
 else
 caption.Printf( _( "Edit '%s' Field" ), aField->GetName() );
 
 DIALOG_SCH_FIELD_PROPERTIES dlg( m_frame, caption, aField );
 
 // The footprint field dialog can invoke a KIWAY_PLAYER so we must use a quasi-modal
 if( dlg.ShowQuasiModal() != wxID_OK )
 return;
 
 dlg.UpdateField( aField, &m_frame->GetCurrentSheet() );
 
 if( m_frame->eeconfig()->m_AutoplaceFields.enable || parentType == SCH_SHEET_T )
 static_cast<SCH_ITEM*>( aField->GetParent() )->AutoAutoplaceFields( m_frame->GetScreen() );
 
 m_frame->UpdateItem( aField, false, true );
 m_frame->OnModify();
 
 // This must go after OnModify() so that the connectivity graph will have been updated.
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
}

References _, CHANGED, DO_TRANSLATE, SCH_BASE_FRAME::eeconfig(), EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::enable, SCH_EDIT_FRAME::GetCurrentSheet(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), EDA_ITEM::GetEditFlags(), SCH_FIELD::GetId(), SCH_FIELD::GetName(), EDA_ITEM::GetParent(), SCH_EDIT_FRAME::GetScreen(), EESCHEMA_SETTINGS::m_AutoplaceFields, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, MANDATORY_FIELDS, SCH_EDIT_FRAME::OnModify(), TOOL_MANAGER::PostEvent(), REFERENCE_FIELD, EE_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList(), SCH_SHEET_T, SCH_SYMBOL_T, SCHEMATIC_T, EVENTS::SelectedItemsModified, SHEET_MANDATORY_FIELDS, DIALOG_SHIM::ShowQuasiModal(), TitleCaps(), EDA_ITEM::Type(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and SCH_EDIT_FRAME::UpdateItem().

Referenced by EditField(), and Properties().

EditPageNumber()

int SCH_EDIT_TOOL::EditPageNumber

(

const TOOL_EVENT &

aEvent

)

Definition at line 2297 of file sch_edit_tool.cpp.

{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( { SCH_SHEET_T } );
 
 if( selection.GetSize() > 1 )
 return 0;
 
 SCH_SHEET* sheet = (SCH_SHEET*) selection.Front();
 
 SCH_SHEET_PATH instance = m_frame->GetCurrentSheet();
 
 SCH_SCREEN* screen;
 
 if( sheet )
 {
 // When changing the page number of a selected sheet, the current screen owns the sheet.
 screen = m_frame->GetScreen();
 
 instance.push_back( sheet );
 }
 else
 {
 SCH_SHEET_PATH prevInstance = instance;
 
 // When change the page number in the screen, the previous screen owns the sheet.
 if( prevInstance.size() )
 {
 prevInstance.pop_back();
 screen = prevInstance.LastScreen();
 }
 else
 {
 // The root sheet and root screen are effectively the same thing.
 screen = m_frame->GetScreen();
 }
 
 sheet = m_frame->GetCurrentSheet().Last();
 }
 
 wxString msg;
 wxString sheetPath = instance.PathHumanReadable( false );
 wxString pageNumber = instance.GetPageNumber();
 
 msg.Printf( _( "Enter page number for sheet path%s" ),
 ( sheetPath.Length() > 20 ) ? "\n" + sheetPath : " " + sheetPath );
 
 wxTextEntryDialog dlg( m_frame, msg, _( "Edit Sheet Page Number" ), pageNumber );
 
 dlg.SetTextValidator( wxFILTER_ALPHANUMERIC ); // No white space.
 
 if( dlg.ShowModal() == wxID_CANCEL || dlg.GetValue() == instance.GetPageNumber() )
 return 0;
 
 m_frame->SaveCopyInUndoList( screen, sheet, UNDO_REDO::CHANGED, false );
 
 instance.SetPageNumber( dlg.GetValue() );
 
 if( instance == m_frame->GetCurrentSheet() )
 {
 m_frame->GetScreen()->SetPageNumber( dlg.GetValue() );
 m_frame->OnPageSettingsChange();
 }
 
 m_frame->OnModify();
 
 return 0;
}

References _, CHANGED, SELECTION::Front(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SHEET_PATH::GetPageNumber(), SCH_EDIT_FRAME::GetScreen(), SELECTION::GetSize(), SCH_SHEET_PATH::Last(), SCH_SHEET_PATH::LastScreen(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, SCH_EDIT_FRAME::OnModify(), SCH_EDIT_FRAME::OnPageSettingsChange(), SCH_SHEET_PATH::PathHumanReadable(), SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH::push_back(), EE_SELECTION_TOOL::RequestSelection(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_SHEET_T, SCH_SHEET_PATH::SetPageNumber(), BASE_SCREEN::SetPageNumber(), and SCH_SHEET_PATH::size().

Referenced by setTransitions().

getEditFrame()

template<typename T >

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 185 of file tool_base.h.

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

References TOOL_BASE::getToolHolderInt().

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

GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Return the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns

Identifier of the tool.

Definition at line 121 of file tool_base.h.

 {
 return m_toolId;
 }

References TOOL_BASE::m_toolId.

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

GetManager()

TOOL_MANAGER * TOOL_BASE::GetManager ( ) const

inlineinherited

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

Returns

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

Definition at line 144 of file tool_base.h.

 {
 return m_toolMgr;
 }

References TOOL_BASE::m_toolMgr.

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

getModel()

template<typename T >

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Store the type of the tool.

Definition at line 197 of file tool_base.h.

References TOOL_BASE::getModelInt().

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

getModelInt()

EDA_ITEM * TOOL_BASE::getModelInt ( ) const

privateinherited

Definition at line 54 of file tool_base.cpp.

{
 return m_toolMgr->GetModel();
}

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

Referenced by TOOL_BASE::getModel().

GetName()

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

inlineinherited

Return the name of the tool.

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

Returns

The name of the tool.

Definition at line 134 of file tool_base.h.

 {
 return m_toolName;
 }

References TOOL_BASE::m_toolName.

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

getToolHolderInt()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInt ( ) const

privateinherited

Definition at line 48 of file tool_base.cpp.

{
 return m_toolMgr->GetToolHolder();
}

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

Referenced by TOOL_BASE::getEditFrame().

GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inlineinherited

Definition at line 77 of file tool_interactive.h.

{ return m_menu; }

References TOOL_INTERACTIVE::m_menu.

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

GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns

The type of the tool.

Definition at line 109 of file tool_base.h.

 {
 return m_type;
 }

References TOOL_BASE::m_type.

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

getView()

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

protectedinherited

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

It allows tools to draw.

Returns

The instance of VIEW.

Definition at line 36 of file tool_base.cpp.

{
 return m_toolMgr->GetView();
}

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

Referenced by EE_POINT_EDITOR::addCornerCondition(), ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), COMMON_TOOLS::CenterContents(), ChangeTextType(), EE_INSPECTION_TOOL::CheckSymbol(), GERBVIEW_CONTROL::ClearAllLayers(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::CollectHits(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), COMMON_TOOLS::CursorControl(), DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::DeleteItems(), PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), EE_SELECTION_TOOL::GetNode(), ROUTER_TOOL::getStartLayer(), PCB_CONTROL::GridResetOrigin(), PCB_CONTROL::GridSetOrigin(), EE_SELECTION_TOOL::GuessSelectionCandidates(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), ROUTER_TOOL::handleCommonEvents(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), PCB_SELECTION_TOOL::hitTestDistance(), Init(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineDrag(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), Mirror(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), Properties(), EDIT_TOOL::Properties(), EE_SELECTION_TOOL::Reset(), EE_TOOL_BASE< T >::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PNS::TOOL_BASE::Reset(), BOARD_EDITOR_CONTROL::Reset(), DRAWING_TOOL::Reset(), PCB_CONTROL::Reset(), PCB_SELECTION_TOOL::Reset(), Rotate(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), EE_SELECTION_TOOL::selectPoint(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCExclusions(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), SCH_EDITOR_CONTROL::ToggleOPCurrents(), SCH_EDITOR_CONTROL::ToggleOPVoltages(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), GERBVIEW_SELECTION_TOOL::unselectVisually(), EE_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), SCH_FIND_REPLACE_TOOL::UpdateFind(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< T >::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), PCB_SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_SELECTION_TOOL::view(), PCB_TOOL_BASE::view(), PCB_VIEWER_TOOLS::view(), EE_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::zoomFitSelection(), EE_SELECTION_TOOL::~EE_SELECTION_TOOL(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), and PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL().

getViewControls()

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

protectedinherited

Return the instance of VIEW_CONTROLS object used in the application.

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

Returns

The instance of VIEW_CONTROLS.

Definition at line 42 of file tool_base.cpp.

{
 return m_toolMgr->GetViewControls();
}

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

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

GlobalEdit()

int SCH_EDIT_TOOL::GlobalEdit

(

const TOOL_EVENT &

aEvent

)

Delete the selected items, or the item under the cursor.

Definition at line 586 of file eeschema/dialogs/dialog_global_edit_text_and_graphics.cpp.

{
 DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS dlg( m_frame );
 dlg.ShowModal();
 return 0;
}

References EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame.

Referenced by setTransitions().

Go()

template<class T >

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

inherited

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

No conditions means any event.

Definition at line 147 of file tool_interactive.h.

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

References TOOL_INTERACTIVE::goInternal().

Referenced by EDA_3D_CONTROLLER::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), EE_INSPECTION_TOOL::setTransitions(), EE_POINT_EDITOR::setTransitions(), EE_SELECTION_TOOL::setTransitions(), SCH_DRAWING_TOOLS::setTransitions(), setTransitions(), SCH_EDITOR_CONTROL::setTransitions(), SCH_FIND_REPLACE_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::setTransitions(), SCH_MOVE_TOOL::setTransitions(), SCH_NAVIGATE_TOOL::setTransitions(), SIMULATOR_CONTROL::setTransitions(), SYMBOL_EDITOR_CONTROL::setTransitions(), SYMBOL_EDITOR_DRAWING_TOOLS::setTransitions(), SYMBOL_EDITOR_EDIT_TOOL::setTransitions(), SYMBOL_EDITOR_MOVE_TOOL::setTransitions(), SYMBOL_EDITOR_PIN_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), COMMON_CONTROL::setTransitions(), COMMON_TOOLS::setTransitions(), PICKER_TOOL::setTransitions(), ZOOM_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), PL_EDIT_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), PL_POINT_EDITOR::setTransitions(), PL_SELECTION_TOOL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), MICROWAVE_TOOL::setTransitions(), SCRIPTING_TOOL::setTransitions(), LENGTH_TUNER_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), CONVERT_TOOL::setTransitions(), DRAWING_TOOL::setTransitions(), DRC_TOOL::setTransitions(), EDIT_TOOL::setTransitions(), FOOTPRINT_EDITOR_CONTROL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), GROUP_TOOL::setTransitions(), PAD_TOOL::setTransitions(), PCB_CONTROL::setTransitions(), PCB_PICKER_TOOL::setTransitions(), PCB_POINT_EDITOR::setTransitions(), PCB_SELECTION_TOOL::setTransitions(), PCB_VIEWER_TOOLS::setTransitions(), ALIGN_DISTRIBUTE_TOOL::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), PROPERTIES_TOOL::setTransitions(), and ZONE_FILLER_TOOL::setTransitions().

goInternal()

void TOOL_INTERACTIVE::goInternal ( TOOL_STATE_FUNC &  aState, const TOOL_EVENT_LIST &  aConditions  )

privateinherited

Definition at line 70 of file tool_interactive.cpp.

{
 m_toolMgr->ScheduleNextState( this, aState, aConditions );
}

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

Referenced by TOOL_INTERACTIVE::Go().

Init()

bool SCH_EDIT_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 140 of file sch_edit_tool.cpp.

{
 EE_TOOL_BASE::Init();
 
 SCH_DRAWING_TOOLS* drawingTools = m_toolMgr->GetTool<SCH_DRAWING_TOOLS>();
 SCH_MOVE_TOOL* moveTool = m_toolMgr->GetTool<SCH_MOVE_TOOL>();
 
 wxASSERT_MSG( drawingTools, "eeshema.InteractiveDrawing tool is not available" );
 
 auto hasElements =
 [this]( const SELECTION& aSel )
 {
 return !m_frame->GetScreen()->Items().empty();
 };
 
 auto sheetHasUndefinedPins =
 []( const SELECTION& aSel )
 {
 if( aSel.Size() == 1 && aSel.Front()->Type() == SCH_SHEET_T )
 return static_cast<SCH_SHEET*>( aSel.Front() )->HasUndefinedPins();
 
 return false;
 };
 
 auto sheetSelection = E_C::Count( 1 ) && E_C::OnlyTypes( { SCH_SHEET_T } );
 
 auto haveHighlight =
 [&]( const SELECTION& sel )
 {
 SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
 
 return editFrame && editFrame->GetHighlightedConnection() != nullptr;
 };
 
 auto anyTextTool =
 [this]( const SELECTION& aSel )
 {
 return ( m_frame->IsCurrentTool( EE_ACTIONS::placeLabel )
 || m_frame->IsCurrentTool( EE_ACTIONS::placeClassLabel )
 || m_frame->IsCurrentTool( EE_ACTIONS::placeGlobalLabel )
 || m_frame->IsCurrentTool( EE_ACTIONS::placeHierLabel )
 || m_frame->IsCurrentTool( EE_ACTIONS::placeSchematicText ) );
 };
 
 auto duplicateCondition =
 []( const SELECTION& aSel )
 {
 if( SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus( aSel ) )
 return false;
 
 return true;
 };
 
 auto orientCondition =
 []( const SELECTION& aSel )
 {
 if( SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus( aSel ) )
 return false;
 
 return SELECTION_CONDITIONS::HasTypes( SCH_EDIT_TOOL::RotatableItems )( aSel );
 };
 
 auto propertiesCondition =
 [&]( const SELECTION& aSel )
 {
 if( aSel.GetSize() == 0 )
 {
 if( getView()->IsLayerVisible( LAYER_SCHEMATIC_DRAWINGSHEET ) )
 {
 DS_PROXY_VIEW_ITEM* ds = m_frame->GetCanvas()->GetView()->GetDrawingSheet();
 VECTOR2D cursor = getViewControls()->GetCursorPosition( false );
 
 if( ds && ds->HitTestDrawingSheetItems( getView(), cursor ) )
 return true;
 }
 
 return false;
 }
 
 SCH_ITEM* firstItem = dynamic_cast<SCH_ITEM*>( aSel.Front() );
 const EE_SELECTION* eeSelection = dynamic_cast<const EE_SELECTION*>( &aSel );
 
 if( !firstItem || !eeSelection )
 return false;
 
 switch( firstItem->Type() )
 {
 case SCH_SYMBOL_T:
 case SCH_SHEET_T:
 case SCH_SHEET_PIN_T:
 case SCH_TEXT_T:
 case SCH_TEXTBOX_T:
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_DIRECTIVE_LABEL_T:
 case SCH_FIELD_T:
 case SCH_SHAPE_T:
 case SCH_BITMAP_T:
 return aSel.GetSize() == 1;
 
 case SCH_LINE_T:
 case SCH_BUS_WIRE_ENTRY_T:
 case SCH_JUNCTION_T:
 if( std::all_of( aSel.Items().begin(), aSel.Items().end(),
 [&]( const EDA_ITEM* item )
 {
 return item->Type() == SCH_LINE_T
 && static_cast<const SCH_LINE*>( item )->IsGraphicLine();
 } ) )
 {
 return true;
 }
 else if( std::all_of( aSel.Items().begin(), aSel.Items().end(),
 [&]( const EDA_ITEM* item )
 {
 return item->Type() == SCH_JUNCTION_T;
 } ) )
 {
 return true;
 }
 else if( std::all_of( aSel.Items().begin(), aSel.Items().end(),
 [&]( const EDA_ITEM* item )
 {
 const SCH_ITEM* schItem = dynamic_cast<const SCH_ITEM*>( item );
 
 wxCHECK( schItem, false );
 
 return ( schItem->HasLineStroke() && schItem->IsConnectable() )
 || item->Type() == SCH_JUNCTION_T;
 } ) )
 {
 return true;
 }
 
 return false;
 
 default:
 return false;
 }
 };
 
 auto autoplaceCondition =
 []( const SELECTION& aSel )
 {
 for( const EDA_ITEM* item : aSel )
 {
 if( item->IsType( EE_COLLECTOR::FieldOwners ) )
 return true;
 }
 
 return false;
 };
 
 // allTextTypes does not include SCH_SHEET_PIN_T because one cannot convert other
 // types to/from this type, living only in a SHEET
 static std::vector<KICAD_T> allTextTypes = { SCH_LABEL_T,
 SCH_DIRECTIVE_LABEL_T,
 SCH_GLOBAL_LABEL_T,
 SCH_HIER_LABEL_T,
 SCH_TEXT_T,
 SCH_TEXTBOX_T };
 
 auto toChangeCondition = ( E_C::OnlyTypes( allTextTypes ) );
 
 auto toLabelCondition = ( E_C::Count( 1 ) && E_C::OnlyTypes( { SCH_DIRECTIVE_LABEL_T,
 SCH_GLOBAL_LABEL_T,
  SCH_HIER_LABEL_T,
 SCH_TEXT_T,
 SCH_TEXTBOX_T } ) )
 || ( E_C::MoreThan( 1 ) && E_C::OnlyTypes( allTextTypes ) );
 
 auto toCLabelCondition = ( E_C::Count( 1 ) && E_C::OnlyTypes( { SCH_LABEL_T,
 SCH_HIER_LABEL_T,
 SCH_GLOBAL_LABEL_T,
 SCH_TEXT_T,
 SCH_TEXTBOX_T } ) )
 || ( E_C::MoreThan( 1 ) && E_C::OnlyTypes( allTextTypes ) );
 
 auto toHLabelCondition = ( E_C::Count( 1 ) && E_C::OnlyTypes( { SCH_LABEL_T,
 SCH_DIRECTIVE_LABEL_T,
 SCH_GLOBAL_LABEL_T,
 SCH_TEXT_T,
 SCH_TEXTBOX_T } ) )
 || ( E_C::MoreThan( 1 ) && E_C::OnlyTypes( allTextTypes ) );
 
 auto toGLabelCondition = ( E_C::Count( 1 ) && E_C::OnlyTypes( { SCH_LABEL_T,
 SCH_DIRECTIVE_LABEL_T,
 SCH_HIER_LABEL_T,
 SCH_TEXT_T,
 SCH_TEXTBOX_T } ) )
 || ( E_C::MoreThan( 1 ) && E_C::OnlyTypes( allTextTypes ) );
 
 auto toTextCondition = ( E_C::Count( 1 ) && E_C::OnlyTypes( { SCH_LABEL_T,
 SCH_DIRECTIVE_LABEL_T,
 SCH_GLOBAL_LABEL_T,
 SCH_HIER_LABEL_T,
 SCH_TEXTBOX_T } ) )
 || ( E_C::MoreThan( 1 ) && E_C::OnlyTypes( allTextTypes ) );
 
 auto toTextBoxCondition = ( E_C::Count( 1 ) && E_C::OnlyTypes( { SCH_LABEL_T,
 SCH_DIRECTIVE_LABEL_T,
 SCH_GLOBAL_LABEL_T,
 SCH_HIER_LABEL_T,
 SCH_TEXT_T } ) )
 || ( E_C::MoreThan( 1 ) && E_C::OnlyTypes( allTextTypes ) );
 
 auto entryCondition = E_C::MoreThan( 0 ) && E_C::OnlyTypes( { SCH_BUS_WIRE_ENTRY_T,
 SCH_BUS_BUS_ENTRY_T} );
 
 auto singleSheetCondition = E_C::Count( 1 ) && E_C::OnlyTypes( { SCH_SHEET_T } );
 
 //
 // Add edit actions to the move tool menu
 //
 if( moveTool )
 {
 CONDITIONAL_MENU& moveMenu = moveTool->GetToolMenu().GetMenu();
 
 moveMenu.AddSeparator();
 moveMenu.AddItem( EE_ACTIONS::rotateCCW, orientCondition );
 moveMenu.AddItem( EE_ACTIONS::rotateCW, orientCondition );
 moveMenu.AddItem( EE_ACTIONS::mirrorV, orientCondition );
 moveMenu.AddItem( EE_ACTIONS::mirrorH, orientCondition );
 moveMenu.AddItem( EE_ACTIONS::swap, SELECTION_CONDITIONS::MoreThan( 1 ) );
 
 moveMenu.AddItem( EE_ACTIONS::properties, propertiesCondition );
 
 CONDITIONAL_MENU* editMoveItemSubMenu = new CONDITIONAL_MENU(moveTool);
 editMoveItemSubMenu->SetTitle( _( "Edit Main Fields" ) );
 editMoveItemSubMenu->SetIcon( BITMAPS::right );
 moveMenu.AddMenu( editMoveItemSubMenu, E_C::SingleSymbol );
 
 editMoveItemSubMenu->AddItem( EE_ACTIONS::editReference, E_C::SingleSymbol );
 editMoveItemSubMenu->AddItem( EE_ACTIONS::editValue, E_C::SingleSymbol );
 editMoveItemSubMenu->AddItem( EE_ACTIONS::editFootprint, E_C::SingleSymbol );
 
 moveMenu.AddItem( EE_ACTIONS::toggleDeMorgan, E_C::SingleDeMorganSymbol );
 
 std::shared_ptr<SYMBOL_UNIT_MENU> symUnitMenu = std::make_shared<SYMBOL_UNIT_MENU>();
 symUnitMenu->SetTool( this );
 m_menu.RegisterSubMenu( symUnitMenu );
 moveMenu.AddMenu( symUnitMenu.get(), E_C::SingleMultiUnitSymbol, 1 );
 
 moveMenu.AddSeparator();
 moveMenu.AddItem( ACTIONS::cut,  E_C::IdleSelection );
 moveMenu.AddItem( ACTIONS::copy, E_C::IdleSelection );
 moveMenu.AddItem( ACTIONS::doDelete, E_C::NotEmpty );
 moveMenu.AddItem( ACTIONS::duplicate, duplicateCondition );
 }
 
 //
 // Add editing actions to the drawing tool menu
 //
 CONDITIONAL_MENU& drawMenu = drawingTools->GetToolMenu().GetMenu();
 
 drawMenu.AddItem( EE_ACTIONS::clearHighlight, haveHighlight && EE_CONDITIONS::Idle, 1 );
 drawMenu.AddSeparator( haveHighlight && EE_CONDITIONS::Idle, 1 );
 
 drawMenu.AddItem( EE_ACTIONS::enterSheet, sheetSelection && EE_CONDITIONS::Idle, 1 );
 drawMenu.AddSeparator( sheetSelection && EE_CONDITIONS::Idle, 1 );
 
 drawMenu.AddItem( EE_ACTIONS::rotateCCW, orientCondition, 200 );
 drawMenu.AddItem( EE_ACTIONS::rotateCW, orientCondition, 200 );
 drawMenu.AddItem( EE_ACTIONS::mirrorV, orientCondition, 200 );
 drawMenu.AddItem( EE_ACTIONS::mirrorH, orientCondition, 200 );
 
 drawMenu.AddItem( EE_ACTIONS::properties, propertiesCondition, 200 );
 
 CONDITIONAL_MENU* editDrawItemSubMenu = new CONDITIONAL_MENU( drawingTools );
 editDrawItemSubMenu->SetTitle( _( "Edit Main Fields" ) );
 editDrawItemSubMenu->SetIcon( BITMAPS::right );
 drawMenu.AddMenu( editDrawItemSubMenu, E_C::SingleSymbol, 200 );
 
 editDrawItemSubMenu->AddItem( EE_ACTIONS::editReference, E_C::SingleSymbol, 200 );
 editDrawItemSubMenu->AddItem( EE_ACTIONS::editValue, E_C::SingleSymbol, 200 );
 editDrawItemSubMenu->AddItem( EE_ACTIONS::editFootprint, E_C::SingleSymbol, 200 );
 
 drawMenu.AddItem( EE_ACTIONS::toggleDeMorgan, E_C::SingleDeMorganSymbol, 200 );
 
 drawMenu.AddItem( EE_ACTIONS::autoplaceFields, autoplaceCondition, 200 );
 
 std::shared_ptr<SYMBOL_UNIT_MENU> symUnitMenu2 = std::make_shared<SYMBOL_UNIT_MENU>();
 symUnitMenu2->SetTool( drawingTools );
 drawingTools->GetToolMenu().RegisterSubMenu( symUnitMenu2 );
 drawMenu.AddMenu( symUnitMenu2.get(), E_C::SingleMultiUnitSymbol, 1 );
 
 drawMenu.AddItem( EE_ACTIONS::editWithLibEdit, E_C::SingleSymbolOrPower && E_C::Idle, 200 );
 
 drawMenu.AddItem( EE_ACTIONS::toLabel, anyTextTool && E_C::Idle, 200 );
 drawMenu.AddItem( EE_ACTIONS::toHLabel, anyTextTool && E_C::Idle, 200 );
 drawMenu.AddItem( EE_ACTIONS::toGLabel, anyTextTool && E_C::Idle, 200 );
 drawMenu.AddItem( EE_ACTIONS::toText, anyTextTool && E_C::Idle, 200 );
 drawMenu.AddItem( EE_ACTIONS::toTextBox, anyTextTool && E_C::Idle, 200 );
 
 //
 // Add editing actions to the selection tool menu
 //
 CONDITIONAL_MENU& selToolMenu = m_selectionTool->GetToolMenu().GetMenu();
 
 selToolMenu.AddItem( EE_ACTIONS::rotateCCW, orientCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::rotateCW, orientCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::mirrorV, orientCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::mirrorH, orientCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::swap, SELECTION_CONDITIONS::MoreThan( 1 ) );
 
 selToolMenu.AddItem( EE_ACTIONS::properties, propertiesCondition, 200 );
 
 CONDITIONAL_MENU* editSelItemSubMenu = new CONDITIONAL_MENU( moveTool );
 editSelItemSubMenu->SetTitle( _( "Edit Main Fields" ) );
 editSelItemSubMenu->SetIcon( BITMAPS::right );
 selToolMenu.AddMenu( editSelItemSubMenu, E_C::SingleSymbol, 200 );
 
 editSelItemSubMenu->AddItem( EE_ACTIONS::editReference, E_C::SingleSymbol, 200 );
 editSelItemSubMenu->AddItem( EE_ACTIONS::editValue, E_C::SingleSymbol, 200 );
 editSelItemSubMenu->AddItem( EE_ACTIONS::editFootprint, E_C::SingleSymbol, 200 );
 
 selToolMenu.AddItem( EE_ACTIONS::autoplaceFields, autoplaceCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::toggleDeMorgan, E_C::SingleSymbol, 200 );
 
 std::shared_ptr<SYMBOL_UNIT_MENU> symUnitMenu3 = std::make_shared<SYMBOL_UNIT_MENU>();
 symUnitMenu3->SetTool( m_selectionTool );
 m_selectionTool->GetToolMenu().RegisterSubMenu( symUnitMenu3 );
 selToolMenu.AddMenu( symUnitMenu3.get(), E_C::SingleMultiUnitSymbol, 1 );
 
 selToolMenu.AddItem( EE_ACTIONS::editWithLibEdit, E_C::SingleSymbolOrPower && E_C::Idle, 200 );
 selToolMenu.AddItem( EE_ACTIONS::changeSymbol, E_C::SingleSymbolOrPower, 200 );
 selToolMenu.AddItem( EE_ACTIONS::updateSymbol, E_C::SingleSymbolOrPower, 200 );
 selToolMenu.AddItem( EE_ACTIONS::changeSymbols, E_C::MultipleSymbolsOrPower, 200 );
 selToolMenu.AddItem( EE_ACTIONS::updateSymbols, E_C::MultipleSymbolsOrPower, 200 );
 
 CONDITIONAL_MENU* convertToSubMenu = new CONDITIONAL_MENU( m_selectionTool );
 convertToSubMenu->SetTitle( _( "Change To" ) );
 convertToSubMenu->SetIcon( BITMAPS::right );
 selToolMenu.AddMenu( convertToSubMenu, toChangeCondition, 200 );
 
 convertToSubMenu->AddItem( EE_ACTIONS::toLabel, toLabelCondition, 200 );
 convertToSubMenu->AddItem( EE_ACTIONS::toCLabel, toCLabelCondition, 200 );
 convertToSubMenu->AddItem( EE_ACTIONS::toHLabel, toHLabelCondition, 200 );
 convertToSubMenu->AddItem( EE_ACTIONS::toGLabel, toGLabelCondition, 200 );
 convertToSubMenu->AddItem( EE_ACTIONS::toText, toTextCondition, 200 );
 convertToSubMenu->AddItem( EE_ACTIONS::toTextBox, toTextBoxCondition, 200 );
 
 selToolMenu.AddItem( EE_ACTIONS::cleanupSheetPins, sheetHasUndefinedPins, 250 );
 
 selToolMenu.AddSeparator( 300 );
 selToolMenu.AddItem( ACTIONS::cut, E_C::IdleSelection, 300 );
 selToolMenu.AddItem( ACTIONS::copy, E_C::IdleSelection, 300 );
 selToolMenu.AddItem( ACTIONS::paste, E_C::Idle, 300 );
 selToolMenu.AddItem( ACTIONS::pasteSpecial, E_C::Idle, 300 );
 selToolMenu.AddItem( ACTIONS::doDelete, E_C::NotEmpty, 300 );
 selToolMenu.AddItem( ACTIONS::duplicate, duplicateCondition, 300 );
 
 selToolMenu.AddSeparator( 400 );
 selToolMenu.AddItem( ACTIONS::selectAll, hasElements, 400 );
 
 
 return true;
}

References _, CONDITIONAL_MENU::AddItem(), CONDITIONAL_MENU::AddMenu(), CONDITIONAL_MENU::AddSeparator(), EE_ACTIONS::autoplaceFields, EE_ACTIONS::changeSymbol, EE_ACTIONS::changeSymbols, EE_ACTIONS::cleanupSheetPins, EE_ACTIONS::clearHighlight, ACTIONS::copy, SELECTION_CONDITIONS::Count(), cursor, ACTIONS::cut, ACTIONS::doDelete, ACTIONS::duplicate, EE_ACTIONS::editFootprint, EE_ACTIONS::editReference, EE_ACTIONS::editValue, EE_ACTIONS::editWithLibEdit, EE_RTREE::empty(), EE_ACTIONS::enterSheet, EE_COLLECTOR::FieldOwners, SCH_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), KIGFX::SCH_VIEW::GetDrawingSheet(), SCH_EDIT_FRAME::GetHighlightedConnection(), TOOL_MENU::GetMenu(), SCH_EDIT_FRAME::GetScreen(), TOOL_MANAGER::GetTool(), TOOL_INTERACTIVE::GetToolMenu(), TOOL_BASE::getView(), SCH_DRAW_PANEL::GetView(), TOOL_BASE::getViewControls(), SCH_ITEM::HasLineStroke(), SELECTION_CONDITIONS::HasTypes(), DS_PROXY_VIEW_ITEM::HitTestDrawingSheetItems(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), EE_TOOL_BASE< T >::Init(), SCH_ITEM::IsConnectable(), TOOLS_HOLDER::IsCurrentTool(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), KIGFX::VIEW::IsLayerVisible(), SCH_SCREEN::Items(), LAYER_SCHEMATIC_DRAWINGSHEET, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_INTERACTIVE::m_menu, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, EE_ACTIONS::mirrorH, EE_ACTIONS::mirrorV, SELECTION_CONDITIONS::MoreThan(), EE_CONDITIONS::MultipleSymbolsOrPower, SELECTION_CONDITIONS::NotEmpty(), SELECTION_CONDITIONS::OnlyTypes(), ACTIONS::paste, ACTIONS::pasteSpecial, EE_ACTIONS::placeClassLabel, EE_ACTIONS::placeGlobalLabel, EE_ACTIONS::placeHierLabel, EE_ACTIONS::placeLabel, EE_ACTIONS::placeSchematicText, EE_ACTIONS::properties, TOOL_MENU::RegisterSubMenu(), right, RotatableItems, EE_ACTIONS::rotateCCW, EE_ACTIONS::rotateCW, SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_SHAPE_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TEXT_T, SCH_TEXTBOX_T, ACTIONS::selectAll, ACTION_MENU::SetIcon(), ACTION_MENU::SetTitle(), EE_CONDITIONS::SingleDeMorganSymbol, EE_CONDITIONS::SingleMultiUnitSymbol, EE_CONDITIONS::SingleSymbol, EE_CONDITIONS::SingleSymbolOrPower, EE_ACTIONS::swap, EE_ACTIONS::toCLabel, EE_ACTIONS::toggleDeMorgan, EE_ACTIONS::toGLabel, EE_ACTIONS::toHLabel, EE_ACTIONS::toLabel, EE_ACTIONS::toText, EE_ACTIONS::toTextBox, EDA_ITEM::Type(), EE_ACTIONS::updateSymbol, and EE_ACTIONS::updateSymbols.

IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 31 of file tool_base.cpp.

{
 return m_toolMgr->IsToolActive( m_toolId );
}

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

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

Mirror()

int SCH_EDIT_TOOL::Mirror

(

const TOOL_EVENT &

aEvent

)

Definition at line 788 of file sch_edit_tool.cpp.

{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( RotatableItems );
 
 if( selection.GetSize() == 0 )
 return 0;
 
 bool vertical = ( aEvent.Matches( EE_ACTIONS::mirrorV.MakeEvent() ) );
 SCH_ITEM* item = static_cast<SCH_ITEM*>( selection.Front() );
 bool connections = false;
 bool moving = item->IsMoving();
 
 if( selection.GetSize() == 1 )
 {
 if( !moving )
 saveCopyInUndoList( item, UNDO_REDO::CHANGED );
 
 switch( item->Type() )
 {
 case SCH_SYMBOL_T:
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
 
 if( vertical )
 symbol->SetOrientation( SYM_MIRROR_X );
 else
 symbol->SetOrientation( SYM_MIRROR_Y );
 
 symbol->ClearFieldsAutoplaced();
 break;
 }
 
 case SCH_TEXT_T:
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_DIRECTIVE_LABEL_T:
 {
 SCH_TEXT* textItem = static_cast<SCH_TEXT*>( item );
 textItem->MirrorSpinStyle( !vertical );
 break;
 }
 
 case SCH_SHEET_PIN_T:
 {
 // mirror within parent sheet
 SCH_SHEET_PIN* pin = static_cast<SCH_SHEET_PIN*>( item );
 SCH_SHEET* sheet = pin->GetParent();
 
 if( vertical )
 pin->MirrorVertically( sheet->GetBoundingBox().GetCenter().y );
 else
 pin->MirrorHorizontally( sheet->GetBoundingBox().GetCenter().x );
 
 break;
 }
 
 case SCH_FIELD_T:
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( item );
 
 if( vertical )
 field->SetVertJustify( TO_VJUSTIFY( -field->GetVertJustify() ) );
 else
 field->SetHorizJustify( TO_HJUSTIFY( -field->GetHorizJustify() ) );
 
 // Now that we're re-justifying a field, they're no longer autoplaced.
 static_cast<SCH_ITEM*>( field->GetParent() )->ClearFieldsAutoplaced();
 
 break;
 }
 
 case SCH_BITMAP_T:
 if( vertical )
 item->MirrorVertically( item->GetPosition().y );
 else
 item->MirrorHorizontally( item->GetPosition().x );
 
 // The bitmap is cached in Opengl: clear the cache to redraw
 getView()->RecacheAllItems();
 break;
 
 case SCH_SHEET_T:
 {
 // Mirror the sheet on itself. Sheets do not have a anchor point.
 VECTOR2I mirrorPoint = m_frame->GetNearestHalfGridPosition( item->GetBoundingBox().Centre() );
 
 if( vertical )
 item->MirrorVertically( mirrorPoint.y );
  else
 item->MirrorHorizontally( mirrorPoint.x );
 
 break;
 }
 
 default:
 if( vertical )
 item->MirrorVertically( item->GetPosition().y );
 else
 item->MirrorHorizontally( item->GetPosition().x );
 
 break;
 }
 
 connections = item->IsConnectable();
 m_frame->UpdateItem( item, false, true );
 }
 else if( selection.GetSize() > 1 )
 {
 VECTOR2I mirrorPoint = m_frame->GetNearestHalfGridPosition( selection.GetCenter() );
 
 for( unsigned ii = 0; ii < selection.GetSize(); ii++ )
 {
 item = static_cast<SCH_ITEM*>( selection.GetItem( ii ) );
 
 if( !moving )
 saveCopyInUndoList( item, UNDO_REDO::CHANGED, ii > 0 );
 
 if( item->Type() == SCH_SHEET_PIN_T )
 {
 if( item->GetParent()->IsSelected() )
 {
 // parent will mirror us
 }
 else
 {
 // mirror within parent sheet
 SCH_SHEET_PIN* pin = static_cast<SCH_SHEET_PIN*>( item );
 SCH_SHEET* sheet = pin->GetParent();
 
 if( vertical )
 pin->MirrorVertically( sheet->GetBoundingBox().GetCenter().y );
 else
 pin->MirrorHorizontally( sheet->GetBoundingBox().GetCenter().x );
 }
 }
 else if( item->Type() == SCH_FIELD_T )
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( item );
 
 if( vertical )
 field->SetVertJustify( TO_VJUSTIFY( -field->GetVertJustify() ) );
 else
 field->SetHorizJustify( TO_HJUSTIFY( -field->GetHorizJustify() ) );
 
 // Now that we're re-justifying a field, they're no longer autoplaced.
 static_cast<SCH_ITEM*>( field->GetParent() )->ClearFieldsAutoplaced();
 }
 else
 {
 if( vertical )
 item->MirrorVertically( mirrorPoint.y );
 else
 item->MirrorHorizontally( mirrorPoint.x );
 }
 
 connections |= item->IsConnectable();
 m_frame->UpdateItem( item, false, true );
 }
 }
 
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 
 // Update R-Tree for modified items
 for( EDA_ITEM* selected : selection )
 updateItem( selected, true );
 
 if( item->IsMoving() )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else
 {
 EE_SELECTION selectionCopy = selection;
 
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 
 if( connections )
 {
 SCH_LINE_WIRE_BUS_TOOL* lwbTool = m_toolMgr->GetTool<SCH_LINE_WIRE_BUS_TOOL>();
 lwbTool->TrimOverLappingWires( &selectionCopy );
 lwbTool->AddJunctionsIfNeeded( &selectionCopy );
 
 m_frame->SchematicCleanUp();
 m_frame->TestDanglingEnds();
 }
 
 m_frame->OnModify();
 }
 
 return 0;
}

References SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), BOX2< Vec >::Centre(), CHANGED, SCH_ITEM::ClearFieldsAutoplaced(), EE_ACTIONS::clearSelection, SELECTION::Front(), EDA_ITEM::GetBoundingBox(), SCH_SHEET::GetBoundingBox(), SELECTION::GetCenter(), BOX2< Vec >::GetCenter(), EDA_TEXT::GetHorizJustify(), SELECTION::GetItem(), EDA_DRAW_FRAME::GetNearestHalfGridPosition(), EDA_ITEM::GetParent(), EDA_ITEM::GetPosition(), SELECTION::GetSize(), TOOL_MANAGER::GetTool(), EDA_TEXT::GetVertJustify(), TOOL_BASE::getView(), SCH_ITEM::IsConnectable(), SELECTION::IsHover(), EDA_ITEM::IsMoving(), EDA_ITEM::IsSelected(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, TOOL_EVENT::Matches(), SCH_ITEM::MirrorHorizontally(), SCH_TEXT::MirrorSpinStyle(), EE_ACTIONS::mirrorV, SCH_ITEM::MirrorVertically(), SCH_EDIT_FRAME::OnModify(), pin, TOOL_MANAGER::PostEvent(), KIGFX::VIEW::RecacheAllItems(), ACTIONS::refreshPreview, EE_SELECTION_TOOL::RequestSelection(), RotatableItems, TOOL_MANAGER::RunAction(), EE_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList(), SCH_BITMAP_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TEXT_T, SCH_EDIT_FRAME::SchematicCleanUp(), EVENTS::SelectedItemsModified, EDA_TEXT::SetHorizJustify(), SCH_SYMBOL::SetOrientation(), EDA_TEXT::SetVertJustify(), SYM_MIRROR_X, SYM_MIRROR_Y, SCH_EDIT_FRAME::TestDanglingEnds(), TO_HJUSTIFY, TO_VJUSTIFY, SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), EDA_ITEM::Type(), EE_TOOL_BASE< SCH_EDIT_FRAME >::updateItem(), SCH_EDIT_FRAME::UpdateItem(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by setTransitions().

Properties()

int SCH_EDIT_TOOL::Properties

(

const TOOL_EVENT &

aEvent

)

Definition at line 1566 of file sch_edit_tool.cpp.

{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( EE_COLLECTOR::EditableItems );
 bool clearSelection = selection.IsHover();
 
 if( selection.Empty() )
 {
 if( getView()->IsLayerVisible( LAYER_SCHEMATIC_DRAWINGSHEET ) )
 {
 DS_PROXY_VIEW_ITEM* ds = m_frame->GetCanvas()->GetView()->GetDrawingSheet();
 VECTOR2D cursorPos = getViewControls()->GetCursorPosition( false );
 
 if( ds && ds->HitTestDrawingSheetItems( getView(), cursorPos ) )
 m_toolMgr->RunAction( ACTIONS::pageSettings );
 }
 
 return 0;
 }
 
 EDA_ITEM* curr_item = selection.Front();
 
 switch( curr_item->Type() )
 {
 case SCH_LINE_T:
 case SCH_BUS_WIRE_ENTRY_T:
 case SCH_JUNCTION_T:
 break;
 
 default:
 if( selection.Size() > 1 )
 return 0;
 
 break;
 }
 
 switch( curr_item->Type() )
 {
 case SCH_SYMBOL_T:
 {
 int retval;
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( curr_item );
 
 // This needs to be scoped so the dialog destructor removes blocking status
 // before we launch the next dialog.
 {
 DIALOG_SYMBOL_PROPERTIES symbolPropsDialog( m_frame, symbol );
 
 // This dialog itself subsequently can invoke a KIWAY_PLAYER as a quasimodal
 // frame. Therefore this dialog as a modal frame parent, MUST be run under
 // quasimodal mode for the quasimodal frame support to work. So don't use
 // the QUASIMODAL macros here.
 retval = symbolPropsDialog.ShowQuasiModal();
 }
 
 if( retval == SYMBOL_PROPS_EDIT_OK )
 {
 if( m_frame->eeconfig()->m_AutoplaceFields.enable )
 symbol->AutoAutoplaceFields( m_frame->GetScreen() );
 
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 else if( retval == SYMBOL_PROPS_EDIT_SCHEMATIC_SYMBOL )
 {
 auto editor = (SYMBOL_EDIT_FRAME*) m_frame->Kiway().Player( FRAME_SCH_SYMBOL_EDITOR,
 true );
 
 if( wxWindow* blocking_win = editor->Kiway().GetBlockingDialog() )
 blocking_win->Close( true );
 
 // The broken library symbol link indicator cannot be edited.
 if( symbol->IsMissingLibSymbol() )
 return 0;
 
 editor->LoadSymbolFromSchematic( symbol );
 
 editor->Show( true );
 editor->Raise();
 }
 else if( retval == SYMBOL_PROPS_EDIT_LIBRARY_SYMBOL )
 {
 auto editor = (SYMBOL_EDIT_FRAME*) m_frame->Kiway().Player( FRAME_SCH_SYMBOL_EDITOR,
 true );
 
 if( wxWindow* blocking_win = editor->Kiway().GetBlockingDialog() )
 blocking_win->Close( true );
 
 editor->LoadSymbol( symbol->GetLibId(), symbol->GetUnit(), symbol->GetConvert() );
 
 editor->Show( true );
 editor->Raise();
 }
 else if( retval == SYMBOL_PROPS_WANT_UPDATE_SYMBOL )
 {
 DIALOG_CHANGE_SYMBOLS dlg( m_frame, symbol, DIALOG_CHANGE_SYMBOLS::MODE::UPDATE );
 dlg.ShowQuasiModal();
 }
 else if( retval == SYMBOL_PROPS_WANT_EXCHANGE_SYMBOL )
 {
 DIALOG_CHANGE_SYMBOLS dlg( m_frame, symbol, DIALOG_CHANGE_SYMBOLS::MODE::CHANGE );
 dlg.ShowQuasiModal();
 }
 }
 break;
 
 case SCH_SHEET_T:
 {
 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( curr_item );
 bool doClearAnnotation;
 bool doRefresh = false;
 
 // Keep track of existing sheet paths. EditSheet() can modify this list.
 // Note that we use the validity checking/repairing version here just to make sure
 // we've got a valid hierarchy to begin with.
 SCH_SHEET_LIST originalHierarchy( &m_frame->Schematic().Root(), true );
 
 doRefresh = m_frame->EditSheetProperties( sheet, &m_frame->GetCurrentSheet(),
 &doClearAnnotation );
 
 // If the sheet file is changed and new sheet contents are loaded then we have to
 // clear the annotations on the new content (as it may have been set from some other
 // sheet path reference)
 if( doClearAnnotation )
 {
 SCH_SCREENS screensList( &m_frame->Schematic().Root() );
 
 // We clear annotation of new sheet paths here:
 screensList.ClearAnnotationOfNewSheetPaths( originalHierarchy );
 
 // Clear annotation of g_CurrentSheet itself, because its sheetpath is not a new
 // path, but symbols managed by its sheet path must have their annotation cleared
 // because they are new:
 sheet->GetScreen()->ClearAnnotation( &m_frame->GetCurrentSheet(), false );
 }
 
 if( doRefresh )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->GetCanvas()->Refresh();
 m_frame->UpdateHierarchyNavigator();
 }
 
 break;
 }
 
 case SCH_SHEET_PIN_T:
 {
 SCH_SHEET_PIN* pin = static_cast<SCH_SHEET_PIN*>( curr_item );
 DIALOG_SHEET_PIN_PROPERTIES dlg( m_frame, pin );
 
 // QuasiModal required for help dialog
 if( dlg.ShowQuasiModal() == wxID_OK )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 }
 break;
 
 case SCH_TEXT_T:
 case SCH_TEXTBOX_T:
 {
 DIALOG_TEXT_PROPERTIES dlg( m_frame, static_cast<SCH_ITEM*>( curr_item ) );
 
 // Must be quasi modal for syntax help
 if( dlg.ShowQuasiModal() == wxID_OK )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 }
 break;
 
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_DIRECTIVE_LABEL_T:
 {
 DIALOG_LABEL_PROPERTIES dlg( m_frame, static_cast<SCH_LABEL_BASE*>( curr_item ) );
 
 // Must be quasi modal for syntax help
 if( dlg.ShowQuasiModal() == wxID_OK )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 }
 break;
 
 case SCH_FIELD_T:
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( curr_item );
 
 editFieldText( field );
 
 if( !field->IsVisible() )
 clearSelection = true;
 }
 break;
 
 case SCH_SHAPE_T:
 {
 DIALOG_SHAPE_PROPERTIES dlg( m_frame, static_cast<SCH_SHAPE*>( curr_item ) );
 
 if( dlg.ShowModal() == wxID_OK )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 }
 break;
 
 case SCH_BITMAP_T:
 {
 SCH_BITMAP* bitmap = static_cast<SCH_BITMAP*>( curr_item );
 DIALOG_IMAGE_PROPERTIES dlg( m_frame, bitmap );
 
 if( dlg.ShowModal() == wxID_OK )
 {
 // The bitmap is cached in Opengl: clear the cache in case it has become invalid
 getView()->RecacheAllItems();
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 }
 break;
 
 case SCH_LINE_T:
 case SCH_BUS_WIRE_ENTRY_T:
 case SCH_JUNCTION_T:
 if( std::all_of( selection.Items().begin(), selection.Items().end(),
 [&]( const EDA_ITEM* item )
 {
 return item->Type() == SCH_LINE_T
 && static_cast<const SCH_LINE*>( item )->IsGraphicLine();
 } ) )
 {
 std::deque<SCH_LINE*> lines;
 
 for( EDA_ITEM* selItem : selection.Items() )
 lines.push_back( static_cast<SCH_LINE*>( selItem ) );
 
 DIALOG_LINE_PROPERTIES dlg( m_frame, lines );
 
 if( dlg.ShowModal() == wxID_OK )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 }
 else if( std::all_of( selection.Items().begin(), selection.Items().end(),
 [&]( const EDA_ITEM* item )
 {
 return item->Type() == SCH_JUNCTION_T;
 } ) )
 {
 std::deque<SCH_JUNCTION*> junctions;
 
 for( EDA_ITEM* selItem : selection.Items() )
 junctions.push_back( static_cast<SCH_JUNCTION*>( selItem ) );
 
 DIALOG_JUNCTION_PROPS dlg( m_frame, junctions );
 
 if( dlg.ShowModal() == wxID_OK )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 }
 else if( std::all_of( selection.Items().begin(), selection.Items().end(),
 [&]( const EDA_ITEM* item )
 {
 const SCH_ITEM* schItem = dynamic_cast<const SCH_ITEM*>( item );
 
 wxCHECK( schItem, false );
 
 return ( schItem->HasLineStroke() && schItem->IsConnectable() )
 || item->Type() == SCH_JUNCTION_T;
 } ) )
 {
 std::deque<SCH_ITEM*> items;
 
 for( EDA_ITEM* selItem : selection.Items() )
 items.push_back( static_cast<SCH_ITEM*>( selItem ) );
 
 DIALOG_WIRE_BUS_PROPERTIES dlg( m_frame, items );
 
 if( dlg.ShowModal() == wxID_OK )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 }
 else
 {
 return 0;
 }
 
 break;
 
 case SCH_MARKER_T: // These items have no properties to edit
 case SCH_NO_CONNECT_T:
 break;
 
 default: // Unexpected item
 wxFAIL_MSG( wxString( "Cannot edit schematic item type " ) + curr_item->GetClass() );
 }
 
 updateItem( curr_item, true );
 
 if( clearSelection )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 
 return 0;
}

References SCH_ITEM::AutoAutoplaceFields(), DIALOG_CHANGE_SYMBOLS::CHANGE, SCH_SCREEN::ClearAnnotation(), SCH_SCREENS::ClearAnnotationOfNewSheetPaths(), EE_ACTIONS::clearSelection, EE_COLLECTOR::EditableItems, editFieldText(), editor, SCH_EDIT_FRAME::EditSheetProperties(), SCH_BASE_FRAME::eeconfig(), SELECTION::Empty(), EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::enable, FRAME_SCH_SYMBOL_EDITOR, SELECTION::Front(), SCH_BASE_FRAME::GetCanvas(), EDA_ITEM::GetClass(), SCH_SYMBOL::GetConvert(), SCH_EDIT_FRAME::GetCurrentSheet(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), KIGFX::SCH_VIEW::GetDrawingSheet(), SCH_SYMBOL::GetLibId(), SCH_SHEET::GetScreen(), SCH_EDIT_FRAME::GetScreen(), SCH_SYMBOL::GetUnit(), TOOL_BASE::getView(), SCH_DRAW_PANEL::GetView(), TOOL_BASE::getViewControls(), DS_PROXY_VIEW_ITEM::HitTestDrawingSheetItems(), SELECTION::IsHover(), SCH_SYMBOL::IsMissingLibSymbol(), EDA_TEXT::IsVisible(), SELECTION::Items(), KIWAY_HOLDER::Kiway(), LAYER_SCHEMATIC_DRAWINGSHEET, EESCHEMA_SETTINGS::m_AutoplaceFields, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, SCH_EDIT_FRAME::OnModify(), ACTIONS::pageSettings, pin, KIWAY::Player(), TOOL_MANAGER::PostEvent(), KIGFX::VIEW::RecacheAllItems(), EDA_DRAW_PANEL_GAL::Refresh(), EE_SELECTION_TOOL::RequestSelection(), SCHEMATIC::Root(), TOOL_MANAGER::RunAction(), SCH_BITMAP_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_MARKER_T, SCH_NO_CONNECT_T, SCH_SHAPE_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TEXT_T, SCH_TEXTBOX_T, SCH_EDIT_FRAME::Schematic(), EVENTS::SelectedItemsModified, DIALOG_SHIM::ShowQuasiModal(), SELECTION::Size(), SYMBOL_PROPS_EDIT_LIBRARY_SYMBOL, SYMBOL_PROPS_EDIT_OK, SYMBOL_PROPS_EDIT_SCHEMATIC_SYMBOL, SYMBOL_PROPS_WANT_EXCHANGE_SYMBOL, SYMBOL_PROPS_WANT_UPDATE_SYMBOL, EDA_ITEM::Type(), DIALOG_CHANGE_SYMBOLS::UPDATE, SCH_EDIT_FRAME::UpdateHierarchyNavigator(), and EE_TOOL_BASE< SCH_EDIT_FRAME >::updateItem().

Referenced by setTransitions().

RepeatDrawItem()

int SCH_EDIT_TOOL::RepeatDrawItem

(

const TOOL_EVENT &

aEvent

)

Definition at line 1085 of file sch_edit_tool.cpp.

{
 const std::vector<std::unique_ptr<SCH_ITEM>>& sourceItems = m_frame->GetRepeatItems();
 
 if( sourceItems.empty() )
 return 0;
 
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 
 bool appendUndo = false;
 EE_SELECTION newItems;
 
 for( const std::unique_ptr<SCH_ITEM>& item : sourceItems )
 {
 SCH_ITEM* newItem = item->Duplicate();
 EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
 
 if( SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( newItem ) )
 {
 // If incrementing tries to go below zero, tell user why the value is repeated
 
 if( !label->IncrementLabel( cfg->m_Drawing.repeat_label_increment ) )
 m_frame->ShowInfoBarWarning( _( "Label value cannot go below zero" ), true );
 }
 
 // If cloning a symbol then put into 'move' mode.
 if( newItem->Type() == SCH_SYMBOL_T )
 {
 VECTOR2I cursorPos = getViewControls()->GetCursorPosition( true );
 newItem->Move( cursorPos - newItem->GetPosition() );
 }
 else
 {
 newItem->Move( VECTOR2I( schIUScale.MilsToIU( cfg->m_Drawing.default_repeat_offset_x ),
 schIUScale.MilsToIU( cfg->m_Drawing.default_repeat_offset_y ) ) );
 }
 
 m_toolMgr->RunAction( EE_ACTIONS::addItemToSel, true, newItem );
 newItem->SetFlags( IS_NEW );
 m_frame->AddToScreen( newItem, m_frame->GetScreen() );
 m_frame->SaveCopyInUndoList( m_frame->GetScreen(), newItem, UNDO_REDO::NEWITEM, appendUndo );
 appendUndo = true;
 
 if( newItem->Type() == SCH_SYMBOL_T )
 {
 EESCHEMA_SETTINGS::PANEL_ANNOTATE& annotate = m_frame->eeconfig()->m_AnnotatePanel;
 SCHEMATIC_SETTINGS& projSettings = m_frame->Schematic().Settings();
 int annotateStartNum = projSettings.m_AnnotateStartNum;
 
 if( annotate.automatic )
 {
 static_cast<SCH_SYMBOL*>( newItem )->ClearAnnotation( nullptr, false );
 NULL_REPORTER reporter;
 m_frame->AnnotateSymbols( ANNOTATE_SELECTION,
 (ANNOTATE_ORDER_T) annotate.sort_order,
 (ANNOTATE_ALGO_T) annotate.method, true /* recursive */,
 annotateStartNum, false, false, reporter, appendUndo );
 }
 
 m_toolMgr->RunAction( EE_ACTIONS::move, true );
 }
 
 newItems.Add( newItem );
 
 newItem->ClearFlags();
 }
 
 if( !newItems.Empty() )
 {
 SCH_LINE_WIRE_BUS_TOOL* lwbTool = m_toolMgr->GetTool<SCH_LINE_WIRE_BUS_TOOL>();
 lwbTool->TrimOverLappingWires( &newItems );
 lwbTool->AddJunctionsIfNeeded( &newItems );
 
 m_frame->SchematicCleanUp();
 m_frame->TestDanglingEnds();
 }
 
 m_frame->GetCanvas()->Refresh();
 m_frame->OnModify();
 
 if( !newItems.Empty() )
 m_frame->SaveCopyForRepeatItem( static_cast<SCH_ITEM*>( newItems[0] ) );
 
 for( size_t ii = 1; ii < newItems.GetSize(); ++ii )
 m_frame->AddCopyForRepeatItem( static_cast<SCH_ITEM*>( newItems[ii] ) );
 
 return 0;
}

References _, SELECTION::Add(), SCH_EDIT_FRAME::AddCopyForRepeatItem(), EE_ACTIONS::addItemToSel, SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), SCH_BASE_FRAME::AddToScreen(), annotate, ANNOTATE_SELECTION, SCH_EDIT_FRAME::AnnotateSymbols(), EDA_ITEM::ClearFlags(), EE_ACTIONS::clearSelection, EESCHEMA_SETTINGS::DRAWING::default_repeat_offset_x, EESCHEMA_SETTINGS::DRAWING::default_repeat_offset_y, SCH_ITEM::Duplicate(), SCH_BASE_FRAME::eeconfig(), SELECTION::Empty(), SCH_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), EDA_ITEM::GetPosition(), SCH_EDIT_FRAME::GetRepeatItems(), SCH_EDIT_FRAME::GetScreen(), SELECTION::GetSize(), TOOL_MANAGER::GetTool(), TOOL_BASE::getViewControls(), IS_NEW, EESCHEMA_SETTINGS::m_AnnotatePanel, SCHEMATIC_SETTINGS::m_AnnotateStartNum, EESCHEMA_SETTINGS::m_Drawing, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, EDA_IU_SCALE::MilsToIU(), SCH_ITEM::Move(), EE_ACTIONS::move, NEWITEM, SCH_EDIT_FRAME::OnModify(), Pgm(), EDA_DRAW_PANEL_GAL::Refresh(), EESCHEMA_SETTINGS::DRAWING::repeat_label_increment, TOOL_MANAGER::RunAction(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_SYMBOL_T, SCH_EDIT_FRAME::Schematic(), SCH_EDIT_FRAME::SchematicCleanUp(), schIUScale, EDA_ITEM::SetFlags(), SCHEMATIC::Settings(), EDA_BASE_FRAME::ShowInfoBarWarning(), SCH_EDIT_FRAME::TestDanglingEnds(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), and EDA_ITEM::Type().

Referenced by setTransitions().

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() );
 }

resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

Clear the current transition map and restores the default one created by setTransitions().

Definition at line 63 of file tool_interactive.cpp.

{
 m_toolMgr->ClearTransitions( this );
 setTransitions();
}

References TOOL_MANAGER::ClearTransitions(), TOOL_BASE::m_toolMgr, and TOOL_INTERACTIVE::setTransitions().

Rotate()

int SCH_EDIT_TOOL::Rotate

(

const TOOL_EVENT &

aEvent

)

Definition at line 522 of file sch_edit_tool.cpp.

{
 bool clockwise = ( aEvent.Matches( EE_ACTIONS::rotateCW.MakeEvent() ) );
 EE_SELECTION& selection = m_selectionTool->RequestSelection( RotatableItems );
 
 if( selection.GetSize() == 0 )
 return 0;
 
 SCH_ITEM* head = nullptr;
 int principalItemCount = 0; // User-selected items (as opposed to connected wires)
 VECTOR2I rotPoint;
 bool moving = false;
 
 for( unsigned ii = 0; ii < selection.GetSize(); ii++ )
 {
 SCH_ITEM* item = static_cast<SCH_ITEM*>( selection.GetItem( ii ) );
 
 if( item->HasFlag( SELECTED_BY_DRAG ) )
 continue;
 
 principalItemCount++;
 
 if( !head )
 head = item;
 }
 
 if( head && head->IsMoving() )
 moving = true;
 
 if( principalItemCount == 1 )
 {
 if( moving && selection.HasReferencePoint() )
 rotPoint = selection.GetReferencePoint();
 else if( head->IsConnectable() )
 rotPoint = head->GetPosition();
 else
 rotPoint = m_frame->GetNearestHalfGridPosition( head->GetBoundingBox().GetCenter() );
 
 if( !moving )
 saveCopyInUndoList( head, UNDO_REDO::CHANGED );
 
 switch( head->Type() )
 {
 case SCH_SYMBOL_T:
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( head );
 
 for( int i = 0; clockwise ? i < 3 : i < 1; ++i )
 symbol->Rotate( rotPoint );
 
 if( m_frame->eeconfig()->m_AutoplaceFields.enable )
 symbol->AutoAutoplaceFields( m_frame->GetScreen() );
 
 break;
 }
 
 case SCH_TEXT_T:
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_DIRECTIVE_LABEL_T:
 {
 SCH_TEXT* textItem = static_cast<SCH_TEXT*>( head );
 textItem->Rotate90( clockwise );
 break;
 }
 
 case SCH_SHEET_PIN_T:
 {
 // Rotate pin within parent sheet
 SCH_SHEET_PIN* pin = static_cast<SCH_SHEET_PIN*>( head );
 SCH_SHEET* sheet = pin->GetParent();
 
 for( int i = 0; clockwise ? i < 3 : i < 1; ++i )
 pin->Rotate( sheet->GetBodyBoundingBox().GetCenter() );
 
 break;
 }
 
 case SCH_LINE_T:
 {
 SCH_LINE* line = static_cast<SCH_LINE*>( head );
 
 // Equal checks for both and neither. We need this because on undo
 // the item will have both flags cleared, but will be selected, so it is possible
 // for the user to get a selected line with neither endpoint selected. We
 // set flags to make sure Rotate() works when we call it.
 if( line->HasFlag( STARTPOINT ) == line->HasFlag( ENDPOINT ) )
 {
 line->SetFlags( STARTPOINT | ENDPOINT );
 
 // When we allow off grid items, the rotPoint should be set to the midpoint
 // of the line to allow rotation around the center, and the next if
 // should become an else-if
 }
 
 if( line->HasFlag( STARTPOINT ) )
 rotPoint = line->GetEndPoint();
 else if( line->HasFlag( ENDPOINT ) )
 rotPoint = line->GetStartPoint();
 }
 
 KI_FALLTHROUGH;
 case SCH_JUNCTION_T:
 case SCH_BUS_BUS_ENTRY_T:
 case SCH_BUS_WIRE_ENTRY_T:
 for( int i = 0; clockwise ? i < 3 : i < 1; ++i )
 head->Rotate( rotPoint );
 
 break;
 
 case SCH_FIELD_T:
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( head );
 
 if( field->GetTextAngle().IsHorizontal() )
 field->SetTextAngle( ANGLE_VERTICAL );
 else
 field->SetTextAngle( ANGLE_HORIZONTAL );
 
 // Now that we're moving a field, they're no longer autoplaced.
 static_cast<SCH_ITEM*>( head->GetParent() )->ClearFieldsAutoplaced();
 
 break;
 }
 
 case SCH_SHAPE_T:
 case SCH_TEXTBOX_T:
 for( int i = 0; clockwise ? i < 1 : i < 3; ++i )
 head->Rotate( rotPoint );
 
 break;
 
 case SCH_BITMAP_T:
 for( int i = 0; clockwise ? i < 3 : i < 1; ++i )
 head->Rotate( rotPoint );
 
 // The bitmap is cached in Opengl: clear the cache to redraw
 getView()->RecacheAllItems();
 break;
 
 case SCH_SHEET_T:
 {
 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( head );
 rotPoint = m_frame->GetNearestHalfGridPosition( sheet->GetRotationCenter() );
 
  // Rotate the sheet on itself. Sheets do not have an anchor point.
 for( int i = 0; clockwise ? i < 3 : i < 1; ++i )
 sheet->Rotate( rotPoint );
 
 break;
 }
 
 default:
 UNIMPLEMENTED_FOR( head->GetClass() );
 }
 
 m_frame->UpdateItem( head, false, true );
 }
 else
 {
 if( moving && selection.HasReferencePoint() )
 rotPoint = selection.GetReferencePoint();
 else
 rotPoint = m_frame->GetNearestHalfGridPosition( selection.GetCenter() );
 }
 
 for( unsigned ii = 0; ii < selection.GetSize(); ii++ )
 {
 SCH_ITEM* item = static_cast<SCH_ITEM*>( selection.GetItem( ii ) );
 
 // We've already rotated the user selected item if there was only one. We're just
 // here to rotate the ends of wires that were attached to it.
 if( principalItemCount == 1 && !item->HasFlag( SELECTED_BY_DRAG ) )
 continue;
 
 if( !moving )
 saveCopyInUndoList( item, UNDO_REDO::CHANGED, ii > 0 );
 
 for( int i = 0; clockwise ? i < 3 : i < 1; ++i )
 {
 if( item->Type() == SCH_LINE_T )
 {
 SCH_LINE* line = (SCH_LINE*) item;
 
 // If we are rotating more than one item, we do not have start/end
 // points separately selected
 if( item->HasFlag( STARTPOINT ) )
 line->RotateStart( rotPoint );
 
 if( item->HasFlag( ENDPOINT ) )
 line->RotateEnd( rotPoint );
 }
 else if( item->Type() == SCH_SHEET_PIN_T )
 {
 if( item->GetParent()->IsSelected() )
 {
 // parent will rotate us
 }
 else
 {
 // rotate within parent
 SCH_SHEET_PIN* pin = static_cast<SCH_SHEET_PIN*>( item );
 SCH_SHEET* sheet = pin->GetParent();
 
 pin->Rotate( sheet->GetBodyBoundingBox().GetCenter() );
 }
 }
 else if( item->Type() == SCH_FIELD_T )
 {
 if( item->GetParent()->IsSelected() )
 {
 // parent will rotate us
 }
 else
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( item );
 
 field->Rotate( rotPoint );
 
 if( field->GetTextAngle().IsHorizontal() )
 field->SetTextAngle( ANGLE_VERTICAL );
 else
 field->SetTextAngle( ANGLE_HORIZONTAL );
 
 // Now that we're moving a field, they're no longer autoplaced.
 static_cast<SCH_ITEM*>( field->GetParent() )->ClearFieldsAutoplaced();
 }
 }
 else
 {
 item->Rotate( rotPoint );
 }
 }
 
 m_frame->UpdateItem( item, false, true );
 updateItem( item, true );
 }
 
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 
 if( moving )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else
 {
 EE_SELECTION selectionCopy = selection;
 
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 
 SCH_LINE_WIRE_BUS_TOOL* lwbTool = m_toolMgr->GetTool<SCH_LINE_WIRE_BUS_TOOL>();
 lwbTool->TrimOverLappingWires( &selectionCopy );
 lwbTool->AddJunctionsIfNeeded( &selectionCopy );
 
 m_frame->SchematicCleanUp();
 m_frame->TestDanglingEnds();
 
 m_frame->OnModify();
 }
 
 return 0;
}

References SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ANGLE_HORIZONTAL, ANGLE_VERTICAL, SCH_ITEM::AutoAutoplaceFields(), CHANGED, EE_ACTIONS::clearSelection, SCH_BASE_FRAME::eeconfig(), EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::enable, ENDPOINT, SCH_SHEET::GetBodyBoundingBox(), EDA_ITEM::GetBoundingBox(), SELECTION::GetCenter(), BOX2< Vec >::GetCenter(), SCH_ITEM::GetClass(), SCH_LINE::GetEndPoint(), SELECTION::GetItem(), EDA_DRAW_FRAME::GetNearestHalfGridPosition(), EDA_ITEM::GetParent(), EDA_ITEM::GetPosition(), SELECTION::GetReferencePoint(), SCH_SHEET::GetRotationCenter(), SCH_EDIT_FRAME::GetScreen(), SELECTION::GetSize(), SCH_LINE::GetStartPoint(), EDA_TEXT::GetTextAngle(), TOOL_MANAGER::GetTool(), TOOL_BASE::getView(), EDA_ITEM::HasFlag(), SELECTION::HasReferencePoint(), SCH_ITEM::IsConnectable(), EDA_ANGLE::IsHorizontal(), SELECTION::IsHover(), EDA_ITEM::IsMoving(), EDA_ITEM::IsSelected(), KI_FALLTHROUGH, EESCHEMA_SETTINGS::m_AutoplaceFields, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, TOOL_EVENT::Matches(), SCH_EDIT_FRAME::OnModify(), pin, TOOL_MANAGER::PostEvent(), KIGFX::VIEW::RecacheAllItems(), ACTIONS::refreshPreview, EE_SELECTION_TOOL::RequestSelection(), RotatableItems, SCH_FIELD::Rotate(), SCH_SHEET::Rotate(), SCH_SYMBOL::Rotate(), SCH_ITEM::Rotate(), SCH_TEXT::Rotate90(), EE_ACTIONS::rotateCW, SCH_LINE::RotateEnd(), SCH_LINE::RotateStart(), TOOL_MANAGER::RunAction(), EE_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList(), SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_SHAPE_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TEXT_T, SCH_TEXTBOX_T, SCH_EDIT_FRAME::SchematicCleanUp(), SELECTED_BY_DRAG, EVENTS::SelectedItemsModified, EDA_ITEM::SetFlags(), EDA_TEXT::SetTextAngle(), STARTPOINT, SCH_EDIT_FRAME::TestDanglingEnds(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), EDA_ITEM::Type(), UNIMPLEMENTED_FOR, EE_TOOL_BASE< SCH_EDIT_FRAME >::updateItem(), and SCH_EDIT_FRAME::UpdateItem().

Referenced by setTransitions().

RunMainStack()

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

inherited

Call a function using the main stack.

Parameters

aFunc

is the function to be calls.

Definition at line 87 of file tool_interactive.cpp.

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

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

Referenced by DRAWING_TOOL::PlaceText().

saveCopyInUndoList()

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

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( SELECTED_BY_DRAG ) )
 aItem->ClearSelected();
 
 if( m_isSymbolEditor )
 {
 SYMBOL_EDIT_FRAME* editFrame = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame );
 wxCHECK_RET( editFrame, wxT( "editFrame is null" ) );
 
 editFrame->SaveCopyInUndoList( static_cast<LIB_ITEM*>( aItem ), aType, aAppend );
 }
 else
 {
 SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
 wxASSERT( editFrame );
 
 if( editFrame )
 {
 if( itemType == SCH_FIELD_T )
 {
 editFrame->SaveCopyInUndoList( editFrame->GetScreen(),
 static_cast<SCH_ITEM*>( aItem->GetParent() ),
 UNDO_REDO::CHANGED, aAppend,
 false );
 }
 else if( itemType == SCH_PIN_T || itemType == SCH_SHEET_PIN_T )
 {
 editFrame->SaveCopyInUndoList( editFrame->GetScreen(),
 static_cast<SCH_ITEM*>( aItem->GetParent() ),
 UNDO_REDO::CHANGED, aAppend,
 aDirtyConnectivity );
 }
 else
 {
 editFrame->SaveCopyInUndoList( editFrame->GetScreen(),
 static_cast<SCH_ITEM*>( aItem ), aType,
 aAppend, aDirtyConnectivity );
 }
 }
 }
 
 if( selected && aItem->HasFlag( SELECTED_BY_DRAG ) )
 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 SELECTION_TOOL::doSelectionMenu(), TOOL_MENU::ShowContextMenu(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

setTransitions()

void SCH_EDIT_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 2373 of file sch_edit_tool.cpp.

{
 Go( &SCH_EDIT_TOOL::RepeatDrawItem, EE_ACTIONS::repeatDrawItem.MakeEvent() );
 Go( &SCH_EDIT_TOOL::Rotate, EE_ACTIONS::rotateCW.MakeEvent() );
 Go( &SCH_EDIT_TOOL::Rotate, EE_ACTIONS::rotateCCW.MakeEvent() );
 Go( &SCH_EDIT_TOOL::Mirror, EE_ACTIONS::mirrorV.MakeEvent() );
 Go( &SCH_EDIT_TOOL::Mirror, EE_ACTIONS::mirrorH.MakeEvent() );
 Go( &SCH_EDIT_TOOL::Swap, EE_ACTIONS::swap.MakeEvent() );
 Go( &SCH_EDIT_TOOL::DoDelete, ACTIONS::doDelete.MakeEvent() );
 Go( &SCH_EDIT_TOOL::DeleteItemCursor, ACTIONS::deleteTool.MakeEvent() );
 
 Go( &SCH_EDIT_TOOL::Properties, EE_ACTIONS::properties.MakeEvent() );
 Go( &SCH_EDIT_TOOL::EditField, EE_ACTIONS::editReference.MakeEvent() );
 Go( &SCH_EDIT_TOOL::EditField, EE_ACTIONS::editValue.MakeEvent() );
 Go( &SCH_EDIT_TOOL::EditField, EE_ACTIONS::editFootprint.MakeEvent() );
 Go( &SCH_EDIT_TOOL::AutoplaceFields, EE_ACTIONS::autoplaceFields.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeSymbols, EE_ACTIONS::changeSymbols.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeSymbols, EE_ACTIONS::updateSymbols.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeSymbols, EE_ACTIONS::changeSymbol.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeSymbols, EE_ACTIONS::updateSymbol.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ConvertDeMorgan, EE_ACTIONS::toggleDeMorgan.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ConvertDeMorgan, EE_ACTIONS::showDeMorganStandard.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ConvertDeMorgan, EE_ACTIONS::showDeMorganAlternate.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeTextType, EE_ACTIONS::toLabel.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeTextType, EE_ACTIONS::toHLabel.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeTextType, EE_ACTIONS::toGLabel.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeTextType, EE_ACTIONS::toCLabel.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeTextType, EE_ACTIONS::toText.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeTextType, EE_ACTIONS::toTextBox.MakeEvent() );
 
 Go( &SCH_EDIT_TOOL::BreakWire, EE_ACTIONS::breakWire.MakeEvent() );
 Go( &SCH_EDIT_TOOL::BreakWire, EE_ACTIONS::slice.MakeEvent() );
 
 Go( &SCH_EDIT_TOOL::CleanupSheetPins, EE_ACTIONS::cleanupSheetPins.MakeEvent() );
 Go( &SCH_EDIT_TOOL::GlobalEdit, EE_ACTIONS::editTextAndGraphics.MakeEvent() );
 Go( &SCH_EDIT_TOOL::EditPageNumber, EE_ACTIONS::editPageNumber.MakeEvent() );
 
 Go( &SCH_EDIT_TOOL::DdAppendFile, EE_ACTIONS::ddAppendFile.MakeEvent() );
}

References EE_ACTIONS::autoplaceFields, AutoplaceFields(), EE_ACTIONS::breakWire, BreakWire(), EE_ACTIONS::changeSymbol, EE_ACTIONS::changeSymbols, ChangeSymbols(), ChangeTextType(), EE_ACTIONS::cleanupSheetPins, CleanupSheetPins(), ConvertDeMorgan(), EE_ACTIONS::ddAppendFile, DdAppendFile(), DeleteItemCursor(), ACTIONS::deleteTool, DoDelete(), ACTIONS::doDelete, EditField(), EE_ACTIONS::editFootprint, EE_ACTIONS::editPageNumber, EditPageNumber(), EE_ACTIONS::editReference, EE_ACTIONS::editTextAndGraphics, EE_ACTIONS::editValue, GlobalEdit(), TOOL_INTERACTIVE::Go(), Mirror(), EE_ACTIONS::mirrorH, EE_ACTIONS::mirrorV, EE_ACTIONS::properties, Properties(), EE_ACTIONS::repeatDrawItem, RepeatDrawItem(), Rotate(), EE_ACTIONS::rotateCCW, EE_ACTIONS::rotateCW, EE_ACTIONS::showDeMorganAlternate, EE_ACTIONS::showDeMorganStandard, EE_ACTIONS::slice, EE_ACTIONS::swap, Swap(), EE_ACTIONS::toCLabel, EE_ACTIONS::toggleDeMorgan, EE_ACTIONS::toGLabel, EE_ACTIONS::toHLabel, EE_ACTIONS::toLabel, EE_ACTIONS::toText, EE_ACTIONS::toTextBox, EE_ACTIONS::updateSymbol, and EE_ACTIONS::updateSymbols.

Swap()

int SCH_EDIT_TOOL::Swap

(

const TOOL_EVENT &

aEvent

)

Definition at line 1000 of file sch_edit_tool.cpp.

{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( swappableItems );
 std::vector<EDA_ITEM*> sorted = selection.GetItemsSortedBySelectionOrder();
 
 if( selection.Size() < 2 )
 return 0;
 
 bool isMoving = selection.Front()->IsMoving();
 bool appendUndo = isMoving;
 bool connections = false;
 
 SCH_SCREEN* screen = this->m_frame->GetScreen();
 
 for( size_t i = 0; i < sorted.size() - 1; i++ )
 {
 SCH_ITEM* a = static_cast<SCH_ITEM*>( sorted[i] );
 SCH_ITEM* b = static_cast<SCH_ITEM*>( sorted[( i + 1 ) % sorted.size()] );
 
 VECTOR2I aPos = a->GetPosition(), bPos = b->GetPosition();
 std::swap( aPos, bPos );
 
 saveCopyInUndoList( a, UNDO_REDO::CHANGED, appendUndo );
 appendUndo = true;
 saveCopyInUndoList( b, UNDO_REDO::CHANGED, appendUndo );
 
 a->SetPosition( aPos );
 b->SetPosition( bPos );
 
 if( a->Type() == b->Type() )
 {
 switch( a->Type() )
 {
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_DIRECTIVE_LABEL_T:
 m_frame->AutoRotateItem( screen, a );
 m_frame->AutoRotateItem( screen, b );
 break;
 case SCH_SYMBOL_T:
 {
 SCH_SYMBOL* aSymbol = static_cast<SCH_SYMBOL*>( a );
 SCH_SYMBOL* bSymbol = static_cast<SCH_SYMBOL*>( b );
 int aOrient = aSymbol->GetOrientation(), bOrient = bSymbol->GetOrientation();
 std::swap( aOrient, bOrient );
 aSymbol->SetOrientation( aOrient );
 bSymbol->SetOrientation( bOrient );
 break;
 }
 default: break;
 }
 }
 
 connections |= a->IsConnectable();
 connections |= b->IsConnectable();
 m_frame->UpdateItem( a, false, true );
 m_frame->UpdateItem( b, false, true );
 }
 
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 
 // Update R-Tree for modified items
 for( EDA_ITEM* selected : selection )
 updateItem( selected, true );
 
 if( isMoving )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else
 {
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 
 if( connections )
 m_frame->TestDanglingEnds();
 
 m_frame->OnModify();
 }
 
 return 0;
}

References SCH_EDIT_FRAME::AutoRotateItem(), CHANGED, EE_ACTIONS::clearSelection, SELECTION::Front(), SELECTION::GetItemsSortedBySelectionOrder(), SCH_SYMBOL::GetOrientation(), EDA_ITEM::GetPosition(), SCH_EDIT_FRAME::GetScreen(), SCH_ITEM::IsConnectable(), SELECTION::IsHover(), EDA_ITEM::IsMoving(), EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool, TOOL_BASE::m_toolMgr, SCH_EDIT_FRAME::OnModify(), TOOL_MANAGER::PostEvent(), ACTIONS::refreshPreview, EE_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), EE_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList(), SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_SYMBOL_T, EVENTS::SelectedItemsModified, SCH_SYMBOL::SetOrientation(), EDA_ITEM::SetPosition(), SELECTION::Size(), swappableItems, SCH_EDIT_FRAME::TestDanglingEnds(), EDA_ITEM::Type(), EE_TOOL_BASE< SCH_EDIT_FRAME >::updateItem(), and SCH_EDIT_FRAME::UpdateItem().

Referenced by setTransitions().

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

Member Data Documentation

m_frame

SCH_EDIT_FRAME * EE_TOOL_BASE< SCH_EDIT_FRAME >::m_frame

protectedinherited

Definition at line 189 of file ee_tool_base.h.

m_isSymbolEditor

bool EE_TOOL_BASE< SCH_EDIT_FRAME >::m_isSymbolEditor

protectedinherited

Definition at line 192 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(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), TOOL_INTERACTIVE::GetToolMenu(), EDA_3D_CONTROLLER::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), EE_TOOL_BASE< T >::Init(), SCH_DRAWING_TOOLS::Init(), Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), GERBVIEW_SELECTION_TOOL::Init(), PICKER_TOOL::Init(), ZOOM_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), LENGTH_TUNER_TOOL::Init(), ROUTER_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), DRAWING_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), PAD_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_TOOL_BASE::Init(), PCB_VIEWER_TOOLS::Init(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDA_3D_CONTROLLER::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

m_pickerItem

EDA_ITEM* SCH_EDIT_TOOL::m_pickerItem

private

Definition at line 93 of file sch_edit_tool.h.

Referenced by DeleteItemCursor(), and SCH_EDIT_TOOL().

m_selectionTool

EE_SELECTION_TOOL* EE_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool

protectedinherited

Definition at line 191 of file ee_tool_base.h.

m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Name of the tool.

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

Definition at line 210 of file tool_base.h.

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

m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 215 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), SCH_MOVE_TOOL::AlignElements(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), TOOL_BASE::attachManager(), AutoplaceFields(), EE_SELECTION_TOOL::autostartEvent(), BreakWire(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), SCH_EDITOR_CONTROL::ChangeLineMode(), ChangeTextType(), EDIT_TOOL::ChangeTrackWidth(), CleanupSheetPins(), GERBVIEW_CONTROL::ClearAllLayers(), SCH_EDITOR_CONTROL::ClearHighlight(), BOARD_INSPECTION_TOOL::ClearHighlight(), GERBVIEW_SELECTION_TOOL::clearSelection(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), ConvertDeMorgan(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), PL_EDIT_TOOL::Copy(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), MICROWAVE_TOOL::createInductorBetween(), EE_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), COMMON_TOOLS::CursorControl(), SCH_EDITOR_CONTROL::Cut(), DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::DeleteItems(), SCH_EDITOR_CONTROL::doCopy(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::doSyncSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Duplicate(), EditField(), editFieldText(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), PCB_SELECTION_TOOL::EnterGroup(), GROUP_TOOL::EnterGroup(), SCH_NAVIGATE_TOOL::EnterSheet(), PAD_TOOL::EnumeratePads(), EE_INSPECTION_TOOL::ExcludeMarker(), PCB_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::expandConnection(), PAD_TOOL::explodePad(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), TOOL_BASE::GetManager(), TOOL_BASE::getModelInt(), DRAWING_TOOL::getSourceZoneForAction(), TOOL_BASE::getToolHolderInt(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_INTERACTIVE::goInternal(), PCB_SELECTION_TOOL::grabUnconnected(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), PCB_CONTROL::GridSetOrigin(), GROUP_TOOL::Group(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightItem(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PL_EDIT_TOOL::ImportDrawingSheetContent(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), EE_TOOL_BASE< T >::Init(), Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_POINT_EDITOR::Init(), ROUTER_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), BOARD_REANNOTATE_TOOL::Init(), CONVERT_TOOL::Init(), DRAWING_TOOL::Init(), EDIT_TOOL::Init(), GLOBAL_EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_POINT_EDITOR::Init(), PCB_SELECTION_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), POSITION_RELATIVE_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), DRAWING_TOOL::InteractivePlaceWithPreview(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), TOOL_BASE::IsToolActive(), GROUP_TOOL::LeaveGroup(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), SCH_EDITOR_CONTROL::NextLineMode(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), SELECTION_TOOL::onDisambiguationExpire(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), EE_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDITOR_CONTROL::Redo(), SYMBOL_EDITOR_EDIT_TOOL::Redo(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), RepeatDrawItem(), SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem(), PCB_SELECTION_TOOL::RequestSelection(), EE_SELECTION_TOOL::RequestSelection(), EDA_3D_CONTROLLER::Reset(), COMMON_TOOLS::Reset(), PNS::TOOL_BASE::Reset(), PAD_TOOL::Reset(), COMMON_TOOLS::ResetLocalCoords(), TOOL_INTERACTIVE::resetTransitions(), SCH_EDITOR_CONTROL::Revert(), Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), TOOL_INTERACTIVE::RunMainStack(), DRC_TOOL::RunTests(), EE_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::SelectConnection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), GERBVIEW_SELECTION_TOOL::SelectItems(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectNet(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE::SetContextMenu(), EDA_3D_CONTROLLER::SetMaterial(), DRC_TOOL::ShowDRCDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), Swap(), EE_SELECTION_TOOL::SyncSelection(), COMMON_TOOLS::ToggleCursor(), COMMON_TOOLS::ToggleCursorStyle(), EDA_3D_CONTROLLER::ToggleVisibility(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), SCH_MOVE_TOOL::trimDanglingLines(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_EDITOR_CONTROL::Undo(), SYMBOL_EDITOR_EDIT_TOOL::Undo(), GROUP_TOOL::Ungroup(), PCB_SELECTION_TOOL::unrouteSelected(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), EE_POINT_EDITOR::updateParentItem(), PNS::TOOL_BASE::updateStartItem(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), TOOL_INTERACTIVE::Wait(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), and BOARD_EDITOR_CONTROL::ZoneMerge().

m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Definition at line 214 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

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

Definition at line 207 of file tool_base.h.

Referenced by TOOL_BASE::GetType().

m_view

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

protectedinherited

Definition at line 190 of file ee_tool_base.h.

RotatableItems

const std::vector< KICAD_T > SCH_EDIT_TOOL::RotatableItems

static

Initial value:

= {
 SCH_SHAPE_T,
 SCH_TEXT_T,
 SCH_TEXTBOX_T,
 SCH_LABEL_T,
 SCH_GLOBAL_LABEL_T,
 SCH_HIER_LABEL_T,
 SCH_DIRECTIVE_LABEL_T,
 SCH_FIELD_T,
 SCH_SYMBOL_T,
 SCH_SHEET_PIN_T,
 SCH_SHEET_T,
 SCH_BITMAP_T,
 SCH_BUS_BUS_ENTRY_T,
 SCH_BUS_WIRE_ENTRY_T,
 SCH_LINE_T,
 SCH_JUNCTION_T,
 SCH_NO_CONNECT_T
}

Definition at line 42 of file sch_edit_tool.h.

Referenced by AutoplaceFields(), Init(), Mirror(), and Rotate().

---

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

• sch_edit_tool.h
• eeschema/dialogs/dialog_global_edit_text_and_graphics.cpp
• sch_edit_tool.cpp