class_draw_panel_gal.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013-2018 CERN
 * Copyright (C) 2013-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 * @author Maciej Suminski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */

#ifndef PANELGAL_WXSTRUCT_H
#define PANELGAL_WXSTRUCT_H

#include <wx/window.h>
#include <wx/timer.h>
#include <wx/grid.h> // needed for MSVC to see wxScrolledCanvas indirectly exported
#include <math/box2.h>
#include <math/vector2d.h>
#include <widgets/msgpanel.h>
#include <memory>

#include <gal/cursors.h>

class BOARD;
class EDA_DRAW_FRAME;
class TOOL_DISPATCHER;
class PROF_COUNTER;

namespace KIGFX
{
class GAL;
class VIEW;
class WX_VIEW_CONTROLS;
class VIEW_CONTROLS;
class PAINTER;
class GAL_DISPLAY_OPTIONS;
class VIEW_OVERLAY;
}


class EDA_DRAW_PANEL_GAL : public wxScrolledCanvas
{
public:
 enum GAL_TYPE {
 GAL_TYPE_UNKNOWN = -1, 
 GAL_TYPE_NONE = 0, 
 GAL_TYPE_OPENGL, 
 GAL_TYPE_CAIRO, 
 GAL_TYPE_LAST 
 };

#ifdef __WXMAC__
 // Cairo doesn't work on OSX so we really have no fallback available.
 static constexpr GAL_TYPE GAL_FALLBACK = GAL_TYPE_OPENGL;
#else
 static constexpr GAL_TYPE GAL_FALLBACK = GAL_TYPE_CAIRO;
#endif

 EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
 const wxPoint& aPosition, const wxSize& aSize,
 KIGFX::GAL_DISPLAY_OPTIONS& aOptions,
 GAL_TYPE aGalType = GAL_TYPE_OPENGL );
 ~EDA_DRAW_PANEL_GAL();

 virtual void SetFocus() override;

 virtual bool SwitchBackend( GAL_TYPE aGalType );

 inline GAL_TYPE GetBackend() const { return m_backend; }

 KIGFX::GAL* GetGAL() const { return m_gal; }

 virtual KIGFX::VIEW* GetView() const { return m_view; }

 KIGFX::VIEW_CONTROLS* GetViewControls() const
 {
 return (KIGFX::VIEW_CONTROLS*)( m_viewControls );
 }

 virtual void Refresh( bool aEraseBackground = true, const wxRect* aRect = nullptr ) override;

 void ForceRefresh();

 void SetEventDispatcher( TOOL_DISPATCHER* aEventDispatcher );

 void StartDrawing();

 void StopDrawing();

 virtual void SetHighContrastLayer( int aLayer );

 virtual void SetTopLayer( int aLayer );

 virtual void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
 {
 wxASSERT( false );
 }

 EDA_DRAW_FRAME* GetParentEDAFrame() const { return m_edaFrame; }

 bool IsDialogPreview() const { return m_parent != (wxWindow*) m_edaFrame; }

 virtual void OnShow() {}

 void SetStealsFocus( bool aStealsFocus ) { m_stealsFocus = aStealsFocus; }

 void SetCurrentCursor( KICURSOR aCursor );

 virtual BOX2I GetDefaultViewBBox() const { return BOX2I(); }

 void OnEvent( wxEvent& aEvent );

 void DoRePaint();

 std::shared_ptr<KIGFX::VIEW_OVERLAY> DebugOverlay();


 void ClearDebugOverlay();

 bool m_MouseCapturedLost;

 std::unique_ptr<PROF_COUNTER> m_PaintEventCounter;

protected:
 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 );

 static const int MinRefreshPeriod = 17; 

 wxWindow* m_parent; 
 EDA_DRAW_FRAME* m_edaFrame; 

 wxLongLong m_lastRefresh; 
 bool m_pendingRefresh; 
 wxTimer m_refreshTimer; 

 bool m_drawing;

 bool m_drawingEnabled;

 wxTimer m_onShowTimer;

 KIGFX::GAL* m_gal;

 KIGFX::VIEW* m_view;

 std::unique_ptr<KIGFX::PAINTER> m_painter;

 KIGFX::WX_VIEW_CONTROLS* m_viewControls;

 GAL_TYPE m_backend;
 KIGFX::GAL_DISPLAY_OPTIONS& m_options;

 TOOL_DISPATCHER* m_eventDispatcher;

 bool m_lostFocus;

 bool m_stealsFocus;

 std::shared_ptr<KIGFX::VIEW_OVERLAY> m_debugOverlay;
};

#endif