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 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)
 
 ~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...
 
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_UNITS_T aUnits, 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...
 
virtual void SetDefaultCursor ()
 
virtual void SetCurrentCursor (int aCursor)
 Function SetCurrentCursor Set the current cursor shape for this panel. More...
 
virtual int GetDefaultCursor () const
 Function GetDefaultCursor. More...
 
int GetCurrentCursor () const
 Function GetCurrentCursor. More...
 
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)
 

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

60  {
61  GAL_TYPE_UNKNOWN = -1,
62  GAL_TYPE_NONE = 0,
66  };
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 
)

Definition at line 48 of file draw_panel_gal.cpp.

50  :
51  wxScrolledCanvas( aParentWindow, aWindowId, aPosition, aSize ),
52  m_options( aOptions )
53 {
54  m_parent = aParentWindow;
55  m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( aParentWindow );
56  m_gal = NULL;
58  m_view = NULL;
59  m_painter = NULL;
60  m_eventDispatcher = NULL;
61  m_lostFocus = false;
62  m_stealsFocus = true;
63 
64 #ifdef __WXMAC__
65  m_defaultCursor = m_currentCursor = wxCURSOR_CROSS;
66 #else
67  m_defaultCursor = m_currentCursor = wxCURSOR_ARROW;
68 #endif
69 
70  SetLayoutDirection( wxLayout_LeftToRight );
71 
72  SwitchBackend( aGalType );
73  SetBackgroundStyle( wxBG_STYLE_CUSTOM );
74 
75  ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
76  EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
77 
78  Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), NULL, this );
79  Connect( wxEVT_ENTER_WINDOW, wxEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), NULL, this );
80  Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), NULL, this );
81 
82  const wxEventType events[] =
83  {
84  // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
85  // especially special key like arrow keys, are handled by the GAL event dispatcher,
86  // and not sent to GUI without filtering, because they have a default action (scroll)
87  // that must not be called.
88  wxEVT_LEFT_UP, wxEVT_LEFT_DOWN, wxEVT_LEFT_DCLICK,
89  wxEVT_RIGHT_UP, wxEVT_RIGHT_DOWN, wxEVT_RIGHT_DCLICK,
90  wxEVT_MIDDLE_UP, wxEVT_MIDDLE_DOWN, wxEVT_MIDDLE_DCLICK,
91  wxEVT_MOTION, wxEVT_MOUSEWHEEL, wxEVT_CHAR, wxEVT_CHAR_HOOK,
92 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
93  wxEVT_MAGNIFY,
94 #endif
96  };
97 
98  for( wxEventType eventType : events )
99  {
100  Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::OnEvent ),
101  NULL, m_eventDispatcher );
102  }
103 
104  m_pendingRefresh = false;
105  m_drawing = false;
106  m_drawingEnabled = false;
107 
108  // Set up timer that prevents too frequent redraw commands
109  m_refreshTimer.SetOwner( this );
110  Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
111  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), NULL, this );
112 
113  // Set up timer to execute OnShow() method when the window appears on the screen
114  m_onShowTimer.SetOwner( this );
115  Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
116  wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), NULL, this );
117  m_onShowTimer.Start( 10 );
118 }
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.
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)
int m_currentCursor
Current mouse cursor shape id.
void onShowTimer(wxTimerEvent &aEvent)
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.
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.
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)
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, 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, onEnter(), OnEvent(), onLostFocus(), onRefreshTimer(), onShowTimer(), onSize(), and SwitchBackend().

◆ ~EDA_DRAW_PANEL_GAL()

EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL ( )

Definition at line 121 of file draw_panel_gal.cpp.

122 {
123  StopDrawing();
124 
125  wxASSERT( !m_drawing );
126 
127  delete m_viewControls;
128  delete m_view;
129  delete m_gal;
130 }
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()

GAL_TYPE EDA_DRAW_PANEL_GAL::GetBackend ( ) const
inline

◆ GetCurrentCursor()

int EDA_DRAW_PANEL_GAL::GetCurrentCursor ( ) const
inline

Function GetCurrentCursor.

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

Definition at line 225 of file class_draw_panel_gal.h.

225 { return m_currentCursor; }
int m_currentCursor
Current mouse cursor shape id.

References m_currentCursor.

◆ GetDefaultCursor()

virtual int EDA_DRAW_PANEL_GAL::GetDefaultCursor ( ) const
inlinevirtual

Function GetDefaultCursor.

Returns
the default cursor shape

Definition at line 219 of file class_draw_panel_gal.h.

