KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
ZONE_PREVIEW_CANVAS Class Reference

#include <zone_preview_canvas.h>

Inheritance diagram for ZONE_PREVIEW_CANVAS:
PCB_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

 ZONE_PREVIEW_CANVAS (BOARD *aPcb, std::unique_ptr< ZONE > aZone, PCB_LAYER_ID aLayer, wxWindow *aParentWindow, KIGFX::GAL_DISPLAY_OPTIONS &aOptions, GAL_TYPE aGalType)
 
 ~ZONE_PREVIEW_CANVAS () override=default
 
const wxSize GetPageSizeIU () const
 
void ZoomFitScreen ()
 
BOX2I GetBoardBoundingBox (bool aBoardEdgesOnly) const
 
const BOX2I GetDocumentExtents (bool aIncludeAllVisible=true) const
 
void LockZoom (double aScale, const VECTOR2D &aCenter)
 
void UnlockZoom ()
 
void DisplayBoard (BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr)
 Add all items from the current board to the VIEW, so they can be displayed by GAL.
 
void SetDrawingSheet (DS_PROXY_VIEW_ITEM *aDrawingSheet)
 Set or update drawing-sheet used by the draw panel.
 
DS_PROXY_VIEW_ITEM * GetDrawingSheet () const
 
void UpdateColors ()
 Update the color settings in the painter and GAL.
 
void prepareGridSources () override
 Push a GRID_SOURCE for every PCB_GRIDITEM on the board to the GAL.
 
virtual void SetHighContrastLayer (int aLayer) override
 Take care of display settings for the given layer to be displayed in high contrast mode.
 
void SetHighContrastLayer (PCB_LAYER_ID aLayer)
 SetHighContrastLayer(), with some extra smarts for PCB.
 
virtual void SetTopLayer (int aLayer) override
 Move the selected layer to the top, so it is displayed above all others.
 
void SetTopLayer (PCB_LAYER_ID aLayer)
 SetTopLayer(), with some extra smarts for PCB.
 
void SyncLayersVisibility (const BOARD *aBoard)
 Update "visibility" property of each layer of a given BOARD.
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 
void OnShow () override
 Called when the window is shown for the first time.
 
bool SwitchBackend (GAL_TYPE aGalType) override
 Switch method of rendering graphics.
 
void RedrawRatsnest ()
 Force refresh of the ratsnest visual representation.
 
BOX2I GetDefaultViewBBox () const override
 Return the bounding box of the view that should be used if model is not valid.
 
virtual KIGFX::PCB_VIEW * GetView () const override
 Return a pointer to the KIGFX::VIEW instance used in the panel.
 
void SetFocus () override
 
bool StatusPopupHasFocus ()
 
void SetStatusPopup (wxWindow *aPopup)
 
void UpdateTouchpadGestureHandler ()
 Apply the current native touchpad gesture preference to the active backend window.
 
GAL_TYPE GetBackend () const
 Return the type of backend currently used by GAL canvas.
 
KIGFX::GAL * GetGAL () const
 Return a pointer to the GAL instance used in the panel.
 
KIGFX::VIEW_CONTROLS * GetViewControls () const
 Return a pointer to the KIGFX::VIEW_CONTROLS instance used in the panel.
 
bool GetScreenshot (wxImage &aDstImage)
 Capture the current canvas contents into aDstImage.
 
virtual void Refresh (bool aEraseBackground=true, const wxRect *aRect=nullptr) override
 
void ForceRefresh ()
 Force a redraw.
 
void RequestRefresh ()
 Make sure a refresh gets done on the next idle event if it hasn't already.
 
void UpdateOverlayExclusions ()
 Tell the backend which areas of this panel are covered by an overlaid infobar.
 
void ResizeGal (bool aForce=false)
 Resize the GAL to the current client size of this panel.
 
void SetEventDispatcher (TOOL_DISPATCHER *aEventDispatcher)
 Set a dispatcher that processes events and forwards them to tools.
 
void StartDrawing ()
 Begin drawing if it was stopped previously.
 
void StopDrawing ()
 Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.
 
EDA_DRAW_FRAME * GetParentEDAFrame () const
 Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
 
bool IsDialogPreview () const
 
void SetStealsFocus (bool aStealsFocus)
 Set whether focus is taken on certain events (mouseover, keys, etc).
 
void SetCurrentCursor (KICURSOR aCursor)
 Set the current cursor shape for this panel.
 
void OnEvent (wxEvent &aEvent)
 Used to forward events to the canvas from popups, etc.
 
bool DoRePaint (bool aAllowSkip=true)
 Repaint the canvas, and fix scrollbar cursors.
 
std::shared_ptr< KIGFX::VIEW_OVERLAY > DebugOverlay ()
 Create an overlay for rendering debug graphics.
 
void ClearDebugOverlay ()
 Clear the contents of the debug overlay and removes it from the VIEW.
 

Static Public Member Functions

static GAL_TYPE ResolveStoredCanvasType (int aStoredCanvasType)
 Convert a stored canvas type setting into a backend that can actually be used.
 
static KIGFX::VC_SETTINGS GetVcSettings ()
 Gets a populated View Controls settings object dervived from our program settings.
 

Public Attributes

bool m_MouseCapturedLost
 used on wxMSW: true after a wxEVT_MOUSE_CAPTURE_LOST was received false after the mouse is recaptured.
 
std::unique_ptr< PROF_COUNTER > m_PaintEventCounter
 

Static Public Attributes

static constexpr GAL_TYPE GAL_FALLBACK = GAL_TYPE_CAIRO
 
static constexpr bool GAL_FALLBACK_AVAILABLE = GAL_FALLBACK != GAL_TYPE_OPENGL
 

Protected Member Functions

void setDefaultLayerOrder ()
 Reassign layer order to the initial settings.
 
void setDefaultLayerDeps ()
 Set rendering targets & dependencies for layers.
 
virtual void onPaint (wxPaintEvent &WXUNUSED(aEvent))
 
void onSize (wxSizeEvent &aEvent)
 
void onEnter (wxMouseEvent &aEvent)
 
void onLostFocus (wxFocusEvent &aEvent)
 
void onIdle (wxIdleEvent &aEvent)
 
void onRefreshTimer (wxTimerEvent &aEvent)
 
void onShowEvent (wxShowEvent &aEvent)
 
bool recoverFromGalError (const std::exception &aErr)
 
bool handleContextLoss ()
 Replace a GAL whose context was destroyed by a GPU reset.
 
void showMessageLater (const wxString &aTitle, const wxString &aDetail, bool aError)
 Show a recovery message once the current event finishes.
 

Protected Attributes

std::unique_ptr< DS_PROXY_VIEW_ITEM > m_drawingSheet
 Currently used drawing-sheet.
 
std::unique_ptr< RATSNEST_VIEW_ITEM > m_ratsnest
 Ratsnest view item.
 
wxWindow * m_parent
 Pointer to the parent window.
 
EDA_DRAW_FRAME * m_edaFrame
 Parent EDA_DRAW_FRAME (if available)
 
std::chrono::steady_clock::time_point m_lastRepaintStart
 Timestamp of the last repaint start.
 
std::chrono::steady_clock::time_point m_lastRepaintEnd
 Timestamp of the last repaint end.
 
wxTimer m_refreshTimer
 Timer to prevent too-frequent refreshing.
 
std::mutex m_refreshMutex
 Blocks multiple calls to the draw.
 
bool m_drawing
 True if GAL is currently redrawing the view.
 
bool m_drawingEnabled
 Flag that determines if VIEW may use GAL for redrawing the screen.
 
bool m_needIdleRefresh
 True when canvas needs to be refreshed from idle handler.
 
VECTOR2D m_lastCursorPosition
 Last cursor position sent to GAL for drawing.
 
KIGFX::GAL * m_gal
 Interface for drawing objects on a 2D-surface.
 
KIGFX::VIEW * m_view
 Stores view settings (scale, center, etc.) and items to be drawn.
 
std::unique_ptr< KIGFX::PAINTER > m_painter
 Contains information about how to draw items using GAL.
 
KIGFX::WX_VIEW_CONTROLS * m_viewControls
 Control for VIEW (moving, zooming, etc.)
 
GAL_TYPE m_backend
 Currently used GAL.
 
KIGFX::GAL_DISPLAY_OPTIONS & m_options
 
TOOL_DISPATCHER * m_eventDispatcher
 Processes and forwards events to tools.
 
bool m_lostFocus
 Flag to indicate that focus should be regained on the next mouse event.
 
bool m_glRecoveryAttempted
 Set after an OpenGL recovery attempt to prevent infinite retry loops.
 
int m_contextBindFailures
 Consecutive frames dropped because the GL context could not be made current.
 
bool m_rebuiltAfterReset
 The GAL was rebuilt after a GPU reset and has not completed a frame yet.
 
bool m_pendingResize
 Set when a size change could not be applied because the GL context was unavailable.
 
bool m_stealsFocus
 Flag to indicate whether the panel should take focus at certain times (when moused over, and on various mouse/key events)
 
wxWindow * m_statusPopup
 
std::shared_ptr< KIGFX::VIEW_OVERLAY > m_debugOverlay
 Optional overlay for drawing transient debug objects.
 
