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 PL_DRAW_PANEL_GAL SCH_DRAW_PANEL SCH_PREVIEW_PANEL FOOTPRINT_PREVIEW_PANEL

Public Types

enum  GAL_TYPE {
  GAL_TYPE_UNKNOWN = -1, GAL_TYPE_NONE = 0, 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)
 Create a drawing panel that is contained inside aParentWindow. More...
 
 ~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...
 
virtual 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...
 
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 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 (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
 
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...
 
void SetCurrentCursor (wxStockCursor aStockCursorID)
 Function SetCurrentCursor Set the current cursor shape for this panel. More...
 
void SetCurrentCursor (const wxCursor &aCursor)
 
virtual BOX2I GetDefaultViewBBox () const
 Returns the bounding box of the view that should be used if model is not valid For example, the worksheet bounding box for an empty PCB. More...
 
void OnEvent (wxEvent &aEvent)
 Used to forward events to the canvas from popups, etc. More...
 

Protected Member Functions

virtual void onPaint (wxPaintEvent &WXUNUSED(aEvent))
 
void onSize (wxSizeEvent &aEvent)
 
void onEnter (wxEvent &aEvent)
 
void onLostFocus (wxFocusEvent &aEvent)
 
void onRefreshTimer (wxTimerEvent &aEvent)
 
void onShowTimer (wxTimerEvent &aEvent)
 
void onSetCursor (wxSetCursorEvent &event)
 

Protected Attributes

wxCursor m_currentCursor
 Current 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...
 
wxTimer m_refreshTimer
 Timer to prevent too-frequent refreshing. 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_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...
 
std::unique_ptr< 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 52 of file class_draw_panel_gal.h.

Member Enumeration Documentation

◆ GAL_TYPE

Enumerator
GAL_TYPE_UNKNOWN 

not specified: a GAL engine must be set by the client

GAL_TYPE_NONE 

GAL not used (the legacy wxDC engine is used)

GAL_TYPE_OPENGL 

OpenGL implementation.

GAL_TYPE_CAIRO 

Cairo implementation.

GAL_TYPE_LAST 

Sentinel, do not use as a parameter.

Definition at line 55 of file class_draw_panel_gal.h.

55  {
56  GAL_TYPE_UNKNOWN = -1,
57  GAL_TYPE_NONE = 0,
61  };
Sentinel, do not use as a parameter.
not specified: a GAL engine must be set by the client
GAL not used (the legacy wxDC engine is used)

Constructor & Destructor Documentation

◆ EDA_DRAW_PANEL_GAL()

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 
)

Create a drawing panel that is contained inside aParentWindow.

If aParentWindow is not an EDA frame, a search through all the parents of the parent window will be done to find the frame.

Parameters
aParentWindowis the window immeidately containing this panel

Definition at line 50 of file draw_panel_gal.cpp.

