KiCad PCB EDA Suite
Loading...
Searching...
No Matches
draw_panel_gal.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2013-2017 CERN
5 * Copyright (C) 2013-2024, 2024 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * @author Tomasz Wlostowski <[email protected]>
8 * @author Maciej Suminski <[email protected]>
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, you may find one here:
22 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23 * or you may search the http://www.gnu.org website for the version 2 license,
24 * or you may write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26 */
27#include <eda_draw_frame.h>
28#include <kiface_base.h>
29#include <macros.h>
30#include <scoped_set_reset.h>
32#include <trace_helpers.h>
33
35#include <view/view.h>
37#include <gal/painter.h>
38#include <base_screen.h>
39#include <gal/cursors.h>
42#include <gal/cairo/cairo_gal.h>
43#include <math/vector2wx.h>
44
45
47#include <tool/tool_manager.h>
48
49#include <widgets/wx_infobar.h>
50
51#include <kiplatform/ui.h>
52
53#include <core/profile.h>
54
55#include <pgm_base.h>
56#include <confirm.h>
57
58
64static const wxChar traceDrawPanel[] = wxT( "KICAD_DRAW_PANEL" );
65
66
67EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
68 const wxPoint& aPosition, const wxSize& aSize,
69 KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
70 wxScrolledCanvas( aParentWindow, aWindowId, aPosition, aSize ),
71 m_MouseCapturedLost( false ),
72 m_parent( aParentWindow ),
73 m_edaFrame( nullptr ),
74 m_lastRepaintStart( 0 ),
75 m_lastRepaintEnd( 0 ),
76 m_drawing( false ),
77 m_drawingEnabled( false ),
78 m_needIdleRefresh( false ),
79 m_gal( nullptr ),
80 m_view( nullptr ),
81 m_painter( nullptr ),
82 m_viewControls( nullptr ),
83 m_backend( GAL_TYPE_NONE ),
84 m_options( aOptions ),
85 m_eventDispatcher( nullptr ),
86 m_lostFocus( false ),
87 m_stealsFocus( true ),
88 m_statusPopup( nullptr )
89{
90 m_PaintEventCounter = std::make_unique<PROF_COUNTER>( "Draw panel paint events" );
91
92 if( Pgm().GetCommonSettings()->m_Appearance.show_scrollbars )
93 ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
94 else
95 ShowScrollbars( wxSHOW_SB_NEVER, wxSHOW_SB_NEVER );
96
97 SetLayoutDirection( wxLayout_LeftToRight );
98
99 m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( m_parent );
100
101 // If we're in a dialog, we have to go looking for our parent frame
102 if( !m_edaFrame )
103 {
104 wxWindow* ancestor = aParentWindow->GetParent();
105
106 while( ancestor && !dynamic_cast<EDA_DRAW_FRAME*>( ancestor ) )
107 ancestor = ancestor->GetParent();
108
109 if( ancestor )
110 m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( ancestor );
111 }
112
113 SwitchBackend( aGalType );
114 SetBackgroundStyle( wxBG_STYLE_CUSTOM );
115
116 EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
117 KIPLATFORM::UI::SetOverlayScrolling( this, false ); // Prevent excessive repaint on GTK
118 KIPLATFORM::UI::ImmControl( this, false ); // Ensure our panel can't suck in IME events
119
120 Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), nullptr, this );
121 Connect( wxEVT_ENTER_WINDOW, wxMouseEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), nullptr,
122 this );
123 Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), nullptr,
124 this );
125
126 const wxEventType events[] = {
127 // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
128 // especially special key like arrow keys, are handled by the GAL event dispatcher,
129 // and not sent to GUI without filtering, because they have a default action (scroll)
130 // that must not be called.
131 wxEVT_LEFT_UP,
132 wxEVT_LEFT_DOWN,
133 wxEVT_LEFT_DCLICK,
134 wxEVT_RIGHT_UP,
135 wxEVT_RIGHT_DOWN,
136 wxEVT_RIGHT_DCLICK,
137 wxEVT_MIDDLE_UP,
138 wxEVT_MIDDLE_DOWN,
139 wxEVT_MIDDLE_DCLICK,
140 wxEVT_AUX1_UP,
141 wxEVT_AUX1_DOWN,
142 wxEVT_AUX1_DCLICK,
143 wxEVT_AUX2_UP,
144 wxEVT_AUX2_DOWN,
145 wxEVT_AUX2_DCLICK,
146 wxEVT_MOTION,
147 wxEVT_MOUSEWHEEL,
148 wxEVT_CHAR,
149 wxEVT_CHAR_HOOK,
150 wxEVT_MAGNIFY,
152 };
153
154 for( wxEventType eventType : events )
155 Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::OnEvent ), nullptr,
157
158 // Set up timer to detect when drawing starts
159 m_refreshTimer.SetOwner( this );
160 Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
161 wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), nullptr, this );
162
163 // Set up timer to execute OnShow() method when the window appears on the screen
164 m_onShowTimer.SetOwner( this );
165 Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
166 wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), nullptr, this );
167 m_onShowTimer.Start( 10 );
168}
169
170
172{
173 StopDrawing();
174
175 wxASSERT( !m_drawing );
176
177 delete m_viewControls;
178 delete m_view;
179 delete m_gal;
180}
181
182
184{
186 wxScrolledCanvas::SetFocus();
187 m_lostFocus = false;
188}
189
190
191void EDA_DRAW_PANEL_GAL::onPaint( wxPaintEvent& WXUNUSED( aEvent ) )
192{
193 DoRePaint();
194}
195
196
198{
199 if( !m_refreshMutex.try_lock() )
200 return false;
201
202 std::lock_guard<std::mutex> lock( m_refreshMutex, std::adopt_lock );
203
204 if( !m_drawingEnabled )
205 return false;
206
207 if( !m_gal->IsInitialized() || !m_gal->IsVisible() )
208 return false;
209
210 if( m_drawing )
211 return false;
212
213 m_lastRepaintStart = wxGetLocalTimeMillis();
214
215 // Repaint the canvas, and fix scrollbar cursors
216 // Usually called by a OnPaint event, but because it does not use a wxPaintDC,
217 // it can be called outside a wxPaintEvent.
218
219 // Update current zoom settings if the canvas is managed by a EDA frame
220 // (i.e. not by a preview panel in a dialog)
221 if( !IsDialogPreview() && GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
223
224 if( Pgm().GetCommonSettings()->m_Appearance.show_scrollbars )
226
227 SCOPED_SET_RESET<bool> drawing( m_drawing, true );
228
229 ( *m_PaintEventCounter )++;
230
231 wxASSERT( m_painter );
232
233 KIGFX::RENDER_SETTINGS* settings =
234 static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
235
236 PROF_TIMER cntUpd("view-upd-items");
237 PROF_TIMER cntTotal("view-total");
238 PROF_TIMER cntCtx("view-context-create");
239 PROF_TIMER cntCtxDestroy("view-context-destroy");
240 PROF_TIMER cntRedraw("view-redraw-rects");
241
242 bool isDirty = false;
243
244 cntTotal.Start();
245
246 try
247 {
248 cntUpd.Start();
249
250 try
251 {
253 }
254 catch( std::out_of_range& err )
255 {
256 // Don't do anything here but don't fail
257 // This can happen when we don't catch `at()` calls
258 wxLogTrace( traceDrawPanel, wxS( "Out of Range error: %s" ), err.what() );
259 }
260
261 cntUpd.Stop();
262
263 // GAL_DRAWING_CONTEXT can throw in the dtor, so we need to scope
264 // the full lifetime inside the try block
265 {
266 cntCtx.Start();
268 cntCtx.Stop();
269
272 {
273 m_view->MarkDirty();
274 }
275
276 m_gal->SetClearColor( settings->GetBackgroundColor() );
277 m_gal->SetGridColor( settings->GetGridColor() );
278 m_gal->SetCursorColor( settings->GetCursorColor() );
279
281
282 if( m_view->IsDirty() )
283 {
285
286 // Grid has to be redrawn only when the NONCACHED target is redrawn
288 m_gal->DrawGrid();
289
290 cntRedraw.Start();
291 m_view->Redraw();
292 cntRedraw.Stop();
293 isDirty = true;
294 }
295
297
298 cntCtxDestroy.Start();
299 }
300
301 // ctx goes out of scope here so destructor would be called
302 cntCtxDestroy.Stop();
303 }
304 catch( std::exception& err )
305 {
306 if( GAL_FALLBACK != m_backend )
307 {
309
311 _( "Could not use OpenGL, falling back to software rendering" ),
312 wxString( err.what() ) );
313
314 StartDrawing();
315 }
316 else
317 {
318 // We're well and truly banjaxed if we get here without a fallback.
319 DisplayErrorMessage( m_parent, _( "Graphics error" ), wxString( err.what() ) );
320
321 StopDrawing();
322 }
323 }
324
325 if( isDirty )
326 {
327 KI_TRACE( traceGalProfile, "View timing: %s %s %s %s %s\n",
328 cntTotal.to_string(),
329 cntUpd.to_string(),
330 cntRedraw.to_string(),
331 cntCtx.to_string(),
332 cntCtxDestroy.to_string()
333 );
334 }
335
336 m_lastRepaintEnd = wxGetLocalTimeMillis();
337
338 return true;
339}
340
341
342void EDA_DRAW_PANEL_GAL::onSize( wxSizeEvent& aEvent )
343{
344 // If we get a second wx update call before the first finishes, don't crash
345 if( m_gal->IsContextLocked() )
346 return;
347
349 wxSize clientSize = GetClientSize();
350 WX_INFOBAR* infobar = GetParentEDAFrame() ? GetParentEDAFrame()->GetInfoBar() : nullptr;
351
352 if( ToVECTOR2I( clientSize ) == m_gal->GetScreenPixelSize() )
353 return;
354
355 // Note: ( +1, +1 ) prevents an ugly black line on right and bottom on Mac
356 clientSize.x = std::max( 10, clientSize.x + 1 );
357 clientSize.y = std::max( 10, clientSize.y + 1 );
358
359 VECTOR2D bottom( 0, 0 );
360
361 if( m_view )
362 bottom = m_view->ToWorld( m_gal->GetScreenPixelSize(), true );
363
364 m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
365
366 if( m_view )
367 {
368 if( infobar && infobar->IsLocked() )
369 {
370 VECTOR2D halfScreen( std::ceil( 0.5 * clientSize.x ), std::ceil( 0.5 * clientSize.y ) );
371 m_view->SetCenter( bottom - m_view->ToWorld( halfScreen, false ) );
372 }
373
376 }
377}
378
379
381{
382 m_needIdleRefresh = true;
383}
384
385
386void EDA_DRAW_PANEL_GAL::Refresh( bool aEraseBackground, const wxRect* aRect )
387{
388 if( !DoRePaint() )
390}
391
392
394{
395 if( !m_drawingEnabled )
396 {
397 if( m_gal && m_gal->IsInitialized() )
398 {
399 Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr,
400 this );
401
402 Connect( wxEVT_IDLE, wxIdleEventHandler( EDA_DRAW_PANEL_GAL::onIdle ), nullptr, this );
403
404 m_drawingEnabled = true;
405 }
406 else
407 {
408 // Try again soon
409 m_refreshTimer.StartOnce( 100 );
410 return;
411 }
412 }
413
414 DoRePaint();
415}
416
417
419{
420 m_eventDispatcher = aEventDispatcher;
421}
422
423
425{
426 // Start querying GAL if it is ready
427 m_refreshTimer.StartOnce( 100 );
428}
429
430
432{
433 m_refreshTimer.Stop();
434 m_drawingEnabled = false;
435
436 Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr, this );
437
438 Disconnect( wxEVT_IDLE, wxIdleEventHandler( EDA_DRAW_PANEL_GAL::onIdle ), nullptr, this );
439}
440
441
443{
444 // Set display settings for high contrast mode
446
447 SetTopLayer( aLayer );
448
449 rSettings->ClearHighContrastLayers();
450 rSettings->SetLayerIsHighContrast( aLayer );
451
453}
454
455
457{
459 m_view->SetTopLayer( aLayer );
461}
462
463
465{
466 // Do not do anything if the currently used GAL is correct
467 if( aGalType == m_backend && m_gal != nullptr )
468 return true;
469
470 VECTOR2D grid_size = m_gal ? m_gal->GetGridSize() : VECTOR2D();
471 bool grid_visibility = m_gal ? m_gal->GetGridVisibility() : true;
472 bool result = true; // assume everything will be fine
473
474 // Prevent refreshing canvas during backend switch
475 StopDrawing();
476
477 KIGFX::GAL* new_gal = nullptr;
478
479 try
480 {
481 switch( aGalType )
482 {
483 case GAL_TYPE_OPENGL:
484 {
485 wxString errormsg = KIGFX::OPENGL_GAL::CheckFeatures( m_options );
486
487 if( errormsg.empty() )
488 {
489 new_gal = new KIGFX::OPENGL_GAL( GetVcSettings(), m_options, this, this, this );
490 }
491 else
492 {
493 if( GAL_FALLBACK != aGalType )
494 {
495 aGalType = GAL_FALLBACK;
497 m_parent,
498 _( "Could not use OpenGL, falling back to software rendering" ),
499 errormsg );
500 new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
501 }
502 else
503 {
504 // We're well and truly banjaxed if we get here without a fallback.
505 DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), errormsg );
506 }
507 }
508 break;
509 }
510
511 case GAL_TYPE_CAIRO: new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this ); break;
512
513 default:
514 wxASSERT( false );
516 // warn about unhandled GAL canvas type, but continue with the fallback option
517
518 case GAL_TYPE_NONE:
519 // KIGFX::GAL is a stub - it actually does cannot display anything,
520 // but prevents code relying on GAL canvas existence from crashing
521 new_gal = new KIGFX::GAL( m_options );
522 break;
523 }
524 }
525 catch( std::runtime_error& err )
526 {
527 // Create a dummy GAL
528 new_gal = new KIGFX::GAL( m_options );
529 aGalType = GAL_TYPE_NONE;
530 DisplayError( m_parent, wxString( err.what() ) );
531 result = false;
532 }
533
534 // trigger update of the gal options in case they differ from the defaults
536
537 delete m_gal;
538 m_gal = new_gal;
539
540 wxSize clientSize = GetClientSize();
541 clientSize.x = std::max( 10, clientSize.x );
542 clientSize.y = std::max( 10, clientSize.y );
543 m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
544
545 if( grid_size.x > 0 && grid_size.y > 0 )
546 m_gal->SetGridSize( grid_size );
547
548 m_gal->SetGridVisibility( grid_visibility );
549
550 // Make sure the cursor is set on the new canvas
551 SetCurrentCursor( KICURSOR::ARROW );
552
553 if( m_painter )
554 m_painter->SetGAL( m_gal );
555
556 if( m_view )
557 {
558 m_view->SetGAL( m_gal );
559 // Note: OpenGL requires reverse draw order when draw priority is enabled
561 }
562
563 m_backend = aGalType;
564
565 return result;
566}
567
568
569void EDA_DRAW_PANEL_GAL::OnEvent( wxEvent& aEvent )
570{
571 bool shouldSetFocus = m_lostFocus && m_stealsFocus
572 && !KIUI::IsInputControlFocused() // Don't steal from input controls
573 && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
574 && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
575
576 if( shouldSetFocus )
577 SetFocus();
578
579 if( !m_eventDispatcher )
580 aEvent.Skip();
581 else
583
584 // Give events time to process, based on last render duration
585 wxLongLong endDelta = wxGetLocalTimeMillis() - m_lastRepaintEnd;
586 long long timeLimit = ( m_lastRepaintEnd - m_lastRepaintStart ).GetValue() / 5;
587
588 timeLimit = std::clamp( timeLimit, 3LL, 150LL );
589
590 if( endDelta > timeLimit )
591 Refresh();
592 else
594}
595
596
597void EDA_DRAW_PANEL_GAL::onEnter( wxMouseEvent& aEvent )
598{
599 bool shouldSetFocus = m_stealsFocus
600 && !KIUI::IsInputControlFocused() // Don't steal from input controls
601 && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
602 && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
603
604 // Getting focus is necessary in order to receive key events properly
605 if( shouldSetFocus )
606 SetFocus();
607
608 aEvent.Skip();
609}
610
611
612void EDA_DRAW_PANEL_GAL::onLostFocus( wxFocusEvent& aEvent )
613{
614 m_lostFocus = true;
615
617
618 aEvent.Skip();
619}
620
621
622void EDA_DRAW_PANEL_GAL::onIdle( wxIdleEvent& aEvent )
623{
625 {
626 m_needIdleRefresh = false;
627 Refresh();
628 }
629
630 aEvent.Skip();
631}
632
633
634void EDA_DRAW_PANEL_GAL::onRefreshTimer( wxTimerEvent& aEvent )
635{
636 ForceRefresh();
637}
638
639
640void EDA_DRAW_PANEL_GAL::onShowTimer( wxTimerEvent& aEvent )
641{
642 if( m_gal && m_gal->IsInitialized() && m_gal->IsVisible() )
643 {
644 m_onShowTimer.Stop();
645 OnShow();
646 }
647}
648
649
651{
652 if( !m_gal )
653 return;
654
655 DPI_SCALING_COMMON dpi( nullptr, m_parent );
656
657 bool hidpi = false;
658
659 // Cursor scaling factor cannot be set for a wxCursor on GTK and OSX (at least before wx 3.3),
660 // resulting in 4x rendered size on 2x window scale.
661 // MSW renders the bitmap as-is, without scaling, so this works here.
662#ifdef __WXMSW__
663 hidpi = dpi.GetContentScaleFactor() >= 2.0;
664#endif
665
666 m_gal->SetNativeCursorStyle( aCursor, hidpi );
667}
668
669
670std::shared_ptr<KIGFX::VIEW_OVERLAY> EDA_DRAW_PANEL_GAL::DebugOverlay()
671{
672 if( !m_debugOverlay )
673 {
674 m_debugOverlay.reset( new KIGFX::VIEW_OVERLAY() );
675 m_view->Add( m_debugOverlay.get() );
676 }
677
678 return m_debugOverlay;
679}
680
681
683{
684 if( m_debugOverlay )
685 {
686 m_view->Remove( m_debugOverlay.get() );
687 m_debugOverlay = nullptr;
688 }
689}
690
691
693{
695
696 KIGFX::VC_SETTINGS vcSettings;
697 vcSettings.m_warpCursor = cfg->m_Input.center_on_zoom;
699 vcSettings.m_autoPanSettingEnabled = cfg->m_Input.auto_pan;
701 vcSettings.m_horizontalPan = cfg->m_Input.horizontal_pan;
703 vcSettings.m_zoomSpeed = cfg->m_Input.zoom_speed;
704 vcSettings.m_zoomSpeedAuto = cfg->m_Input.zoom_speed_auto;
708 vcSettings.m_dragLeft = cfg->m_Input.drag_left;
709 vcSettings.m_dragMiddle = cfg->m_Input.drag_middle;
710 vcSettings.m_dragRight = cfg->m_Input.drag_right;
712
713 return vcSettings;
714}
BASE_SCREEN class implementation.
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:100
Class to handle configuration and automatic determination of the DPI scale to use for canvases.
double GetContentScaleFactor() const override
Get the content scale factor, which may be different from the scale factor on some platforms.
WX_INFOBAR * GetInfoBar()
The base class for create windows for drawing purpose.
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
std::unique_ptr< PROF_COUNTER > m_PaintEventCounter
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
void onLostFocus(wxFocusEvent &aEvent)
static constexpr GAL_TYPE GAL_FALLBACK
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
void onSize(wxSizeEvent &aEvent)
bool m_needIdleRefresh
True when canvas needs to be refreshed from idle handler.
virtual void SetHighContrastLayer(int aLayer)
Take care of display settings for the given layer to be displayed in high contrast mode.
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...
KIGFX::GAL_DISPLAY_OPTIONS & m_options
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.
static KIGFX::VC_SETTINGS GetVcSettings()
Gets a populated View Controls settings object dervived from our program settings.
virtual void SetTopLayer(int aLayer)
Move the selected layer to the top, so it is displayed above all others.
void ClearDebugOverlay()
Clear the contents of the debug overlay and removes it from the VIEW.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
void ForceRefresh()
Force a redraw.
bool m_drawing
True if GAL is currently redrawing the view.
void onShowTimer(wxTimerEvent &aEvent)
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
EDA_DRAW_PANEL_GAL(wxWindow *aParentWindow, wxWindowID aWindowId, const wxPoint &aPosition, const wxSize &aSize, KIGFX::GAL_DISPLAY_OPTIONS &aOptions, GAL_TYPE aGalType=GAL_TYPE_OPENGL)
Create a drawing panel that is contained inside aParentWindow.
void onRefreshTimer(wxTimerEvent &aEvent)
void SetCurrentCursor(KICURSOR aCursor)
Set the current cursor shape for this panel.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
virtual void OnShow()
Called when the window is shown for the first time.
std::shared_ptr< KIGFX::VIEW_OVERLAY > m_debugOverlay
Optional overlay for drawing transient debug objects.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
wxWindow * m_parent
Pointer to the parent window.
wxLongLong m_lastRepaintStart
Timestamp of the last repaint start.
@ GAL_TYPE_OPENGL
OpenGL implementation.
@ GAL_TYPE_CAIRO
Cairo implementation.
@ GAL_TYPE_NONE
GAL not used (the legacy wxDC engine is used)
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
void SetFocus() override
void onIdle(wxIdleEvent &aEvent)
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
void onEnter(wxMouseEvent &aEvent)
void RequestRefresh()
Make sure a refresh gets done on the next idle event if it hasn't already.
std::mutex m_refreshMutex
Blocks multiple calls to the draw.
virtual bool SwitchBackend(GAL_TYPE aGalType)
Switch method of rendering graphics.
void StartDrawing()
Begin drawing if it was stopped previously.
wxLongLong m_lastRepaintEnd
Timestamp of the last repaint end.
void OnEvent(wxEvent &aEvent)
Used to forward events to the canvas from popups, etc.
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
std::shared_ptr< KIGFX::VIEW_OVERLAY > DebugOverlay()
Create an overlay for rendering debug graphics.
bool DoRePaint()
Repaint the canvas, and fix scrollbar cursors.
GAL_TYPE m_backend
Currently used GAL.
wxTimer m_onShowTimer
Timer used to execute OnShow() when the window finally appears on the screen.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
Abstract interface for drawing on a 2D-surface.
virtual void ResizeScreen(int aWidth, int aHeight)
Resize the canvas.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
virtual bool SetNativeCursorStyle(KICURSOR aCursor, bool aHiDPI)
Set the cursor in the native panel.
virtual bool HasTarget(RENDER_TARGET aTarget)
Return true if the target exists.
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
void SetGridSize(const VECTOR2D &aGridSize)
Set the grid size.
const VECTOR2D & GetGridSize() const
Return the grid size.
virtual void DrawGrid()
virtual bool IsContextLocked()
Checks the state of the context lock.
bool GetGridVisibility() const
virtual void ClearScreen()
Clear the screen.
void SetClearColor(const COLOR4D &aColor)
virtual bool IsInitialized() const
Return the initialization status for the canvas.
const VECTOR2I & GetScreenPixelSize() const
Return GAL canvas size in pixels.
void SetGridVisibility(bool aVisibility)
Set the visibility setting of the grid.
virtual void DrawCursor(const VECTOR2D &aCursorPosition)
Draw the cursor.
virtual bool IsVisible() const
Return true if the GAL canvas is visible on the screen.
OpenGL implementation of the Graphics Abstraction Layer.
Definition: opengl_gal.h:71
static wxString CheckFeatures(GAL_DISPLAY_OPTIONS &aOptions)
Checks OpenGL features.
Definition: opengl_gal.cpp:468
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
void ClearHighContrastLayers()
Clear the list of active layers.
virtual const COLOR4D & GetGridColor()=0
Return current grid color settings.
virtual const COLOR4D & GetBackgroundColor() const =0
Return current background color settings.
void SetLayerIsHighContrast(int aLayerId, bool aEnabled=true)
Set the specified layer as high-contrast.
virtual const COLOR4D & GetCursorColor()=0
Return current cursor color settings.
void ReverseDrawOrder(bool aFlag)
Only takes effect if UseDrawPriority is true.
Definition: view.h:713
const VECTOR2D & GetCenter() const
Return the center point of this VIEW (in world space coordinates).
Definition: view.h:347
void UpdateAllLayersOrder()
Do everything that is needed to apply the rendering order of layers.
Definition: view.cpp:938
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:317
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition: view.cpp:357
void ClearTargets()
Clear targets that are marked as dirty.
Definition: view.cpp:1183
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition: view.cpp:804
void SetGAL(GAL *aGal)
Assign a rendering device for the VIEW.
Definition: view.cpp:528
virtual void Redraw()
Immediately redraws the whole view.
Definition: view.cpp:1202
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:484
void ClearTopLayers()
Remove all layers from the on-the-top set (they are no longer displayed over the rest of layers).
Definition: view.cpp:923
bool IsTargetDirty(int aTarget) const
Return true if any of layers belonging to the target or the target itself should be redrawn.
Definition: view.h:614
void UpdateItems()
Iterate through the list of items that asked for updating and updates them.
Definition: view.cpp:1471
bool IsDirty() const
Return true if any of the VIEW layers needs to be refreshened.
Definition: view.h:597
virtual void SetTopLayer(int aLayer, bool aEnabled=true)
Set given layer to be displayed on the top or sets back the default order of layers.
Definition: view.cpp:871
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:649
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:221
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:613
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:625
VECTOR2D GetCursorPosition(bool aSnappingEnabled) const override
<
void UpdateScrollbars()
End any mouse drag action still in progress.
static const wxEventType EVT_REFRESH_MOUSE
virtual COMMON_SETTINGS * GetCommonSettings() const
Definition: pgm_base.cpp:678
A small class to help profiling.
Definition: profile.h:49
void Stop()
Save the time when this function was called, and set the counter stane to stop.
Definition: profile.h:88
void Start()
Start or restart the counter.
Definition: profile.h:77
std::string to_string()
Definition: profile.h:155
RAII class that sets an value at construction and resets it to the original value at destruction.
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.
A modified version of the wxInfoBar class that allows us to:
Definition: wx_infobar.h:75
bool IsLocked()
Returns true if the infobar is being updated.
Definition: wx_infobar.h:212
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:170
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:222
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:195
This file is part of the common library.
KICURSOR
Definition: cursors.h:34
#define _(s)
static const wxChar traceDrawPanel[]
Flag to enable drawing panel debugging output.
const wxChar *const traceGalProfile
Flag to enable debug output of GAL performance profiling.
This file contains miscellaneous commonly used macros and functions.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:83
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition: definitions.h:49
@ TARGET_CACHED
Main rendering target (cached)
Definition: definitions.h:48
@ TARGET_OVERLAY
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
void SetOverlayScrolling(const wxWindow *aWindow, bool overlay)
Used to set overlay/non-overlay scrolling mode in a window.
Definition: wxgtk/ui.cpp:202
void ImmControl(wxWindow *aWindow, bool aEnable)
Configures the IME mode of a given control handle.
Definition: wxgtk/ui.cpp:319
void ImeNotifyCancelComposition(wxWindow *aWindow)
Asks the IME to cancel.
Definition: wxgtk/ui.cpp:324
bool IsWindowActive(wxWindow *aWindow)
Check to see if the given window is the currently active window (e.g.
Definition: wxgtk/ui.cpp:73
KICOMMON_API bool IsInputControlFocused(wxWindow *aFocus=nullptr)
Check if a input control has focus.
Definition: ui_common.cpp:263
KICOMMON_API bool IsModalDialogFocused()
Definition: ui_common.cpp:317
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: pgm_base.cpp:1059
see class PGM_BASE
MOUSE_DRAG_ACTION drag_right
MOUSE_DRAG_ACTION drag_middle
MOUSE_DRAG_ACTION drag_left
Structure to keep VIEW_CONTROLS settings for easy store/restore operations.
Definition: view_controls.h:43
MOUSE_DRAG_ACTION m_dragLeft
bool m_horizontalPan
Enable the accelerating zoom controller.
Definition: view_controls.h:92
bool m_autoPanSettingEnabled
Distance from cursor to VIEW edge when panning is active.
Definition: view_controls.h:77
bool m_focusFollowSchPcb
Flag for turning on autopanning.
Definition: view_controls.h:71
float m_autoPanAcceleration
If the cursor is allowed to be warped.
Definition: view_controls.h:86
MOUSE_DRAG_ACTION m_dragMiddle
int m_zoomSpeed
When true, ignore zoom_speed and pick a platform-specific default.
Definition: view_controls.h:98
int m_scrollModifierZoom
What modifier key to enable horizontal pan with the (vertical) scroll wheel.
int m_scrollModifierPanH
What modifier key to enable vertical with the (vertical) scroll wheel.
bool m_warpCursor
Enable horizontal panning with the horizontal scroll/trackpad input.
Definition: view_controls.h:89
MOUSE_DRAG_ACTION m_dragRight
Is last cursor motion event coming from keyboard arrow cursor motion action.
bool m_zoomAcceleration
Zoom speed for the non-accelerating zoom controller.
Definition: view_controls.h:95
bool m_zoomSpeedAuto
What modifier key to enable zoom with the (vertical) scroll wheel.
wxLogTrace helper definitions.
#define KI_TRACE(aWhat,...)
VECTOR2< double > VECTOR2D
Definition: vector2d.h:672
VECTOR2I ToVECTOR2I(const wxSize &aSize)
Definition: vector2wx.h:30
WX_VIEW_CONTROLS class definition.