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 
26 #ifndef PANELGAL_WXSTRUCT_H
27 #define PANELGAL_WXSTRUCT_H
28 
29 #include <wx/window.h>
30 #include <wx/timer.h>
31 #include <math/box2.h>
32 #include <math/vector2d.h>
33 #include <msgpanel.h>
34 #include <memory>
35 #include <common.h>
36 
37 class BOARD;
38 class EDA_DRAW_FRAME;
39 class TOOL_DISPATCHER;
40 
41 namespace KIGFX
42 {
43 class GAL;
44 class VIEW;
45 class WX_VIEW_CONTROLS;
46 class VIEW_CONTROLS;
47 class PAINTER;
48 class GAL_DISPLAY_OPTIONS;
49 }
50 
51 
52 class EDA_DRAW_PANEL_GAL : public wxScrolledCanvas
53 {
54 public:
55  enum GAL_TYPE {
61  };
62 
63  EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId, const wxPoint& aPosition,
64  const wxSize& aSize, KIGFX::GAL_DISPLAY_OPTIONS& aOptions,
65  GAL_TYPE aGalType = GAL_TYPE_OPENGL );
67 
68  virtual void SetFocus() override;
69 
75  virtual bool SwitchBackend( GAL_TYPE aGalType );
76 
81  inline GAL_TYPE GetBackend() const { return m_backend; }
82 
88  KIGFX::GAL* GetGAL() const { return m_gal; }
89 
95  virtual KIGFX::VIEW* GetView() const { return m_view; }
96 
103  {
105  }
106 
108  virtual void Refresh( bool aEraseBackground = true, const wxRect* aRect = NULL ) override;
109 
114  void ForceRefresh();
115 
123  void SetEventDispatcher( TOOL_DISPATCHER* aEventDispatcher );
124 
129  void StartDrawing();
130 
136  void StopDrawing();
137 
142  virtual void SetHighContrastLayer( int aLayer );
143 
148  virtual void SetTopLayer( int aLayer );
149 
150  virtual void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector<MSG_PANEL_ITEM>& aList )
151  {
152  wxASSERT( false );
153  }
154 
159  double GetLegacyZoom() const;
160 
166 
171  virtual void OnShow() {}
172 
178  void SetStealsFocus( bool aStealsFocus ) { m_stealsFocus = aStealsFocus; }
179 
184  void SetCurrentCursor( wxStockCursor aStockCursorID );
185  void SetCurrentCursor( const wxCursor& aCursor );
186 
193  virtual BOX2I GetDefaultViewBBox() const { return BOX2I(); }
194 
198  void OnEvent( wxEvent& aEvent );
199 
200 protected:
201  virtual void onPaint( wxPaintEvent& WXUNUSED( aEvent ) );
202  void onSize( wxSizeEvent& aEvent );
203  void onEnter( wxEvent& aEvent );
204  void onLostFocus( wxFocusEvent& aEvent );
205  void onRefreshTimer( wxTimerEvent& aEvent );
206  void onShowTimer( wxTimerEvent& aEvent );
207  void onSetCursor( wxSetCursorEvent& event );
208 
209  static const int MinRefreshPeriod = 17;
210 
211  wxCursor m_currentCursor;
212 
213  wxWindow* m_parent;
215 
216  wxLongLong m_lastRefresh;
218  wxTimer m_refreshTimer;
219 
221  bool m_drawing;
222 
225 
227  wxTimer m_onShowTimer;
228 
231 
234 
236  std::unique_ptr<KIGFX::PAINTER> m_painter;
237 
240 
244 
247 
251 
255 };
256 
257 #endif
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.
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:58
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.
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.
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)
Sentinel, do not use as a parameter.
void onShowTimer(wxTimerEvent &aEvent)
The base class for create windows for drawing purpose.
not specified: a GAL engine must be set by the client
void onRefreshTimer(wxTimerEvent &aEvent)
bool m_drawing
Timer to prevent too-frequent refreshing.
wxWindow * m_parent
Current mouse cursor shape id.
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...
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 KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual void SetFocus() override
void onSetCursor(wxSetCursorEvent &event)
EDA_DRAW_FRAME * m_edaFrame
Pointer to the parent window.
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:161
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools.
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
Parent EDA_DRAW_FRAME (if available)
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,...
EDA_UNITS_T
Definition: common.h:133
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.