54  : wxScrolledCanvas( aParentWindow, aWindowId, aPosition, aSize ),
55  m_edaFrame( nullptr ),
56  m_gal( nullptr ),
57  m_view( nullptr ),
58  m_painter( nullptr ),
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 }
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.
GAL_TYPE m_backend
Currently used GAL.
static const wxEventType EVT_REFRESH_MOUSE
Event that forces mouse move event in the dispatcher (eg.
void OnEvent(wxEvent &aEvent)
Used to forward events to the canvas from popups, etc.
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
KIGFX::GAL_DISPLAY_OPTIONS & m_options
void onLostFocus(wxFocusEvent &aEvent)
void onShowTimer(wxTimerEvent &aEvent)
void onRefreshTimer(wxTimerEvent &aEvent)
bool m_drawing
True if GAL is currently redrawing the view.
wxWindow * m_parent
Pointer to the parent window.
#define NULL
GAL not used (the legacy wxDC engine is used)
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
void onSetCursor(wxSetCursorEvent &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)
wxCursor m_currentCursor
Current mouse cursor shape id.
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...

References KIGFX::WX_VIEW_CONTROLS::EVT_REFRESH_MOUSE, m_currentCursor, m_drawing, m_drawingEnabled, m_edaFrame, m_eventDispatcher, m_onShowTimer, m_parent, m_pendingRefresh, m_refreshTimer, NULL, onEnter(), OnEvent(), onLostFocus(), onRefreshTimer(), onSetCursor(), onShowTimer(), onSize(), and SwitchBackend().

◆ ~EDA_DRAW_PANEL_GAL()

EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL ( )

Definition at line 131 of file draw_panel_gal.cpp.

132 {
133  StopDrawing();
134 
135  wxASSERT( !m_drawing );
136 
137  delete m_viewControls;
138  delete m_view;
139  delete m_gal;
140 }
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...

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

Member Function Documentation

◆ ForceRefresh()

◆ GetBackend()

◆ GetDefaultViewBBox()

virtual BOX2I EDA_DRAW_PANEL_GAL::GetDefaultViewBBox ( ) const
inlinevirtual

Returns the bounding box of the view that should be used if model is not valid For example, the worksheet bounding box for an empty PCB.

Returns
the default bounding box for the panel

Reimplemented in PCB_DRAW_PANEL_GAL, and GERBVIEW_DRAW_PANEL_GAL.

Definition at line 196 of file class_draw_panel_gal.h.

196 { return BOX2I(); }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:521

Referenced by COMMON_TOOLS::CenterContents(), and COMMON_TOOLS::ZoomFitScreen().

◆ GetGAL()

◆ GetMsgPanelInfo()

virtual void EDA_DRAW_PANEL_GAL::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
inlinevirtual

Reimplemented in PCB_DRAW_PANEL_GAL, GERBVIEW_DRAW_PANEL_GAL, and PL_DRAW_PANEL_GAL.

Definition at line 159 of file class_draw_panel_gal.h.

160  {
161  wxASSERT( false );
162  }

◆ GetParentEDAFrame()

◆ GetView()

virtual KIGFX::VIEW* EDA_DRAW_PANEL_GAL::GetView ( ) const
inlinevirtual

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

Returns
The instance of VIEW.

Reimplemented in PCB_DRAW_PANEL_GAL, and SCH_DRAW_PANEL.

Definition at line 104 of file class_draw_panel_gal.h.

104 { return m_view; }
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

References m_view.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::applyDisplaySettingsToGAL(), GERBVIEW_FRAME::Clear_DrawLayers(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), DIALOG_PRINT_GERBVIEW::createPrintout(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), EDA_DRAW_FRAME::FocusOnLocation(), GERBVIEW_FRAME::GetVisibleLayers(), GERBVIEW_CONTROL::HighlightControl(), PROPERTIES_FRAME::OnAcceptPrms(), GERBVIEW_FRAME::OnCloseWindow(), GERBER_LAYER_WIDGET::OnLayerColorChange(), EDA_DRAW_FRAME::OnMove(), onPaint(), GERBER_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectHighlightChoice(), PL_EDITOR_FRAME::OnSelectPage(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), GERBER_LAYER_WIDGET::ReFill(), PCB_BASE_FRAME::SetDisplayOptions(), GERBVIEW_FRAME::SetElementVisibility(), EDA_DRAW_FRAME::SetGridVisibility(), GERBVIEW_FRAME::SetVisibleLayers(), GERBVIEW_FRAME::SortLayersByX2Attributes(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), PL_EDITOR_CONTROL::ToggleBackgroundColor(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_GAL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), GERBVIEW_FRAME::UpdateDisplayOptions(), PANEL_EESCHEMA_COLOR_SETTINGS::updatePreview(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), and SYMBOL_PREVIEW_WIDGET::~SYMBOL_PREVIEW_WIDGET().

◆ GetViewControls()

◆ onEnter()

void EDA_DRAW_PANEL_GAL::onEnter ( wxEvent &  aEvent)
protected

Definition at line 469 of file draw_panel_gal.cpp.

470 {
471  // Getting focus is necessary in order to receive key events properly
472  if( m_stealsFocus )
473  SetFocus();
474 
475  aEvent.Skip();
476 }
virtual void SetFocus() override
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...

References m_stealsFocus, and SetFocus().

Referenced by EDA_DRAW_PANEL_GAL().

◆ OnEvent()

void EDA_DRAW_PANEL_GAL::OnEvent ( wxEvent &  aEvent)

Used to forward events to the canvas from popups, etc.

Definition at line 455 of file draw_panel_gal.cpp.

456 {
457  if( m_lostFocus && m_stealsFocus )
458  SetFocus();
459 
460  if( !m_eventDispatcher )
461  aEvent.Skip();
462  else
464 
465  Refresh();
466 }
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
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...
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,...

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

Referenced by EDA_DRAW_PANEL_GAL(), and STATUS_POPUP::onCharHook().

◆ onLostFocus()

void EDA_DRAW_PANEL_GAL::onLostFocus ( wxFocusEvent &  aEvent)
protected

Definition at line 479 of file draw_panel_gal.cpp.

480 {
481  m_lostFocus = true;
482 
483  aEvent.Skip();
484 }
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.

References m_lostFocus.

Referenced by EDA_DRAW_PANEL_GAL().

◆ onPaint()

void EDA_DRAW_PANEL_GAL::onPaint ( wxPaintEvent &  WXUNUSEDaEvent)
protectedvirtual

Reimplemented in SCH_PREVIEW_PANEL, and SCH_DRAW_PANEL.

Definition at line 159 of file draw_panel_gal.cpp.

160 {
161  // Update scroll position if the canvas is managed by a EDA frame
162  // (i.e. not by a preview panel in a dialog)
163  if( GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
165 
167 
168  if( !m_gal->IsVisible() )
169  return;
170 
171  m_pendingRefresh = false;
172 
173  if( m_drawing )
174  return;
175 
176 #ifdef PROFILE
177  PROF_COUNTER totalRealTime;
178 #endif /* PROFILE */
179 
180  wxASSERT( m_painter );
181 
182  m_drawing = true;
183  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
184 
185  try
186  {
187  m_view->UpdateItems();
188 
190 
191  m_gal->SetClearColor( settings->GetBackgroundColor() );
192  m_gal->SetGridColor( settings->GetGridColor() );
193  m_gal->SetCursorColor( settings->GetCursorColor() );
194 
195  // TODO: find why ClearScreen() must be called here in opengl mode
196  // and only if m_view->IsDirty() in Cairo mode to avoid distaly artifacts
197  // when moving the mouse cursor
198  if( m_backend == GAL_TYPE_OPENGL )
199  m_gal->ClearScreen();
200 
201  if( m_view->IsDirty() )
202  {
203  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
205  m_gal->ClearScreen();
206 
207  m_view->ClearTargets();
208 
209  // Grid has to be redrawn only when the NONCACHED target is redrawn
211  m_gal->DrawGrid();
212 
213  m_view->Redraw();
214  }
215 
217  }
218  catch( std::runtime_error& err )
219  {
220  constexpr auto GAL_FALLBACK = GAL_TYPE_CAIRO;
221 
222  SwitchBackend( GAL_FALLBACK );
223 
225  _( "Could not use OpenGL, falling back to software rendering" ),
226  wxString( err.what() ) );
227  }
228 
229 #ifdef PROFILE
230  totalRealTime.Stop();
231  wxLogTrace( "GAL_PROFILE", "EDA_DRAW_PANEL_GAL::onPaint(): %.1f ms", totalRealTime.msecs() );
232 #endif /* PROFILE */
233 
234  m_lastRefresh = wxGetLocalTimeMillis();
235  m_drawing = false;
236 }
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)
virtual const COLOR4D & GetGridColor()=0
Function GetGridColor Returns current grid color settings.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
GAL_TYPE m_backend
Currently used GAL.
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
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
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:44
Auxiliary rendering target (noncached)
Definition: definitions.h:49
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 Redraw()
Function Redraw() Immediately redraws the whole view.
Definition: view.cpp:1145
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
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
virtual void DrawGrid()
virtual void DrawCursor(const VECTOR2D &aCursorPosition)
Draw the cursor.
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1421
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
virtual void ClearScreen()
Clear the screen.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
#define _(s)
Definition: 3d_actions.cpp:33
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
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:1126
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:77
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.
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:557