std::unique_ptr< KIPLATFORM::UI::TOUCHPAD_GESTURE_HANDLER > m_touchpadGestureHandler
 

Private Attributes

BOARD * m_pcb
 
std::unique_ptr< BOARD_EDGES_BOUNDING_ITEM > m_pcb_bounding_box
 
std::unique_ptr< ZONE > m_zone
 
bool m_zoomLocked
 

Detailed Description

Definition at line 34 of file zone_preview_canvas.h.

Member Enumeration Documentation

◆ GAL_TYPE

enum EDA_DRAW_PANEL_GAL::GAL_TYPE
inherited
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 69 of file class_draw_panel_gal.h.

Constructor & Destructor Documentation

◆ ZONE_PREVIEW_CANVAS()

ZONE_PREVIEW_CANVAS::ZONE_PREVIEW_CANVAS ( BOARD * aPcb,
std::unique_ptr< ZONE > aZone,
PCB_LAYER_ID aLayer,
wxWindow * aParentWindow,
KIGFX::GAL_DISPLAY_OPTIONS & aOptions,
GAL_TYPE aGalType )

Definition at line 100 of file zone_preview_canvas.cpp.

References _, DRAW_ORDER_BOARD_BOUNDING, DRAW_ORDER_ZONE, Edge_Cuts, FRAME_FOOTPRINT_PREVIEW, getCanvasBackgroundColor(), EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_painter, m_pcb, m_pcb_bounding_box, EDA_DRAW_PANEL_GAL::m_view, m_zone, m_zoomLocked, move, PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), PCB_LAYER_ID_COUNT, EDA_DRAW_PANEL_GAL::RequestRefresh(), EDA_DRAW_PANEL_GAL::StartDrawing(), UnlockZoom(), PCB_DRAW_PANEL_GAL::UpdateColors(), and ZoomFitScreen().

◆ ~ZONE_PREVIEW_CANVAS()

ZONE_PREVIEW_CANVAS::~ZONE_PREVIEW_CANVAS ( )
overridedefault

Member Function Documentation

◆ ClearDebugOverlay()

void EDA_DRAW_PANEL_GAL::ClearDebugOverlay ( )
inherited

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

Definition at line 1069 of file draw_panel_gal.cpp.

References m_debugOverlay, and m_view.

◆ DebugOverlay()

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

Create an overlay for rendering debug graphics.

Definition at line 1057 of file draw_panel_gal.cpp.

References m_debugOverlay, and m_view.

◆ DisplayBoard()

void PCB_DRAW_PANEL_GAL::DisplayBoard ( BOARD * aBoard,
PROGRESS_REPORTER * aReporter = nullptr )
inherited

Add all items from the current board to the VIEW, so they can be displayed by GAL.

Parameters
aBoardis the PCB to be loaded.
aReporteris the optional REPORTER object to write status messages to.

Definition at line 276 of file pcb_draw_panel_gal.cpp.

References BOARD::BoardOutline(), BOARD::CacheTriangulation(), BOARD::GetConnectivity(), BOARD::GetFileName(), BOARD::GetItemSet(), BOARD::IsFootprintHolder(), m_drawingSheet, m_ratsnest, EDA_DRAW_PANEL_GAL::m_view, NO_RECURSE, PCB_CONSTRAINT_T, PCB_FOOTPRINT_T, TO_UTF8, EDA_ITEM::Type(), and BOARD::UpdateBoardOutline().

Referenced by FOOTPRINT_EDIT_FRAME::installFootprintTabBoard(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), PCB_BASE_EDIT_FRAME::SetBoard(), FOOTPRINT_EDIT_FRAME::UpdateView(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), and FOOTPRINT_WIZARD_FRAME::updateView().

◆ DoRePaint()

bool EDA_DRAW_PANEL_GAL::DoRePaint ( bool aAllowSkip = true)
inherited

Repaint the canvas, and fix scrollbar cursors.

Usually called by a OnPaint event.

Because it does not use a wxPaintDC, it can be called outside a wxPaintEvent.

Returns
true if the repaint attempt was successful.

Definition at line 351 of file draw_panel_gal.cpp.

References _, GAL_TYPE_OPENGL, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), KIGFX::VIEW::GetCenter(), KIGFX::RENDER_SETTINGS::GetCursorColor(), KIGFX::RENDER_SETTINGS::GetGridColor(), GetParentEDAFrame(), EDA_DRAW_FRAME::GetScreen(), GetView(), handleContextLoss(), IsDialogPreview(), KIGFX::GAL_DRAWING_CONTEXT::IsDrawing(), m_backend, m_contextBindFailures, m_drawing, m_drawingEnabled, m_gal, m_glRecoveryAttempted, m_lastCursorPosition, m_lastRepaintEnd, m_lastRepaintStart, m_painter, m_pendingResize, m_rebuiltAfterReset, m_refreshMutex, BASE_SCREEN::m_ScrollCenter, m_view, m_viewControls, MAX_CONTEXT_BIND_RETRIES, Pgm(), prepareGridSources(), recoverFromGalError(), RequestRefresh(), ResizeGal(), showMessageLater(), PROF_TIMER::Start(), PROF_TIMER::Stop(), StopDrawing(), KIGFX::TARGET_NONCACHED, KIGFX::TARGET_OVERLAY, PROF_TIMER::to_string(), traceDrawPanel, and traceGalProfile.

Referenced by ForceRefresh(), GetScreenshot(), onPaint(), and Refresh().

◆ ForceRefresh()

void EDA_DRAW_PANEL_GAL::ForceRefresh ( )
inherited

Force a redraw.

Definition at line 696 of file draw_panel_gal.cpp.

References DoRePaint(), m_drawingEnabled, m_gal, m_refreshTimer, onIdle(), and onPaint().

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), FOOTPRINT_VIEWER_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), PAD_TOOL::ExitPadEditMode(), FOOTPRINT_EDIT_FRAME::HardRedraw(), SCH_BASE_FRAME::HardRedraw(), SCH_EDIT_FRAME::HardRedraw(), FOOTPRINT_EDIT_FRAME::installFootprintTabBoard(), POSITION_RELATIVE_TOOL::InteractiveOffset(), DIALOG_FP_EDIT_PAD_TABLE::OnAddRow(), PCB_EDIT_FRAME::OnCrossProbeFlashTimer(), SCH_EDIT_FRAME::OnCrossProbeFlashTimer(), DIALOG_FP_EDIT_PAD_TABLE::OnDeleteRow(), DIALOG_FP_EDIT_PAD_TABLE::OnImportButtonClick(), onRefreshTimer(), DIALOG_FP_EDIT_PAD_TABLE::OnSelectCell(), FOOTPRINT_PREVIEW_PANEL::RefreshAll(), FOOTPRINT_EDIT_FRAME::RefreshLibraryFootprintTab(), DIALOG_FP_EDIT_PAD_TABLE::RestoreOriginalPadState(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), COMMON_TOOLS::ToggleBoundingBoxes(), FOOTPRINT_EDIT_FRAME::updateInfoBar(), and SYMBOL_EDIT_FRAME::updateInfoBar().

◆ GetBackend()

GAL_TYPE EDA_DRAW_PANEL_GAL::GetBackend ( ) const
inlineinherited

Return the type of backend currently used by GAL canvas.

Definition at line 143 of file class_draw_panel_gal.h.

References m_backend.

Referenced by DIALOG_SYMBOL_REMAP::OnRemapSymbols(), EDA_DRAW_FRAME::resolveCanvasType(), EDA_DRAW_FRAME::SwitchCanvas(), GERBVIEW_FRAME::UpdateXORLayers(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), PCB_BASE_FRAME::~PCB_BASE_FRAME(), PL_EDITOR_FRAME::~PL_EDITOR_FRAME(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetBoardBoundingBox()

BOX2I ZONE_PREVIEW_CANVAS::GetBoardBoundingBox ( bool aBoardEdgesOnly) const

Definition at line 156 of file zone_preview_canvas.cpp.

References BOX2< Vec >::GetHeight(), GetPageSizeIU(), BOX2< Vec >::GetWidth(), m_pcb, BOX2< Vec >::SetEnd(), and BOX2< Vec >::SetOrigin().

Referenced by GetDocumentExtents().

◆ GetDefaultViewBBox()

BOX2I PCB_DRAW_PANEL_GAL::GetDefaultViewBBox ( ) const
overridevirtualinherited

Return the bounding box of the view that should be used if model is not valid.

For example, the drawing sheet bounding box for an empty PCB

Returns
the default bounding box for the panel.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 749 of file pcb_draw_panel_gal.cpp.

References LAYER_DRAWINGSHEET, m_drawingSheet, and EDA_DRAW_PANEL_GAL::m_view.

Referenced by ZONE_PREVIEW_CANVAS::ZoomFitScreen().

◆ GetDocumentExtents()

const BOX2I ZONE_PREVIEW_CANVAS::GetDocumentExtents ( bool aIncludeAllVisible = true) const

Definition at line 171 of file zone_preview_canvas.cpp.

References Edge_Cuts, GetBoardBoundingBox(), and m_pcb.

Referenced by ZoomFitScreen().

◆ GetDrawingSheet()

DS_PROXY_VIEW_ITEM * PCB_DRAW_PANEL_GAL::GetDrawingSheet ( ) const
inlineinherited

Definition at line 63 of file pcb_draw_panel_gal.h.

References m_drawingSheet.

Referenced by EDIT_TOOL::Properties(), and PCB_EDIT_FRAME::SetPageSettings().

◆ GetGAL()

KIGFX::GAL * EDA_DRAW_PANEL_GAL::GetGAL ( ) const
inlineinherited

Return a pointer to the GAL instance used in the panel.

Returns
The instance of GAL.

Definition at line 150 of file class_draw_panel_gal.h.

References m_gal.

Referenced by FOOTPRINT_EDIT_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), SCH_BASE_FRAME::CommonSettingsChanged(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), KICAD_DIFF::ConfigurePcbDiffCanvasContext(), KICAD_DIFF::ConfigureSchDiffCanvasContext(), KICAD_DIFF::ConfigureSymDiffCanvasContext(), GERBVIEW_FRAME::DisplayGridMsg(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), EDA_DRAW_FRAME::GetNearestGridPosition(), EDA_DRAW_FRAME::GetNearestHalfGridPosition(), FOOTPRINT_PREVIEW_PANEL::New(), DIALOG_FP_EDIT_PAD_TABLE::OnAddRow(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), PCB_BASE_EDIT_FRAME::SetBoard(), GERBVIEW_FRAME::SetGridColor(), PCB_EDIT_FRAME::SetGridColor(), EDA_DRAW_FRAME::SetGridVisibility(), FP_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), PL_DRAW_PANEL_GAL::SwitchBackend(), FOOTPRINT_EDIT_FRAME::SwitchCanvas(), and SYMBOL_EDIT_FRAME::SwitchCanvas().

