edit_tool.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013-2020 CERN
 * Copyright (C) 2013-2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 * @author Tomasz Wlostowski <[email protected]>
 *
 * 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_base.h>
#include <tools/pcb_selection_tool.h>
#include <status_popup.h>
#include <unordered_set>
 
 
class BOARD_COMMIT;
class BOARD_ITEM;
class CONNECTIVITY_DATA;
class STATUS_TEXT_POPUP;
 
namespace KIGFX::PREVIEW
{
    class RULER_ITEM;
}
 
 
class EDIT_TOOL : public PCB_TOOL_BASE
{
public:
    EDIT_TOOL();
 
    void Reset( RESET_REASON aReason ) override;
 
    bool Init() override;
 
    int GetAndPlace( const TOOL_EVENT& aEvent );
 
    int Move( const TOOL_EVENT& aEvent );
 
    int Drag( const TOOL_EVENT& aEvent );
 
    int DragArcTrack( const TOOL_EVENT& aTrack );
 
    int Properties( const TOOL_EVENT& aEvent );
 
    int Rotate( const TOOL_EVENT& aEvent );
 
    int Flip( const TOOL_EVENT& aEvent );
 
    int Mirror( const TOOL_EVENT& aEvent );
 
    static const std::vector<KICAD_T> MirrorableItems;
 
    int JustifyText( const TOOL_EVENT& aEvent );
 
    int Swap( const TOOL_EVENT& aEvent );
 
    int PackAndMoveFootprints( const TOOL_EVENT& aEvent );
 
    int ChangeTrackWidth( const TOOL_EVENT& aEvent );
 
    int FilletTracks( const TOOL_EVENT& aEvent );
 
    int ModifyLines( const TOOL_EVENT& aEvent );
 
    int HealShapes( const TOOL_EVENT& aEvent );
 
    int SimplifyPolygons( const TOOL_EVENT& aEvent );
 
    int OutsetItems( const TOOL_EVENT& aEvent );
 
    int BooleanPolygons( const TOOL_EVENT& aEvent );
 
    int Remove( const TOOL_EVENT& aEvent );
 
    void DeleteItems( const PCB_SELECTION& aItem, bool aIsCut );
 
    int Duplicate( const TOOL_EVENT& aItem );
 
    int MoveExact( const TOOL_EVENT& aEvent );
 
    int Increment( const TOOL_EVENT& aEvent );
 
    static void FootprintFilter( const VECTOR2I&, GENERAL_COLLECTOR& aCollector,
                                 PCB_SELECTION_TOOL* sTool );
 
    static void PadFilter( const VECTOR2I&, GENERAL_COLLECTOR& aCollector,
                           PCB_SELECTION_TOOL* sTool );
 
private:
    void setTransitions() override;
 
    int copyToClipboard( const TOOL_EVENT& aEvent );
 
    int copyToClipboardAsText( const TOOL_EVENT& aEvent );
 
    int cutToClipboard( const TOOL_EVENT& aEvent );
 
    bool updateModificationPoint( PCB_SELECTION& aSelection );
 
    bool invokeInlineRouter( int aDragMode );
    bool isRouterActive() const;
 
    VECTOR2I getSafeMovement( const VECTOR2I& aMovement, const BOX2I& aSourceBBox,
                              const VECTOR2D& aBBoxOffset );
 
    bool pickReferencePoint( const wxString& aTooltip, const wxString& aSuccessMessage,
                             const wxString& aCanceledMessage, VECTOR2I& aReferencePoint );
 
    bool doMoveSelection( const TOOL_EVENT& aEvent, BOARD_COMMIT* aCommit, bool aAutoStart );
 
    void rebuildConnectivity();
 
    void removeNonRootItems( std::unordered_set<EDA_ITEM*>& items );
 
    void getChildItemsOfGroupsAndGenerators( EDA_ITEM*                        item,
                                             std::unordered_set<BOARD_ITEM*>& children );
 
 
private:
    PCB_SELECTION_TOOL*   m_selectionTool;
    bool                  m_dragging;         // Indicates objects are currently being dragged
    VECTOR2I              m_cursor;           // Last cursor position (so getModificationPoint()
                                              // can avoid changes of edit reference point).
    std::unique_ptr<STATUS_TEXT_POPUP> m_statusPopup;
 
    static const unsigned int COORDS_PADDING; // Padding from coordinates limits for this tool
};
 
#endif