References _, KIGFX::GAL::ClearScreen(), KIGFX::VIEW::ClearTargets(), DisplayInfoMessage(), KIGFX::GAL::DrawCursor(), KIGFX::GAL::DrawGrid(), GAL_TYPE_CAIRO, GAL_TYPE_OPENGL, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), KIGFX::VIEW::GetCenter(), KIGFX::RENDER_SETTINGS::GetCursorColor(), KIGFX::WX_VIEW_CONTROLS::GetCursorPosition(), KIGFX::RENDER_SETTINGS::GetGridColor(), GetParentEDAFrame(), EDA_DRAW_FRAME::GetScreen(), GetView(), KIGFX::VIEW::IsDirty(), KIGFX::VIEW::IsTargetDirty(), KIGFX::GAL::IsVisible(), m_backend, m_drawing, m_gal, m_lastRefresh, m_painter, m_parent, m_pendingRefresh, BASE_SCREEN::m_ScrollCenter, m_view, m_viewControls, PROF_COUNTER::msecs(), KIGFX::VIEW::Redraw(), KIGFX::GAL::SetClearColor(), KIGFX::GAL::SetCursorColor(), KIGFX::GAL::SetGridColor(), PROF_COUNTER::Stop(), SwitchBackend(), KIGFX::TARGET_NONCACHED, KIGFX::VIEW::UpdateItems(), and KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars().

Referenced by SCH_DRAW_PANEL::onPaint(), SCH_PREVIEW_PANEL::onPaint(), onRefreshTimer(), and StopDrawing().

◆ onRefreshTimer()

void EDA_DRAW_PANEL_GAL::onRefreshTimer ( wxTimerEvent &  aEvent)
protected

Definition at line 487 of file draw_panel_gal.cpp.