◆ GetMsgPanelInfo()

void PCB_DRAW_PANEL_GAL::GetMsgPanelInfo ( EDA_DRAW_FRAME * aFrame,
std::vector< MSG_PANEL_ITEM > & aList )
overridevirtualinherited

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 619 of file pcb_draw_panel_gal.cpp.

References _, BOARD::Footprints(), BOARD::GetConnectivity(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), CONNECTIVITY_DATA::GetUnconnectedCount(), pad, PCB_VIA_T, and BOARD::Tracks().

◆ GetPageSizeIU()

const wxSize ZONE_PREVIEW_CANVAS::GetPageSizeIU ( ) const

Definition at line 180 of file zone_preview_canvas.cpp.

References KiROUND(), m_pcb, pcbIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GetBoardBoundingBox().

◆ GetParentEDAFrame()

EDA_DRAW_FRAME * EDA_DRAW_PANEL_GAL::GetParentEDAFrame ( ) const
inlineinherited

Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.

Definition at line 248 of file class_draw_panel_gal.h.

References m_edaFrame.

Referenced by DoRePaint(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), PCB_DRAW_PANEL_GAL::OnShow(), SCH_DRAW_PANEL::OnShow(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), PCB_DRAW_PANEL_GAL::prepareGridSources(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), and PCB_DRAW_PANEL_GAL::UpdateColors().

◆ GetScreenshot()

bool EDA_DRAW_PANEL_GAL::GetScreenshot ( wxImage & aDstImage)
inherited

Capture the current canvas contents into aDstImage.

Returns
true on success, false if the backend can't be captured this way (the caller should fall back to a DC blit).

Definition at line 719 of file draw_panel_gal.cpp.

References DoRePaint(), GAL_TYPE_OPENGL, GetScreenshot(), m_backend, and m_gal.

Referenced by GetScreenshot().

◆ GetVcSettings()

KIGFX::VC_SETTINGS EDA_DRAW_PANEL_GAL::GetVcSettings ( )
staticinherited

Gets a populated View Controls settings object dervived from our program settings.

Definition at line 1079 of file draw_panel_gal.cpp.

References COMMON_SETTINGS::INPUT::auto_pan, COMMON_SETTINGS::INPUT::auto_pan_acceleration, COMMON_SETTINGS::INPUT::center_on_zoom, COMMON_SETTINGS::INPUT::drag_left, COMMON_SETTINGS::INPUT::drag_middle, COMMON_SETTINGS::INPUT::drag_right, COMMON_SETTINGS::INPUT::focus_follow_sch_pcb, PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::INPUT::horizontal_pan, KIGFX::VC_SETTINGS::m_autoPanAcceleration, KIGFX::VC_SETTINGS::m_autoPanSettingEnabled, KIGFX::VC_SETTINGS::m_dragLeft, KIGFX::VC_SETTINGS::m_dragMiddle, KIGFX::VC_SETTINGS::m_dragRight, KIGFX::VC_SETTINGS::m_focusFollowSchPcb, KIGFX::VC_SETTINGS::m_horizontalPan, COMMON_SETTINGS::m_Input, KIGFX::VC_SETTINGS::m_motionPanModifier, KIGFX::VC_SETTINGS::m_scrollModifierPanH, KIGFX::VC_SETTINGS::m_scrollModifierPanV, KIGFX::VC_SETTINGS::m_scrollModifierZoom, KIGFX::VC_SETTINGS::m_scrollReversePanH, KIGFX::VC_SETTINGS::m_scrollReverseZoom, KIGFX::VC_SETTINGS::m_warpCursor, KIGFX::VC_SETTINGS::m_zoomAcceleration, KIGFX::VC_SETTINGS::m_zoomSpeed, KIGFX::VC_SETTINGS::m_zoomSpeedAuto, COMMON_SETTINGS::INPUT::motion_pan_modifier, Pgm(), COMMON_SETTINGS::INPUT::reverse_scroll_pan_h, COMMON_SETTINGS::INPUT::reverse_scroll_zoom, COMMON_SETTINGS::INPUT::scroll_modifier_pan_h, COMMON_SETTINGS::INPUT::scroll_modifier_pan_v, COMMON_SETTINGS::INPUT::scroll_modifier_zoom, COMMON_SETTINGS::INPUT::zoom_acceleration, COMMON_SETTINGS::INPUT::zoom_speed, and COMMON_SETTINGS::INPUT::zoom_speed_auto.

Referenced by EDA_3D_VIEWER_FRAME::applySettings(), EDA_3D_VIEWER_FRAME::configureCanvas(), and SwitchBackend().

◆ GetView()

KIGFX::PCB_VIEW * PCB_DRAW_PANEL_GAL::GetView ( ) const
overridevirtualinherited

Return a pointer to the KIGFX::VIEW instance used in the panel.

Returns
The instance of KIGFX::VIEW.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 860 of file pcb_draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_view.

