594 lines
19 KiB
C++
594 lines
19 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2019 CERN
|
|
* Copyright (C) 2019-2022 KiCad Developers, see AUTHORS.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 <ee_actions.h>
|
|
#include <symbol_edit_frame.h>
|
|
#include <tools/symbol_editor_drawing_tools.h>
|
|
#include <tools/symbol_editor_pin_tool.h>
|
|
#include <tools/ee_grid_helper.h>
|
|
#include <lib_text.h>
|
|
#include <dialogs/dialog_lib_text_properties.h>
|
|
#include <lib_shape.h>
|
|
#include <lib_textbox.h>
|
|
#include <pgm_base.h>
|
|
#include <symbol_editor/symbol_editor_settings.h>
|
|
#include <settings/settings_manager.h>
|
|
#include <string_utils.h>
|
|
#include "dialog_lib_textbox_properties.h"
|
|
|
|
static void* g_lastPinWeakPtr;
|
|
|
|
|
|
SYMBOL_EDITOR_DRAWING_TOOLS::SYMBOL_EDITOR_DRAWING_TOOLS() :
|
|
EE_TOOL_BASE<SYMBOL_EDIT_FRAME>( "eeschema.SymbolDrawing" ),
|
|
m_lastTextAngle( ANGLE_HORIZONTAL ),
|
|
m_lastFillStyle( FILL_T::NO_FILL ),
|
|
m_drawSpecificConvert( true ),
|
|
m_drawSpecificUnit( false )
|
|
{
|
|
}
|
|
|
|
|
|
bool SYMBOL_EDITOR_DRAWING_TOOLS::Init()
|
|
{
|
|
EE_TOOL_BASE::Init();
|
|
|
|
auto isDrawingCondition =
|
|
[] ( const SELECTION& aSel )
|
|
{
|
|
LIB_ITEM* item = (LIB_ITEM*) aSel.Front();
|
|
return item && item->IsNew();
|
|
};
|
|
|
|
m_menu.GetMenu().AddItem( EE_ACTIONS::finishDrawing, isDrawingCondition, 2 );
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
int SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace( const TOOL_EVENT& aEvent )
|
|
{
|
|
KICAD_T type = aEvent.Parameter<KICAD_T>();
|
|
auto* settings = Pgm().GetSettingsManager().GetAppSettings<SYMBOL_EDITOR_SETTINGS>();
|
|
auto* pinTool = type == LIB_PIN_T ? m_toolMgr->GetTool<SYMBOL_EDITOR_PIN_TOOL>() : nullptr;
|
|
|
|
KIGFX::VIEW_CONTROLS* controls = getViewControls();
|
|
EE_GRID_HELPER grid( m_toolMgr );
|
|
VECTOR2I cursorPos;
|
|
bool ignorePrimePosition = false;
|
|
LIB_ITEM* item = nullptr;
|
|
bool isText = aEvent.IsAction( &EE_ACTIONS::placeSymbolText );
|
|
|
|
m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
|
|
|
|
std::string tool = aEvent.GetCommandStr().get();
|
|
m_frame->PushTool( tool );
|
|
|
|
auto setCursor =
|
|
[&]()
|
|
{
|
|
if( item )
|
|
m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::PLACE );
|
|
else if( isText )
|
|
m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::TEXT );
|
|
else
|
|
m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
|
|
};
|
|
|
|
auto cleanup =
|
|
[&] ()
|
|
{
|
|
m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
|
|
m_view->ClearPreview();
|
|
delete item;
|
|
item = nullptr;
|
|
};
|
|
|
|
Activate();
|
|
// Must be done after Activate() so that it gets set into the correct context
|
|
controls->ShowCursor( true );
|
|
// Set initial cursor
|
|
setCursor();
|
|
|
|
// Prime the pump
|
|
if( aEvent.HasPosition() )
|
|
{
|
|
m_toolMgr->PrimeTool( aEvent.Position() );
|
|
}
|
|
else if( !aEvent.IsReactivate() && isText )
|
|
{
|
|
m_toolMgr->PrimeTool( { 0, 0 } );
|
|
ignorePrimePosition = true;
|
|
}
|
|
|
|
// Set initial cursor
|
|
setCursor();
|
|
|
|
// Main loop: keep receiving events
|
|
while( TOOL_EVENT* evt = Wait() )
|
|
{
|
|
setCursor();
|
|
grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
|
|
grid.SetUseGrid( getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
|
|
|
|
cursorPos = grid.Align( controls->GetMousePosition() );
|
|
controls->ForceCursorPosition( true, cursorPos );
|
|
|
|
if( evt->IsCancelInteractive() )
|
|
{
|
|
m_frame->GetInfoBar()->Dismiss();
|
|
|
|
if( item )
|
|
{
|
|
cleanup();
|
|
}
|
|
else
|
|
{
|
|
m_frame->PopTool( tool );
|
|
break;
|
|
}
|
|
}
|
|
else if( evt->IsActivate() )
|
|
{
|
|
if( item && evt->IsMoveTool() )
|
|
{
|
|
// we're already moving our own item; ignore the move tool
|
|
evt->SetPassEvent( false );
|
|
continue;
|
|
}
|
|
|
|
if( item )
|
|
{
|
|
m_frame->ShowInfoBarMsg( _( "Press <ESC> to cancel item creation." ) );
|
|
evt->SetPassEvent( false );
|
|
continue;
|
|
}
|
|
|
|
if( evt->IsPointEditor() )
|
|
{
|
|
// don't exit (the point editor runs in the background)
|
|
}
|
|
else if( evt->IsMoveTool() )
|
|
{
|
|
break;
|
|
}
|
|
else
|
|
{
|
|
m_frame->PopTool( tool );
|
|
break;
|
|
}
|
|
}
|
|
else if( evt->IsClick( BUT_LEFT ) || evt->IsDblClick( BUT_LEFT ) )
|
|
{
|
|
LIB_SYMBOL* symbol = m_frame->GetCurSymbol();
|
|
|
|
if( !symbol )
|
|
continue;
|
|
|
|
// First click creates...
|
|
if( !item )
|
|
{
|
|
m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
|
|
|
|
switch( type )
|
|
{
|
|
case LIB_PIN_T:
|
|
{
|
|
item = pinTool->CreatePin( VECTOR2I( cursorPos.x, -cursorPos.y ), symbol );
|
|
g_lastPinWeakPtr = item;
|
|
break;
|
|
}
|
|
case LIB_TEXT_T:
|
|
{
|
|
LIB_TEXT* text = new LIB_TEXT( symbol );
|
|
|
|
text->SetPosition( VECTOR2I( cursorPos.x, -cursorPos.y ) );
|
|
text->SetTextSize( wxSize( Mils2iu( settings->m_Defaults.text_size ),
|
|
Mils2iu( settings->m_Defaults.text_size ) ) );
|
|
text->SetTextAngle( m_lastTextAngle );
|
|
|
|
DIALOG_LIB_TEXT_PROPERTIES dlg( m_frame, text );
|
|
|
|
if( dlg.ShowModal() != wxID_OK || NoPrintableChars( text->GetText() ) )
|
|
delete text;
|
|
else
|
|
item = text;
|
|
|
|
break;
|
|
}
|
|
default:
|
|
wxFAIL_MSG( "TwoClickPlace(): unknown type" );
|
|
}
|
|
|
|
// If we started with a click on a tool button or menu then continue with the
|
|
// current mouse position. Otherwise warp back to the original click position.
|
|
if( evt->IsPrime() && ignorePrimePosition )
|
|
cursorPos = grid.Align( controls->GetMousePosition() );
|
|
else
|
|
controls->WarpCursor( cursorPos, true );
|
|
|
|
if( item )
|
|
{
|
|
item->SetPosition( VECTOR2I( cursorPos.x, -cursorPos.y ) );
|
|
|
|
item->SetFlags( IS_NEW | IS_MOVING );
|
|
m_view->ClearPreview();
|
|
m_view->AddToPreview( item->Clone() );
|
|
m_selectionTool->AddItemToSel( item );
|
|
|
|
// update the cursor so it looks correct before another event
|
|
setCursor();
|
|
}
|
|
|
|
controls->SetCursorPosition( cursorPos, false );
|
|
}
|
|
// ... and second click places:
|
|
else
|
|
{
|
|
m_frame->SaveCopyInUndoList( symbol );
|
|
|
|
switch( item->Type() )
|
|
{
|
|
case LIB_PIN_T:
|
|
pinTool->PlacePin( (LIB_PIN*) item );
|
|
break;
|
|
case LIB_TEXT_T:
|
|
symbol->AddDrawItem( (LIB_TEXT*) item );
|
|
break;
|
|
default:
|
|
wxFAIL_MSG( "TwoClickPlace(): unknown type" );
|
|
}
|
|
|
|
item->ClearEditFlags();
|
|
item = nullptr;
|
|
m_view->ClearPreview();
|
|
|
|
m_frame->RebuildView();
|
|
m_frame->OnModify();
|
|
}
|
|
}
|
|
else if( evt->IsClick( BUT_RIGHT ) )
|
|
{
|
|
// Warp after context menu only if dragging...
|
|
if( !item )
|
|
m_toolMgr->VetoContextMenuMouseWarp();
|
|
|
|
m_menu.ShowContextMenu( m_selectionTool->GetSelection() );
|
|
}
|
|
else if( item && ( evt->IsAction( &ACTIONS::refreshPreview ) || evt->IsMotion() ) )
|
|
{
|
|
item->SetPosition( VECTOR2I( cursorPos.x, -cursorPos.y ) );
|
|
m_view->ClearPreview();
|
|
m_view->AddToPreview( item->Clone() );
|
|
}
|
|
else
|
|
{
|
|
evt->SetPassEvent();
|
|
}
|
|
|
|
// Enable autopanning and cursor capture only when there is an item to be placed
|
|
controls->SetAutoPan( item != nullptr );
|
|
controls->CaptureCursor( item != nullptr );
|
|
}
|
|
|
|
controls->SetAutoPan( false );
|
|
controls->CaptureCursor( false );
|
|
m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
|
|
return 0;
|
|
}
|
|
|
|
|
|
int SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape( const TOOL_EVENT& aEvent )
|
|
{
|
|
SETTINGS_MANAGER& settingsMgr = Pgm().GetSettingsManager();
|
|
SYMBOL_EDITOR_SETTINGS* settings = settingsMgr.GetAppSettings<SYMBOL_EDITOR_SETTINGS>();
|
|
SHAPE_T type = aEvent.Parameter<SHAPE_T>();
|
|
LIB_SYMBOL* symbol = m_frame->GetCurSymbol();
|
|
LIB_ITEM* item = nullptr;
|
|
bool isTextBox = aEvent.IsAction( &EE_ACTIONS::drawSymbolTextBox );
|
|
|
|
// We might be running as the same shape in another co-routine. Make sure that one
|
|
// gets whacked.
|
|
m_toolMgr->DeactivateTool();
|
|
|
|
m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
|
|
|
|
std::string tool = aEvent.GetCommandStr().get();
|
|
m_frame->PushTool( tool );
|
|
|
|
auto setCursor =
|
|
[&]()
|
|
{
|
|
m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::PENCIL );
|
|
};
|
|
|
|
auto cleanup =
|
|
[&] ()
|
|
{
|
|
m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
|
|
m_view->ClearPreview();
|
|
delete item;
|
|
item = nullptr;
|
|
};
|
|
|
|
Activate();
|
|
// Must be done after Activate() so that it gets set into the correct context
|
|
getViewControls()->ShowCursor( true );
|
|
// Set initial cursor
|
|
setCursor();
|
|
|
|
// Prime the pump
|
|
if( aEvent.HasPosition() )
|
|
m_toolMgr->RunAction( ACTIONS::cursorClick );
|
|
|
|
// Main loop: keep receiving events
|
|
while( TOOL_EVENT* evt = Wait() )
|
|
{
|
|
setCursor();
|
|
|
|
VECTOR2I cursorPos = getViewControls()->GetCursorPosition( !evt->DisableGridSnapping() );
|
|
|
|
if( evt->IsCancelInteractive() )
|
|
{
|
|
if( item )
|
|
{
|
|
cleanup();
|
|
}
|
|
else
|
|
{
|
|
m_frame->PopTool( tool );
|
|
break;
|
|
}
|
|
}
|
|
else if( evt->IsActivate() )
|
|
{
|
|
if( item )
|
|
cleanup();
|
|
|
|
if( evt->IsPointEditor() )
|
|
{
|
|
// don't exit (the point editor runs in the background)
|
|
}
|
|
else if( evt->IsMoveTool() )
|
|
{
|
|
// leave ourselves on the stack so we come back after the move
|
|
break;
|
|
}
|
|
else
|
|
{
|
|
m_frame->PopTool( tool );
|
|
break;
|
|
}
|
|
}
|
|
else if( evt->IsClick( BUT_LEFT ) && !item )
|
|
{
|
|
// Update in case the symbol was changed while the tool was running
|
|
symbol = m_frame->GetCurSymbol();
|
|
|
|
if( !symbol )
|
|
continue;
|
|
|
|
m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
|
|
|
|
int lineWidth = Mils2iu( settings->m_Defaults.line_width );
|
|
|
|
if( isTextBox )
|
|
item = new LIB_TEXTBOX( symbol, lineWidth, m_lastFillStyle );
|
|
else
|
|
item = new LIB_SHAPE( symbol, type, lineWidth, m_lastFillStyle );
|
|
|
|
item->SetFlags( IS_NEW );
|
|
item->BeginEdit( VECTOR2I( cursorPos.x, -cursorPos.y ) );
|
|
|
|
if( m_drawSpecificUnit )
|
|
item->SetUnit( m_frame->GetUnit() );
|
|
|
|
if( m_drawSpecificConvert )
|
|
item->SetConvert( m_frame->GetConvert() );
|
|
|
|
m_selectionTool->AddItemToSel( item );
|
|
}
|
|
else if( item && ( evt->IsClick( BUT_LEFT ) || evt->IsDblClick( BUT_LEFT )
|
|
|| evt->IsAction( &EE_ACTIONS::finishDrawing ) ) )
|
|
{
|
|
if( symbol != m_frame->GetCurSymbol() )
|
|
{
|
|
symbol = m_frame->GetCurSymbol();
|
|
item->SetParent( symbol );
|
|
}
|
|
|
|
if( evt->IsDblClick( BUT_LEFT ) || evt->IsAction( &EE_ACTIONS::finishDrawing )
|
|
|| !item->ContinueEdit( VECTOR2I( cursorPos.x, -cursorPos.y ) ) )
|
|
{
|
|
item->EndEdit();
|
|
item->ClearEditFlags();
|
|
|
|
if( isTextBox )
|
|
{
|
|
DIALOG_LIB_TEXTBOX_PROPERTIES dlg( m_frame, static_cast<LIB_TEXTBOX*>( item ) );
|
|
|
|
if( dlg.ShowQuasiModal() != wxID_OK )
|
|
{
|
|
cleanup();
|
|
continue;
|
|
}
|
|
}
|
|
|
|
m_view->ClearPreview();
|
|
|
|
m_frame->SaveCopyInUndoList( symbol );
|
|
symbol->AddDrawItem( item );
|
|
item = nullptr;
|
|
|
|
m_frame->RebuildView();
|
|
m_frame->OnModify();
|
|
m_toolMgr->RunAction( ACTIONS::activatePointEditor );
|
|
}
|
|
}
|
|
else if( item && ( evt->IsAction( &ACTIONS::refreshPreview ) || evt->IsMotion() ) )
|
|
{
|
|
item->CalcEdit( VECTOR2I( cursorPos.x, -cursorPos.y ) );
|
|
m_view->ClearPreview();
|
|
m_view->AddToPreview( item->Clone() );
|
|
}
|
|
else if( evt->IsDblClick( BUT_LEFT ) && !item )
|
|
{
|
|
m_toolMgr->RunAction( EE_ACTIONS::properties, true );
|
|
}
|
|
else if( evt->IsClick( BUT_RIGHT ) )
|
|
{
|
|
// Warp after context menu only if dragging...
|
|
if( !item )
|
|
m_toolMgr->VetoContextMenuMouseWarp();
|
|
|
|
m_menu.ShowContextMenu( m_selectionTool->GetSelection() );
|
|
}
|
|
else
|
|
{
|
|
evt->SetPassEvent();
|
|
}
|
|
|
|
// Enable autopanning and cursor capture only when there is a shape being drawn
|
|
getViewControls()->SetAutoPan( item != nullptr );
|
|
getViewControls()->CaptureCursor( item != nullptr );
|
|
}
|
|
|
|
getViewControls()->SetAutoPan( false );
|
|
getViewControls()->CaptureCursor( false );
|
|
m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
|
|
return 0;
|
|
}
|
|
|
|
|
|
int SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor( const TOOL_EVENT& aEvent )
|
|
{
|
|
std::string tool = aEvent.GetCommandStr().get();
|
|
m_frame->PushTool( tool );
|
|
|
|
auto setCursor =
|
|
[&]()
|
|
{
|
|
m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::BULLSEYE );
|
|
};
|
|
|
|
Activate();
|
|
// Must be done after Activate() so that it gets set into the correct context
|
|
getViewControls()->ShowCursor( true );
|
|
// Set initial cursor
|
|
setCursor();
|
|
|
|
// Main loop: keep receiving events
|
|
while( TOOL_EVENT* evt = Wait() )
|
|
{
|
|
setCursor();
|
|
|
|
if( evt->IsCancelInteractive() )
|
|
{
|
|
m_frame->PopTool( tool );
|
|
break;
|
|
}
|
|
else if( evt->IsActivate() )
|
|
{
|
|
m_frame->PopTool( tool );
|
|
break;
|
|
}
|
|
else if( evt->IsClick( BUT_LEFT ) || evt->IsDblClick( BUT_LEFT ) )
|
|
{
|
|
LIB_SYMBOL* symbol = m_frame->GetCurSymbol();
|
|
|
|
if( !symbol )
|
|
continue;
|
|
|
|
VECTOR2I cursorPos = getViewControls()->GetCursorPosition( !evt->DisableGridSnapping() );
|
|
VECTOR2I offset( -cursorPos.x, cursorPos.y );
|
|
|
|
symbol->SetOffset( offset );
|
|
|
|
// Refresh the view without changing the viewport
|
|
auto center = m_view->GetCenter();
|
|
center.x += offset.x;
|
|
center.y -= offset.y;
|
|
m_view->SetCenter( center );
|
|
m_view->RecacheAllItems();
|
|
m_frame->OnModify();
|
|
}
|
|
else if( evt->IsClick( BUT_RIGHT ) )
|
|
{
|
|
m_menu.ShowContextMenu( m_selectionTool->GetSelection() );
|
|
}
|
|
else
|
|
{
|
|
evt->SetPassEvent();
|
|
}
|
|
}
|
|
|
|
m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
|
|
return 0;
|
|
}
|
|
|
|
|
|
int SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem( const TOOL_EVENT& aEvent )
|
|
{
|
|
SYMBOL_EDITOR_PIN_TOOL* pinTool = m_toolMgr->GetTool<SYMBOL_EDITOR_PIN_TOOL>();
|
|
LIB_SYMBOL* symbol = m_frame->GetCurSymbol();
|
|
LIB_PIN* sourcePin = nullptr;
|
|
|
|
if( !symbol )
|
|
return 0;
|
|
|
|
// See if we have a pin matching our weak ptr
|
|
for( LIB_PIN* test = symbol->GetNextPin(); test; test = symbol->GetNextPin( test ) )
|
|
{
|
|
if( (void*) test == g_lastPinWeakPtr )
|
|
sourcePin = test;
|
|
}
|
|
|
|
if( sourcePin )
|
|
{
|
|
LIB_PIN* pin = pinTool->RepeatPin( sourcePin );
|
|
g_lastPinWeakPtr = pin;
|
|
|
|
m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
|
|
|
|
if( pin )
|
|
m_toolMgr->RunAction( EE_ACTIONS::addItemToSel, true, pin );
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
void SYMBOL_EDITOR_DRAWING_TOOLS::setTransitions()
|
|
{
|
|
Go( &SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace, EE_ACTIONS::placeSymbolPin.MakeEvent() );
|
|
Go( &SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace, EE_ACTIONS::placeSymbolText.MakeEvent() );
|
|
Go( &SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape, EE_ACTIONS::drawRectangle.MakeEvent() );
|
|
Go( &SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape, EE_ACTIONS::drawCircle.MakeEvent() );
|
|
Go( &SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape, EE_ACTIONS::drawArc.MakeEvent() );
|
|
Go( &SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape, EE_ACTIONS::drawSymbolLines.MakeEvent() );
|
|
Go( &SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape, EE_ACTIONS::drawSymbolTextBox.MakeEvent() );
|
|
Go( &SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor, EE_ACTIONS::placeSymbolAnchor.MakeEvent() );
|
|
Go( &SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem, EE_ACTIONS::repeatDrawItem.MakeEvent() );
|
|
}
|