488 {
489  if( !m_drawingEnabled )
490  {
491  if( m_gal && m_gal->IsInitialized() )
492  {
493  m_drawing = false;
494  m_pendingRefresh = true;
495  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
496  m_drawingEnabled = true;
497  }
498  else
499  {
500  // Try again soon
501  m_refreshTimer.StartOnce( 100 );
502  return;
503  }
504  }
505 
506  wxPaintEvent redrawEvent;
507  wxPostEvent( this, redrawEvent );
508 }
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.
bool m_drawing
True if GAL is currently redrawing the view.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
#define NULL
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
virtual bool IsInitialized() const
Returns the initalization status for the canvas.

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

Referenced by EDA_DRAW_PANEL_GAL().

◆ onSetCursor()

void EDA_DRAW_PANEL_GAL::onSetCursor ( wxSetCursorEvent &  event)
protected

Definition at line 537 of file draw_panel_gal.cpp.

538 {
539  event.SetCursor( m_currentCursor );
540 }
wxCursor m_currentCursor
Current mouse cursor shape id.

References m_currentCursor.

Referenced by EDA_DRAW_PANEL_GAL(), and SwitchBackend().

◆ OnShow()

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, SCH_DRAW_PANEL, SCH_PREVIEW_PANEL, and GERBVIEW_DRAW_PANEL_GAL.

Definition at line 174 of file class_draw_panel_gal.h.

174 {}

Referenced by onShowTimer().

◆ onShowTimer()

void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protected

Definition at line 511 of file draw_panel_gal.cpp.

512 {
513  if( m_gal && m_gal->IsVisible() )
514  {
515  m_onShowTimer.Stop();
516  OnShow();
517  }
518 }
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.
wxTimer m_onShowTimer
Timer used to execute OnShow() when the window finally appears on the screen.
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.

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

Referenced by EDA_DRAW_PANEL_GAL().

◆ onSize()

void EDA_DRAW_PANEL_GAL::onSize ( wxSizeEvent &  aEvent)
protected

Definition at line 239 of file draw_panel_gal.cpp.

