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 ()
 
virtual void SetHighContrastLayer (int aLayer) override
 

More...
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, 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::WS_PROXY_VIEW_ITEM *aWorksheet)
 Sets (or updates) worksheet used by the draw panel. More...
 
KIGFX::WS_PROXY_VIEW_ITEMGetWorksheet () const
 
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...
 
virtual KIGFX::VIEWGetView () const
 Function GetView() Returns a pointer to the VIEW instance used in the panel. More...
 
KIGFX::VIEW_CONTROLSGetViewControls () const
 Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel. More...
 
virtual void Refresh (bool aEraseBackground=true, const wxRect *aRect=NULL) override
 Update the board display after modifying it by a python script (note: it is automatically called by action plugins, after running the plugin, so call this function is usually not needed inside action plugins. More...
 
void ForceRefresh ()
 Function ForceRefresh() Forces a redraw. More...
 
void SetEventDispatcher (TOOL_DISPATCHER *aEventDispatcher)
 Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools. More...
 
void StartDrawing ()
 Function StartDrawing() Begins drawing if it was stopped previously. More...
 
void StopDrawing ()
 Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDrawing() is called. More...
 
EDA_DRAW_FRAMEGetParentEDAFrame () const
 Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise. More...
 
bool IsDialogPreview () const
 
void SetStealsFocus (bool aStealsFocus)
 Set whether focus is taken on certain events (mouseover, keys, etc). More...
 
void SetCurrentCursor (KICURSOR cursor)
 Function SetCurrentCursor Set the current cursor shape for this panel. More...
 
void OnEvent (wxEvent &aEvent)
 Used to forward events to the canvas from popups, etc. More...
 
void DoRePaint ()
 Repaint the canvas, and fix scrollbar cursors Usually called by a OnPaint event, but because it do not use a wxPaintDC, it can be called outside a wxPaintEvent. More...
 
std::shared_ptr< KIGFX::VIEW_OVERLAYDebugOverlay ()
 Creates an overlay for rendering debug graphics. More...
 
void ClearDebugOverlay ()
 Clears the contents of the debug overlay and removes it from the VIEW. More...
 

Static Public Attributes

static constexpr GAL_TYPE GAL_FALLBACK = GAL_TYPE_CAIRO
 

Protected Member Functions

void setDefaultLayerDeps ()
 

Sets rendering targets & dependencies for layers.

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

Protected Attributes

std::unique_ptr< KIGFX::WS_PROXY_VIEW_ITEMm_worksheet
 

Currently used worksheet

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

Static Protected Attributes

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

Detailed Description

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

59  {
60  GAL_TYPE_UNKNOWN = -1,
61  GAL_TYPE_NONE = 0,
65  };
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.

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 = std::make_unique<KIGFX::GERBVIEW_PAINTER>( m_gal );
48  m_view->SetPainter( m_painter.get() );
49 
51 
53 
54  // Load display options (such as filled/outline display of items).
55  auto frame = static_cast< GERBVIEW_FRAME* >( GetParentEDAFrame() );
56 
57  if( frame )
58  {
59  auto& displ_opts = frame->GetDisplayOptions();
60  auto rs = static_cast<KIGFX::GERBVIEW_RENDER_SETTINGS*>(
62 
63  rs->LoadDisplayOptions( displ_opts );
64  rs->LoadColors( Pgm().GetSettingsManager().GetColorSettings() );
65  }
66 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
WX_VIEW_CONTROLS is a specific implementation of class VIEW_CONTROLS for wxWidgets library.
static constexpr double IU_PER_MM
Mock up a conversion function.
void setDefaultLayerDeps()
Sets rendering targets & dependencies for layers.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:201
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)
Create a drawing panel that is contained inside aParentWindow.
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
SETTINGS_MANAGER * GetSettingsManager()
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter Returns pointer to current settings that are going to be used when drawing items.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
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:191
VIEW.
Definition: view.h:63
void SetGAL(GAL *aGal)
Function SetGAL() Assigns a rendering device for the VIEW.
Definition: view.cpp:500

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

◆ ~GERBVIEW_DRAW_PANEL_GAL()

GERBVIEW_DRAW_PANEL_GAL::~GERBVIEW_DRAW_PANEL_GAL ( )
virtual

Definition at line 69 of file gerbview_draw_panel_gal.cpp.

70 {
71 }

Member Function Documentation

◆ ClearDebugOverlay()

void EDA_DRAW_PANEL_GAL::ClearDebugOverlay ( )
inherited

Clears the contents of the debug overlay and removes it from the VIEW.

Definition at line 613 of file draw_panel_gal.cpp.

614 {
615  if( m_debugOverlay )
616  {
617  m_view->Remove( m_debugOverlay.get() );
618  m_debugOverlay = nullptr;
619  }
620 }
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:357
std::shared_ptr< KIGFX::VIEW_OVERLAY > m_debugOverlay
Optional overlay for drawing transient debug objects.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

References EDA_DRAW_PANEL_GAL::m_debugOverlay, EDA_DRAW_PANEL_GAL::m_view, and KIGFX::VIEW::Remove().

◆ DebugOverlay()

std::shared_ptr< KIGFX::VIEW_OVERLAY > EDA_DRAW_PANEL_GAL::DebugOverlay ( )
inherited

Creates an overlay for rendering debug graphics.

Definition at line 601 of file draw_panel_gal.cpp.

602 {
603  if( !m_debugOverlay )
604  {
605  m_debugOverlay.reset( new KIGFX::VIEW_OVERLAY() );
606  m_view->Add( m_debugOverlay.get() );
607  }
608 
609  return m_debugOverlay;
610 }
std::shared_ptr< KIGFX::VIEW_OVERLAY > m_debugOverlay
Optional overlay for drawing transient debug objects.
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:327

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

◆ DoRePaint()

void EDA_DRAW_PANEL_GAL::DoRePaint ( )
inherited

Repaint the canvas, and fix scrollbar cursors Usually called by a OnPaint event, but because it do not use a wxPaintDC, it can be called outside a wxPaintEvent.

Definition at line 162 of file draw_panel_gal.cpp.

163 {
164  // Repaint the canvas, and fix scrollbar cursors
165  // Usually called by a OnPaint event, but because it does not use a wxPaintDC,
166  // it can be called outside a wxPaintEvent.
167 
168  // Update current zoom settings if the canvas is managed by a EDA frame
169  // (i.e. not by a preview panel in a dialog)
170  if( !IsDialogPreview() && GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
172 
174 
175  if( !m_gal->IsVisible() )
176  return;
177 
178  m_pendingRefresh = false;
179 
180  if( m_drawing )
181  return;
182 
183 #ifdef PROFILE
184  PROF_COUNTER totalRealTime;
185 #endif /* PROFILE */
186 
187  wxASSERT( m_painter );
188 
189  m_drawing = true;
190  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
191 
192  try
193  {
194  m_view->UpdateItems();
195 
197 
200  {
201  m_view->MarkDirty();
202  }
203 
204  m_gal->SetClearColor( settings->GetBackgroundColor() );
205  m_gal->SetGridColor( settings->GetGridColor() );
206  m_gal->SetCursorColor( settings->GetCursorColor() );
207 
208  // TODO: find why ClearScreen() must be called here in opengl mode
209  // and only if m_view->IsDirty() in Cairo mode to avoid distaly artifacts
210  // when moving the mouse cursor
211  if( m_backend == GAL_TYPE_OPENGL )
212  m_gal->ClearScreen();
213 
214  if( m_view->IsDirty() )
215  {
216  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
218  m_gal->ClearScreen();
219 
220  m_view->ClearTargets();
221 
222  // Grid has to be redrawn only when the NONCACHED target is redrawn
224  m_gal->DrawGrid();
225 
226  m_view->Redraw();
227  }
228 
230  }
231  catch( std::runtime_error& err )
232  {
233  if( GAL_FALLBACK != m_backend )
234  {
236 
238  _( "Could not use OpenGL, falling back to software rendering" ),
239  wxString( err.what() ) );
240  }
241  else
242  {
243  // We're well and truly banjaxed if we get here without a fallback.
244  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), wxString( err.what() ) );
245  }
246  }
247 
248 #ifdef PROFILE
249  totalRealTime.Stop();
250  wxLogTrace( "GAL_PROFILE", "EDA_DRAW_PANEL_GAL::DoRePaint(): %.1f ms", totalRealTime.msecs() );
251 #endif /* PROFILE */
252 
253  m_lastRefresh = wxGetLocalTimeMillis();
254  m_drawing = false;
255 }
void Stop()
save the time when this function was called, and set the counter stane to stop
Definition: profile.h:82
bool m_pendingRefresh
Is there a redraw event requested?
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
void SetClearColor(const COLOR4D &aColor)
virtual const COLOR4D & GetGridColor()=0
Function GetGridColor Returns current grid color settings.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
GAL_TYPE m_backend
Currently used GAL.
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
virtual const COLOR4D & GetCursorColor()=0
Function GetCursorColor Returns current cursor color settings.
virtual const COLOR4D & GetBackgroundColor()=0
Function GetBackgroundColor Returns current background color settings.
double msecs(bool aSinceLast=false)
Definition: profile.h:143
const VECTOR2D & GetCenter() const
Function GetCenter() Returns the center point of this VIEW (in world space coordinates)
Definition: view.h:330
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
static constexpr GAL_TYPE GAL_FALLBACK
virtual bool HasTarget(RENDER_TARGET aTarget)
Returns true if the target exists.
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:44
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void UpdateScrollbars()
Adjusts the scrollbars position to match the current viewport.
bool m_drawing
True if GAL is currently redrawing the view.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
wxWindow * m_parent
Pointer to the parent window.
virtual void Redraw()
Function Redraw() Immediately redraws the whole view.
Definition: view.cpp:1123
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:560
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
virtual void DrawGrid()
virtual void DrawCursor(const VECTOR2D &aCursorPosition)
Draw the cursor.
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1394
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
virtual void ClearScreen()
Clear the screen.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
#define _(s)
Definition: 3d_actions.cpp:33
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
VECTOR2D GetCursorPosition(bool aSnappingEnabled) const override
Returns the current cursor position in world coordinates.
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
void ClearTargets()
Function ClearTargets() Clears targets that are marked as dirty.
Definition: view.cpp:1104
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:102
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:268
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:596
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:543

