KiCad PCB EDA Suite
GERBVIEW_DRAW_PANEL_GAL Class Reference

#include <gerbview_draw_panel_gal.h>

Inheritance diagram for GERBVIEW_DRAW_PANEL_GAL:
EDA_DRAW_PANEL_GAL

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

 GERBVIEW_DRAW_PANEL_GAL (wxWindow *aParentWindow, wxWindowID aWindowId, const wxPoint &aPosition, const wxSize &aSize, KIGFX::GAL_DISPLAY_OPTIONS &aOptions, GAL_TYPE aGalType=GAL_TYPE_OPENGL)
 
virtual ~GERBVIEW_DRAW_PANEL_GAL ()
 
void UseColorScheme (const COLORS_DESIGN_SETTINGS *aSettings)
 Function UseColorScheme Applies layer color settings. More...
 
virtual void SetHighContrastLayer (int aLayer) override
 > More...
 
void GetMsgPanelInfo (EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
 > More...
 
void OnShow () override
 > More...
 
bool SwitchBackend (GAL_TYPE aGalType) override
 Function SwitchBackend Switches method of rendering graphics. More...
 
virtual void SetTopLayer (int aLayer) override
 > More...
 
BOX2I GetDefaultViewBBox () const override
 > More...
 
void SetWorksheet (KIGFX::WORKSHEET_VIEWITEM *aWorksheet)
 Sets (or updates) worksheet used by the draw panel. More...
 
virtual void SetFocus () override
 
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...
 
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...
 
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...
 
void OnEvent (wxEvent &aEvent)
 Used to forward events to the canvas from popups, etc. More...
 

Protected Member Functions

void setDefaultLayerDeps ()
 

Sets rendering targets & dependencies for layers.

More...
 
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

std::unique_ptr< KIGFX::WORKSHEET_VIEWITEMm_worksheet
 

Currently used worksheet

More...
 
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 34 of file gerbview_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

◆ GERBVIEW_DRAW_PANEL_GAL()

GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_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 38 of file gerbview_draw_panel_gal.cpp.

References EDA_DRAW_FRAME::GetDisplayOptions(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::VIEW::GetPainter(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), KIGFX::PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_painter, EDA_DRAW_PANEL_GAL::m_view, EDA_DRAW_PANEL_GAL::m_viewControls, setDefaultLayerDeps(), KIGFX::VIEW::SetGAL(), KIGFX::VIEW::SetPainter(), KIGFX::GAL::SetWorldUnitLength(), and UseColorScheme().

40  :
41 EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType )
42 {
43  m_view = new KIGFX::VIEW( true );
44  m_view->SetGAL( m_gal );
45  GetGAL()->SetWorldUnitLength( 1.0/IU_PER_MM /* 10 nm */ / 25.4 /* 1 inch in mm */ );
46 
47  m_painter.reset( new KIGFX::GERBVIEW_PAINTER( m_gal ) );
48  m_view->SetPainter( m_painter.get() );
49 
51 
53 
54 
55  // Load display options (such as filled/outline display of items).
56  auto frame = static_cast< GERBVIEW_FRAME* >( GetParentEDAFrame() );
57 
58  if( frame )
59  {
60  auto displ_opts = (GBR_DISPLAY_OPTIONS*) frame->GetDisplayOptions();
62  ->LoadDisplayOptions( displ_opts );
63  UseColorScheme( frame->m_colorsSettings );
64  }
65 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
Class WX_VIEW_CONTROLS is a specific implementation of class VIEW_CONTROLS for wxWidgets library...
void setDefaultLayerDeps()
Sets rendering targets & dependencies for layers.
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
Class GERBVIEW_PAINTER Contains methods for drawing GerbView-specific items.
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using 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)
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
Class GERBVIEW_RENDER_SETTINGS Stores GerbView specific render settings.
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.
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.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
void SetPainter(PAINTER *aPainter)
Function SetPainter() Sets the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:189
void UseColorScheme(const COLORS_DESIGN_SETTINGS *aSettings)
Function UseColorScheme Applies layer color settings.
Class VIEW.
Definition: view.h:61
void SetGAL(GAL *aGal)
Function SetGAL() Assigns a rendering device for the VIEW.
Definition: view.cpp:519
virtual void * GetDisplayOptions()
A way to pass info to draw functions.
Definition: draw_frame.h:947

◆ ~GERBVIEW_DRAW_PANEL_GAL()

GERBVIEW_DRAW_PANEL_GAL::~GERBVIEW_DRAW_PANEL_GAL ( )
virtual

Definition at line 68 of file gerbview_draw_panel_gal.cpp.

69 {
70 }

Member Function Documentation

◆ ForceRefresh()

◆ GetBackend()

GAL_TYPE EDA_DRAW_PANEL_GAL::GetBackend ( ) const
inlineinherited

◆ GetCurrentCursor()

int EDA_DRAW_PANEL_GAL::GetCurrentCursor ( ) const
inlineinherited

Function GetCurrentCursor.

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

Definition at line 225 of file class_draw_panel_gal.h.

References EDA_DRAW_PANEL_GAL::m_currentCursor.

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

◆ GetDefaultCursor()

virtual int EDA_DRAW_PANEL_GAL::GetDefaultCursor ( ) const
inlinevirtualinherited

Function GetDefaultCursor.

Returns
the default cursor shape

Definition at line 219 of file class_draw_panel_gal.h.

References EDA_DRAW_PANEL_GAL::m_defaultCursor.

Referenced by EDA_DRAW_FRAME::SetNoToolSelected().

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

◆ GetDefaultViewBBox()

BOX2I GERBVIEW_DRAW_PANEL_GAL::GetDefaultViewBBox ( ) const
overridevirtual

>

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 from EDA_DRAW_PANEL_GAL.

Definition at line 212 of file gerbview_draw_panel_gal.cpp.

References m_worksheet.

213 {
214  if( m_worksheet )
215  return m_worksheet->ViewBBox();
216 
217  return BOX2I();
218 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:520
std::unique_ptr< KIGFX::WORKSHEET_VIEWITEM > m_worksheet
Currently used worksheet

◆ GetGAL()

◆ GetLegacyZoom()

double EDA_DRAW_PANEL_GAL::GetLegacyZoom ( ) const
inherited

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

Definition at line 362 of file draw_panel_gal.cpp.

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

Referenced by COMMON_TOOLS::doZoomInOut(), EDA_DRAW_PANEL_GAL::onPaint(), GERBVIEW_FRAME::OnUpdateSelectZoom(), PCB_BASE_FRAME::OnUpdateSelectZoom(), EDA_DRAW_FRAME::SetNextZoomAndRedraw(), and EDA_DRAW_FRAME::SetPreviousZoomAndRedraw().

363 {
365 }
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:470
double GetZoomFactor() const
Get the zoom factor.
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)

◆ GetMsgPanelInfo()

void GERBVIEW_DRAW_PANEL_GAL::GetMsgPanelInfo ( EDA_UNITS_T  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

>

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 96 of file gerbview_draw_panel_gal.cpp.

98 {
99 
100 }

◆ GetParentEDAFrame()

EDA_DRAW_FRAME* EDA_DRAW_PANEL_GAL::GetParentEDAFrame ( ) const
inlineinherited

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

Definition at line 179 of file class_draw_panel_gal.h.

References EDA_DRAW_PANEL_GAL::m_edaFrame.

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

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

◆ GetStealsFocus()

bool EDA_DRAW_PANEL_GAL::GetStealsFocus ( ) const
inlineinherited

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

Definition at line 203 of file class_draw_panel_gal.h.

References EDA_DRAW_PANEL_GAL::m_stealsFocus.

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

◆ GetView()

KIGFX::VIEW* EDA_DRAW_PANEL_GAL::GetView ( ) const
inlineinherited

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.

References EDA_DRAW_PANEL_GAL::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(), PCB_EDIT_FRAME::Edit_Zone_Params(), EVT_GRID_CMD_CELL_CHANGED(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), 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_EDIT_FRAME::HighlightConnectionAtPosition(), 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(), EDA_DRAW_PANEL_GAL::onPaint(), PCB_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectHighlightChoice(), PCB_EDIT_FRAME::OnSelectOptionToolbar(), PCB_BASE_FRAME::OnToggleEdgeDrawMode(), EDA_DRAW_FRAME::OnToggleGridState(), PCB_BASE_FRAME::OnTogglePadDrawMode(), PCB_BASE_FRAME::OnToggleTextDrawMode(), EDA_DRAW_FRAME::OnZoom(), DIALOG_UPDATE_PCB::PerformUpdate(), LIB_EDIT_FRAME::PlaceAnchor(), DIALOG_PAD_PROPERTIES::prepareCanvas(), processBoardItem(), GRID_HELPER::queryVisible(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_PAD_PROPERTIES::redraw(), refreshCallback(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), GRID_HELPER::SetAuxAxes(), PCB_BASE_EDIT_FRAME::SetBoard(), GERBVIEW_FRAME::SetElementVisibility(), FOOTPRINT_EDIT_FRAME::SetElementVisibility(), EDA_DRAW_FRAME::SetPresetGrid(), FOOTPRINT_EDIT_FRAME::setupTools(), GERBVIEW_FRAME::SortLayersByX2Attributes(), LIB_EDIT_FRAME::StartMoveDrawSymbol(), PCB_EDIT_FRAME::Swap_Layers(), 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().

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

◆ GetViewControls()

KIGFX::VIEW_CONTROLS* EDA_DRAW_PANEL_GAL::GetViewControls ( ) const
inlineinherited

◆ onEnter()

void EDA_DRAW_PANEL_GAL::onEnter ( wxEvent &  aEvent)
protectedinherited

Definition at line 467 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_stealsFocus, and EDA_DRAW_PANEL_GAL::SetFocus().

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

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

◆ OnEvent()

void EDA_DRAW_PANEL_GAL::OnEvent ( wxEvent &  aEvent)
inherited

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

Definition at line 453 of file draw_panel_gal.cpp.

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

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

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

◆ onLostFocus()

void EDA_DRAW_PANEL_GAL::onLostFocus ( wxFocusEvent &  aEvent)
protectedinherited

Definition at line 477 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_lostFocus.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

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

◆ onPaint()

void EDA_DRAW_PANEL_GAL::onPaint ( wxPaintEvent &  WXUNUSEDaEvent)
protectedvirtualinherited

Reimplemented in SCH_DRAW_PANEL, and SCH_PREVIEW_PANEL.

Definition at line 155 of file draw_panel_gal.cpp.

References KIGFX::GAL::ClearScreen(), KIGFX::VIEW::ClearTargets(), DisplayInfoMessage(), KIGFX::GAL::DrawCursor(), KIGFX::GAL::DrawGrid(), err, EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), KIGFX::VIEW::GetCenter(), KIGFX::RENDER_SETTINGS::GetCursorColor(), KIGFX::WX_VIEW_CONTROLS::GetCursorPosition(), KIGFX::RENDER_SETTINGS::GetGridColor(), EDA_DRAW_PANEL_GAL::GetLegacyZoom(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), EDA_DRAW_FRAME::GetScreen(), EDA_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::IsDirty(), KIGFX::VIEW::IsTargetDirty(), KIGFX::GAL::IsVisible(), EDA_DRAW_PANEL_GAL::m_backend, EDA_DRAW_PANEL_GAL::m_drawing, EDA_DRAW_PANEL_GAL::m_edaFrame, EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_lastRefresh, EDA_DRAW_PANEL_GAL::m_painter, EDA_DRAW_PANEL_GAL::m_parent, EDA_DRAW_PANEL_GAL::m_pendingRefresh, EDA_DRAW_PANEL_GAL::m_view, EDA_DRAW_PANEL_GAL::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(), EDA_DRAW_PANEL_GAL::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_PREVIEW_PANEL::onPaint(), SCH_DRAW_PANEL::onPaint(), EDA_DRAW_PANEL_GAL::onRefreshTimer(), and EDA_DRAW_PANEL_GAL::StopDrawing().

156 {
158 
159  // Update current zoom settings if the canvas is managed by a EDA frame
160  // (i.e. not by a preview panel in a dialog)
161  if( GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
162  {
164 
165  VECTOR2D center = GetView()->GetCenter();
166  GetParentEDAFrame()->SetScrollCenterPosition( wxPoint( center.x, center.y ) );
167  }
168 
169  if( !m_gal->IsVisible() )
170  return;
171 
172  m_pendingRefresh = false;
173 
174  if( m_drawing )
175  return;
176 
177 #ifdef __WXDEBUG__
178  PROF_COUNTER totalRealTime;
179 #endif /* PROFILE */
180 
181  wxASSERT( m_painter );
182 
183  m_drawing = true;
184  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
185 
186  try
187  {
188  m_view->UpdateItems();
189 
191 
192  m_gal->SetClearColor( settings->GetBackgroundColor() );
193  m_gal->SetGridColor( settings->GetGridColor() );
194  m_gal->SetCursorColor( settings->GetCursorColor() );
195 
196  // TODO: find why ClearScreen() must be called here in opengl mode
197  // and only if m_view->IsDirty() in Cairo mode to avoid distaly artifacts
198  // when moving the mouse cursor
199  if( m_backend == GAL_TYPE_OPENGL )
200  m_gal->ClearScreen();
201 
202  if( m_view->IsDirty() )
203  {
204  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
206  m_gal->ClearScreen();
207 
208  m_view->ClearTargets();
209 
210  // Grid has to be redrawn only when the NONCACHED target is redrawn
212  m_gal->DrawGrid();
213 
214  m_view->Redraw();
215  }
216 
218  }
219  catch( std::runtime_error& err )
220  {
221  constexpr auto GAL_FALLBACK = GAL_TYPE_CAIRO;
222 
223  if( m_edaFrame )
224  {
225  bool use_gal = m_edaFrame->SwitchCanvas( GAL_FALLBACK );
226  m_edaFrame->UseGalCanvas( use_gal );
227  }
228  else
229  {
230  SwitchBackend( GAL_FALLBACK );
231  }
232 
234  _( "Could not use OpenGL, falling back to software rendering" ),
235  wxString( err.what() ) );
236  }
237 
238 #ifdef __WXDEBUG__
239  totalRealTime.Stop();
240  wxLogTrace( "GAL_PROFILE", "EDA_DRAW_PANEL_GAL::onPaint(): %.1f ms", totalRealTime.msecs() );
241 #endif /* PROFILE */
242 
243  m_lastRefresh = wxGetLocalTimeMillis();
244  m_drawing = false;
245 }
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.
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:42
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 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 DrawGrid()
>
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:124
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:277
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: draw_frame.h:403
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:568

◆ onRefreshTimer()

void EDA_DRAW_PANEL_GAL::onRefreshTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 485 of file draw_panel_gal.cpp.

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

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

486 {
487  if( !m_drawingEnabled )
488  {
489  if( m_gal && m_gal->IsInitialized() )
490  {
491  m_drawing = false;
492  m_pendingRefresh = true;
493  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
494  m_drawingEnabled = true;
495  }
496  else
497  {
498  // Try again soon
499  m_refreshTimer.StartOnce( 100 );
500  return;
501  }
502  }
503 
504  wxPaintEvent redrawEvent;
505  wxPostEvent( this, redrawEvent );
506 }
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.

◆ OnShow()

void GERBVIEW_DRAW_PANEL_GAL::OnShow ( )
overridevirtual

>

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

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 103 of file gerbview_draw_panel_gal.cpp.

References GERBVIEW_FRAME::GetActiveLayer(), EDA_DRAW_FRAME::GetDisplayOptions(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::m_view, KIGFX::VIEW::RecacheAllItems(), and SetTopLayer().

104 {
105  GERBVIEW_FRAME* frame = dynamic_cast<GERBVIEW_FRAME*>( GetParent() );
106 
107  if( frame )
108  {
109  SetTopLayer( frame->GetActiveLayer() );
111  static_cast<KIGFX::GERBVIEW_RENDER_SETTINGS*>(
112  m_view->GetPainter()->GetSettings() )->LoadDisplayOptions( displ_opts );
113  }
114 
116 }
void RecacheAllItems()
Function RecacheAllItems() Rebuilds GAL display lists.
Definition: view.cpp:1401
int GetActiveLayer()
Function SetActiveLayer returns the active layer.
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
Class GERBVIEW_RENDER_SETTINGS Stores GerbView specific render settings.
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.
virtual void SetTopLayer(int aLayer) override
>
virtual void * GetDisplayOptions()
A way to pass info to draw functions.
Definition: draw_frame.h:947

◆ onShowTimer()

void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 509 of file draw_panel_gal.cpp.

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

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

510 {
511  if( m_gal && m_gal->IsVisible() )
512  {
513  m_onShowTimer.Stop();
514  OnShow();
515  }
516 }
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.

◆ onSize()

void EDA_DRAW_PANEL_GAL::onSize ( wxSizeEvent &  aEvent)
protectedinherited

Definition at line 248 of file draw_panel_gal.cpp.

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

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

249 {
251  wxSize clientSize = GetClientSize();
252  m_gal->ResizeScreen( clientSize.x, clientSize.y );
253 
254  if( m_view )
255  {
258  }
259 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
Auxiliary rendering target (noncached)
Definition: definitions.h:42
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target &#39;dirty&#39; flag.
Definition: view.h:596
virtual void ResizeScreen(int aWidth, int aHeight)
Resizes the canvas.
Main rendering target (cached)
Definition: definitions.h:41
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

◆ Refresh()

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

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

References delta, EDA_DRAW_PANEL_GAL::ForceRefresh(), EDA_DRAW_PANEL_GAL::m_lastRefresh, EDA_DRAW_PANEL_GAL::m_pendingRefresh, EDA_DRAW_PANEL_GAL::m_refreshTimer, and EDA_DRAW_PANEL_GAL::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(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCBNEW_CONTROL::GraphicDisplayMode(), SCH_EDIT_FRAME::HighlightConnectionAtPosition(), GERBVIEW_CONTROL::HighlightControl(), GERBVIEW_FRAME::loadListOfGerberAndDrillFiles(), PCBNEW_CONTROL::ModuleEdgeOutlines(), PCBNEW_CONTROL::ModuleTextOutlines(), EDA_DRAW_PANEL_GAL::OnEvent(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectHighlightChoice(), PCBNEW_CONTROL::PadDisplayMode(), TOOL_MANAGER::ProcessEvent(), 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(), ZONE_FILLER_TOOL::SegzoneDeleteFill(), GERBVIEW_FRAME::SetActiveLayer(), PCBNEW_CONTROL::TrackDisplayMode(), 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().

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

◆ SetCurrentCursor()

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( int  aCursor)
virtualinherited

Function SetCurrentCursor Set the current cursor shape for this panel.

Definition at line 517 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_currentCursor.

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

518 {
519  if ( aCursor > wxCURSOR_NONE && aCursor < wxCURSOR_MAX )
520  {
521  m_currentCursor = aCursor;
522  }
523  else
524  {
525  m_currentCursor = wxCURSOR_ARROW;
526  }
527 
528  SetCursor( (wxStockCursor) m_currentCursor );
529 }
int m_currentCursor
Current mouse cursor shape id.

◆ SetDefaultCursor()

void EDA_DRAW_PANEL_GAL::SetDefaultCursor ( )
virtualinherited

Definition at line 531 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_defaultCursor, and EDA_DRAW_PANEL_GAL::SetCurrentCursor().

Referenced by AbortBlockCurrentCommand().

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

◆ setDefaultLayerDeps()

void GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps ( )
protected

Sets rendering targets & dependencies for layers.

Definition at line 156 of file gerbview_draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, i, LAYER_DCODES, LAYER_GERBVIEW_AXES, LAYER_GERBVIEW_BACKGROUND, LAYER_GERBVIEW_GRID, LAYER_GP_OVERLAY, LAYER_NEGATIVE_OBJECTS, LAYER_SELECT_OVERLAY, LAYER_WORKSHEET, EDA_DRAW_PANEL_GAL::m_backend, EDA_DRAW_PANEL_GAL::m_view, KIGFX::VIEW::SetLayerDisplayOnly(), KIGFX::VIEW::SetLayerTarget(), KIGFX::TARGET_CACHED, KIGFX::TARGET_NONCACHED, KIGFX::TARGET_OVERLAY, and KIGFX::VIEW::VIEW_MAX_LAYERS.

Referenced by GERBVIEW_DRAW_PANEL_GAL(), and SwitchBackend().

157 {
158  // caching makes no sense for Cairo and other software renderers
160 
161  for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
162  m_view->SetLayerTarget( i, target );
163 
164  // for( int i = GERBVIEW_LAYER_ID_START; i < GERBVIEW_LAYER_ID_RESERVED; i++ )
165  // m_view->SetLayerDisplayOnly( i );
166 
173 
176 
179 }
GAL_TYPE m_backend
Currently used GAL.
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:712
Auxiliary rendering target (noncached)
Definition: definitions.h:42
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Function SetLayerTarget() Changes the rendering target for a particular layer.
Definition: view.h:445
void SetLayerDisplayOnly(int aLayer, bool aDisplayOnly=true)
Definition: view.h:433
Items that may change while the view stays the same (noncached)
Definition: definitions.h:43
general purpose overlay
Main rendering target (cached)
Definition: definitions.h:41
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
size_t i
Definition: json11.cpp:597
currently selected items overlay

◆ SetEventDispatcher()

void EDA_DRAW_PANEL_GAL::SetEventDispatcher ( TOOL_DISPATCHER aEventDispatcher)
inherited

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

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

Referenced by EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_EDIT_FRAME::OnCloseWindow(), FOOTPRINT_EDIT_FRAME::setupTools(), PCB_BASE_FRAME::UseGalCanvas(), and GERBVIEW_FRAME::UseGalCanvas().

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

◆ SetFocus()

void EDA_DRAW_PANEL_GAL::SetFocus ( )
overridevirtualinherited

Definition at line 139 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_lostFocus.

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

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

◆ SetHighContrastLayer()

void GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer ( int  aLayer)
overridevirtual

>

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

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 81 of file gerbview_draw_panel_gal.cpp.

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

82 {
83  // Set display settings for high contrast mode
85 
86  SetTopLayer( aLayer );
87 
88  rSettings->ClearActiveLayers();
89  rSettings->SetActiveLayer( aLayer );
90  rSettings->SetActiveLayer( GERBER_DCODE_LAYER( aLayer ) );
91 
93 }
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
#define GERBER_DCODE_LAYER(x)
void ClearActiveLayers()
Function ClearActiveLayers Clears the list of active layers.
Definition: painter.h:98
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.
virtual void SetTopLayer(int aLayer) override
>
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:797

◆ SetStealsFocus()

void EDA_DRAW_PANEL_GAL::SetStealsFocus ( bool  aStealsFocus)
inlineinherited

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.

References EDA_DRAW_PANEL_GAL::m_stealsFocus.

Referenced by FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), DIALOG_PAD_PROPERTIES::prepareCanvas(), and SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET().

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

◆ SetTopLayer()

void GERBVIEW_DRAW_PANEL_GAL::SetTopLayer ( int  aLayer)
overridevirtual

>

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

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 189 of file gerbview_draw_panel_gal.cpp.

References KIGFX::VIEW::ClearTopLayers(), GERBER_DCODE_LAYER, GERBER_DRAW_LAYER, GERBER_DRAWLAYERS_COUNT, i, LAYER_GP_OVERLAY, LAYER_SELECT_OVERLAY, EDA_DRAW_PANEL_GAL::m_view, KIGFX::VIEW::SetLayerOrder(), KIGFX::VIEW::SetTopLayer(), and KIGFX::VIEW::UpdateAllLayersOrder().

Referenced by OnShow(), and SetHighContrastLayer().

190 {
192 
193  for( int i = 0; i < GERBER_DRAWLAYERS_COUNT; ++i )
194  {
196  m_view->SetLayerOrder( GERBER_DRAW_LAYER( i ), ( 2 * i ) + 1 );
197  }
198 
199  m_view->SetTopLayer( aLayer );
200 
201  // Move DCODE layer to the top
202  m_view->SetTopLayer( GERBER_DCODE_LAYER( aLayer ) );
203 
205 
207 
209 }
void SetLayerOrder(int aLayer, int aRenderingOrder)
Function SetLayerOrder() Sets rendering order of a particular layer.
Definition: view.cpp:663
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
#define GERBER_DCODE_LAYER(x)
#define GERBER_DRAWLAYERS_COUNT
general purpose overlay
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.
size_t i
Definition: json11.cpp:597
currently selected items overlay
#define GERBER_DRAW_LAYER(x)

◆ SetWorksheet()

void GERBVIEW_DRAW_PANEL_GAL::SetWorksheet ( KIGFX::WORKSHEET_VIEWITEM aWorksheet)

Sets (or updates) worksheet used by the draw panel.

Parameters
aWorksheetis the worksheet to be used. The object is then owned by GERBVIEW_DRAW_PANEL_GAL.

Definition at line 182 of file gerbview_draw_panel_gal.cpp.

References KIGFX::VIEW::Add(), EDA_DRAW_PANEL_GAL::m_view, and m_worksheet.

183 {
184  m_worksheet.reset( aWorksheet );
185  m_view->Add( m_worksheet.get() );
186 }
std::unique_ptr< KIGFX::WORKSHEET_VIEWITEM > m_worksheet
Currently used worksheet
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346

◆ StartDrawing()

void EDA_DRAW_PANEL_GAL::StartDrawing ( )
inherited

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

Definition at line 324 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::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().

325 {
326  // Start querying GAL if it is ready
327  m_refreshTimer.StartOnce( 100 );
328 }
wxTimer m_refreshTimer
Timer responsible for preventing too frequent refresh.

◆ StopDrawing()

void EDA_DRAW_PANEL_GAL::StopDrawing ( )
inherited

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

Definition at line 331 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_drawingEnabled, EDA_DRAW_PANEL_GAL::m_pendingRefresh, EDA_DRAW_PANEL_GAL::m_refreshTimer, and EDA_DRAW_PANEL_GAL::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(), EDA_DRAW_PANEL_GAL::SwitchBackend(), GERBVIEW_FRAME::UseGalCanvas(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

332 {
333  m_drawingEnabled = false;
334  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
335  m_pendingRefresh = false;
336  m_refreshTimer.Stop();
337 }
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.

◆ SwitchBackend()

bool GERBVIEW_DRAW_PANEL_GAL::SwitchBackend ( GAL_TYPE  aGalType)
overridevirtual

Function SwitchBackend Switches method of rendering graphics.

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

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 119 of file gerbview_draw_panel_gal.cpp.

References KIGFX::VIEW::Add(), KIGFX::VIEW::Clear(), EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, GERBER_DRAWLAYERS_COUNT, EDA_DRAW_PANEL_GAL::GetGAL(), GERBER_FILE_IMAGE_LIST::GetGbrImage(), GERBVIEW_FRAME::GetImagesList(), GERBER_FILE_IMAGE::GetItemsList(), EDA_DRAW_PANEL_GAL::m_view, GERBER_DRAW_ITEM::Next(), setDefaultLayerDeps(), KIGFX::GAL::SetWorldUnitLength(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

120 {
121  bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
122 
123  // The next onPaint event will call m_view->UpdateItems() that is very time consumming
124  // after switching to opengl. Clearing m_view and rebuild it is much faster
125  if( aGalType == GAL_TYPE_OPENGL )
126  {
127  GERBVIEW_FRAME* frame = dynamic_cast<GERBVIEW_FRAME*>( GetParent() );
128 
129  if( frame )
130  {
131  m_view->Clear();
132 
133  for( int layer = GERBER_DRAWLAYERS_COUNT-1; layer>= 0; --layer )
134  {
135  GERBER_FILE_IMAGE* gerber = frame->GetImagesList()->GetGbrImage( layer );
136 
137  if( gerber == NULL ) // Graphic layer not yet used
138  continue;
139 
140  for( GERBER_DRAW_ITEM* item = gerber->GetItemsList(); item; item = item->Next() )
141  {
142  m_view->Add (item );
143  }
144  }
145  }
146  }
147 
149 
150  GetGAL()->SetWorldUnitLength( 1.0/IU_PER_MM /* 10 nm */ / 25.4 /* 1 inch in mm */ );
151 
152  return rv;
153 }
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
Class GERBER_FILE_IMAGE holds the Image data and parameters for one gerber file and layer parameters ...
void setDefaultLayerDeps()
Sets rendering targets & dependencies for layers.
#define GERBER_DRAWLAYERS_COUNT
GERBER_FILE_IMAGE * GetGbrImage(int aIdx)
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1110
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.
GERBER_DRAW_ITEM * Next() const
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
GERBER_DRAW_ITEM * GetItemsList()
Function GetItemsList.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data.

◆ UseColorScheme()

void GERBVIEW_DRAW_PANEL_GAL::UseColorScheme ( const COLORS_DESIGN_SETTINGS aSettings)

Function UseColorScheme Applies layer color settings.

Parameters
aSettingsare the new settings.

Definition at line 73 of file gerbview_draw_panel_gal.cpp.

References KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), KIGFX::GERBVIEW_RENDER_SETTINGS::ImportLegacyColors(), and EDA_DRAW_PANEL_GAL::m_view.

Referenced by GERBVIEW_DRAW_PANEL_GAL().

74 {
77  rs->ImportLegacyColors( aSettings );
78 }
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
Class GERBVIEW_RENDER_SETTINGS Stores GerbView specific render settings.
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 ImportLegacyColors(const COLORS_DESIGN_SETTINGS *aSettings) override
Function ImportLegacyColors Loads a list of color settings for layers.

Member Data Documentation

◆ m_backend

◆ m_currentCursor

int EDA_DRAW_PANEL_GAL::m_currentCursor
protectedinherited

◆ m_defaultCursor

int EDA_DRAW_PANEL_GAL::m_defaultCursor
protectedinherited

◆ m_drawing

bool EDA_DRAW_PANEL_GAL::m_drawing
protectedinherited

◆ m_drawingEnabled

bool EDA_DRAW_PANEL_GAL::m_drawingEnabled
protectedinherited

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::EDA_DRAW_PANEL_GAL(), EDA_DRAW_PANEL_GAL::onRefreshTimer(), and EDA_DRAW_PANEL_GAL::StopDrawing().

◆ m_edaFrame

EDA_DRAW_FRAME* EDA_DRAW_PANEL_GAL::m_edaFrame
protectedinherited

◆ m_eventDispatcher

TOOL_DISPATCHER* EDA_DRAW_PANEL_GAL::m_eventDispatcher
protectedinherited

Processes and forwards events to tools.

Definition at line 299 of file class_draw_panel_gal.h.

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

◆ m_gal

◆ m_lastRefresh

wxLongLong EDA_DRAW_PANEL_GAL::m_lastRefresh
protectedinherited

Last timestamp when the panel was refreshed.

Definition at line 265 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::onPaint(), and EDA_DRAW_PANEL_GAL::Refresh().

◆ m_lostFocus

bool EDA_DRAW_PANEL_GAL::m_lostFocus
protectedinherited

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::EDA_DRAW_PANEL_GAL(), EDA_DRAW_PANEL_GAL::OnEvent(), EDA_DRAW_PANEL_GAL::onLostFocus(), and EDA_DRAW_PANEL_GAL::SetFocus().

◆ m_onShowTimer

wxTimer EDA_DRAW_PANEL_GAL::m_onShowTimer
protectedinherited

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::EDA_DRAW_PANEL_GAL(), and EDA_DRAW_PANEL_GAL::onShowTimer().

◆ m_options

KIGFX::GAL_DISPLAY_OPTIONS& EDA_DRAW_PANEL_GAL::m_options
protectedinherited

Definition at line 296 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

◆ m_painter

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

◆ m_parent

wxWindow* EDA_DRAW_PANEL_GAL::m_parent
protectedinherited

◆ m_pendingRefresh

bool EDA_DRAW_PANEL_GAL::m_pendingRefresh
protectedinherited

◆ m_refreshTimer

wxTimer EDA_DRAW_PANEL_GAL::m_refreshTimer
protectedinherited

◆ m_stealsFocus

bool EDA_DRAW_PANEL_GAL::m_stealsFocus
protectedinherited

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::EDA_DRAW_PANEL_GAL(), EDA_DRAW_PANEL_GAL::GetStealsFocus(), EDA_DRAW_PANEL_GAL::onEnter(), EDA_DRAW_PANEL_GAL::OnEvent(), and EDA_DRAW_PANEL_GAL::SetStealsFocus().

◆ m_view

◆ m_viewControls

◆ m_worksheet

std::unique_ptr<KIGFX::WORKSHEET_VIEWITEM> GERBVIEW_DRAW_PANEL_GAL::m_worksheet
protected

Currently used worksheet

Definition at line 79 of file gerbview_draw_panel_gal.h.

Referenced by GetDefaultViewBBox(), and SetWorksheet().

◆ MinRefreshPeriod

const int EDA_DRAW_PANEL_GAL::MinRefreshPeriod = 17
staticprotectedinherited

60 FPS.

Definition at line 251 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::Refresh().


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