kicad/pcbnew/tools/edit_tool.h

/*
 * 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 <tools/pcb_tool.h>

class BOARD_COMMIT;
class BOARD_ITEM;
class SELECTION_TOOL;

/**
 * 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 PCB_TOOL
{
public:
    EDIT_TOOL();

    /// @copydoc TOOL_INTERACTIVE::Reset()
    void Reset( RESET_REASON aReason ) override;

    /// @copydoc TOOL_INTERACTIVE::Init()
    bool Init() override;

    /**
     * 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 Mirror
     *
     * Mirrors the current selection. The mirror axis passes through the current point.
     */
    int Mirror( 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 ExchangeFootprints()
     *
     * Invoke the dialog used to change the footprints used for modules
     * and update module footprints based on result
     */
    int ExchangeFootprints( const TOOL_EVENT& aEvent );

    ///> Sets up handlers for various events.
    void SetTransitions() override;

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;

    ///> 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 );

    int editFootprintInFpEditor( const TOOL_EVENT& aEvent );

    bool invokeInlineRouter();

    /**
     * Function hoverSelection()
     *
     * If there are no items currently selected, it tries to choose the
     * item that is under he cursor or displays a disambiguation menu
     * if there are multiple items.
     *
     * @param aSanitize sanitize selection using SanitizeSelection()
     * @return true if the eventual selection contains any items, or
     * false if it fails to select any items.
     */
    bool hoverSelection( bool aSanitize = true );

    /**
     * Function uniqueSelected()
     *
     * Get a single selected item of a certain type
     *
     * @tparam T type of item to select
     * @return pointer to the item (of type T), or nullptr if there isn't
     * a single selected item, or it's not of the right type.
     */
    template<class T>
    T* uniqueSelected()
    {
        const SELECTION& selection = m_selectionTool->GetSelection();

        if( selection.Size() != 1 )
            return nullptr;

        auto item = selection[0];
        return dyn_cast<T*>( item );
    }

    /**
     * Function uniqueHoverSelection()
     *
     * Get a single unique selection of an item, either from the
     * current selection, or from the items under cursor via
     * hoverSelection()
     *
     * @tparam T type of item to select
     * @return pointer to a selected item, or nullptr if none could
     * be found.
     */
    template<class T>
    T* uniqueHoverSelection( bool aSanitize = true )
    {
        if( !hoverSelection( aSanitize ) )
            return nullptr;

        T* item = uniqueSelected<T>();

        return item;
    }

    std::unique_ptr<BOARD_COMMIT> m_commit;
};

#endif