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_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 #ifdef PROFILE
54 #include <profile.h>
55 #endif /* PROFILE */
56 
57 
58 EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
59  const wxPoint& aPosition, const wxSize& aSize,
60  KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
61  wxScrolledCanvas( aParentWindow, aWindowId, aPosition, aSize ),
62  m_edaFrame( nullptr ),
63  m_gal( nullptr ),
64  m_view( nullptr ),
65  m_painter( nullptr ),
66  m_viewControls( nullptr ),
67  m_backend( GAL_TYPE_NONE ),
68  m_options( aOptions ),
69  m_eventDispatcher( nullptr ),
70  m_lostFocus( false ),
71  m_stealsFocus( true )
72 {
73  m_parent = aParentWindow;
74  m_MouseCapturedLost = false;
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 #ifdef PROFILE
196  PROF_COUNTER totalRealTime;
197 #endif /* PROFILE */
198 
199  wxASSERT( m_painter );
200 
201  m_drawing = true;
202  KIGFX::RENDER_SETTINGS* settings =
203  static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
204 
205  try
206  {
207  m_view->UpdateItems();
208 
210 
213  {
214  m_view->MarkDirty();
215  }
216 
217  m_gal->SetClearColor( settings->GetBackgroundColor() );
218  m_gal->SetGridColor( settings->GetGridColor() );
219  m_gal->SetCursorColor( settings->GetCursorColor() );
220 
221  // TODO: find why ClearScreen() must be called here in opengl mode
222  // and only if m_view->IsDirty() in Cairo mode to avoid display artifacts
223  // when moving the mouse cursor
224  if( m_backend == GAL_TYPE_OPENGL )
225  m_gal->ClearScreen();
226 
227  if( m_view->IsDirty() )
228  {
229  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
231  m_gal->ClearScreen();
232 
233  m_view->ClearTargets();
234 
235  // Grid has to be redrawn only when the NONCACHED target is redrawn
237  m_gal->DrawGrid();
238 
239  m_view->Redraw();
240  }
241 
243  }
244  catch( std::exception& err )
245  {
246  if( GAL_FALLBACK != m_backend )
247  {
249 
251  _( "Could not use OpenGL, falling back to software rendering" ),
252  wxString( err.what() ) );
253  }
254  else
255  {
256  // We're well and truly banjaxed if we get here without a fallback.
257  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), wxString( err.what() ) );
258  }
259  }
260 
261 #ifdef PROFILE
262  totalRealTime.Stop();
263  wxLogTrace( traceGalProfile, "EDA_DRAW_PANEL_GAL::DoRePaint(): %.1f ms",
264  totalRealTime.msecs() );
265 #endif /* PROFILE */
266 
267  m_lastRefresh = wxGetLocalTimeMillis();
268  m_drawing = false;
269 }
270 
271 
272 void EDA_DRAW_PANEL_GAL::onSize( wxSizeEvent& aEvent )
273 {
274  // If we get a second wx update call before the first finishes, don't crash
275  if( m_gal->IsContextLocked() )
276  return;
277 
279  wxSize clientSize = GetClientSize();
280  WX_INFOBAR* infobar = GetParentEDAFrame() ? GetParentEDAFrame()->GetInfoBar() : nullptr;
281 
282  if( VECTOR2I( clientSize ) == m_gal->GetScreenPixelSize() )
283  return;
284 
285  clientSize.x = std::max( 10, clientSize.x );
286  clientSize.y = std::max( 10, clientSize.y );
287 
288  VECTOR2D bottom( 0, 0 );
289 
290  if( m_view )
291  bottom = m_view->ToWorld( m_gal->GetScreenPixelSize(), true );
292 
293  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
294 
295  if( m_view )
296  {
297  if( infobar && infobar->IsLocked() )
298  m_view->SetCenter( bottom - m_view->ToWorld( clientSize, false ) / 2.0 );
299 
302  }
303 }
304 
305 
306 void EDA_DRAW_PANEL_GAL::Refresh( bool aEraseBackground, const wxRect* aRect )
307 {
308  wxLongLong t = wxGetLocalTimeMillis();
309  wxLongLong delta = t - m_lastRefresh;
310 
311  // If it has been too long since the last frame (possible depending on platform timer latency),
312  // just do a refresh. Otherwise, start the refresh timer if it hasn't already been started.
313  // This ensures that we will render often enough but not too often.
314  if( delta >= MinRefreshPeriod )
315  {
316  if( !m_pendingRefresh )
317  ForceRefresh();
318 
319  m_refreshTimer.Start( MinRefreshPeriod, true );
320  }
321  else if( !m_refreshTimer.IsRunning() )
322  {
323  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
324  }
325 }
326 
327 
329 {
330  m_pendingRefresh = true;
331  DoRePaint();
332 }
333 
334 
336 {
337  m_eventDispatcher = aEventDispatcher;
338 }
339 
340 
342 {
343  // Start querying GAL if it is ready
344  m_refreshTimer.StartOnce( 100 );
345 }
346 
347 
349 {
350  m_drawingEnabled = false;
351  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr, this );
352  m_pendingRefresh = false;
353  m_refreshTimer.Stop();
354 }
355 
356 
358 {
359  // Set display settings for high contrast mode
361 
362  SetTopLayer( aLayer );
363 
364  rSettings->ClearHighContrastLayers();
365  rSettings->SetLayerIsHighContrast( aLayer );
366 
368 }
369 
370 
372 {
374  m_view->SetTopLayer( aLayer );
376 }
377 
378 
380 {
381  // Do not do anything if the currently used GAL is correct
382  if( aGalType == m_backend && m_gal != nullptr )
383  return true;
384 
385  VECTOR2D grid_size = m_gal ? m_gal->GetGridSize() : VECTOR2D();
386  bool grid_visibility = m_gal ? m_gal->GetGridVisibility() : true;
387  bool result = true; // assume everything will be fine
388 
389  // Prevent refreshing canvas during backend switch
390  StopDrawing();
391 
392  KIGFX::GAL* new_gal = nullptr;
393 
394  try
395  {
396  switch( aGalType )
397  {
398  case GAL_TYPE_OPENGL:
399  {
400  wxString errormsg = KIGFX::OPENGL_GAL::CheckFeatures( m_options );
401 
402  if( errormsg.empty() )
403  {
404  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
405  }
406  else
407  {
408  if( GAL_FALLBACK != aGalType )
409  {
410  aGalType = GAL_FALLBACK;
412  m_parent,
413  _( "Could not use OpenGL, falling back to software rendering" ),
414  errormsg );
415  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
416  }
417  else
418  {
419  // We're well and truly banjaxed if we get here without a fallback.
420  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), errormsg );
421  }
422  }
423  break;
424  }
425 
426  case GAL_TYPE_CAIRO: new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this ); break;
427 
428  default:
429  wxASSERT( false );
431  // warn about unhandled GAL canvas type, but continue with the fallback option
432 
433  case GAL_TYPE_NONE:
434  // KIGFX::GAL is a stub - it actually does cannot display anything,
435  // but prevents code relying on GAL canvas existence from crashing
436  new_gal = new KIGFX::GAL( m_options );
437  break;
438  }
439  }
440  catch( std::runtime_error& err )
441  {
442  // Create a dummy GAL
443  new_gal = new KIGFX::GAL( m_options );
444  aGalType = GAL_TYPE_NONE;
445  DisplayError( m_parent, wxString( err.what() ) );
446  result = false;
447  }
448 
449  // trigger update of the gal options in case they differ from the defaults
451 
452  delete m_gal;
453  m_gal = new_gal;
454 
455  wxSize clientSize = GetClientSize();
456  clientSize.x = std::max( 10, clientSize.x );
457  clientSize.y = std::max( 10, clientSize.y );
458  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
459 
460  if( grid_size.x > 0 && grid_size.y > 0 )
461  m_gal->SetGridSize( grid_size );
462 
463  m_gal->SetGridVisibility( grid_visibility );
464 
465  // Make sure the cursor is set on the new canvas
467 
468  if( m_painter )
469  m_painter->SetGAL( m_gal );
470 
471  if( m_view )
472  {
473  m_view->SetGAL( m_gal );
474  // Note: OpenGL requires reverse draw order when draw priority is enabled
475  m_view->ReverseDrawOrder( aGalType == GAL_TYPE_OPENGL );
476  }
477 
478  m_backend = aGalType;
479 
480  return result;
481 }
482 
483 
484 void EDA_DRAW_PANEL_GAL::OnEvent( wxEvent& aEvent )
485 {
486  bool shouldSetFocus = m_lostFocus && m_stealsFocus
487  && !KIUI::IsInputControlFocused() // Don't steal from input controls
488  && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
489  && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
490 
491  if( shouldSetFocus )
492  SetFocus();
493 
494  if( !m_eventDispatcher )
495  aEvent.Skip();
496  else
498 
499  Refresh();
500 }
501 
502 
503 void EDA_DRAW_PANEL_GAL::onEnter( wxMouseEvent& aEvent )
504 {
505  bool shouldSetFocus = m_stealsFocus
506  && !KIUI::IsInputControlFocused() // Don't steal from input controls
507  && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
508  && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
509 
510  // Getting focus is necessary in order to receive key events properly
511  if( shouldSetFocus )
512  SetFocus();
513 
514  aEvent.Skip();
515 }
516 
517 
518 void EDA_DRAW_PANEL_GAL::onLostFocus( wxFocusEvent& aEvent )
519 {
520  m_lostFocus = true;
521 
523 
524  aEvent.Skip();
525 }
526 
527 
528 void EDA_DRAW_PANEL_GAL::onRefreshTimer( wxTimerEvent& aEvent )
529 {
530  if( !m_drawingEnabled )
531  {
532  if( m_gal && m_gal->IsInitialized() )
533  {
534  m_drawing = false;
535  m_pendingRefresh = true;
536  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr,
537  this );
538  m_drawingEnabled = true;
539  }
540  else
541  {
542  // Try again soon
543  m_refreshTimer.StartOnce( 100 );
544  return;
545  }
546  }
547 
548  DoRePaint();
549 }
550 
551 
552 void EDA_DRAW_PANEL_GAL::onShowTimer( wxTimerEvent& aEvent )
553 {
554  if( m_gal && m_gal->IsVisible() )
555  {
556  m_onShowTimer.Stop();
557  OnShow();
558  }
559 }
560 
561 
563 {
564  if( m_gal )
565  m_gal->SetNativeCursorStyle( aCursor );
566 }
567 
568 
569 std::shared_ptr<KIGFX::VIEW_OVERLAY> EDA_DRAW_PANEL_GAL::DebugOverlay()
570 {
571  if( !m_debugOverlay )
572  {
573  m_debugOverlay.reset( new KIGFX::VIEW_OVERLAY() );
574  m_view->Add( m_debugOverlay.get() );
575  }
576 
577  return m_debugOverlay;
578 }
579 
580 
582 {
583  if( m_debugOverlay )
584  {
585  m_view->Remove( m_debugOverlay.get() );
586  m_debugOverlay = nullptr;
587  }
588 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:279
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.
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:830
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:447
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: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:348
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:897
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.
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:576
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:622
virtual void Redraw()
Immediately redraws the whole view.
Definition: view.cpp:1138
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()
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.
void UpdateItems()
Iterate through the list of items that asked for updating and updates them.
Definition: view.cpp:1406
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.
void ClearTopLayers()
Remove all layers from the on-the-top set (they are no longer displayed over the rest of layers).
Definition: view.cpp:882
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:334
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
<
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:1119
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:318
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:766
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:491
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.
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.