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 <confirm.h>
28 #include <eda_draw_frame.h>
29 #include <kiface_i.h>
30 #include <settings/app_settings.h>
31 
32 #include <class_draw_panel_gal.h>
33 #include <view/view.h>
34 #include <view/wx_view_controls.h>
35 #include <painter.h>
36 #include <base_screen.h>
38 #include <gal/opengl/opengl_gal.h>
39 #include <gal/cairo/cairo_gal.h>
40 
41 #include <tool/tool_dispatcher.h>
42 #include <tool/tool_manager.h>
43 
44 #ifdef PROFILE
45 #include <profile.h>
46 #endif /* PROFILE */
47 
48 
49 EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
50  const wxPoint& aPosition, const wxSize& aSize,
51  KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
52  wxScrolledCanvas( aParentWindow, aWindowId, aPosition, aSize ),
53  m_options( aOptions )
54 {
55  m_parent = aParentWindow;
56  m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( aParentWindow );
57  m_gal = NULL;
59  m_view = NULL;
60  m_painter = NULL;
62  m_lostFocus = false;
63  m_stealsFocus = true;
64 
65  m_currentCursor = wxStockCursor( wxCURSOR_ARROW );
66 
67  SetLayoutDirection( wxLayout_LeftToRight );
68 
69  SwitchBackend( aGalType );
70  SetBackgroundStyle( wxBG_STYLE_CUSTOM );
71 
72  ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
73  EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
74 
75  Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), NULL, this );
76  Connect( wxEVT_ENTER_WINDOW, wxEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), NULL, this );
77  Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), NULL, this );
78  Connect( wxEVT_SET_CURSOR, wxSetCursorEventHandler( EDA_DRAW_PANEL_GAL::onSetCursor ), NULL, this );
79 
80  const wxEventType events[] =
81  {
82  // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
83  // especially special key like arrow keys, are handled by the GAL event dispatcher,
84  // and not sent to GUI without filtering, because they have a default action (scroll)
85  // that must not be called.
86  wxEVT_LEFT_UP, wxEVT_LEFT_DOWN, wxEVT_LEFT_DCLICK,
87  wxEVT_RIGHT_UP, wxEVT_RIGHT_DOWN, wxEVT_RIGHT_DCLICK,
88  wxEVT_MIDDLE_UP, wxEVT_MIDDLE_DOWN, wxEVT_MIDDLE_DCLICK,
89  wxEVT_MOTION, wxEVT_MOUSEWHEEL, wxEVT_CHAR, wxEVT_CHAR_HOOK,
90 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
91  wxEVT_MAGNIFY,
92 #endif
94  };
95 
96  for( wxEventType eventType : events )
97  Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::OnEvent ), NULL, m_eventDispatcher );
98 
99  m_pendingRefresh = false;
100  m_drawing = false;
101  m_drawingEnabled = false;
102 
103  // Set up timer that prevents too frequent redraw commands
104  m_refreshTimer.SetOwner( this );
105  Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
106  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), NULL, this );
107 
108  // Set up timer to execute OnShow() method when the window appears on the screen
109  m_onShowTimer.SetOwner( this );
110  Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
111  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), NULL, this );
112  m_onShowTimer.Start( 10 );
113 }
114 
115 
117 {
118  StopDrawing();
119 
120  wxASSERT( !m_drawing );
121 
122  delete m_viewControls;
123  delete m_view;
124  delete m_gal;
125 }
126 
127 
129 {
130 // Windows has a strange manner on bringing up and activating windows
131 // containing a GAL canvas just after moving the mouse cursor into its area.
132 // Feel free to uncomment or extend the following #ifdef if you experience
133 // similar problems on your platform.
134 #ifdef __WINDOWS__
135  if( !GetParent()->IsDescendant( wxWindow::FindFocus() ) )
136  return;
137 #endif
138 
139  wxScrolledCanvas::SetFocus();
140  m_lostFocus = false;
141 }
142 
143 
144 void EDA_DRAW_PANEL_GAL::onPaint( wxPaintEvent& WXUNUSED( aEvent ) )
145 {
146  // Update current zoom settings if the canvas is managed by a EDA frame
147  // (i.e. not by a preview panel in a dialog)
148  if( GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
149  {
152  }
153 
155 
156  if( !m_gal->IsVisible() )
157  return;
158 
159  m_pendingRefresh = false;
160 
161  if( m_drawing )
162  return;
163 
164 #ifdef PROFILE
165  PROF_COUNTER totalRealTime;
166 #endif /* PROFILE */
167 
168  wxASSERT( m_painter );
169 
170  m_drawing = true;
171  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
172 
173  try
174  {
175  m_view->UpdateItems();
176 
178 
179  m_gal->SetClearColor( settings->GetBackgroundColor() );
180  m_gal->SetGridColor( settings->GetGridColor() );
181  m_gal->SetCursorColor( settings->GetCursorColor() );
182 
183  // TODO: find why ClearScreen() must be called here in opengl mode
184  // and only if m_view->IsDirty() in Cairo mode to avoid distaly artifacts
185  // when moving the mouse cursor
186  if( m_backend == GAL_TYPE_OPENGL )
187  m_gal->ClearScreen();
188 
189  if( m_view->IsDirty() )
190  {
191  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
193  m_gal->ClearScreen();
194 
195  m_view->ClearTargets();
196 
197  // Grid has to be redrawn only when the NONCACHED target is redrawn
199  m_gal->DrawGrid();
200 
201  m_view->Redraw();
202  }
203 
205  }
206  catch( std::runtime_error& err )
207  {
208  constexpr auto GAL_FALLBACK = GAL_TYPE_CAIRO;
209 
210  SwitchBackend( GAL_FALLBACK );
211 
213  _( "Could not use OpenGL, falling back to software rendering" ),
214  wxString( err.what() ) );
215  }
216 
217 #ifdef PROFILE
218  totalRealTime.Stop();
219  wxLogTrace( "GAL_PROFILE", "EDA_DRAW_PANEL_GAL::onPaint(): %.1f ms", totalRealTime.msecs() );
220 #endif /* PROFILE */
221 
222  m_lastRefresh = wxGetLocalTimeMillis();
223  m_drawing = false;
224 }
225 
226 
227 void EDA_DRAW_PANEL_GAL::onSize( wxSizeEvent& aEvent )
228 {
230  wxSize clientSize = GetClientSize();
231  clientSize.x = std::max( 10, clientSize.x );
232  clientSize.y = std::max( 10, clientSize.y );
233  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
234 
235  if( m_view )
236  {
239  }
240 }
241 
242 
243 void EDA_DRAW_PANEL_GAL::Refresh( bool aEraseBackground, const wxRect* aRect )
244 {
245  if( m_pendingRefresh )
246  return;
247 
248  m_pendingRefresh = true;
249 
250 #ifdef __WXMAC__
251  // Timers on OS X may have a high latency (seen up to 500ms and more) which
252  // makes repaints jerky. No negative impact seen without throttling, so just
253  // do an unconditional refresh for OS X.
254  ForceRefresh();
255 #else
256  wxLongLong t = wxGetLocalTimeMillis();
257  wxLongLong delta = t - m_lastRefresh;
258 
259  if( delta >= MinRefreshPeriod )
260  {
261  ForceRefresh();
262  }
263  else
264  {
265  // One shot timer
266  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
267  }
268 #endif
269 }
270 
271 
273 {
274  wxPaintEvent redrawEvent;
275  wxPostEvent( this, redrawEvent );
276 }
277 
278 
280 {
281  m_eventDispatcher = aEventDispatcher;
282  const wxEventType eventTypes[] = { wxEVT_TOOL };
283 
284  if( m_eventDispatcher )
285  {
286  for( wxEventType type : eventTypes )
287  {
288  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
290  }
291  }
292  else
293  {
294  for( wxEventType type : eventTypes )
295  {
296  // While loop is used to be sure that all event handlers are removed.
297  while( m_parent->Disconnect( type,
298  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
299  NULL, m_eventDispatcher ) );
300  }
301  }
302 }
303 
304 
306 {
307  // Start querying GAL if it is ready
308  m_refreshTimer.StartOnce( 100 );
309 }
310 
311 
313 {
314  m_drawingEnabled = false;
315  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
316  m_pendingRefresh = false;
317  m_refreshTimer.Stop();
318 }
319 
320 
322 {
323  // Set display settings for high contrast mode
325 
326  SetTopLayer( aLayer );
327 
328  rSettings->ClearActiveLayers();
329  rSettings->SetActiveLayer( aLayer );
330 
332 }
333 
334 
336 {
338  m_view->SetTopLayer( aLayer );
340 }
341 
342 
344 {
346 }
347 
348 
350 {
351  // Do not do anything if the currently used GAL is correct
352  if( aGalType == m_backend && m_gal != NULL )
353  return true;
354 
355  bool result = true; // assume everything will be fine
356 
357  // Prevent refreshing canvas during backend switch
358  StopDrawing();
359 
360  KIGFX::GAL* new_gal = NULL;
361 
362  try
363  {
364  switch( aGalType )
365  {
366  case GAL_TYPE_OPENGL:
367  try
368  {
369  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
370  break;
371  }
372  catch( std::runtime_error& err )
373  {
374  aGalType = GAL_TYPE_CAIRO;
376  _( "Could not use OpenGL, falling back to software rendering" ),
377  wxString( err.what() ) );
378  }
379 
380  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
381  break;
382 
383  case GAL_TYPE_CAIRO:
384  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
385  break;
386 
387  default:
388  wxASSERT( false );
389  // warn about unhandled GAL canvas type, but continue with the fallback option
390 
391  case GAL_TYPE_NONE:
392  // KIGFX::GAL is a stub - it actually does cannot display anything,
393  // but prevents code relying on GAL canvas existence from crashing
394  new_gal = new KIGFX::GAL( m_options );
395  break;
396  }
397  }
398  catch( std::runtime_error& err )
399  {
400  // Create a dummy GAL
401  new_gal = new KIGFX::GAL( m_options );
402  aGalType = GAL_TYPE_NONE;
403  DisplayError( m_parent, wxString( err.what() ) );
404  result = false;
405  }
406 
407  // trigger update of the gal options in case they differ
408  // from the defaults
410 
411  wxWindow* galWindow = dynamic_cast<wxWindow*>( new_gal );
412 
413  if( galWindow )
414  galWindow->Connect( wxEVT_SET_CURSOR, wxSetCursorEventHandler( EDA_DRAW_PANEL_GAL::onSetCursor ), NULL, this );
415 
416  delete m_gal;
417  m_gal = new_gal;
418 
419  wxSize clientSize = GetClientSize();
420  clientSize.x = std::max( 10, clientSize.x );
421  clientSize.y = std::max( 10, clientSize.y );
422  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
423 
424  if( m_painter )
425  m_painter->SetGAL( m_gal );
426 
427  if( m_view )
428  {
429  m_view->SetGAL( m_gal );
430  // Note: OpenGL requires reverse draw order when draw priority is enabled
431  m_view->ReverseDrawOrder( aGalType == GAL_TYPE_OPENGL );
432  }
433 
434  m_backend = aGalType;
435 
436  return result;
437 }
438 
439 
440 void EDA_DRAW_PANEL_GAL::OnEvent( wxEvent& aEvent )
441 {
442  if( m_lostFocus && m_stealsFocus )
443  SetFocus();
444 
445  if( !m_eventDispatcher )
446  aEvent.Skip();
447  else
449 
450  Refresh();
451 }
452 
453 
454 void EDA_DRAW_PANEL_GAL::onEnter( wxEvent& aEvent )
455 {
456  // Getting focus is necessary in order to receive key events properly
457  if( m_stealsFocus )
458  SetFocus();
459 
460  aEvent.Skip();
461 }
462 
463 
464 void EDA_DRAW_PANEL_GAL::onLostFocus( wxFocusEvent& aEvent )
465 {
466  m_lostFocus = true;
467 
468  aEvent.Skip();
469 }
470 
471 
472 void EDA_DRAW_PANEL_GAL::onRefreshTimer( wxTimerEvent& aEvent )
473 {
474  if( !m_drawingEnabled )
475  {
476  if( m_gal && m_gal->IsInitialized() )
477  {
478  m_drawing = false;
479  m_pendingRefresh = true;
480  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
481  m_drawingEnabled = true;
482  }
483  else
484  {
485  // Try again soon
486  m_refreshTimer.StartOnce( 100 );
487  return;
488  }
489  }
490 
491  wxPaintEvent redrawEvent;
492  wxPostEvent( this, redrawEvent );
493 }
494 
495 
496 void EDA_DRAW_PANEL_GAL::onShowTimer( wxTimerEvent& aEvent )
497 {
498  if( m_gal && m_gal->IsVisible() )
499  {
500  m_onShowTimer.Stop();
501  OnShow();
502  }
503 }
504 
505 
506 void EDA_DRAW_PANEL_GAL::SetCurrentCursor( wxStockCursor aStockCursorID )
507 {
508  if ( aStockCursorID <= wxCURSOR_NONE || aStockCursorID >= wxCURSOR_MAX )
509  aStockCursorID = wxCURSOR_ARROW;
510 
511  SetCurrentCursor( wxCursor( aStockCursorID ) );
512 }
513 
514 
515 void EDA_DRAW_PANEL_GAL::SetCurrentCursor( const wxCursor& aCursor )
516 {
517  m_currentCursor = aCursor;
518  SetCursor( m_currentCursor );
519 }
520 
521 
522 void EDA_DRAW_PANEL_GAL::onSetCursor( wxSetCursorEvent& event )
523 {
524  event.SetCursor( m_currentCursor );
525 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
void Stop()
save the time when this function was called, and set the counter stane to stop
Definition: profile.h:82
bool m_pendingRefresh
Last timestamp when the panel was refreshed.
wxTimer m_refreshTimer
Is there a redraw event requested?
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:675
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:860
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
Definition: painter.h:56
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.
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:328
void SetCurrentCursor(wxStockCursor aStockCursorID)
Function SetCurrentCursor Set the current cursor shape for this panel.
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)
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers.
Definition: view.cpp:927
void onShowTimer(wxTimerEvent &aEvent)
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:44
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
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:71
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void onRefreshTimer(wxTimerEvent &aEvent)
void UpdateScrollbars()
Adjusts the scrollbars position to match the current viewport.
bool m_drawing
Timer to prevent too-frequent refreshing.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
wxWindow * m_parent
Current mouse cursor shape id.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
double GetZoomLevelCoeff() const
Return the coefficient to convert internal display scale factor to zoom level.
#define NULL
void ClearActiveLayers()
Function ClearActiveLayers Clears the list of active layers.
Definition: painter.h:93
virtual void Redraw()
Function Redraw() Immediately redraws the whole view.
Definition: view.cpp:1145
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:585
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:574
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)
Function DispatchWxEvent() Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs,...
double GetLegacyZoom() const
Function GetLegacyZoom() Returns current view scale converted to zoom value used by the legacy canvas...
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)
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.
double GetZoomFactor() const
Get the zoom factor.
virtual void SetFocus() override
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1421
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
Definition: base_screen.cpp:88
void onSetCursor(wxSetCursorEvent &event)
EDA_DRAW_FRAME * m_edaFrame
Pointer to the parent window.
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.
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:912
TOOL_DISPATCHER.
virtual void ClearScreen()
Clear the screen.
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
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:48
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.
#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:1126
wxLongLong m_lastRefresh
Parent EDA_DRAW_FRAME (if available)
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:127
void onEnter(wxEvent &aEvent)
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:798
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:519
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:267
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...
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:557
Class GAL is the abstract interface for drawing on a 2D-surface.