References _, KIGFX::GAL::ClearScreen(), KIGFX::VIEW::ClearTargets(), DisplayInfoMessage(), KIGFX::GAL::DrawCursor(), KIGFX::GAL::DrawGrid(), EDA_DRAW_PANEL_GAL::GAL_FALLBACK, 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::GetParentEDAFrame(), EDA_DRAW_FRAME::GetScreen(), EDA_DRAW_PANEL_GAL::GetView(), KIGFX::GAL::HasTarget(), EDA_DRAW_PANEL_GAL::IsDialogPreview(), 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_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, BASE_SCREEN::m_ScrollCenter, EDA_DRAW_PANEL_GAL::m_view, EDA_DRAW_PANEL_GAL::m_viewControls, KIGFX::VIEW::MarkDirty(), PROF_COUNTER::msecs(), KIGFX::VIEW::Redraw(), KIGFX::GAL::SetClearColor(), KIGFX::GAL::SetCursorColor(), KIGFX::GAL::SetGridColor(), PROF_COUNTER::Stop(), EDA_DRAW_PANEL_GAL::SwitchBackend(), KIGFX::TARGET_NONCACHED, KIGFX::TARGET_OVERLAY, KIGFX::VIEW::UpdateItems(), and KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars().

Referenced by EDA_DRAW_PANEL_GAL::ForceRefresh(), EDA_DRAW_PANEL_GAL::onPaint(), and EDA_DRAW_PANEL_GAL::onRefreshTimer().

