diff options
author | saurabhb17 | 2020-02-26 16:00:53 +0530 |
---|---|---|
committer | GitHub | 2020-02-26 16:00:53 +0530 |
commit | 886d9cb772e81d2e5262284bc3082664f084337f (patch) | |
tree | 6acee185a4dc19113fcbf0f9a3d6941085dedaf7 /pcbnew/tools/edit_tool.cpp | |
parent | 0db48f6533517ecebfd9f0693f89deca28408b76 (diff) | |
parent | aa35045840b78d3f48212db45da59a2e5c69b223 (diff) | |
download | KiCad-eSim-886d9cb772e81d2e5262284bc3082664f084337f.tar.gz KiCad-eSim-886d9cb772e81d2e5262284bc3082664f084337f.tar.bz2 KiCad-eSim-886d9cb772e81d2e5262284bc3082664f084337f.zip |
Merge pull request #1 from saurabhb17/develop
Added main functions
Diffstat (limited to 'pcbnew/tools/edit_tool.cpp')
-rw-r--r-- | pcbnew/tools/edit_tool.cpp | 1099 |
1 files changed, 1099 insertions, 0 deletions
diff --git a/pcbnew/tools/edit_tool.cpp b/pcbnew/tools/edit_tool.cpp new file mode 100644 index 0000000..81d547b --- /dev/null +++ b/pcbnew/tools/edit_tool.cpp @@ -0,0 +1,1099 @@ +/* + * This program source code file is part of KiCad, a free EDA CAD application. + * + * Copyright (C) 2013-2015 CERN + * @author Maciej Suminski <maciej.suminski@cern.ch> + * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch> + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, you may find one here: + * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html + * or you may search the http://www.gnu.org website for the version 2 license, + * or you may write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + */ + +#include <limits> + +#include <class_board.h> +#include <class_module.h> +#include <class_edge_mod.h> +#include <class_zone.h> +#include <wxPcbStruct.h> +#include <kiway.h> +#include <class_draw_panel_gal.h> +#include <module_editor_frame.h> + +#include <tool/tool_manager.h> +#include <view/view_controls.h> +#include <gal/graphics_abstraction_layer.h> +#include <ratsnest_data.h> +#include <confirm.h> + +#include <cassert> +#include <boost/foreach.hpp> +#include <boost/bind.hpp> + +#include "common_actions.h" +#include "selection_tool.h" +#include "edit_tool.h" +#include "grid_helper.h" + +#include <router/router_tool.h> + +#include <dialogs/dialog_create_array.h> +#include <dialogs/dialog_move_exact.h> +#include <dialogs/dialog_track_via_properties.h> + +EDIT_TOOL::EDIT_TOOL() : + TOOL_INTERACTIVE( "pcbnew.InteractiveEdit" ), m_selectionTool( NULL ), + m_dragging( false ), m_editModules( false ), m_undoInhibit( 0 ), + m_updateFlag( KIGFX::VIEW_ITEM::NONE ) +{ +} + + +void EDIT_TOOL::Reset( RESET_REASON aReason ) +{ + m_dragging = false; + m_updateFlag = KIGFX::VIEW_ITEM::NONE; +} + + +bool EDIT_TOOL::Init() +{ + // Find the selection tool, so they can cooperate + m_selectionTool = static_cast<SELECTION_TOOL*>( m_toolMgr->FindTool( "pcbnew.InteractiveSelection" ) ); + + if( !m_selectionTool ) + { + DisplayError( NULL, wxT( "pcbnew.InteractiveSelection tool is not available" ) ); + return false; + } + + // Vector storing track & via types, used for specifying 'Properties' menu entry condition + m_tracksViasType.push_back( PCB_TRACE_T ); + m_tracksViasType.push_back( PCB_VIA_T ); + + // Add context menu entries that are displayed when selection tool is active + m_selectionTool->GetMenu().AddItem( COMMON_ACTIONS::editActivate, SELECTION_CONDITIONS::NotEmpty ); + m_selectionTool->GetMenu().AddItem( COMMON_ACTIONS::rotate, SELECTION_CONDITIONS::NotEmpty ); + m_selectionTool->GetMenu().AddItem( COMMON_ACTIONS::flip, SELECTION_CONDITIONS::NotEmpty ); + m_selectionTool->GetMenu().AddItem( COMMON_ACTIONS::remove, SELECTION_CONDITIONS::NotEmpty ); + m_selectionTool->GetMenu().AddItem( COMMON_ACTIONS::properties, SELECTION_CONDITIONS::Count( 1 ) + || SELECTION_CONDITIONS::OnlyTypes( m_tracksViasType ) ); + m_selectionTool->GetMenu().AddItem( COMMON_ACTIONS::moveExact, SELECTION_CONDITIONS::NotEmpty ); + m_selectionTool->GetMenu().AddItem( COMMON_ACTIONS::duplicate, SELECTION_CONDITIONS::NotEmpty ); + m_selectionTool->GetMenu().AddItem( COMMON_ACTIONS::createArray, SELECTION_CONDITIONS::NotEmpty ); + + // Footprint actions + m_selectionTool->GetMenu().AddItem( COMMON_ACTIONS::editFootprintInFpEditor, + SELECTION_CONDITIONS::OnlyType( PCB_MODULE_T ) && + SELECTION_CONDITIONS::Count( 1 ) ); + + m_offset.x = 0; + m_offset.y = 0; + + return true; +} + + +bool EDIT_TOOL::invokeInlineRouter() +{ + TRACK* track = uniqueSelected<TRACK>(); + VIA* via = uniqueSelected<VIA>(); + + if( isUndoInhibited() ) + return false; + + if( track || via ) + { + ROUTER_TOOL* theRouter = static_cast<ROUTER_TOOL*>( m_toolMgr->FindTool( "pcbnew.InteractiveRouter" ) ); + assert( theRouter ); + + if( !theRouter->PNSSettings().InlineDragEnabled() ) + return false; + + TOOL_EVENT dummy; + m_selectionTool->ClearSelection( dummy ); + m_toolMgr->RunAction( COMMON_ACTIONS::routerInlineDrag, true, track ? track : via ); + return true; + } + + return false; +} + + +int EDIT_TOOL::Main( const TOOL_EVENT& aEvent ) +{ + KIGFX::VIEW_CONTROLS* controls = getViewControls(); + PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>(); + + VECTOR2I originalCursorPos = controls->GetCursorPosition(); + const SELECTION& selection = m_selectionTool->GetSelection(); + + // Shall the selection be cleared at the end? + bool unselect = selection.Empty(); + + // Be sure that there is at least one item that we can modify. If nothing was selected before, + // try looking for the stuff under mouse cursor (i.e. Kicad old-style hover selection) + if( !hoverSelection( selection ) ) + return 0; + + Activate(); + + m_dragging = false; // Are selected items being dragged? + bool restore = false; // Should items' state be restored when finishing the tool? + bool lockOverride = false; + + // By default, modified items need to update their geometry + m_updateFlag = KIGFX::VIEW_ITEM::GEOMETRY; + + controls->ShowCursor( true ); + + // cumulative translation + wxPoint totalMovement( 0, 0 ); + + GRID_HELPER grid( editFrame ); + OPT_TOOL_EVENT evt = aEvent; + + // Main loop: keep receiving events + do + { + if( evt->IsCancel() ) + { + restore = true; // Cancelling the tool means that items have to be restored + break; // Finish + } + + else if( evt->Action() == TA_UNDO_REDO ) + { + unselect = true; + break; + } + + else if( evt->IsAction( &COMMON_ACTIONS::editActivate ) + || evt->IsMotion() || evt->IsDrag( BUT_LEFT ) ) + { + BOARD_ITEM* item = selection.Item<BOARD_ITEM>( 0 ); + + if( m_dragging && evt->Category() == TC_MOUSE ) + { + m_cursor = grid.BestSnapAnchor( evt->Position(), item ); + controls->ForceCursorPosition( true, m_cursor ); + + wxPoint movement = wxPoint( m_cursor.x, m_cursor.y ) - item->GetPosition(); + totalMovement += movement; + + // Drag items to the current cursor position + for( unsigned int i = 0; i < selection.items.GetCount(); ++i ) + selection.Item<BOARD_ITEM>( i )->Move( movement + m_offset ); + + updateRatsnest( true ); + } + else if( !m_dragging ) // Prepare to start dragging + { + if( !invokeInlineRouter() ) + { + m_selectionTool->SanitizeSelection(); + + if( selection.Empty() ) + break; + + // deal with locked items (override lock or abort the operation) + SELECTION_LOCK_FLAGS lockFlags = m_selectionTool->CheckLock(); + + if( lockFlags == SELECTION_LOCKED ) + break; + else if( lockFlags == SELECTION_LOCK_OVERRIDE ) + lockOverride = true; + + // Save items, so changes can be undone + if( !isUndoInhibited() ) + { + editFrame->OnModify(); + editFrame->SaveCopyInUndoList( selection.items, UR_CHANGED ); + } + + m_cursor = controls->GetCursorPosition(); + + if( selection.Size() == 1 ) + { + // Set the current cursor position to the first dragged item origin, so the + // movement vector could be computed later + m_cursor = grid.BestDragOrigin( originalCursorPos, item ); + grid.SetAuxAxes( true, m_cursor ); + } + else + { + m_cursor = grid.Align( m_cursor ); + } + + controls->ForceCursorPosition( true, m_cursor ); + controls->WarpCursor( m_cursor, true ); + + VECTOR2I o = VECTOR2I( item->GetPosition() ); + m_offset.x = o.x - m_cursor.x; + m_offset.y = o.y - m_cursor.y; + + controls->SetAutoPan( true ); + m_dragging = true; + incUndoInhibit(); + } + } + + selection.group->ViewUpdate( KIGFX::VIEW_ITEM::GEOMETRY ); + m_toolMgr->RunAction( COMMON_ACTIONS::pointEditorUpdate, true ); + } + + // Dispatch TOOL_ACTIONs + else if( evt->Category() == TC_COMMAND ) + { + if( evt->IsAction( &COMMON_ACTIONS::rotate ) ) + { + Rotate( aEvent ); + } + else if( evt->IsAction( &COMMON_ACTIONS::flip ) ) + { + Flip( aEvent ); + + // Flip causes change of layers + enableUpdateFlag( KIGFX::VIEW_ITEM::LAYERS ); + } + else if( evt->IsAction( &COMMON_ACTIONS::remove ) ) + { + Remove( aEvent ); + + break; // exit the loop, as there is no further processing for removed items + } + else if( evt->IsAction( &COMMON_ACTIONS::duplicate ) ) + { + // On duplicate, stop moving this item + // The duplicate tool should then select the new item and start + // a new move procedure + break; + } + else if( evt->IsAction( &COMMON_ACTIONS::moveExact ) ) + { + // Can't do this, because the selection will then contain + // stale pointers and it will all go horribly wrong... + //editFrame->RestoreCopyFromUndoList( dummy ); + // + // So, instead, reset the position manually + for( unsigned int i = 0; i < selection.items.GetCount(); ++i ) + { + BOARD_ITEM* item = selection.Item<BOARD_ITEM>( i ); + item->SetPosition( item->GetPosition() - totalMovement ); + + // And what about flipping and rotation? + // for now, they won't be undone, but maybe that is how + // it should be, so you can flip and move exact in the + // same action? + } + + // This causes a double event, so we will get the dialogue + // correctly, somehow - why does Rotate not? + //MoveExact( aEvent ); + break; // exit the loop - we move exactly, so we have finished moving + } + } + + else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) ) + { + if( !lockOverride ) + break; // Finish + + lockOverride = false; + } + } while( evt = Wait() ); + + if( m_dragging ) + decUndoInhibit(); + + m_dragging = false; + m_offset.x = 0; + m_offset.y = 0; + + if( restore ) + { + // Modifications have to be rollbacked, so restore the previous state of items + wxCommandEvent dummy; + editFrame->RestoreCopyFromUndoList( dummy ); + } + else + { + // Changes are applied, so update the items + selection.group->ItemsViewUpdate( m_updateFlag ); + } + + if( unselect ) + m_toolMgr->RunAction( COMMON_ACTIONS::selectionClear, true ); + + RN_DATA* ratsnest = getModel<BOARD>()->GetRatsnest(); + ratsnest->ClearSimple(); + ratsnest->Recalculate(); + + controls->ShowCursor( false ); + controls->SetAutoPan( false ); + + return 0; +} + + +int EDIT_TOOL::Properties( const TOOL_EVENT& aEvent ) +{ + const SELECTION& selection = m_selectionTool->GetSelection(); + PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>(); + + // Shall the selection be cleared at the end? + bool unselect = selection.Empty(); + + if( !hoverSelection( selection, false ) ) + return 0; + + // Tracks & vias are treated in a special way: + if( ( SELECTION_CONDITIONS::OnlyTypes( m_tracksViasType ) )( selection ) ) + { + DIALOG_TRACK_VIA_PROPERTIES dlg( editFrame, selection ); + + if( dlg.ShowModal() ) + { + RN_DATA* ratsnest = getModel<BOARD>()->GetRatsnest(); + + editFrame->OnModify(); + editFrame->SaveCopyInUndoList( selection.items, UR_CHANGED ); + dlg.Apply(); + + selection.ForAll<KIGFX::VIEW_ITEM>( boost::bind( &KIGFX::VIEW_ITEM::ViewUpdate, _1, + KIGFX::VIEW_ITEM::ALL ) ); + selection.ForAll<BOARD_ITEM>( boost::bind( &RN_DATA::Update, ratsnest, _1 ) ); + ratsnest->Recalculate(); + } + } + else if( selection.Size() == 1 ) // Properties are displayed when there is only one item selected + { + // Display properties dialog + BOARD_ITEM* item = selection.Item<BOARD_ITEM>( 0 ); + + // Store the head of the undo list to compare if anything has changed + std::vector<PICKED_ITEMS_LIST*>& undoList = editFrame->GetScreen()->m_UndoList.m_CommandsList; + + // Some of properties dialogs alter pointers, so we should deselect them + m_toolMgr->RunAction( COMMON_ACTIONS::selectionClear, true ); + STATUS_FLAGS flags = item->GetFlags(); + item->ClearFlags(); + + // It is necessary to determine if anything has changed, so store the current undo save point + PICKED_ITEMS_LIST* undoSavePoint = undoList.empty() ? NULL : undoList.back(); + + // Display properties dialog provided by the legacy canvas frame + editFrame->OnEditItemRequest( NULL, item ); + + if( !undoList.empty() && undoList.back() != undoSavePoint ) // Undo buffer has changed + { + // Process changes stored after undoSavePoint + processUndoBuffer( undoSavePoint ); + + // Update the modified item + item->ViewUpdate(); + RN_DATA* ratsnest = getModel<BOARD>()->GetRatsnest(); + ratsnest->Recalculate(); + + // TODO OBSERVER! I miss you so much.. + m_toolMgr->RunAction( COMMON_ACTIONS::pointEditorUpdate, true ); + } + + item->SetFlags( flags ); + } + + if( unselect ) + m_toolMgr->RunAction( COMMON_ACTIONS::selectionClear, true ); + + return 0; +} + + +int EDIT_TOOL::Rotate( const TOOL_EVENT& aEvent ) +{ + const SELECTION& selection = m_selectionTool->GetSelection(); + PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>(); + + // Shall the selection be cleared at the end? + bool unselect = selection.Empty(); + + if( !hoverSelection( selection ) || m_selectionTool->CheckLock() == SELECTION_LOCKED ) + return 0; + + wxPoint rotatePoint = getModificationPoint( selection ); + + // If it is being dragged, then it is already saved with UR_CHANGED flag + if( !isUndoInhibited() ) + { + editFrame->OnModify(); + editFrame->SaveCopyInUndoList( selection.items, UR_ROTATED, rotatePoint ); + } + + for( unsigned int i = 0; i < selection.items.GetCount(); ++i ) + { + BOARD_ITEM* item = selection.Item<BOARD_ITEM>( i ); + + item->Rotate( rotatePoint, editFrame->GetRotationAngle() ); + + if( !m_dragging ) + item->ViewUpdate( KIGFX::VIEW_ITEM::GEOMETRY ); + } + + updateRatsnest( m_dragging ); + + // Update dragging offset (distance between cursor and the first dragged item) + m_offset = static_cast<BOARD_ITEM*>( selection.items.GetPickedItem( 0 ) )->GetPosition() - + rotatePoint; + + if( m_dragging ) + selection.group->ViewUpdate( KIGFX::VIEW_ITEM::GEOMETRY ); + else + getModel<BOARD>()->GetRatsnest()->Recalculate(); + + if( unselect ) + m_toolMgr->RunAction( COMMON_ACTIONS::selectionClear, true ); + + m_toolMgr->RunAction( COMMON_ACTIONS::pointEditorUpdate, true ); + + return 0; +} + + +int EDIT_TOOL::Flip( const TOOL_EVENT& aEvent ) +{ + const SELECTION& selection = m_selectionTool->GetSelection(); + PCB_BASE_FRAME* editFrame = getEditFrame<PCB_BASE_FRAME>(); + + // Shall the selection be cleared at the end? + bool unselect = selection.Empty(); + + if( !hoverSelection( selection ) || m_selectionTool->CheckLock() == SELECTION_LOCKED ) + return 0; + + wxPoint flipPoint = getModificationPoint( selection ); + + if( !isUndoInhibited() ) // If it is being dragged, then it is already saved with UR_CHANGED flag + { + editFrame->OnModify(); + editFrame->SaveCopyInUndoList( selection.items, UR_FLIPPED, flipPoint ); + } + + for( unsigned int i = 0; i < selection.items.GetCount(); ++i ) + { + BOARD_ITEM* item = selection.Item<BOARD_ITEM>( i ); + + item->Flip( flipPoint ); + + if( !m_dragging ) + item->ViewUpdate( KIGFX::VIEW_ITEM::LAYERS ); + } + + updateRatsnest( m_dragging ); + + // Update dragging offset (distance between cursor and the first dragged item) + m_offset = static_cast<BOARD_ITEM*>( selection.items.GetPickedItem( 0 ) )->GetPosition() - + flipPoint; + + if( m_dragging ) + selection.group->ViewUpdate( KIGFX::VIEW_ITEM::GEOMETRY ); + else + getModel<BOARD>()->GetRatsnest()->Recalculate(); + + if( unselect ) + m_toolMgr->RunAction( COMMON_ACTIONS::selectionClear, true ); + + m_toolMgr->RunAction( COMMON_ACTIONS::pointEditorUpdate, true ); + + return 0; +} + + +int EDIT_TOOL::Remove( const TOOL_EVENT& aEvent ) +{ + const SELECTION& selection = m_selectionTool->GetSelection(); + + if( !hoverSelection( selection ) || m_selectionTool->CheckLock() == SELECTION_LOCKED ) + return 0; + + // Get a copy of the selected items set + PICKED_ITEMS_LIST selectedItems = selection.items; + PCB_BASE_FRAME* editFrame = getEditFrame<PCB_BASE_FRAME>(); + + // As we are about to remove items, they have to be removed from the selection first + m_toolMgr->RunAction( COMMON_ACTIONS::selectionClear, true ); + + // Save them + for( unsigned int i = 0; i < selectedItems.GetCount(); ++i ) + selectedItems.SetPickedItemStatus( UR_DELETED, i ); + + editFrame->OnModify(); + editFrame->SaveCopyInUndoList( selectedItems, UR_DELETED ); + + // And now remove + for( unsigned int i = 0; i < selectedItems.GetCount(); ++i ) + remove( static_cast<BOARD_ITEM*>( selectedItems.GetPickedItem( i ) ) ); + + getModel<BOARD>()->GetRatsnest()->Recalculate(); + + return 0; +} + + +void EDIT_TOOL::remove( BOARD_ITEM* aItem ) +{ + BOARD* board = getModel<BOARD>(); + + switch( aItem->Type() ) + { + case PCB_MODULE_T: + { + MODULE* module = static_cast<MODULE*>( aItem ); + module->ClearFlags(); + module->RunOnChildren( boost::bind( &KIGFX::VIEW::Remove, getView(), _1 ) ); + + // Module itself is deleted after the switch scope is finished + // list of pads is rebuild by BOARD::BuildListOfNets() + + // Clear flags to indicate, that the ratsnest, list of nets & pads are not valid anymore + board->m_Status_Pcb = 0; + } + break; + + // Default removal procedure + case PCB_MODULE_TEXT_T: + { + TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( aItem ); + + switch( text->GetType() ) + { + case TEXTE_MODULE::TEXT_is_REFERENCE: + DisplayError( getEditFrame<PCB_BASE_FRAME>(), _( "Cannot delete component reference." ) ); + return; + + case TEXTE_MODULE::TEXT_is_VALUE: + DisplayError( getEditFrame<PCB_BASE_FRAME>(), _( "Cannot delete component value." ) ); + return; + + case TEXTE_MODULE::TEXT_is_DIVERS: // suppress warnings + break; + } + + if( m_editModules ) + { + MODULE* module = static_cast<MODULE*>( aItem->GetParent() ); + module->SetLastEditTime(); + board->m_Status_Pcb = 0; // it is done in the legacy view + aItem->DeleteStructure(); + } + + return; + } + + case PCB_PAD_T: + case PCB_MODULE_EDGE_T: + { + MODULE* module = static_cast<MODULE*>( aItem->GetParent() ); + module->SetLastEditTime(); + + board->m_Status_Pcb = 0; // it is done in the legacy view + + + if( !m_editModules ) + { + getView()->Remove( aItem ); + board->Remove( aItem ); + } + + aItem->DeleteStructure(); + + return; + } + + case PCB_LINE_T: // a segment not on copper layers + case PCB_TEXT_T: // a text on a layer + case PCB_TRACE_T: // a track segment (segment on a copper layer) + case PCB_VIA_T: // a via (like track segment on a copper layer) + case PCB_DIMENSION_T: // a dimension (graphic item) + case PCB_TARGET_T: // a target (graphic item) + case PCB_MARKER_T: // a marker used to show something + case PCB_ZONE_T: // SEG_ZONE items are now deprecated + case PCB_ZONE_AREA_T: + break; + + default: // other types do not need to (or should not) be handled + assert( false ); + return; + } + + getView()->Remove( aItem ); + board->Remove( aItem ); +} + + +int EDIT_TOOL::MoveExact( const TOOL_EVENT& aEvent ) +{ + const SELECTION& selection = m_selectionTool->GetSelection(); + + // Shall the selection be cleared at the end? + bool unselect = selection.Empty(); + + if( !hoverSelection( selection ) || m_selectionTool->CheckLock() == SELECTION_LOCKED ) + return 0; + + wxPoint translation; + double rotation = 0; + + PCB_BASE_FRAME* editFrame = getEditFrame<PCB_BASE_FRAME>(); + + DIALOG_MOVE_EXACT dialog( editFrame, translation, rotation ); + int ret = dialog.ShowModal(); + + if( ret == wxID_OK ) + { + if( !isUndoInhibited() ) + { + editFrame->OnModify(); + // Record an action of move and rotate + editFrame->SaveCopyInUndoList( selection.items, UR_CHANGED ); + } + + VECTOR2I rp = selection.GetCenter(); + wxPoint rotPoint( rp.x, rp.y ); + + for( unsigned int i = 0; i < selection.items.GetCount(); ++i ) + { + BOARD_ITEM* item = selection.Item<BOARD_ITEM>( i ); + + item->Move( translation ); + item->Rotate( rotPoint, rotation ); + + if( !m_dragging ) + item->ViewUpdate( KIGFX::VIEW_ITEM::GEOMETRY ); + } + + updateRatsnest( m_dragging ); + + if( m_dragging ) + selection.group->ViewUpdate( KIGFX::VIEW_ITEM::GEOMETRY ); + else + getModel<BOARD>()->GetRatsnest()->Recalculate(); + + if( unselect ) + m_toolMgr->RunAction( COMMON_ACTIONS::selectionClear, true ); + + m_toolMgr->RunAction( COMMON_ACTIONS::pointEditorUpdate, true ); + } + + return 0; +} + + +int EDIT_TOOL::Duplicate( const TOOL_EVENT& aEvent ) +{ + // Note: original items are no more modified. + + bool increment = aEvent.IsAction( &COMMON_ACTIONS::duplicateIncrement ); + + // first, check if we have a selection, or try to get one + SELECTION_TOOL* selTool = m_toolMgr->GetTool<SELECTION_TOOL>(); + const SELECTION& selection = selTool->GetSelection(); + + // Be sure that there is at least one item that we can modify + if( !hoverSelection( selection ) ) + return 0; + + // we have a selection to work on now, so start the tool process + + PCB_BASE_FRAME* editFrame = getEditFrame<PCB_BASE_FRAME>(); + editFrame->OnModify(); + + // prevent other tools making undo points while the duplicate is going on + // so that if you cancel, you don't get a duplicate object hiding over + // the original + incUndoInhibit(); + + if( m_editModules ) + editFrame->SaveCopyInUndoList( editFrame->GetBoard()->m_Modules, UR_MODEDIT ); + + std::vector<BOARD_ITEM*> old_items; + + for( int i = 0; i < selection.Size(); ++i ) + { + BOARD_ITEM* item = selection.Item<BOARD_ITEM>( i ); + + if( item ) + old_items.push_back( item ); + } + + for( unsigned i = 0; i < old_items.size(); ++i ) + { + BOARD_ITEM* item = old_items[i]; + + // Unselect the item, so we won't pick it up again + // Do this first, so a single-item duplicate will correctly call + // SetCurItem and show the item properties + m_toolMgr->RunAction( COMMON_ACTIONS::unselectItem, true, item ); + + BOARD_ITEM* new_item = NULL; + + if( m_editModules ) + new_item = editFrame->GetBoard()->m_Modules->DuplicateAndAddItem( item, increment ); + else + { +#if 0 + // @TODO: see if we allow zone duplication here + // Duplicate zones is especially tricky (overlaping zones must be merged) + // so zones are not duplicated + if( item->Type() != PCB_ZONE_AREA_T ) +#endif + new_item = editFrame->GetBoard()->DuplicateAndAddItem( item, increment ); + } + + if( new_item ) + { + if( new_item->Type() == PCB_MODULE_T ) + { + static_cast<MODULE*>( new_item )->RunOnChildren( boost::bind( &KIGFX::VIEW::Add, + getView(), _1 ) ); + } + + editFrame->GetGalCanvas()->GetView()->Add( new_item ); + + // Select the new item, so we can pick it up + m_toolMgr->RunAction( COMMON_ACTIONS::selectItem, true, new_item ); + } + } + + // record the new items as added + if( !m_editModules && !selection.Empty() ) + { + editFrame->SaveCopyInUndoList( selection.items, UR_NEW ); + + editFrame->DisplayToolMsg( wxString::Format( _( "Duplicated %d item(s)" ), + (int) old_items.size() ) ); + + // If items were duplicated, pick them up + // this works well for "dropping" copies around + TOOL_EVENT evt = COMMON_ACTIONS::editActivate.MakeEvent(); + Main( evt ); + } + + // and re-enable undos + decUndoInhibit(); + + return 0; +} + + +int EDIT_TOOL::CreateArray( const TOOL_EVENT& aEvent ) +{ + // first, check if we have a selection, or try to get one + SELECTION_TOOL* selTool = m_toolMgr->GetTool<SELECTION_TOOL>(); + const SELECTION& selection = selTool->GetSelection(); + + // Be sure that there is at least one item that we can modify + if( !hoverSelection( selection ) ) + return 0; + + // we have a selection to work on now, so start the tool process + + PCB_BASE_FRAME* editFrame = getEditFrame<PCB_BASE_FRAME>(); + editFrame->OnModify(); + + if( m_editModules ) + { + // Module editors do their undo point upfront for the whole module + editFrame->SaveCopyInUndoList( editFrame->GetBoard()->m_Modules, UR_MODEDIT ); + } + + DIALOG_CREATE_ARRAY::ARRAY_OPTIONS* array_opts = NULL; + + VECTOR2I rp = selection.GetCenter(); + const wxPoint rotPoint( rp.x, rp.y ); + + DIALOG_CREATE_ARRAY dialog( editFrame, rotPoint, &array_opts ); + int ret = dialog.ShowModal(); + + if( ret == wxID_OK && array_opts != NULL ) + { + PICKED_ITEMS_LIST newItemList; + + for( int i = 0; i < selection.Size(); ++i ) + { + BOARD_ITEM* item = selection.Item<BOARD_ITEM>( i ); + + if( !item ) + continue; + + // iterate across the array, laying out the item at the + // correct position + const unsigned nPoints = array_opts->GetArraySize(); + + // The first item in list is the original item. We do not modify it + for( unsigned ptN = 1; ptN < nPoints; ++ptN ) + { + BOARD_ITEM* newItem = NULL; + + // Some items cannot be duplicated + // i.e. the ref and value fields of a footprint or zones + // therefore newItem can be null + + #define INCREMENT_REF false + #define INCREMENT_PADNUMBER true + + if( m_editModules ) + newItem = editFrame->GetBoard()->m_Modules->DuplicateAndAddItem( + item, INCREMENT_PADNUMBER ); + else + { +#if 0 + // @TODO: see if we allow zone duplication here + // Duplicate zones is especially tricky (overlaping zones must be merged) + // so zones are not duplicated + if( item->Type() == PCB_ZONE_AREA_T ) + newItem = NULL; + else +#endif + newItem = editFrame->GetBoard()->DuplicateAndAddItem( + item, INCREMENT_REF ); + // @TODO: we should merge zones. This is a bit tricky, because + // the undo command needs saving old area, if it is merged. + } + + if( newItem ) + { + array_opts->TransformItem( ptN, newItem, rotPoint ); + + m_toolMgr->RunAction( COMMON_ACTIONS::unselectItem, true, newItem ); + + newItemList.PushItem( newItem ); + + if( newItem->Type() == PCB_MODULE_T) + { + static_cast<MODULE*>( newItem )->RunOnChildren( boost::bind( &KIGFX::VIEW::Add, + getView(), _1 ) ); + } + + editFrame->GetGalCanvas()->GetView()->Add( newItem ); + getModel<BOARD>()->GetRatsnest()->Update( newItem ); + } + + // Only renumbering pads has meaning: + if( newItem && array_opts->ShouldRenumberItems() ) + { + if( newItem->Type() == PCB_PAD_T ) + { + const wxString padName = array_opts->GetItemNumber( ptN ); + static_cast<D_PAD*>( newItem )->SetPadName( padName ); + } + } + } + } + + if( !m_editModules ) + { + // Add all items as a single undo point for PCB editors + editFrame->SaveCopyInUndoList( newItemList, UR_NEW ); + } + } + + getModel<BOARD>()->GetRatsnest()->Recalculate(); + + return 0; +} + + +void EDIT_TOOL::SetTransitions() +{ + Go( &EDIT_TOOL::Main, COMMON_ACTIONS::editActivate.MakeEvent() ); + Go( &EDIT_TOOL::Rotate, COMMON_ACTIONS::rotate.MakeEvent() ); + Go( &EDIT_TOOL::Flip, COMMON_ACTIONS::flip.MakeEvent() ); + Go( &EDIT_TOOL::Remove, COMMON_ACTIONS::remove.MakeEvent() ); + Go( &EDIT_TOOL::Properties, COMMON_ACTIONS::properties.MakeEvent() ); + Go( &EDIT_TOOL::MoveExact, COMMON_ACTIONS::moveExact.MakeEvent() ); + Go( &EDIT_TOOL::Duplicate, COMMON_ACTIONS::duplicate.MakeEvent() ); + Go( &EDIT_TOOL::Duplicate, COMMON_ACTIONS::duplicateIncrement.MakeEvent() ); + Go( &EDIT_TOOL::CreateArray,COMMON_ACTIONS::createArray.MakeEvent() ); + Go( &EDIT_TOOL::editFootprintInFpEditor, COMMON_ACTIONS::editFootprintInFpEditor.MakeEvent() ); +} + + +void EDIT_TOOL::updateRatsnest( bool aRedraw ) +{ + const SELECTION& selection = m_selectionTool->GetSelection(); + RN_DATA* ratsnest = getModel<BOARD>()->GetRatsnest(); + + ratsnest->ClearSimple(); + + for( unsigned int i = 0; i < selection.items.GetCount(); ++i ) + { + BOARD_ITEM* item = selection.Item<BOARD_ITEM>( i ); + + ratsnest->Update( item ); + + if( aRedraw ) + ratsnest->AddSimple( item ); + } +} + + +wxPoint EDIT_TOOL::getModificationPoint( const SELECTION& aSelection ) +{ + if( aSelection.Size() == 1 ) + { + return aSelection.Item<BOARD_ITEM>( 0 )->GetPosition() - m_offset; + } + else + { + // If EDIT_TOOL is not currently active then it means that the cursor position is not + // updated, so we have to fetch the latest value + if( m_toolMgr->GetCurrentToolId() != m_toolId ) + m_cursor = getViewControls()->GetCursorPosition(); + + return wxPoint( m_cursor.x, m_cursor.y ); + } +} + + +bool EDIT_TOOL::hoverSelection( const SELECTION& aSelection, bool aSanitize ) +{ + if( aSelection.Empty() ) // Try to find an item that could be modified + { + m_toolMgr->RunAction( COMMON_ACTIONS::selectionCursor, true ); + + if( m_selectionTool->CheckLock() == SELECTION_LOCKED ) + { + m_toolMgr->RunAction( COMMON_ACTIONS::selectionClear, true ); + return false; + } + } + + if( aSanitize ) + m_selectionTool->SanitizeSelection(); + + if( aSelection.Empty() ) // TODO is it necessary? + m_toolMgr->RunAction( COMMON_ACTIONS::selectionClear, true ); + + return !aSelection.Empty(); +} + +void EDIT_TOOL::processUndoBuffer( const PICKED_ITEMS_LIST* aLastChange ) +{ + PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>(); + const std::vector<PICKED_ITEMS_LIST*>& undoList = editFrame->GetScreen()->m_UndoList.m_CommandsList; + bool process = false; + + BOOST_FOREACH( const PICKED_ITEMS_LIST* list, undoList ) + { + if( process ) + processPickedList( list ); + else if( list == aLastChange ) + process = true; // Start processing starting with the next undo save point + } + + // If we could not find the requested save point in the current undo list + // then the undo list must have been completely altered, so process everything + if( !process ) + { + BOOST_FOREACH( const PICKED_ITEMS_LIST* list, undoList ) + processPickedList( list ); + } +} + + +void EDIT_TOOL::processPickedList( const PICKED_ITEMS_LIST* aList ) +{ + KIGFX::VIEW* view = getView(); + RN_DATA* ratsnest = getModel<BOARD>()->GetRatsnest(); + + for( unsigned int i = 0; i < aList->GetCount(); ++i ) + { + UNDO_REDO_T operation = aList->GetPickedItemStatus( i ); + BOARD_ITEM* updItem = static_cast<BOARD_ITEM*>( aList->GetPickedItem( i ) ); + + switch( operation ) + { + case UR_CHANGED: + ratsnest->Update( updItem ); + // fall through + + case UR_MODEDIT: + updItem->ViewUpdate( KIGFX::VIEW_ITEM::ALL ); + break; + + case UR_DELETED: + if( updItem->Type() == PCB_MODULE_T ) + static_cast<MODULE*>( updItem )->RunOnChildren( boost::bind( &KIGFX::VIEW::Remove, + view, _1 ) ); + + view->Remove( updItem ); + //ratsnest->Remove( updItem ); // this is done in BOARD::Remove + break; + + case UR_NEW: + if( updItem->Type() == PCB_MODULE_T ) + static_cast<MODULE*>( updItem )->RunOnChildren( boost::bind( &KIGFX::VIEW::Add, + view, _1 ) ); + + view->Add( updItem ); + //ratsnest->Add( updItem ); // this is done in BOARD::Add + break; + + default: + assert( false ); // Not handled + break; + } + } +} + + +int EDIT_TOOL::editFootprintInFpEditor( const TOOL_EVENT& aEvent ) +{ + const SELECTION& selection = m_selectionTool->GetSelection(); + bool unselect = selection.Empty(); + + if( !hoverSelection( selection ) ) + return 0; + + MODULE* mod = uniqueSelected<MODULE>(); + + if( !mod ) + return 0; + + PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>(); + + editFrame-> SetCurItem( mod ); + + if( editFrame->GetCurItem()->GetTimeStamp() == 0 ) // Module Editor needs a non null timestamp + { + editFrame->GetCurItem()->SetTimeStamp( GetNewTimeStamp() ); + editFrame->OnModify(); + } + + FOOTPRINT_EDIT_FRAME* editor = (FOOTPRINT_EDIT_FRAME*) editFrame->Kiway().Player( FRAME_PCB_MODULE_EDITOR, true ); + + editor->Load_Module_From_BOARD( (MODULE*) editFrame->GetCurItem() ); + editFrame->SetCurItem( NULL ); // the current module could be deleted by + + editor->Show( true ); + editor->Raise(); // Iconize( false ); + + if( unselect ) + m_toolMgr->RunAction( COMMON_ACTIONS::selectionClear, true ); + + return 0; +} |