219 { return m_defaultCursor; }
int m_defaultCursor
The default mouse cursor shape id.

References m_defaultCursor.

Referenced by EDA_DRAW_FRAME::SetNoToolSelected().

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

234  {
235  return BOX2I();
236  }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:520

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

◆ GetGAL()

◆ GetLegacyZoom()

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

357 {
359 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
double GetZoomLevelCoeff() const
Return the coefficient to convert internal display scale factor to zoom level.
Definition: draw_frame.h:475
double GetZoomFactor() const
Get the zoom factor.
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)

References KIGFX::GAL::GetZoomFactor(), EDA_DRAW_FRAME::GetZoomLevelCoeff(), m_edaFrame, and m_gal.

Referenced by COMMON_TOOLS::doZoomInOut(), onPaint(), GERBVIEW_FRAME::OnUpdateSelectZoom(), and PCB_BASE_FRAME::OnUpdateSelectZoom().

◆ GetMsgPanelInfo()

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

Reimplemented in PCB_DRAW_PANEL_GAL, and GERBVIEW_DRAW_PANEL_GAL.

Definition at line 164 of file class_draw_panel_gal.h.

165  {
166  wxASSERT( false );
167  }

Referenced by PCB_BASE_FRAME::UpdateMsgPanel().

◆ GetParentEDAFrame()

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

180  {
181  return m_edaFrame;
182  }
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)

References m_edaFrame.

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

◆ GetStealsFocus()

bool EDA_DRAW_PANEL_GAL::GetStealsFocus ( ) const
inline

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

Definition at line 203 of file class_draw_panel_gal.h.

204  {
205  return m_stealsFocus;
206  }
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...

References m_stealsFocus.

◆ GetView()

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

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

References m_view.