240 {
242  wxSize clientSize = GetClientSize();
243  clientSize.x = std::max( 10, clientSize.x );
244  clientSize.y = std::max( 10, clientSize.y );
245  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
246 
247  if( m_view )
248  {
251  }
252 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:585
virtual void ResizeScreen(int aWidth, int aHeight)
Resizes the canvas.
Main rendering target (cached)
Definition: definitions.h:48
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

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

Referenced by EDA_DRAW_PANEL_GAL().

◆ Refresh()

void EDA_DRAW_PANEL_GAL::Refresh ( bool  aEraseBackground = true,
const wxRect *  aRect = NULL 
)
overridevirtual

Update the board display after modifying it by 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.

Reimplemented in SCH_PREVIEW_PANEL.

Definition at line 255 of file draw_panel_gal.cpp.

256 {
257  if( m_pendingRefresh )
258  return;
259 
260  m_pendingRefresh = true;
261 
262 #ifdef __WXMAC__
263  // Timers on OS X may have a high latency (seen up to 500ms and more) which
264  // makes repaints jerky. No negative impact seen without throttling, so just
265  // do an unconditional refresh for OS X.
266  ForceRefresh();
267 #else
268  wxLongLong t = wxGetLocalTimeMillis();
269  wxLongLong delta = t - m_lastRefresh;
270 
271  if( delta >= MinRefreshPeriod )
272  {
273  ForceRefresh();
274  }
275  else
276  {
277  // One shot timer
278  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
279  }
280 #endif
281 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.
void ForceRefresh()
Function ForceRefresh() Forces a redraw.
static const int MinRefreshPeriod
60 FPS.
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.

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

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_FRAME::AnnotateComponents(), SCH_EDITOR_CONTROL::BackAnnotateFootprints(), SCH_EDIT_TOOL::BreakWire(), SCH_BASE_FRAME::CenterScreen(), ZONE_FILLER_TOOL::CheckAllZones(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), SCH_EDIT_FRAME::DeleteAnnotation(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), SCH_EDIT_TOOL::DoDelete(), PCB_INSPECTION_TOOL::doHideNet(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), LIB_EDIT_TOOL::editFieldProperties(), LIB_EDIT_TOOL::editGraphicProperties(), LIB_EDIT_TOOL::editTextProperties(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_FRAME::Files_io(), ZONE_FILLER_TOOL::FillAllZones(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDITOR_CONTROL::FindNext(), PCB_BASE_FRAME::FocusOnItem(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), PCB_VIEWER_TOOLS::GraphicOutlines(), PL_EDITOR_FRAME::HardRedraw(), GERBVIEW_CONTROL::HighlightControl(), DIALOG_SELECT_NET_FROM_LIST::highlightNetOnBoard(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), SCH_EDIT_FRAME::KiwayMailIn(), GERBVIEW_FRAME::loadListOfGerberAndDrillFiles(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), PCB_VIEWER_TOOLS::MeasureTool(), DIALOG_MIGRATE_BUSES::onAcceptClicked(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_EDIT_COMPONENTS_LIBID::onApplyButton(), DIALOG_ANNOTATE::OnApplyClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnEraseDrcMarkersClick(), OnEvent(), EDA_DRAW_FRAME::OnGridSettings(), GERBER_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerSelect(), PCB_LAYER_WIDGET::OnLayerSelect(), GERBER_LAYER_WIDGET::OnLayerVisible(), PCB_LAYER_WIDGET::OnLayerVisible(), SCH_EDIT_FRAME::OnModify(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), GERBER_LAYER_WIDGET::onPopupSelection(), PCB_LAYER_WIDGET::onPopupSelection(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), GERBER_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderEnable(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectActiveDCode(), PL_EDITOR_FRAME::OnSelectCoordOriginCorner(), GERBVIEW_FRAME::OnSelectDisplayMode(), EDA_DRAW_FRAME::OnSelectGrid(), GERBVIEW_FRAME::OnSelectHighlightChoice(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), PL_EDITOR_FRAME::OnSelectPage(), EDA_DRAW_FRAME::OnSelectZoom(), PROPERTIES_FRAME::OnSetDefaultValues(), DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), GERBVIEW_CONTROL::OpenDrillFile(), GERBVIEW_CONTROL::OpenJobFile(), GERBVIEW_CONTROL::OpenZipFile(), PCB_VIEWER_TOOLS::PadDisplayMode(), PL_EDITOR_FRAME::PrintPage(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_TOOL::Properties(), FOOTPRINT_EDITOR_TOOLS::Properties(), PCB_INSPECTION_TOOL::ratsnestTimer(), LIB_EDIT_FRAME::RebuildView(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListLib(), FOOTPRINT_WIZARD_FRAME::ReCreatePageList(), SCH_EDITOR_CONTROL::Redo(), DIALOG_PAD_PROPERTIES::redraw(), DIALOG_ERC::RedrawDrawPanel(), SCH_BASE_FRAME::RedrawScreen(), SCH_PREVIEW_PANEL::Refresh(), Refresh(), DIALOG_DRC::refreshBoardEditor(), refreshCallback(), EDA_DRAW_FRAME::RefreshCanvas(), SCH_BASE_FRAME::RefreshItem(), SCH_EDIT_TOOL::RefreshSymbolFromLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), SCH_EDITOR_CONTROL::RemapSymbols(), EDIT_TOOL::Remove(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), SCH_EDITOR_CONTROL::rescueProject(), DIALOG_EDIT_COMPONENTS_LIBID::revertChanges(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), GERBVIEW_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetDisplayOptions(), EDA_DRAW_FRAME::SetGridVisibility(), LIB_VIEW_FRAME::SetSelectedLibrary(), LIB_CONTROL::ShowElectricalTypes(), PCB_VIEWER_TOOLS::ShowPadNumbers(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), GERBVIEW_FRAME::SortLayersByX2Attributes(), GLOBAL_EDIT_TOOL::SwapLayers(), SCH_DRAW_PANEL::SwitchBackend(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_ERC::TestErc(), PCB_VIEWER_TOOLS::TextOutlines(), PL_EDITOR_CONTROL::ToggleBackgroundColor(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), PCBNEW_CONTROL::ToggleRatsnest(), PCBNEW_CONTROL::TrackDisplayMode(), PANEL_GAL_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_EDIT_LINE_STYLE::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), DIALOG_EDIT_SHEET_PIN::TransferDataFromWindow(), PANEL_LIBEDIT_SETTINGS::TransferDataFromWindow(), DIALOG_UPDATE_FIELDS::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::Undo(), GERBVIEW_FRAME::UpdateDisplayOptions(), SCH_EDIT_TOOL::UpdateFields(), SCH_EDITOR_CONTROL::UpdateFind(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), PCBNEW_CONTROL::ViaDisplayMode(), PCBNEW_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

◆ SetCurrentCursor() [1/2]

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( wxStockCursor  aStockCursorID)

Function SetCurrentCursor Set the current cursor shape for this panel.

Definition at line 521 of file draw_panel_gal.cpp.

522 {
523  if ( aStockCursorID <= wxCURSOR_NONE || aStockCursorID >= wxCURSOR_MAX )
524  aStockCursorID = wxCURSOR_ARROW;
525 
526  SetCurrentCursor( wxCursor( aStockCursorID ) );
527 }
void SetCurrentCursor(wxStockCursor aStockCursorID)
Function SetCurrentCursor Set the current cursor shape for this panel.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), LIB_MOVE_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), PICKER_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), EE_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetCurrentCursor() [2/2]

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( const wxCursor &  aCursor)

Definition at line 530 of file draw_panel_gal.cpp.

531 {
532  m_currentCursor = aCursor;
533  SetCursor( m_currentCursor );
534 }
wxCursor m_currentCursor
Current mouse cursor shape id.

References m_currentCursor.

◆ SetEventDispatcher()

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 291 of file draw_panel_gal.cpp.

292 {
293  m_eventDispatcher = aEventDispatcher;
294  const wxEventType eventTypes[] = { wxEVT_TOOL };
295 
296  if( m_eventDispatcher )
297  {
298  for( wxEventType type : eventTypes )
299  {
300  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
302  }
303  }
304  else
305  {
306  for( wxEventType type : eventTypes )
307  {
308  // While loop is used to be sure that all event handlers are removed.
309  while( m_parent->Disconnect( type,
310  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
311  NULL, m_eventDispatcher ) );
312  }
313  }
314 }
wxWindow * m_parent
Pointer to the parent window.
#define NULL
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...

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

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), LIB_VIEW_FRAME::setupTools(), LIB_EDIT_FRAME::setupTools(), and SCH_EDIT_FRAME::setupTools().

◆ SetFocus()

void EDA_DRAW_PANEL_GAL::SetFocus ( )
overridevirtual

Definition at line 143 of file draw_panel_gal.cpp.

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 }
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.

References m_lostFocus.

Referenced by onEnter(), OnEvent(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), GERBVIEW_FRAME::SetActiveLayer(), and ZONE_FILLER_TOOL::singleShotRefocus().

◆ SetHighContrastLayer()

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 333 of file draw_panel_gal.cpp.

334 {
335  // Set display settings for high contrast mode
337 
338  SetTopLayer( aLayer );
339 
340  rSettings->ClearActiveLayers();
341  rSettings->SetActiveLayer( aLayer );
342 
344 }
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
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...
void ClearActiveLayers()
Function ClearActiveLayers Clears the list of active layers.
virtual void SetTopLayer(int aLayer)
Function SetTopLayer Moves the selected layer to the top, so it is displayed above all others.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter 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:798

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

Referenced by GERBVIEW_FRAME::SetActiveLayer(), and PCB_BASE_FRAME::SetDisplayOptions().

◆ SetStealsFocus()

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 181 of file class_draw_panel_gal.h.

181 { m_stealsFocus = aStealsFocus; }
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...

References m_stealsFocus.

Referenced by LIB_VIEW_FRAME::ClickOnCmpList(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_VIEWER_FRAME::ClickOnLibList(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), DIALOG_PAD_PROPERTIES::prepareCanvas(), LIB_VIEW_FRAME::SetSelectedLibrary(), and SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET().

◆ SetTopLayer()

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, GERBVIEW_DRAW_PANEL_GAL, and PL_DRAW_PANEL_GAL.

Definition at line 347 of file draw_panel_gal.cpp.

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

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

Referenced by SetHighContrastLayer().

◆ StartDrawing()

void EDA_DRAW_PANEL_GAL::StartDrawing ( )

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

Definition at line 317 of file draw_panel_gal.cpp.

318 {
319  // Start querying GAL if it is ready
320  m_refreshTimer.StartOnce( 100 );
321 }
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.

References m_refreshTimer.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), EDA_DRAW_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), DIALOG_PAD_PROPERTIES::prepareCanvas(), DIALOG_PAD_PROPERTIES::redraw(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), and SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL().

