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-2017 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 <draw_frame.h>
28 #include <kiface_i.h>
29 #include <confirm.h>
30 
31 #include <class_draw_panel_gal.h>
32 #include <view/view.h>
33 #include <view/wx_view_controls.h>
34 #include <painter.h>
35 
37 #include <gal/opengl/opengl_gal.h>
38 #include <gal/cairo/cairo_gal.h>
39 
40 #include <tool/tool_dispatcher.h>
41 #include <tool/tool_manager.h>
42 
43 #ifdef PROFILE
44 #include <profile.h>
45 #endif /* PROFILE */
46 
47 
48 EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
49  const wxPoint& aPosition, const wxSize& aSize,
50  KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
51  wxScrolledCanvas( aParentWindow, aWindowId, aPosition, aSize ), m_options( aOptions )
52 {
53  m_parent = aParentWindow;
54  m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( aParentWindow );
55  m_gal = NULL;
57  m_view = NULL;
58  m_painter = NULL;
59  m_eventDispatcher = NULL;
60  m_lostFocus = false;
61  m_stealsFocus = true;
62 
63  SetLayoutDirection( wxLayout_LeftToRight );
64 
65  SwitchBackend( aGalType );
66  SetBackgroundStyle( wxBG_STYLE_CUSTOM );
67 
68 // Scrollbars broken in GAL on OSX
69 #ifdef __WXMAC__
70  ShowScrollbars( wxSHOW_SB_NEVER, wxSHOW_SB_NEVER );
71 #else
72  ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
73 #endif
74  EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
75 
76  m_view = new KIGFX::VIEW( true );
77  m_view->SetGAL( m_gal );
78 
79  Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), NULL, this );
80  Connect( wxEVT_ENTER_WINDOW, wxEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), NULL, this );
81  Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), NULL, this );
82 
83  const wxEventType events[] =
84  {
85  wxEVT_LEFT_UP, wxEVT_LEFT_DOWN, wxEVT_LEFT_DCLICK,
86  wxEVT_RIGHT_UP, wxEVT_RIGHT_DOWN, wxEVT_RIGHT_DCLICK,
87  wxEVT_MIDDLE_UP, wxEVT_MIDDLE_DOWN, wxEVT_MIDDLE_DCLICK,
88  wxEVT_MOTION, wxEVT_MOUSEWHEEL, wxEVT_CHAR,
89 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
90  wxEVT_MAGNIFY,
91 #endif
93  };
94 
95  for( wxEventType eventType : events )
96  {
97  Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::onEvent ),
98  NULL, m_eventDispatcher );
99  }
100 
101  // View controls is the first in the event handler chain, so the Tool Framework operates
102  // on updated viewport data.
104 
105  m_pendingRefresh = false;
106  m_drawing = false;
107  m_drawingEnabled = false;
108 
109  // Set up timer that prevents too frequent redraw commands
110  m_refreshTimer.SetOwner( this );
111  Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
112  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), NULL, this );
113 
114  // Set up timer to execute OnShow() method when the window appears on the screen
115  m_onShowTimer.SetOwner( this );
116  Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
117  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), NULL, this );
118  m_onShowTimer.Start( 10 );
119 }
120 
121 
123 {
124  StopDrawing();
125 
126  assert( !m_drawing );
127 
128  delete m_viewControls;
129  delete m_view;
130  delete m_gal;
131 }
132 
133 
135 {
136 // Windows has a strange manner on bringing up and activating windows
137 // containing a GAL canvas just after moving the mouse cursor into its area.
138 // Feel free to uncomment or extend the following #ifdef if you experience
139 // similar problems on your platform.
140 #ifdef __WINDOWS__
141  if( !GetParent()->IsDescendant( wxWindow::FindFocus() ) )
142  return;
143 #endif
144 
145  wxScrolledCanvas::SetFocus();
146  m_lostFocus = false;
147 }
148 
149 
150 void EDA_DRAW_PANEL_GAL::onPaint( wxPaintEvent& WXUNUSED( aEvent ) )
151 {
152  m_pendingRefresh = false;
153 
154  if( m_drawing )
155  return;
156 
157 #ifdef PROFILE
158  PROF_COUNTER totalRealTime;
159 #endif /* PROFILE */
160 
161  wxASSERT( m_painter );
162 
163  m_drawing = true;
164  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
165 
166 // Scrollbars broken in GAL on OSX
167 #ifndef __WXMAC__
169 #endif
170 
171  m_view->UpdateItems();
172 
173  try
174  {
175  m_gal->BeginDrawing();
176  m_gal->ClearScreen( settings->GetBackgroundColor() );
177 
178  KIGFX::COLOR4D gridColor = settings->GetLayerColor( LAYER_GRID );
179  m_gal->SetGridColor( gridColor );
180 
181  if( m_view->IsDirty() )
182  {
183  m_view->ClearTargets();
184 
185  // Grid has to be redrawn only when the NONCACHED target is redrawn
187  m_gal->DrawGrid();
188 
189  m_view->Redraw();
190  }
191 
193  m_gal->EndDrawing();
194  }
195  catch( std::runtime_error& err )
196  {
197  assert( GetBackend() != GAL_TYPE_CAIRO );
198 
199  // Cairo is supposed to be the safe backend, there is not a single "throw" in its code
201 
202  if( m_edaFrame )
203  m_edaFrame->UseGalCanvas( true );
204 
205  DisplayError( m_parent, wxString( err.what() ) );
206  }
207 
208 #ifdef PROFILE
209  totalRealTime.Stop();
210  wxLogDebug( "EDA_DRAW_PANEL_GAL::onPaint(): %.1f ms", totalRealTime.msecs() );
211 #endif /* PROFILE */
212 
213  m_lastRefresh = wxGetLocalTimeMillis();
214  m_drawing = false;
215 }
216 
217 
218 void EDA_DRAW_PANEL_GAL::onSize( wxSizeEvent& aEvent )
219 {
220  m_gal->ResizeScreen( aEvent.GetSize().x, aEvent.GetSize().y );
223 }
224 
225 
226 void EDA_DRAW_PANEL_GAL::Refresh( bool aEraseBackground, const wxRect* aRect )
227 {
228  if( m_pendingRefresh )
229  return;
230 
231  m_pendingRefresh = true;
232 
233 #ifdef __WXMAC__
234  // Timers on OS X may have a high latency (seen up to 500ms and more) which
235  // makes repaints jerky. No negative impact seen without throttling, so just
236  // do an unconditional refresh for OS X.
237  ForceRefresh();
238 #else
239  wxLongLong t = wxGetLocalTimeMillis();
240  wxLongLong delta = t - m_lastRefresh;
241 
242  if( delta >= MinRefreshPeriod )
243  {
244  ForceRefresh();
245  }
246  else
247  {
248  // One shot timer
249  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
250  }
251 #endif
252 }
253 
254 
256 {
257  wxPaintEvent redrawEvent;
258  wxPostEvent( this, redrawEvent );
259 }
260 
261 
263 {
264  m_eventDispatcher = aEventDispatcher;
265  const wxEventType eventTypes[] = { wxEVT_TOOL };
266 
267  if( m_eventDispatcher )
268  {
269  for( wxEventType type : eventTypes )
270  {
271  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
272  NULL, m_eventDispatcher );
273  }
274  }
275  else
276  {
277  for( wxEventType type : eventTypes )
278  {
279  // While loop is used to be sure that all event handlers are removed.
280  while( m_parent->Disconnect( type,
281  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
282  NULL, m_eventDispatcher ) );
283  }
284  }
285 }
286 
287 
289 {
290  // Start querying GAL if it is ready
291  m_refreshTimer.StartOnce( 100 );
292 }
293 
294 
296 {
297  m_drawingEnabled = false;
298  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
299  m_pendingRefresh = false;
300  m_refreshTimer.Stop();
301 }
302 
303 
305 {
306  // Set display settings for high contrast mode
308 
309  SetTopLayer( aLayer );
310 
311  rSettings->ClearActiveLayers();
312  rSettings->SetActiveLayer( aLayer );
313 
315 }
316 
317 
319 {
321  m_view->SetTopLayer( aLayer );
323 }
324 
325 
327 {
328  double zoomFactor = m_gal->GetWorldScale() / m_gal->GetZoomFactor();
329  return ( 1.0 / ( zoomFactor * m_view->GetScale() ) );
330 }
331 
332 
334 {
335  // Do not do anything if the currently used GAL is correct
336  if( aGalType == m_backend && m_gal != NULL )
337  return true;
338 
339  bool result = true; // assume everything will be fine
340 
341  // Prevent refreshing canvas during backend switch
342  StopDrawing();
343 
344  KIGFX::GAL* new_gal = NULL;
345 
346  try
347  {
348  switch( aGalType )
349  {
350  case GAL_TYPE_OPENGL:
351  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
352  break;
353 
354  case GAL_TYPE_CAIRO:
355  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
356  break;
357 
358  default:
359  assert( false );
360  // warn about unhandled GAL canvas type, but continue with the fallback option
361 
362  case GAL_TYPE_NONE:
363  // KIGFX::GAL is a stub - it actually does cannot display anything,
364  // but prevents code relying on GAL canvas existence from crashing
365  new_gal = new KIGFX::GAL( m_options );
366  break;
367  }
368  }
369  catch( std::runtime_error& err )
370  {
371  new_gal = new KIGFX::GAL( m_options );
372  aGalType = GAL_TYPE_NONE;
373  DisplayError( m_parent, wxString( err.what() ) );
374  result = false;
375  }
376 
377  // trigger update of the gal options in case they differ
378  // from the defaults
380 
381  assert( new_gal );
382  delete m_gal;
383  m_gal = new_gal;
384 
385  wxSize size = GetClientSize();
386  m_gal->ResizeScreen( size.GetX(), size.GetY() );
387 
388  if( m_painter )
389  m_painter->SetGAL( m_gal );
390 
391  if( m_view )
392  m_view->SetGAL( m_gal );
393 
394  m_backend = aGalType;
395 
396  return result;
397 }
398 
399 
400 void EDA_DRAW_PANEL_GAL::onEvent( wxEvent& aEvent )
401 {
402  if( m_lostFocus && m_stealsFocus )
403  SetFocus();
404 
405  if( !m_eventDispatcher )
406  aEvent.Skip();
407  else
409 
410  Refresh();
411 }
412 
413 
414 void EDA_DRAW_PANEL_GAL::onEnter( wxEvent& aEvent )
415 {
416  // Getting focus is necessary in order to receive key events properly
417  if( m_stealsFocus )
418  SetFocus();
419 
420  aEvent.Skip();
421 }
422 
423 
424 void EDA_DRAW_PANEL_GAL::onLostFocus( wxFocusEvent& aEvent )
425 {
426  m_lostFocus = true;
427 
428  aEvent.Skip();
429 }
430 
431 
432 void EDA_DRAW_PANEL_GAL::onRefreshTimer( wxTimerEvent& aEvent )
433 {
434  if( !m_drawingEnabled )
435  {
436  if( m_gal && m_gal->IsInitialized() )
437  {
438  m_drawing = false;
439  m_pendingRefresh = true;
440  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
441  m_drawingEnabled = true;
442  }
443  else
444  {
445  // Try again soon
446  m_refreshTimer.StartOnce( 100 );
447  return;
448  }
449  }
450 
451  wxPaintEvent redrawEvent;
452  wxPostEvent( this, redrawEvent );
453 }
454 
455 
456 void EDA_DRAW_PANEL_GAL::onShowTimer( wxTimerEvent& aEvent )
457 {
458  if( m_gal && m_gal->IsVisible() )
459  {
460  m_onShowTimer.Stop();
461  OnShow();
462  }
463 }
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 responsible for preventing too frequent refresh.
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
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.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
GAL_TYPE m_backend
Currently used GAL.
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:748
Class RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output ...
Definition: painter.h:56
static const wxEventType EVT_REFRESH_MOUSE
Event that forces mouse move event in the dispatcher (eg.
GAL_TYPE GetBackend() const
Function GetBackend Returns the type of backend currently used by GAL canvas.
This file is part of the common library.
double GetWorldScale() const
Get the world scale.
Class WX_VIEW_CONTROLS is a specific implementation of class VIEW_CONTROLS for wxWidgets library...
double GetLegacyZoom() const
Function GetLegacyZoom() Returns current view scale converted to zoom value used by the legacy canvas...
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
void onLostFocus(wxFocusEvent &aEvent)
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
VECTOR2D GetCursorPosition() const override
Function GetCursorPosition() Returns the current cursor position in world coordinates.
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers...
Definition: view.cpp:815
void onShowTimer(wxTimerEvent &aEvent)
Class EDA_DRAW_FRAME is the base class for create windows for drawing purpose.
Definition: draw_frame.h:53
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:546
virtual bool IsInitialized() const
Returns the initalization status for the canvas.
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:45
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
Definition: painter.h:205
virtual void UseGalCanvas(bool aEnable)
Function UseGalCanvas used to switch between standard and GAL-based canvas.
static const int delta[8][2]
Definition: solve.cpp:112
WX_VIEW_CONTROLS class definition.
void SetActiveLayer(int aLayerId, bool aEnabled=true)
Function SetActiveLayer Sets the specified layer as active - it means that it can be drawn in a speci...
Definition: painter.h:75
Auxiliary rendering target (noncached)
Definition: definitions.h:42
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.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
wxWindow * m_parent
Pointer to the parent window.
void onPaint(wxPaintEvent &WXUNUSED(aEvent))
void ClearActiveLayers()
Function ClearActiveLayers Clears the list of active layers.
Definition: painter.h:97
void Redraw()
Function Redraw() Immediately redraws the whole view.
Definition: view.cpp:1016
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:575
static const int MinRefreshPeriod
60 FPS.
virtual void DispatchWxEvent(wxEvent &aEvent)
Function DispatchWxEvent() Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs...
virtual void SetTopLayer(int aLayer)
Function SetTopLayer Moves the selected layer to the top, so it is displayed above all others...
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:563
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)
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
virtual void SetFocus() override
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them...
Definition: view.cpp:1272
EDA_DRAW_FRAME * GetParent() const
Definition: draw_panel.cpp:175
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:196
virtual void ResizeScreen(int aWidth, int aHeight)
Resizes the canvas.
void onSize(wxSizeEvent &aEvent)
void StartDrawing()
Function StartDrawing() Begins drawing if it was stopped previously.
void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
void ClearTopLayers()
Function ClearTopLayers() Removes all layers from the on-the-top set (they are no longer displayed ov...
Definition: view.cpp:800
Class TOOL_DISPATCHER.
virtual void DrawGrid()
>
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
double msecs() const
Definition: profile.h:124
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings 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.
Main rendering target (cached)
Definition: definitions.h:41
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
virtual void DispatchWxCommand(wxCommandEvent &aEvent)
Function DispatchWxCommand() Processes wxCommands (mostly menu related events) and runs appropriate a...
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools...
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
void ClearTargets()
Function ClearTargets() Clears targets that are marked as dirty.
Definition: view.cpp:997
double GetZoomFactor() const
Get the zoom factor.
virtual void ClearScreen(const COLOR4D &aColor)
Clear the screen.
double GetScale() const
Function GetScale()
Definition: view.h:265
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
virtual void BeginDrawing()
Begin the drawing, needs to be called for every new frame.
void SetGAL(GAL *aGal)
Function SetGAL Changes Graphics Abstraction Layer used for drawing items for a new one...
Definition: painter.h:297
void onEnter(wxEvent &aEvent)
void onEvent(wxEvent &aEvent)
Class VIEW.
Definition: view.h:58
KIGFX::PAINTER * m_painter
Contains information about how to draw items using GAL.
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:674
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over...
void SetGAL(GAL *aGal)
Function SetGAL() Assigns a rendering device for the VIEW.
Definition: view.cpp:484
virtual void EndDrawing()
End the drawing, needs to be called for every new frame.
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:69
void StopDrawing()
Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDraw...
const COLOR4D & GetBackgroundColor() const
Function GetBackgroundColor Returns current background color settings.
Definition: painter.h:185
Class GAL is the abstract interface for drawing on a 2D-surface.
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39