1989 lines
55 KiB
C++
1989 lines
55 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2013-2017 CERN
|
|
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
|
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
|
* Copyright (C) 2017 KiCad Developers, see CHANGELOG.TXT for contributors.
|
|
*
|
|
* 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
|
|
*/
|
|
#include <limits>
|
|
|
|
#include <functional>
|
|
using namespace std::placeholders;
|
|
|
|
#include <class_board.h>
|
|
#include <class_board_item.h>
|
|
#include <class_track.h>
|
|
#include <class_module.h>
|
|
#include <class_pcb_text.h>
|
|
#include <class_drawsegment.h>
|
|
|
|
#include <wxPcbStruct.h>
|
|
#include <collectors.h>
|
|
#include <confirm.h>
|
|
#include <dialog_find.h>
|
|
#include <dialog_block_options.h>
|
|
|
|
#include <class_draw_panel_gal.h>
|
|
#include <view/view_controls.h>
|
|
#include <view/view_group.h>
|
|
#include <preview_items/selection_area.h>
|
|
#include <painter.h>
|
|
#include <bitmaps.h>
|
|
#include <hotkeys.h>
|
|
|
|
#include <tool/tool_event.h>
|
|
#include <tool/tool_manager.h>
|
|
#include <ratsnest_data.h>
|
|
|
|
#include "selection_tool.h"
|
|
#include "pcb_bright_box.h"
|
|
#include "pcb_actions.h"
|
|
|
|
// Selection tool actions
|
|
TOOL_ACTION PCB_ACTIONS::selectionActivate( "pcbnew.InteractiveSelection",
|
|
AS_GLOBAL, 0,
|
|
"", "", NULL, AF_ACTIVATE ); // No description, it is not supposed to be shown anywhere
|
|
|
|
TOOL_ACTION PCB_ACTIONS::selectionCursor( "pcbnew.InteractiveSelection.Cursor",
|
|
AS_GLOBAL, 0,
|
|
"", "" ); // No description, it is not supposed to be shown anywhere
|
|
|
|
TOOL_ACTION PCB_ACTIONS::selectItem( "pcbnew.InteractiveSelection.SelectItem",
|
|
AS_GLOBAL, 0,
|
|
"", "" ); // No description, it is not supposed to be shown anywhere
|
|
|
|
TOOL_ACTION PCB_ACTIONS::unselectItem( "pcbnew.InteractiveSelection.UnselectItem",
|
|
AS_GLOBAL, 0,
|
|
"", "" ); // No description, it is not supposed to be shown anywhere
|
|
|
|
TOOL_ACTION PCB_ACTIONS::selectionClear( "pcbnew.InteractiveSelection.Clear",
|
|
AS_GLOBAL, 0,
|
|
"", "" ); // No description, it is not supposed to be shown anywhere
|
|
|
|
TOOL_ACTION PCB_ACTIONS::selectConnection( "pcbnew.InteractiveSelection.SelectConnection",
|
|
AS_GLOBAL, 'U',
|
|
_( "Trivial Connection" ), _( "Selects a connection between two junctions." ) );
|
|
|
|
TOOL_ACTION PCB_ACTIONS::selectCopper( "pcbnew.InteractiveSelection.SelectCopper",
|
|
AS_GLOBAL, 'I',
|
|
_( "Copper Connection" ), _( "Selects whole copper connection." ) );
|
|
|
|
TOOL_ACTION PCB_ACTIONS::selectNet( "pcbnew.InteractiveSelection.SelectNet",
|
|
AS_GLOBAL, 0,
|
|
_( "Whole Net" ), _( "Selects all tracks & vias belonging to the same net." ) );
|
|
|
|
TOOL_ACTION PCB_ACTIONS::selectOnSheetFromEeschema( "pcbnew.InteractiveSelection.SelectOnSheet",
|
|
AS_GLOBAL, 0,
|
|
_( "Sheet" ), _( "Selects all modules and tracks in the schematic sheet" ) );
|
|
|
|
TOOL_ACTION PCB_ACTIONS::selectSameSheet( "pcbnew.InteractiveSelection.SelectSameSheet",
|
|
AS_GLOBAL, 0,
|
|
_( "Items in Same Hierarchical Sheet" ),
|
|
_( "Selects all modules and tracks in the same schematic sheet" ) );
|
|
|
|
TOOL_ACTION PCB_ACTIONS::find( "pcbnew.InteractiveSelection.Find",
|
|
AS_GLOBAL, 0, //TOOL_ACTION::LegacyHotKey( HK_FIND_ITEM ), // handled by wxWidgets
|
|
_( "Find Item" ),_( "Searches the document for an item" ), find_xpm );
|
|
|
|
TOOL_ACTION PCB_ACTIONS::findMove( "pcbnew.InteractiveSelection.FindMove",
|
|
AS_GLOBAL, TOOL_ACTION::LegacyHotKey( HK_GET_AND_MOVE_FOOTPRINT ) );
|
|
|
|
TOOL_ACTION PCB_ACTIONS::filterSelection( "pcbnew.InteractiveSelection.FilterSelection",
|
|
AS_GLOBAL, 0,
|
|
_( "Filter Selection" ), _( "Filter the types of items in the selection" ),
|
|
nullptr );
|
|
|
|
|
|
|
|
class SELECT_MENU: public CONTEXT_MENU
|
|
{
|
|
public:
|
|
SELECT_MENU()
|
|
{
|
|
SetTitle( _( "Select..." ) );
|
|
|
|
Add( PCB_ACTIONS::filterSelection );
|
|
|
|
AppendSeparator();
|
|
|
|
Add( PCB_ACTIONS::selectConnection );
|
|
Add( PCB_ACTIONS::selectCopper );
|
|
Add( PCB_ACTIONS::selectNet );
|
|
Add( PCB_ACTIONS::selectSameSheet );
|
|
}
|
|
|
|
private:
|
|
|
|
void update() override
|
|
{
|
|
using S_C = SELECTION_CONDITIONS;
|
|
|
|
const auto& selection = getToolManager()->GetTool<SELECTION_TOOL>()->GetSelection();
|
|
|
|
bool connItem = ( S_C::OnlyType( PCB_VIA_T ) || S_C::OnlyType( PCB_TRACE_T ) )( selection );
|
|
bool sheetSelEnabled = ( S_C::OnlyType( PCB_MODULE_T ) )( selection );
|
|
|
|
Enable( getMenuId( PCB_ACTIONS::selectNet ), connItem );
|
|
Enable( getMenuId( PCB_ACTIONS::selectCopper ), connItem );
|
|
Enable( getMenuId( PCB_ACTIONS::selectConnection ), connItem );
|
|
Enable( getMenuId( PCB_ACTIONS::selectSameSheet ), sheetSelEnabled );
|
|
}
|
|
|
|
CONTEXT_MENU* create() const override
|
|
{
|
|
return new SELECT_MENU();
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Private implementation of firewalled private data
|
|
*/
|
|
class SELECTION_TOOL::PRIV
|
|
{
|
|
public:
|
|
DIALOG_BLOCK_OPTIONS::OPTIONS m_filterOpts;
|
|
};
|
|
|
|
|
|
SELECTION_TOOL::SELECTION_TOOL() :
|
|
PCB_TOOL( "pcbnew.InteractiveSelection" ),
|
|
m_frame( NULL ), m_additive( false ), m_subtractive( false ),
|
|
m_multiple( false ),
|
|
m_locked( true ), m_menu( *this ),
|
|
m_priv( std::make_unique<PRIV>() )
|
|
{
|
|
|
|
}
|
|
|
|
|
|
SELECTION_TOOL::~SELECTION_TOOL()
|
|
{
|
|
getView()->Remove( &m_selection );
|
|
}
|
|
|
|
|
|
bool SELECTION_TOOL::Init()
|
|
{
|
|
auto selectMenu = std::make_shared<SELECT_MENU>();
|
|
selectMenu->SetTool( this );
|
|
m_menu.AddSubMenu( selectMenu );
|
|
|
|
auto& menu = m_menu.GetMenu();
|
|
|
|
menu.AddMenu( selectMenu.get(), false, SELECTION_CONDITIONS::NotEmpty );
|
|
// only show separator if there is a Select menu to show above it
|
|
menu.AddSeparator( SELECTION_CONDITIONS::NotEmpty, 1000 );
|
|
|
|
m_menu.AddStandardSubMenus( *getEditFrame<PCB_BASE_FRAME>() );
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void SELECTION_TOOL::Reset( RESET_REASON aReason )
|
|
{
|
|
m_frame = getEditFrame<PCB_BASE_FRAME>();
|
|
m_locked = true;
|
|
|
|
if( aReason == TOOL_BASE::MODEL_RELOAD )
|
|
{
|
|
// Remove pointers to the selected items from containers
|
|
// without changing their properties (as they are already deleted
|
|
// while a new board is loaded)
|
|
m_selection.Clear();
|
|
getView()->GetPainter()->GetSettings()->SetHighlight( false );
|
|
}
|
|
else
|
|
// Restore previous properties of selected items and remove them from containers
|
|
clearSelection();
|
|
|
|
// Reinsert the VIEW_GROUP, in case it was removed from the VIEW
|
|
getView()->Remove( &m_selection );
|
|
getView()->Add( &m_selection );
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::Main( const TOOL_EVENT& aEvent )
|
|
{
|
|
// Main loop: keep receiving events
|
|
while( OPT_TOOL_EVENT evt = Wait() )
|
|
{
|
|
// Should selected items be added to the current selection or
|
|
// become the new selection (discarding previously selected items)
|
|
m_additive = evt->Modifier( MD_SHIFT );
|
|
|
|
// Should selected items be REMOVED from the current selection?
|
|
// This will be ignored if the SHIFT modifier is pressed
|
|
m_subtractive = !m_additive && evt->Modifier( MD_CTRL );
|
|
|
|
// single click? Select single object
|
|
if( evt->IsClick( BUT_LEFT ) )
|
|
{
|
|
if( evt->Modifier( MD_CTRL ) && !m_editModules )
|
|
{
|
|
m_toolMgr->RunAction( PCB_ACTIONS::highlightNet, true );
|
|
}
|
|
else
|
|
{
|
|
if( !m_additive )
|
|
clearSelection();
|
|
|
|
selectPoint( evt->Position() );
|
|
}
|
|
}
|
|
|
|
// right click? if there is any object - show the context menu
|
|
else if( evt->IsClick( BUT_RIGHT ) )
|
|
{
|
|
bool emptySelection = m_selection.Empty();
|
|
|
|
if( emptySelection )
|
|
selectPoint( evt->Position() );
|
|
|
|
m_menu.ShowContextMenu( m_selection );
|
|
}
|
|
|
|
// double click? Display the properties window
|
|
else if( evt->IsDblClick( BUT_LEFT ) )
|
|
{
|
|
if( m_selection.Empty() )
|
|
selectPoint( evt->Position() );
|
|
|
|
m_toolMgr->RunAction( PCB_ACTIONS::properties );
|
|
}
|
|
|
|
// drag with LMB? Select multiple objects (or at least draw a selection box) or drag them
|
|
else if( evt->IsDrag( BUT_LEFT ) )
|
|
{
|
|
if( m_additive || m_subtractive )
|
|
{
|
|
selectMultiple();
|
|
}
|
|
else if( m_selection.Empty() )
|
|
{
|
|
// There is nothing selected, so try to select something
|
|
if( !selectCursor() )
|
|
{
|
|
// If nothings has been selected or user wants to select more
|
|
// draw the selection box
|
|
selectMultiple();
|
|
}
|
|
else
|
|
{
|
|
m_toolMgr->InvokeTool( "pcbnew.InteractiveEdit" );
|
|
}
|
|
}
|
|
|
|
else
|
|
{
|
|
// Check if dragging has started within any of selected items bounding box
|
|
if( selectionContains( evt->Position() ) )
|
|
{
|
|
// Yes -> run the move tool and wait till it finishes
|
|
m_toolMgr->InvokeTool( "pcbnew.InteractiveEdit" );
|
|
}
|
|
else
|
|
{
|
|
// No -> clear the selection list
|
|
clearSelection();
|
|
}
|
|
}
|
|
}
|
|
|
|
else if( evt->IsCancel() || evt->Action() == TA_UNDO_REDO_PRE )
|
|
{
|
|
clearSelection();
|
|
}
|
|
|
|
else if( evt->Action() == TA_CONTEXT_MENU_CLOSED )
|
|
{
|
|
m_menu.CloseContextMenu( evt );
|
|
}
|
|
}
|
|
|
|
// This tool is supposed to be active forever
|
|
assert( false );
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
SELECTION& SELECTION_TOOL::GetSelection()
|
|
{
|
|
return m_selection;
|
|
}
|
|
|
|
|
|
SELECTION& SELECTION_TOOL::RequestSelection( int aFlags )
|
|
{
|
|
if ( m_selection.Empty() )
|
|
{
|
|
m_toolMgr->RunAction( PCB_ACTIONS::selectionCursor, true, 0 );
|
|
m_selection.SetIsHover( true );
|
|
}
|
|
else
|
|
{
|
|
m_selection.SetIsHover( false );
|
|
}
|
|
|
|
// Be careful with iterators: items can be removed from list
|
|
// that invalidate iterators.
|
|
for( unsigned ii = 0; ii < m_selection.GetSize(); ii++ )
|
|
{
|
|
EDA_ITEM* item = m_selection[ii];
|
|
|
|
if( ( aFlags & SELECTION_EDITABLE ) && item->Type() == PCB_MARKER_T )
|
|
{
|
|
unselect( static_cast<BOARD_ITEM *>( item ) );
|
|
}
|
|
}
|
|
|
|
if ( aFlags & SELECTION_SANITIZE_PADS )
|
|
SanitizeSelection();
|
|
|
|
return m_selection;
|
|
}
|
|
|
|
|
|
void SELECTION_TOOL::toggleSelection( BOARD_ITEM* aItem )
|
|
{
|
|
if( aItem->IsSelected() )
|
|
{
|
|
unselect( aItem );
|
|
|
|
// Inform other potentially interested tools
|
|
m_toolMgr->ProcessEvent( UnselectedEvent );
|
|
}
|
|
else
|
|
{
|
|
if( !m_additive )
|
|
clearSelection();
|
|
|
|
// Prevent selection of invisible or inactive items
|
|
if( selectable( aItem ) )
|
|
{
|
|
select( aItem );
|
|
|
|
// Inform other potentially interested tools
|
|
m_toolMgr->ProcessEvent( SelectedEvent );
|
|
}
|
|
}
|
|
|
|
m_frame->GetGalCanvas()->ForceRefresh();
|
|
}
|
|
|
|
|
|
bool SELECTION_TOOL::selectPoint( const VECTOR2I& aWhere, bool aOnDrag )
|
|
{
|
|
BOARD_ITEM* item;
|
|
GENERAL_COLLECTORS_GUIDE guide = m_frame->GetCollectorsGuide();
|
|
GENERAL_COLLECTOR collector;
|
|
|
|
collector.Collect( board(),
|
|
m_editModules ? GENERAL_COLLECTOR::ModuleItems : GENERAL_COLLECTOR::AllBoardItems,
|
|
wxPoint( aWhere.x, aWhere.y ), guide );
|
|
|
|
bool anyCollected = collector.GetCount() != 0;
|
|
|
|
// Remove unselectable items
|
|
for( int i = collector.GetCount() - 1; i >= 0; --i )
|
|
{
|
|
if( !selectable( collector[i] ) || ( aOnDrag && collector[i]->IsLocked() ) )
|
|
collector.Remove( i );
|
|
}
|
|
|
|
switch( collector.GetCount() )
|
|
{
|
|
case 0:
|
|
if( !m_additive && anyCollected )
|
|
clearSelection();
|
|
|
|
return false;
|
|
|
|
case 1:
|
|
toggleSelection( collector[0] );
|
|
|
|
return true;
|
|
|
|
default:
|
|
// Apply some ugly heuristics to avoid disambiguation menus whenever possible
|
|
guessSelectionCandidates( collector );
|
|
|
|
// Let's see if there is still disambiguation in selection..
|
|
if( collector.GetCount() == 1 )
|
|
{
|
|
toggleSelection( collector[0] );
|
|
|
|
return true;
|
|
}
|
|
else if( collector.GetCount() > 1 )
|
|
{
|
|
if( aOnDrag )
|
|
Wait( TOOL_EVENT( TC_ANY, TA_MOUSE_UP, BUT_LEFT ) );
|
|
|
|
item = disambiguationMenu( &collector );
|
|
|
|
if( item )
|
|
{
|
|
toggleSelection( item );
|
|
|
|
return true;
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SELECTION_TOOL::selectCursor( bool aSelectAlways )
|
|
{
|
|
if( aSelectAlways || m_selection.Empty() )
|
|
{
|
|
clearSelection();
|
|
selectPoint( getViewControls()->GetCursorPosition() );
|
|
}
|
|
|
|
return !m_selection.Empty();
|
|
}
|
|
|
|
|
|
bool SELECTION_TOOL::selectMultiple()
|
|
{
|
|
bool cancelled = false; // Was the tool cancelled while it was running?
|
|
m_multiple = true; // Multiple selection mode is active
|
|
KIGFX::VIEW* view = getView();
|
|
getViewControls()->SetAutoPan( true );
|
|
|
|
KIGFX::PREVIEW::SELECTION_AREA area;
|
|
view->Add( &area );
|
|
|
|
while( OPT_TOOL_EVENT evt = Wait() )
|
|
{
|
|
if( evt->IsCancel() )
|
|
{
|
|
cancelled = true;
|
|
break;
|
|
}
|
|
|
|
if( evt->IsDrag( BUT_LEFT ) )
|
|
{
|
|
|
|
// Start drawing a selection box
|
|
area.SetOrigin( evt->DragOrigin() );
|
|
area.SetEnd( evt->Position() );
|
|
area.SetAdditive( m_additive );
|
|
area.SetSubtractive( m_subtractive );
|
|
|
|
view->SetVisible( &area, true );
|
|
view->Update( &area );
|
|
}
|
|
|
|
if( evt->IsMouseUp( BUT_LEFT ) )
|
|
{
|
|
// End drawing the selection box
|
|
view->SetVisible( &area, false );
|
|
|
|
// Mark items within the selection box as selected
|
|
std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> selectedItems;
|
|
|
|
// Filter the view items based on the selection box
|
|
BOX2I selectionBox = area.ViewBBox();
|
|
view->Query( selectionBox, selectedItems ); // Get the list of selected items
|
|
|
|
std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR>::iterator it, it_end;
|
|
|
|
int width = area.GetEnd().x - area.GetOrigin().x;
|
|
int height = area.GetEnd().y - area.GetOrigin().y;
|
|
|
|
// Construct an EDA_RECT to determine BOARD_ITEM selection
|
|
EDA_RECT selectionRect( wxPoint( area.GetOrigin().x, area.GetOrigin().y ),
|
|
wxSize( width, height ) );
|
|
|
|
selectionRect.Normalize();
|
|
|
|
for( it = selectedItems.begin(), it_end = selectedItems.end(); it != it_end; ++it )
|
|
{
|
|
BOARD_ITEM* item = static_cast<BOARD_ITEM*>( it->first );
|
|
|
|
if( !item || !selectable( item ) )
|
|
continue;
|
|
|
|
/* Selection mode depends on direction of drag-selection:
|
|
* Left > Right : Select objects that are fully enclosed by selection
|
|
* Right > Left : Select objects that are crossed by selection
|
|
*/
|
|
|
|
if( width >= 0 )
|
|
{
|
|
if( selectionBox.Contains( item->ViewBBox() ) )
|
|
{
|
|
if( m_subtractive )
|
|
unselect( item );
|
|
else
|
|
select( item );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if( item->HitTest( selectionRect, false ) )
|
|
{
|
|
if( m_subtractive )
|
|
unselect( item );
|
|
else
|
|
select( item );
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
if( m_selection.Size() == 1 )
|
|
m_frame->SetCurItem( static_cast<BOARD_ITEM*>( m_selection.Front() ) );
|
|
else
|
|
m_frame->SetCurItem( NULL );
|
|
|
|
// Inform other potentially interested tools
|
|
if( !m_selection.Empty() )
|
|
m_toolMgr->ProcessEvent( SelectedEvent );
|
|
|
|
break; // Stop waiting for events
|
|
}
|
|
}
|
|
|
|
// Stop drawing the selection box
|
|
view->Remove( &area );
|
|
m_multiple = false; // Multiple selection mode is inactive
|
|
getViewControls()->SetAutoPan( false );
|
|
|
|
return cancelled;
|
|
}
|
|
|
|
|
|
void SELECTION_TOOL::SetTransitions()
|
|
{
|
|
Go( &SELECTION_TOOL::Main, PCB_ACTIONS::selectionActivate.MakeEvent() );
|
|
Go( &SELECTION_TOOL::CursorSelection, PCB_ACTIONS::selectionCursor.MakeEvent() );
|
|
Go( &SELECTION_TOOL::ClearSelection, PCB_ACTIONS::selectionClear.MakeEvent() );
|
|
Go( &SELECTION_TOOL::SelectItem, PCB_ACTIONS::selectItem.MakeEvent() );
|
|
Go( &SELECTION_TOOL::UnselectItem, PCB_ACTIONS::unselectItem.MakeEvent() );
|
|
Go( &SELECTION_TOOL::find, PCB_ACTIONS::find.MakeEvent() );
|
|
Go( &SELECTION_TOOL::findMove, PCB_ACTIONS::findMove.MakeEvent() );
|
|
Go( &SELECTION_TOOL::filterSelection, PCB_ACTIONS::filterSelection.MakeEvent() );
|
|
Go( &SELECTION_TOOL::selectConnection, PCB_ACTIONS::selectConnection.MakeEvent() );
|
|
Go( &SELECTION_TOOL::selectCopper, PCB_ACTIONS::selectCopper.MakeEvent() );
|
|
Go( &SELECTION_TOOL::selectNet, PCB_ACTIONS::selectNet.MakeEvent() );
|
|
Go( &SELECTION_TOOL::selectSameSheet, PCB_ACTIONS::selectSameSheet.MakeEvent() );
|
|
Go( &SELECTION_TOOL::selectOnSheetFromEeschema, PCB_ACTIONS::selectOnSheetFromEeschema.MakeEvent() );
|
|
Go( &SELECTION_TOOL::updateSelection, PCB_ACTIONS::selectionModified.MakeEvent() );
|
|
}
|
|
|
|
|
|
SELECTION_LOCK_FLAGS SELECTION_TOOL::CheckLock()
|
|
{
|
|
if( !m_locked || m_editModules )
|
|
return SELECTION_UNLOCKED;
|
|
|
|
bool containsLocked = false;
|
|
|
|
// Check if the selection contains locked items
|
|
for( const auto& item : m_selection )
|
|
{
|
|
switch( item->Type() )
|
|
{
|
|
case PCB_MODULE_T:
|
|
if( static_cast<MODULE*>( item )->IsLocked() )
|
|
containsLocked = true;
|
|
break;
|
|
|
|
case PCB_MODULE_EDGE_T:
|
|
case PCB_MODULE_TEXT_T:
|
|
if( static_cast<MODULE*>( item->GetParent() )->IsLocked() )
|
|
containsLocked = true;
|
|
break;
|
|
|
|
default: // suppress warnings
|
|
break;
|
|
}
|
|
}
|
|
|
|
if( containsLocked )
|
|
{
|
|
if( IsOK( m_frame, _( "Selection contains locked items. Do you want to continue?" ) ) )
|
|
{
|
|
m_locked = false;
|
|
return SELECTION_LOCK_OVERRIDE;
|
|
}
|
|
else
|
|
return SELECTION_LOCKED;
|
|
}
|
|
|
|
m_locked = false;
|
|
|
|
return SELECTION_UNLOCKED;
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::CursorSelection( const TOOL_EVENT& aEvent )
|
|
{
|
|
bool sanitize = (bool) aEvent.Parameter<intptr_t>();
|
|
|
|
if( m_selection.Empty() ) // Try to find an item that could be modified
|
|
{
|
|
selectCursor( true );
|
|
|
|
if( CheckLock() == SELECTION_LOCKED )
|
|
{
|
|
clearSelection();
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
if( sanitize )
|
|
SanitizeSelection();
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::ClearSelection( const TOOL_EVENT& aEvent )
|
|
{
|
|
clearSelection();
|
|
|
|
return 0;
|
|
}
|
|
|
|
int SELECTION_TOOL::SelectItem( const TOOL_EVENT& aEvent )
|
|
{
|
|
// Check if there is an item to be selected
|
|
BOARD_ITEM* item = aEvent.Parameter<BOARD_ITEM*>();
|
|
|
|
if( item )
|
|
{
|
|
select( item );
|
|
|
|
// Inform other potentially interested tools
|
|
m_toolMgr->ProcessEvent( SelectedEvent );
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::UnselectItem( const TOOL_EVENT& aEvent )
|
|
{
|
|
// Check if there is an item to be selected
|
|
BOARD_ITEM* item = aEvent.Parameter<BOARD_ITEM*>();
|
|
|
|
if( item )
|
|
{
|
|
unselect( item );
|
|
|
|
// Inform other potentially interested tools
|
|
m_toolMgr->ProcessEvent( UnselectedEvent );
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::selectConnection( const TOOL_EVENT& aEvent )
|
|
{
|
|
if( !selectCursor() )
|
|
return 0;
|
|
|
|
// copy the selection, since we're going to iterate and modify
|
|
auto selection = m_selection.GetItems();
|
|
|
|
for( auto item : selection )
|
|
{
|
|
// only TRACK items can be checked for trivial connections
|
|
if( item->Type() == PCB_TRACE_T || item->Type() == PCB_VIA_T )
|
|
{
|
|
TRACK& trackItem = static_cast<TRACK&>( *item );
|
|
selectAllItemsConnectedToTrack( trackItem );
|
|
}
|
|
}
|
|
|
|
// Inform other potentially interested tools
|
|
if( m_selection.Size() > 0 )
|
|
m_toolMgr->ProcessEvent( SelectedEvent );
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::selectCopper( const TOOL_EVENT& aEvent )
|
|
{
|
|
if( !selectCursor() )
|
|
return 0;
|
|
|
|
// copy the selection, since we're going to iterate and modify
|
|
auto selection = m_selection.GetItems();
|
|
|
|
for( auto i : selection )
|
|
{
|
|
auto item = static_cast<BOARD_ITEM*>( i );
|
|
// only connected items can be traversed in the ratsnest
|
|
if( item->IsConnected() )
|
|
{
|
|
auto& connItem = static_cast<BOARD_CONNECTED_ITEM&>( *item );
|
|
|
|
selectAllItemsConnectedToItem( connItem );
|
|
}
|
|
}
|
|
|
|
// Inform other potentially interested tools
|
|
if( m_selection.Size() > 0 )
|
|
m_toolMgr->ProcessEvent( SelectedEvent );
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
void SELECTION_TOOL::selectAllItemsConnectedToTrack( TRACK& aSourceTrack )
|
|
{
|
|
int segmentCount;
|
|
TRACK* trackList = board()->MarkTrace( &aSourceTrack, &segmentCount,
|
|
nullptr, nullptr, true );
|
|
|
|
for( int i = 0; i < segmentCount; ++i )
|
|
{
|
|
select( trackList );
|
|
trackList = trackList->Next();
|
|
}
|
|
}
|
|
|
|
|
|
void SELECTION_TOOL::selectAllItemsConnectedToItem( BOARD_CONNECTED_ITEM& aSourceItem )
|
|
{
|
|
RN_DATA* ratsnest = getModel<BOARD>()->GetRatsnest();
|
|
std::list<BOARD_CONNECTED_ITEM*> itemsList;
|
|
ratsnest->GetConnectedItems( &aSourceItem, itemsList, (RN_ITEM_TYPE)( RN_TRACKS | RN_VIAS ) );
|
|
|
|
for( BOARD_CONNECTED_ITEM* i : itemsList )
|
|
select( i );
|
|
}
|
|
|
|
|
|
void SELECTION_TOOL::selectAllItemsOnNet( int aNetCode )
|
|
{
|
|
RN_DATA* ratsnest = getModel<BOARD>()->GetRatsnest();
|
|
std::list<BOARD_CONNECTED_ITEM*> itemsList;
|
|
|
|
ratsnest->GetNetItems( aNetCode, itemsList, (RN_ITEM_TYPE)( RN_TRACKS | RN_VIAS ) );
|
|
|
|
for( BOARD_CONNECTED_ITEM* i : itemsList )
|
|
select( i );
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::selectNet( const TOOL_EVENT& aEvent )
|
|
{
|
|
if( !selectCursor() )
|
|
return 0;
|
|
|
|
// copy the selection, since we're going to iterate and modify
|
|
auto selection = m_selection.GetItems();
|
|
|
|
for( auto i : selection )
|
|
{
|
|
auto item = static_cast<BOARD_ITEM*>( i );
|
|
// only connected items get a net code
|
|
if( item->IsConnected() )
|
|
{
|
|
auto& connItem = static_cast<BOARD_CONNECTED_ITEM&>( *item );
|
|
|
|
selectAllItemsOnNet( connItem.GetNetCode() );
|
|
}
|
|
}
|
|
|
|
// Inform other potentially interested tools
|
|
if( m_selection.Size() > 0 )
|
|
m_toolMgr->ProcessEvent( SelectedEvent );
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
void SELECTION_TOOL::selectAllItemsOnSheet( wxString& aSheetpath )
|
|
{
|
|
auto modules = board()->m_Modules.GetFirst();
|
|
std::list<MODULE*> modList;
|
|
|
|
// store all modules that are on that sheet
|
|
for( MODULE* mitem = modules; mitem; mitem = mitem->Next() )
|
|
{
|
|
if( mitem != NULL && mitem->GetPath().Contains( aSheetpath ) )
|
|
{
|
|
modList.push_back( mitem );
|
|
}
|
|
}
|
|
|
|
//Generate a list of all pads, and of all nets they belong to.
|
|
std::list<int> netcodeList;
|
|
for( MODULE* mmod : modList )
|
|
{
|
|
for( D_PAD* pad = mmod->Pads().GetFirst(); pad; pad = pad->Next() )
|
|
{
|
|
if( pad->IsConnected() )
|
|
{
|
|
netcodeList.push_back( pad->GetNetCode() );
|
|
}
|
|
}
|
|
}
|
|
|
|
// remove all duplicates
|
|
netcodeList.sort();
|
|
netcodeList.unique();
|
|
|
|
// now we need to find all modules that are connected to each of these nets
|
|
// then we need to determine if these modules are in the list of modules
|
|
// belonging to this sheet ( modList )
|
|
RN_DATA* ratsnest = getModel<BOARD>()->GetRatsnest();
|
|
std::list<int> removeCodeList;
|
|
for( int netCode : netcodeList )
|
|
{
|
|
std::list<BOARD_CONNECTED_ITEM*> netPads;
|
|
ratsnest->GetNetItems( netCode, netPads, (RN_ITEM_TYPE)( RN_PADS ) );
|
|
for( BOARD_CONNECTED_ITEM* mitem : netPads )
|
|
{
|
|
bool found = ( std::find( modList.begin(), modList.end(), mitem->GetParent() ) != modList.end() );
|
|
if( !found )
|
|
{
|
|
// if we cannot find the module of the pad in the modList
|
|
// then we can assume that that module is not located in the same
|
|
// schematic, therefore invalidate this netcode.
|
|
removeCodeList.push_back( netCode );
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// remove all duplicates
|
|
removeCodeList.sort();
|
|
removeCodeList.unique();
|
|
|
|
for( int removeCode : removeCodeList )
|
|
{
|
|
netcodeList.remove( removeCode );
|
|
}
|
|
|
|
std::list<BOARD_CONNECTED_ITEM*> localConnectionList;
|
|
for( int netCode : netcodeList )
|
|
{
|
|
ratsnest->GetNetItems( netCode, localConnectionList, (RN_ITEM_TYPE)( RN_TRACKS | RN_VIAS ) );
|
|
}
|
|
|
|
for( BOARD_ITEM* i : modList )
|
|
{
|
|
if( i != NULL )
|
|
select( i );
|
|
}
|
|
for( BOARD_CONNECTED_ITEM* i : localConnectionList )
|
|
{
|
|
if( i != NULL )
|
|
select( i );
|
|
}
|
|
}
|
|
|
|
void SELECTION_TOOL::zoomFitSelection( void )
|
|
{
|
|
//Should recalculate the view to zoom in on the selection
|
|
auto selectionBox = m_selection.ViewBBox();
|
|
auto canvas = m_frame->GetGalCanvas();
|
|
auto view = getView();
|
|
|
|
VECTOR2D screenSize = view->ToWorld( canvas->GetClientSize(), false );
|
|
|
|
if( !( selectionBox.GetWidth() == 0 ) || !( selectionBox.GetHeight() == 0 ) )
|
|
{
|
|
VECTOR2D vsize = selectionBox.GetSize();
|
|
double scale = view->GetScale() / std::max( fabs( vsize.x / screenSize.x ),
|
|
fabs( vsize.y / screenSize.y ) );
|
|
view->SetScale( scale );
|
|
view->SetCenter( selectionBox.Centre() );
|
|
view->Add( &m_selection );
|
|
}
|
|
|
|
m_frame->GetGalCanvas()->ForceRefresh();
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::selectOnSheetFromEeschema( const TOOL_EVENT& aEvent )
|
|
{
|
|
clearSelection();
|
|
wxString* sheetpath = aEvent.Parameter<wxString*>();
|
|
|
|
selectAllItemsOnSheet( *sheetpath );
|
|
|
|
zoomFitSelection();
|
|
|
|
if( m_selection.Size() > 0 )
|
|
m_toolMgr->ProcessEvent( SelectedEvent );
|
|
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::selectSameSheet( const TOOL_EVENT& aEvent )
|
|
{
|
|
if( !selectCursor( true ) )
|
|
return 0;
|
|
|
|
// this function currently only supports modules since they are only
|
|
// on one sheet.
|
|
auto item = m_selection.Front();
|
|
|
|
if( !item )
|
|
return 0;
|
|
|
|
if( item->Type() != PCB_MODULE_T )
|
|
return 0;
|
|
|
|
auto mod = dynamic_cast<MODULE*>( item );
|
|
|
|
clearSelection();
|
|
|
|
// get the lowest subsheet name for this.
|
|
wxString sheetPath = mod->GetPath();
|
|
sheetPath = sheetPath.BeforeLast( '/' );
|
|
sheetPath = sheetPath.AfterLast( '/' );
|
|
|
|
selectAllItemsOnSheet( sheetPath );
|
|
|
|
// Inform other potentially interested tools
|
|
if( m_selection.Size() > 0 )
|
|
m_toolMgr->ProcessEvent( SelectedEvent );
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
void SELECTION_TOOL::findCallback( BOARD_ITEM* aItem )
|
|
{
|
|
clearSelection();
|
|
|
|
if( aItem )
|
|
{
|
|
select( aItem );
|
|
EDA_RECT bbox = aItem->GetBoundingBox();
|
|
BOX2D viewport( VECTOR2D( bbox.GetOrigin() ), VECTOR2D( bbox.GetSize() ) );
|
|
getView()->SetViewport( viewport );
|
|
|
|
// Inform other potentially interested tools
|
|
m_toolMgr->ProcessEvent( SelectedEvent );
|
|
}
|
|
|
|
m_frame->GetGalCanvas()->ForceRefresh();
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::find( const TOOL_EVENT& aEvent )
|
|
{
|
|
DIALOG_FIND dlg( m_frame );
|
|
dlg.EnableWarp( false );
|
|
dlg.SetCallback( std::bind( &SELECTION_TOOL::findCallback, this, _1 ) );
|
|
dlg.ShowModal();
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::findMove( const TOOL_EVENT& aEvent )
|
|
{
|
|
MODULE* module = m_frame->GetFootprintFromBoardByReference();
|
|
|
|
if( module )
|
|
{
|
|
clearSelection();
|
|
toggleSelection( module );
|
|
|
|
// Place event on module origin first, so the generic anchor snap
|
|
// doesn't just choose the closest pin for us
|
|
// Don't warp the view - we want the component to
|
|
// "teleport" to cursor, not move to the components position
|
|
getViewControls()->ForceCursorPosition( true, module->GetPosition() );
|
|
|
|
// pick the component up and start moving
|
|
m_toolMgr->InvokeTool( "pcbnew.InteractiveEdit" );
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
/**
|
|
* Function itemIsIncludedByFilter()
|
|
*
|
|
* Determine if an item is included by the filter specified
|
|
*
|
|
* @return true if the parameter indicate the items should be selected
|
|
* by this filter (i..e not filtered out)
|
|
*/
|
|
static bool itemIsIncludedByFilter( const BOARD_ITEM& aItem,
|
|
const BOARD& aBoard,
|
|
const LSET& aTechnlLayerMask,
|
|
const DIALOG_BLOCK_OPTIONS::OPTIONS& aBlockOpts )
|
|
{
|
|
bool include = true;
|
|
const PCB_LAYER_ID layer = aItem.GetLayer();
|
|
|
|
// can skip without even checking item type
|
|
if( !aBlockOpts.includeItemsOnInvisibleLayers
|
|
&& !aBoard.IsLayerVisible( layer ) )
|
|
{
|
|
include = false;
|
|
}
|
|
|
|
// if the item needsto be checked agains the options
|
|
if( include )
|
|
{
|
|
switch( aItem.Type() )
|
|
{
|
|
case PCB_MODULE_T:
|
|
{
|
|
const auto& module = static_cast<const MODULE&>( aItem );
|
|
|
|
include = aBlockOpts.includeModules;
|
|
|
|
if( include && !aBlockOpts.includeLockedModules )
|
|
{
|
|
include = !module.IsLocked();
|
|
}
|
|
|
|
break;
|
|
}
|
|
case PCB_TRACE_T:
|
|
{
|
|
include = aBlockOpts.includeTracks;
|
|
break;
|
|
}
|
|
case PCB_ZONE_AREA_T:
|
|
{
|
|
include = aBlockOpts.includeZones;
|
|
break;
|
|
}
|
|
case PCB_LINE_T:
|
|
case PCB_TARGET_T:
|
|
case PCB_DIMENSION_T:
|
|
{
|
|
include = aTechnlLayerMask[layer];
|
|
break;
|
|
}
|
|
case PCB_TEXT_T:
|
|
{
|
|
include = aBlockOpts.includePcbTexts
|
|
&& aTechnlLayerMask[layer];
|
|
break;
|
|
}
|
|
default:
|
|
{
|
|
// no filterering, just select it
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
return include;
|
|
}
|
|
|
|
|
|
/**
|
|
* Gets the technical layers that are part of the given selection opts
|
|
*/
|
|
static LSET getFilteredLayerSet(
|
|
const DIALOG_BLOCK_OPTIONS::OPTIONS& blockOpts )
|
|
{
|
|
LSET layerMask( Edge_Cuts );
|
|
|
|
if( blockOpts.includeItemsOnTechLayers )
|
|
layerMask.set();
|
|
|
|
if( !blockOpts.includeBoardOutlineLayer )
|
|
layerMask.set( Edge_Cuts, false );
|
|
|
|
return layerMask;
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::filterSelection( const TOOL_EVENT& aEvent )
|
|
{
|
|
auto& opts = m_priv->m_filterOpts;
|
|
DIALOG_BLOCK_OPTIONS dlg( m_frame, opts, false, _( "Filter selection" ) );
|
|
|
|
const int cmd = dlg.ShowModal();
|
|
|
|
if( cmd != wxID_OK )
|
|
return 0;
|
|
|
|
const auto& board = *getModel<BOARD>();
|
|
const auto layerMask = getFilteredLayerSet( opts );
|
|
|
|
// copy current selection
|
|
auto selection = m_selection.GetItems();
|
|
|
|
// clear current selection
|
|
clearSelection();
|
|
|
|
// copy selection items from the saved selection
|
|
// according to the dialog options
|
|
for( auto i : selection )
|
|
{
|
|
auto item = static_cast<BOARD_ITEM*>( i );
|
|
bool include = itemIsIncludedByFilter( *item, board, layerMask, opts );
|
|
|
|
if( include )
|
|
{
|
|
select( item );
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
|
|
void SELECTION_TOOL::clearSelection()
|
|
{
|
|
if( m_selection.Empty() )
|
|
return;
|
|
|
|
for( auto item : m_selection )
|
|
unselectVisually( static_cast<BOARD_ITEM*>( item ) );
|
|
|
|
m_selection.Clear();
|
|
|
|
m_frame->SetCurItem( NULL );
|
|
m_locked = true;
|
|
|
|
// Inform other potentially interested tools
|
|
m_toolMgr->ProcessEvent( ClearedEvent );
|
|
}
|
|
|
|
|
|
BOARD_ITEM* SELECTION_TOOL::disambiguationMenu( GENERAL_COLLECTOR* aCollector )
|
|
{
|
|
BOARD_ITEM* current = NULL;
|
|
PCB_BRIGHT_BOX brightBox;
|
|
CONTEXT_MENU menu;
|
|
|
|
getView()->Add( &brightBox );
|
|
|
|
int limit = std::min( 10, aCollector->GetCount() );
|
|
|
|
for( int i = 0; i < limit; ++i )
|
|
{
|
|
wxString text;
|
|
BOARD_ITEM* item = ( *aCollector )[i];
|
|
text = item->GetSelectMenuText();
|
|
menu.Add( text, i + 1 );
|
|
}
|
|
|
|
menu.SetTitle( _( "Clarify selection" ) );
|
|
menu.DisplayTitle( true );
|
|
SetContextMenu( &menu, CMENU_NOW );
|
|
|
|
while( OPT_TOOL_EVENT evt = Wait() )
|
|
{
|
|
if( evt->Action() == TA_CONTEXT_MENU_UPDATE )
|
|
{
|
|
if( current )
|
|
current->ClearBrightened();
|
|
|
|
int id = *evt->GetCommandId();
|
|
|
|
// User has pointed an item, so show it in a different way
|
|
if( id > 0 && id <= limit )
|
|
{
|
|
current = ( *aCollector )[id - 1];
|
|
current->SetBrightened();
|
|
}
|
|
else
|
|
{
|
|
current = NULL;
|
|
}
|
|
}
|
|
else if( evt->Action() == TA_CONTEXT_MENU_CHOICE )
|
|
{
|
|
boost::optional<int> id = evt->GetCommandId();
|
|
|
|
// User has selected an item, so this one will be returned
|
|
if( id && ( *id > 0 ) )
|
|
current = ( *aCollector )[*id - 1];
|
|
else
|
|
current = NULL;
|
|
|
|
break;
|
|
}
|
|
|
|
// Draw a mark to show which item is available to be selected
|
|
if( current && current->IsBrightened() )
|
|
{
|
|
brightBox.SetItem( current );
|
|
getView()->SetVisible( &brightBox, true );
|
|
// getView()->Hide( &brightBox, false );
|
|
getView()->Update( &brightBox, KIGFX::GEOMETRY );
|
|
getView()->MarkTargetDirty( KIGFX::TARGET_OVERLAY );
|
|
}
|
|
}
|
|
|
|
getView()->Remove( &brightBox );
|
|
|
|
|
|
return current;
|
|
}
|
|
|
|
|
|
BOARD_ITEM* SELECTION_TOOL::pickSmallestComponent( GENERAL_COLLECTOR* aCollector )
|
|
{
|
|
int count = aCollector->GetPrimaryCount(); // try to use preferred layer
|
|
|
|
if( 0 == count )
|
|
count = aCollector->GetCount();
|
|
|
|
for( int i = 0; i < count; ++i )
|
|
{
|
|
if( ( *aCollector )[i]->Type() != PCB_MODULE_T )
|
|
return NULL;
|
|
}
|
|
|
|
// All are modules, now find smallest MODULE
|
|
int minDim = 0x7FFFFFFF;
|
|
int minNdx = 0;
|
|
|
|
for( int i = 0; i < count; ++i )
|
|
{
|
|
MODULE* module = (MODULE*) ( *aCollector )[i];
|
|
|
|
int lx = module->GetBoundingBox().GetWidth();
|
|
int ly = module->GetBoundingBox().GetHeight();
|
|
|
|
int lmin = std::min( lx, ly );
|
|
|
|
if( lmin < minDim )
|
|
{
|
|
minDim = lmin;
|
|
minNdx = i;
|
|
}
|
|
}
|
|
|
|
return (*aCollector)[minNdx];
|
|
}
|
|
|
|
|
|
bool SELECTION_TOOL::selectable( const BOARD_ITEM* aItem ) const
|
|
{
|
|
// Is high contrast mode enabled?
|
|
bool highContrast = getView()->GetPainter()->GetSettings()->GetHighContrast();
|
|
|
|
if( highContrast )
|
|
{
|
|
bool onActive = false; // Is the item on any of active layers?
|
|
int layers[KIGFX::VIEW::VIEW_MAX_LAYERS], layers_count;
|
|
|
|
// Filter out items that do not belong to active layers
|
|
const std::set<unsigned int>& activeLayers = getView()->GetPainter()->
|
|
GetSettings()->GetActiveLayers();
|
|
aItem->ViewGetLayers( layers, layers_count );
|
|
|
|
for( int i = 0; i < layers_count; ++i )
|
|
{
|
|
if( activeLayers.count( layers[i] ) > 0 ) // Item is on at least one of the active layers
|
|
{
|
|
onActive = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if( !onActive ) // We do not want to select items that are in the background
|
|
return false;
|
|
}
|
|
|
|
switch( aItem->Type() )
|
|
{
|
|
case PCB_VIA_T:
|
|
{
|
|
// For vias it is enough if only one of layers is visible
|
|
PCB_LAYER_ID top, bottom;
|
|
|
|
static_cast<const VIA*>( aItem )->LayerPair( &top, &bottom );
|
|
|
|
return board()->IsLayerVisible( top ) || board()->IsLayerVisible( bottom );
|
|
}
|
|
break;
|
|
|
|
case PCB_MODULE_T:
|
|
|
|
// In the module editor, we do not want to select the module itself
|
|
// rather, the module sub-components should be selected individually
|
|
if( m_editModules )
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if( aItem->IsOnLayer( F_Cu ) && board()->IsElementVisible( LAYER_MOD_FR ) )
|
|
return !m_editModules;
|
|
|
|
if( aItem->IsOnLayer( B_Cu ) && board()->IsElementVisible( LAYER_MOD_BK ) )
|
|
return !m_editModules;
|
|
|
|
return false;
|
|
|
|
break;
|
|
|
|
case PCB_MODULE_TEXT_T:
|
|
if( m_multiple && !m_editModules )
|
|
return false;
|
|
|
|
return view()->IsVisible( aItem ) && board()->IsLayerVisible( aItem->GetLayer() );
|
|
|
|
case PCB_MODULE_EDGE_T:
|
|
case PCB_PAD_T:
|
|
{
|
|
// Multiple selection is only allowed in modedit mode
|
|
// In pcbnew, you have to select subparts of modules
|
|
// one-by-one, rather than with a drag selection.
|
|
// This is so you can pick up items under an (unlocked)
|
|
// module without also moving the module's sub-parts.
|
|
if( m_multiple && !m_editModules )
|
|
return false;
|
|
|
|
// When editing modules, it's allowed to select them, even when
|
|
// locked, since you already have to explicitly activate the
|
|
// module editor to get to this stage
|
|
if ( !m_editModules )
|
|
{
|
|
MODULE* mod = static_cast<const D_PAD*>( aItem )->GetParent();
|
|
if( mod && mod->IsLocked() )
|
|
return false;
|
|
}
|
|
|
|
break;
|
|
}
|
|
|
|
// These are not selectable
|
|
case NOT_USED:
|
|
case TYPE_NOT_INIT:
|
|
return false;
|
|
|
|
default: // Suppress warnings
|
|
break;
|
|
}
|
|
|
|
// All other items are selected only if the layer on which they exist is visible
|
|
return board()->IsLayerVisible( aItem->GetLayer() );
|
|
}
|
|
|
|
void SELECTION_TOOL::select( BOARD_ITEM* aItem )
|
|
{
|
|
if( aItem->IsSelected() )
|
|
{
|
|
return;
|
|
}
|
|
|
|
if( aItem->Type() == PCB_PAD_T )
|
|
{
|
|
MODULE* module = static_cast<MODULE*>( aItem->GetParent() );
|
|
|
|
if( m_selection.Contains( module ) )
|
|
return;
|
|
}
|
|
|
|
m_selection.Add( aItem );
|
|
selectVisually( aItem );
|
|
|
|
|
|
if( m_selection.Size() == 1 )
|
|
{
|
|
// Set as the current item, so the information about selection is displayed
|
|
m_frame->SetCurItem( aItem, true );
|
|
}
|
|
else if( m_selection.Size() == 2 ) // Check only for 2, so it will not be
|
|
{ // called for every next selected item
|
|
// If multiple items are selected, do not show the information about the selected item
|
|
m_frame->SetCurItem( NULL, true );
|
|
}
|
|
}
|
|
|
|
|
|
void SELECTION_TOOL::unselect( BOARD_ITEM* aItem )
|
|
{
|
|
if( !aItem->IsSelected() )
|
|
return;
|
|
|
|
m_selection.Remove( aItem );
|
|
unselectVisually( aItem );
|
|
|
|
if( m_selection.Empty() )
|
|
{
|
|
m_frame->SetCurItem( NULL );
|
|
m_locked = true;
|
|
}
|
|
}
|
|
|
|
|
|
void SELECTION_TOOL::selectVisually( BOARD_ITEM* aItem )
|
|
{
|
|
// Hide the original item, so it is shown only on overlay
|
|
aItem->SetSelected();
|
|
view()->Hide( aItem, true );
|
|
view()->Update( aItem, KIGFX::GEOMETRY );
|
|
|
|
// Modules are treated in a special way - when they are selected, we have to
|
|
// unselect all the parts that make the module, not the module itself
|
|
|
|
if( aItem->Type() == PCB_MODULE_T )
|
|
{
|
|
static_cast<MODULE*>( aItem )->RunOnChildren( [&] ( BOARD_ITEM* item )
|
|
{
|
|
item->SetSelected();
|
|
view()->Hide( item, true );
|
|
view()->Update( item, KIGFX::GEOMETRY );
|
|
} );
|
|
}
|
|
|
|
view()->Update( &m_selection );
|
|
}
|
|
|
|
|
|
void SELECTION_TOOL::unselectVisually( BOARD_ITEM* aItem )
|
|
{
|
|
// Restore original item visibility
|
|
aItem->ClearSelected();
|
|
view()->Hide( aItem, false );
|
|
view()->Update( aItem, KIGFX::ALL );
|
|
|
|
// Modules are treated in a special way - when they are selected, we have to
|
|
// unselect all the parts that make the module, not the module itself
|
|
|
|
if( aItem->Type() == PCB_MODULE_T )
|
|
{
|
|
static_cast<MODULE*>( aItem )->RunOnChildren( [&] ( BOARD_ITEM* item )
|
|
{
|
|
item->ClearSelected();
|
|
view()->Hide( item, false );
|
|
view()->Update( item, KIGFX::ALL );
|
|
});
|
|
}
|
|
|
|
view()->Update( &m_selection );
|
|
}
|
|
|
|
|
|
bool SELECTION_TOOL::selectionContains( const VECTOR2I& aPoint ) const
|
|
{
|
|
const unsigned GRIP_MARGIN = 20;
|
|
VECTOR2D margin = getView()->ToWorld( VECTOR2D( GRIP_MARGIN, GRIP_MARGIN ), false );
|
|
|
|
// Check if the point is located within any of the currently selected items bounding boxes
|
|
for( auto item : m_selection )
|
|
{
|
|
BOX2I itemBox = item->ViewBBox();
|
|
itemBox.Inflate( margin.x, margin.y ); // Give some margin for gripping an item
|
|
|
|
if( itemBox.Contains( aPoint ) )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
static EDA_RECT getRect( const BOARD_ITEM* aItem )
|
|
{
|
|
if( aItem->Type() == PCB_MODULE_T )
|
|
return static_cast<const MODULE*>( aItem )->GetFootprintRect();
|
|
|
|
return aItem->GetBoundingBox();
|
|
}
|
|
|
|
|
|
static double calcArea( const BOARD_ITEM* aItem )
|
|
{
|
|
if( aItem->Type() == PCB_TRACE_T )
|
|
{
|
|
const TRACK* t = static_cast<const TRACK*>( aItem );
|
|
return ( t->GetWidth() + t->GetLength() ) * t->GetWidth();
|
|
}
|
|
|
|
return getRect( aItem ).GetArea();
|
|
}
|
|
|
|
|
|
static double calcMinArea( GENERAL_COLLECTOR& aCollector, KICAD_T aType )
|
|
{
|
|
double best = std::numeric_limits<double>::max();
|
|
|
|
if( !aCollector.GetCount() )
|
|
return 0.0;
|
|
|
|
for( int i = 0; i < aCollector.GetCount(); i++ )
|
|
{
|
|
BOARD_ITEM* item = aCollector[i];
|
|
if( item->Type() == aType )
|
|
best = std::min( best, calcArea( item ) );
|
|
}
|
|
|
|
return best;
|
|
}
|
|
|
|
|
|
static double calcMaxArea( GENERAL_COLLECTOR& aCollector, KICAD_T aType )
|
|
{
|
|
double best = 0.0;
|
|
|
|
for( int i = 0; i < aCollector.GetCount(); i++ )
|
|
{
|
|
BOARD_ITEM* item = aCollector[i];
|
|
if( item->Type() == aType )
|
|
best = std::max( best, calcArea( item ) );
|
|
}
|
|
|
|
return best;
|
|
}
|
|
|
|
|
|
static inline double calcCommonArea( const BOARD_ITEM* aItem, const BOARD_ITEM* aOther )
|
|
{
|
|
if( !aItem || !aOther )
|
|
return 0;
|
|
|
|
return getRect( aItem ).Common( getRect( aOther ) ).GetArea();
|
|
}
|
|
|
|
|
|
double calcRatio( double a, double b )
|
|
{
|
|
if( a == 0.0 && b == 0.0 )
|
|
return 1.0;
|
|
|
|
if( b == 0.0 )
|
|
return std::numeric_limits<double>::max();
|
|
|
|
return a / b;
|
|
}
|
|
|
|
|
|
// todo: explain the selection heuristics
|
|
void SELECTION_TOOL::guessSelectionCandidates( GENERAL_COLLECTOR& aCollector ) const
|
|
{
|
|
std::set<BOARD_ITEM*> rejected;
|
|
|
|
const double footprintAreaRatio = 0.2;
|
|
const double modulePadMinCoverRatio = 0.45;
|
|
const double padViaAreaRatio = 0.5;
|
|
const double trackViaLengthRatio = 2.0;
|
|
const double trackTrackLengthRatio = 0.3;
|
|
const double textToFeatureMinRatio = 0.2;
|
|
const double textToFootprintMinRatio = 0.4;
|
|
// If the common area of two compared items is above the following threshold, they cannot
|
|
// be rejected (it means they overlap and it might be hard to pick one by selecting
|
|
// its unique area).
|
|
const double commonAreaRatio = 0.6;
|
|
|
|
PCB_LAYER_ID actLayer = m_frame->GetActiveLayer();
|
|
|
|
LSET silkLayers( 2, B_SilkS, F_SilkS );
|
|
|
|
if( silkLayers[actLayer] )
|
|
{
|
|
std::set<BOARD_ITEM*> preferred;
|
|
|
|
for( int i = 0; i < aCollector.GetCount(); ++i )
|
|
{
|
|
BOARD_ITEM* item = aCollector[i];
|
|
KICAD_T type = item->Type();
|
|
|
|
if( ( type == PCB_MODULE_TEXT_T || type == PCB_TEXT_T || type == PCB_LINE_T )
|
|
&& silkLayers[item->GetLayer()] )
|
|
{
|
|
preferred.insert( item );
|
|
}
|
|
}
|
|
|
|
if( preferred.size() != 0 )
|
|
{
|
|
aCollector.Empty();
|
|
|
|
for( BOARD_ITEM* item : preferred )
|
|
aCollector.Append( item );
|
|
return;
|
|
}
|
|
}
|
|
|
|
if( aCollector.CountType( PCB_MODULE_TEXT_T ) > 0 )
|
|
{
|
|
for( int i = 0; i < aCollector.GetCount(); ++i )
|
|
{
|
|
if( TEXTE_MODULE* txt = dyn_cast<TEXTE_MODULE*>( aCollector[i] ) )
|
|
{
|
|
double textArea = calcArea( txt );
|
|
|
|
for( int j = 0; j < aCollector.GetCount(); ++j )
|
|
{
|
|
if( i == j )
|
|
continue;
|
|
|
|
BOARD_ITEM* item = aCollector[j];
|
|
double itemArea = calcArea( item );
|
|
double areaRatio = calcRatio( textArea, itemArea );
|
|
double commonArea = calcCommonArea( txt, item );
|
|
double itemCommonRatio = calcRatio( commonArea, itemArea );
|
|
double txtCommonRatio = calcRatio( commonArea, textArea );
|
|
|
|
if( item->Type() == PCB_MODULE_T && areaRatio < textToFootprintMinRatio &&
|
|
itemCommonRatio < commonAreaRatio )
|
|
rejected.insert( item );
|
|
|
|
switch( item->Type() )
|
|
{
|
|
case PCB_TRACE_T:
|
|
case PCB_PAD_T:
|
|
case PCB_LINE_T:
|
|
case PCB_VIA_T:
|
|
case PCB_MODULE_T:
|
|
if( areaRatio > textToFeatureMinRatio && txtCommonRatio < commonAreaRatio )
|
|
rejected.insert( txt );
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if( aCollector.CountType( PCB_MODULE_T ) > 0 )
|
|
{
|
|
double minArea = calcMinArea( aCollector, PCB_MODULE_T );
|
|
double maxArea = calcMaxArea( aCollector, PCB_MODULE_T );
|
|
|
|
if( calcRatio( minArea, maxArea ) <= footprintAreaRatio )
|
|
{
|
|
for( int i = 0; i < aCollector.GetCount(); ++i )
|
|
{
|
|
if( MODULE* mod = dyn_cast<MODULE*>( aCollector[i] ) )
|
|
{
|
|
double normalizedArea = calcRatio( calcArea( mod ), maxArea );
|
|
|
|
if( normalizedArea > footprintAreaRatio )
|
|
rejected.insert( mod );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if( aCollector.CountType( PCB_PAD_T ) > 0 )
|
|
{
|
|
for( int i = 0; i < aCollector.GetCount(); ++i )
|
|
{
|
|
if( D_PAD* pad = dyn_cast<D_PAD*>( aCollector[i] ) )
|
|
{
|
|
double ratio = pad->GetParent()->PadCoverageRatio();
|
|
|
|
if( ratio < modulePadMinCoverRatio )
|
|
rejected.insert( pad->GetParent() );
|
|
}
|
|
}
|
|
}
|
|
|
|
if( aCollector.CountType( PCB_VIA_T ) > 0 )
|
|
{
|
|
for( int i = 0; i < aCollector.GetCount(); ++i )
|
|
{
|
|
if( VIA* via = dyn_cast<VIA*>( aCollector[i] ) )
|
|
{
|
|
double viaArea = calcArea( via );
|
|
|
|
for( int j = 0; j < aCollector.GetCount(); ++j )
|
|
{
|
|
if( i == j )
|
|
continue;
|
|
|
|
BOARD_ITEM* item = aCollector[j];
|
|
double areaRatio = calcRatio( viaArea, calcArea( item ) );
|
|
|
|
if( item->Type() == PCB_MODULE_T && areaRatio < modulePadMinCoverRatio )
|
|
rejected.insert( item );
|
|
|
|
if( item->Type() == PCB_PAD_T && areaRatio < padViaAreaRatio )
|
|
rejected.insert( item );
|
|
|
|
if( TRACK* track = dyn_cast<TRACK*>( item ) )
|
|
{
|
|
if( track->GetNetCode() != via->GetNetCode() )
|
|
continue;
|
|
|
|
double lenRatio = (double) ( track->GetLength() + track->GetWidth() ) /
|
|
(double) via->GetWidth();
|
|
|
|
if( lenRatio > trackViaLengthRatio )
|
|
rejected.insert( track );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
int nTracks = aCollector.CountType( PCB_TRACE_T );
|
|
|
|
if( nTracks > 0 )
|
|
{
|
|
double maxLength = 0.0;
|
|
double minLength = std::numeric_limits<double>::max();
|
|
double maxArea = 0.0;
|
|
const TRACK* maxTrack = nullptr;
|
|
|
|
for( int i = 0; i < aCollector.GetCount(); ++i )
|
|
{
|
|
if( TRACK* track = dyn_cast<TRACK*>( aCollector[i] ) )
|
|
{
|
|
maxLength = std::max( track->GetLength(), maxLength );
|
|
maxLength = std::max( (double) track->GetWidth(), maxLength );
|
|
|
|
minLength = std::min( std::max( track->GetLength(), (double) track->GetWidth() ), minLength );
|
|
|
|
double area = track->GetLength() * track->GetWidth();
|
|
|
|
if( area > maxArea )
|
|
{
|
|
maxArea = area;
|
|
maxTrack = track;
|
|
}
|
|
}
|
|
}
|
|
|
|
if( maxLength > 0.0 && minLength / maxLength < trackTrackLengthRatio && nTracks > 1 )
|
|
{
|
|
for( int i = 0; i < aCollector.GetCount(); ++i )
|
|
{
|
|
if( TRACK* track = dyn_cast<TRACK*>( aCollector[i] ) )
|
|
{
|
|
double ratio = std::max( (double) track->GetWidth(), track->GetLength() ) / maxLength;
|
|
|
|
if( ratio > trackTrackLengthRatio )
|
|
rejected.insert( track );
|
|
}
|
|
}
|
|
}
|
|
|
|
for( int j = 0; j < aCollector.GetCount(); ++j )
|
|
{
|
|
if( MODULE* mod = dyn_cast<MODULE*>( aCollector[j] ) )
|
|
{
|
|
double ratio = calcRatio( maxArea, mod->GetFootprintRect().GetArea() );
|
|
|
|
if( ratio < modulePadMinCoverRatio && calcCommonArea( maxTrack, mod ) < commonAreaRatio )
|
|
rejected.insert( mod );
|
|
}
|
|
}
|
|
}
|
|
|
|
if( (unsigned) aCollector.GetCount() > rejected.size() ) // do not remove everything
|
|
{
|
|
for( BOARD_ITEM* item : rejected )
|
|
{
|
|
aCollector.Remove( item );
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
int SELECTION_TOOL::updateSelection( const TOOL_EVENT& aEvent )
|
|
{
|
|
getView()->Update( &m_selection );
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
bool SELECTION_TOOL::SanitizeSelection()
|
|
{
|
|
std::set<BOARD_ITEM*> rejected;
|
|
std::set<BOARD_ITEM*> added;
|
|
|
|
if( !m_editModules )
|
|
{
|
|
for( auto i : m_selection )
|
|
{
|
|
auto item = static_cast<BOARD_ITEM*>( i );
|
|
if( item->Type() == PCB_PAD_T )
|
|
{
|
|
MODULE* mod = static_cast<MODULE*>( item->GetParent() );
|
|
|
|
// case 1: module (or its pads) are locked
|
|
if( mod && ( mod->PadsLocked() || mod->IsLocked() ) )
|
|
{
|
|
rejected.insert( item );
|
|
|
|
if( !mod->IsLocked() && !mod->IsSelected() )
|
|
added.insert( mod );
|
|
}
|
|
|
|
// case 2: multi-item selection contains both the module and its pads - remove the pads
|
|
if( mod && m_selection.Contains( mod ) )
|
|
rejected.insert( item );
|
|
}
|
|
}
|
|
}
|
|
|
|
if( !rejected.empty() )
|
|
{
|
|
for( BOARD_ITEM* item : rejected )
|
|
unselect( item );
|
|
|
|
// Inform other potentially interested tools
|
|
m_toolMgr->ProcessEvent( UnselectedEvent );
|
|
}
|
|
|
|
if( !added.empty() )
|
|
{
|
|
for( BOARD_ITEM* item : added )
|
|
select( item );
|
|
|
|
// Inform other potentially interested tools
|
|
m_toolMgr->ProcessEvent( SelectedEvent );
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
// TODO(JE) Only works for BOARD_ITEM
|
|
VECTOR2I SELECTION::GetPosition() const
|
|
{
|
|
return static_cast<VECTOR2I>( GetBoundingBox().GetPosition() );
|
|
}
|
|
|
|
|
|
VECTOR2I SELECTION::GetCenter() const
|
|
{
|
|
return static_cast<VECTOR2I>( GetBoundingBox().Centre() );
|
|
}
|
|
|
|
|
|
EDA_RECT SELECTION::GetBoundingBox() const
|
|
{
|
|
EDA_RECT bbox;
|
|
|
|
bbox = Front()->GetBoundingBox();
|
|
auto i = m_items.begin();
|
|
++i;
|
|
|
|
for( ; i != m_items.end(); ++i )
|
|
{
|
|
bbox.Merge( (*i)->GetBoundingBox() );
|
|
}
|
|
|
|
return bbox;
|
|
}
|
|
|
|
|
|
EDA_ITEM* SELECTION::GetTopLeftItem( bool onlyModules ) const
|
|
{
|
|
BOARD_ITEM* topLeftItem = nullptr;
|
|
BOARD_ITEM* currentItem;
|
|
|
|
wxPoint pnt;
|
|
|
|
// find the leftmost (smallest x coord) and highest (smallest y with the smallest x) item in the selection
|
|
for( auto item : m_items )
|
|
{
|
|
currentItem = static_cast<BOARD_ITEM*>( item );
|
|
pnt = currentItem->GetPosition();
|
|
|
|
if( ( currentItem->Type() != PCB_MODULE_T ) && onlyModules )
|
|
{
|
|
continue;
|
|
}
|
|
else
|
|
{
|
|
if( topLeftItem == nullptr )
|
|
{
|
|
topLeftItem = currentItem;
|
|
}
|
|
else if( ( pnt.x < topLeftItem->GetPosition().x ) ||
|
|
( ( topLeftItem->GetPosition().x == pnt.x ) &&
|
|
( pnt.y < topLeftItem->GetPosition().y ) ) )
|
|
{
|
|
topLeftItem = currentItem;
|
|
}
|
|
}
|
|
}
|
|
|
|
return static_cast<EDA_ITEM*>( topLeftItem );
|
|
}
|
|
|
|
|
|
EDA_ITEM* SELECTION::GetTopLeftModule() const
|
|
{
|
|
return GetTopLeftItem( true );
|
|
}
|
|
|
|
|
|
const BOX2I SELECTION::ViewBBox() const
|
|
{
|
|
EDA_RECT eda_bbox;
|
|
|
|
if( Size() == 1 )
|
|
{
|
|
eda_bbox = Front()->GetBoundingBox();
|
|
}
|
|
else if( Size() > 1 )
|
|
{
|
|
eda_bbox = Front()->GetBoundingBox();
|
|
auto i = m_items.begin();
|
|
++i;
|
|
|
|
for( ; i != m_items.end(); ++i )
|
|
{
|
|
eda_bbox.Merge( (*i)->GetBoundingBox() );
|
|
}
|
|
}
|
|
|
|
return BOX2I( eda_bbox.GetOrigin(), eda_bbox.GetSize() );
|
|
}
|
|
|
|
|
|
const KIGFX::VIEW_GROUP::ITEMS SELECTION::updateDrawList() const
|
|
{
|
|
std::vector<VIEW_ITEM*> items;
|
|
|
|
for( auto item : m_items )
|
|
{
|
|
items.push_back( item );
|
|
|
|
if( item->Type() == PCB_MODULE_T )
|
|
{
|
|
MODULE* module = static_cast<MODULE*>( item );
|
|
module->RunOnChildren( [&] ( BOARD_ITEM* bitem ) { items.push_back( bitem ); } );
|
|
}
|
|
}
|
|
|
|
return items;
|
|
}
|
|
|
|
|
|
const TOOL_EVENT SELECTION_TOOL::SelectedEvent( TC_MESSAGE, TA_ACTION, "pcbnew.InteractiveSelection.selected" );
|
|
const TOOL_EVENT SELECTION_TOOL::UnselectedEvent( TC_MESSAGE, TA_ACTION, "pcbnew.InteractiveSelection.unselected" );
|
|
const TOOL_EVENT SELECTION_TOOL::ClearedEvent( TC_MESSAGE, TA_ACTION, "pcbnew.InteractiveSelection.cleared" );
|