◆ StopDrawing()

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 324 of file draw_panel_gal.cpp.

325 {
326  m_drawingEnabled = false;
327  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
328  m_pendingRefresh = false;
329  m_refreshTimer.Stop();
330 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
#define NULL
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.

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

Referenced by DIALOG_PAD_PROPERTIES::OnCancel(), FOOTPRINT_EDIT_FRAME::OnCloseWindow(), LIB_VIEW_FRAME::OnCloseWindow(), FOOTPRINT_VIEWER_FRAME::OnCloseWindow(), GERBVIEW_FRAME::OnCloseWindow(), DIALOG_PAD_PROPERTIES::redraw(), SwitchBackend(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), ~EDA_DRAW_PANEL_GAL(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ SwitchBackend()

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, SCH_DRAW_PANEL, GERBVIEW_DRAW_PANEL_GAL, and PL_DRAW_PANEL_GAL.

Definition at line 355 of file draw_panel_gal.cpp.

356 {
357  // Do not do anything if the currently used GAL is correct
358  if( aGalType == m_backend && m_gal != NULL )
359  return true;
360 
361  VECTOR2D grid_size = m_gal ? m_gal->GetGridSize() : VECTOR2D();
362  bool grid_visibility = m_gal ? m_gal->GetGridVisibility() : true;
363  bool result = true; // assume everything will be fine
364 
365  // Prevent refreshing canvas during backend switch
366  StopDrawing();
367 
368  KIGFX::GAL* new_gal = NULL;
369 
370  try
371  {
372  switch( aGalType )
373  {
374  case GAL_TYPE_OPENGL:
375  {
376  wxString errormsg = KIGFX::OPENGL_GAL::CheckFeatures( m_options );
377 
378  if( errormsg.empty() )
379  {
380  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
381  }
382  else
383  {
384  aGalType = GAL_TYPE_CAIRO;
386  _( "Could not use OpenGL, falling back to software rendering" ), errormsg );
387  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
388  }
389  break;
390  }
391 
392  case GAL_TYPE_CAIRO:
393  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
394  break;
395 
396  default:
397  wxASSERT( false );
399  // warn about unhandled GAL canvas type, but continue with the fallback option
400 
401  case GAL_TYPE_NONE:
402  // KIGFX::GAL is a stub - it actually does cannot display anything,
403  // but prevents code relying on GAL canvas existence from crashing
404  new_gal = new KIGFX::GAL( m_options );
405  break;
406  }
407  }
408  catch( std::runtime_error& err )
409  {
410  // Create a dummy GAL
411  new_gal = new KIGFX::GAL( m_options );
412  aGalType = GAL_TYPE_NONE;
413  DisplayError( m_parent, wxString( err.what() ) );
414  result = false;
415  }
416 
417  // trigger update of the gal options in case they differ
418  // from the defaults
420 
421  wxWindow* galWindow = dynamic_cast<wxWindow*>( new_gal );
422 
423  if( galWindow )
424  galWindow->Connect( wxEVT_SET_CURSOR, wxSetCursorEventHandler( EDA_DRAW_PANEL_GAL::onSetCursor ), NULL, this );
425 
426  delete m_gal;
427  m_gal = new_gal;
428 
429  wxSize clientSize = GetClientSize();
430  clientSize.x = std::max( 10, clientSize.x );
431  clientSize.y = std::max( 10, clientSize.y );
432  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
433 
434  if( grid_size.x > 0 && grid_size.y > 0 )
435  m_gal->SetGridSize( grid_size );
436 
437  m_gal->SetGridVisibility( grid_visibility );
438 
439  if( m_painter )
440  m_painter->SetGAL( m_gal );
441 
442  if( m_view )
443  {
444  m_view->SetGAL( m_gal );
445  // Note: OpenGL requires reverse draw order when draw priority is enabled
446  m_view->ReverseDrawOrder( aGalType == GAL_TYPE_OPENGL );
447  }
448 
449  m_backend = aGalType;
450 
451  return result;
452 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
#define KI_FALLTHROUGH
void ReverseDrawOrder(bool aFlag)
Function ReverseDrawOrder() Only takes effect if UseDrawPriority is true.
Definition: view.h:675
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.
#define NULL
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
GAL not used (the legacy wxDC engine is used)
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
void onSetCursor(wxSetCursorEvent &event)
virtual void ResizeScreen(int aWidth, int aHeight)
Resizes the canvas.
void SetGridSize(const VECTOR2D &aGridSize)
Set the grid size.
const VECTOR2D & GetGridSize() const
Returns the grid size.
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.
#define _(s)
Definition: 3d_actions.cpp:33
void SetGridVisibility(bool aVisibility)
Sets the visibility setting of the grid.
bool GetGridVisibility() const
void SetGAL(GAL *aGal)
Function SetGAL() Assigns a rendering device for the VIEW.
Definition: view.cpp:519
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:267
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.

References _, KIGFX::OPENGL_GAL::CheckFeatures(), DisplayError(), DisplayInfoMessage(), GAL_TYPE_CAIRO, GAL_TYPE_NONE, GAL_TYPE_OPENGL, KIGFX::GAL::GetGridSize(), KIGFX::GAL::GetGridVisibility(), KI_FALLTHROUGH, m_backend, m_gal, m_options, m_painter, m_parent, m_view, KIGFX::GAL_DISPLAY_OPTIONS::NotifyChanged(), NULL, onSetCursor(), KIGFX::GAL::ResizeScreen(), KIGFX::VIEW::ReverseDrawOrder(), KIGFX::VIEW::SetGAL(), KIGFX::GAL::SetGridSize(), KIGFX::GAL::SetGridVisibility(), StopDrawing(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDA_DRAW_PANEL_GAL(), onPaint(), PL_DRAW_PANEL_GAL::SwitchBackend(), SCH_DRAW_PANEL::SwitchBackend(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), PCB_DRAW_PANEL_GAL::SwitchBackend(), and EDA_DRAW_FRAME::SwitchCanvas().

Member Data Documentation

◆ m_backend

◆ m_currentCursor

wxCursor EDA_DRAW_PANEL_GAL::m_currentCursor
protected

Current mouse cursor shape id.

Definition at line 214 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), onSetCursor(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), and SetCurrentCursor().

◆ m_drawing

bool EDA_DRAW_PANEL_GAL::m_drawing
protected

True if GAL is currently redrawing the view.

Definition at line 224 of file class_draw_panel_gal.h.

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

◆ m_drawingEnabled

bool EDA_DRAW_PANEL_GAL::m_drawingEnabled
protected

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

Definition at line 227 of file class_draw_panel_gal.h.

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

◆ m_edaFrame

EDA_DRAW_FRAME* EDA_DRAW_PANEL_GAL::m_edaFrame
protected

Parent EDA_DRAW_FRAME (if available)

Definition at line 217 of file class_draw_panel_gal.h.

Referenced by PL_DRAW_PANEL_GAL::DisplayWorksheet(), EDA_DRAW_PANEL_GAL(), and GetParentEDAFrame().

◆ m_eventDispatcher

TOOL_DISPATCHER* EDA_DRAW_PANEL_GAL::m_eventDispatcher
protected

Processes and forwards events to tools.

Definition at line 249 of file class_draw_panel_gal.h.

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

◆ m_gal

◆ m_lastRefresh

wxLongLong EDA_DRAW_PANEL_GAL::m_lastRefresh
protected

Last timestamp when the panel was refreshed.

Definition at line 219 of file class_draw_panel_gal.h.

Referenced by onPaint(), and Refresh().

◆ m_lostFocus

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 253 of file class_draw_panel_gal.h.

Referenced by OnEvent(), onLostFocus(), and SetFocus().

◆ m_onShowTimer

wxTimer EDA_DRAW_PANEL_GAL::m_onShowTimer
protected

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

Definition at line 230 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), and onShowTimer().

◆ m_options

KIGFX::GAL_DISPLAY_OPTIONS& EDA_DRAW_PANEL_GAL::m_options
protected

Definition at line 246 of file class_draw_panel_gal.h.

Referenced by SwitchBackend().

◆ m_painter

std::unique_ptr<KIGFX::PAINTER> EDA_DRAW_PANEL_GAL::m_painter
protected

◆ m_parent

wxWindow* EDA_DRAW_PANEL_GAL::m_parent
protected

Pointer to the parent window.

Definition at line 216 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), onPaint(), SetEventDispatcher(), and SwitchBackend().

