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 #ifdef __WXMAC__
64  m_defaultCursor = m_currentCursor = wxCURSOR_CROSS;
65 #else
66  m_defaultCursor = m_currentCursor = wxCURSOR_ARROW;
67 #endif
68 
69  SetLayoutDirection( wxLayout_LeftToRight );
70 
71  SwitchBackend( aGalType );
72  SetBackgroundStyle( wxBG_STYLE_CUSTOM );
73 
74 // Scrollbars broken in GAL on OSX
75 #ifdef __WXMAC__
76  ShowScrollbars( wxSHOW_SB_NEVER, wxSHOW_SB_NEVER );
77 #else
78  ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
79 #endif
80  EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
81 
82  m_view = new KIGFX::VIEW( true );
83  m_view->SetGAL( m_gal );
84 
85  Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), NULL, this );
86  Connect( wxEVT_ENTER_WINDOW, wxEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), NULL, this );
87  Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), NULL, this );
88 
89  const wxEventType events[] =
90  {
91  wxEVT_LEFT_UP, wxEVT_LEFT_DOWN, wxEVT_LEFT_DCLICK,
92  wxEVT_RIGHT_UP, wxEVT_RIGHT_DOWN, wxEVT_RIGHT_DCLICK,
93  wxEVT_MIDDLE_UP, wxEVT_MIDDLE_DOWN, wxEVT_MIDDLE_DCLICK,
94  wxEVT_MOTION, wxEVT_MOUSEWHEEL, wxEVT_CHAR,
95 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
96  wxEVT_MAGNIFY,
97 #endif
99  };
100 
101  for( wxEventType eventType : events )
102  {
103  Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::onEvent ),
104  NULL, m_eventDispatcher );
105  }
106 
107  // View controls is the first in the event handler chain, so the Tool Framework operates
108  // on updated viewport data.
110 
111  m_pendingRefresh = false;
112  m_drawing = false;
113  m_drawingEnabled = false;
114 
115  // Set up timer that prevents too frequent redraw commands
116  m_refreshTimer.SetOwner( this );
117  Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
118  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), NULL, this );
119 
120  // Set up timer to execute OnShow() method when the window appears on the screen
121  m_onShowTimer.SetOwner( this );
122  Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
123  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), NULL, this );
124  m_onShowTimer.Start( 10 );
125 }
126 
127 
129 {
130  StopDrawing();
131 
132  assert( !m_drawing );
133 
134  delete m_viewControls;
135  delete m_view;
136  delete m_gal;
137 }
138 
139 
141 {
142 // Windows has a strange manner on bringing up and activating windows
143 // containing a GAL canvas just after moving the mouse cursor into its area.
144 // Feel free to uncomment or extend the following #ifdef if you experience
145 // similar problems on your platform.
146 #ifdef __WINDOWS__
147  if( !GetParent()->IsDescendant( wxWindow::FindFocus() ) )
148  return;
149 #endif
150 
151  wxScrolledCanvas::SetFocus();
152  m_lostFocus = false;
153 }
154 
155 
156 void EDA_DRAW_PANEL_GAL::onPaint( wxPaintEvent& WXUNUSED( aEvent ) )
157 {
158  m_pendingRefresh = false;
159 
160  if( m_drawing )
161  return;
162 
163 #ifdef PROFILE
164  PROF_COUNTER totalRealTime;
165 #endif /* PROFILE */
166 
167  wxASSERT( m_painter );
168 
169  m_drawing = true;
170  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
171 
172 // Scrollbars broken in GAL on OSX
173 #ifndef __WXMAC__
175 #endif
176 
177  m_view->UpdateItems();
178 
179  try
180  {
181  m_gal->BeginDrawing();
182  m_gal->ClearScreen( settings->GetBackgroundColor() );
183 
184  KIGFX::COLOR4D gridColor = settings->GetLayerColor( LAYER_GRID );
185  m_gal->SetGridColor( gridColor );
186 
187  if( m_view->IsDirty() )
188  {
189  m_view->ClearTargets();
190 
191  // Grid has to be redrawn only when the NONCACHED target is redrawn
193  m_gal->DrawGrid();
194 
195  m_view->Redraw();
196  }
197 
199  m_gal->EndDrawing();
200  }
201  catch( std::runtime_error& err )
202  {
203  assert( GetBackend() != GAL_TYPE_CAIRO );
204 
205  // Cairo is supposed to be the safe backend, there is not a single "throw" in its code
207 
208  if( m_edaFrame )
209  m_edaFrame->UseGalCanvas( true );
210 
211  DisplayError( m_parent, wxString( err.what() ) );
212  }
213 
214 #ifdef PROFILE
215  totalRealTime.Stop();
216  wxLogDebug( "EDA_DRAW_PANEL_GAL::onPaint(): %.1f ms", totalRealTime.msecs() );
217 #endif /* PROFILE */
218 
219  m_lastRefresh = wxGetLocalTimeMillis();
220  m_drawing = false;
221 }
222 
223 
224 void EDA_DRAW_PANEL_GAL::onSize( wxSizeEvent& aEvent )
225 {
226  m_gal->ResizeScreen( aEvent.GetSize().x, aEvent.GetSize().y );
229 }
230 
231 
232 void EDA_DRAW_PANEL_GAL::Refresh( bool aEraseBackground, const wxRect* aRect )
233 {
234  if( m_pendingRefresh )
235  return;
236 
237  m_pendingRefresh = true;
238 
239 #ifdef __WXMAC__
240  // Timers on OS X may have a high latency (seen up to 500ms and more) which
241  // makes repaints jerky. No negative impact seen without throttling, so just
242  // do an unconditional refresh for OS X.
243  ForceRefresh();
244 #else
245  wxLongLong t = wxGetLocalTimeMillis();
246  wxLongLong delta = t - m_lastRefresh;
247 
248  if( delta >= MinRefreshPeriod )
249  {
250  ForceRefresh();
251  }
252  else
253  {
254  // One shot timer
255  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
256  }
257 #endif
258 }
259 
260 
262 {
263  wxPaintEvent redrawEvent;
264  wxPostEvent( this, redrawEvent );
265 }
266 
267 
269 {
270  m_eventDispatcher = aEventDispatcher;
271  const wxEventType eventTypes[] = { wxEVT_TOOL };
272 
273  if( m_eventDispatcher )
274  {
275  for( wxEventType type : eventTypes )
276  {
277  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
278  NULL, m_eventDispatcher );
279  }
280  }
281  else
282  {
283  for( wxEventType type : eventTypes )
284  {
285  // While loop is used to be sure that all event handlers are removed.
286  while( m_parent->Disconnect( type,
287  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
288  NULL, m_eventDispatcher ) );
289  }
290  }
291 }
292 
293 
295 {
296  // Start querying GAL if it is ready
297  m_refreshTimer.StartOnce( 100 );
298 }
299 
300 
302 {
303  m_drawingEnabled = false;
304  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
305  m_pendingRefresh = false;
306  m_refreshTimer.Stop();
307 }
308 
309 
311 {
312  // Set display settings for high contrast mode
314 
315  SetTopLayer( aLayer );
316 
317  rSettings->ClearActiveLayers();
318  rSettings->SetActiveLayer( aLayer );
319 
321 }
322 
323 
325 {
327  m_view->SetTopLayer( aLayer );
329 }
330 
331 
333 {
334  double zoomFactor = m_gal->GetWorldScale() / m_gal->GetZoomFactor();
335  return ( 1.0 / ( zoomFactor * m_view->GetScale() ) );
336 }
337 
338 
340 {
341  // Do not do anything if the currently used GAL is correct
342  if( aGalType == m_backend && m_gal != NULL )
343  return true;
344 
345  bool result = true; // assume everything will be fine
346 
347  // Prevent refreshing canvas during backend switch
348  StopDrawing();
349 
350  KIGFX::GAL* new_gal = NULL;
351 
352  try
353  {
354  switch( aGalType )
355  {
356  case GAL_TYPE_OPENGL:
357  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
358  break;
359 
360  case GAL_TYPE_CAIRO:
361  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
362  break;
363 
364  default:
365  assert( false );
366  // warn about unhandled GAL canvas type, but continue with the fallback option
367 
368  case GAL_TYPE_NONE:
369  // KIGFX::GAL is a stub - it actually does cannot display anything,
370  // but prevents code relying on GAL canvas existence from crashing
371  new_gal = new KIGFX::GAL( m_options );
372  break;
373  }
374  }
375  catch( std::runtime_error& err )
376  {
377  new_gal = new KIGFX::GAL( m_options );
378  aGalType = GAL_TYPE_NONE;
379  DisplayError( m_parent, wxString( err.what() ) );
380  result = false;
381  }
382 
383  // trigger update of the gal options in case they differ
384  // from the defaults
386 
387  assert( new_gal );
388  delete m_gal;
389  m_gal = new_gal;
390 
391  wxSize size = GetClientSize();
392  m_gal->ResizeScreen( size.GetX(), size.GetY() );
393 
394  if( m_painter )
395  m_painter->SetGAL( m_gal );
396 
397  if( m_view )
398  m_view->SetGAL( m_gal );
399 
400  m_backend = aGalType;
401 
402  return result;
403 }
404 
405 
406 void EDA_DRAW_PANEL_GAL::onEvent( wxEvent& aEvent )
407 {
408  if( m_lostFocus && m_stealsFocus )
409  SetFocus();
410 
411  if( !m_eventDispatcher )
412  aEvent.Skip();
413  else
415 
416  Refresh();
417 }
418 
419 
420 void EDA_DRAW_PANEL_GAL::onEnter( wxEvent& aEvent )
421 {
422  // Getting focus is necessary in order to receive key events properly
423  if( m_stealsFocus )
424  SetFocus();
425 
426  aEvent.Skip();
427 }
428 
429 
430 void EDA_DRAW_PANEL_GAL::onLostFocus( wxFocusEvent& aEvent )
431 {
432  m_lostFocus = true;
433 
434  aEvent.Skip();
435 }
436 
437 
438 void EDA_DRAW_PANEL_GAL::onRefreshTimer( wxTimerEvent& aEvent )
439 {
440  if( !m_drawingEnabled )
441  {
442  if( m_gal && m_gal->IsInitialized() )
443  {
444  m_drawing = false;
445  m_pendingRefresh = true;
446  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
447  m_drawingEnabled = true;
448  }
449  else
450  {
451  // Try again soon
452  m_refreshTimer.StartOnce( 100 );
453  return;
454  }
455  }
456 
457  wxPaintEvent redrawEvent;
458  wxPostEvent( this, redrawEvent );
459 }
460 
461 
462 void EDA_DRAW_PANEL_GAL::onShowTimer( wxTimerEvent& aEvent )
463 {
464  if( m_gal && m_gal->IsVisible() )
465  {
466  m_onShowTimer.Stop();
467  OnShow();
468  }
469 }
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)
int m_currentCursor
Current mouse cursor shape id.
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:547
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
int m_defaultCursor
The default mouse cursor shape id.
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
Definition: painter.h:206
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:76
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:98
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:576
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:564
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:298
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:186
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