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 
33 #include <class_draw_panel_gal.h>
34 #include <view/view.h>
35 #include <view/wx_view_controls.h>
36 #include <painter.h>
37 #include <base_screen.h>
39 #include <gal/opengl/opengl_gal.h>
40 #include <gal/cairo/cairo_gal.h>
41 
42 #include <tool/tool_dispatcher.h>
43 #include <tool/tool_manager.h>
44 
45 #ifdef PROFILE
46 #include <profile.h>
47 #endif /* PROFILE */
48 
49 
50 EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
51  const wxPoint& aPosition, const wxSize& aSize,
53  GAL_TYPE aGalType )
54  : wxScrolledCanvas( aParentWindow, aWindowId, aPosition, aSize ),
55  m_edaFrame( nullptr ),
56  m_gal( nullptr ),
57  m_view( nullptr ),
58  m_painter( nullptr ),
59  m_backend( GAL_TYPE_NONE ),
60  m_options( aOptions ),
61  m_eventDispatcher( nullptr ),
62  m_lostFocus( false ),
63  m_stealsFocus( true )
64 {
65  m_parent = aParentWindow;
66  m_currentCursor = wxStockCursor( wxCURSOR_ARROW );
67 
68  SetLayoutDirection( wxLayout_LeftToRight );
69 
70  m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( m_parent );
71 
72  // If we're in a dialog, we have to go looking for our parent frame
73  if( !m_edaFrame )
74  {
75  wxWindow* ancestor = aParentWindow->GetParent();
76 
77  while( ancestor && !dynamic_cast<EDA_DRAW_FRAME*>( ancestor ) )
78  ancestor = ancestor->GetParent();
79 
80  if( ancestor )
81  m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( ancestor );
82  }
83 
84  SwitchBackend( aGalType );
85  SetBackgroundStyle( wxBG_STYLE_CUSTOM );
86 
87  ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
88  EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
89 
90  Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), NULL, this );
91  Connect( wxEVT_ENTER_WINDOW, wxEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), NULL, this );
92  Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), NULL, this );
93  Connect( wxEVT_SET_CURSOR, wxSetCursorEventHandler( EDA_DRAW_PANEL_GAL::onSetCursor ), NULL, this );
94 
95  const wxEventType events[] =
96  {
97  // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
98  // especially special key like arrow keys, are handled by the GAL event dispatcher,
99  // and not sent to GUI without filtering, because they have a default action (scroll)
100  // that must not be called.
101  wxEVT_LEFT_UP, wxEVT_LEFT_DOWN, wxEVT_LEFT_DCLICK,
102  wxEVT_RIGHT_UP, wxEVT_RIGHT_DOWN, wxEVT_RIGHT_DCLICK,
103  wxEVT_MIDDLE_UP, wxEVT_MIDDLE_DOWN, wxEVT_MIDDLE_DCLICK,
104  wxEVT_MOTION, wxEVT_MOUSEWHEEL, wxEVT_CHAR, wxEVT_CHAR_HOOK,
105 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
106  wxEVT_MAGNIFY,
107 #endif
109  };
110 
111  for( wxEventType eventType : events )
112  Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::OnEvent ), NULL, m_eventDispatcher );
113 
114  m_pendingRefresh = false;
115  m_drawing = false;
116  m_drawingEnabled = false;
117 
118  // Set up timer that prevents too frequent redraw commands
119  m_refreshTimer.SetOwner( this );
120  Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
121  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), NULL, this );
122 
123  // Set up timer to execute OnShow() method when the window appears on the screen
124  m_onShowTimer.SetOwner( this );
125  Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
126  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), NULL, this );
127  m_onShowTimer.Start( 10 );
128 }
129 
130 
132 {
133  StopDrawing();
134 
135  wxASSERT( !m_drawing );
136 
137  delete m_viewControls;
138  delete m_view;
139  delete m_gal;
140 }
141 
142 
144 {
145 // Windows has a strange manner on bringing up and activating windows
146 // containing a GAL canvas just after moving the mouse cursor into its area.
147 // Feel free to uncomment or extend the following #ifdef if you experience
148 // similar problems on your platform.
149 #ifdef __WINDOWS__
150  if( !GetParent()->IsDescendant( wxWindow::FindFocus() ) )
151  return;
152 #endif
153 
154  wxScrolledCanvas::SetFocus();
155  m_lostFocus = false;
156 }
157 
158 
159 void EDA_DRAW_PANEL_GAL::onPaint( wxPaintEvent& WXUNUSED( aEvent ) )
160 {
161  DoRePaint();
162 }
163 
164 
166 {
167  // Repaint the canvas, and fix scrollbar cursors
168  // Usually called by a OnPaint event, but because it does not use a wxPaintDC,
169  // it can be called outside a wxPaintEvent.
170 
171  // Update current zoom settings if the canvas is managed by a EDA frame
172  // (i.e. not by a preview panel in a dialog)
173  if( GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
175 
177 
178  if( !m_gal->IsVisible() )
179  return;
180 
181  m_pendingRefresh = false;
182 
183  if( m_drawing )
184  return;
185 
186 #ifdef PROFILE
187  PROF_COUNTER totalRealTime;
188 #endif /* PROFILE */
189 
190  wxASSERT( m_painter );
191 
192  m_drawing = true;
193  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
194 
195  try
196  {
197  m_view->UpdateItems();
198 
200 
203  {
204  m_view->MarkDirty();
205  }
206 
207  m_gal->SetClearColor( settings->GetBackgroundColor() );
208  m_gal->SetGridColor( settings->GetGridColor() );
209  m_gal->SetCursorColor( settings->GetCursorColor() );
210 
211  // TODO: find why ClearScreen() must be called here in opengl mode
212  // and only if m_view->IsDirty() in Cairo mode to avoid distaly artifacts
213  // when moving the mouse cursor
214  if( m_backend == GAL_TYPE_OPENGL )
215  m_gal->ClearScreen();
216 
217  if( m_view->IsDirty() )
218  {
219  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
221  m_gal->ClearScreen();
222 
223  m_view->ClearTargets();
224 
225  // Grid has to be redrawn only when the NONCACHED target is redrawn
227  m_gal->DrawGrid();
228 
229  m_view->Redraw();
230  }
231 
233  }
234  catch( std::runtime_error& err )
235  {
236  constexpr auto GAL_FALLBACK = GAL_TYPE_CAIRO;
237 
238  SwitchBackend( GAL_FALLBACK );
239 
241  _( "Could not use OpenGL, falling back to software rendering" ),
242  wxString( err.what() ) );
243  }
244 
245 #ifdef PROFILE
246  totalRealTime.Stop();
247  wxLogTrace( "GAL_PROFILE", "EDA_DRAW_PANEL_GAL::DoRePaint(): %.1f ms", totalRealTime.msecs() );
248 #endif /* PROFILE */
249 
250  m_lastRefresh = wxGetLocalTimeMillis();
251  m_drawing = false;
252 }
253 
254 
255 void EDA_DRAW_PANEL_GAL::onSize( wxSizeEvent& aEvent )
256 {
258  wxSize clientSize = GetClientSize();
259  clientSize.x = std::max( 10, clientSize.x );
260  clientSize.y = std::max( 10, clientSize.y );
261  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
262 
263  if( m_view )
264  {
267  }
268 }
269 
270 
271 void EDA_DRAW_PANEL_GAL::Refresh( bool aEraseBackground, const wxRect* aRect )
272 {
273  if( m_pendingRefresh )
274  return;
275 
276  m_pendingRefresh = true;
277 
278 #ifdef __WXMAC__
279  // Timers on OS X may have a high latency (seen up to 500ms and more) which
280  // makes repaints jerky. No negative impact seen without throttling, so just
281  // do an unconditional refresh for OS X.
282  ForceRefresh();
283 #else
284  wxLongLong t = wxGetLocalTimeMillis();
285  wxLongLong delta = t - m_lastRefresh;
286 
287  if( delta >= MinRefreshPeriod )
288  {
289  ForceRefresh();
290  }
291  else
292  {
293  // One shot timer
294  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
295  }
296 #endif
297 }
298 
299 
301 {
302  //wxPaintEvent redrawEvent;
303  //wxPostEvent( this, redrawEvent );
304  DoRePaint();
305 }
306 
307 
309 {
310  m_eventDispatcher = aEventDispatcher;
311  const wxEventType eventTypes[] = { wxEVT_TOOL };
312 
313  if( m_eventDispatcher )
314  {
315  for( wxEventType type : eventTypes )
316  {
317  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
319  }
320  }
321  else
322  {
323  for( wxEventType type : eventTypes )
324  {
325  // While loop is used to be sure that all event handlers are removed.
326  while( m_parent->Disconnect( type,
327  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
328  NULL, m_eventDispatcher ) );
329  }
330  }
331 }
332 
333 
335 {
336  // Start querying GAL if it is ready
337  m_refreshTimer.StartOnce( 100 );
338 }
339 
340 
342 {
343  m_drawingEnabled = false;
344  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
345  m_pendingRefresh = false;
346  m_refreshTimer.Stop();
347 }
348 
349 
351 {
352  // Set display settings for high contrast mode
354 
355  SetTopLayer( aLayer );
356 
357  rSettings->ClearActiveLayers();
358  rSettings->SetActiveLayer( aLayer );
359 
361 }
362 
363 
365 {
367  m_view->SetTopLayer( aLayer );
369 }
370 
371 
373 {
374  // Do not do anything if the currently used GAL is correct
375  if( aGalType == m_backend && m_gal != NULL )
376  return true;
377 
378  VECTOR2D grid_size = m_gal ? m_gal->GetGridSize() : VECTOR2D();
379  bool grid_visibility = m_gal ? m_gal->GetGridVisibility() : true;
380  bool result = true; // assume everything will be fine
381 
382  // Prevent refreshing canvas during backend switch
383  StopDrawing();
384 
385  KIGFX::GAL* new_gal = NULL;
386 
387  try
388  {
389  switch( aGalType )
390  {
391  case GAL_TYPE_OPENGL:
392  {
393  wxString errormsg = KIGFX::OPENGL_GAL::CheckFeatures( m_options );
394 
395  if( errormsg.empty() )
396  {
397  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
398  }
399  else
400  {
401  aGalType = GAL_TYPE_CAIRO;
403  _( "Could not use OpenGL, falling back to software rendering" ), errormsg );
404  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
405  }
406  break;
407  }
408 
409  case GAL_TYPE_CAIRO:
410  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
411  break;
412 
413  default:
414  wxASSERT( false );
416  // warn about unhandled GAL canvas type, but continue with the fallback option
417 
418  case GAL_TYPE_NONE:
419  // KIGFX::GAL is a stub - it actually does cannot display anything,
420  // but prevents code relying on GAL canvas existence from crashing
421  new_gal = new KIGFX::GAL( m_options );
422  break;
423  }
424  }
425  catch( std::runtime_error& err )
426  {
427  // Create a dummy GAL
428  new_gal = new KIGFX::GAL( m_options );
429  aGalType = GAL_TYPE_NONE;
430  DisplayError( m_parent, wxString( err.what() ) );
431  result = false;
432  }
433 
434  // trigger update of the gal options in case they differ
435  // from the defaults
437 
438  wxWindow* galWindow = dynamic_cast<wxWindow*>( new_gal );
439 
440  if( galWindow )
441  galWindow->Connect( wxEVT_SET_CURSOR, wxSetCursorEventHandler( EDA_DRAW_PANEL_GAL::onSetCursor ), NULL, this );
442 
443  delete m_gal;
444  m_gal = new_gal;
445 
446  wxSize clientSize = GetClientSize();
447  clientSize.x = std::max( 10, clientSize.x );
448  clientSize.y = std::max( 10, clientSize.y );
449  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
450 
451  if( grid_size.x > 0 && grid_size.y > 0 )
452  m_gal->SetGridSize( grid_size );
453 
454  m_gal->SetGridVisibility( grid_visibility );
455 
456  if( m_painter )
457  m_painter->SetGAL( m_gal );
458 
459  if( m_view )
460  {
461  m_view->SetGAL( m_gal );
462  // Note: OpenGL requires reverse draw order when draw priority is enabled
463  m_view->ReverseDrawOrder( aGalType == GAL_TYPE_OPENGL );
464  }
465 
466  m_backend = aGalType;
467 
468  return result;
469 }
470 
471 
472 void EDA_DRAW_PANEL_GAL::OnEvent( wxEvent& aEvent )
473 {
474  if( m_lostFocus && m_stealsFocus )
475  SetFocus();
476 
477  if( !m_eventDispatcher )
478  aEvent.Skip();
479  else
481 
482  Refresh();
483 }
484 
485 
486 void EDA_DRAW_PANEL_GAL::onEnter( wxEvent& aEvent )
487 {
488  // Getting focus is necessary in order to receive key events properly
489  if( m_stealsFocus )
490  SetFocus();
491 
492  aEvent.Skip();
493 }
494 
495 
496 void EDA_DRAW_PANEL_GAL::onLostFocus( wxFocusEvent& aEvent )
497 {
498  m_lostFocus = true;
499 
500  aEvent.Skip();
501 }
502 
503 
504 void EDA_DRAW_PANEL_GAL::onRefreshTimer( wxTimerEvent& aEvent )
505 {
506  if( !m_drawingEnabled )
507  {
508  if( m_gal && m_gal->IsInitialized() )
509  {
510  m_drawing = false;
511  m_pendingRefresh = true;
512  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
513  m_drawingEnabled = true;
514  }
515  else
516  {
517  // Try again soon
518  m_refreshTimer.StartOnce( 100 );
519  return;
520  }
521  }
522 
523  //wxPaintEvent redrawEvent;
524  //wxPostEvent( this, redrawEvent );
525  DoRePaint();
526 }
527 
528 
529 void EDA_DRAW_PANEL_GAL::onShowTimer( wxTimerEvent& aEvent )
530 {
531  if( m_gal && m_gal->IsVisible() )
532  {
533  m_onShowTimer.Stop();
534  OnShow();
535  }
536 }
537 
538 
539 void EDA_DRAW_PANEL_GAL::SetCurrentCursor( wxStockCursor aStockCursorID )
540 {
541  if ( aStockCursorID <= wxCURSOR_NONE || aStockCursorID >= wxCURSOR_MAX )
542  aStockCursorID = wxCURSOR_ARROW;
543 
544  SetCurrentCursor( wxCursor( aStockCursorID ) );
545 }
546 
547 
548 void EDA_DRAW_PANEL_GAL::SetCurrentCursor( const wxCursor& aCursor )
549 {
550  m_currentCursor = aCursor;
551  SetCursor( m_currentCursor );
552 }
553 
554 
555 void EDA_DRAW_PANEL_GAL::onSetCursor( wxSetCursorEvent& event )
556 {
557  event.SetCursor( m_currentCursor );
558 }
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
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.
#define KI_FALLTHROUGH
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:864
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.
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)
virtual bool HasTarget(RENDER_TARGET aTarget)
Returns true if the target exists.
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers.
Definition: view.cpp:931
void DoRePaint()
Repaint the canvas, and fix scrollbar cursors Usually called by a OnPaint event, but because it do no...
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...
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.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
wxWindow * m_parent
Pointer to the parent window.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
#define NULL
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
void ClearActiveLayers()
Function ClearActiveLayers Clears the list of active layers.
virtual void Redraw()
Function Redraw() Immediately redraws the whole view.
Definition: view.cpp:1149
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,...
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 UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1425
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:916
TOOL_DISPATCHER.
const VECTOR2D & GetGridSize() const
Returns the grid size.
virtual void ClearScreen()
Clear the screen.
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
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.
Main rendering target (cached)
Definition: definitions.h:48
static wxString CheckFeatures(GAL_DISPLAY_OPTIONS &aOptions)
Checks OpenGL features.
Definition: opengl_gal.cpp:325
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:1130
void SetGridVisibility(bool aVisibility)
Sets the visibility setting of the grid.
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:75
void onEnter(wxEvent &aEvent)
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:802
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:523
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...
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:610
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.