Referenced by CheckItemDRCViolation(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_PREVIEW_PANEL::ClearViewAndData(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::detachActiveFootprintTab(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprints(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::enterPadEditMode(), PAD_TOOL::ExitPadEditMode(), PCB_SELECTION_TOOL::FindItem(), FindSnapGraphic(), FindSnapPad(), FindSnapTrack(), FOOTPRINT_PREVIEW_PANEL::fitToCurrentFootprint(), PCB_BASE_FRAME::FocusOnItems(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME(), FOOTPRINT_PREVIEW_PANEL::GetBackgroundColor(), FOOTPRINT_PREVIEW_PANEL::GetForegroundColor(), PCB_TUNING_PATTERN::GetPreviewItems(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), PCB_BASE_FRAME::HideSolderMask(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), FOOTPRINT_EDIT_FRAME::installFootprintTabBoard(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_BASE_FRAME::LoadSettings(), FOOTPRINT_PREVIEW_PANEL::New(), DIALOG_FP_EDIT_PAD_TABLE::OnAddRow(), PCB_EDIT_FRAME::OnBoardLoaded(), DIALOG_FP_EDIT_PAD_TABLE::OnDeleteRow(), DIALOG_FP_EDIT_PAD_TABLE::OnImportButtonClick(), PCB_EDIT_FRAME::OnNetlistChanged(), DIALOG_FP_EDIT_PAD_TABLE::OnSelectCell(), PCB_EDIT_FRAME::onVariantSelected(), ZONE_PREVIEW_NOTEBOOK::OnZoneSelectionChanged(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::redrawNetnames(), ZONE_FILLER_TOOL::refresh(), FOOTPRINT_PREVIEW_PANEL::RefreshAll(), PCB_EDIT_FRAME::RefreshDrillSymbols(), DISPLAY_FOOTPRINTS_FRAME::ReloadFootprint(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), PCB_EDIT_FRAME::ResolveDRCExclusions(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), DIALOG_FP_EDIT_PAD_TABLE::restoreOriginalPadData(), DIALOG_FP_EDIT_PAD_TABLE::RestoreOriginalPadState(), PCB_BASE_EDIT_FRAME::RollbackFromUndo(), PCB_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetBoard(), PCB_EDIT_FRAME::SetElementVisibility(), PCB_EDIT_FRAME::SetPageSettings(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_BASE_EDIT_FRAME::ShowReferenceImagePropertiesDialog(), PCB_BASE_FRAME::ShowSolderMask(), DIALOG_FP_EDIT_PAD_TABLE::TransferDataFromWindow(), FOOTPRINT_EDIT_FRAME::updateEnabledLayers(), FOOTPRINT_EDIT_FRAME::updateInfoBar(), PCB_EDIT_FRAME::UpdateUserInterface(), ViaSnapRange(), GLOBAL_EDIT_TOOL::ZonesManager(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ GetViewControls()

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

Return a pointer to the KIGFX::VIEW_CONTROLS instance used in the panel.

Returns
The instance of KIGFX::VIEW_CONTROLS.

Definition at line 164 of file class_draw_panel_gal.h.

References m_viewControls.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), EDA_DRAW_FRAME::CommonSettingsChanged(), FOOTPRINT_EDITOR_CONTROL::CreateFootprintFromWizard(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_FRAME::FocusOnLocation(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_BASE_FRAME::RedrawScreen(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), PL_EDITOR_FRAME::UpdateStatusBar(), and SCH_BASE_FRAME::UpdateStatusBar().

◆ handleContextLoss()

bool EDA_DRAW_PANEL_GAL::handleContextLoss ( )
protectedinherited

Replace a GAL whose context was destroyed by a GPU reset.

Returns
true if the GAL was replaced, so the current repaint must stop.

Definition at line 273 of file draw_panel_gal.cpp.

References _, GAL_FALLBACK, GAL_FALLBACK_AVAILABLE, GAL_TYPE_NONE, m_backend, m_gal, m_rebuiltAfterReset, m_refreshTimer, KIGFX::NONE, KIGFX::RECOVERABLE, KIGFX::REPEATED, EDA_DRAW_FRAME::SetOpenGLFailureOccurred(), showMessageLater(), StartDrawing(), SwitchBackend(), and traceGalContext.

Referenced by DoRePaint(), and recoverFromGalError().

◆ IsDialogPreview()

bool EDA_DRAW_PANEL_GAL::IsDialogPreview ( ) const
inlineinherited

Definition at line 250 of file class_draw_panel_gal.h.

References m_edaFrame, and m_parent.

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

◆ LockZoom()

void ZONE_PREVIEW_CANVAS::LockZoom ( double aScale,
const VECTOR2D & aCenter )

Definition at line 215 of file zone_preview_canvas.cpp.

References EDA_DRAW_PANEL_GAL::m_view, m_zoomLocked, and EDA_DRAW_PANEL_GAL::RequestRefresh().

Referenced by ZONE_PREVIEW_NOTEBOOK::OnZoneSelectionChanged().

◆ onEnter()

void EDA_DRAW_PANEL_GAL::onEnter ( wxMouseEvent & aEvent)
protectedinherited

Definition at line 979 of file draw_panel_gal.cpp.

References KIUI::IsInputControlFocused(), KIUI::IsModalDialogFocused(), KIPLATFORM::UI::IsWindowActive(), m_edaFrame, m_stealsFocus, and SetFocus().

Referenced by 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 960 of file draw_panel_gal.cpp.

References KIUI::IsInputControlFocused(), KIUI::IsModalDialogFocused(), KIPLATFORM::UI::IsWindowActive(), m_edaFrame, m_eventDispatcher, m_lostFocus, m_stealsFocus, Refresh(), and SetFocus().

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

◆ onIdle()

void EDA_DRAW_PANEL_GAL::onIdle ( wxIdleEvent & aEvent)
protectedinherited

Definition at line 1010 of file draw_panel_gal.cpp.

References m_needIdleRefresh, and Refresh().

Referenced by ForceRefresh(), and StopDrawing().

◆ onLostFocus()

void EDA_DRAW_PANEL_GAL::onLostFocus ( wxFocusEvent & aEvent)
protectedinherited

Definition at line 994 of file draw_panel_gal.cpp.

References m_eventDispatcher, m_lostFocus, and m_viewControls.

Referenced by EDA_DRAW_PANEL_GAL().

◆ onPaint()

void EDA_DRAW_PANEL_GAL::onPaint ( wxPaintEvent & WXUNUSEDaEvent)
protectedvirtualinherited

Reimplemented in SCH_DRAW_PANEL, and SCH_PREVIEW_PANEL.

Definition at line 197 of file draw_panel_gal.cpp.

References DoRePaint().

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

◆ onRefreshTimer()

void EDA_DRAW_PANEL_GAL::onRefreshTimer ( wxTimerEvent & aEvent)
protectedinherited

Definition at line 1022 of file draw_panel_gal.cpp.

References ForceRefresh().

Referenced by EDA_DRAW_PANEL_GAL().

◆ OnShow()

void PCB_DRAW_PANEL_GAL::OnShow ( )
overridevirtualinherited

Called when the window is shown for the first time.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 659 of file pcb_draw_panel_gal.cpp.

References PCB_BASE_FRAME::ActivateGalCanvas(), DisplayError(), EDA_DRAW_PANEL_GAL::GAL_FALLBACK, PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetDisplayOptions(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), PCB_BASE_FRAME::GetPcbNewSettings(), KIGFX::PCB_PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::IsDialogPreview(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), EDA_DRAW_PANEL_GAL::m_backend, PCBNEW_SETTINGS::m_Display, KIGFX::PCB_RENDER_SETTINGS::m_ForceShowFieldsWhenFPSelected, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_ForceShowFieldsWhenFPSelected, EDA_DRAW_PANEL_GAL::m_view, SetTopLayer(), and SwitchBackend().

◆ onShowEvent()

void EDA_DRAW_PANEL_GAL::onShowEvent ( wxShowEvent & aEvent)
protectedinherited

Definition at line 1028 of file draw_panel_gal.cpp.

References m_gal, and OnShow().

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

◆ onSize()

void EDA_DRAW_PANEL_GAL::onSize ( wxSizeEvent & aEvent)
protectedinherited

Definition at line 585 of file draw_panel_gal.cpp.

References ResizeGal().

Referenced by EDA_DRAW_PANEL_GAL().

◆ prepareGridSources()

void PCB_DRAW_PANEL_GAL::prepareGridSources ( )
overridevirtualinherited

Push a GRID_SOURCE for every PCB_GRIDITEM on the board to the GAL.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 353 of file pcb_draw_panel_gal.cpp.

References KIGFX::GRID_SOURCE::color, BOARD::Drawings(), BOARD_ITEM::GetBoard(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), grid, KIGFX::GRID_SOURCE::highlighted, BOARD::IsElementVisible(), LAYER_SUBGRIDS, EDA_DRAW_PANEL_GAL::m_gal, PCB_GRID_ITEM_T, GRID_GEOMETRY::pitch, KIGFX::GRID_SOURCE::snapCursor, KIGFX::GRID_SOURCE::style, KIGFX::GRID_SOURCE::tick, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ recoverFromGalError()

bool EDA_DRAW_PANEL_GAL::recoverFromGalError ( const std::exception & aErr)
protectedinherited

Definition at line 203 of file draw_panel_gal.cpp.

References _, GAL_FALLBACK, GAL_FALLBACK_AVAILABLE, GAL_TYPE_NONE, handleContextLoss(), m_backend, m_gal, m_glRecoveryAttempted, m_rebuiltAfterReset, EDA_DRAW_FRAME::SetOpenGLFailureOccurred(), showMessageLater(), StartDrawing(), and SwitchBackend().

Referenced by DoRePaint().

◆ RedrawRatsnest()

void PCB_DRAW_PANEL_GAL::RedrawRatsnest ( )
inherited

Force refresh of the ratsnest visual representation.

Definition at line 742 of file pcb_draw_panel_gal.cpp.

References m_ratsnest, and EDA_DRAW_PANEL_GAL::m_view.

Referenced by PCB_EDIT_FRAME::HardRedraw(), BOARD_COMMIT::Push(), PCB_CONTROL::RatsnestModeCycle(), PCB_BASE_FRAME::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), PCB_CONTROL::ToggleRatsnest(), and GLOBAL_EDIT_TOOL::ZonesManager().

◆ Refresh()

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

Reimplemented in SCH_PREVIEW_PANEL.

Definition at line 656 of file draw_panel_gal.cpp.

References delta, DoRePaint(), m_gal, m_lastRepaintStart, m_refreshTimer, and RequestRefresh().

Referenced by PCB_EDIT_FRAME::ActivateGalCanvas(), SYMBOL_EDIT_FRAME::activateSymbolTab(), SCH_EDIT_FRAME::AnnotateSymbols(), WIDGET_DIFF_CANVAS::CenterOnHighlight(), GERBVIEW_CONTROL::ClearAllLayers(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), PCB_BASE_EDIT_FRAME::configureToolbars(), FOOTPRINT_EDITOR_CONTROL::CreateFootprintFromWizard(), COMMON_TOOLS::doCenter(), SCH_EDIT_FRAME::EditVariantDescription(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_PREVIEW_PANEL::fitToCurrentFootprint(), PCB_BASE_FRAME::FocusOnItems(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), PCB_VIEWER_TOOLS::GraphicOutlines(), API_HANDLER_SCH::handleDeleteVariant(), PCB_EDIT_FRAME::HandleRemoteNetHighlight(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), PL_EDITOR_FRAME::HardRedraw(), GERBVIEW_CONTROL::HighlightControl(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), POSITION_RELATIVE_TOOL::InteractiveOffset(), SCH_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), GERBVIEW_CONTROL::LoadZipfile(), PCB_VIEWER_TOOLS::MeasureTool(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), OnEvent(), PANEL_COMPONENT_CLASS_ASSIGNMENT::OnHighlightItemsClick(), onIdle(), SCH_EDIT_FRAME::OnModify(), PCB_EDIT_FRAME::OnNetlistChanged(), SCH_EDIT_FRAME::onNetNavigatorSelection(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), GERBVIEW_FRAME::OnSelectActiveDCode(), GERBVIEW_FRAME::OnSelectActiveLayer(), PL_EDITOR_FRAME::OnSelectCoordOriginCorner(), PL_EDITOR_FRAME::OnSelectPage(), PCB_EDIT_FRAME::onVariantSelected(), GERBVIEW_CONTROL::OpenJobFile(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), GERBVIEW_CONTROL::OpenZipFile(), PCB_VIEWER_TOOLS::PadDisplayMode(), ROUTER_TOOL::performRouting(), ROUTER_TOOL::prepareInteractive(), PCB_CONTROL::RatsnestModeCycle(), WIDGET_DIFF_CANVAS::rebuildOverlay(), SYMBOL_EDIT_FRAME::RebuildView(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_WIZARD_FRAME::ReCreateParameterList(), SCH_BASE_FRAME::RedrawScreen(), SCH_PREVIEW_PANEL::Refresh(), ZONE_FILLER_TOOL::refresh(), EDA_DRAW_FRAME::RefreshCanvas(), PCB_EDIT_FRAME::RefreshDrillSymbols(), SCH_EDIT_FRAME::RefreshErcMarkers(), FOOTPRINT_WIZARD_FRAME::RegenerateFootprint(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), GERBVIEW_CONTROL::ReloadAllLayers(), DISPLAY_FOOTPRINTS_FRAME::ReloadFootprint(), GERBVIEW_FRAME::RemapLayers(), SCH_EDIT_FRAME::RemoveVariant(), SCH_EDITOR_CONTROL::ReplaceTerminalPin(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PCB_BASE_EDIT_FRAME::RollbackFromUndo(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SCH_EDIT_FRAME::SaveProject(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), GERBVIEW_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), WIDGET_DIFF_CANVAS::SetContextPainter(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_BASE_FRAME::SetDisplayOptions(), EDA_DRAW_FRAME::SetGridVisibility(), GERBVIEW_FRAME::SetLayerDrawPrms(), PCB_BASE_FRAME::SetPlotSettings(), SYMBOL_VIEWER_FRAME::SetSelectedLibrary(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_VIEWER_TOOLS::ShowPadNumbers(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SCH_EDIT_FRAME::subscribeConnectivity(), SCH_DRAW_PANEL::SwitchBackend(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), PCB_VIEWER_TOOLS::TextOutlines(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), PANEL_ASSIGN_COMPONENT_CLASSES::Validate(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), GLOBAL_EDIT_TOOL::ZonesManager(), COMMON_TOOLS::ZoomFitBox(), ZONE_PREVIEW_CANVAS::ZoomFitScreen(), and WIDGET_DIFF_CANVAS::ZoomToBBox().

◆ RequestRefresh()

void EDA_DRAW_PANEL_GAL::RequestRefresh ( )
inherited

Make sure a refresh gets done on the next idle event if it hasn't already.

Definition at line 650 of file draw_panel_gal.cpp.

References m_needIdleRefresh.

Referenced by DoRePaint(), ZONE_PREVIEW_CANVAS::LockZoom(), Refresh(), ResizeGal(), PCB_EDIT_FRAME::SetActiveLayer(), ZONE_PREVIEW_CANVAS::ZONE_PREVIEW_CANVAS(), and ZONE_PREVIEW_CANVAS::ZoomFitScreen().

◆ ResizeGal()

void EDA_DRAW_PANEL_GAL::ResizeGal ( bool aForce = false)
inherited

Resize the GAL to the current client size of this panel.

This must be used in preference to calling GAL::ResizeScreen() directly: it holds the GL context lock while the compositor buffers are reallocated, clamps degenerate sizes and invalidates the view.

Parameters
aForcereallocates even when the client size is unchanged, which is required after a display scale factor change because the buffers are sized in native pixels rather than client units.

Definition at line 591 of file draw_panel_gal.cpp.

References m_gal, m_pendingResize, m_view, RequestRefresh(), and ToVECTOR2I().

Referenced by DoRePaint(), EDA_DRAW_FRAME::OnMove(), and onSize().

◆ ResolveStoredCanvasType()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_PANEL_GAL::ResolveStoredCanvasType ( int aStoredCanvasType)
staticinherited

Convert a stored canvas type setting into a backend that can actually be used.

A settings file may have been written by hand or by another version of KiCad, so a value outside the supported range is bad data rather than a programming error. It resolves to the accelerated canvas, as does the retired wxDC canvas (GAL_TYPE_NONE).

Parameters
aStoredCanvasTypeis the raw COMMON_SETTINGS graphics.canvas_type value.
Returns
a GAL type that SwitchBackend() implements.

Definition at line 779 of file draw_panel_gal.cpp.

References GAL_TYPE_CAIRO, and GAL_TYPE_OPENGL.

Referenced by PANEL_COMMON_SETTINGS::applySettingsToPanel(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), EDA_DRAW_FRAME::loadCanvasTypeSetting(), FOOTPRINT_PREVIEW_PANEL::New(), and PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS().

◆ SetCurrentCursor()

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( KICURSOR aCursor)
inherited

Set the current cursor shape for this panel.

Definition at line 1037 of file draw_panel_gal.cpp.

References DPI_SCALING_COMMON::GetContentScaleFactor(), m_gal, and m_parent.

Referenced by EDIT_TOOL::doMoveSelection(), PAD_TOOL::EnumeratePads(), PCB_VIEWER_TOOLS::MeasureTool(), and SwitchBackend().

◆ setDefaultLayerDeps()

void PCB_DRAW_PANEL_GAL::setDefaultLayerDeps ( )
protectedinherited

Set rendering targets & dependencies for layers.

Definition at line 758 of file pcb_draw_panel_gal.cpp.

References BITMAP_LAYER_FOR, CLEARANCE_LAYER_FOR, DRILL_SYMBOL_LAYER_FOR, GAL_LAYER_ORDER, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, GetNetnameLayer(), IsCopperLayer(), IsNetnameLayer(), IsNonCopperLayer(), LAYER_ANCHOR, LAYER_BOARD_OUTLINE_AREA, LAYER_CONFLICTS_SHADOW, LAYER_CONSTRAINT_SHADOW, LAYER_DRAWINGSHEET, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_DRILL_SYMBOL_END, LAYER_DRILL_SYMBOL_START, LAYER_GP_OVERLAY, LAYER_GRID, LAYER_LOCKED_ITEM_SHADOW, LAYER_MARKER_SHADOWS, LAYER_NON_PLATEDHOLES, LAYER_PAD_HOLEWALLS, LAYER_PAD_NETNAMES, LAYER_PAD_PLATEDHOLES, LAYER_PADS, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_UI_END, LAYER_UI_START, LAYER_VIA_BLIND, LAYER_VIA_BURIED, LAYER_VIA_HOLES, LAYER_VIA_HOLEWALLS, LAYER_VIA_MICROVIA, LAYER_VIA_NETNAMES, LAYER_VIA_THROUGH, LAYER_VIAS, EDA_DRAW_PANEL_GAL::m_backend, EDA_DRAW_PANEL_GAL::m_view, PAD_COPPER_LAYER_FOR, POINT_LAYER_FOR, KIGFX::TARGET_CACHED, KIGFX::TARGET_NONCACHED, KIGFX::TARGET_OVERLAY, VIA_COPPER_LAYER_FOR, KIGFX::VIEW::VIEW_MAX_LAYERS, and ZONE_LAYER_FOR.

Referenced by PCB_DRAW_PANEL_GAL(), and SwitchBackend().

◆ setDefaultLayerOrder()

void PCB_DRAW_PANEL_GAL::setDefaultLayerOrder ( )
protectedinherited

Reassign layer order to the initial settings.

Definition at line 727 of file pcb_draw_panel_gal.cpp.

References ApplyPcbGalLayerOrder(), and EDA_DRAW_PANEL_GAL::m_view.

Referenced by PCB_DRAW_PANEL_GAL(), and SetTopLayer().

◆ SetDrawingSheet()

void PCB_DRAW_PANEL_GAL::SetDrawingSheet ( DS_PROXY_VIEW_ITEM * aDrawingSheet)
inherited

Set or update drawing-sheet used by the draw panel.

Parameters
aDrawingSheetis the drawing-sheet to be used. The object is then owned by PCB_DRAW_PANEL_GAL.

Definition at line 325 of file pcb_draw_panel_gal.cpp.

References m_drawingSheet, and EDA_DRAW_PANEL_GAL::m_view.

Referenced by PCB_EDIT_FRAME::SetPageSettings().

◆ SetEventDispatcher()

void EDA_DRAW_PANEL_GAL::SetEventDispatcher ( TOOL_DISPATCHER * aEventDispatcher)
inherited

Set a dispatcher that processes events and forwards them to tools.

EDA_DRAW_PANEL_GAL does not take over the ownership. Passing NULL disconnects all event handlers from the EDA_DRAW_PANEL_GAL and parent frame.

Parameters
aEventDispatcheris the object that will be used for dispatching events.

Definition at line 734 of file draw_panel_gal.cpp.

References m_eventDispatcher.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME(), FOOTPRINT_EDIT_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), and SYMBOL_VIEWER_FRAME::setupTools().

◆ SetFocus()

void EDA_DRAW_PANEL_GAL::SetFocus ( )
overrideinherited

Definition at line 189 of file draw_panel_gal.cpp.

References KIPLATFORM::UI::ImeNotifyCancelComposition(), and m_lostFocus.

Referenced by ZONE_CREATE_HELPER::createNewZone(), onEnter(), OnEvent(), WIDGET_DIFF_CANVAS::onLeftDown(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), PCB_EDIT_FRAME::SelectViaStack_Event(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), GERBVIEW_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), ZONE_FILLER_TOOL::singleShotRefocus(), PCB_EDIT_FRAME::ToggleSearch(), and PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event().

◆ SetHighContrastLayer() [1/2]

virtual void PCB_DRAW_PANEL_GAL::SetHighContrastLayer ( int aLayer)
inlineoverridevirtualinherited

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

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 77 of file pcb_draw_panel_gal.h.

References SetHighContrastLayer().

Referenced by FOOTPRINT_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), and SetHighContrastLayer().

◆ SetHighContrastLayer() [2/2]

void PCB_DRAW_PANEL_GAL::SetHighContrastLayer ( PCB_LAYER_ID aLayer)
inherited

SetHighContrastLayer(), with some extra smarts for PCB.

Definition at line 410 of file pcb_draw_panel_gal.cpp.

References B_Cu, BITMAP_LAYER_FOR, KIGFX::RENDER_SETTINGS::ClearHighContrastLayers(), F_Cu, GetNetnameLayer(), IsCopperLayer(), LAYER_ANCHOR, LAYER_CONFLICTS_SHADOW, LAYER_CONSTRAINT_SHADOW, LAYER_CURSOR, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_FOOTPRINTS_BK, LAYER_FOOTPRINTS_FR, LAYER_GP_OVERLAY, LAYER_LOCKED_ITEM_SHADOW, LAYER_MARKER_SHADOWS, LAYER_NON_PLATEDHOLES, LAYER_PAD_BK_NETNAMES, LAYER_PAD_FR_NETNAMES, LAYER_PAD_HOLEWALLS, LAYER_PAD_NETNAMES, LAYER_PAD_PLATEDHOLES, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_UI_END, LAYER_UI_START, LAYER_VIA_BLIND, LAYER_VIA_BURIED, LAYER_VIA_HOLES, LAYER_VIA_HOLEWALLS, LAYER_VIA_MICROVIA, LAYER_VIA_NETNAMES, LAYER_VIA_THROUGH, EDA_DRAW_PANEL_GAL::m_view, PAD_COPPER_LAYER_FOR, POINT_LAYER_FOR, KIGFX::RENDER_SETTINGS::SetActiveLayer(), KIGFX::RENDER_SETTINGS::SetLayerIsHighContrast(), SetTopLayer(), VIA_COPPER_LAYER_FOR, and ZONE_LAYER_FOR.

◆ SetStatusPopup()

void EDA_DRAW_PANEL_GAL::SetStatusPopup ( wxWindow * aPopup)
inlineinherited

Definition at line 111 of file class_draw_panel_gal.h.

References m_statusPopup.

Referenced by PAD_TOOL::EnumeratePads(), POSITION_RELATIVE_TOOL::InteractiveOffset(), MATCH_PROPERTIES_TOOL::runInteractive(), PCB_PICKER_TOOL::SelectItemInteractively(), and PCB_PICKER_TOOL::SelectPointInteractively().

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

References m_stealsFocus.

Referenced by SYMBOL_VIEWER_FRAME::ClickOnSymbolList(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), and SYMBOL_VIEWER_FRAME::SetSelectedLibrary().

◆ SetTopLayer() [1/2]

virtual void PCB_DRAW_PANEL_GAL::SetTopLayer ( int aLayer)
inlineoverridevirtualinherited

Move the selected layer to the top, so it is displayed above all others.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 86 of file pcb_draw_panel_gal.h.

References SetTopLayer().

Referenced by OnShow(), SetHighContrastLayer(), and SetTopLayer().

◆ SetTopLayer() [2/2]

void PCB_DRAW_PANEL_GAL::SetTopLayer ( PCB_LAYER_ID aLayer)
inherited

SetTopLayer(), with some extra smarts for PCB.

Definition at line 468 of file pcb_draw_panel_gal.cpp.

References B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, BITMAP_LAYER_FOR, CLEARANCE_LAYER_FOR, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, GetNetnameLayer(), IsBackLayer(), IsCopperLayer(), IsFrontLayer(), LAYER_ANCHOR, LAYER_CONFLICTS_SHADOW, LAYER_CONSTRAINT_SHADOW, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_HIGHLIGHTED, LAYER_DRC_WARNING, LAYER_GP_OVERLAY, LAYER_MARKER_SHADOWS, LAYER_NON_PLATEDHOLES, LAYER_PAD_BK_NETNAMES, LAYER_PAD_FR_NETNAMES, LAYER_PAD_HOLEWALLS, LAYER_PAD_NETNAMES, LAYER_PAD_PLATEDHOLES, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_UI_END, LAYER_UI_START, LAYER_VIA_BLIND, LAYER_VIA_BURIED, LAYER_VIA_HOLES, LAYER_VIA_HOLEWALLS, LAYER_VIA_MICROVIA, LAYER_VIA_NETNAMES, LAYER_VIA_THROUGH, EDA_DRAW_PANEL_GAL::m_view, NETNAMES_LAYER_INDEX, PAD_COPPER_LAYER_FOR, PCB_LAYER_ID_COUNT, POINT_LAYER_FOR, setDefaultLayerOrder(), VIA_COPPER_LAYER_FOR, and ZONE_LAYER_FOR.

◆ showMessageLater()

void EDA_DRAW_PANEL_GAL::showMessageLater ( const wxString & aTitle,
const wxString & aDetail,
bool aError )
protectedinherited

Show a recovery message once the current event finishes.

Recovery runs inside a repaint, where a modal dialog would stop every canvas from painting until it was closed.

Definition at line 332 of file draw_panel_gal.cpp.

References DisplayErrorMessage(), DisplayInfoMessage(), and m_parent.

Referenced by DoRePaint(), handleContextLoss(), recoverFromGalError(), and SwitchBackend().

◆ StartDrawing()

void EDA_DRAW_PANEL_GAL::StartDrawing ( )
inherited

Begin drawing if it was stopped previously.

Definition at line 740 of file draw_panel_gal.cpp.

References m_refreshTimer.

Referenced by EDA_DRAW_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), handleContextLoss(), recoverFromGalError(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), WIDGET_DIFF_CANVAS::WIDGET_DIFF_CANVAS(), and ZONE_PREVIEW_CANVAS::ZONE_PREVIEW_CANVAS().

◆ StatusPopupHasFocus()

bool EDA_DRAW_PANEL_GAL::StatusPopupHasFocus ( )
inlineinherited

Definition at line 106 of file class_draw_panel_gal.h.

References m_statusPopup.

◆ StopDrawing()

void EDA_DRAW_PANEL_GAL::StopDrawing ( )
inherited

Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.

Definition at line 747 of file draw_panel_gal.cpp.

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

Referenced by FOOTPRINT_EDIT_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), GERBVIEW_FRAME::doCloseWindow(), PCB_EDIT_FRAME::doCloseWindow(), SCH_BASE_FRAME::doCloseWindow(), DoRePaint(), SwitchBackend(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), ~EDA_DRAW_PANEL_GAL(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME(), SCH_EDIT_FRAME::~SCH_EDIT_FRAME(), and WIDGET_DIFF_CANVAS::~WIDGET_DIFF_CANVAS().

◆ SwitchBackend()

bool PCB_DRAW_PANEL_GAL::SwitchBackend ( GAL_TYPE aGalType)
overridevirtualinherited

Switch 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 733 of file pcb_draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_gal, setDefaultLayerDeps(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

Referenced by OnShow().

◆ SyncLayersVisibility()

void PCB_DRAW_PANEL_GAL::SyncLayersVisibility ( const BOARD * aBoard)
inherited

Update "visibility" property of each layer of a given BOARD.

Parameters
aBoardcontains layers visibility settings to be applied.

Definition at line 560 of file pcb_draw_panel_gal.cpp.

References GAL_LAYER_ID_END, GAL_LAYER_ID_START, BOARD::IsElementVisible(), BOARD::IsLayerVisible(), LAYER_BITMAP_END, LAYER_BITMAP_START, LAYER_CLEARANCE_END, LAYER_CLEARANCE_START, LAYER_DRC_HIGHLIGHTED, LAYER_DRILL_SYMBOL_END, LAYER_DRILL_SYMBOL_START, LAYER_GP_OVERLAY, LAYER_MARKER_SHADOWS, LAYER_NON_PLATEDHOLES, LAYER_PAD_COPPER_END, LAYER_PAD_COPPER_START, LAYER_PAD_HOLEWALLS, LAYER_PAD_PLATEDHOLES, LAYER_POINT_END, LAYER_POINT_START, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_UI_END, LAYER_UI_START, LAYER_VIA_BLIND, LAYER_VIA_BURIED, LAYER_VIA_COPPER_END, LAYER_VIA_COPPER_START, LAYER_VIA_HOLES, LAYER_VIA_HOLEWALLS, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, LAYER_ZONE_END, LAYER_ZONE_START, EDA_DRAW_PANEL_GAL::m_view, NETNAMES_LAYER_ID_END, NETNAMES_LAYER_ID_START, and PCB_LAYER_ID_COUNT.

Referenced by PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), API_HANDLER_BOARD::handleSetVisibleLayers(), and PCB_EDIT_FRAME::OnBoardLoaded().

◆ UnlockZoom()

void ZONE_PREVIEW_CANVAS::UnlockZoom ( )

Definition at line 224 of file zone_preview_canvas.cpp.

References m_zoomLocked.

Referenced by ZONE_PREVIEW_CANVAS().

◆ UpdateColors()

void PCB_DRAW_PANEL_GAL::UpdateColors ( )
inherited

Update the color settings in the painter and GAL.

Definition at line 332 of file pcb_draw_panel_gal.cpp.

References DEFAULT_THEME, GetAppSettings(), COLOR_SETTINGS::GetColor(), GetColorSettings(), PCB_BASE_FRAME::GetColorSettings(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), LAYER_CURSOR, LAYER_GRID, LAYER_GRID_AXES, KIGFX::PCB_RENDER_SETTINGS::LoadColors(), EDA_DRAW_PANEL_GAL::m_gal, and EDA_DRAW_PANEL_GAL::m_view.

Referenced by PCB_EDIT_FRAME::ActivateGalCanvas(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), FOOTPRINT_EDIT_FRAME::installFootprintTabBoard(), FOOTPRINT_PREVIEW_PANEL::New(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), PCB_BASE_EDIT_FRAME::SetBoard(), FOOTPRINT_EDIT_FRAME::UpdateView(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), and ZONE_PREVIEW_CANVAS::ZONE_PREVIEW_CANVAS().

◆ UpdateOverlayExclusions()

void EDA_DRAW_PANEL_GAL::UpdateOverlayExclusions ( )
inherited

Tell the backend which areas of this panel are covered by an overlaid infobar.

Must be called whenever an infobar is shown, hidden or moved.

Definition at line 630 of file draw_panel_gal.cpp.

References m_gal, and KIGFX::CAIRO_GAL::SetOverlayExclusions().

Referenced by SwitchBackend().

◆ UpdateTouchpadGestureHandler()

void EDA_DRAW_PANEL_GAL::UpdateTouchpadGestureHandler ( )
inherited

Apply the current native touchpad gesture preference to the active backend window.

Definition at line 936 of file draw_panel_gal.cpp.

References KIPLATFORM::UI::CreateTouchpadGestureHandler(), m_gal, m_touchpadGestureHandler, m_viewControls, NATIVE_GESTURES, KIPLATFORM::UI::TOUCHPAD_GESTURE::panX, KIPLATFORM::UI::TOUCHPAD_GESTURE::panY, Pgm(), KIPLATFORM::UI::TOUCHPAD_GESTURE::zoomAnchor, and KIPLATFORM::UI::TOUCHPAD_GESTURE::zoomFactor.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), and SwitchBackend().

◆ ZoomFitScreen()

void ZONE_PREVIEW_CANVAS::ZoomFitScreen ( )

Definition at line 187 of file zone_preview_canvas.cpp.

References BOX2< Vec >::Centre(), PCB_DRAW_PANEL_GAL::GetDefaultViewBBox(), GetDocumentExtents(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetSize(), BOX2< Vec >::GetWidth(), EDA_DRAW_PANEL_GAL::m_view, EDA_DRAW_PANEL_GAL::Refresh(), EDA_DRAW_PANEL_GAL::RequestRefresh(), scale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ZONE_PREVIEW_NOTEBOOK::FitCanvasToScreen(), ZONE_PREVIEW_NOTEBOOK::OnZoneSelectionChanged(), and ZONE_PREVIEW_CANVAS().

Member Data Documentation

◆ GAL_FALLBACK

GAL_TYPE EDA_DRAW_PANEL_GAL::GAL_FALLBACK = GAL_TYPE_CAIRO
staticconstexprinherited

Definition at line 81 of file class_draw_panel_gal.h.

Referenced by DIALOG_BARCODE_PROPERTIES_BASE::DIALOG_BARCODE_PROPERTIES_BASE(), DIALOG_KICAD_DIFF::DIALOG_KICAD_DIFF(), EVT_UPDATE_UI_RANGE(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME(), handleContextLoss(), PCB_DRAW_PANEL_GAL::OnShow(), SCH_DRAW_PANEL::OnShow(), recoverFromGalError(), EDA_DRAW_FRAME::resolveCanvasType(), FOOTPRINT_EDIT_FRAME::resolveCanvasType(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::SCH_DESIGN_BLOCK_PREVIEW_WIDGET(), SwitchBackend(), and SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET().

◆ GAL_FALLBACK_AVAILABLE

bool EDA_DRAW_PANEL_GAL::GAL_FALLBACK_AVAILABLE = GAL_FALLBACK != GAL_TYPE_OPENGL
staticconstexprinherited

Definition at line 83 of file class_draw_panel_gal.h.

Referenced by handleContextLoss(), recoverFromGalError(), and SwitchBackend().

◆ m_backend

GAL_TYPE EDA_DRAW_PANEL_GAL::m_backend
protectedinherited

Currently used GAL.

Definition at line 386 of file class_draw_panel_gal.h.

Referenced by DoRePaint(), EDA_DRAW_PANEL_GAL(), GetBackend(), GetScreenshot(), handleContextLoss(), PCB_DRAW_PANEL_GAL::OnShow(), SCH_DRAW_PANEL::OnShow(), recoverFromGalError(), GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), SCH_DRAW_PANEL::setDefaultLayerDeps(), SwitchBackend(), and WIDGET_DIFF_CANVAS::WIDGET_DIFF_CANVAS().

◆ m_contextBindFailures

int EDA_DRAW_PANEL_GAL::m_contextBindFailures
protectedinherited

Consecutive frames dropped because the GL context could not be made current.

Definition at line 400 of file class_draw_panel_gal.h.

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

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

Referenced by ClearDebugOverlay(), and DebugOverlay().

◆ m_drawing

bool EDA_DRAW_PANEL_GAL::m_drawing
protectedinherited

True if GAL is currently redrawing the view.

Definition at line 362 of file class_draw_panel_gal.h.

Referenced by DoRePaint(), EDA_DRAW_PANEL_GAL(), and ~EDA_DRAW_PANEL_GAL().

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

Referenced by DoRePaint(), EDA_DRAW_PANEL_GAL(), ForceRefresh(), and StopDrawing().

◆ m_drawingSheet

std::unique_ptr<DS_PROXY_VIEW_ITEM> PCB_DRAW_PANEL_GAL::m_drawingSheet
protectedinherited

Currently used drawing-sheet.

Definition at line 125 of file pcb_draw_panel_gal.h.

Referenced by DisplayBoard(), GetDefaultViewBBox(), GetDrawingSheet(), and SetDrawingSheet().

◆ m_edaFrame

EDA_DRAW_FRAME* EDA_DRAW_PANEL_GAL::m_edaFrame
protectedinherited

Parent EDA_DRAW_FRAME (if available)

Definition at line 353 of file class_draw_panel_gal.h.

Referenced by PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), EDA_DRAW_PANEL_GAL(), GetParentEDAFrame(), IsDialogPreview(), onEnter(), and OnEvent().

◆ m_eventDispatcher

TOOL_DISPATCHER* EDA_DRAW_PANEL_GAL::m_eventDispatcher
protectedinherited

Processes and forwards events to tools.

Definition at line 390 of file class_draw_panel_gal.h.

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

◆ m_gal

KIGFX::GAL* EDA_DRAW_PANEL_GAL::m_gal
protectedinherited

Interface for drawing objects on a 2D-surface.

Definition at line 374 of file class_draw_panel_gal.h.

Referenced by DoRePaint(), EDA_DRAW_PANEL_GAL(), ForceRefresh(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), GetGAL(), GetScreenshot(), handleContextLoss(), SCH_DRAW_PANEL::onPaint(), onShowEvent(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), PCB_DRAW_PANEL_GAL::prepareGridSources(), recoverFromGalError(), Refresh(), ResizeGal(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), SetCurrentCursor(), WIDGET_DIFF_CANVAS::SetWorldUnitLength(), SwitchBackend(), PCB_DRAW_PANEL_GAL::SwitchBackend(), SCH_DRAW_PANEL::SwitchBackend(), PCB_DRAW_PANEL_GAL::UpdateColors(), UpdateOverlayExclusions(), UpdateTouchpadGestureHandler(), WIDGET_DIFF_CANVAS::WIDGET_DIFF_CANVAS(), ZONE_PREVIEW_CANVAS::ZONE_PREVIEW_CANVAS(), and ~EDA_DRAW_PANEL_GAL().

◆ m_glRecoveryAttempted

bool EDA_DRAW_PANEL_GAL::m_glRecoveryAttempted
protectedinherited

Set after an OpenGL recovery attempt to prevent infinite retry loops.

Definition at line 397 of file class_draw_panel_gal.h.

Referenced by DoRePaint(), EDA_DRAW_PANEL_GAL(), and recoverFromGalError().

◆ m_lastCursorPosition

VECTOR2D EDA_DRAW_PANEL_GAL::m_lastCursorPosition
protectedinherited

Last cursor position sent to GAL for drawing.

Definition at line 371 of file class_draw_panel_gal.h.

Referenced by DoRePaint().

◆ m_lastRepaintEnd

std::chrono::steady_clock::time_point EDA_DRAW_PANEL_GAL::m_lastRepaintEnd
protectedinherited

Timestamp of the last repaint end.

Definition at line 356 of file class_draw_panel_gal.h.

Referenced by DoRePaint().

◆ m_lastRepaintStart

std::chrono::steady_clock::time_point EDA_DRAW_PANEL_GAL::m_lastRepaintStart
protectedinherited

Timestamp of the last repaint start.

Definition at line 355 of file class_draw_panel_gal.h.

Referenced by DoRePaint(), and 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 394 of file class_draw_panel_gal.h.

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

◆ m_MouseCapturedLost

bool EDA_DRAW_PANEL_GAL::m_MouseCapturedLost
inherited

used on wxMSW: true after a wxEVT_MOUSE_CAPTURE_LOST was received false after the mouse is recaptured.

Used to avoid calling twice a CaptureMouse(), not accepted by wxMSW

Definition at line 316 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL().

◆ m_needIdleRefresh

bool EDA_DRAW_PANEL_GAL::m_needIdleRefresh
protectedinherited

True when canvas needs to be refreshed from idle handler.

Definition at line 368 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), onIdle(), and RequestRefresh().

◆ m_options

KIGFX::GAL_DISPLAY_OPTIONS& EDA_DRAW_PANEL_GAL::m_options
protectedinherited

Definition at line 387 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), and SwitchBackend().

◆ m_painter

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

Contains information about how to draw items using GAL.

Definition at line 380 of file class_draw_panel_gal.h.

Referenced by DoRePaint(), EDA_DRAW_PANEL_GAL(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), SCH_PREVIEW_PANEL::GetRenderSettings(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), WIDGET_DIFF_CANVAS::SetContextPainter(), SwitchBackend(), WIDGET_DIFF_CANVAS::WIDGET_DIFF_CANVAS(), and ZONE_PREVIEW_CANVAS::ZONE_PREVIEW_CANVAS().

◆ m_PaintEventCounter

std::unique_ptr<PROF_COUNTER> EDA_DRAW_PANEL_GAL::m_PaintEventCounter
inherited

Definition at line 318 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL().

◆ m_parent

wxWindow* EDA_DRAW_PANEL_GAL::m_parent
protectedinherited

Pointer to the parent window.

Definition at line 352 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), IsDialogPreview(), SetCurrentCursor(), and showMessageLater().

◆ m_pcb

BOARD* ZONE_PREVIEW_CANVAS::m_pcb
private

Definition at line 52 of file zone_preview_canvas.h.

Referenced by GetBoardBoundingBox(), GetDocumentExtents(), GetPageSizeIU(), and ZONE_PREVIEW_CANVAS().

◆ m_pcb_bounding_box

std::unique_ptr<BOARD_EDGES_BOUNDING_ITEM> ZONE_PREVIEW_CANVAS::m_pcb_bounding_box
private

Definition at line 53 of file zone_preview_canvas.h.

Referenced by ZONE_PREVIEW_CANVAS().

◆ m_pendingResize

bool EDA_DRAW_PANEL_GAL::m_pendingResize
protectedinherited

Set when a size change could not be applied because the GL context was unavailable.

Definition at line 406 of file class_draw_panel_gal.h.

Referenced by DoRePaint(), EDA_DRAW_PANEL_GAL(), ResizeGal(), and SwitchBackend().

◆ m_ratsnest

std::unique_ptr<RATSNEST_VIEW_ITEM> PCB_DRAW_PANEL_GAL::m_ratsnest
protectedinherited

Ratsnest view item.

Definition at line 126 of file pcb_draw_panel_gal.h.

Referenced by DisplayBoard(), and RedrawRatsnest().

◆ m_rebuiltAfterReset

bool EDA_DRAW_PANEL_GAL::m_rebuiltAfterReset
protectedinherited

The GAL was rebuilt after a GPU reset and has not completed a frame yet.

Definition at line 403 of file class_draw_panel_gal.h.

Referenced by DoRePaint(), EDA_DRAW_PANEL_GAL(), handleContextLoss(), and recoverFromGalError().

◆ m_refreshMutex

std::mutex EDA_DRAW_PANEL_GAL::m_refreshMutex
protectedinherited

Blocks multiple calls to the draw.

Definition at line 359 of file class_draw_panel_gal.h.

Referenced by DoRePaint().

◆ m_refreshTimer

wxTimer EDA_DRAW_PANEL_GAL::m_refreshTimer
protectedinherited

Timer to prevent too-frequent refreshing.

Definition at line 357 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), ForceRefresh(), handleContextLoss(), Refresh(), StartDrawing(), and StopDrawing().

◆ m_statusPopup

wxWindow* EDA_DRAW_PANEL_GAL::m_statusPopup
protectedinherited

Definition at line 412 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), SetStatusPopup(), and StatusPopupHasFocus().

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

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

◆ m_touchpadGestureHandler

std::unique_ptr<KIPLATFORM::UI::TOUCHPAD_GESTURE_HANDLER> EDA_DRAW_PANEL_GAL::m_touchpadGestureHandler
protectedinherited

Definition at line 417 of file class_draw_panel_gal.h.

Referenced by SwitchBackend(), UpdateTouchpadGestureHandler(), and ~EDA_DRAW_PANEL_GAL().

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

Referenced by WIDGET_DIFF_CANVAS::CenterOnHighlight(), ClearDebugOverlay(), DebugOverlay(), PCB_DRAW_PANEL_GAL::DisplayBoard(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), DoRePaint(), EDA_DRAW_PANEL_GAL(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), GERBVIEW_DRAW_PANEL_GAL::GetDefaultViewBBox(), PCB_DRAW_PANEL_GAL::GetDefaultViewBBox(), GetView(), PCB_DRAW_PANEL_GAL::GetView(), SCH_DRAW_PANEL::GetView(), ZONE_PREVIEW_CANVAS::LockZoom(), WIDGET_DIFF_CANVAS::onDoubleClick(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), PCB_DRAW_PANEL_GAL::OnShow(), SCH_DRAW_PANEL::OnShow(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), WIDGET_DIFF_CANVAS::rebuildOverlay(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), WIDGET_DIFF_CANVAS::refreshItemDimming(), ResizeGal(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), WIDGET_DIFF_CANVAS::SetCategoryVisible(), WIDGET_DIFF_CANVAS::SetContextItems(), WIDGET_DIFF_CANVAS::SetContextPainter(), GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), PL_DRAW_PANEL_GAL::setDefaultLayerDeps(), SCH_DRAW_PANEL::setDefaultLayerDeps(), SCH_PREVIEW_PANEL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::setDefaultLayerOrder(), SCH_DRAW_PANEL::setDefaultLayerOrder(), SCH_PREVIEW_PANEL::setDefaultLayerOrder(), GERBVIEW_DRAW_PANEL_GAL::SetDrawingSheet(), PCB_DRAW_PANEL_GAL::SetDrawingSheet(), SetHighContrastLayer(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), WIDGET_DIFF_CANVAS::SetItemCategories(), WIDGET_DIFF_CANVAS::SetLayerVisible(), SetTopLayer(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), PL_DRAW_PANEL_GAL::SetTopLayer(), WIDGET_DIFF_CANVAS::shapeAt(), SwitchBackend(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), PCB_DRAW_PANEL_GAL::UpdateColors(), SCH_PREVIEW_PANEL::view(), WIDGET_DIFF_CANVAS::WIDGET_DIFF_CANVAS(), ZONE_PREVIEW_CANVAS::ZONE_PREVIEW_CANVAS(), ZONE_PREVIEW_CANVAS::ZoomFitScreen(), WIDGET_DIFF_CANVAS::ZoomToBBox(), ~EDA_DRAW_PANEL_GAL(), and WIDGET_DIFF_CANVAS::~WIDGET_DIFF_CANVAS().

◆ m_viewControls

KIGFX::WX_VIEW_CONTROLS* EDA_DRAW_PANEL_GAL::m_viewControls
protectedinherited

Control for VIEW (moving, zooming, etc.)

Definition at line 383 of file class_draw_panel_gal.h.

Referenced by DoRePaint(), EDA_DRAW_PANEL_GAL(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), GetViewControls(), onLostFocus(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), UpdateTouchpadGestureHandler(), WIDGET_DIFF_CANVAS::WIDGET_DIFF_CANVAS(), and ~EDA_DRAW_PANEL_GAL().

◆ m_zone

std::unique_ptr<ZONE> ZONE_PREVIEW_CANVAS::m_zone
private

Definition at line 54 of file zone_preview_canvas.h.

Referenced by ZONE_PREVIEW_CANVAS().

◆ m_zoomLocked

bool ZONE_PREVIEW_CANVAS::m_zoomLocked
private

Definition at line 55 of file zone_preview_canvas.h.

Referenced by LockZoom(), UnlockZoom(), and ZONE_PREVIEW_CANVAS().

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