2013-12-09 10:01:05 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
2015-03-03 10:55:23 +00:00
|
|
|
* Copyright (C) 2013-2015 CERN
|
2013-12-09 10:01:05 +00:00
|
|
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
2015-03-03 10:55:23 +00:00
|
|
|
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
|
2013-12-09 10:01:05 +00:00
|
|
|
*
|
|
|
|
* 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>
|
2016-05-10 16:09:39 +00:00
|
|
|
#include <tools/pcb_tool.h>
|
2018-03-09 06:25:06 +00:00
|
|
|
#include <tools/selection_tool.h>
|
2013-12-09 10:01:05 +00:00
|
|
|
|
2017-08-03 15:53:07 +00:00
|
|
|
|
2016-06-21 15:06:28 +00:00
|
|
|
class BOARD_COMMIT;
|
2013-12-09 10:01:05 +00:00
|
|
|
class BOARD_ITEM;
|
2017-03-22 13:43:10 +00:00
|
|
|
class CONNECTIVITY_DATA;
|
2013-12-09 10:01:05 +00:00
|
|
|
|
2018-03-09 06:25:06 +00:00
|
|
|
/**
|
|
|
|
* Function SanitizePadsEnsureEditableFilter
|
|
|
|
*
|
|
|
|
* A CLIENT_SELECTION_FILTER which promotes pad selections to their parent modules and
|
|
|
|
* excludes non-editable items (such as markers).
|
|
|
|
*/
|
|
|
|
void SanitizePadsEnsureEditableFilter( const VECTOR2I&, GENERAL_COLLECTOR& items );
|
|
|
|
|
|
|
|
void SanitizePadsFilter( const VECTOR2I&, GENERAL_COLLECTOR& items );
|
|
|
|
|
|
|
|
void EnsureEditableFilter( const VECTOR2I&, GENERAL_COLLECTOR& items );
|
|
|
|
|
|
|
|
|
2013-12-09 10:01:05 +00:00
|
|
|
/**
|
|
|
|
* Class EDIT_TOOL
|
|
|
|
*
|
2018-04-08 10:28:58 +00:00
|
|
|
* The interactive edit tool. Allows one to move, rotate, flip and change properties of items selected
|
2013-12-09 10:01:05 +00:00
|
|
|
* using the pcbnew.InteractiveSelection tool.
|
|
|
|
*/
|
|
|
|
|
2016-05-10 16:09:39 +00:00
|
|
|
class EDIT_TOOL : public PCB_TOOL
|
2013-12-09 10:01:05 +00:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
EDIT_TOOL();
|
|
|
|
|
|
|
|
/// @copydoc TOOL_INTERACTIVE::Reset()
|
2016-09-24 18:53:15 +00:00
|
|
|
void Reset( RESET_REASON aReason ) override;
|
2013-12-09 10:01:05 +00:00
|
|
|
|
|
|
|
/// @copydoc TOOL_INTERACTIVE::Init()
|
2016-09-24 18:53:15 +00:00
|
|
|
bool Init() override;
|
2013-12-09 10:01:05 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function Main()
|
|
|
|
*
|
|
|
|
* Main loop in which events are handled.
|
|
|
|
* @param aEvent is the handled event.
|
|
|
|
*/
|
2015-02-14 20:28:47 +00:00
|
|
|
int Main( const TOOL_EVENT& aEvent );
|
2013-12-09 10:01:05 +00:00
|
|
|
|
2017-08-03 15:53:07 +00:00
|
|
|
/**
|
|
|
|
* Function Drag()
|
|
|
|
*
|
|
|
|
* todo
|
|
|
|
*/
|
|
|
|
int Drag( const TOOL_EVENT& aEvent );
|
|
|
|
|
2013-12-09 10:01:05 +00:00
|
|
|
/**
|
|
|
|
* Function Edit()
|
|
|
|
*
|
|
|
|
* Displays properties window for the selected object.
|
|
|
|
*/
|
2015-02-14 20:28:47 +00:00
|
|
|
int Properties( const TOOL_EVENT& aEvent );
|
2013-12-09 10:01:05 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function Rotate()
|
|
|
|
*
|
|
|
|
* Rotates currently selected items.
|
|
|
|
*/
|
2015-02-14 20:28:47 +00:00
|
|
|
int Rotate( const TOOL_EVENT& aEvent );
|
2013-12-09 10:01:05 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function Flip()
|
|
|
|
*
|
|
|
|
* Rotates currently selected items. The rotation point is the current cursor position.
|
|
|
|
*/
|
2015-02-14 20:28:47 +00:00
|
|
|
int Flip( const TOOL_EVENT& aEvent );
|
2013-12-09 10:01:05 +00:00
|
|
|
|
2017-01-23 06:47:39 +00:00
|
|
|
/**
|
|
|
|
* Function Mirror
|
|
|
|
*
|
|
|
|
* Mirrors the current selection. The mirror axis passes through the current point.
|
|
|
|
*/
|
|
|
|
int Mirror( const TOOL_EVENT& aEvent );
|
|
|
|
|
2013-12-09 10:01:05 +00:00
|
|
|
/**
|
|
|
|
* Function Remove()
|
|
|
|
*
|
|
|
|
* Deletes currently selected items. The rotation point is the current cursor position.
|
|
|
|
*/
|
2015-02-14 20:28:47 +00:00
|
|
|
int Remove( const TOOL_EVENT& aEvent );
|
2015-02-12 03:22:24 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function Duplicate()
|
|
|
|
*
|
2017-06-12 09:16:30 +00:00
|
|
|
* Duplicates the current selection and starts a move action.
|
2015-02-12 03:22:24 +00:00
|
|
|
*/
|
2015-02-18 19:27:00 +00:00
|
|
|
int Duplicate( const TOOL_EVENT& aEvent );
|
2015-02-12 03:22:24 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function MoveExact()
|
|
|
|
*
|
|
|
|
* Invokes a dialog box to allow moving of the item by an exact amount.
|
|
|
|
*/
|
2015-02-18 19:27:00 +00:00
|
|
|
int MoveExact( const TOOL_EVENT& aEvent );
|
2015-02-12 03:22:24 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function CreateArray()
|
|
|
|
*
|
|
|
|
* Creates an array of the selected items, invoking the array editor dialog
|
|
|
|
* to set the array options
|
|
|
|
*/
|
2015-02-18 19:27:00 +00:00
|
|
|
int CreateArray( const TOOL_EVENT& aEvent );
|
2013-12-09 10:01:05 +00:00
|
|
|
|
2017-01-31 08:03:07 +00:00
|
|
|
/**
|
|
|
|
* Function ExchangeFootprints()
|
|
|
|
*
|
2018-01-12 19:36:15 +00:00
|
|
|
* Invoke the dialog used to update or exchange the footprints used for
|
|
|
|
* modules. The mode depends on the PCB_ACTIONS held by the TOOL_EVENT.
|
2017-01-31 08:03:07 +00:00
|
|
|
*/
|
|
|
|
int ExchangeFootprints( const TOOL_EVENT& aEvent );
|
2014-07-09 12:01:06 +00:00
|
|
|
|
2017-03-09 09:09:13 +00:00
|
|
|
///> Launches a tool to measure between points
|
|
|
|
int MeasureTool( const TOOL_EVENT& aEvent );
|
|
|
|
|
2018-01-05 23:44:37 +00:00
|
|
|
/**
|
|
|
|
* Function FootprintFilter()
|
|
|
|
*
|
|
|
|
* A selection filter which prunes the selection to contain only items
|
|
|
|
* of type PCB_MODULE_T
|
|
|
|
*/
|
|
|
|
static void FootprintFilter( const VECTOR2I&, GENERAL_COLLECTOR& aCollector );
|
|
|
|
|
2015-04-30 08:46:03 +00:00
|
|
|
///> Sets up handlers for various events.
|
2017-07-31 12:30:51 +00:00
|
|
|
void setTransitions() override;
|
2015-04-30 08:46:03 +00:00
|
|
|
|
2017-09-17 17:49:06 +00:00
|
|
|
/**
|
|
|
|
* Function copyToClipboard()
|
|
|
|
* Sends the current selection to the clipboard by formatting it as a fake pcb
|
|
|
|
* see AppendBoardFromClipboard for importing
|
|
|
|
* @return True if it was sent succesfully
|
|
|
|
*/
|
|
|
|
int copyToClipboard( const TOOL_EVENT& aEvent );
|
|
|
|
|
2018-08-22 18:05:40 +00:00
|
|
|
int copyToClipboardWithAnchor( const TOOL_EVENT& aEvent );
|
|
|
|
|
|
|
|
int doCopyToClipboard( bool withAnchor );
|
|
|
|
|
2017-09-17 17:49:06 +00:00
|
|
|
/**
|
|
|
|
* Function cutToClipboard()
|
2017-09-29 09:40:10 +00:00
|
|
|
* Cuts the current selection to the clipboard by formatting it as a fake pcb
|
2017-09-17 17:49:06 +00:00
|
|
|
* see AppendBoardFromClipboard for importing
|
|
|
|
* @return True if it was sent succesfully
|
|
|
|
*/
|
|
|
|
int cutToClipboard( const TOOL_EVENT& aEvent );
|
|
|
|
|
2017-09-22 15:17:38 +00:00
|
|
|
BOARD_COMMIT* GetCurrentCommit() const
|
|
|
|
{
|
|
|
|
return m_commit.get();
|
|
|
|
}
|
|
|
|
|
2013-12-09 10:01:05 +00:00
|
|
|
private:
|
|
|
|
///> Selection tool used for obtaining selected items
|
|
|
|
SELECTION_TOOL* m_selectionTool;
|
|
|
|
|
2018-03-09 06:25:06 +00:00
|
|
|
CLIENT_SELECTION_FILTER m_defaultSelectionFilter;
|
|
|
|
|
2013-12-09 10:01:05 +00:00
|
|
|
///> Flag determining if anything is being dragged right now
|
|
|
|
bool m_dragging;
|
|
|
|
|
2014-05-13 09:22:51 +00:00
|
|
|
///> Last cursor position (needed for getModificationPoint() to avoid changes
|
|
|
|
///> of edit reference point).
|
2014-05-13 09:22:51 +00:00
|
|
|
VECTOR2I m_cursor;
|
|
|
|
|
2014-02-04 16:27:00 +00:00
|
|
|
///> Returns the right modification point (e.g. for rotation), depending on the number of
|
|
|
|
///> selected items.
|
2017-09-28 16:38:54 +00:00
|
|
|
bool updateModificationPoint( SELECTION& aSelection );
|
2014-02-04 16:27:00 +00:00
|
|
|
|
2015-02-18 00:10:20 +00:00
|
|
|
int editFootprintInFpEditor( const TOOL_EVENT& aEvent );
|
|
|
|
|
2017-08-03 15:53:07 +00:00
|
|
|
bool invokeInlineRouter( int aDragMode );
|
2017-08-22 14:44:47 +00:00
|
|
|
bool isInteractiveDragEnabled() const;
|
2017-08-03 15:53:07 +00:00
|
|
|
|
|
|
|
bool changeTrackWidthOnClick( const SELECTION& selection );
|
2017-09-22 15:17:38 +00:00
|
|
|
bool pickCopyReferencePoint( VECTOR2I& aP );
|
2017-08-03 15:53:07 +00:00
|
|
|
|
2016-06-21 15:06:28 +00:00
|
|
|
std::unique_ptr<BOARD_COMMIT> m_commit;
|
2013-12-09 10:01:05 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|