◆ m_pendingRefresh

bool EDA_DRAW_PANEL_GAL::m_pendingRefresh
protected

Is there a redraw event requested?

Definition at line 220 of file class_draw_panel_gal.h.

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

◆ m_refreshTimer

wxTimer EDA_DRAW_PANEL_GAL::m_refreshTimer
protected

Timer to prevent too-frequent refreshing.

Definition at line 221 of file class_draw_panel_gal.h.

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

◆ m_stealsFocus

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 257 of file class_draw_panel_gal.h.

Referenced by onEnter(), OnEvent(), and SetStealsFocus().

◆ m_view

KIGFX::VIEW* EDA_DRAW_PANEL_GAL::m_view
protected

Stores view settings (scale, center, etc.) and items to be drawn.

Definition at line 236 of file class_draw_panel_gal.h.

Referenced by PCB_DRAW_PANEL_GAL::DisplayBoard(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), GERBVIEW_DRAW_PANEL_GAL::GetDefaultViewBBox(), PCB_DRAW_PANEL_GAL::GetDefaultViewBBox(), SCH_DRAW_PANEL::GetView(), GetView(), PCB_DRAW_PANEL_GAL::GetView(), onPaint(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), SCH_DRAW_PANEL::OnShow(), PCB_DRAW_PANEL_GAL::OnShow(), onSize(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), PL_DRAW_PANEL_GAL::setDefaultLayerDeps(), SCH_DRAW_PANEL::setDefaultLayerDeps(), SCH_PREVIEW_PANEL::setDefaultLayerDeps(), GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), SCH_DRAW_PANEL::setDefaultLayerOrder(), SCH_PREVIEW_PANEL::setDefaultLayerOrder(), PCB_DRAW_PANEL_GAL::setDefaultLayerOrder(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), SetHighContrastLayer(), PL_DRAW_PANEL_GAL::SetTopLayer(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), SetTopLayer(), PCB_DRAW_PANEL_GAL::SetWorksheet(), GERBVIEW_DRAW_PANEL_GAL::SetWorksheet(), PL_DRAW_PANEL_GAL::SwitchBackend(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), SwitchBackend(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), PCB_DRAW_PANEL_GAL::UpdateColors(), SCH_PREVIEW_PANEL::view(), and ~EDA_DRAW_PANEL_GAL().

◆ m_viewControls

◆ MinRefreshPeriod

const int EDA_DRAW_PANEL_GAL::MinRefreshPeriod = 17
staticprotected

60 FPS.

Definition at line 212 of file class_draw_panel_gal.h.

Referenced by Refresh().


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