KiCad PCB EDA Suite
EDA_DRAW_PANEL_GAL Class Reference

#include <class_draw_panel_gal.h>

Inheritance diagram for EDA_DRAW_PANEL_GAL:
GERBVIEW_DRAW_PANEL_GAL PCB_DRAW_PANEL_GAL FOOTPRINT_PREVIEW_PANEL

Public Types

enum  GAL_TYPE { GAL_TYPE_NONE, GAL_TYPE_OPENGL, GAL_TYPE_CAIRO, GAL_TYPE_LAST }
 

Public Member Functions

 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)
 
 ~EDA_DRAW_PANEL_GAL ()
 
virtual void SetFocus () override
 
virtual bool SwitchBackend (GAL_TYPE aGalType)
 Function SwitchBackend Switches method of rendering graphics. More...
 
GAL_TYPE GetBackend () const
 Function GetBackend Returns the type of backend currently used by GAL canvas. More...
 
KIGFX::GALGetGAL () const
 Function GetGAL() Returns a pointer to the GAL instance used in the panel. More...
 
KIGFX::VIEWGetView () const
 Function GetView() Returns a pointer to the VIEW instance used in the panel. More...
 
KIGFX::VIEW_CONTROLSGetViewControls () const
 Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel. More...
 
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 action plugins, after running the plugin, so call this function is usually not needed inside action plugins. More...
 
void ForceRefresh ()
 Function ForceRefresh() Forces a redraw. More...
 
void SetEventDispatcher (TOOL_DISPATCHER *aEventDispatcher)
 Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools. More...
 
void StartDrawing ()
 Function StartDrawing() Begins drawing if it was stopped previously. More...
 
void StopDrawing ()
 Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDrawing() is called. More...
 
virtual void SetHighContrastLayer (int aLayer)
 Function SetHighContrastLayer Takes care of display settings for the given layer to be displayed in high contrast mode. More...
 
virtual void SetTopLayer (int aLayer)
 Function SetTopLayer Moves the selected layer to the top, so it is displayed above all others. More...
 
virtual void GetMsgPanelInfo (std::vector< MSG_PANEL_ITEM > &aList)
 
double GetLegacyZoom () const
 Function GetLegacyZoom() Returns current view scale converted to zoom value used by the legacy canvas. More...
 
EDA_DRAW_FRAMEGetParentEDAFrame () const
 Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise. More...
 
virtual void OnShow ()
 Function OnShow() Called when the window is shown for the first time. More...
 
void SetStealsFocus (bool aStealsFocus)
 Set whether focus is taken on certain events (mouseover, keys, etc). More...
 
bool GetStealsFocus () const
 Get whether focus is taken on certain events (see SetStealsFocus()). More...
 
void SetCurrentCursor (int aCursor)
 Function SetCurrentCursor Set the current cursor shape for this panel. More...
 
int GetDefaultCursor () const
 Function GetDefaultCursor. More...
 
int GetCurrentCursor () const
 Function GetCurrentCursor. More...
 

Protected Member Functions

void onPaint (wxPaintEvent &WXUNUSED(aEvent))
 
void onSize (wxSizeEvent &aEvent)
 
void onEvent (wxEvent &aEvent)
 
void onEnter (wxEvent &aEvent)
 
void onLostFocus (wxFocusEvent &aEvent)
 
void onRefreshTimer (wxTimerEvent &aEvent)
 
void onShowTimer (wxTimerEvent &aEvent)
 

Protected Attributes

int m_currentCursor
 Current mouse cursor shape id. More...
 
int m_defaultCursor
 The default mouse cursor shape id. More...
 
wxWindow * m_parent
 Pointer to the parent window. More...
 
EDA_DRAW_FRAMEm_edaFrame
 Parent EDA_DRAW_FRAME (if available) More...
 
wxLongLong m_lastRefresh
 Last timestamp when the panel was refreshed. More...
 
bool m_pendingRefresh
 Is there a redraw event requested? More...
 
bool m_drawing
 True if GAL is currently redrawing the view. More...
 
bool m_drawingEnabled
 Flag that determines if VIEW may use GAL for redrawing the screen. More...
 
wxTimer m_refreshTimer
 Timer responsible for preventing too frequent refresh. More...
 
wxTimer m_onShowTimer
 Timer used to execute OnShow() when the window finally appears on the screen. More...
 
KIGFX::GALm_gal
 Interface for drawing objects on a 2D-surface. More...
 
KIGFX::VIEWm_view
 Stores view settings (scale, center, etc.) and items to be drawn. More...
 
KIGFX::PAINTERm_painter
 Contains information about how to draw items using GAL. More...
 
KIGFX::WX_VIEW_CONTROLSm_viewControls
 Control for VIEW (moving, zooming, etc.) More...
 
GAL_TYPE m_backend
 Currently used GAL. More...
 
KIGFX::GAL_DISPLAY_OPTIONSm_options
 
TOOL_DISPATCHERm_eventDispatcher
 Processes and forwards events to tools. More...
 
bool m_lostFocus
 Flag to indicate that focus should be regained on the next mouse event. More...
 
bool m_stealsFocus
 Flag to indicate whether the panel should take focus at certain times (when moused over, and on various mouse/key events) More...
 

Static Protected Attributes

static const int MinRefreshPeriod = 17
 60 FPS. More...
 

Detailed Description

Definition at line 54 of file class_draw_panel_gal.h.

Member Enumeration Documentation