◆ ForceRefresh()

◆ GetBackend()

GAL_TYPE EDA_DRAW_PANEL_GAL::GetBackend ( ) const
inlineinherited

◆ GetDefaultViewBBox()

BOX2I GERBVIEW_DRAW_PANEL_GAL::GetDefaultViewBBox ( ) const
overridevirtual

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 205 of file gerbview_draw_panel_gal.cpp.

206 {
207  // Even in Gervbview, this is the LAYER_WORKSHEET that controls the visibility
208  // of the worksheet
210  return m_worksheet->ViewBBox();
211 
212  return BOX2I();
213 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:522
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
std::unique_ptr< KIGFX::WS_PROXY_VIEW_ITEM > m_worksheet
Currently used worksheet
bool IsLayerVisible(int aLayer) const
Function IsLayerVisible() Returns information about visibility of a particular layer.
Definition: view.h:402

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

◆ GetGAL()

◆ GetMsgPanelInfo()

void GERBVIEW_DRAW_PANEL_GAL::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 89 of file gerbview_draw_panel_gal.cpp.

91 {
92 
93 }

◆ GetParentEDAFrame()

◆ GetView()

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

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

Returns
The instance of VIEW.

Reimplemented in PCB_DRAW_PANEL_GAL, and SCH_DRAW_PANEL.

Definition at line 115 of file class_draw_panel_gal.h.

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

References EDA_DRAW_PANEL_GAL::m_view.

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

◆ GetViewControls()

◆ GetWorksheet()

KIGFX::WS_PROXY_VIEW_ITEM* GERBVIEW_DRAW_PANEL_GAL::GetWorksheet ( ) const
inline
Returns
the current worksheet

Definition at line 67 of file gerbview_draw_panel_gal.h.

67 { return m_worksheet.get(); }
std::unique_ptr< KIGFX::WS_PROXY_VIEW_ITEM > m_worksheet
Currently used worksheet

References m_worksheet.

◆ IsDialogPreview()

bool EDA_DRAW_PANEL_GAL::IsDialogPreview ( ) const
inlineinherited

Definition at line 181 of file class_draw_panel_gal.h.

181 { return m_parent != (wxWindow*) m_edaFrame; }
wxWindow * m_parent
Pointer to the parent window.
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)