Referenced by FOOTPRINT_VIEWER_FRAME::ApplyDisplaySettingsToGAL(), DISPLAY_FOOTPRINTS_FRAME::ApplyDisplaySettingsToGAL(), GERBVIEW_FRAME::applyDisplaySettingsToGAL(), GRID_HELPER::BestSnapAnchor(), DIALOG_PRINT_PCBNEW::createPrintout(), DIALOG_PRINT_GERBVIEW::createPrintout(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), COMMON_TOOLS::doZoomToPreset(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Edit_Zone_Params(), EVT_GRID_CMD_CELL_CHANGED(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), EDA_DRAW_FRAME::FocusOnLocation(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_BASE_FRAME::GetCollectorsGuide(), SCH_BASE_FRAME::GetRenderSettings(), GRID_HELPER::GRID_HELPER(), SCH_BASE_FRAME::HardRedraw(), GERBVIEW_CONTROL::HighlightControl(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), FOOTPRINT_PREVIEW_PANEL::New(), DIALOG_PAD_PROPERTIES::onChangePadMode(), GERBVIEW_FRAME::OnCloseWindow(), PCB_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnLayerVisible(), onPaint(), PCB_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectHighlightChoice(), PCB_EDIT_FRAME::OnSelectOptionToolbar(), PCB_BASE_FRAME::OnToggleEdgeDrawMode(), PCB_BASE_FRAME::OnTogglePadDrawMode(), PCB_BASE_FRAME::OnToggleTextDrawMode(), DIALOG_PAD_PROPERTIES::prepareCanvas(), processBoardItem(), GRID_HELPER::queryVisible(), GERBVIEW_FRAME::Read_EXCELLON_File(), PCB_EDIT_FRAME::ReCreateMenuBar(), DIALOG_PAD_PROPERTIES::redraw(), refreshCallback(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), GRID_HELPER::SetAuxAxes(), PCB_BASE_EDIT_FRAME::SetBoard(), GERBVIEW_FRAME::SetElementVisibility(), FOOTPRINT_EDIT_FRAME::SetElementVisibility(), FOOTPRINT_EDIT_FRAME::setupTools(), GERBVIEW_FRAME::SortLayersByX2Attributes(), PCB_EDIT_FRAME::Swap_Layers(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), SCH_BASE_FRAME::SyncView(), PANEL_PCBNEW_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_MODEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_LIBEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_PCBNEW_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), GERBVIEW_FRAME::UpdateDisplayOptions(), PCB_BASE_FRAME::UseGalCanvas(), GERBVIEW_FRAME::UseGalCanvas(), EDA_DRAW_FRAME::UseGalCanvas(), CVPCB_CONTROL::view(), SCH_BASE_FRAME::Window_Zoom(), SCH_BASE_FRAME::Zoom_Automatique(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), and SYMBOL_PREVIEW_WIDGET::~SYMBOL_PREVIEW_WIDGET().

◆ GetViewControls()

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

117  {
119  }
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 (...

References m_viewControls.

Referenced by SCH_BASE_FRAME::CenterScreen(), EVT_GRID_CMD_CELL_CHANGED(), EDA_DRAW_FRAME::FocusOnLocation(), LIB_EDIT_FRAME::GeneralControl(), EDA_DRAW_FRAME::GetCrossHairPosition(), DIALOG_PAD_PROPERTIES::prepareCanvas(), SCH_BASE_FRAME::RedrawScreen(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetCrossHairPosition(), FOOTPRINT_EDIT_FRAME::setupTools(), and EDA_DRAW_FRAME::UseGalCanvas().

◆ onEnter()

void EDA_DRAW_PANEL_GAL::onEnter ( wxEvent &  aEvent)
protected

Definition at line 461 of file draw_panel_gal.cpp.

462 {
463  // Getting focus is necessary in order to receive key events properly
464  if( m_stealsFocus )
465  SetFocus();
466 
467  aEvent.Skip();
468 }
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 447 of file draw_panel_gal.cpp.

448 {
449  if( m_lostFocus && m_stealsFocus )
450  SetFocus();
451 
452  if( !m_eventDispatcher )
453  aEvent.Skip();
454  else
456 
457  Refresh();
458 }
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 471 of file draw_panel_gal.cpp.

472 {
473  m_lostFocus = true;
474 
475  aEvent.Skip();
476 }
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_DRAW_PANEL, and SCH_PREVIEW_PANEL.

Definition at line 149 of file draw_panel_gal.cpp.

150 {
152 
153  // Update current zoom settings if the canvas is managed by a EDA frame
154  // (i.e. not by a preview panel in a dialog)
155  if( GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
156  {
158 
159  VECTOR2D center = GetView()->GetCenter();
160  GetParentEDAFrame()->SetScrollCenterPosition( wxPoint( center.x, center.y ) );
161  }
162 
163  if( !m_gal->IsVisible() )
164  return;
165 
166  m_pendingRefresh = false;
167 
168  if( m_drawing )
169  return;
170 
171 #ifdef __WXDEBUG__
172  PROF_COUNTER totalRealTime;
173 #endif /* PROFILE */
174 
175  wxASSERT( m_painter );
176 
177  m_drawing = true;
178  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
179 
180  try
181  {
182  m_view->UpdateItems();
183 
185 
186  m_gal->SetClearColor( settings->GetBackgroundColor() );
187  m_gal->SetGridColor( settings->GetGridColor() );
188  m_gal->SetCursorColor( settings->GetCursorColor() );
189 
190  // TODO: find why ClearScreen() must be called here in opengl mode
191  // and only if m_view->IsDirty() in Cairo mode to avoid distaly artifacts
192  // when moving the mouse cursor
193  if( m_backend == GAL_TYPE_OPENGL )
194  m_gal->ClearScreen();
195 
196  if( m_view->IsDirty() )
197  {
198  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
200  m_gal->ClearScreen();
201 
202  m_view->ClearTargets();
203 
204  // Grid has to be redrawn only when the NONCACHED target is redrawn
206  m_gal->DrawGrid();
207 
208  m_view->Redraw();
209  }
210 
212  }
213  catch( std::runtime_error& err )
214  {
215  constexpr auto GAL_FALLBACK = GAL_TYPE_CAIRO;
216 
217  if( m_edaFrame )
218  {
219  bool use_gal = m_edaFrame->SwitchCanvas( GAL_FALLBACK );
220  m_edaFrame->UseGalCanvas( use_gal );
221  }
222  else
223  {
224  SwitchBackend( GAL_FALLBACK );
225  }
226 
228  _( "Could not use OpenGL, falling back to software rendering" ),
229  wxString( err.what() ) );
230  }
231 
232 #ifdef __WXDEBUG__
233  totalRealTime.Stop();
234  wxLogTrace( "GAL_PROFILE", "EDA_DRAW_PANEL_GAL::onPaint(): %.1f ms", totalRealTime.msecs() );
235 #endif /* PROFILE */
236 
237  m_lastRefresh = wxGetLocalTimeMillis();
238  m_drawing = false;
239 }
void Stop()
save the time when this function was called, and set the counter stane to stop
Definition: profile.h:83
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.
Class RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output ...
Definition: painter.h:56
virtual const COLOR4D & GetCursorColor()=0
Function GetCursorColor Returns current cursor color settings.
virtual const COLOR4D & GetBackgroundColor()=0
Function GetBackgroundColor Returns current background color settings.
const VECTOR2D & GetCenter() const
Function GetCenter() Returns the center point of this VIEW (in world space coordinates)
Definition: view.h:339
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
void SetScrollCenterPosition(const wxPoint &aPoint)
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:45
virtual void UseGalCanvas(bool aEnable)
Use to switch between standard and GAL-based canvas.
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:1144
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:585
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
double GetLegacyZoom() const
Function GetLegacyZoom() Returns current view scale converted to zoom value used by the legacy canvas...
virtual void DrawGrid()
virtual void DrawCursor(const VECTOR2D &aCursorPosition)
Draw the cursor.
virtual bool SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Changes the current rendering backend.
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1420
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
string & err
Definition: json11.cpp:598
virtual void ClearScreen()
Clear the screen.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
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:1125
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
double msecs() const
Definition: profile.h:144
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:276
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: draw_frame.h:408
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:568

References KIGFX::GAL::ClearScreen(), KIGFX::VIEW::ClearTargets(), DisplayInfoMessage(), KIGFX::GAL::DrawCursor(), KIGFX::GAL::DrawGrid(), err, 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(), GetLegacyZoom(), GetParentEDAFrame(), EDA_DRAW_FRAME::GetScreen(), GetView(), KIGFX::VIEW::IsDirty(), KIGFX::VIEW::IsTargetDirty(), KIGFX::GAL::IsVisible(), m_backend, 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(), KIGFX::GAL::SetGridColor(), EDA_DRAW_FRAME::SetScrollCenterPosition(), BASE_SCREEN::SetZoom(), PROF_COUNTER::Stop(), SwitchBackend(), EDA_DRAW_FRAME::SwitchCanvas(), KIGFX::TARGET_NONCACHED, KIGFX::VIEW::UpdateItems(), KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars(), EDA_DRAW_FRAME::UseGalCanvas(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

480 {
481  if( !m_drawingEnabled )
482  {
483  if( m_gal && m_gal->IsInitialized() )
484  {
485  m_drawing = false;
486  m_pendingRefresh = true;
487  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
488  m_drawingEnabled = true;
489  }
490  else
491  {
492  // Try again soon
493  m_refreshTimer.StartOnce( 100 );
494  return;
495  }
496  }
497 
498  wxPaintEvent redrawEvent;
499  wxPostEvent( this, redrawEvent );
500 }
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.
bool m_drawing
True if GAL is currently redrawing the view.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
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, and onPaint().

Referenced by EDA_DRAW_PANEL_GAL().

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

Definition at line 188 of file class_draw_panel_gal.h.

188 {}

Referenced by onShowTimer().

◆ onShowTimer()

void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protected

Definition at line 503 of file draw_panel_gal.cpp.

504 {
505  if( m_gal && m_gal->IsVisible() )
506  {
507  m_onShowTimer.Stop();
508  OnShow();
509  }
510 }
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 242 of file draw_panel_gal.cpp.

243 {
245  wxSize clientSize = GetClientSize();
246  m_gal->ResizeScreen( clientSize.x, clientSize.y );
247 
248  if( m_view )
249  {
252  }
253 }
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:596
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_DRAW_PANEL, and SCH_PREVIEW_PANEL.

Definition at line 256 of file draw_panel_gal.cpp.

257 {
258  if( m_pendingRefresh )
259  return;
260 
261  m_pendingRefresh = true;
262 
263 #ifdef __WXMAC__
264  // Timers on OS X may have a high latency (seen up to 500ms and more) which
265  // makes repaints jerky. No negative impact seen without throttling, so just
266  // do an unconditional refresh for OS X.
267  ForceRefresh();
268 #else
269  wxLongLong t = wxGetLocalTimeMillis();
270  wxLongLong delta = t - m_lastRefresh;
271 
272  if( delta >= MinRefreshPeriod )
273  {
274  ForceRefresh();
275  }
276  else
277  {
278  // One shot timer
279  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
280  }
281 #endif
282 }
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.

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

Referenced by FOOTPRINT_VIEWER_FRAME::ApplyDisplaySettingsToGAL(), DISPLAY_FOOTPRINTS_FRAME::ApplyDisplaySettingsToGAL(), SCH_BASE_FRAME::CenterScreen(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCBNEW_CONTROL::GraphicDisplayMode(), GERBVIEW_CONTROL::HighlightControl(), GERBVIEW_FRAME::loadListOfGerberAndDrillFiles(), PCBNEW_CONTROL::ModuleEdgeOutlines(), PCBNEW_CONTROL::ModuleTextOutlines(), OnEvent(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectHighlightChoice(), PCBNEW_CONTROL::PadDisplayMode(), PCBNEW_CONTROL::RatsnestLineMode(), PCB_EDITOR_CONTROL::ratsnestTimer(), DIALOG_PAD_PROPERTIES::redraw(), SCH_BASE_FRAME::RedrawScreen2(), SCH_PREVIEW_PANEL::Refresh(), SCH_DRAW_PANEL::Refresh(), refreshCallback(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), GERBVIEW_FRAME::SetActiveLayer(), COMMON_TOOLS::ToggleGrid(), PCBNEW_CONTROL::TrackDisplayMode(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), PCBNEW_CONTROL::ViaDisplayMode(), SCH_BASE_FRAME::Window_Zoom(), PCBNEW_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillAll(), ZONE_FILLER_TOOL::ZoneUnfill(), ZONE_FILLER_TOOL::ZoneUnfillAll(), and SCH_BASE_FRAME::Zoom_Automatique().

◆ SetCurrentCursor()

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( int  aCursor)
virtual

Function SetCurrentCursor Set the current cursor shape for this panel.

Definition at line 511 of file draw_panel_gal.cpp.

512 {
513  if ( aCursor > wxCURSOR_NONE && aCursor < wxCURSOR_MAX )
514  {
515  m_currentCursor = aCursor;
516  }
517  else
518  {
519  m_currentCursor = wxCURSOR_ARROW;
520  }
521 
522  SetCursor( (wxStockCursor) m_currentCursor );
523 }
int m_currentCursor
Current mouse cursor shape id.

References m_currentCursor.

Referenced by SetDefaultCursor(), and EDA_DRAW_FRAME::SetToolID().

◆ SetDefaultCursor()

void EDA_DRAW_PANEL_GAL::SetDefaultCursor ( )
virtual

Definition at line 525 of file draw_panel_gal.cpp.

526 {
528 }
int m_defaultCursor
The default mouse cursor shape id.
virtual void SetCurrentCursor(int aCursor)
Function SetCurrentCursor Set the current cursor shape for this panel.

References m_defaultCursor, and SetCurrentCursor().

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

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

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

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

◆ SetFocus()

void EDA_DRAW_PANEL_GAL::SetFocus ( )
overridevirtual

Definition at line 133 of file draw_panel_gal.cpp.

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

References m_lostFocus.

Referenced by onEnter(), OnEvent(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), and GERBVIEW_FRAME::SetActiveLayer().

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

335 {
336  // Set display settings for high contrast mode
338 
339  SetTopLayer( aLayer );
340 
341  rSettings->ClearActiveLayers();
342  rSettings->SetActiveLayer( aLayer );
343 
345 }
Class RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output ...
Definition: painter.h:56
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...
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.
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:797

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().

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

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

References m_stealsFocus.

Referenced by FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), DIALOG_PAD_PROPERTIES::prepareCanvas(), 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, and GERBVIEW_DRAW_PANEL_GAL.

Definition at line 348 of file draw_panel_gal.cpp.

349 {
351  m_view->SetTopLayer( aLayer );
353 }
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:859
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers.
Definition: view.cpp:926
void ClearTopLayers()
Function ClearTopLayers() Removes all layers from the on-the-top set (they are no longer displayed ov...
Definition: view.cpp:911
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 318 of file draw_panel_gal.cpp.

319 {
320  // Start querying GAL if it is ready
321  m_refreshTimer.StartOnce( 100 );
322 }
wxTimer m_refreshTimer
Timer responsible for preventing too frequent refresh.

References m_refreshTimer.

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

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

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

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

Referenced by DIALOG_PAD_PROPERTIES::OnCancel(), LIB_VIEW_FRAME::OnCloseWindow(), FOOTPRINT_EDIT_FRAME::OnCloseWindow(), FOOTPRINT_VIEWER_FRAME::OnCloseWindow(), GERBVIEW_FRAME::OnCloseWindow(), DIALOG_PAD_PROPERTIES::redraw(), SwitchBackend(), GERBVIEW_FRAME::UseGalCanvas(), 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, GERBVIEW_DRAW_PANEL_GAL, and SCH_DRAW_PANEL.

Definition at line 362 of file draw_panel_gal.cpp.

363 {
364  // Do not do anything if the currently used GAL is correct
365  if( aGalType == m_backend && m_gal != NULL )
366  return true;
367 
368  bool result = true; // assume everything will be fine
369 
370  // Prevent refreshing canvas during backend switch
371  StopDrawing();
372 
373  KIGFX::GAL* new_gal = NULL;
374 
375  try
376  {
377  switch( aGalType )
378  {
379  case GAL_TYPE_OPENGL:
380  try
381  {
382  new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
383  break;
384  }
385  catch( std::runtime_error& err )
386  {
387  aGalType = GAL_TYPE_CAIRO;
389  _( "Could not use OpenGL, falling back to software rendering" ),
390  wxString( err.what() ) );
391  }
392 
393  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
394  break;
395 
396  case GAL_TYPE_CAIRO:
397  new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
398  break;
399 
400  default:
401  wxASSERT( false );
402  // warn about unhandled GAL canvas type, but continue with the fallback option
403 
404  case GAL_TYPE_NONE:
405  // KIGFX::GAL is a stub - it actually does cannot display anything,
406  // but prevents code relying on GAL canvas existence from crashing
407  new_gal = new KIGFX::GAL( m_options );
408  break;
409  }
410  }
411  catch( std::runtime_error& err )
412  {
413  // Create a dummy GAL
414  new_gal = new KIGFX::GAL( m_options );
415  aGalType = GAL_TYPE_NONE;
416  DisplayError( m_parent, wxString( err.what() ) );
417  result = false;
418  }
419 
420  // trigger update of the gal options in case they differ
421  // from the defaults
423 
424  wxASSERT( new_gal );
425  delete m_gal;
426  m_gal = new_gal;
427 
428  wxSize size = GetClientSize();
429  m_gal->ResizeScreen( size.GetX(), size.GetY() );
430 
431  if( m_painter )
432  m_painter->SetGAL( m_gal );
433 
434  if( m_view )
435  {
436  m_view->SetGAL( m_gal );
437  // Note: OpenGL requires reverse draw order when draw priority is enabled
438  m_view->ReverseDrawOrder( aGalType == GAL_TYPE_OPENGL );
439  }
440 
441  m_backend = aGalType;
442 
443  return result;
444 }
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:686
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.
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.
string & err
Definition: json11.cpp:598
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() Assigns a rendering device for the VIEW.
Definition: view.cpp:519
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:276
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:244
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 DisplayError(), DisplayInfoMessage(), err, 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(), and StopDrawing().

Referenced by EDA_DRAW_PANEL_GAL(), onPaint(), SCH_BASE_FRAME::OnSwitchCanvas(), SCH_DRAW_PANEL::SwitchBackend(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), and PCB_DRAW_PANEL_GAL::SwitchBackend().

Member Data Documentation

◆ m_backend

GAL_TYPE EDA_DRAW_PANEL_GAL::m_backend
protected

◆ m_currentCursor

int EDA_DRAW_PANEL_GAL::m_currentCursor
protected

Current mouse cursor shape id.

Definition at line 254 of file class_draw_panel_gal.h.

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

◆ m_defaultCursor

int EDA_DRAW_PANEL_GAL::m_defaultCursor
protected

The default mouse cursor shape id.

Definition at line 256 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), GetDefaultCursor(), and SetDefaultCursor().

◆ m_drawing

bool EDA_DRAW_PANEL_GAL::m_drawing
protected

True if GAL is currently redrawing the view.

Definition at line 271 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 274 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 262 of file class_draw_panel_gal.h.

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

◆ m_eventDispatcher

TOOL_DISPATCHER* EDA_DRAW_PANEL_GAL::m_eventDispatcher
protected

Processes and forwards events to tools.

Definition at line 299 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 265 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 303 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), 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 280 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 296 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 259 of file class_draw_panel_gal.h.

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

◆ m_pendingRefresh

bool EDA_DRAW_PANEL_GAL::m_pendingRefresh
protected

Is there a redraw event requested?

Definition at line 268 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 responsible for preventing too frequent refresh.

Definition at line 277 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 307 of file class_draw_panel_gal.h.

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

◆ m_view

◆ m_viewControls

KIGFX::WX_VIEW_CONTROLS* EDA_DRAW_PANEL_GAL::m_viewControls
protected

◆ MinRefreshPeriod

const int EDA_DRAW_PANEL_GAL::MinRefreshPeriod = 17
staticprotected

60 FPS.

Definition at line 251 of file class_draw_panel_gal.h.

Referenced by Refresh().


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