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-2020 KiCad Developers, see AUTHORS.txt for contributors.
6  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
7  * @author Maciej Suminski <maciej.suminski@cern.ch>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
27 #include <confirm.h>
28 #include <eda_draw_frame.h>
29 #include <kiface_i.h>
30 #include <macros.h>
31 #include <settings/app_settings.h>
32 #include <cursors.h>
33 
34 #include <class_draw_panel_gal.h>
35 #include <view/view.h>
36 #include <view/wx_view_controls.h>
37 #include <painter.h>
38 #include <base_screen.h>
40 #include <gal/opengl/opengl_gal.h>
41 #include <gal/cairo/cairo_gal.h>
42 
43 
44 #include <tool/tool_dispatcher.h>
45 #include <tool/tool_manager.h>
46 
47 #include <widgets/infobar.h>
48 
49 #ifdef PROFILE
50 #include <profile.h>
51 #endif /* PROFILE */
52 
53 
54 EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
55  const wxPoint& aPosition, const wxSize& aSize,
57  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, this );
100 
101  const wxEventType events[] =
102  {
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, wxEVT_LEFT_DOWN, wxEVT_LEFT_DCLICK,
108  wxEVT_RIGHT_UP, wxEVT_RIGHT_DOWN, wxEVT_RIGHT_DCLICK,
109  wxEVT_MIDDLE_UP, wxEVT_MIDDLE_DOWN, wxEVT_MIDDLE_DCLICK,
110  wxEVT_MOTION, wxEVT_MOUSEWHEEL, wxEVT_CHAR, wxEVT_CHAR_HOOK,
111 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
112  wxEVT_MAGNIFY,
113 #endif
115  };
116 
117  for( wxEventType eventType : events )
118  Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::OnEvent ), NULL, m_eventDispatcher );
119 
120  m_pendingRefresh = false;
121  m_drawing = false;
122  m_drawingEnabled = false;
123 
124  // Set up timer that prevents too frequent redraw commands
125  m_refreshTimer.SetOwner( this );
126  Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
127  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), NULL, this );
128 
129  // Set up timer to execute OnShow() method when the window appears on the screen
130  m_onShowTimer.SetOwner( this );
131  Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
132  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), NULL, this );
133  m_onShowTimer.Start( 10 );
134 }
135 
136 
138 {
139  StopDrawing();
140 
141  wxASSERT( !m_drawing );
142 
143  delete m_viewControls;
144  delete m_view;
145  delete m_gal;
146 }
147 
148 
150 {
151  wxScrolledCanvas::SetFocus();
152  m_lostFocus = false;
153 }
154 
155 
156 void EDA_DRAW_PANEL_GAL::onPaint( wxPaintEvent& WXUNUSED( aEvent ) )
157 {
158  DoRePaint();
159 }
160 
161 
163 {
164  // Repaint the canvas, and fix scrollbar cursors
165  // Usually called by a OnPaint event, but because it does not use a wxPaintDC,
166  // it can be called outside a wxPaintEvent.
167 
168  // Update current zoom settings if the canvas is managed by a EDA frame
169  // (i.e. not by a preview panel in a dialog)
170  if( !IsDialogPreview() && GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
172 
174 
175  if( !m_gal->IsVisible() )
176  return;
177 
178  m_pendingRefresh = false;
179 
180  if( m_drawing )
181  return;
182 
183 #ifdef PROFILE
184  PROF_COUNTER totalRealTime;
185 #endif /* PROFILE */
186 
187  wxASSERT( m_painter );
188 
189  m_drawing = true;
190  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
191 
192  try
193  {
194  m_view->UpdateItems();
195 
197 
200  {
201  m_view->MarkDirty();
202  }
203 
204  m_gal->SetClearColor( settings->GetBackgroundColor() );
205  m_gal->SetGridColor( settings->GetGridColor() );
206  m_gal->SetCursorColor( settings->GetCursorColor() );
207 
208  // TODO: find why ClearScreen() must be called here in opengl mode
209  // and only if m_view->IsDirty() in Cairo mode to avoid distaly artifacts
210  // when moving the mouse cursor
211  if( m_backend == GAL_TYPE_OPENGL )
212  m_gal->ClearScreen();
213 
214  if( m_view->IsDirty() )
215  {
216  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
218  m_gal->ClearScreen();
219 
220  m_view->ClearTargets();
221 
222  // Grid has to be redrawn only when the NONCACHED target is redrawn
224  m_gal->DrawGrid();
225 
226  m_view->Redraw();
227  }
228 
230  }
231  catch( std::runtime_error& err )
232  {
233  if( GAL_FALLBACK != m_backend )
234  {
236 
238  _( "Could not use OpenGL, falling back to software rendering" ),
239  wxString( err.what() ) );
240  }
241  else
242  {
243  // We're well and truly banjaxed if we get here without a fallback.
244  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), wxString( err.what() ) );
245  }
246  }
247 
248 #ifdef PROFILE
249  totalRealTime.Stop();
250  wxLogTrace( "GAL_PROFILE", "EDA_DRAW_PANEL_GAL::DoRePaint(): %.1f ms", totalRealTime.msecs() );
251 #endif /* PROFILE */
252 
253  m_lastRefresh = wxGetLocalTimeMillis();
254  m_drawing = false;
255 }
256 
257 
258 void EDA_DRAW_PANEL_GAL::onSize( wxSizeEvent& aEvent )
259 {
261  wxSize clientSize = GetClientSize();
262  WX_INFOBAR* infobar = GetParentEDAFrame() ? GetParentEDAFrame()->GetInfoBar() : nullptr;
263 
264  if( VECTOR2I( clientSize ) == m_gal->GetScreenPixelSize() )
265  return;
266 
267  clientSize.x = std::max( 10, clientSize.x );
268  clientSize.y = std::max( 10, clientSize.y );
269 
270  VECTOR2D bottom( 0, 0 );
271 
272  if( m_view )
273  bottom = m_view->ToWorld( m_gal->GetScreenPixelSize(), true );
274 
275  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
276 
277  if( m_view )
278  {
279  if( infobar && infobar->IsLocked() )
280  m_view->SetCenter( bottom - m_view->ToWorld( clientSize, false ) / 2.0 );
281 
284  }
285 }
286 
287 
288 void EDA_DRAW_PANEL_GAL::Refresh( bool aEraseBackground, const wxRect* aRect )
289 {
290  if( m_pendingRefresh )
291  return;
292 
293  m_pendingRefresh = true;
294 
295 #ifdef __WXMAC__
296  // Timers on OS X may have a high latency (seen up to 500ms and more) which
297  // makes repaints jerky. No negative impact seen without throttling, so just
298  // do an unconditional refresh for OS X.
299  ForceRefresh();
300 #else
301  wxLongLong t = wxGetLocalTimeMillis();
302  wxLongLong delta = t - m_lastRefresh;
303 
304  if( delta >= MinRefreshPeriod )
305  {
306  ForceRefresh();
307  }
308  else
309  {
310  // One shot timer
311  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
312  }
313 #endif
314 }
315 
316 
318 {
319  //wxPaintEvent redrawEvent;
320  //wxPostEvent( this, redrawEvent );
321  DoRePaint();
322 }
323 
324 
326 {
327  m_eventDispatcher = aEventDispatcher;
328  const wxEventType eventTypes[] = { wxEVT_TOOL };
329 
330  if( m_eventDispatcher )
331  {
332  for( wxEventType type : eventTypes )
333  {
334  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
336  }
337  }
338  else
339  {
340  for( wxEventType type : eventTypes )
341  {
342  // While loop is used to be sure that all event handlers are removed.
343  while( m_parent->Disconnect( type,
344  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
345  NULL, m_eventDispatcher ) );
346  }
347  }
348 }
349 
350 
352 {
353  // Start querying GAL if it is ready
354  m_refreshTimer.StartOnce( 100 );
355 }
356 
357 
359 {
360  m_drawingEnabled = false;
361  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
362  m_pendingRefresh = false;
363  m_refreshTimer.Stop();
364 }
365 
366 
368 {
369  // Set display settings for high contrast mode
371 
372  SetTopLayer( aLayer );
373 
374  rSettings->ClearHighContrastLayers();
375  rSettings->SetLayerIsHighContrast( aLayer );
376 
378 }
379 
380 
382 {
384  m_view->SetTopLayer( aLayer );
386 }
387 
388 
390 {
391  // Do not do anything if the currently used GAL is correct
392  if( aGalType == m_backend && m_gal != NULL )
393  return true;
394 
395  VECTOR2D grid_size = m_gal ? m_gal->GetGridSize() : VECTOR2D();
396  bool grid_visibility = m_gal ? m_gal->GetGridVisibility() : true;
397  bool result = true; // assume everything will be fine
398 
399  // Prevent refreshing canvas during backend switch
400  StopDrawing();
401 
402  KIGFX::GAL* new_gal = NULL;
403 
404  try
405  {
406  switch( aGalType )
407  {
408  case GAL_TYPE_OPENGL:
409  {
410  wxString errormsg = KIGFX::OPENGL_GAL::CheckFeatures( m_options );
411 
412  if( errormsg.empty() )
413  {
414  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
415  }
416  else
417  {
418  if( GAL_FALLBACK != aGalType )
419  {
420  aGalType = GAL_FALLBACK;
422  _( "Could not use OpenGL, falling back to software rendering" ),
423  errormsg );
424  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
425  }
426  else
427  {
428  // We're well and truly banjaxed if we get here without a fallback.
429  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), errormsg );
430  }
431  }
432  break;
433  }
434 
435  case GAL_TYPE_CAIRO:
436  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
437  break;
438 
439  default:
440  wxASSERT( false );
442  // warn about unhandled GAL canvas type, but continue with the fallback option
443 
444  case GAL_TYPE_NONE:
445  // KIGFX::GAL is a stub - it actually does cannot display anything,
446  // but prevents code relying on GAL canvas existence from crashing
447  new_gal = new KIGFX::GAL( m_options );
448  break;
449  }
450  }
451  catch( std::runtime_error& err )
452  {
453  // Create a dummy GAL
454  new_gal = new KIGFX::GAL( m_options );
455  aGalType = GAL_TYPE_NONE;
456  DisplayError( m_parent, wxString( err.what() ) );
457  result = false;
458  }
459 
460  // trigger update of the gal options in case they differ
461  // from the defaults
463 
464  wxWindow* galWindow = dynamic_cast<wxWindow*>( new_gal );
465 
466  if( galWindow )
467  galWindow->Connect( wxEVT_SET_CURSOR, wxSetCursorEventHandler( EDA_DRAW_PANEL_GAL::onSetCursor ), NULL, this );
468 
469  delete m_gal;
470  m_gal = new_gal;
471 
472  wxSize clientSize = GetClientSize();
473  clientSize.x = std::max( 10, clientSize.x );
474  clientSize.y = std::max( 10, clientSize.y );
475  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
476 
477  if( grid_size.x > 0 && grid_size.y > 0 )
478  m_gal->SetGridSize( grid_size );
479 
480  m_gal->SetGridVisibility( grid_visibility );
481 
482  if( m_painter )
483  m_painter->SetGAL( m_gal );
484 
485  if( m_view )
486  {
487  m_view->SetGAL( m_gal );
488  // Note: OpenGL requires reverse draw order when draw priority is enabled
489  m_view->ReverseDrawOrder( aGalType == GAL_TYPE_OPENGL );
490  }
491 
492  m_backend = aGalType;
493 
494  return result;
495 }
496 
497 
498 void EDA_DRAW_PANEL_GAL::OnEvent( wxEvent& aEvent )
499 {
500  bool shouldSetFocus = m_lostFocus && m_stealsFocus;
501 
502 #if defined( _WIN32 )
503  // Ensure we are the active foreground window before we attempt to steal focus
504  // mouse events are generated on Win32 regardless if window is active
505  shouldSetFocus = shouldSetFocus && ( m_edaFrame->GetHWND() == GetForegroundWindow() );
506 #endif
507 
508  if( shouldSetFocus )
509  SetFocus();
510 
511  if( !m_eventDispatcher )
512  aEvent.Skip();
513  else
515 
516  Refresh();
517 }
518 
519 
520 void EDA_DRAW_PANEL_GAL::onEnter( wxMouseEvent& aEvent )
521 {
522  bool shouldSetFocus = m_stealsFocus;
523 
524 #if defined( _WIN32 )
525  // Ensure we are the active foreground window before we attempt to steal focus
526  // mouse events are generated on Win32 regardless if window is active
527  shouldSetFocus = shouldSetFocus && ( m_edaFrame->GetHWND() == GetForegroundWindow() );
528 #endif
529 
530  // Getting focus is necessary in order to receive key events properly
531  if( shouldSetFocus )
532  SetFocus();
533 
534  aEvent.Skip();
535 }
536 
537 
538 void EDA_DRAW_PANEL_GAL::onLostFocus( wxFocusEvent& aEvent )
539 {
540  m_lostFocus = true;
541 
542  aEvent.Skip();
543 }
544 
545 
546 void EDA_DRAW_PANEL_GAL::onRefreshTimer( wxTimerEvent& aEvent )
547 {
548  if( !m_drawingEnabled )
549  {
550  if( m_gal && m_gal->IsInitialized() )
551  {
552  m_drawing = false;
553  m_pendingRefresh = true;
554  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
555  m_drawingEnabled = true;
556  }
557  else
558  {
559  // Try again soon
560  m_refreshTimer.StartOnce( 100 );
561  return;
562  }
563  }
564 
565  //wxPaintEvent redrawEvent;
566  //wxPostEvent( this, redrawEvent );
567  DoRePaint();
568 }
569 
570 
571 void EDA_DRAW_PANEL_GAL::onShowTimer( wxTimerEvent& aEvent )
572 {
573  if( m_gal && m_gal->IsVisible() )
574  {
575  m_onShowTimer.Stop();
576  OnShow();
577  }
578 }
579 
580 
582 {
583  if( m_currentKiCursor == cursor )
584  {
585  return;
586  }
587 
589  m_currentKiCursor = cursor;
590 
591  SetCursor( m_currentCursor );
592 }
593 
594 
595 void EDA_DRAW_PANEL_GAL::onSetCursor( wxSetCursorEvent& event )
596 {
597  event.SetCursor( m_currentCursor );
598 }
599 
600 
601 std::shared_ptr<KIGFX::VIEW_OVERLAY> EDA_DRAW_PANEL_GAL::DebugOverlay()
602 {
603  if( !m_debugOverlay )
604  {
605  m_debugOverlay.reset( new KIGFX::VIEW_OVERLAY() );
606  m_view->Add( m_debugOverlay.get() );
607  }
608 
609  return m_debugOverlay;
610 }
611 
612 
614 {
615  if( m_debugOverlay )
616  {
617  m_view->Remove( m_debugOverlay.get() );
618  m_debugOverlay = nullptr;
619  }
620 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
void Stop()
save the time when this function was called, and set the counter stane to stop
Definition: profile.h:82
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)
Function SetHighContrastLayer Takes care of display settings for the given layer to be displayed in h...
void ForceRefresh()
Function ForceRefresh() Forces a redraw.
virtual const COLOR4D & GetGridColor()=0
Function GetGridColor Returns current grid color settings.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
void ReverseDrawOrder(bool aFlag)
Function ReverseDrawOrder() 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)
Function SetTopLayer() Sets given layer to be displayed on the top or sets back the default order of ...
Definition: view.cpp:838
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
static const wxEventType EVT_REFRESH_MOUSE
Event that forces mouse move event in the dispatcher (eg.
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
Function GetCursorColor Returns current cursor color settings.
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:456
virtual const COLOR4D & GetBackgroundColor()=0
Function GetBackgroundColor Returns current background color settings.
double msecs(bool aSinceLast=false)
Definition: profile.h:143
const VECTOR2D & GetCenter() const
Function GetCenter() Returns the center point of this VIEW (in world space coordinates)
Definition: view.h:330
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
KIGFX::GAL_DISPLAY_OPTIONS & m_options
virtual void OnShow()
Function OnShow() Called when the window is shown for the first time.
Class OpenGL_GAL is the OpenGL implementation of the Graphics Abstraction Layer.
Definition: opengl_gal.h:65
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:357
static constexpr GAL_TYPE GAL_FALLBACK
void onLostFocus(wxFocusEvent &aEvent)
virtual bool HasTarget(RENDER_TARGET aTarget)
Returns 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()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers.
Definition: view.cpp:905
void DoRePaint()
Repaint the canvas, and fix scrollbar cursors Usually called by a OnPaint event, but because it do no...
void onShowTimer(wxTimerEvent &aEvent)
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:44
void ClearDebugOverlay()
Clears the contents of the debug overlay and removes it from the VIEW.
void SetCurrentCursor(KICURSOR cursor)
Function SetCurrentCursor Set the current cursor shape for this panel.
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:201
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()
Adjusts the scrollbars position to match the current viewport.
bool m_drawing
True if GAL is currently redrawing the view.
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
bool IsLocked()
Returns true if the infobar is being updated.
Definition: infobar.h:172
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
wxWindow * m_parent
Pointer to the parent window.
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:585
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
#define NULL
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
virtual void Redraw()
Function Redraw() Immediately redraws the whole view.
Definition: view.cpp:1123
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:571
bool IsTargetDirty(int aTarget) const
Function IsTargetDirty() Returns true if any of layers belonging to the target or the target itself s...
Definition: view.h:560
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:379
virtual void DispatchWxEvent(wxEvent &aEvent)
Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs, and makes tools handle those.
virtual void SetTopLayer(int aLayer)
Function SetTopLayer Moves 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
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual void SetFocus() override
void SetLayerIsHighContrast(int aLayerId, bool aEnabled=true)
Function SetLayerIsHighContrast Sets the specified layer as high-contrast.
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1394
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)
Resizes the canvas.
void SetGridSize(const VECTOR2D &aGridSize)
Set the grid size.
void onSize(wxSizeEvent &aEvent)
void StartDrawing()
Function StartDrawing() Begins 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()
Function ClearTopLayers() Removes all layers from the on-the-top set (they are no longer displayed ov...
Definition: view.cpp:890
const VECTOR2D & GetGridSize() const
Returns 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:70
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter Returns 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:328
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
virtual void DispatchWxCommand(wxCommandEvent &aEvent)
Processes wxCommands (mostly menu related events) and runs appropriate actions (eg.
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools.
#define _(s)
Definition: 3d_actions.cpp:33
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() 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
Returns the current cursor position in world coordinates.
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
void ClearTargets()
Function ClearTargets() Clears targets that are marked as dirty.
Definition: view.cpp:1104
void ClearHighContrastLayers()
Function ClearHighContrastLayers Clears the list of active layers.
void SetGridVisibility(bool aVisibility)
Sets 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)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:327
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:102
bool GetGridVisibility() const
wxCursor m_currentCursor
Current mouse cursor shape id.
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:776
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)
Function SetGAL() Assigns a rendering device for the VIEW.
Definition: view.cpp:500
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:268
std::shared_ptr< KIGFX::VIEW_OVERLAY > DebugOverlay()
Creates an overlay for rendering debug graphics.
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
virtual bool IsInitialized() const
Returns the initalization status for the canvas.
void StopDrawing()
Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDraw...
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:596
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:543
Class GAL is the abstract interface for drawing on a 2D-surface.