KiCad PCB EDA Suite
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-2021 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 
28 #include <confirm.h>
29 #include <eda_draw_frame.h>
30 #include <kiface_base.h>
31 #include <macros.h>
32 #include <settings/app_settings.h>
33 #include <trace_helpers.h>
34 
35 #include <class_draw_panel_gal.h>
36 #include <view/view.h>
37 #include <view/wx_view_controls.h>
38 #include <painter.h>
39 #include <base_screen.h>
40 #include <gal/cursors.h>
42 #include <gal/opengl/opengl_gal.h>
43 #include <gal/cairo/cairo_gal.h>
44 
45 
46 #include <tool/tool_dispatcher.h>
47 #include <tool/tool_manager.h>
48 
49 #include <widgets/infobar.h>
50 
51 #include <kiplatform/ui.h>
52 
53 #include <profile.h>
54 
55 
56 EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
57  const wxPoint& aPosition, const wxSize& aSize,
58  KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
59  wxScrolledCanvas( aParentWindow, aWindowId, aPosition, aSize ),
60  m_edaFrame( nullptr ),
61  m_gal( nullptr ),
62  m_view( nullptr ),
63  m_painter( nullptr ),
64  m_viewControls( nullptr ),
65  m_backend( GAL_TYPE_NONE ),
66  m_options( aOptions ),
67  m_eventDispatcher( nullptr ),
68  m_lostFocus( false ),
69  m_stealsFocus( true )
70 {
71  m_parent = aParentWindow;
72  m_MouseCapturedLost = false;
73 
74  m_PaintEventCounter = std::make_unique<PROF_COUNTER>( "Draw panel paint events" );
75 
76  SetLayoutDirection( wxLayout_LeftToRight );
77 
78  m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( m_parent );
79 
80  // If we're in a dialog, we have to go looking for our parent frame
81  if( !m_edaFrame )
82  {
83  wxWindow* ancestor = aParentWindow->GetParent();
84 
85  while( ancestor && !dynamic_cast<EDA_DRAW_FRAME*>( ancestor ) )
86  ancestor = ancestor->GetParent();
87 
88  if( ancestor )
89  m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( ancestor );
90  }
91 
92  SwitchBackend( aGalType );
93  SetBackgroundStyle( wxBG_STYLE_CUSTOM );
94 
95  ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
96  EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
97  KIPLATFORM::UI::SetOverlayScrolling( this, false ); // Prevent excessive repaint on GTK
98 
99  Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), nullptr, this );
100  Connect( wxEVT_ENTER_WINDOW, wxMouseEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), nullptr,
101  this );
102  Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), nullptr,
103  this );
104 
105  const wxEventType events[] = {
106  // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
107  // especially special key like arrow keys, are handled by the GAL event dispatcher,
108  // and not sent to GUI without filtering, because they have a default action (scroll)
109  // that must not be called.
110  wxEVT_LEFT_UP,
111  wxEVT_LEFT_DOWN,
112  wxEVT_LEFT_DCLICK,
113  wxEVT_RIGHT_UP,
114  wxEVT_RIGHT_DOWN,
115  wxEVT_RIGHT_DCLICK,
116  wxEVT_MIDDLE_UP,
117  wxEVT_MIDDLE_DOWN,
118  wxEVT_MIDDLE_DCLICK,
119  wxEVT_MOTION,
120  wxEVT_MOUSEWHEEL,
121  wxEVT_CHAR,
122  wxEVT_CHAR_HOOK,
123 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
124  wxEVT_MAGNIFY,
125 #endif
127  };
128 
129  for( wxEventType eventType : events )
130  Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::OnEvent ), nullptr,
132 
133  m_pendingRefresh = false;
134  m_drawing = false;
135  m_drawingEnabled = false;
136 
137  // Set up timer that prevents too frequent redraw commands
138  m_refreshTimer.SetOwner( this );
139  Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
140  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), nullptr, this );
141 
142  // Set up timer to execute OnShow() method when the window appears on the screen
143  m_onShowTimer.SetOwner( this );
144  Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
145  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), nullptr, this );
146  m_onShowTimer.Start( 10 );
147 }
148 
149 
151 {
152  StopDrawing();
153 
154  wxASSERT( !m_drawing );
155 
156  delete m_viewControls;
157  delete m_view;
158  delete m_gal;
159 }
160 
161 
163 {
164  wxScrolledCanvas::SetFocus();
165  m_lostFocus = false;
166 }
167 
168 
169 void EDA_DRAW_PANEL_GAL::onPaint( wxPaintEvent& WXUNUSED( aEvent ) )
170 {
171  DoRePaint();
172 }
173 
174 
176 {
177  // Repaint the canvas, and fix scrollbar cursors
178  // Usually called by a OnPaint event, but because it does not use a wxPaintDC,
179  // it can be called outside a wxPaintEvent.
180 
181  // Update current zoom settings if the canvas is managed by a EDA frame
182  // (i.e. not by a preview panel in a dialog)
183  if( !IsDialogPreview() && GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
185 
187 
188  if( !m_gal->IsVisible() )
189  return;
190 
191  m_pendingRefresh = false;
192 
193  if( m_drawing )
194  return;
195 
196  ( *m_PaintEventCounter )++;
197 
198  wxASSERT( m_painter );
199 
200  m_drawing = true;
201  KIGFX::RENDER_SETTINGS* settings =
202  static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
203 
204  PROF_TIMER cntUpd("view-upd-items");
205  PROF_TIMER cntTotal("view-total");
206  PROF_TIMER cntCtx("view-context-create");
207  PROF_TIMER cntCtxDestroy("view-context-destroy");
208  PROF_TIMER cntRedraw("view-redraw-rects");
209 
210  bool isDirty = false;
211 
212  cntTotal.Start();
213  try
214  {
215  cntUpd.Start();
216 
217  try
218  {
219  m_view->UpdateItems();
220  }
221  catch( std::out_of_range& err )
222  {
223  // Don't do anything here but don't fail
224  // This can happen when we don't catch `at()` calls
225  wxString msg;
226  msg.Printf( wxT( "Out of Range error: %s" ), err.what() );
227  wxLogDebug( msg );
228  }
229 
230  cntUpd.Stop();
231 
232  cntCtx.Start();
234  cntCtx.Stop();
235 
238  {
239  m_view->MarkDirty();
240  }
241 
242  m_gal->SetClearColor( settings->GetBackgroundColor() );
243  m_gal->SetGridColor( settings->GetGridColor() );
244  m_gal->SetCursorColor( settings->GetCursorColor() );
245 
246  // TODO: find why ClearScreen() must be called here in opengl mode
247  // and only if m_view->IsDirty() in Cairo mode to avoid display artifacts
248  // when moving the mouse cursor
249  if( m_backend == GAL_TYPE_OPENGL )
250  m_gal->ClearScreen();
251 
252  if( m_view->IsDirty() )
253  {
254  if( m_backend != GAL_TYPE_OPENGL // Already called in opengl
256  {
257  m_gal->ClearScreen();
258  }
259 
260  m_view->ClearTargets();
261 
262  // Grid has to be redrawn only when the NONCACHED target is redrawn
264  m_gal->DrawGrid();
265 
266  cntRedraw.Start();
267  m_view->Redraw();
268  cntRedraw.Stop();
269  isDirty = true;
270  }
271 
273 
274  cntCtxDestroy.Start();
275  }
276  catch( std::exception& err )
277  {
278  if( GAL_FALLBACK != m_backend )
279  {
281 
283  _( "Could not use OpenGL, falling back to software rendering" ),
284  wxString( err.what() ) );
285  }
286  else
287  {
288  // We're well and truly banjaxed if we get here without a fallback.
289  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), wxString( err.what() ) );
290  }
291  }
292 
293  // ctx goes out of scope here so destructor would be called
294  cntCtxDestroy.Stop();
295 
296 
297  if( isDirty )
298  {
299  KI_TRACE( traceGalProfile, "View timing: %s %s %s %s %s\n",
300  cntTotal.to_string(),
301  cntUpd.to_string(),
302  cntRedraw.to_string(),
303  cntCtx.to_string(),
304  cntCtxDestroy.to_string()
305  );
306  }
307 
308  m_lastRefresh = wxGetLocalTimeMillis();
309  m_drawing = false;
310 }
311 
312 
313 void EDA_DRAW_PANEL_GAL::onSize( wxSizeEvent& aEvent )
314 {
315  // If we get a second wx update call before the first finishes, don't crash
316  if( m_gal->IsContextLocked() )
317  return;
318 
320  wxSize clientSize = GetClientSize();
321  WX_INFOBAR* infobar = GetParentEDAFrame() ? GetParentEDAFrame()->GetInfoBar() : nullptr;
322 
323  if( VECTOR2I( clientSize ) == m_gal->GetScreenPixelSize() )
324  return;
325 
326  clientSize.x = std::max( 10, clientSize.x );
327  clientSize.y = std::max( 10, clientSize.y );
328 
329  VECTOR2D bottom( 0, 0 );
330 
331  if( m_view )
332  bottom = m_view->ToWorld( m_gal->GetScreenPixelSize(), true );
333 
334  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
335 
336  if( m_view )
337  {
338  if( infobar && infobar->IsLocked() )
339  m_view->SetCenter( bottom - m_view->ToWorld( clientSize, false ) / 2.0 );
340 
343  }
344 }
345 
346 
347 void EDA_DRAW_PANEL_GAL::Refresh( bool aEraseBackground, const wxRect* aRect )
348 {
349  wxLongLong t = wxGetLocalTimeMillis();
350  wxLongLong delta = t - m_lastRefresh;
351 
352  // If it has been too long since the last frame (possible depending on platform timer latency),
353  // just do a refresh. Otherwise, start the refresh timer if it hasn't already been started.
354  // This ensures that we will render often enough but not too often.
355  if( delta >= MinRefreshPeriod )
356  {
357  if( !m_pendingRefresh )
358  ForceRefresh();
359 
360  m_refreshTimer.Start( MinRefreshPeriod, true );
361  }
362  else if( !m_refreshTimer.IsRunning() )
363  {
364  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
365  }
366 }
367 
368 
370 {
371  m_pendingRefresh = true;
372  DoRePaint();
373 }
374 
375 
377 {
378  m_eventDispatcher = aEventDispatcher;
379 }
380 
381 
383 {
384  // Start querying GAL if it is ready
385  m_refreshTimer.StartOnce( 100 );
386 }
387 
388 
390 {
391  m_drawingEnabled = false;
392  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr, this );
393  m_pendingRefresh = false;
394  m_refreshTimer.Stop();
395 }
396 
397 
399 {
400  // Set display settings for high contrast mode
402 
403  SetTopLayer( aLayer );
404 
405  rSettings->ClearHighContrastLayers();
406  rSettings->SetLayerIsHighContrast( aLayer );
407 
409 }
410 
411 
413 {
415  m_view->SetTopLayer( aLayer );
417 }
418 
419 
421 {
422  // Do not do anything if the currently used GAL is correct
423  if( aGalType == m_backend && m_gal != nullptr )
424  return true;
425 
426  VECTOR2D grid_size = m_gal ? m_gal->GetGridSize() : VECTOR2D();
427  bool grid_visibility = m_gal ? m_gal->GetGridVisibility() : true;
428  bool result = true; // assume everything will be fine
429 
430  // Prevent refreshing canvas during backend switch
431  StopDrawing();
432 
433  KIGFX::GAL* new_gal = nullptr;
434 
435  try
436  {
437  switch( aGalType )
438  {
439  case GAL_TYPE_OPENGL:
440  {
441  wxString errormsg = KIGFX::OPENGL_GAL::CheckFeatures( m_options );
442 
443  if( errormsg.empty() )
444  {
445  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
446  }
447  else
448  {
449  if( GAL_FALLBACK != aGalType )
450  {
451  aGalType = GAL_FALLBACK;
453  m_parent,
454  _( "Could not use OpenGL, falling back to software rendering" ),
455  errormsg );
456  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
457  }
458  else
459  {
460  // We're well and truly banjaxed if we get here without a fallback.
461  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), errormsg );
462  }
463  }
464  break;
465  }
466 
467  case GAL_TYPE_CAIRO: new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this ); break;
468 
469  default:
470  wxASSERT( false );
472  // warn about unhandled GAL canvas type, but continue with the fallback option
473 
474  case GAL_TYPE_NONE:
475  // KIGFX::GAL is a stub - it actually does cannot display anything,
476  // but prevents code relying on GAL canvas existence from crashing
477  new_gal = new KIGFX::GAL( m_options );
478  break;
479  }
480  }
481  catch( std::runtime_error& err )
482  {
483  // Create a dummy GAL
484  new_gal = new KIGFX::GAL( m_options );
485  aGalType = GAL_TYPE_NONE;
486  DisplayError( m_parent, wxString( err.what() ) );
487  result = false;
488  }
489 
490  // trigger update of the gal options in case they differ from the defaults
492 
493  delete m_gal;
494  m_gal = new_gal;
495 
496  wxSize clientSize = GetClientSize();
497  clientSize.x = std::max( 10, clientSize.x );
498  clientSize.y = std::max( 10, clientSize.y );
499  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
500 
501  if( grid_size.x > 0 && grid_size.y > 0 )
502  m_gal->SetGridSize( grid_size );
503 
504  m_gal->SetGridVisibility( grid_visibility );
505 
506  // Make sure the cursor is set on the new canvas
508 
509  if( m_painter )
510  m_painter->SetGAL( m_gal );
511 
512  if( m_view )
513  {
514  m_view->SetGAL( m_gal );
515  // Note: OpenGL requires reverse draw order when draw priority is enabled
516  m_view->ReverseDrawOrder( aGalType == GAL_TYPE_OPENGL );
517  }
518 
519  m_backend = aGalType;
520 
521  return result;
522 }
523 
524 
525 void EDA_DRAW_PANEL_GAL::OnEvent( wxEvent& aEvent )
526 {
527  bool shouldSetFocus = m_lostFocus && m_stealsFocus
528  && !KIUI::IsInputControlFocused() // Don't steal from input controls
529  && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
530  && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
531 
532  if( shouldSetFocus )
533  SetFocus();
534 
535  if( !m_eventDispatcher )
536  aEvent.Skip();
537  else
539 
540  Refresh();
541 }
542 
543 
544 void EDA_DRAW_PANEL_GAL::onEnter( wxMouseEvent& aEvent )
545 {
546  bool shouldSetFocus = m_stealsFocus
547  && !KIUI::IsInputControlFocused() // Don't steal from input controls
548  && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
549  && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
550 
551  // Getting focus is necessary in order to receive key events properly
552  if( shouldSetFocus )
553  SetFocus();
554 
555  aEvent.Skip();
556 }
557 
558 
559 void EDA_DRAW_PANEL_GAL::onLostFocus( wxFocusEvent& aEvent )
560 {
561  m_lostFocus = true;
562 
564 
565  aEvent.Skip();
566 }
567 
568 
569 void EDA_DRAW_PANEL_GAL::onRefreshTimer( wxTimerEvent& aEvent )
570 {
571  if( !m_drawingEnabled )
572  {
573  if( m_gal && m_gal->IsInitialized() )
574  {
575  m_drawing = false;
576  m_pendingRefresh = true;
577  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr,
578  this );
579  m_drawingEnabled = true;
580  }
581  else
582  {
583  // Try again soon
584  m_refreshTimer.StartOnce( 100 );
585  return;
586  }
587  }
588 
589  DoRePaint();
590 }
591 
592 
593 void EDA_DRAW_PANEL_GAL::onShowTimer( wxTimerEvent& aEvent )
594 {
595  if( m_gal && m_gal->IsVisible() )
596  {
597  m_onShowTimer.Stop();
598  OnShow();
599  }
600 }
601 
602 
604 {
605  if( m_gal )
606  m_gal->SetNativeCursorStyle( aCursor );
607 }
608 
609 
610 std::shared_ptr<KIGFX::VIEW_OVERLAY> EDA_DRAW_PANEL_GAL::DebugOverlay()
611 {
612  if( !m_debugOverlay )
613  {
614  m_debugOverlay.reset( new KIGFX::VIEW_OVERLAY() );
615  m_view->Add( m_debugOverlay.get() );
616  }
617 
618  return m_debugOverlay;
619 }
620 
621 
623 {
624  if( m_debugOverlay )
625  {
626  m_view->Remove( m_debugOverlay.get() );
627  m_debugOverlay = nullptr;
628  }
629 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:279
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
void SetClearColor(const COLOR4D &aColor)
virtual void SetHighContrastLayer(int aLayer)
Take care of display settings for the given layer to be displayed in high contrast mode.
void ForceRefresh()
Force a redraw.
void SetCurrentCursor(KICURSOR aCursor)
Set the current cursor shape for this panel.
virtual const COLOR4D & GetGridColor()=0
Return current grid color settings.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
bool IsModalDialogFocused()
Definition: ui_common.cpp:270
void ReverseDrawOrder(bool aFlag)
Only takes effect if UseDrawPriority is true.
Definition: view.h:690
GAL_TYPE m_backend
Currently used GAL.
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:826
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
static const wxEventType EVT_REFRESH_MOUSE
This file is part of the common library.
void OnEvent(wxEvent &aEvent)
Used to forward events to the canvas from popups, etc.
virtual const COLOR4D & GetCursorColor()=0
Return current cursor color settings.
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:449
virtual const COLOR4D & GetBackgroundColor()=0
Return current background color settings.
const VECTOR2D & GetCenter() const
Return the center point of this VIEW (in world space coordinates).
Definition: view.h:334
virtual bool SwitchBackend(GAL_TYPE aGalType)
Switch method of rendering graphics.
KIGFX::GAL_DISPLAY_OPTIONS & m_options
virtual void OnShow()
Called when the window is shown for the first time.
OpenGL implementation of the Graphics Abstraction Layer.
Definition: opengl_gal.h:70
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition: view.cpp:350
static constexpr GAL_TYPE GAL_FALLBACK
void onLostFocus(wxFocusEvent &aEvent)
virtual bool HasTarget(RENDER_TARGET aTarget)
Return true if the target exists.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:83
const wxChar *const traceGalProfile
Flag to enable debug output of GAL performance profiling.
KICURSOR
Definition: cursors.h:33
void UpdateAllLayersOrder()
Do everything that is needed to apply the rendering order of layers.
Definition: view.cpp:893
void DoRePaint()
Repaint the canvas, and fix scrollbar cursors.
void onShowTimer(wxTimerEvent &aEvent)
VECTOR2< int > VECTOR2I
Definition: vector2d.h:622
void ClearDebugOverlay()
Clear the contents of the debug overlay and removes it from the VIEW.
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:208
void onEnter(wxMouseEvent &aEvent)
WX_VIEW_CONTROLS class definition.
Auxiliary rendering target (noncached)
Definition: definitions.h:49
This file contains miscellaneous commonly used macros and functions.
void onRefreshTimer(wxTimerEvent &aEvent)
void UpdateScrollbars()
End any mouse drag action still in progress.
bool m_drawing
True if GAL is currently redrawing the view.
const VECTOR2I & GetScreenPixelSize() const
Return GAL canvas size in pixels.
bool IsLocked()
Returns true if the infobar is being updated.
Definition: infobar.h:211
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
wxWindow * m_parent
Pointer to the parent window.
bool IsInputControlFocused(wxWindow *aFocus=nullptr)
Check if a input control has focus.
Definition: ui_common.cpp:220
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:578
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
bool IsWindowActive(wxWindow *aWindow)
Check to see if the given window is the currently active window (e.g.
Definition: gtk/ui.cpp:50
VECTOR2< double > VECTOR2D
Definition: vector2d.h:621
virtual void Redraw()
Immediately redraws the whole view.
Definition: view.cpp:1134
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:609
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:598
GAL not used (the legacy wxDC engine is used)
static const int MinRefreshPeriod
60 FPS.
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.
virtual void SetTopLayer(int aLayer)
Move the selected layer to the top, so it is displayed above all others.
virtual void DrawGrid()
std::unique_ptr< PROF_COUNTER > m_PaintEventCounter
virtual void DrawCursor(const VECTOR2D &aCursorPosition)
Draw the cursor.
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.
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
#define _(s)
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
wxLogTrace helper definitions.
virtual void SetFocus() override
void SetLayerIsHighContrast(int aLayerId, bool aEnabled=true)
Set the specified layer as high-contrast.
std::string to_string()
Definition: profile.h:153
void UpdateItems()
Iterate through the list of items that asked for updating and updates them.
Definition: view.cpp:1402
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
virtual void ResizeScreen(int aWidth, int aHeight)
Resize the canvas.
void SetGridSize(const VECTOR2D &aGridSize)
Set the grid size.
A small class to help profiling.
Definition: profile.h:46
void onSize(wxSizeEvent &aEvent)
void StartDrawing()
Begin drawing if it was stopped previously.
void Stop()
Save the time when this function was called, and set the counter stane to stop.
Definition: profile.h:86
void ClearTopLayers()
Remove all layers from the on-the-top set (they are no longer displayed over the rest of layers).
Definition: view.cpp:878
virtual bool SetNativeCursorStyle(KICURSOR aCursor)
Set the cursor in the native panel.
const VECTOR2D & GetGridSize() const
Return the grid size.
virtual void ClearScreen()
Clear the screen.
void SetOverlayScrolling(const wxWindow *aWindow, bool overlay)
Used to set overlay/non-overlay scrolling mode in a window.
Definition: gtk/ui.cpp:132
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:73
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
wxTimer m_onShowTimer
Timer used to execute OnShow() when the window finally appears on the screen.
bool m_MouseCapturedLost
used on wxMSW: true after a wxEVT_MOUSE_CAPTURE_LOST was received false after the mouse is recaptured...
std::shared_ptr< KIGFX::VIEW_OVERLAY > m_debugOverlay
Optional overlay for drawing transient debug objects.
Main rendering target (cached)
Definition: definitions.h:48
static wxString CheckFeatures(GAL_DISPLAY_OPTIONS &aOptions)
Checks OpenGL features.
Definition: opengl_gal.cpp:335
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
VECTOR2D GetCursorPosition(bool aSnappingEnabled) const override
<
#define KI_TRACE(...)
virtual bool IsVisible() const
Return true if the GAL canvas is visible on the screen.
void ClearTargets()
Clear targets that are marked as dirty.
Definition: view.cpp:1115
void ClearHighContrastLayers()
Clear the list of active layers.
void SetGridVisibility(bool aVisibility)
Set the visibility setting of the grid.
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
WX_INFOBAR * GetInfoBar()
constexpr int delta
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:320
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:100
bool GetGridVisibility() const
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition: view.cpp:762
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...
BASE_SCREEN class implementation.
void SetGAL(GAL *aGal)
Assign a rendering device for the VIEW.
Definition: view.cpp:493
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:307
std::shared_ptr< KIGFX::VIEW_OVERLAY > DebugOverlay()
Create an overlay for rendering debug graphics.
virtual bool IsContextLocked()
Checks the state of the context lock.
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
void Start()
Start or restart the counter.
Definition: profile.h:75
virtual bool IsInitialized() const
Return the initialization status for the canvas.
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:633
bool IsDirty() const
Return true if any of the VIEW layers needs to be refreshened.
Definition: view.h:581
Abstract interface for drawing on a 2D-surface.