2018-08-03 12:18:26 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
2019-01-25 19:18:22 +00:00
|
|
|
* Copyright (C) 2014-2019 CERN
|
2018-08-03 12:18:26 +00:00
|
|
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
2019-03-27 09:09:16 +00:00
|
|
|
* Copyright (C) 2019 KiCad Developers, see AUTHORS.txt for contributors.
|
2018-08-03 12:18:26 +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
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
#include <view/wx_view_controls.h>
|
2019-05-25 11:05:39 +00:00
|
|
|
#include <ws_view_item.h>
|
2018-08-03 12:18:26 +00:00
|
|
|
|
|
|
|
#include <gal/graphics_abstraction_layer.h>
|
|
|
|
#include <sch_draw_panel.h>
|
|
|
|
#include <sch_view.h>
|
|
|
|
#include <sch_painter.h>
|
|
|
|
#include <sch_edit_frame.h>
|
|
|
|
#include <preview_items/selection_area.h>
|
2019-04-19 16:08:19 +00:00
|
|
|
#include <tool/tool_manager.h>
|
|
|
|
#include <tool/actions.h>
|
2018-08-03 12:18:26 +00:00
|
|
|
#include <functional>
|
|
|
|
#include <sch_sheet.h>
|
2018-08-28 13:27:13 +00:00
|
|
|
#include <pgm_base.h>
|
2019-05-10 17:19:48 +00:00
|
|
|
#include <tools/ee_actions.h>
|
|
|
|
#include <tools/ee_selection_tool.h>
|
2018-08-03 12:18:26 +00:00
|
|
|
|
|
|
|
using namespace std::placeholders;
|
|
|
|
|
2018-10-21 12:50:31 +00:00
|
|
|
|
2018-09-08 20:57:56 +00:00
|
|
|
// Events used by EDA_DRAW_PANEL
|
2018-09-14 08:15:10 +00:00
|
|
|
BEGIN_EVENT_TABLE( SCH_DRAW_PANEL, wxScrolledCanvas )
|
2018-09-15 14:01:35 +00:00
|
|
|
EVT_CHAR( SCH_DRAW_PANEL::OnKeyEvent )
|
|
|
|
EVT_CHAR_HOOK( SCH_DRAW_PANEL::OnCharHook )
|
|
|
|
EVT_PAINT( SCH_DRAW_PANEL::onPaint )
|
2018-09-08 20:57:56 +00:00
|
|
|
END_EVENT_TABLE()
|
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
SCH_DRAW_PANEL::SCH_DRAW_PANEL( wxWindow* aParentWindow, wxWindowID aWindowId,
|
2018-08-28 13:27:13 +00:00
|
|
|
const wxPoint& aPosition, const wxSize& aSize,
|
|
|
|
KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
|
|
|
|
EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType ),
|
|
|
|
m_parent( aParentWindow )
|
2018-08-03 12:18:26 +00:00
|
|
|
{
|
2018-08-28 13:27:13 +00:00
|
|
|
m_defaultCursor = m_currentCursor = wxCURSOR_ARROW;
|
|
|
|
m_showCrossHair = true;
|
2018-11-19 09:21:28 +00:00
|
|
|
m_view = new KIGFX::SCH_VIEW( true, dynamic_cast<SCH_BASE_FRAME*>( aParentWindow ) );
|
2018-08-03 12:18:26 +00:00
|
|
|
m_view->SetGAL( m_gal );
|
|
|
|
|
2018-10-23 07:53:05 +00:00
|
|
|
m_gal->SetWorldUnitLength( SCH_WORLD_UNIT );
|
2018-08-03 12:18:26 +00:00
|
|
|
|
|
|
|
m_painter.reset( new KIGFX::SCH_PAINTER( m_gal ) );
|
|
|
|
|
|
|
|
m_view->SetPainter( m_painter.get() );
|
2018-11-02 13:36:12 +00:00
|
|
|
m_view->SetScaleLimits( 50.0, 0.05 ); // This fixes the zoom in and zoom out limits
|
2018-08-03 12:18:26 +00:00
|
|
|
m_view->SetMirror( false, false );
|
|
|
|
|
2019-01-25 19:18:22 +00:00
|
|
|
// Early initialization of the canvas background color,
|
|
|
|
// before any OnPaint event is fired for the canvas using a wrong bg color
|
|
|
|
auto settings = m_painter->GetSettings();
|
|
|
|
m_gal->SetClearColor( settings->GetBackgroundColor() );
|
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
setDefaultLayerOrder();
|
|
|
|
setDefaultLayerDeps();
|
|
|
|
|
|
|
|
view()->UpdateAllLayersOrder();
|
2018-10-13 14:53:28 +00:00
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
// View controls is the first in the event handler chain, so the Tool Framework operates
|
|
|
|
// on updated viewport data.
|
|
|
|
m_viewControls = new KIGFX::WX_VIEW_CONTROLS( m_view, this );
|
|
|
|
|
|
|
|
Connect( wxEVT_CHAR, wxKeyEventHandler( SCH_DRAW_PANEL::OnKeyEvent ), NULL, this );
|
|
|
|
Connect( wxEVT_CHAR_HOOK, wxKeyEventHandler( SCH_DRAW_PANEL::OnCharHook ), NULL, this );
|
|
|
|
|
2018-08-28 13:27:13 +00:00
|
|
|
Pgm().CommonSettings()->Read( ENBL_MOUSEWHEEL_PAN_KEY, &m_enableMousewheelPan, false );
|
|
|
|
Pgm().CommonSettings()->Read( ENBL_ZOOM_NO_CENTER_KEY, &m_enableZoomNoCenter, false );
|
|
|
|
Pgm().CommonSettings()->Read( ENBL_AUTO_PAN_KEY, &m_enableAutoPan, true );
|
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
m_abortRequest = false;
|
|
|
|
m_ignoreMouseEvents = false;
|
|
|
|
// Be sure a mouse release button event will be ignored when creating the canvas
|
|
|
|
// if the mouse click was not made inside the canvas (can happen sometimes, when
|
|
|
|
// launching a editor from a double click made in another frame)
|
|
|
|
m_ignoreNextLeftButtonRelease = true;
|
|
|
|
|
|
|
|
m_cursorLevel = 0;
|
|
|
|
m_PrintIsMirrored = false;
|
|
|
|
|
|
|
|
m_doubleClickInterval = 250;
|
|
|
|
|
|
|
|
m_viewControls->SetSnapping( true );
|
|
|
|
|
|
|
|
SetEvtHandlerEnabled( true );
|
|
|
|
SetFocus();
|
|
|
|
Show( true );
|
|
|
|
Raise();
|
|
|
|
StartDrawing();
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
SCH_DRAW_PANEL::~SCH_DRAW_PANEL()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void SCH_DRAW_PANEL::DisplayComponent( const LIB_PART* aComponent )
|
|
|
|
{
|
|
|
|
view()->Clear();
|
|
|
|
view()->DisplayComponent( const_cast<LIB_PART*>(aComponent) );
|
|
|
|
|
|
|
|
}
|
|
|
|
|
2018-11-20 14:11:22 +00:00
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
void SCH_DRAW_PANEL::DisplaySheet( const SCH_SCREEN *aScreen )
|
|
|
|
{
|
|
|
|
view()->Clear();
|
2018-09-04 20:53:04 +00:00
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
if( aScreen )
|
2018-09-04 20:53:04 +00:00
|
|
|
view()->DisplaySheet( const_cast<SCH_SCREEN*>( aScreen ) );
|
2018-08-03 12:18:26 +00:00
|
|
|
}
|
|
|
|
|
2018-11-20 14:11:22 +00:00
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
void SCH_DRAW_PANEL::setDefaultLayerOrder()
|
|
|
|
{
|
2018-10-21 12:50:31 +00:00
|
|
|
for( LAYER_NUM i = 0; (unsigned) i < sizeof( SCH_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
|
2018-08-03 12:18:26 +00:00
|
|
|
{
|
2018-10-21 12:50:31 +00:00
|
|
|
LAYER_NUM layer = SCH_LAYER_ORDER[i];
|
2018-08-03 12:18:26 +00:00
|
|
|
wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
|
|
|
|
|
|
|
|
m_view->SetLayerOrder( layer, i );
|
2018-10-21 12:50:31 +00:00
|
|
|
}
|
2018-08-03 12:18:26 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
bool SCH_DRAW_PANEL::SwitchBackend( GAL_TYPE aGalType )
|
|
|
|
{
|
2018-09-10 13:37:28 +00:00
|
|
|
VECTOR2D grid_size = m_gal->GetGridSize();
|
2018-08-03 12:18:26 +00:00
|
|
|
bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
|
|
|
|
setDefaultLayerDeps();
|
2018-10-23 07:53:05 +00:00
|
|
|
m_gal->SetWorldUnitLength( SCH_WORLD_UNIT );
|
2018-10-11 16:44:59 +00:00
|
|
|
|
|
|
|
// Keep grid size and grid visibility:
|
2018-09-10 13:37:28 +00:00
|
|
|
m_gal->SetGridSize( grid_size );
|
2018-10-11 16:44:59 +00:00
|
|
|
SCH_BASE_FRAME* frame = dynamic_cast<SCH_BASE_FRAME*>( GetParent() );
|
|
|
|
|
|
|
|
if( frame )
|
|
|
|
m_gal->SetGridVisibility( frame->IsGridVisible() );
|
|
|
|
|
|
|
|
Refresh();
|
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
return rv;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2018-09-08 16:44:51 +00:00
|
|
|
void SCH_DRAW_PANEL::SetEnableMousewheelPan( bool aEnable )
|
|
|
|
{
|
|
|
|
m_enableMousewheelPan = aEnable;
|
|
|
|
|
|
|
|
if( GetParent()->IsGalCanvasActive() )
|
|
|
|
GetParent()->GetGalCanvas()->GetViewControls()->EnableMousewheelPan( aEnable );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void SCH_DRAW_PANEL::SetEnableAutoPan( bool aEnable )
|
|
|
|
{
|
2018-12-11 16:49:28 +00:00
|
|
|
EDA_DRAW_PANEL::SetEnableAutoPan( aEnable );
|
2018-09-08 16:44:51 +00:00
|
|
|
|
|
|
|
if( GetParent()->IsGalCanvasActive() )
|
|
|
|
GetParent()->GetGalCanvas()->GetViewControls()->EnableAutoPan( aEnable );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2018-12-11 16:49:28 +00:00
|
|
|
void SCH_DRAW_PANEL::SetAutoPanRequest( bool aEnable )
|
|
|
|
{
|
|
|
|
wxCHECK( GetParent()->IsGalCanvasActive(), /*void*/ );
|
|
|
|
GetParent()->GetGalCanvas()->GetViewControls()->SetAutoPan( aEnable );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2018-09-08 16:44:51 +00:00
|
|
|
void SCH_DRAW_PANEL::SetEnableZoomNoCenter( bool aEnable )
|
|
|
|
{
|
|
|
|
m_enableZoomNoCenter = aEnable;
|
|
|
|
|
|
|
|
if( GetParent()->IsGalCanvasActive() )
|
|
|
|
GetParent()->GetGalCanvas()->GetViewControls()->EnableCursorWarping( !aEnable );
|
|
|
|
}
|
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
|
|
|
|
void SCH_DRAW_PANEL::setDefaultLayerDeps()
|
|
|
|
{
|
|
|
|
// caching makes no sense for Cairo and other software renderers
|
2018-10-13 14:53:28 +00:00
|
|
|
auto target = m_backend == GAL_TYPE_OPENGL ? KIGFX::TARGET_CACHED : KIGFX::TARGET_NONCACHED;
|
2018-08-03 12:18:26 +00:00
|
|
|
|
|
|
|
for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
|
|
|
|
m_view->SetLayerTarget( i, target );
|
|
|
|
|
2018-10-16 12:20:09 +00:00
|
|
|
// Bitmaps are draw on a non cached GAL layer:
|
|
|
|
m_view->SetLayerTarget( LAYER_DRAW_BITMAPS , KIGFX::TARGET_NONCACHED );
|
2018-08-03 12:18:26 +00:00
|
|
|
|
2018-10-16 12:20:09 +00:00
|
|
|
// Some draw layers need specific settings
|
|
|
|
m_view->SetLayerTarget( LAYER_GP_OVERLAY , KIGFX::TARGET_OVERLAY );
|
2018-08-03 12:18:26 +00:00
|
|
|
m_view->SetLayerDisplayOnly( LAYER_GP_OVERLAY ) ;
|
2018-10-16 12:20:09 +00:00
|
|
|
|
|
|
|
m_view->SetLayerTarget( LAYER_SELECT_OVERLAY , KIGFX::TARGET_OVERLAY );
|
|
|
|
m_view->SetLayerDisplayOnly( LAYER_SELECT_OVERLAY ) ;
|
|
|
|
|
|
|
|
m_view->SetLayerTarget( LAYER_WORKSHEET , KIGFX::TARGET_NONCACHED );
|
2018-08-03 12:18:26 +00:00
|
|
|
m_view->SetLayerDisplayOnly( LAYER_WORKSHEET ) ;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
KIGFX::SCH_VIEW* SCH_DRAW_PANEL::view() const
|
|
|
|
{
|
|
|
|
return static_cast<KIGFX::SCH_VIEW*>( m_view );
|
|
|
|
}
|
|
|
|
|
|
|
|
BASE_SCREEN* SCH_DRAW_PANEL::GetScreen()
|
|
|
|
{
|
|
|
|
return GetParent()->GetScreen();
|
|
|
|
}
|
|
|
|
|
|
|
|
EDA_DRAW_FRAME* SCH_DRAW_PANEL::GetParent() const
|
|
|
|
{
|
|
|
|
return static_cast<EDA_DRAW_FRAME*>(m_parent); // static_cast<SCH_EDIT_FRAME*> (m_parent);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2018-09-05 14:48:05 +00:00
|
|
|
void SCH_DRAW_PANEL::MoveCursorToCrossHair()
|
|
|
|
{
|
|
|
|
GetViewControls()->WarpCursor( GetParent()->GetCrossHairPosition(), true );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
void SCH_DRAW_PANEL::Refresh( bool aEraseBackground, const wxRect* aRect )
|
|
|
|
{
|
|
|
|
EDA_DRAW_PANEL_GAL::Refresh( aEraseBackground, aRect );
|
|
|
|
}
|
|
|
|
|
2018-09-09 09:57:36 +00:00
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
void SCH_DRAW_PANEL::OnCharHook( wxKeyEvent& event )
|
|
|
|
{
|
|
|
|
event.Skip();
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void SCH_DRAW_PANEL::OnKeyEvent( wxKeyEvent& event )
|
|
|
|
{
|
2019-05-22 22:57:54 +00:00
|
|
|
SCH_BASE_FRAME* frame = (SCH_BASE_FRAME*) m_parent;
|
|
|
|
int localkey = event.GetKeyCode();
|
|
|
|
bool keyWasHandled = false;
|
2018-08-03 12:18:26 +00:00
|
|
|
|
2019-05-08 18:56:03 +00:00
|
|
|
if( localkey == WXK_ESCAPE )
|
2018-08-03 12:18:26 +00:00
|
|
|
{
|
|
|
|
m_abortRequest = true;
|
|
|
|
|
2019-05-23 00:46:22 +00:00
|
|
|
if( frame->IsModal() )
|
2019-05-22 22:57:54 +00:00
|
|
|
frame->DismissModal( wxID_CANCEL );
|
2019-05-23 00:46:22 +00:00
|
|
|
else
|
|
|
|
GetParent()->GetToolManager()->RunAction( ACTIONS::cancelInteractive, true );
|
|
|
|
|
|
|
|
keyWasHandled = true; // The key is captured: the key event will be not skipped
|
2018-08-03 12:18:26 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Normalize keys code to easily handle keys from Ctrl+A to Ctrl+Z
|
|
|
|
* They have an ascii code from 1 to 27 remapped
|
|
|
|
* to GR_KB_CTRL + 'A' to GR_KB_CTRL + 'Z'
|
|
|
|
*/
|
|
|
|
if( event.ControlDown() && localkey >= WXK_CONTROL_A && localkey <= WXK_CONTROL_Z )
|
|
|
|
localkey += 'A' - 1;
|
|
|
|
|
|
|
|
/* Disallow shift for keys that have two keycodes on them (e.g. number and
|
|
|
|
* punctuation keys) leaving only the "letter keys" of A-Z.
|
|
|
|
* Then, you can have, e.g. Ctrl-5 and Ctrl-% (GB layout)
|
|
|
|
* and Ctrl-( and Ctrl-5 (FR layout).
|
|
|
|
* Otherwise, you'd have to have to say Ctrl-Shift-5 on a FR layout
|
|
|
|
*/
|
|
|
|
bool keyIsLetter = ( localkey >= 'A' && localkey <= 'Z' ) ||
|
|
|
|
( localkey >= 'a' && localkey <= 'z' );
|
|
|
|
|
|
|
|
if( event.ShiftDown() && ( keyIsLetter || localkey > 256 ) )
|
|
|
|
localkey |= GR_KB_SHIFT;
|
|
|
|
|
|
|
|
if( event.ControlDown() )
|
|
|
|
localkey |= GR_KB_CTRL;
|
|
|
|
|
|
|
|
if( event.AltDown() )
|
|
|
|
localkey |= GR_KB_ALT;
|
|
|
|
|
|
|
|
|
|
|
|
// Some key commands use the current mouse position: refresh it.
|
|
|
|
//pos = wxGetMousePosition() - GetScreenPosition();
|
|
|
|
|
|
|
|
// Compute the cursor position in drawing units. Also known as logical units to wxDC.
|
|
|
|
//pos = wxPoint( DC.DeviceToLogicalX( pos.x ), DC.DeviceToLogicalY( pos.y ) );
|
|
|
|
|
2018-10-17 21:24:35 +00:00
|
|
|
auto p = GetViewControls()->GetCursorPosition( false );
|
2018-08-03 12:18:26 +00:00
|
|
|
|
|
|
|
wxPoint pos ((int)p.x, (int)p.y);
|
|
|
|
|
|
|
|
GetParent()->SetMousePosition( pos );
|
|
|
|
|
2019-03-27 09:09:16 +00:00
|
|
|
// a Key event has to be skipped only if it is not handled:
|
|
|
|
if( !GetParent()->GeneralControl( nullptr, pos, localkey ) && !keyWasHandled )
|
2018-08-03 12:18:26 +00:00
|
|
|
event.Skip();
|
|
|
|
}
|
|
|
|
|
2018-09-09 09:57:36 +00:00
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
void SCH_DRAW_PANEL::onPaint( wxPaintEvent& aEvent )
|
|
|
|
{
|
2019-03-18 12:22:33 +00:00
|
|
|
if( !m_gal->IsInitialized() || !m_gal->IsVisible() )
|
2018-09-15 14:01:35 +00:00
|
|
|
// The first wxPaintEvent can be fired at startup before the GAL engine is fully initialized
|
|
|
|
// (depending on platforms). Do nothing in this case
|
|
|
|
return;
|
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
if( m_painter )
|
|
|
|
static_cast<KIGFX::SCH_PAINTER*>(m_painter.get())->GetSettings()->ImportLegacyColors( nullptr );
|
2018-09-10 13:37:28 +00:00
|
|
|
|
2018-08-03 12:18:26 +00:00
|
|
|
EDA_DRAW_PANEL_GAL::onPaint( aEvent );
|
|
|
|
}
|