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 
98  Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), nullptr, this );
99  Connect( wxEVT_ENTER_WINDOW, wxMouseEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), nullptr,
100  this );
101  Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), nullptr,
102  this );
103 
104  const wxEventType events[] = {
105  // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
106  // especially special key like arrow keys, are handled by the GAL event dispatcher,
107  // and not sent to GUI without filtering, because they have a default action (scroll)
108  // that must not be called.
109  wxEVT_LEFT_UP,
110  wxEVT_LEFT_DOWN,
111  wxEVT_LEFT_DCLICK,
112  wxEVT_RIGHT_UP,
113  wxEVT_RIGHT_DOWN,
114  wxEVT_RIGHT_DCLICK,
115  wxEVT_MIDDLE_UP,
116  wxEVT_MIDDLE_DOWN,
117  wxEVT_MIDDLE_DCLICK,
118  wxEVT_MOTION,
119  wxEVT_MOUSEWHEEL,
120  wxEVT_CHAR,
121  wxEVT_CHAR_HOOK,
122 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
123  wxEVT_MAGNIFY,
124 #endif
126  };
127 
128  for( wxEventType eventType : events )
129  Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::OnEvent ), nullptr,
131 
132  m_pendingRefresh = false;
133  m_drawing = false;
134  m_drawingEnabled = false;
135 
136  // Set up timer that prevents too frequent redraw commands
137  m_refreshTimer.SetOwner( this );
138  Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
139  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), nullptr, this );
140 
141  // Set up timer to execute OnShow() method when the window appears on the screen
142  m_onShowTimer.SetOwner( this );
143  Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
144  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), nullptr, this );
145  m_onShowTimer.Start( 10 );
146 }
147 
148 
150 {
151  StopDrawing();
152 
153  wxASSERT( !m_drawing );
154 
155  delete m_viewControls;
156  delete m_view;
157  delete m_gal;
158 }
159 
160 
162 {
163  wxScrolledCanvas::SetFocus();
164  m_lostFocus = false;
165 }
166 
167 
168 void EDA_DRAW_PANEL_GAL::onPaint( wxPaintEvent& WXUNUSED( aEvent ) )
169 {
170  DoRePaint();
171 }
172 
173 
175 {
176  // Repaint the canvas, and fix scrollbar cursors
177  // Usually called by a OnPaint event, but because it does not use a wxPaintDC,
178  // it can be called outside a wxPaintEvent.
179 
180  // Update current zoom settings if the canvas is managed by a EDA frame
181  // (i.e. not by a preview panel in a dialog)
182  if( !IsDialogPreview() && GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
184 
186 
187  if( !m_gal->IsVisible() )
188  return;
189 
190  m_pendingRefresh = false;
191 
192  if( m_drawing )
193  return;
194 
195  ( *m_PaintEventCounter )++;
196 
197  wxASSERT( m_painter );
198 
199  m_drawing = true;
200  KIGFX::RENDER_SETTINGS* settings =
201  static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
202 
203  PROF_TIMER cntUpd("view-upd-items");
204  PROF_TIMER cntTotal("view-total");
205  PROF_TIMER cntCtx("view-context-create");
206  PROF_TIMER cntCtxDestroy("view-context-destroy");
207  PROF_TIMER cntRedraw("view-redraw-rects");
208 
209  bool isDirty = false;
210 
211  cntTotal.Start();
212  try
213  {
214  cntUpd.Start();
215  try
216  {
217  m_view->UpdateItems();
218  }
219  catch( std::out_of_range& err )
220  {
221  // Don't do anything here but don't fail
222  // This can happen when we don't catch `at()` calls
223  wxString msg;
224  msg.Printf( wxT( "Out of Range error: %s" ), err.what() );
225  wxLogDebug( msg );
226  }
227 
228  cntUpd.Stop();
229 
230  cntCtx.Start();
231  int cookie = rand();
232  m_gal->LockContext( cookie );
233  m_gal->BeginDrawing();
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  m_gal->ClearScreen();
257 
258  m_view->ClearTargets();
259 
260  // Grid has to be redrawn only when the NONCACHED target is redrawn
262  m_gal->DrawGrid();
263 
264  cntRedraw.Start();
265  m_view->Redraw();
266  cntRedraw.Stop();
267  isDirty = true;
268  }
269 
271 
272  cntCtxDestroy.Start();
273  m_gal->EndDrawing();
274  m_gal->UnlockContext( cookie );
275  cntCtxDestroy.Stop();
276  }
277  catch( std::exception& err )
278  {
279  if( GAL_FALLBACK != m_backend )
280  {
282 
284  _( "Could not use OpenGL, falling back to software rendering" ),
285  wxString( err.what() ) );
286  }
287  else
288  {
289  // We're well and truly banjaxed if we get here without a fallback.
290  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), wxString( err.what() ) );
291  }
292  }
293 
294 
295  if( isDirty )
296  {
297  KI_TRACE( traceGalProfile, "View timing: %s %s %s %s %s\n",
298  cntTotal.to_string(),
299  cntUpd.to_string(),
300  cntRedraw.to_string(),
301  cntCtx.to_string(),
302  cntCtxDestroy.to_string()
303  );
304  }
305 
306  m_lastRefresh = wxGetLocalTimeMillis();
307  m_drawing = false;
308 }
309 
310 
311 void EDA_DRAW_PANEL_GAL::onSize( wxSizeEvent& aEvent )
312 {
313  // If we get a second wx update call before the first finishes, don't crash
314  if( m_gal->IsContextLocked() )
315  return;
316 
318  wxSize clientSize = GetClientSize();
319  WX_INFOBAR* infobar = GetParentEDAFrame() ? GetParentEDAFrame()->GetInfoBar() : nullptr;
320 
321  if( VECTOR2I( clientSize ) == m_gal->GetScreenPixelSize() )
322  return;
323 
324  clientSize.x = std::max( 10, clientSize.x );
325  clientSize.y = std::max( 10, clientSize.y );
326 
327  VECTOR2D bottom( 0, 0 );
328 
329  if( m_view )
330  bottom = m_view->ToWorld( m_gal->GetScreenPixelSize(), true );
331 
332  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
333 
334  if( m_view )
335  {
336  if( infobar && infobar->IsLocked() )
337  m_view->SetCenter( bottom - m_view->ToWorld( clientSize, false ) / 2.0 );
338 
341  }
342 }
343 
344 
345 void EDA_DRAW_PANEL_GAL::Refresh( bool aEraseBackground, const wxRect* aRect )
346 {
347  wxLongLong t = wxGetLocalTimeMillis();
348  wxLongLong delta = t - m_lastRefresh;
349 
350  // If it has been too long since the last frame (possible depending on platform timer latency),
351  // just do a refresh. Otherwise, start the refresh timer if it hasn't already been started.
352  // This ensures that we will render often enough but not too often.
353  if( delta >= MinRefreshPeriod )
354  {
355  if( !m_pendingRefresh )
356  ForceRefresh();
357 
358  m_refreshTimer.Start( MinRefreshPeriod, true );
359  }
360  else if( !m_refreshTimer.IsRunning() )
361  {
362  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
363  }
364 }
365 
366 
368 {
369  m_pendingRefresh = true;
370  DoRePaint();
371 }
372 
373 
375 {
376  m_eventDispatcher = aEventDispatcher;
377 }
378 
379 
381 {
382  // Start querying GAL if it is ready
383  m_refreshTimer.StartOnce( 100 );
384 }
385 
386 
388 {
389  m_drawingEnabled = false;
390  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr, this );
391  m_pendingRefresh = false;
392  m_refreshTimer.Stop();
393 }
394 
395 
397 {
398  // Set display settings for high contrast mode
400 
401  SetTopLayer( aLayer );
402 
403  rSettings->ClearHighContrastLayers();
404  rSettings->SetLayerIsHighContrast( aLayer );
405 
407 }
408 
409 
411 {
413  m_view->SetTopLayer( aLayer );
415 }
416 
417 
419 {
420  // Do not do anything if the currently used GAL is correct
421  if( aGalType == m_backend && m_gal != nullptr )
422  return true;
423 
424  VECTOR2D grid_size = m_gal ? m_gal->GetGridSize() : VECTOR2D();
425  bool grid_visibility = m_gal ? m_gal->GetGridVisibility() : true;
426  bool result = true; // assume everything will be fine
427 
428  // Prevent refreshing canvas during backend switch
429  StopDrawing();
430 
431  KIGFX::GAL* new_gal = nullptr;
432 
433  try
434  {
435  switch( aGalType )
436  {
437  case GAL_TYPE_OPENGL:
438  {
439  wxString errormsg = KIGFX::OPENGL_GAL::CheckFeatures( m_options );
440 
441  if( errormsg.empty() )
442  {
443  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
444  }
445  else
446  {
447  if( GAL_FALLBACK != aGalType )
448  {
449  aGalType = GAL_FALLBACK;
451  m_parent,
452  _( "Could not use OpenGL, falling back to software rendering" ),
453  errormsg );
454  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
455  }
456  else
457  {
458  // We're well and truly banjaxed if we get here without a fallback.
459  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), errormsg );
460  }
461  }
462  break;
463  }
464 
465  case GAL_TYPE_CAIRO: new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this ); break;
466 
467  default:
468  wxASSERT( false );
470  // warn about unhandled GAL canvas type, but continue with the fallback option
471 
472  case GAL_TYPE_NONE:
473  // KIGFX::GAL is a stub - it actually does cannot display anything,
474  // but prevents code relying on GAL canvas existence from crashing
475  new_gal = new KIGFX::GAL( m_options );
476  break;
477  }
478  }
479  catch( std::runtime_error& err )
480  {
481  // Create a dummy GAL
482  new_gal = new KIGFX::GAL( m_options );
483  aGalType = GAL_TYPE_NONE;
484  DisplayError( m_parent, wxString( err.what() ) );
485  result = false;
486  }
487 
488  // trigger update of the gal options in case they differ from the defaults
490 
491  delete m_gal;
492  m_gal = new_gal;
493 
494  wxSize clientSize = GetClientSize();
495  clientSize.x = std::max( 10, clientSize.x );
496  clientSize.y = std::max( 10, clientSize.y );
497  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
498 
499  if( grid_size.x > 0 && grid_size.y > 0 )
500  m_gal->SetGridSize( grid_size );
501 
502  m_gal->SetGridVisibility( grid_visibility );
503 
504  // Make sure the cursor is set on the new canvas
506 
507  if( m_painter )
508  m_painter->SetGAL( m_gal );
509 
510  if( m_view )
511  {
512  m_view->SetGAL( m_gal );
513  // Note: OpenGL requires reverse draw order when draw priority is enabled
514  m_view->ReverseDrawOrder( aGalType == GAL_TYPE_OPENGL );
515  }
516 
517  m_backend = aGalType;
518 
519  return result;
520 }
521 
522 
523 void EDA_DRAW_PANEL_GAL::OnEvent( wxEvent& aEvent )
524 {
525  bool shouldSetFocus = m_lostFocus && m_stealsFocus
526  && !KIUI::IsInputControlFocused() // Don't steal from input controls
527  && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
528  && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
529 
530  if( shouldSetFocus )
531  SetFocus();
532 
533  if( !m_eventDispatcher )
534  aEvent.Skip();
535  else
537 
538  Refresh();
539 }
540 
541 
542 void EDA_DRAW_PANEL_GAL::onEnter( wxMouseEvent& aEvent )
543 {
544  bool shouldSetFocus = m_stealsFocus
545  && !KIUI::IsInputControlFocused() // Don't steal from input controls
546  && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
547  && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
548 
549  // Getting focus is necessary in order to receive key events properly
550  if( shouldSetFocus )
551  SetFocus();
552 
553  aEvent.Skip();
554 }
555 
556 
557 void EDA_DRAW_PANEL_GAL::onLostFocus( wxFocusEvent& aEvent )
558 {
559  m_lostFocus = true;
560 
562 
563  aEvent.Skip();
564 }
565 
566 
567 void EDA_DRAW_PANEL_GAL::onRefreshTimer( wxTimerEvent& aEvent )
568 {
569  if( !m_drawingEnabled )
570  {
571  if( m_gal && m_gal->IsInitialized() )
572  {
573  m_drawing = false;
574  m_pendingRefresh = true;
575  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr,
576  this );
577  m_drawingEnabled = true;
578  }
579  else
580  {
581  // Try again soon
582  m_refreshTimer.StartOnce( 100 );
583  return;
584  }
585  }
586 
587  DoRePaint();
588 }
589 
590 
591 void EDA_DRAW_PANEL_GAL::onShowTimer( wxTimerEvent& aEvent )
592 {
593  if( m_gal && m_gal->IsVisible() )
594  {
595  m_onShowTimer.Stop();
596  OnShow();
597  }
598 }
599 
600 
602 {
603  if( m_gal )
604  m_gal->SetNativeCursorStyle( aCursor );
605 }
606 
607 
608 std::shared_ptr<KIGFX::VIEW_OVERLAY> EDA_DRAW_PANEL_GAL::DebugOverlay()
609 {
610  if( !m_debugOverlay )
611  {
612  m_debugOverlay.reset( new KIGFX::VIEW_OVERLAY() );
613  m_view->Add( m_debugOverlay.get() );
614  }
615 
616  return m_debugOverlay;
617 }
618 
619 
621 {
622  if( m_debugOverlay )
623  {
624  m_view->Remove( m_debugOverlay.get() );
625  m_debugOverlay = nullptr;
626  }
627 }
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 void LockContext(int aClientCookie)
Use GAL_CONTEXT_LOCKER RAII object unless you know what you're doing.
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
virtual void UnlockContext(int aClientCookie)
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.
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.
virtual void BeginDrawing()
Start/end drawing functions, draw calls can be only made in between the calls to BeginDrawing()/EndDr...
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
virtual void EndDrawing()
End the drawing, needs to be called for every new frame.
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.