References EDA_DRAW_PANEL_GAL::m_edaFrame, and EDA_DRAW_PANEL_GAL::m_parent.

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), PCB_DRAW_PANEL_GAL::OnShow(), and PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL().

◆ onEnter()

void EDA_DRAW_PANEL_GAL::onEnter ( wxMouseEvent &  aEvent)
protectedinherited

Definition at line 520 of file draw_panel_gal.cpp.

521 {
522  bool shouldSetFocus = m_stealsFocus;
523 
524 #if defined( _WIN32 )
525  // Ensure we are the active foreground window before we attempt to steal focus
526  // mouse events are generated on Win32 regardless if window is active
527  shouldSetFocus = shouldSetFocus && ( m_edaFrame->GetHWND() == GetForegroundWindow() );
528 #endif
529 
530  // Getting focus is necessary in order to receive key events properly
531  if( shouldSetFocus )
532  SetFocus();
533 
534  aEvent.Skip();
535 }
virtual void SetFocus() override
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...

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

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ OnEvent()

void EDA_DRAW_PANEL_GAL::OnEvent ( wxEvent &  aEvent)
inherited

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

Definition at line 498 of file draw_panel_gal.cpp.

499 {
500  bool shouldSetFocus = m_lostFocus && m_stealsFocus;
501 
502 #if defined( _WIN32 )
503  // Ensure we are the active foreground window before we attempt to steal focus
504  // mouse events are generated on Win32 regardless if window is active
505  shouldSetFocus = shouldSetFocus && ( m_edaFrame->GetHWND() == GetForegroundWindow() );
506 #endif
507 
508  if( shouldSetFocus )
509  SetFocus();
510 
511  if( !m_eventDispatcher )
512  aEvent.Skip();
513  else
515 
516  Refresh();
517 }
virtual void DispatchWxEvent(wxEvent &aEvent)
Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs, and makes tools handle those.
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
virtual void SetFocus() override
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
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(), EDA_DRAW_PANEL_GAL::m_edaFrame, 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().

◆ onLostFocus()

void EDA_DRAW_PANEL_GAL::onLostFocus ( wxFocusEvent &  aEvent)
protectedinherited

Definition at line 538 of file draw_panel_gal.cpp.

539 {
540  m_lostFocus = true;
541 
542  aEvent.Skip();
543 }
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.

References EDA_DRAW_PANEL_GAL::m_lostFocus.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ onPaint()

void EDA_DRAW_PANEL_GAL::onPaint ( wxPaintEvent &  WXUNUSEDaEvent)
protectedvirtualinherited

Reimplemented in SCH_PREVIEW_PANEL, and SCH_DRAW_PANEL.

Definition at line 156 of file draw_panel_gal.cpp.

157 {
158  DoRePaint();
159 }
void DoRePaint()
Repaint the canvas, and fix scrollbar cursors Usually called by a OnPaint event, but because it do no...

References EDA_DRAW_PANEL_GAL::DoRePaint().

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

◆ onRefreshTimer()

void EDA_DRAW_PANEL_GAL::onRefreshTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 546 of file draw_panel_gal.cpp.

