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 <tomasz.wlostowski@cern.ch>
8  * @author Maciej Suminski <maciej.suminski@cern.ch>
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_i.h>
31 #include <macros.h>
32 #include <settings/app_settings.h>
33 #include <cursors.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>
41 #include <gal/opengl/opengl_gal.h>
42 #include <gal/cairo/cairo_gal.h>
43 
44 
45 #include <tool/tool_dispatcher.h>
46 #include <tool/tool_manager.h>
47 
48 #include <widgets/infobar.h>
49 
50 #ifdef PROFILE
51 #include <profile.h>
52 #endif /* PROFILE */
53 
54 
55 EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
56  const wxPoint& aPosition, const wxSize& aSize,
57  KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
58  wxScrolledCanvas( aParentWindow, aWindowId, aPosition, aSize ),
59  m_edaFrame( nullptr ),
60  m_gal( nullptr ),
61  m_view( nullptr ),
62  m_painter( nullptr ),
63  m_viewControls( nullptr ),
64  m_backend( GAL_TYPE_NONE ),
65  m_options( aOptions ),
66  m_eventDispatcher( nullptr ),
67  m_lostFocus( false ),
68  m_stealsFocus( true )
69 {
70  m_parent = aParentWindow;
73 
74  SetLayoutDirection( wxLayout_LeftToRight );
75 
76  m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( m_parent );
77 
78  // If we're in a dialog, we have to go looking for our parent frame
79  if( !m_edaFrame )
80  {
81  wxWindow* ancestor = aParentWindow->GetParent();
82 
83  while( ancestor && !dynamic_cast<EDA_DRAW_FRAME*>( ancestor ) )
84  ancestor = ancestor->GetParent();
85 
86  if( ancestor )
87  m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( ancestor );
88  }
89 
90  SwitchBackend( aGalType );
91  SetBackgroundStyle( wxBG_STYLE_CUSTOM );
92 
93  ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
94  EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
95 
96  Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), NULL, this );
97  Connect( wxEVT_ENTER_WINDOW, wxMouseEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), NULL, this );
98  Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), NULL, this );
99  Connect( wxEVT_SET_CURSOR, wxSetCursorEventHandler( EDA_DRAW_PANEL_GAL::onSetCursor ), NULL,
100  this );
101 
102  const wxEventType events[] = {
103  // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
104  // especially special key like arrow keys, are handled by the GAL event dispatcher,
105  // and not sent to GUI without filtering, because they have a default action (scroll)
106  // that must not be called.
107  wxEVT_LEFT_UP,
108  wxEVT_LEFT_DOWN,
109  wxEVT_LEFT_DCLICK,
110  wxEVT_RIGHT_UP,
111  wxEVT_RIGHT_DOWN,
112  wxEVT_RIGHT_DCLICK,
113  wxEVT_MIDDLE_UP,
114  wxEVT_MIDDLE_DOWN,
115  wxEVT_MIDDLE_DCLICK,
116  wxEVT_MOTION,
117  wxEVT_MOUSEWHEEL,
118  wxEVT_CHAR,
119  wxEVT_CHAR_HOOK,
120 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
121  wxEVT_MAGNIFY,
122 #endif
124  };
125 
126  for( wxEventType eventType : events )
127  Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::OnEvent ), NULL,
129 
130  m_pendingRefresh = false;
131  m_drawing = false;
132  m_drawingEnabled = false;
133 
134  // Set up timer that prevents too frequent redraw commands
135  m_refreshTimer.SetOwner( this );
136  Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
137  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), NULL, this );
138 
139  // Set up timer to execute OnShow() method when the window appears on the screen
140  m_onShowTimer.SetOwner( this );
141  Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
142  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), NULL, this );
143  m_onShowTimer.Start( 10 );
144 }
145 
146 
148 {
149  StopDrawing();
150 
151  wxASSERT( !m_drawing );
152 
153  delete m_viewControls;
154  delete m_view;
155  delete m_gal;
156 }
157 
158 
160 {
161  wxScrolledCanvas::SetFocus();
162  m_lostFocus = false;
163 }
164 
165 
166 void EDA_DRAW_PANEL_GAL::onPaint( wxPaintEvent& WXUNUSED( aEvent ) )
167 {
168  DoRePaint();
169 }
170 
171 
173 {
174  // Repaint the canvas, and fix scrollbar cursors
175  // Usually called by a OnPaint event, but because it does not use a wxPaintDC,
176  // it can be called outside a wxPaintEvent.
177 
178  // Update current zoom settings if the canvas is managed by a EDA frame
179  // (i.e. not by a preview panel in a dialog)
180  if( !IsDialogPreview() && GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
182 
184 
185  if( !m_gal->IsVisible() )
186  return;
187 
188  m_pendingRefresh = false;
189 
190  if( m_drawing )
191  return;
192 
193 #ifdef PROFILE
194  PROF_COUNTER totalRealTime;
195 #endif /* PROFILE */
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  try
204  {
205  m_view->UpdateItems();
206 
208 
211  {
212  m_view->MarkDirty();
213  }
214 
215  m_gal->SetClearColor( settings->GetBackgroundColor() );
216  m_gal->SetGridColor( settings->GetGridColor() );
217  m_gal->SetCursorColor( settings->GetCursorColor() );
218 
219  // TODO: find why ClearScreen() must be called here in opengl mode
220  // and only if m_view->IsDirty() in Cairo mode to avoid display artifacts
221  // when moving the mouse cursor
222  if( m_backend == GAL_TYPE_OPENGL )
223  m_gal->ClearScreen();
224 
225  if( m_view->IsDirty() )
226  {
227  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
229  m_gal->ClearScreen();
230 
231  m_view->ClearTargets();
232 
233  // Grid has to be redrawn only when the NONCACHED target is redrawn
235  m_gal->DrawGrid();
236 
237  m_view->Redraw();
238  }
239 
241  }
242  catch( std::exception& err )
243  {
244  if( GAL_FALLBACK != m_backend )
245  {
247 
249  _( "Could not use OpenGL, falling back to software rendering" ),
250  wxString( err.what() ) );
251  }
252  else
253  {
254  // We're well and truly banjaxed if we get here without a fallback.
255  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), wxString( err.what() ) );
256  }
257  }
258 
259 #ifdef PROFILE
260  totalRealTime.Stop();
261  wxLogTrace( "GAL_PROFILE", "EDA_DRAW_PANEL_GAL::DoRePaint(): %.1f ms", totalRealTime.msecs() );
262 #endif /* PROFILE */
263 
264  m_lastRefresh = wxGetLocalTimeMillis();
265  m_drawing = false;
266 }
267 
268 
269 void EDA_DRAW_PANEL_GAL::onSize( wxSizeEvent& aEvent )
270 {
271  // If we get a second wx update call before the first finishes, don't crash
272  if( m_gal->IsContextLocked() )
273  return;
274 
276  wxSize clientSize = GetClientSize();
277  WX_INFOBAR* infobar = GetParentEDAFrame() ? GetParentEDAFrame()->GetInfoBar() : nullptr;
278 
279  if( VECTOR2I( clientSize ) == m_gal->GetScreenPixelSize() )
280  return;
281 
282  clientSize.x = std::max( 10, clientSize.x );
283  clientSize.y = std::max( 10, clientSize.y );
284 
285  VECTOR2D bottom( 0, 0 );
286 
287  if( m_view )
288  bottom = m_view->ToWorld( m_gal->GetScreenPixelSize(), true );
289 
290  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
291 
292  if( m_view )
293  {
294  if( infobar && infobar->IsLocked() )
295  m_view->SetCenter( bottom - m_view->ToWorld( clientSize, false ) / 2.0 );
296 
299  }
300 }
301 
302 
303 void EDA_DRAW_PANEL_GAL::Refresh( bool aEraseBackground, const wxRect* aRect )
304 {
305  wxLongLong t = wxGetLocalTimeMillis();
306  wxLongLong delta = t - m_lastRefresh;
307 
308  // If it has been too long since the last frame (possible depending on platform timer latency),
309  // just do a refresh. Otherwise, start the refresh timer if it hasn't already been started.
310  // This ensures that we will render often enough but not too often.
311  if( delta >= MinRefreshPeriod )
312  {
313  if( !m_pendingRefresh )
314  ForceRefresh();
315 
316  m_refreshTimer.Start( MinRefreshPeriod, true );
317  }
318  else if( !m_refreshTimer.IsRunning() )
319  {
320  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
321  }
322 }
323 
324 
326 {
327  m_pendingRefresh = true;
328  DoRePaint();
329 }
330 
331 
333 {
334  m_eventDispatcher = aEventDispatcher;
335  const wxEventType eventTypes[] = { wxEVT_TOOL };
336 
337  if( m_eventDispatcher )
338  {
339  for( wxEventType type : eventTypes )
340  {
341  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
343  }
344  }
345  else
346  {
347  for( wxEventType type : eventTypes )
348  {
349  // While loop is used to be sure that all event handlers are removed.
350  while( m_parent->Disconnect(
351  type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ), NULL,
353  ;
354  }
355  }
356 }
357 
358 
360 {
361  // Start querying GAL if it is ready
362  m_refreshTimer.StartOnce( 100 );
363 }
364 
365 
367 {
368  m_drawingEnabled = false;
369  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
370  m_pendingRefresh = false;
371  m_refreshTimer.Stop();
372 }
373 
374 
376 {
377  // Set display settings for high contrast mode
379 
380  SetTopLayer( aLayer );
381 
382  rSettings->ClearHighContrastLayers();
383  rSettings->SetLayerIsHighContrast( aLayer );
384 
386 }
387 
388 
390 {
392  m_view->SetTopLayer( aLayer );
394 }
395 
396 
398 {
399  // Do not do anything if the currently used GAL is correct
400  if( aGalType == m_backend && m_gal != NULL )
401  return true;
402 
403  VECTOR2D grid_size = m_gal ? m_gal->GetGridSize() : VECTOR2D();
404  bool grid_visibility = m_gal ? m_gal->GetGridVisibility() : true;
405  bool result = true; // assume everything will be fine
406 
407  // Prevent refreshing canvas during backend switch
408  StopDrawing();
409 
410  KIGFX::GAL* new_gal = NULL;
411 
412  try
413  {
414  switch( aGalType )
415  {
416  case GAL_TYPE_OPENGL:
417  {
418  wxString errormsg = KIGFX::OPENGL_GAL::CheckFeatures( m_options );
419 
420  if( errormsg.empty() )
421  {
422  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
423  }
424  else
425  {
426  if( GAL_FALLBACK != aGalType )
427  {
428  aGalType = GAL_FALLBACK;
430  m_parent,
431  _( "Could not use OpenGL, falling back to software rendering" ),
432  errormsg );
433  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
434  }
435  else
436  {
437  // We're well and truly banjaxed if we get here without a fallback.
438  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), errormsg );
439  }
440  }
441  break;
442  }
443 
444  case GAL_TYPE_CAIRO: new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this ); break;
445 
446  default:
447  wxASSERT( false );
449  // warn about unhandled GAL canvas type, but continue with the fallback option
450 
451  case GAL_TYPE_NONE:
452  // KIGFX::GAL is a stub - it actually does cannot display anything,
453  // but prevents code relying on GAL canvas existence from crashing
454  new_gal = new KIGFX::GAL( m_options );
455  break;
456  }
457  }
458  catch( std::runtime_error& err )
459  {
460  // Create a dummy GAL
461  new_gal = new KIGFX::GAL( m_options );
462  aGalType = GAL_TYPE_NONE;
463  DisplayError( m_parent, wxString( err.what() ) );
464  result = false;
465  }
466 
467  // trigger update of the gal options in case they differ from the defaults
469 
470  wxWindow* galWindow = dynamic_cast<wxWindow*>( new_gal );
471 
472  if( galWindow )
473  {
474  galWindow->Connect( wxEVT_SET_CURSOR,
475  wxSetCursorEventHandler( EDA_DRAW_PANEL_GAL::onSetCursor ), NULL,
476  this );
477  }
478 
479  delete m_gal;
480  m_gal = new_gal;
481 
482  wxSize clientSize = GetClientSize();
483  clientSize.x = std::max( 10, clientSize.x );
484  clientSize.y = std::max( 10, clientSize.y );
485  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
486 
487  if( grid_size.x > 0 && grid_size.y > 0 )
488  m_gal->SetGridSize( grid_size );
489 
490  m_gal->SetGridVisibility( grid_visibility );
491 
492  if( m_painter )
493  m_painter->SetGAL( m_gal );
494 
495  if( m_view )
496  {
497  m_view->SetGAL( m_gal );
498  // Note: OpenGL requires reverse draw order when draw priority is enabled
499  m_view->ReverseDrawOrder( aGalType == GAL_TYPE_OPENGL );
500  }
501 
502  m_backend = aGalType;
503 
504  return result;
505 }
506 
507 
508 void EDA_DRAW_PANEL_GAL::OnEvent( wxEvent& aEvent )
509 {
510  bool shouldSetFocus = m_lostFocus && m_stealsFocus && !KIUI::IsInputControlFocused()
512 
513 #if defined( _WIN32 )
514  // Ensure we are the active foreground window before we attempt to steal focus
515  // mouse events are generated on Win32 regardless if window is active
516  shouldSetFocus = shouldSetFocus && ( m_edaFrame->GetHWND() == GetForegroundWindow() );
517 #endif
518 
519  if( shouldSetFocus )
520  SetFocus();
521 
522  if( !m_eventDispatcher )
523  aEvent.Skip();
524  else
526 
527  Refresh();
528 }
529 
530 
531 void EDA_DRAW_PANEL_GAL::onEnter( wxMouseEvent& aEvent )
532 {
533  bool shouldSetFocus =
535 
536 #if defined( _WIN32 )
537  // Ensure we are the active foreground window before we attempt to steal focus
538  // mouse events are generated on Win32 regardless if window is active
539  shouldSetFocus = shouldSetFocus && ( m_edaFrame->GetHWND() == GetForegroundWindow() );
540 #endif
541 
542  // Getting focus is necessary in order to receive key events properly
543  if( shouldSetFocus )
544  SetFocus();
545 
546  aEvent.Skip();
547 }
548 
549 
550 void EDA_DRAW_PANEL_GAL::onLostFocus( wxFocusEvent& aEvent )
551 {
552  m_lostFocus = true;
553 
555 
556  aEvent.Skip();
557 }
558 
559 
560 void EDA_DRAW_PANEL_GAL::onRefreshTimer( wxTimerEvent& aEvent )
561 {
562  if( !m_drawingEnabled )
563  {
564  if( m_gal && m_gal->IsInitialized() )
565  {
566  m_drawing = false;
567  m_pendingRefresh = true;
568  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
569  m_drawingEnabled = true;
570  }
571  else
572  {
573  // Try again soon
574  m_refreshTimer.StartOnce( 100 );
575  return;
576  }
577  }
578 
579  DoRePaint();
580 }
581 
582 
583 void EDA_DRAW_PANEL_GAL::onShowTimer( wxTimerEvent& aEvent )
584 {
585  if( m_gal && m_gal->IsVisible() )
586  {
587  m_onShowTimer.Stop();
588  OnShow();
589  }
590 }
591 
592 
594 {
595  if( m_currentKiCursor == cursor )
596  return;
597 
599  m_currentKiCursor = cursor;
600 
601  SetCursor( m_currentCursor );
602 }
603 
604 
605 void EDA_DRAW_PANEL_GAL::onSetCursor( wxSetCursorEvent& event )
606 {
607  event.SetCursor( m_currentCursor );
608 }
609 
610 
611 std::shared_ptr<KIGFX::VIEW_OVERLAY> EDA_DRAW_PANEL_GAL::DebugOverlay()
612 {
613  if( !m_debugOverlay )
614  {
615  m_debugOverlay.reset( new KIGFX::VIEW_OVERLAY() );
616  m_view->Add( m_debugOverlay.get() );
617  }
618 
619  return m_debugOverlay;
620 }
621 
622 
624 {
625  if( m_debugOverlay )
626  {
627  m_view->Remove( m_debugOverlay.get() );
628  m_debugOverlay = nullptr;
629  }
630 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:253
void Stop()
Save the time when this function was called, and set the counter stane to stop.
Definition: profile.h:85
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.
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:149
void ReverseDrawOrder(bool aFlag)
Only takes effect if UseDrawPriority is true.
Definition: view.h:661
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:832
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:450
virtual const COLOR4D & GetBackgroundColor()=0
Return current background color settings.
double msecs(bool aSinceLast=false)
Definition: profile.h:146
const VECTOR2D & GetCenter() const
Return the center point of this VIEW (in world space coordinates).
Definition: view.h:333
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:65
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition: view.cpp:351
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
KICURSOR
Definition: cursors.h:33
void UpdateAllLayersOrder()
Do everything that is needed to apply the rendering order of layers.
Definition: view.cpp:899
void DoRePaint()
Repaint the canvas, and fix scrollbar cursors.
void onShowTimer(wxTimerEvent &aEvent)
VECTOR2< int > VECTOR2I
Definition: vector2d.h:623
A small class to help profiling.
Definition: profile.h:45
void ClearDebugOverlay()
Clear the contents of the debug overlay and removes it from the VIEW.
void SetCurrentCursor(KICURSOR cursor)
Set the current cursor shape for this panel.
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:207
void onEnter(wxMouseEvent &aEvent)
WX_VIEW_CONTROLS class definition.
bool IsInputControlFocused()
Checks if a input control has focus.
Definition: ui_common.cpp:137
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:210
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
wxWindow * m_parent
Pointer to the parent window.
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:579
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
#define NULL
VECTOR2< double > VECTOR2D
Definition: vector2d.h:622
virtual void Redraw()
Immediately redraws the whole view.
Definition: view.cpp:1117
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:574
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:563
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.
static const wxCursor GetCursor(KICURSOR aCursorType)
Definition: cursors.cpp:392
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()
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
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.
virtual void SetFocus() override
void SetLayerIsHighContrast(int aLayerId, bool aEnabled=true)
Set the specified layer as high-contrast.
void UpdateItems()
Iterate through the list of items that asked for updating and updates them.
Definition: view.cpp:1389
void onSetCursor(wxSetCursorEvent &event)
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.
void onSize(wxSizeEvent &aEvent)
void StartDrawing()
Begin drawing if it was stopped previously.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
void ClearTopLayers()
Remove all layers from the on-the-top set (they are no longer displayed over the rest of layers).
Definition: view.cpp:884
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:71
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.
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:327
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
virtual void DispatchWxCommand(wxCommandEvent &aEvent)
Process wxCommands (mostly menu related events) and runs appropriate actions (eg.
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
#define _(s)
Definition: 3d_actions.cpp:33
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.
VECTOR2D GetCursorPosition(bool aSnappingEnabled) const override
<
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:1098
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()
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:321
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:104
bool GetGridVisibility() const
wxCursor m_currentCursor
Current mouse cursor shape id.
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition: view.cpp:770
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:494
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:281
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.
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:598
bool IsDirty() const
Return true if any of the VIEW layers needs to be refreshened.
Definition: view.h:546
Abstract interface for drawing on a 2D-surface.