2013-08-02 14:53:50 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2013 CERN
|
|
|
|
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
|
2013-09-19 15:02:57 +00:00
|
|
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
2013-08-02 14:53:50 +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 __SELECTION_TOOL_H
|
|
|
|
#define __SELECTION_TOOL_H
|
|
|
|
|
|
|
|
#include <math/vector2d.h>
|
|
|
|
#include <tool/tool_interactive.h>
|
2013-09-26 16:38:58 +00:00
|
|
|
#include <tool/context_menu.h>
|
2013-12-18 13:33:34 +00:00
|
|
|
#include <class_undoredo_container.h>
|
2013-08-02 14:53:50 +00:00
|
|
|
|
|
|
|
class SELECTION_AREA;
|
|
|
|
class BOARD_ITEM;
|
|
|
|
class GENERAL_COLLECTOR;
|
|
|
|
|
2013-10-14 14:13:35 +00:00
|
|
|
namespace KIGFX
|
2013-10-02 08:21:05 +00:00
|
|
|
{
|
|
|
|
class VIEW_GROUP;
|
|
|
|
}
|
|
|
|
|
2013-08-02 14:53:50 +00:00
|
|
|
/**
|
2013-08-06 07:31:08 +00:00
|
|
|
* Class SELECTION_TOOL
|
2013-08-02 14:53:50 +00:00
|
|
|
*
|
|
|
|
* Our sample selection tool: currently supports:
|
|
|
|
* - pick single objects (click LMB)
|
|
|
|
* - add objects to existing selection (Shift+LMB)
|
|
|
|
* - draw selection box (drag LMB)
|
2013-09-19 15:02:57 +00:00
|
|
|
* - handles MODULEs properly (ie. selects either MODULE or its PADs, TEXTs, etc.)
|
|
|
|
* - takes into account high-contrast & layer visibility settings
|
2013-12-03 15:09:03 +00:00
|
|
|
* - invokes InteractiveEdit tool when user starts to drag selected items
|
2013-08-02 14:53:50 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
class SELECTION_TOOL : public TOOL_INTERACTIVE
|
|
|
|
{
|
2013-08-06 07:31:08 +00:00
|
|
|
public:
|
2013-08-09 13:04:10 +00:00
|
|
|
SELECTION_TOOL();
|
|
|
|
~SELECTION_TOOL();
|
2013-08-02 14:53:50 +00:00
|
|
|
|
2013-10-02 08:21:05 +00:00
|
|
|
struct SELECTION
|
|
|
|
{
|
|
|
|
/// Set of selected items
|
2013-12-18 13:33:34 +00:00
|
|
|
PICKED_ITEMS_LIST items;
|
2013-10-02 08:21:05 +00:00
|
|
|
|
|
|
|
/// VIEW_GROUP that holds currently selected items
|
2013-10-14 14:13:35 +00:00
|
|
|
KIGFX::VIEW_GROUP* group;
|
2013-10-02 08:21:05 +00:00
|
|
|
|
|
|
|
/// Checks if there is anything selected
|
2013-12-03 14:17:43 +00:00
|
|
|
bool Empty() const
|
|
|
|
{
|
2013-12-18 13:33:34 +00:00
|
|
|
return ( items.GetCount() == 0 );
|
2013-12-03 14:17:43 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Returns the number of selected parts
|
|
|
|
int Size() const
|
|
|
|
{
|
2013-12-18 13:33:34 +00:00
|
|
|
return items.GetCount();
|
2013-12-03 14:17:43 +00:00
|
|
|
}
|
2013-12-03 16:11:22 +00:00
|
|
|
|
2014-02-04 10:37:54 +00:00
|
|
|
private:
|
2013-12-03 16:11:22 +00:00
|
|
|
/// Clears both the VIEW_GROUP and set of selected items. Please note that it does not
|
|
|
|
/// change properties of selected items (e.g. selection flag).
|
2014-02-04 10:37:54 +00:00
|
|
|
void clear();
|
|
|
|
|
|
|
|
friend class SELECTION_TOOL;
|
2013-10-02 08:21:05 +00:00
|
|
|
};
|
|
|
|
|
2013-09-26 16:38:58 +00:00
|
|
|
/// @copydoc TOOL_INTERACTIVE::Reset()
|
2013-12-09 09:42:38 +00:00
|
|
|
void Reset( RESET_REASON aReason );
|
2013-09-04 08:56:06 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function Main()
|
|
|
|
*
|
|
|
|
* The main loop.
|
|
|
|
*/
|
2013-08-08 12:59:59 +00:00
|
|
|
int Main( TOOL_EVENT& aEvent );
|
2013-09-04 08:56:06 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function GetSelection()
|
|
|
|
*
|
|
|
|
* Returns the set of currently selected items.
|
|
|
|
*/
|
2013-10-02 08:21:05 +00:00
|
|
|
const SELECTION& GetSelection() const
|
2013-08-30 08:23:18 +00:00
|
|
|
{
|
2013-10-02 08:21:05 +00:00
|
|
|
return m_selection;
|
2013-08-30 08:23:18 +00:00
|
|
|
}
|
2013-08-02 14:53:50 +00:00
|
|
|
|
2013-09-26 16:38:58 +00:00
|
|
|
/**
|
2013-12-18 13:33:34 +00:00
|
|
|
* Function AddMenuItem()
|
2013-09-26 16:38:58 +00:00
|
|
|
*
|
|
|
|
* Adds a menu entry to run a TOOL_ACTION on selected items.
|
|
|
|
* @param aAction is a menu entry to be added.
|
|
|
|
*/
|
|
|
|
void AddMenuItem( const TOOL_ACTION& aAction );
|
|
|
|
|
2013-08-06 07:31:08 +00:00
|
|
|
private:
|
2013-09-04 08:56:06 +00:00
|
|
|
/**
|
|
|
|
* Function selectSingle()
|
|
|
|
* Selects an item pointed by the parameter aWhere. If there is more than one item at that
|
|
|
|
* place, there is a menu displayed that allows to choose the item.
|
|
|
|
*
|
|
|
|
* @param aWhere is the place where the item should be selected.
|
|
|
|
*/
|
2013-08-09 08:18:48 +00:00
|
|
|
void selectSingle( const VECTOR2I& aWhere );
|
2013-09-04 08:56:06 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function selectMultiple()
|
|
|
|
* Handles drawing a selection box that allows to select many items at the same time.
|
2013-09-06 14:04:12 +00:00
|
|
|
*
|
|
|
|
* @return true if the function was cancelled (ie. CancelEvent was received).
|
2013-09-04 08:56:06 +00:00
|
|
|
*/
|
2013-09-06 14:04:12 +00:00
|
|
|
bool selectMultiple();
|
2013-09-04 08:56:06 +00:00
|
|
|
|
2014-02-04 15:03:56 +00:00
|
|
|
/**
|
|
|
|
* Function ClearSelection()
|
|
|
|
* Clears the current selection.
|
|
|
|
*/
|
|
|
|
void clearSelection();
|
|
|
|
|
2013-09-04 08:56:06 +00:00
|
|
|
/**
|
|
|
|
* Function disambiguationMenu()
|
|
|
|
* Handles the menu that allows to select one of many items in case there is more than one
|
|
|
|
* item at the selected point (@see selectSingle()).
|
|
|
|
*
|
|
|
|
* @param aItems contains list of items that are displayed to the user.
|
|
|
|
*/
|
2013-08-06 08:30:09 +00:00
|
|
|
BOARD_ITEM* disambiguationMenu( GENERAL_COLLECTOR* aItems );
|
2013-09-04 08:56:06 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function pickSmallestComponent()
|
|
|
|
* Allows to find the smallest (in terms of bounding box area) item from the list.
|
|
|
|
*
|
|
|
|
* @param aCollector containes the list of items.
|
|
|
|
*/
|
2013-08-06 07:31:08 +00:00
|
|
|
BOARD_ITEM* pickSmallestComponent( GENERAL_COLLECTOR* aCollector );
|
2013-09-04 08:56:06 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function toggleSelection()
|
|
|
|
* Changes selection status of a given item.
|
|
|
|
*
|
|
|
|
* @param aItem is the item to have selection status changed.
|
|
|
|
*/
|
2013-08-09 08:18:48 +00:00
|
|
|
void toggleSelection( BOARD_ITEM* aItem );
|
2013-09-04 08:56:06 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function selectable()
|
|
|
|
* Checks conditions for an item to be selected.
|
|
|
|
*
|
|
|
|
* @return True if the item fulfills conditions to be selected.
|
|
|
|
*/
|
2013-09-26 12:09:56 +00:00
|
|
|
bool selectable( const BOARD_ITEM* aItem ) const;
|
2013-09-04 08:56:06 +00:00
|
|
|
|
2013-09-26 16:38:58 +00:00
|
|
|
/**
|
|
|
|
* Function selectItem()
|
|
|
|
* Takes necessary action mark an item as selected.
|
|
|
|
*
|
|
|
|
* @param aItem is an item to be selected.
|
|
|
|
*/
|
2013-12-18 13:33:34 +00:00
|
|
|
void select( BOARD_ITEM* aItem );
|
2013-09-26 16:38:58 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function deselectItem()
|
|
|
|
* Takes necessary action mark an item as deselected.
|
|
|
|
*
|
|
|
|
* @param aItem is an item to be deselected.
|
|
|
|
*/
|
2013-12-18 13:33:34 +00:00
|
|
|
void deselect( BOARD_ITEM* aItem );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function deselectVisually()
|
|
|
|
* Marks item as selected, but does not add it to the ITEMS_PICKED_LIST.
|
|
|
|
* @param aItem is an item to be be marked.
|
|
|
|
*/
|
|
|
|
void selectVisually( BOARD_ITEM* aItem ) const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function deselectVisually()
|
|
|
|
* Marks item as selected, but does not add it to the ITEMS_PICKED_LIST.
|
|
|
|
* @param aItem is an item to be be marked.
|
|
|
|
*/
|
|
|
|
void deselectVisually( BOARD_ITEM* aItem ) const;
|
2013-09-26 16:38:58 +00:00
|
|
|
|
2013-09-19 15:02:57 +00:00
|
|
|
/**
|
|
|
|
* Function containsSelected()
|
|
|
|
* Checks if the given point is placed within any of selected items' bounding box.
|
|
|
|
*
|
|
|
|
* @return True if the given point is contained in any of selected items' bouding box.
|
|
|
|
*/
|
|
|
|
bool containsSelected( const VECTOR2I& aPoint ) const;
|
|
|
|
|
|
|
|
/// Visual representation of selection box
|
2013-08-06 07:31:08 +00:00
|
|
|
SELECTION_AREA* m_selArea;
|
2013-09-04 08:56:06 +00:00
|
|
|
|
2013-10-02 08:21:05 +00:00
|
|
|
/// Current state of selection
|
|
|
|
SELECTION m_selection;
|
|
|
|
|
2013-09-04 08:56:06 +00:00
|
|
|
/// Flag saying if items should be added to the current selection or rather replace it
|
2013-08-09 08:18:48 +00:00
|
|
|
bool m_additive;
|
2013-09-09 08:10:02 +00:00
|
|
|
|
|
|
|
/// Flag saying if multiple selection mode is active
|
|
|
|
bool m_multiple;
|
2013-09-19 15:02:57 +00:00
|
|
|
|
2013-09-26 16:38:58 +00:00
|
|
|
/// Right click popup menu
|
|
|
|
CONTEXT_MENU m_menu;
|
2013-08-02 14:53:50 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|