547 {
548  if( !m_drawingEnabled )
549  {
550  if( m_gal && m_gal->IsInitialized() )
551  {
552  m_drawing = false;
553  m_pendingRefresh = true;
554  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
555  m_drawingEnabled = true;
556  }
557  else
558  {
559  // Try again soon
560  m_refreshTimer.StartOnce( 100 );
561  return;
562  }
563  }
564 
565  //wxPaintEvent redrawEvent;
566  //wxPostEvent( this, redrawEvent );
567  DoRePaint();
568 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
void DoRePaint()
Repaint the canvas, and fix scrollbar cursors Usually called by a OnPaint event, but because it do no...
bool m_drawing
True if GAL is currently redrawing the view.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
#define NULL
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
virtual bool IsInitialized() const
Returns the initalization status for the canvas.

References EDA_DRAW_PANEL_GAL::DoRePaint(), 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, NULL, and EDA_DRAW_PANEL_GAL::onPaint().

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ onSetCursor()

void EDA_DRAW_PANEL_GAL::onSetCursor ( wxSetCursorEvent &  event)
protectedinherited

Definition at line 595 of file draw_panel_gal.cpp.

596 {
597  event.SetCursor( m_currentCursor );
598 }
wxCursor m_currentCursor
Current mouse cursor shape id.

References EDA_DRAW_PANEL_GAL::m_currentCursor.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

◆ 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 96 of file gerbview_draw_panel_gal.cpp.

97 {
98  GERBVIEW_FRAME* frame = dynamic_cast<GERBVIEW_FRAME*>( GetParentEDAFrame() );
99 
100  if( frame )
101  {
102  SetTopLayer( frame->GetActiveLayer() );
103  auto& displ_opts = frame->GetDisplayOptions();
104  static_cast<KIGFX::GERBVIEW_RENDER_SETTINGS*>(
105  m_view->GetPainter()->GetSettings() )->LoadDisplayOptions( displ_opts );
106  }
107 
109 }
void RecacheAllItems()
Function RecacheAllItems() Rebuilds GAL display lists.
Definition: view.cpp:1377
const GBR_DISPLAY_OPTIONS & GetDisplayOptions() const
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:201
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter Returns pointer to current settings that are going to be used when drawing items.
int GetActiveLayer() const
Function SetActiveLayer returns the active layer.
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.
virtual void SetTopLayer(int aLayer) override

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

◆ onShowTimer()

void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 571 of file draw_panel_gal.cpp.

572 {
573  if( m_gal && m_gal->IsVisible() )
574  {
575  m_onShowTimer.Stop();
576  OnShow();
577  }
578 }
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(), 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().

◆ onSize()

void EDA_DRAW_PANEL_GAL::onSize ( wxSizeEvent &  aEvent)
protectedinherited

Definition at line 258 of file draw_panel_gal.cpp.

259 {
261  wxSize clientSize = GetClientSize();
262  WX_INFOBAR* infobar = GetParentEDAFrame() ? GetParentEDAFrame()->GetInfoBar() : nullptr;
263 
264  if( VECTOR2I( clientSize ) == m_gal->GetScreenPixelSize() )
265  return;
266 
267  clientSize.x = std::max( 10, clientSize.x );
268  clientSize.y = std::max( 10, clientSize.y );
269 
270  VECTOR2D bottom( 0, 0 );
271 
272  if( m_view )
273  bottom = m_view->ToWorld( m_gal->GetScreenPixelSize(), true );
274 
275  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
276 
277  if( m_view )
278  {
279  if( infobar && infobar->IsLocked() )
280  m_view->SetCenter( bottom - m_view->ToWorld( clientSize, false ) / 2.0 );
281 
284  }
285 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:456
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
Auxiliary rendering target (noncached)
Definition: definitions.h:49
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
bool IsLocked()
Returns true if the infobar is being updated.
Definition: infobar.h:172
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:585
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:571
virtual void ResizeScreen(int aWidth, int aHeight)
Resizes the canvas.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:70
Main rendering target (cached)
Definition: definitions.h:48
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.
WX_INFOBAR * GetInfoBar()

References EDA_BASE_FRAME::GetInfoBar(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), KIGFX::GAL::GetScreenPixelSize(), WX_INFOBAR::IsLocked(), EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_view, KIGFX::VIEW::MarkTargetDirty(), KIGFX::GAL::ResizeScreen(), KIGFX::VIEW::SetCenter(), KIGFX::TARGET_CACHED, KIGFX::TARGET_NONCACHED, and KIGFX::VIEW::ToWorld().

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ 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_PREVIEW_PANEL.

Definition at line 288 of file draw_panel_gal.cpp.

289 {
290  if( m_pendingRefresh )
291  return;
292 
293  m_pendingRefresh = true;
294 
295 #ifdef __WXMAC__
296  // Timers on OS X may have a high latency (seen up to 500ms and more) which
297  // makes repaints jerky. No negative impact seen without throttling, so just
298  // do an unconditional refresh for OS X.
299  ForceRefresh();
300 #else
301  wxLongLong t = wxGetLocalTimeMillis();
302  wxLongLong delta = t - m_lastRefresh;
303 
304  if( delta >= MinRefreshPeriod )
305  {
306  ForceRefresh();
307  }
308  else
309  {
310  // One shot timer
311  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
312  }
313 #endif
314 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.
void ForceRefresh()
Function ForceRefresh() Forces a redraw.
static const int MinRefreshPeriod
60 FPS.
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.

References 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 DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_FRAME::AnnotateComponents(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_EDIT_TOOL::BreakWire(), SCH_BASE_FRAME::CenterScreen(), ZONE_FILLER_TOOL::CheckAllZones(), GERBVIEW_CONTROL::ClearAllLayers(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::DeleteAnnotation(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SCH_EDIT_TOOL::DoDelete(), PCB_INSPECTION_TOOL::doHideNet(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), LIB_EDIT_TOOL::editFieldProperties(), LIB_EDIT_TOOL::editGraphicProperties(), LIB_EDIT_TOOL::editTextProperties(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), ZONE_FILLER_TOOL::FillAllZones(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDITOR_CONTROL::FindNext(), PCB_BASE_FRAME::FocusOnItem(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), PCB_VIEWER_TOOLS::GraphicOutlines(), PL_EDITOR_FRAME::HardRedraw(), GERBVIEW_CONTROL::HighlightControl(), DIALOG_SELECT_NET_FROM_LIST::highlightNetOnBoard(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), SCH_EDIT_FRAME::KiwayMailIn(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), PCB_VIEWER_TOOLS::MeasureTool(), DIALOG_MIGRATE_BUSES::onAcceptClicked(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_ANNOTATE::OnApplyClick(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), DIALOG_INSPECTOR::onCellClicked(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnEraseDrcMarkersClick(), EDA_DRAW_PANEL_GAL::OnEvent(), EDA_DRAW_FRAME::OnGridSettings(), GERBER_LAYER_WIDGET::OnLayerColorChange(), APPEARANCE_CONTROLS::OnLayerContextMenu(), GERBER_LAYER_WIDGET::OnLayerSelect(), APPEARANCE_CONTROLS::onLayerVisibilityChanged(), GERBER_LAYER_WIDGET::OnLayerVisible(), DIALOG_GROUP_PROPERTIES::OnMemberSelected(), SCH_EDIT_FRAME::OnModify(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), GERBER_LAYER_WIDGET::onPopupSelection(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_SELECT_NET_FROM_LIST::onRenameNet(), GERBER_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectActiveDCode(), PL_EDITOR_FRAME::OnSelectCoordOriginCorner(), GERBVIEW_FRAME::OnSelectDisplayMode(), EDA_DRAW_FRAME::OnSelectGrid(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), PL_EDITOR_FRAME::OnSelectPage(), EDA_DRAW_FRAME::OnSelectZoom(), PROPERTIES_FRAME::OnSetDefaultValues(), DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), GERBVIEW_CONTROL::OpenDrillFile(), GERBVIEW_CONTROL::OpenJobFile(), GERBVIEW_CONTROL::OpenZipFile(), PCB_VIEWER_TOOLS::PadDisplayMode(), PL_EDITOR_FRAME::PrintPage(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_TOOL::Properties(), FOOTPRINT_EDITOR_TOOLS::Properties(), ReannotateFromPCBNew(), LIB_EDIT_FRAME::RebuildView(), SCH_EDIT_FRAME::RecomputeIntersheetsRefs(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListLib(), FOOTPRINT_WIZARD_FRAME::ReCreatePageList(), SCH_EDITOR_CONTROL::Redo(), DIALOG_PAD_PROPERTIES::redraw(), DIALOG_ERC::redrawDrawPanel(), SCH_BASE_FRAME::RedrawScreen(), SCH_PREVIEW_PANEL::Refresh(), Refresh(), DIALOG_DRC::refreshBoardEditor(), refreshCallback(), EDA_DRAW_FRAME::RefreshCanvas(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), SCH_EDITOR_CONTROL::RemapSymbols(), EDIT_TOOL::Remove(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), GERBVIEW_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetDisplayOptions(), EDA_DRAW_FRAME::SetGridVisibility(), APPEARANCE_CONTROLS::SetObjectVisible(), LIB_VIEW_FRAME::SetSelectedLibrary(), LIB_CONTROL::ShowElectricalTypes(), PCB_VIEWER_TOOLS::ShowPadNumbers(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), GERBVIEW_FRAME::SortLayersByX2Attributes(), GLOBAL_EDIT_TOOL::SwapLayers(), SCH_DRAW_PANEL::SwitchBackend(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_ERC::testErc(), PCB_VIEWER_TOOLS::TextOutlines(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), PCBNEW_CONTROL::ToggleRatsnest(), PCBNEW_CONTROL::TrackDisplayMode(), PANEL_GAL_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_EDIT_LINE_STYLE::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_SYM_EDITING_OPTIONS::TransferDataFromWindow(), DIALOG_EDIT_SHEET_PIN::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::Undo(), GERBVIEW_FRAME::UpdateDisplayOptions(), SCH_EDITOR_CONTROL::UpdateFind(), NET_GRID_TABLE::updateNetColor(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), SCH_EDIT_FRAME::UpdateSymbolFromEditor(), PCBNEW_CONTROL::ViaDisplayMode(), PCBNEW_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

◆ SetCurrentCursor()

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( KICURSOR  cursor)
inherited

Function SetCurrentCursor Set the current cursor shape for this panel.

Definition at line 581 of file draw_panel_gal.cpp.

582 {
583  if( m_currentKiCursor == cursor )
584  {
585  return;
586  }
587 
589  m_currentKiCursor = cursor;
590 
591  SetCursor( m_currentCursor );
592 }
static const wxCursor GetCursor(KICURSOR aCursorType)
Definition: cursors.cpp:379
wxCursor m_currentCursor
Current mouse cursor shape id.

References CURSOR_STORE::GetCursor(), EDA_DRAW_PANEL_GAL::m_currentCursor, and EDA_DRAW_PANEL_GAL::m_currentKiCursor.

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

◆ setDefaultLayerDeps()

void GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps ( )
protected

Sets rendering targets & dependencies for layers.

Definition at line 149 of file gerbview_draw_panel_gal.cpp.

150 {
151  // caching makes no sense for Cairo and other software renderers
153 
154  for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
155  m_view->SetLayerTarget( i, target );
156 
157  // for( int i = GERBVIEW_LAYER_ID_START; i < GERBVIEW_LAYER_ID_RESERVED; i++ )
158  // m_view->SetLayerDisplayOnly( i );
159 
166 
169 
172 }
GAL_TYPE m_backend
Currently used GAL.
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:694
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Function SetLayerTarget() Changes the rendering target for a particular layer.
Definition: view.h:420
void SetLayerDisplayOnly(int aLayer, bool aDisplayOnly=true)
Definition: view.h:408
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
Main rendering target (cached)
Definition: definitions.h:48
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
currently selected items overlay

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

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

326 {
327  m_eventDispatcher = aEventDispatcher;
328  const wxEventType eventTypes[] = { wxEVT_TOOL };
329 
330  if( m_eventDispatcher )
331  {
332  for( wxEventType type : eventTypes )
333  {
334  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
336  }
337  }
338  else
339  {
340  for( wxEventType type : eventTypes )
341  {
342  // While loop is used to be sure that all event handlers are removed.
343  while( m_parent->Disconnect( type,
344  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
345  NULL, m_eventDispatcher ) );
346  }
347  }
348 }
wxWindow * m_parent
Pointer to the parent window.
#define NULL
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
virtual void DispatchWxCommand(wxCommandEvent &aEvent)
Processes wxCommands (mostly menu related events) and runs appropriate actions (eg.

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

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

◆ SetFocus()

void EDA_DRAW_PANEL_GAL::SetFocus ( )
overridevirtualinherited

◆ SetHighContrastLayer()

void GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer ( int  aLayer)
overridevirtual

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 74 of file gerbview_draw_panel_gal.cpp.

75 {
76  // Set display settings for high contrast mode
78 
79  SetTopLayer( aLayer );
80 
81  rSettings->ClearHighContrastLayers();
82  rSettings->SetLayerIsHighContrast( aLayer );
83  rSettings->SetLayerIsHighContrast( GERBER_DCODE_LAYER( aLayer ) );
84 
86 }
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:201
#define GERBER_DCODE_LAYER(x)
void SetLayerIsHighContrast(int aLayerId, bool aEnabled=true)
Function SetLayerIsHighContrast Sets the specified layer as high-contrast.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter Returns pointer to current settings that are going to be used when drawing items.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
virtual void SetTopLayer(int aLayer) override
void ClearHighContrastLayers()
Function ClearHighContrastLayers Clears the list of active layers.
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:776

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

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

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

References EDA_DRAW_PANEL_GAL::m_stealsFocus.

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

◆ SetTopLayer()

void GERBVIEW_DRAW_PANEL_GAL::SetTopLayer ( int  aLayer)
overridevirtual

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 182 of file gerbview_draw_panel_gal.cpp.

183 {
185 
186  for( int i = 0; i < GERBER_DRAWLAYERS_COUNT; ++i )
187  {
189  m_view->SetLayerOrder( GERBER_DRAW_LAYER( i ), ( 2 * i ) + 1 );
190  }
191 
192  m_view->SetTopLayer( aLayer );
193 
194  // Move DCODE layer to the top
195  m_view->SetTopLayer( GERBER_DCODE_LAYER( aLayer ) );
196 
198 
200 
202 }
void SetLayerOrder(int aLayer, int aRenderingOrder)
Function SetLayerOrder() Sets rendering order of a particular layer.
Definition: view.cpp:645
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:838
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers.
Definition: view.cpp:905
#define GERBER_DCODE_LAYER(x)
#define GERBER_DRAWLAYERS_COUNT
void ClearTopLayers()
Function ClearTopLayers() Removes all layers from the on-the-top set (they are no longer displayed ov...
Definition: view.cpp:890
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
currently selected items overlay
#define GERBER_DRAW_LAYER(x)

References KIGFX::VIEW::ClearTopLayers(), GERBER_DCODE_LAYER, GERBER_DRAW_LAYER, GERBER_DRAWLAYERS_COUNT, 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().

◆ SetWorksheet()

void GERBVIEW_DRAW_PANEL_GAL::SetWorksheet ( KIGFX::WS_PROXY_VIEW_ITEM 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 175 of file gerbview_draw_panel_gal.cpp.

176 {
177  m_worksheet.reset( aWorksheet );
178  m_view->Add( m_worksheet.get() );
179 }
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:327
std::unique_ptr< KIGFX::WS_PROXY_VIEW_ITEM > m_worksheet
Currently used worksheet

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

◆ StartDrawing()

void EDA_DRAW_PANEL_GAL::StartDrawing ( )
inherited

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

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

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

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

◆ 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 112 of file gerbview_draw_panel_gal.cpp.

113 {
114  bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
115 
116  // The next onPaint event will call m_view->UpdateItems() that is very time consumming
117  // after switching to opengl. Clearing m_view and rebuild it is much faster
118  if( aGalType == GAL_TYPE_OPENGL )
119  {
120  GERBVIEW_FRAME* frame = dynamic_cast<GERBVIEW_FRAME*>( GetParentEDAFrame() );
121 
122  if( frame )
123  {
124  m_view->Clear();
125 
126  for( int layer = GERBER_DRAWLAYERS_COUNT-1; layer>= 0; --layer )
127  {
128  GERBER_FILE_IMAGE* gerber = frame->GetImagesList()->GetGbrImage( layer );
129 
130  if( gerber == NULL ) // Graphic layer not yet used
131  continue;
132 
133  for( GERBER_DRAW_ITEM* item : gerber->GetItems() )
134  {
135  m_view->Add (item );
136  }
137  }
138  }
139  }
140 
142 
143  GetGAL()->SetWorldUnitLength( 1.0/IU_PER_MM /* 10 nm */ / 25.4 /* 1 inch in mm */ );
144 
145  return rv;
146 }
GERBER_DRAW_ITEMS & GetItems()
static constexpr double IU_PER_MM
Mock up a conversion function.
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
GERBER_FILE_IMAGE holds the Image data and parameters for one gerber file and layer parameters (TODO:...
void setDefaultLayerDeps()
Sets rendering targets & dependencies for layers.
#define NULL
#define GERBER_DRAWLAYERS_COUNT
GERBER_FILE_IMAGE * GetGbrImage(int aIdx)
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1089
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.
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.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:327
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data.

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::GetItems(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), IU_PER_MM, EDA_DRAW_PANEL_GAL::m_view, NULL, setDefaultLayerDeps(), KIGFX::GAL::SetWorldUnitLength(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

Member Data Documentation

◆ GAL_FALLBACK

◆ m_backend

◆ m_currentCursor

wxCursor EDA_DRAW_PANEL_GAL::m_currentCursor
protectedinherited

Current mouse cursor shape id.

Definition at line 246 of file class_draw_panel_gal.h.

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

◆ m_currentKiCursor

KICURSOR EDA_DRAW_PANEL_GAL::m_currentKiCursor
protectedinherited

◆ m_debugOverlay

std::shared_ptr<KIGFX::VIEW_OVERLAY> EDA_DRAW_PANEL_GAL::m_debugOverlay
protectedinherited

Optional overlay for drawing transient debug objects.

Definition at line 293 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::ClearDebugOverlay(), and EDA_DRAW_PANEL_GAL::DebugOverlay().

◆ 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 260 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

◆ m_eventDispatcher

TOOL_DISPATCHER* EDA_DRAW_PANEL_GAL::m_eventDispatcher
protectedinherited

Processes and forwards events to tools.

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

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), 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 286 of file class_draw_panel_gal.h.

Referenced by 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 263 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 279 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 290 of file class_draw_panel_gal.h.

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

◆ m_view

KIGFX::VIEW* EDA_DRAW_PANEL_GAL::m_view
protectedinherited

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

Definition at line 269 of file class_draw_panel_gal.h.

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

◆ m_viewControls

◆ m_worksheet

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

Currently used worksheet

Definition at line 74 of file gerbview_draw_panel_gal.h.

Referenced by GetDefaultViewBBox(), GetWorksheet(), and SetWorksheet().

◆ MinRefreshPeriod

const int EDA_DRAW_PANEL_GAL::MinRefreshPeriod = 17
staticprotectedinherited

60 FPS.

Definition at line 244 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: