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  ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
75  EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
76 
77  m_view = new KIGFX::VIEW( true );
78  m_view->SetGAL( m_gal );
79 
80  Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), NULL, this );
81  Connect( wxEVT_ENTER_WINDOW, wxEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), NULL, this );
82  Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), NULL, this );
83 
84  const wxEventType events[] =
85  {
86  // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
87  // especially special key like arrow keys, are handled by the GAL event dispatcher,
88  // and not sent to GUI without filtering, because they have a default action (scroll)
89  // that must not be called.
90  wxEVT_LEFT_UP, wxEVT_LEFT_DOWN, wxEVT_LEFT_DCLICK,
91  wxEVT_RIGHT_UP, wxEVT_RIGHT_DOWN, wxEVT_RIGHT_DCLICK,
92  wxEVT_MIDDLE_UP, wxEVT_MIDDLE_DOWN, wxEVT_MIDDLE_DCLICK,
93  wxEVT_MOTION, wxEVT_MOUSEWHEEL, wxEVT_CHAR, wxEVT_CHAR_HOOK,
94 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
95  wxEVT_MAGNIFY,
96 #endif
98  };
99 
100  for( wxEventType eventType : events )
101  {
102  Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::onEvent ),
103  NULL, m_eventDispatcher );
104  }
105 
106  // View controls is the first in the event handler chain, so the Tool Framework operates
107  // on updated viewport data.
109 
110  m_pendingRefresh = false;
111  m_drawing = false;
112  m_drawingEnabled = false;
113 
114  // Set up timer that prevents too frequent redraw commands
115  m_refreshTimer.SetOwner( this );
116  Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
117  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), NULL, this );
118 
119  // Set up timer to execute OnShow() method when the window appears on the screen
120  m_onShowTimer.SetOwner( this );
121  Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
122  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), NULL, this );
123  m_onShowTimer.Start( 10 );
124 }
125 
126 
128 {
129  StopDrawing();
130 
131  assert( !m_drawing );
132 
133  delete m_viewControls;
134  delete m_view;
135  delete m_gal;
136 }
137 
138 
140 {
141 // Windows has a strange manner on bringing up and activating windows
142 // containing a GAL canvas just after moving the mouse cursor into its area.
143 // Feel free to uncomment or extend the following #ifdef if you experience
144 // similar problems on your platform.
145 #ifdef __WINDOWS__
146  if( !GetParent()->IsDescendant( wxWindow::FindFocus() ) )
147  return;
148 #endif
149 
150  wxScrolledCanvas::SetFocus();
151  m_lostFocus = false;
152 }
153 
154 
155 void EDA_DRAW_PANEL_GAL::onPaint( wxPaintEvent& WXUNUSED( aEvent ) )
156 {
157  m_pendingRefresh = false;
158 
159  if( m_drawing )
160  return;
161 
162 #ifdef PROFILE
163  PROF_COUNTER totalRealTime;
164 #endif /* PROFILE */
165 
166  wxASSERT( m_painter );
167 
168  m_drawing = true;
169  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
170 
172 
173  m_view->UpdateItems();
174 
175  try
176  {
177  m_gal->BeginDrawing();
178  m_gal->SetClearColor( settings->GetBackgroundColor() );
180  m_gal->ClearScreen( );
181 
182  if( m_view->IsDirty() )
183  {
184  m_view->ClearTargets();
185 
186  // Grid has to be redrawn only when the NONCACHED target is redrawn
188  m_gal->DrawGrid();
189 
190  m_view->Redraw();
191  }
192 
194  m_gal->EndDrawing();
195  }
196  catch( std::runtime_error& err )
197  {
198  assert( GetBackend() != GAL_TYPE_CAIRO );
199 
200  // Cairo is supposed to be the safe backend, there is not a single "throw" in its code
202 
203  if( m_edaFrame )
204  m_edaFrame->UseGalCanvas( true );
205 
206  DisplayError( m_parent, wxString( err.what() ) );
207  }
208 
209 #ifdef PROFILE
210  totalRealTime.Stop();
211  wxLogDebug( "EDA_DRAW_PANEL_GAL::onPaint(): %.1f ms", totalRealTime.msecs() );
212 #endif /* PROFILE */
213 
214  m_lastRefresh = wxGetLocalTimeMillis();
215  m_drawing = false;
216 }
217 
218 
219 void EDA_DRAW_PANEL_GAL::onSize( wxSizeEvent& aEvent )
220 {
221  wxSize clientSize = GetClientSize();
222  m_gal->ResizeScreen( clientSize.x, clientSize.y );
225 }
226 
227 
228 void EDA_DRAW_PANEL_GAL::Refresh( bool aEraseBackground, const wxRect* aRect )
229 {
230  if( m_pendingRefresh )
231  return;
232 
233  m_pendingRefresh = true;
234 
235 #ifdef __WXMAC__
236  // Timers on OS X may have a high latency (seen up to 500ms and more) which
237  // makes repaints jerky. No negative impact seen without throttling, so just
238  // do an unconditional refresh for OS X.
239  ForceRefresh();
240 #else
241  wxLongLong t = wxGetLocalTimeMillis();
242  wxLongLong delta = t - m_lastRefresh;
243 
244  if( delta >= MinRefreshPeriod )
245  {
246  ForceRefresh();
247  }
248  else
249  {
250  // One shot timer
251  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
252  }
253 #endif
254 }
255 
256 
258 {
259  wxPaintEvent redrawEvent;
260  wxPostEvent( this, redrawEvent );
261 }
262 
263 
265 {
266  m_eventDispatcher = aEventDispatcher;
267  const wxEventType eventTypes[] = { wxEVT_TOOL };
268 
269  if( m_eventDispatcher )
270  {
271  for( wxEventType type : eventTypes )
272  {
273  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
274  NULL, m_eventDispatcher );
275  }
276  }
277  else
278  {
279  for( wxEventType type : eventTypes )
280  {
281  // While loop is used to be sure that all event handlers are removed.
282  while( m_parent->Disconnect( type,
283  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
284  NULL, m_eventDispatcher ) );
285  }
286  }
287 }
288 
289 
291 {
292  // Start querying GAL if it is ready
293  m_refreshTimer.StartOnce( 100 );
294 }
295 
296 
298 {
299  m_drawingEnabled = false;
300  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
301  m_pendingRefresh = false;
302  m_refreshTimer.Stop();
303 }
304 
305 
307 {
308  // Set display settings for high contrast mode
310 
311  SetTopLayer( aLayer );
312 
313  rSettings->ClearActiveLayers();
314  rSettings->SetActiveLayer( aLayer );
315 
317 }
318 
319 
321 {
323  m_view->SetTopLayer( aLayer );
325 }
326 
327 
329 {
330  double zoomFactor = m_gal->GetWorldScale() / m_gal->GetZoomFactor();
331  return ( 1.0 / ( zoomFactor * m_view->GetScale() ) );
332 }
333 
334 
336 {
337  // Do not do anything if the currently used GAL is correct
338  if( aGalType == m_backend && m_gal != NULL )
339  return true;
340 
341  bool result = true; // assume everything will be fine
342 
343  // Prevent refreshing canvas during backend switch
344  StopDrawing();
345 
346  KIGFX::GAL* new_gal = NULL;
347 
348  try
349  {
350  switch( aGalType )
351  {
352  case GAL_TYPE_OPENGL:
353  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
354  break;
355 
356  case GAL_TYPE_CAIRO:
357  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
358  break;
359 
360  default:
361  assert( false );
362  // warn about unhandled GAL canvas type, but continue with the fallback option
363 
364  case GAL_TYPE_NONE:
365  // KIGFX::GAL is a stub - it actually does cannot display anything,
366  // but prevents code relying on GAL canvas existence from crashing
367  new_gal = new KIGFX::GAL( m_options );
368  break;
369  }
370  }
371  catch( std::runtime_error& err )
372  {
373  new_gal = new KIGFX::GAL( m_options );
374  aGalType = GAL_TYPE_NONE;
375  DisplayError( m_parent, wxString( err.what() ) );
376  result = false;
377  }
378 
379  // trigger update of the gal options in case they differ
380  // from the defaults
382 
383  assert( new_gal );
384  delete m_gal;
385  m_gal = new_gal;
386 
387  wxSize size = GetClientSize();
388  m_gal->ResizeScreen( size.GetX(), size.GetY() );
389 
390  if( m_painter )
391  m_painter->SetGAL( m_gal );
392 
393  if( m_view )
394  {
395  m_view->SetGAL( m_gal );
396  // Note: OpenGL requires reverse draw order when draw priority is enabled
397  m_view->ReverseDrawOrder( aGalType == GAL_TYPE_OPENGL );
398  }
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.
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.
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:647
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:730
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.
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers...
Definition: view.cpp:797
void onShowTimer(wxTimerEvent &aEvent)
Class EDA_DRAW_FRAME is the base class for create windows for drawing purpose.
Definition: draw_frame.h:54
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:539
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.
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:1003
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:568
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:556
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:174
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
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
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
Update the board display after modifying it bu 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:782
Class TOOL_DISPATCHER.
virtual void DrawGrid()
>
virtual void ClearScreen()
Clear the screen.
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.
VECTOR2D GetCursorPosition(bool aSnappingEnabled) const override
Returns the current cursor position in world coordinates.
void ClearTargets()
Function ClearTargets() Clears targets that are marked as dirty.
Definition: view.cpp:984
double GetZoomFactor() const
Get the zoom factor.
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:675
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:485
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:71
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.