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-2018 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 #include <common.h>
41 
42 class BOARD;
43 class EDA_DRAW_FRAME;
44 class TOOL_DISPATCHER;
45 
46 namespace KIGFX
47 {
48 class GAL;
49 class VIEW;
50 class WX_VIEW_CONTROLS;
51 class VIEW_CONTROLS;
52 class PAINTER;
53 class GAL_DISPLAY_OPTIONS;
54 }
55 
56 
57 class EDA_DRAW_PANEL_GAL : public wxScrolledCanvas
58 {
59 public:
60  enum GAL_TYPE {
66  };
67 
68  EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId, const wxPoint& aPosition,
69  const wxSize& aSize, KIGFX::GAL_DISPLAY_OPTIONS& aOptions,
70  GAL_TYPE aGalType = GAL_TYPE_OPENGL );
72 
73  virtual void SetFocus() override;
74 
80  virtual bool SwitchBackend( GAL_TYPE aGalType );
81 
86  inline GAL_TYPE GetBackend() const
87  {
88  return m_backend;
89  }
90 
96  KIGFX::GAL* GetGAL() const
97  {
98  return m_gal;
99  }
100 
107  {
108  return m_view;
109  }
110 
117  {
119  }
120 
122  virtual void Refresh( bool aEraseBackground = true, const wxRect* aRect = NULL ) override;
123 
128  void ForceRefresh();
129 
137  void SetEventDispatcher( TOOL_DISPATCHER* aEventDispatcher );
138 
143  void StartDrawing();
144 
150  void StopDrawing();
151 
156  virtual void SetHighContrastLayer( int aLayer );
157 
162  virtual void SetTopLayer( int aLayer );
163 
164  virtual void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector<MSG_PANEL_ITEM>& aList )
165  {
166  wxASSERT( false );
167  }
168 
173  double GetLegacyZoom() const;
174 
180  {
181  return m_edaFrame;
182  }
183 
188  virtual void OnShow() {}
189 
195  void SetStealsFocus( bool aStealsFocus )
196  {
197  m_stealsFocus = aStealsFocus;
198  }
199 
203  bool GetStealsFocus() const
204  {
205  return m_stealsFocus;
206  }
207 
208  virtual void SetDefaultCursor();
213  virtual void SetCurrentCursor( int aCursor );
214 
219  virtual int GetDefaultCursor() const { return m_defaultCursor; }
220 
225  int GetCurrentCursor() const { return m_currentCursor; }
226 
233  virtual BOX2I GetDefaultViewBBox() const
234  {
235  return BOX2I();
236  }
237 
241  void OnEvent( wxEvent& aEvent );
242 
243 protected:
244  virtual void onPaint( wxPaintEvent& WXUNUSED( aEvent ) );
245  void onSize( wxSizeEvent& aEvent );
246  void onEnter( wxEvent& aEvent );
247  void onLostFocus( wxFocusEvent& aEvent );
248  void onRefreshTimer( wxTimerEvent& aEvent );
249  void onShowTimer( wxTimerEvent& aEvent );
250 
251  static const int MinRefreshPeriod = 17;
252 
257 
259  wxWindow* m_parent;
260 
263 
265  wxLongLong m_lastRefresh;
266 
269 
271  bool m_drawing;
272 
275 
277  wxTimer m_refreshTimer;
278 
280  wxTimer m_onShowTimer;
281 
284 
287 
289  std::unique_ptr<KIGFX::PAINTER> m_painter;
290 
293 
297 
300 
304 
308 };
309 
310 #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:520
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::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.
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
void OnEvent(wxEvent &aEvent)
Used to forward events to the canvas from popups, etc.
Class WX_VIEW_CONTROLS is a specific implementation of class VIEW_CONTROLS for wxWidgets library.
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
virtual void GetMsgPanelInfo(EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList)
KIGFX::GAL_DISPLAY_OPTIONS & m_options
virtual void OnShow()
Function OnShow() Called when the window is shown for the first time.
void onLostFocus(wxFocusEvent &aEvent)
int m_currentCursor
Current mouse cursor shape id.
Sentinel, do not use as a parameter.
void onShowTimer(wxTimerEvent &aEvent)
The base class for create windows for drawing purpose.
Definition: draw_frame.h:82
int m_defaultCursor
The default mouse cursor shape id.
not specified: a GAL engine must be set by the client
int GetCurrentCursor() const
Function GetCurrentCursor.
void onRefreshTimer(wxTimerEvent &aEvent)
bool m_drawing
True if GAL is currently redrawing the view.
wxWindow * m_parent
Pointer to the parent window.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
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.
double GetLegacyZoom() const
Function GetLegacyZoom() Returns current view scale converted to zoom value used by the legacy canvas...
bool GetStealsFocus() const
Get whether focus is taken on certain events (see SetStealsFocus()).
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)
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
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)
virtual void SetCurrentCursor(int aCursor)
Function SetCurrentCursor Set the current cursor shape for this panel.
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...
Class TOOL_DISPATCHER.
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:170
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools.
KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
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.
The common library.
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
virtual int GetDefaultCursor() const
Function GetDefaultCursor.
GAL_TYPE GetBackend() const
Function GetBackend Returns the type of backend currently used by GAL canvas.
void onEnter(wxEvent &aEvent)
Class VIEW.
Definition: view.h:61
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...
Message panel definition file.
virtual BOX2I GetDefaultViewBBox() const
Returns the bounding box of the view that should be used if model is not valid For example,...
virtual void SetDefaultCursor()
EDA_UNITS_T
Definition: common.h:157
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.