KiCad PCB EDA Suite
class_draw_panel_gal.h
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-2016 CERN
5  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
6  * @author Maciej Suminski <maciej.suminski@cern.ch>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
31 #ifndef PANELGAL_WXSTRUCT_H
32 #define PANELGAL_WXSTRUCT_H
33 
34 #include <wx/window.h>
35 #include <wx/timer.h>
36 #include <math/box2.h>
37 #include <math/vector2d.h>
38 #include <msgpanel.h>
39 #include <memory>
40 
41 class BOARD;
42 class EDA_DRAW_FRAME;
43 class TOOL_DISPATCHER;
44 
45 namespace KIGFX
46 {
47 class GAL;
48 class VIEW;
49 class WX_VIEW_CONTROLS;
50 class VIEW_CONTROLS;
51 class PAINTER;
52 class GAL_DISPLAY_OPTIONS;
53 }
54 
55 
56 class EDA_DRAW_PANEL_GAL : public wxScrolledCanvas
57 {
58 public:
59  enum GAL_TYPE {
64  };
65 
66  EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId, const wxPoint& aPosition,
67  const wxSize& aSize, KIGFX::GAL_DISPLAY_OPTIONS& aOptions,
68  GAL_TYPE aGalType = GAL_TYPE_OPENGL );
70 
71  virtual void SetFocus() override;
72 
78  virtual bool SwitchBackend( GAL_TYPE aGalType );
79 
84  inline GAL_TYPE GetBackend() const
85  {
86  return m_backend;
87  }
88 
94  KIGFX::GAL* GetGAL() const
95  {
96  return m_gal;
97  }
98 
105  {
106  return m_view;
107  }
108 
115  {
117  }
118 
120  void Refresh( bool aEraseBackground = true, const wxRect* aRect = NULL ) override;
121 
126  void ForceRefresh();
127 
135  void SetEventDispatcher( TOOL_DISPATCHER* aEventDispatcher );
136 
141  void StartDrawing();
142 
148  void StopDrawing();
149 
154  virtual void SetHighContrastLayer( int aLayer );
155 
160  virtual void SetTopLayer( int aLayer );
161 
162  virtual void GetMsgPanelInfo( std::vector<MSG_PANEL_ITEM>& aList )
163  {
164  assert( false );
165  }
166 
171  double GetLegacyZoom() const;
172 
178  {
179  return m_edaFrame;
180  }
181 
186  virtual void OnShow() {}
187 
193  void SetStealsFocus( bool aStealsFocus )
194  {
195  m_stealsFocus = aStealsFocus;
196  }
197 
201  bool GetStealsFocus() const
202  {
203  return m_stealsFocus;
204  }
205 
210  void SetCurrentCursor( int aCursor )
211  {
212  m_currentCursor = aCursor;
213  SetCursor( (wxStockCursor) m_currentCursor );
214  }
215 
220  int GetDefaultCursor() const { return m_defaultCursor; }
221 
226  int GetCurrentCursor() const { return m_currentCursor; }
227 
234  virtual BOX2I GetDefaultViewBBox() const
235  {
236  return BOX2I();
237  }
238 
239 
240 protected:
241  void onPaint( wxPaintEvent& WXUNUSED( aEvent ) );
242  void onSize( wxSizeEvent& aEvent );
243  void onEvent( wxEvent& aEvent );
244  void onEnter( wxEvent& aEvent );
245  void onLostFocus( wxFocusEvent& aEvent );
246  void onRefreshTimer( wxTimerEvent& aEvent );
247  void onShowTimer( wxTimerEvent& aEvent );
248 
249  static const int MinRefreshPeriod = 17;
250 
255 
257  wxWindow* m_parent;
258 
261 
263  wxLongLong m_lastRefresh;
264 
267 
269  bool m_drawing;
270 
273 
275  wxTimer m_refreshTimer;
276 
278  wxTimer m_onShowTimer;
279 
282 
285 
287  std::unique_ptr<KIGFX::PAINTER> m_painter;
288 
291 
295 
298 
302 
306 };
307 
308 #endif
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.
BOX2< VECTOR2I > BOX2I
Definition: box2.h:468
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.
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: class_module.h:57
GAL_TYPE GetBackend() const
Function GetBackend Returns the type of backend currently used by GAL canvas.
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.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
KIGFX::GAL_DISPLAY_OPTIONS & m_options
virtual void OnShow()
Function OnShow() Called when the window is shown for the first time.
int GetCurrentCursor() const
Function GetCurrentCursor.
void onLostFocus(wxFocusEvent &aEvent)
int m_currentCursor
Current mouse cursor shape id.
KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
Sentinel, do not use as a parameter.
void onShowTimer(wxTimerEvent &aEvent)
Class EDA_DRAW_FRAME is the base class for create windows for drawing purpose.
Definition: draw_frame.h:54
int m_defaultCursor
The default mouse cursor shape id.
void onRefreshTimer(wxTimerEvent &aEvent)
bool m_drawing
True if GAL is currently redrawing the view.
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
wxWindow * m_parent
Pointer to the parent window.
void onPaint(wxPaintEvent &WXUNUSED(aEvent))
static const int MinRefreshPeriod
60 FPS.
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
virtual void SetTopLayer(int aLayer)
Function SetTopLayer Moves the selected layer to the top, so it is displayed above all others...
void SetStealsFocus(bool aStealsFocus)
Set whether focus is taken on certain events (mouseover, keys, etc).
Class VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (...
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
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
void SetCurrentCursor(int aCursor)
Function SetCurrentCursor Set the current cursor shape for this panel.
virtual BOX2I GetDefaultViewBBox() const
Returns the bounding box of the view that should be used if model is not valid For example...
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...
Class TOOL_DISPATCHER.
bool GetStealsFocus() const
Get whether focus is taken on certain events (see SetStealsFocus()).
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
wxTimer m_onShowTimer
Timer used to execute OnShow() when the window finally appears on the screen.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
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.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel...
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
void onEnter(wxEvent &aEvent)
void onEvent(wxEvent &aEvent)
Class VIEW.
Definition: view.h:58
int GetDefaultCursor() const
Function GetDefaultCursor.
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over...
Message panel definition file.
void StopDrawing()
Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDraw...
Class GAL is the abstract interface for drawing on a 2D-surface.
virtual void GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList)