1 files changed, 238 insertions, 0 deletions
diff --git a/pcbnew/tools/edit_tool.h b/pcbnew/tools/edit_tool.h
new file mode 100644
index 0000000..0c24018
--- /dev/null
+++ b/pcbnew/tools/edit_tool.h
@@ -0,0 +1,238 @@
+/*
+ * 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
+ */
+
+#ifndef __EDIT_TOOL_H
+#define __EDIT_TOOL_H
+
+#include <math/vector2d.h>
+#include <tool/tool_interactive.h>
+#include <view/view_group.h>
+
+class BOARD_ITEM;
+class SELECTION_TOOL;
+
+namespace KIGFX
+{
+class VIEW_GROUP;
+}
+
+/**
+ * Class EDIT_TOOL
+ *
+ * The interactive edit tool. Allows to move, rotate, flip and change properties of items selected
+ * using the pcbnew.InteractiveSelection tool.
+ */
+
+class EDIT_TOOL : public TOOL_INTERACTIVE
+{
+public:
+    EDIT_TOOL();
+
+    /// @copydoc TOOL_INTERACTIVE::Reset()
+    void Reset( RESET_REASON aReason );
+
+    /// @copydoc TOOL_INTERACTIVE::Init()
+    bool Init();
+
+    /**
+     * Function Main()
+     *
+     * Main loop in which events are handled.
+     * @param aEvent is the handled event.
+     */
+    int Main( const TOOL_EVENT& aEvent );
+
+    /**
+     * Function Edit()
+     *
+     * Displays properties window for the selected object.
+     */
+    int Properties( const TOOL_EVENT& aEvent );
+
+    /**
+     * Function Rotate()
+     *
+     * Rotates currently selected items.
+     */
+    int Rotate( const TOOL_EVENT& aEvent );
+
+    /**
+     * Function Flip()
+     *
+     * Rotates currently selected items. The rotation point is the current cursor position.
+     */
+    int Flip( const TOOL_EVENT& aEvent );
+
+    /**
+     * Function Remove()
+     *
+     * Deletes currently selected items. The rotation point is the current cursor position.
+     */
+    int Remove( const TOOL_EVENT& aEvent );
+
+    /**
+     * Function Duplicate()
+     *
+     * Duplicates a selection and starts a move action
+     */
+    int Duplicate( const TOOL_EVENT& aEvent );
+
+    /**
+     * Function MoveExact()
+     *
+     * Invokes a dialog box to allow moving of the item by an exact amount.
+     */
+    int MoveExact( const TOOL_EVENT& aEvent );
+
+    /**
+     * Function CreateArray()
+     *
+     * Creates an array of the selected items, invoking the array editor dialog
+     * to set the array options
+     */
+    int CreateArray( const TOOL_EVENT& aEvent );
+
+    /**
+     * Function EditModules()
+     *
+     * Toggles edit module mode. When enabled, one may select parts of modules individually
+     * (graphics, pads, etc.), so they can be modified.
+     * @param aEnabled decides if the mode should be enabled.
+     */
+    void EditModules( bool aEnabled )
+    {
+        m_editModules = aEnabled;
+    }
+
+    ///> Sets up handlers for various events.
+    void SetTransitions();
+
+private:
+    ///> Selection tool used for obtaining selected items
+    SELECTION_TOOL* m_selectionTool;
+
+    ///> Flag determining if anything is being dragged right now
+    bool m_dragging;
+
+    ///> Offset from the dragged item's center (anchor)
+    wxPoint m_offset;
+
+    ///> Last cursor position (needed for getModificationPoint() to avoid changes
+    ///> of edit reference point).
+    VECTOR2I m_cursor;
+
+    /// Edit module mode flag
+    bool m_editModules;
+
+    /// Counter of undo inhibitions. When zero, undo is not inhibited.
+    int m_undoInhibit;
+
+    // Vector storing track & via types, used for specifying 'Properties' menu entry condition
+    std::vector<KICAD_T> m_tracksViasType;
+
+    ///> Removes and frees a single BOARD_ITEM.
+    void remove( BOARD_ITEM* aItem );
+
+    ///> The required update flag for modified items
+    KIGFX::VIEW_ITEM::VIEW_UPDATE_FLAGS m_updateFlag;
+
+    ///> Enables higher order update flag
+    void enableUpdateFlag( KIGFX::VIEW_ITEM::VIEW_UPDATE_FLAGS aFlag )
+    {
+        if( m_updateFlag < aFlag )
+            m_updateFlag = aFlag;
+    }
+
+    ///> Updates ratsnest for selected items.
+    ///> @param aRedraw says if selected items should be drawn using the simple mode (e.g. one line
+    ///> per item).
+    void updateRatsnest( bool aRedraw );
+
+    ///> Returns the right modification point (e.g. for rotation), depending on the number of
+    ///> selected items.
+    wxPoint getModificationPoint( const SELECTION& aSelection );
+
+    ///> If there are no items currently selected, it tries to choose the item that is under
+    ///> the cursor or displays a disambiguation menu if there are multpile items.
+    bool hoverSelection( const SELECTION& aSelection, bool aSanitize = true );
+
+    ///> Processes the current undo buffer since the last change. If the last change does not occur
+    ///> in the current buffer, then the whole list is processed.
+    void processUndoBuffer( const PICKED_ITEMS_LIST* aLastChange );
+
+    ///> Updates items stored in the list.
+    void processPickedList( const PICKED_ITEMS_LIST* aList );
+
+    /**
+     * Increments the undo inhibit counter. This will indicate that tools
+     * should not create an undo point, as another tool is doing it already,
+     * and considers that its operation is atomic, even if it calls another one
+     * (for example a duplicate calls a move).
+     */
+    inline void incUndoInhibit()
+    {
+        m_undoInhibit++;
+    }
+
+    /**
+     * Decrements the inhibit counter. An assert is raised if the counter drops
+     * below zero.
+     */
+    inline void decUndoInhibit()
+    {
+        m_undoInhibit--;
+
+        wxASSERT_MSG( m_undoInhibit >= 0, wxT( "Undo inhibit count decremented past zero" ) );
+    }
+
+    /**
+     * Report if the tool manager has been told at least once that undo
+     * points should not be created. This can be ignored if the undo point
+     * is still required.
+     *
+     * @return true if undo are inhibited
+     */
+    inline bool isUndoInhibited() const
+    {
+        return m_undoInhibit > 0;
+    }
+
+    int editFootprintInFpEditor( const TOOL_EVENT& aEvent );
+
+    bool invokeInlineRouter();
+
+    template<class T> T* uniqueSelected()
+    {
+        const SELECTION& selection = m_selectionTool->GetSelection();
+
+        if( selection.items.GetCount() != 1 )
+            return NULL;
+
+        BOARD_ITEM* item = selection.Item<BOARD_ITEM>( 0 );
+        return dyn_cast<T*>( item );
+    }
+};
+
+#endif