Enumerator
GAL_TYPE_NONE 

Not used.

GAL_TYPE_OPENGL 

OpenGL implementation.

GAL_TYPE_CAIRO 

Cairo implementation.

GAL_TYPE_LAST 

Sentinel, do not use as a parameter.

Definition at line 57 of file class_draw_panel_gal.h.

Constructor & Destructor Documentation

EDA_DRAW_PANEL_GAL::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 
)

Definition at line 48 of file draw_panel_gal.cpp.

References KIGFX::WX_VIEW_CONTROLS::EVT_REFRESH_MOUSE, GAL_TYPE_NONE, m_backend, m_currentCursor, m_defaultCursor, m_drawing, m_drawingEnabled, m_edaFrame, m_eventDispatcher, m_gal, m_lostFocus, m_onShowTimer, m_painter, m_parent, m_pendingRefresh, m_refreshTimer, m_stealsFocus, m_view, m_viewControls, onEnter(), onEvent(), onLostFocus(), onRefreshTimer(), onShowTimer(), onSize(), KIGFX::VIEW::SetGAL(), and SwitchBackend().

50  :
51  wxScrolledCanvas( aParentWindow, aWindowId, aPosition, aSize ), m_options( aOptions )
52 {
53  m_parent = aParentWindow;
54  m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( aParentWindow );
55  m_gal = NULL;
57  m_view = NULL;
58  m_painter = NULL;
59  m_eventDispatcher = NULL;
60  m_lostFocus = false;
61  m_stealsFocus = true;
62 
63 #ifdef __WXMAC__
64  m_defaultCursor = m_currentCursor = wxCURSOR_CROSS;
65 #else
66  m_defaultCursor = m_currentCursor = wxCURSOR_ARROW;
67 #endif
68 
69  SetLayoutDirection( wxLayout_LeftToRight );
70 
71  SwitchBackend( aGalType );
72  SetBackgroundStyle( wxBG_STYLE_CUSTOM );
73 
74  ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
75  EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
76 
77  m_view = new KIGFX::VIEW( true );
78  m_view->SetGAL( m_gal );
79 
80  Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), NULL, this );
81  Connect( wxEVT_ENTER_WINDOW, wxEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), NULL, this );
82  Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), NULL, this );
83 
84  const wxEventType events[] =
85  {
86  // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
87  // especially special key like arrow keys, are handled by the GAL event dispatcher,
88  // and not sent to GUI without filtering, because they have a default action (scroll)
89  // that must not be called.
90  wxEVT_LEFT_UP, wxEVT_LEFT_DOWN, wxEVT_LEFT_DCLICK,
91  wxEVT_RIGHT_UP, wxEVT_RIGHT_DOWN, wxEVT_RIGHT_DCLICK,
92  wxEVT_MIDDLE_UP, wxEVT_MIDDLE_DOWN, wxEVT_MIDDLE_DCLICK,
93  wxEVT_MOTION, wxEVT_MOUSEWHEEL, wxEVT_CHAR, wxEVT_CHAR_HOOK,
94 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
95  wxEVT_MAGNIFY,
96 #endif
98  };
99 
100  for( wxEventType eventType : events )
101  {
102  Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::onEvent ),
103  NULL, m_eventDispatcher );
104  }
105 
106  // View controls is the first in the event handler chain, so the Tool Framework operates
107  // on updated viewport data.
109 
110  m_pendingRefresh = false;
111  m_drawing = false;
112  m_drawingEnabled = false;
113 
114  // Set up timer that prevents too frequent redraw commands
115  m_refreshTimer.SetOwner( this );
116  Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
117  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), NULL, this );
118 
119  // Set up timer to execute OnShow() method when the window appears on the screen
120  m_onShowTimer.SetOwner( this );
121  Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
122  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), NULL, this );
123  m_onShowTimer.Start( 10 );
124 }
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.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
GAL_TYPE m_backend
Currently used GAL.
static const wxEventType EVT_REFRESH_MOUSE
Event that forces mouse move event in the dispatcher (eg.
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.
KIGFX::GAL_DISPLAY_OPTIONS & m_options
void onLostFocus(wxFocusEvent &aEvent)
int m_currentCursor
Current mouse cursor shape id.
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.
wxWindow * m_parent
Pointer to the parent window.
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
void onSize(wxSizeEvent &aEvent)
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.
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
void onEnter(wxEvent &aEvent)
void onEvent(wxEvent &aEvent)
Class VIEW.
Definition: view.h:58
KIGFX::PAINTER * m_painter
Contains information about how to draw items using GAL.
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over...
void SetGAL(GAL *aGal)
Function SetGAL() Assigns a rendering device for the VIEW.
Definition: view.cpp:485
EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL ( )

Definition at line 127 of file draw_panel_gal.cpp.

References m_drawing, m_gal, m_view, m_viewControls, and StopDrawing().

128 {
129  StopDrawing();
130 
131  assert( !m_drawing );
132 
133  delete m_viewControls;
134  delete m_view;
135  delete m_gal;
136 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
bool m_drawing
True if GAL is currently redrawing the view.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
void StopDrawing()
Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDraw...

Member Function Documentation

void EDA_DRAW_PANEL_GAL::ForceRefresh ( )

Function ForceRefresh() Forces a redraw.

Definition at line 257 of file draw_panel_gal.cpp.

Referenced by SELECTION_TOOL::findCallback(), Refresh(), GERBVIEW_SELECTION_TOOL::toggleSelection(), SELECTION_TOOL::toggleSelection(), GERBVIEW_SELECTION_TOOL::zoomFitSelection(), and SELECTION_TOOL::zoomFitSelection().

258 {
259  wxPaintEvent redrawEvent;
260  wxPostEvent( this, redrawEvent );
261 }
GAL_TYPE EDA_DRAW_PANEL_GAL::GetBackend ( ) const
inline

Function GetBackend Returns the type of backend currently used by GAL canvas.

Definition at line 82 of file class_draw_panel_gal.h.

References m_backend.

Referenced by EVT_TOOL(), EVT_UPDATE_UI(), onPaint(), PCB_BASE_FRAME::OnUpdateSwitchCanvas(), GERBVIEW_FRAME::OnUpdateSwitchCanvas(), and DIALOG_PAD_PROPERTIES::prepareCanvas().

83  {
84  return m_backend;
85  }
GAL_TYPE m_backend
Currently used GAL.
int EDA_DRAW_PANEL_GAL::GetCurrentCursor ( ) const
inline

Function GetCurrentCursor.

Returns
the current cursor shape, depending on the current selected tool

Definition at line 224 of file class_draw_panel_gal.h.

References m_currentCursor.

224 { return m_currentCursor; }
int m_currentCursor
Current mouse cursor shape id.
int EDA_DRAW_PANEL_GAL::GetDefaultCursor ( ) const
inline

Function GetDefaultCursor.

Returns
the default cursor shape

Definition at line 218 of file class_draw_panel_gal.h.

References m_defaultCursor.

Referenced by EDA_DRAW_FRAME::SetNoToolSelected().

218 { return m_defaultCursor; }
int m_defaultCursor
The default mouse cursor shape id.
double EDA_DRAW_PANEL_GAL::GetLegacyZoom ( ) const

Function GetLegacyZoom() Returns current view scale converted to zoom value used by the legacy canvas.

Definition at line 328 of file draw_panel_gal.cpp.

References KIGFX::VIEW::GetScale(), KIGFX::GAL::GetWorldScale(), KIGFX::GAL::GetZoomFactor(), m_gal, and m_view.

Referenced by PCB_BASE_FRAME::OnUpdateSelectZoom().

329 {
330  double zoomFactor = m_gal->GetWorldScale() / m_gal->GetZoomFactor();
331  return ( 1.0 / ( zoomFactor * m_view->GetScale() ) );
332 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
double GetWorldScale() const
Get the world scale.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
double GetZoomFactor() const
Get the zoom factor.
double GetScale() const
Function GetScale()
Definition: view.h:265
virtual void EDA_DRAW_PANEL_GAL::GetMsgPanelInfo ( std::vector< MSG_PANEL_ITEM > &  aList)
inlinevirtual

Reimplemented in PCB_DRAW_PANEL_GAL, and GERBVIEW_DRAW_PANEL_GAL.

Definition at line 160 of file class_draw_panel_gal.h.

Referenced by PCB_BASE_FRAME::UpdateMsgPanel().

161  {
162  assert( false );
163  }
EDA_DRAW_FRAME* EDA_DRAW_PANEL_GAL::GetParentEDAFrame ( ) const
inline

Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.

Definition at line 175 of file class_draw_panel_gal.h.

References m_edaFrame.

Referenced by GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), and PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL().

176  {
177  return m_edaFrame;
178  }
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
bool EDA_DRAW_PANEL_GAL::GetStealsFocus ( ) const
inline

Get whether focus is taken on certain events (see SetStealsFocus()).

Definition at line 199 of file class_draw_panel_gal.h.

References m_stealsFocus.

200  {
201  return m_stealsFocus;
202  }
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over...
KIGFX::VIEW* EDA_DRAW_PANEL_GAL::GetView ( ) const
inline

Function GetView() Returns a pointer to the VIEW instance used in the panel.

Returns
The instance of VIEW.

Definition at line 102 of file class_draw_panel_gal.h.

References m_view.

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), GRID_HELPER::BestSnapAnchor(), PCB_EDIT_FRAME::Edit_Zone_Params(), EVT_TOOL(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_DRAW_FRAME::GetZoomLevelIndicator(), GRID_HELPER::GRID_HELPER(), GERBVIEW_CONTROL::HighlightControl(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), PCB_EDIT_FRAME::ListNetsAndSelect(), PCB_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnLayerVisible(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnMarkerSelectionEvent(), DIALOG_DISPLAY_OPTIONS::OnOKBUttonClick(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::OnOkClick(), DIALOG_DRC_CONTROL::OnPopupMenu(), PCB_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectHighlightChoice(), EDA_DRAW_FRAME::OnToggleGridState(), PCB_BASE_FRAME::OnTogglePadDrawMode(), DIALOG_DRC_CONTROL::OnUnconnectedSelectionEvent(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PCB_EDIT_FRAME::Process_Config(), GRID_HELPER::queryVisible(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_PAD_PROPERTIES::redraw(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), GRID_HELPER::SetAuxAxes(), PCB_BASE_EDIT_FRAME::SetBoard(), FOOTPRINT_EDIT_FRAME::SetElementVisibility(), FOOTPRINT_EDIT_FRAME::setupTools(), DIALOG_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_MODEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), PCB_BASE_FRAME::UseGalCanvas(), GERBVIEW_FRAME::UseGalCanvas(), EDA_DRAW_FRAME::UseGalCanvas(), COMMON_TOOLS::ZoomInOut(), and COMMON_TOOLS::ZoomPreset().

103  {
104  return m_view;
105  }
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
KIGFX::VIEW_CONTROLS* EDA_DRAW_PANEL_GAL::GetViewControls ( ) const
inline

Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.

Returns
The instance of VIEW_CONTROLS.

Definition at line 112 of file class_draw_panel_gal.h.

References m_viewControls.

Referenced by EVT_TOOL(), EDA_DRAW_FRAME::GetCrossHairPosition(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_PANEL::SetEnableMousewheelPan(), EDA_DRAW_PANEL::SetEnableZoomNoCenter(), FOOTPRINT_EDIT_FRAME::setupTools(), and EDA_DRAW_FRAME::UseGalCanvas().

113  {
115  }
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
Class VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (...
void EDA_DRAW_PANEL_GAL::onEnter ( wxEvent &  aEvent)
protected

Definition at line 420 of file draw_panel_gal.cpp.

References m_stealsFocus, and SetFocus().

Referenced by EDA_DRAW_PANEL_GAL().

421 {
422  // Getting focus is necessary in order to receive key events properly
423  if( m_stealsFocus )
424  SetFocus();
425 
426  aEvent.Skip();
427 }
virtual void SetFocus() override
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over...
void EDA_DRAW_PANEL_GAL::onEvent ( wxEvent &  aEvent)
protected

Definition at line 406 of file draw_panel_gal.cpp.

References TOOL_DISPATCHER::DispatchWxEvent(), m_eventDispatcher, m_lostFocus, m_stealsFocus, Refresh(), and SetFocus().

Referenced by EDA_DRAW_PANEL_GAL().

407 {
408  if( m_lostFocus && m_stealsFocus )
409  SetFocus();
410 
411  if( !m_eventDispatcher )
412  aEvent.Skip();
413  else
415 
416  Refresh();
417 }
virtual void DispatchWxEvent(wxEvent &aEvent)
Function DispatchWxEvent() Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs...
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
virtual void SetFocus() override
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...
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over...
void EDA_DRAW_PANEL_GAL::onLostFocus ( wxFocusEvent &  aEvent)
protected

Definition at line 430 of file draw_panel_gal.cpp.

References m_lostFocus.

Referenced by EDA_DRAW_PANEL_GAL().

431 {
432  m_lostFocus = true;
433 
434  aEvent.Skip();
435 }
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
void EDA_DRAW_PANEL_GAL::onPaint ( wxPaintEvent &  WXUNUSEDaEvent)
protected

Definition at line 155 of file draw_panel_gal.cpp.

References KIGFX::GAL::BeginDrawing(), KIGFX::GAL::ClearScreen(), KIGFX::VIEW::ClearTargets(), DisplayError(), KIGFX::GAL::DrawCursor(), KIGFX::GAL::DrawGrid(), KIGFX::GAL::EndDrawing(), GAL_TYPE_CAIRO, GetBackend(), KIGFX::RENDER_SETTINGS::GetBackgroundColor(), KIGFX::WX_VIEW_CONTROLS::GetCursorPosition(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::PAINTER::GetSettings(), KIGFX::VIEW::IsDirty(), KIGFX::VIEW::IsTargetDirty(), LAYER_CURSOR, m_drawing, m_edaFrame, m_gal, m_lastRefresh, m_painter, m_parent, m_pendingRefresh, m_view, m_viewControls, PROF_COUNTER::msecs(), KIGFX::VIEW::Redraw(), KIGFX::GAL::SetClearColor(), KIGFX::GAL::SetCursorColor(), PROF_COUNTER::Stop(), SwitchBackend(), KIGFX::TARGET_NONCACHED, KIGFX::VIEW::UpdateItems(), KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars(), and EDA_DRAW_FRAME::UseGalCanvas().

Referenced by onRefreshTimer(), and StopDrawing().

156 {
157  m_pendingRefresh = false;
158 
159  if( m_drawing )
160  return;
161 
162 #ifdef PROFILE
163  PROF_COUNTER totalRealTime;
164 #endif /* PROFILE */
165 
166  wxASSERT( m_painter );
167 
168  m_drawing = true;
169  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
170 
172 
173  m_view->UpdateItems();
174 
175  try
176  {
177  m_gal->BeginDrawing();
178  m_gal->SetClearColor( settings->GetBackgroundColor() );
180  m_gal->ClearScreen( );
181 
182  if( m_view->IsDirty() )
183  {
184  m_view->ClearTargets();
185 
186  // Grid has to be redrawn only when the NONCACHED target is redrawn
188  m_gal->DrawGrid();
189 
190  m_view->Redraw();
191  }
192 
194  m_gal->EndDrawing();
195  }
196  catch( std::runtime_error& err )
197  {
198  assert( GetBackend() != GAL_TYPE_CAIRO );
199 
200  // Cairo is supposed to be the safe backend, there is not a single "throw" in its code
202 
203  if( m_edaFrame )
204  m_edaFrame->UseGalCanvas( true );
205 
206  DisplayError( m_parent, wxString( err.what() ) );
207  }
208 
209 #ifdef PROFILE
210  totalRealTime.Stop();
211  wxLogDebug( "EDA_DRAW_PANEL_GAL::onPaint(): %.1f ms", totalRealTime.msecs() );
212 #endif /* PROFILE */
213 
214  m_lastRefresh = wxGetLocalTimeMillis();
215  m_drawing = false;
216 }
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?
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
void SetClearColor(const COLOR4D &aColor)
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
Class RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output ...
Definition: painter.h:56
GAL_TYPE GetBackend() const
Function GetBackend Returns the type of backend currently used by GAL canvas.
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:539
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:45
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
Definition: painter.h:206
virtual void UseGalCanvas(bool aEnable)
Function UseGalCanvas used to switch between standard and GAL-based canvas.
Auxiliary rendering target (noncached)
Definition: definitions.h:42
void UpdateScrollbars()
Adjusts the scrollbars position to match the current viewport.
bool m_drawing
True if GAL is currently redrawing the view.
wxWindow * m_parent
Pointer to the parent window.
void Redraw()
Function Redraw() Immediately redraws the whole view.
Definition: view.cpp:1003
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:556
virtual void DrawCursor(const VECTOR2D &aCursorPosition)
Draw the cursor.
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them...
Definition: view.cpp:1272
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
virtual void DrawGrid()
>
virtual void ClearScreen()
Clear the screen.
double msecs() const
Definition: profile.h:124
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
VECTOR2D GetCursorPosition(bool aSnappingEnabled) const override
Returns the current cursor position in world coordinates.
void ClearTargets()
Function ClearTargets() Clears targets that are marked as dirty.
Definition: view.cpp:984
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
virtual void BeginDrawing()
Begin the drawing, needs to be called for every new frame.
KIGFX::PAINTER * m_painter
Contains information about how to draw items using GAL.
virtual void EndDrawing()
End the drawing, needs to be called for every new frame.
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:71
const COLOR4D & GetBackgroundColor() const
Function GetBackgroundColor Returns current background color settings.
Definition: painter.h:186
void EDA_DRAW_PANEL_GAL::onRefreshTimer ( wxTimerEvent &  aEvent)
protected

Definition at line 438 of file draw_panel_gal.cpp.

References KIGFX::GAL::IsInitialized(), m_drawing, m_drawingEnabled, m_gal, m_pendingRefresh, m_refreshTimer, and onPaint().

Referenced by EDA_DRAW_PANEL_GAL().

439 {
440  if( !m_drawingEnabled )
441  {
442  if( m_gal && m_gal->IsInitialized() )
443  {
444  m_drawing = false;
445  m_pendingRefresh = true;
446  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
447  m_drawingEnabled = true;
448  }
449  else
450  {
451  // Try again soon
452  m_refreshTimer.StartOnce( 100 );
453  return;
454  }
455  }
456 
457  wxPaintEvent redrawEvent;
458  wxPostEvent( this, redrawEvent );
459 }
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.
virtual bool IsInitialized() const
Returns the initalization status for the canvas.
bool m_drawing
True if GAL is currently redrawing the view.
void onPaint(wxPaintEvent &WXUNUSED(aEvent))
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
virtual void EDA_DRAW_PANEL_GAL::OnShow ( )
inlinevirtual

Function OnShow() Called when the window is shown for the first time.

Reimplemented in PCB_DRAW_PANEL_GAL, and GERBVIEW_DRAW_PANEL_GAL.

Definition at line 184 of file class_draw_panel_gal.h.

Referenced by onShowTimer().

184 {}
void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protected

Definition at line 462 of file draw_panel_gal.cpp.

References KIGFX::GAL::IsVisible(), m_gal, m_onShowTimer, and OnShow().

Referenced by EDA_DRAW_PANEL_GAL().

463 {
464  if( m_gal && m_gal->IsVisible() )
465  {
466  m_onShowTimer.Stop();
467  OnShow();
468  }
469 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
virtual void OnShow()
Function OnShow() Called when the window is shown for the first time.
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
wxTimer m_onShowTimer
Timer used to execute OnShow() when the window finally appears on the screen.
void EDA_DRAW_PANEL_GAL::onSize ( wxSizeEvent &  aEvent)
protected

Definition at line 219 of file draw_panel_gal.cpp.

References m_gal, m_view, KIGFX::VIEW::MarkTargetDirty(), KIGFX::GAL::ResizeScreen(), KIGFX::TARGET_CACHED, and KIGFX::TARGET_NONCACHED.

Referenced by EDA_DRAW_PANEL_GAL().

220 {
221  wxSize clientSize = GetClientSize();
222  m_gal->ResizeScreen( clientSize.x, clientSize.y );
225 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
Auxiliary rendering target (noncached)
Definition: definitions.h:42
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:568
virtual void ResizeScreen(int aWidth, int aHeight)
Resizes the canvas.
Main rendering target (cached)
Definition: definitions.h:41
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
void EDA_DRAW_PANEL_GAL::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 action plugins, after running the plugin, so call this function is usually not needed inside action plugins.

Could be deprecated because modifying a board (especially deleting items) outside a action plugin can crash Pcbnew.

Definition at line 228 of file draw_panel_gal.cpp.

References delta, ForceRefresh(), m_lastRefresh, m_pendingRefresh, m_refreshTimer, and MinRefreshPeriod.

Referenced by FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), GERBVIEW_CONTROL::HighlightControl(), PCB_EDIT_FRAME::ListNetsAndSelect(), MODULE_EDITOR_TOOLS::ModuleEdgeOutlines(), MODULE_EDITOR_TOOLS::ModuleTextOutlines(), onEvent(), PCB_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectHighlightChoice(), PCBNEW_CONTROL::PadDisplayMode(), PCB_EDIT_FRAME::Process_Config(), TOOL_MANAGER::ProcessEvent(), PCB_EDITOR_CONTROL::ratsnestTimer(), DIALOG_PAD_PROPERTIES::redraw(), Refresh(), EDA_DRAW_PANEL::Refresh(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), GERBVIEW_FRAME::SetActiveLayer(), PCBNEW_CONTROL::TrackDisplayMode(), PCBNEW_CONTROL::ViaDisplayMode(), and PCBNEW_CONTROL::ZoneDisplayMode().

229 {
230  if( m_pendingRefresh )
231  return;
232 
233  m_pendingRefresh = true;
234 
235 #ifdef __WXMAC__
236  // Timers on OS X may have a high latency (seen up to 500ms and more) which
237  // makes repaints jerky. No negative impact seen without throttling, so just
238  // do an unconditional refresh for OS X.
239  ForceRefresh();
240 #else
241  wxLongLong t = wxGetLocalTimeMillis();
242  wxLongLong delta = t - m_lastRefresh;
243 
244  if( delta >= MinRefreshPeriod )
245  {
246  ForceRefresh();
247  }
248  else
249  {
250  // One shot timer
251  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
252  }
253 #endif
254 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer responsible for preventing too frequent refresh.
void ForceRefresh()
Function ForceRefresh() Forces a redraw.
static const int delta[8][2]
Definition: solve.cpp:112
static const int MinRefreshPeriod
60 FPS.
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( int  aCursor)
inline

Function SetCurrentCursor Set the current cursor shape for this panel.

Definition at line 208 of file class_draw_panel_gal.h.

References m_currentCursor.

Referenced by EDA_DRAW_FRAME::SetToolID().

209  {
210  m_currentCursor = aCursor;
211  SetCursor( (wxStockCursor) m_currentCursor );
212  }
int m_currentCursor
Current mouse cursor shape id.
void EDA_DRAW_PANEL_GAL::SetEventDispatcher ( TOOL_DISPATCHER aEventDispatcher)

Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools.

Parameters
aEventDispatcheris the object that will be used for dispatching events. DRAW_PANEL_GAL does not take over the ownership. Passing NULL disconnects all event handlers from the DRAW_PANEL_GAL and parent frame.

Definition at line 264 of file draw_panel_gal.cpp.

References TOOL_DISPATCHER::DispatchWxCommand(), m_eventDispatcher, and m_parent.

Referenced by EVT_TOOL(), FOOTPRINT_EDIT_FRAME::setupTools(), PCB_BASE_FRAME::UseGalCanvas(), and GERBVIEW_FRAME::UseGalCanvas().

265 {
266  m_eventDispatcher = aEventDispatcher;
267  const wxEventType eventTypes[] = { wxEVT_TOOL };
268 
269  if( m_eventDispatcher )
270  {
271  for( wxEventType type : eventTypes )
272  {
273  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
274  NULL, m_eventDispatcher );
275  }
276  }
277  else
278  {
279  for( wxEventType type : eventTypes )
280  {
281  // While loop is used to be sure that all event handlers are removed.
282  while( m_parent->Disconnect( type,
283  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
284  NULL, m_eventDispatcher ) );
285  }
286  }
287 }
wxWindow * m_parent
Pointer to the parent window.
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
virtual void DispatchWxCommand(wxCommandEvent &aEvent)
Function DispatchWxCommand() Processes wxCommands (mostly menu related events) and runs appropriate a...
void EDA_DRAW_PANEL_GAL::SetFocus ( )
overridevirtual

Definition at line 139 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL::GetParent(), and m_lostFocus.

Referenced by onEnter(), onEvent(), and GERBVIEW_FRAME::SetActiveLayer().

140 {
141 // Windows has a strange manner on bringing up and activating windows
142 // containing a GAL canvas just after moving the mouse cursor into its area.
143 // Feel free to uncomment or extend the following #ifdef if you experience
144 // similar problems on your platform.
145 #ifdef __WINDOWS__
146  if( !GetParent()->IsDescendant( wxWindow::FindFocus() ) )
147  return;
148 #endif
149 
150  wxScrolledCanvas::SetFocus();
151  m_lostFocus = false;
152 }
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
void EDA_DRAW_PANEL_GAL::SetHighContrastLayer ( int  aLayer)
virtual

Function SetHighContrastLayer Takes care of display settings for the given layer to be displayed in high contrast mode.

Reimplemented in PCB_DRAW_PANEL_GAL, and GERBVIEW_DRAW_PANEL_GAL.

Definition at line 306 of file draw_panel_gal.cpp.

References KIGFX::RENDER_SETTINGS::ClearActiveLayers(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), m_view, KIGFX::RENDER_SETTINGS::SetActiveLayer(), SetTopLayer(), and KIGFX::VIEW::UpdateAllLayersColor().

Referenced by PCBNEW_CONTROL::HighContrastMode(), and GERBVIEW_FRAME::SetActiveLayer().

307 {
308  // Set display settings for high contrast mode
310 
311  SetTopLayer( aLayer );
312 
313  rSettings->ClearActiveLayers();
314  rSettings->SetActiveLayer( aLayer );
315 
317 }
Class RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output ...
Definition: painter.h:56
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:76
void ClearActiveLayers()
Function ClearActiveLayers Clears the list of active layers.
Definition: painter.h:98
virtual void SetTopLayer(int aLayer)
Function SetTopLayer Moves the selected layer to the top, so it is displayed above all others...
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:196
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:675
void EDA_DRAW_PANEL_GAL::SetStealsFocus ( bool  aStealsFocus)
inline

Set whether focus is taken on certain events (mouseover, keys, etc).

This should be true (and is by default) for any primary canvas, but can be false to make well-behaved preview panes and the like.

Definition at line 191 of file class_draw_panel_gal.h.

References m_stealsFocus.

Referenced by FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL().

192  {
193  m_stealsFocus = aStealsFocus;
194  }
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over...
void EDA_DRAW_PANEL_GAL::SetTopLayer ( int  aLayer)
virtual

Function SetTopLayer Moves the selected layer to the top, so it is displayed above all others.

Reimplemented in PCB_DRAW_PANEL_GAL, and GERBVIEW_DRAW_PANEL_GAL.

Definition at line 320 of file draw_panel_gal.cpp.

References KIGFX::VIEW::ClearTopLayers(), m_view, KIGFX::VIEW::SetTopLayer(), and KIGFX::VIEW::UpdateAllLayersOrder().

Referenced by GERBVIEW_FRAME::SetActiveLayer(), and SetHighContrastLayer().

321 {
323  m_view->SetTopLayer( aLayer );
325 }
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:730
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers...
Definition: view.cpp:797
void ClearTopLayers()
Function ClearTopLayers() Removes all layers from the on-the-top set (they are no longer displayed ov...
Definition: view.cpp:782
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
void EDA_DRAW_PANEL_GAL::StartDrawing ( )

Function StartDrawing() Begins drawing if it was stopped previously.

Definition at line 290 of file draw_panel_gal.cpp.

References m_refreshTimer.

Referenced by FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), DIALOG_PAD_PROPERTIES::prepareCanvas(), DIALOG_PAD_PROPERTIES::redraw(), PCB_BASE_FRAME::UseGalCanvas(), and GERBVIEW_FRAME::UseGalCanvas().

291 {
292  // Start querying GAL if it is ready
293  m_refreshTimer.StartOnce( 100 );
294 }
wxTimer m_refreshTimer
Timer responsible for preventing too frequent refresh.
void EDA_DRAW_PANEL_GAL::StopDrawing ( )

Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDrawing() is called.

Definition at line 297 of file draw_panel_gal.cpp.

References m_drawingEnabled, m_pendingRefresh, m_refreshTimer, and onPaint().

Referenced by FOOTPRINT_EDIT_FRAME::OnCloseWindow(), FOOTPRINT_VIEWER_FRAME::OnCloseWindow(), DIALOG_PAD_PROPERTIES::redraw(), SwitchBackend(), GERBVIEW_FRAME::UseGalCanvas(), and ~EDA_DRAW_PANEL_GAL().

298 {
299  m_drawingEnabled = false;
300  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
301  m_pendingRefresh = false;
302  m_refreshTimer.Stop();
303 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer responsible for preventing too frequent refresh.
void onPaint(wxPaintEvent &WXUNUSED(aEvent))
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
bool EDA_DRAW_PANEL_GAL::SwitchBackend ( GAL_TYPE  aGalType)
virtual

Function SwitchBackend Switches method of rendering graphics.

Parameters
aGalTypeis a type of rendering engine that you want to use.

Reimplemented in PCB_DRAW_PANEL_GAL, and GERBVIEW_DRAW_PANEL_GAL.

Definition at line 335 of file draw_panel_gal.cpp.

References DisplayError(), GAL_TYPE_CAIRO, GAL_TYPE_NONE, GAL_TYPE_OPENGL, m_backend, m_gal, m_options, m_painter, m_parent, m_view, KIGFX::GAL_DISPLAY_OPTIONS::NotifyChanged(), KIGFX::GAL::ResizeScreen(), KIGFX::VIEW::ReverseDrawOrder(), KIGFX::VIEW::SetGAL(), KIGFX::PAINTER::SetGAL(), and StopDrawing().

Referenced by EDA_DRAW_PANEL_GAL(), onPaint(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), PCB_DRAW_PANEL_GAL::SwitchBackend(), PCB_BASE_FRAME::SwitchCanvas(), and GERBVIEW_FRAME::SwitchCanvas().

336 {
337  // Do not do anything if the currently used GAL is correct
338  if( aGalType == m_backend && m_gal != NULL )
339  return true;
340 
341  bool result = true; // assume everything will be fine
342 
343  // Prevent refreshing canvas during backend switch
344  StopDrawing();
345 
346  KIGFX::GAL* new_gal = NULL;
347 
348  try
349  {
350  switch( aGalType )
351  {
352  case GAL_TYPE_OPENGL:
353  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
354  break;
355 
356  case GAL_TYPE_CAIRO:
357  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
358  break;
359 
360  default:
361  assert( false );
362  // warn about unhandled GAL canvas type, but continue with the fallback option
363 
364  case GAL_TYPE_NONE:
365  // KIGFX::GAL is a stub - it actually does cannot display anything,
366  // but prevents code relying on GAL canvas existence from crashing
367  new_gal = new KIGFX::GAL( m_options );
368  break;
369  }
370  }
371  catch( std::runtime_error& err )
372  {
373  new_gal = new KIGFX::GAL( m_options );
374  aGalType = GAL_TYPE_NONE;
375  DisplayError( m_parent, wxString( err.what() ) );
376  result = false;
377  }
378 
379  // trigger update of the gal options in case they differ
380  // from the defaults
382 
383  assert( new_gal );
384  delete m_gal;
385  m_gal = new_gal;
386 
387  wxSize size = GetClientSize();
388  m_gal->ResizeScreen( size.GetX(), size.GetY() );
389 
390  if( m_painter )
391  m_painter->SetGAL( m_gal );
392 
393  if( m_view )
394  {
395  m_view->SetGAL( m_gal );
396  // Note: OpenGL requires reverse draw order when draw priority is enabled
397  m_view->ReverseDrawOrder( aGalType == GAL_TYPE_OPENGL );
398  }
399 
400  m_backend = aGalType;
401 
402  return result;
403 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
void ReverseDrawOrder(bool aFlag)
Function ReverseDrawOrder() Only takes effect if UseDrawPriority is true.
Definition: view.h:647
GAL_TYPE m_backend
Currently used GAL.
KIGFX::GAL_DISPLAY_OPTIONS & m_options
Class OpenGL_GAL is the OpenGL implementation of the Graphics Abstraction Layer.
Definition: opengl_gal.h:65
wxWindow * m_parent
Pointer to the parent window.
virtual void ResizeScreen(int aWidth, int aHeight)
Resizes the canvas.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
void SetGAL(GAL *aGal)
Function SetGAL Changes Graphics Abstraction Layer used for drawing items for a new one...
Definition: painter.h:298
KIGFX::PAINTER * m_painter
Contains information about how to draw items using GAL.
void SetGAL(GAL *aGal)
Function SetGAL() Assigns a rendering device for the VIEW.
Definition: view.cpp:485
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:71
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.

Member Data Documentation

GAL_TYPE EDA_DRAW_PANEL_GAL::m_backend
protected
int EDA_DRAW_PANEL_GAL::m_currentCursor
protected

Current mouse cursor shape id.

Definition at line 239 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), GetCurrentCursor(), and SetCurrentCursor().

int EDA_DRAW_PANEL_GAL::m_defaultCursor
protected

The default mouse cursor shape id.

Definition at line 241 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), and GetDefaultCursor().

bool EDA_DRAW_PANEL_GAL::m_drawing
protected

True if GAL is currently redrawing the view.

Definition at line 256 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), onPaint(), onRefreshTimer(), and ~EDA_DRAW_PANEL_GAL().

bool EDA_DRAW_PANEL_GAL::m_drawingEnabled
protected

Flag that determines if VIEW may use GAL for redrawing the screen.

Definition at line 259 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), onRefreshTimer(), and StopDrawing().

EDA_DRAW_FRAME* EDA_DRAW_PANEL_GAL::m_edaFrame
protected

Parent EDA_DRAW_FRAME (if available)

Definition at line 247 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), GetParentEDAFrame(), and onPaint().

TOOL_DISPATCHER* EDA_DRAW_PANEL_GAL::m_eventDispatcher
protected

Processes and forwards events to tools.

Definition at line 284 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), onEvent(), and SetEventDispatcher().

wxLongLong EDA_DRAW_PANEL_GAL::m_lastRefresh
protected

Last timestamp when the panel was refreshed.

Definition at line 250 of file class_draw_panel_gal.h.

Referenced by onPaint(), and Refresh().

bool EDA_DRAW_PANEL_GAL::m_lostFocus
protected

Flag to indicate that focus should be regained on the next mouse event.

It is a workaround for cases when the panel loses keyboard focus, so it does not react to hotkeys anymore.

Definition at line 288 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), onEvent(), onLostFocus(), and SetFocus().

wxTimer EDA_DRAW_PANEL_GAL::m_onShowTimer
protected

Timer used to execute OnShow() when the window finally appears on the screen.

Definition at line 265 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), and onShowTimer().

KIGFX::GAL_DISPLAY_OPTIONS& EDA_DRAW_PANEL_GAL::m_options
protected

Definition at line 281 of file class_draw_panel_gal.h.

Referenced by SwitchBackend().

KIGFX::PAINTER* EDA_DRAW_PANEL_GAL::m_painter
protected
wxWindow* EDA_DRAW_PANEL_GAL::m_parent
protected

Pointer to the parent window.

Definition at line 244 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), onPaint(), SetEventDispatcher(), and SwitchBackend().

bool EDA_DRAW_PANEL_GAL::m_pendingRefresh
protected

Is there a redraw event requested?

Definition at line 253 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), onPaint(), onRefreshTimer(), Refresh(), and StopDrawing().

wxTimer EDA_DRAW_PANEL_GAL::m_refreshTimer
protected

Timer responsible for preventing too frequent refresh.

Definition at line 262 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), onRefreshTimer(), Refresh(), StartDrawing(), and StopDrawing().

bool EDA_DRAW_PANEL_GAL::m_stealsFocus
protected

Flag to indicate whether the panel should take focus at certain times (when moused over, and on various mouse/key events)

Definition at line 292 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), GetStealsFocus(), onEnter(), onEvent(), and SetStealsFocus().

KIGFX::WX_VIEW_CONTROLS* EDA_DRAW_PANEL_GAL::m_viewControls
protected

Control for VIEW (moving, zooming, etc.)

Definition at line 277 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), GetViewControls(), onPaint(), and ~EDA_DRAW_PANEL_GAL().

const int EDA_DRAW_PANEL_GAL::MinRefreshPeriod = 17
staticprotected

60 FPS.

Definition at line 236 of file class_draw_panel_gal.h.

Referenced by Refresh().


The documentation for this class was generated from the following files: