312 lines
8.9 KiB
C++
312 lines
8.9 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2013-2018 CERN
|
|
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
|
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
/**
|
|
* @file class_draw_panel_gal.h:
|
|
* @brief EDA_DRAW_PANEL_GAL class definition.
|
|
*/
|
|
|
|
#ifndef PANELGAL_WXSTRUCT_H
|
|
#define PANELGAL_WXSTRUCT_H
|
|
|
|
#include <wx/window.h>
|
|
#include <wx/timer.h>
|
|
#include <math/box2.h>
|
|
#include <math/vector2d.h>
|
|
#include <msgpanel.h>
|
|
#include <memory>
|
|
|
|
class BOARD;
|
|
class EDA_DRAW_FRAME;
|
|
class TOOL_DISPATCHER;
|
|
|
|
namespace KIGFX
|
|
{
|
|
class GAL;
|
|
class VIEW;
|
|
class WX_VIEW_CONTROLS;
|
|
class VIEW_CONTROLS;
|
|
class PAINTER;
|
|
class GAL_DISPLAY_OPTIONS;
|
|
}
|
|
|
|
|
|
class EDA_DRAW_PANEL_GAL : public wxScrolledCanvas
|
|
{
|
|
public:
|
|
enum GAL_TYPE {
|
|
GAL_TYPE_NONE, ///< Not used
|
|
GAL_TYPE_OPENGL, ///< OpenGL implementation
|
|
GAL_TYPE_CAIRO, ///< Cairo implementation
|
|
GAL_TYPE_LAST ///< Sentinel, do not use as a parameter
|
|
};
|
|
|
|
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;
|
|
|
|
/**
|
|
* Function SwitchBackend
|
|
* Switches method of rendering graphics.
|
|
* @param aGalType is a type of rendering engine that you want to use.
|
|
*/
|
|
virtual bool SwitchBackend( GAL_TYPE aGalType );
|
|
|
|
/**
|
|
* Function GetBackend
|
|
* Returns the type of backend currently used by GAL canvas.
|
|
*/
|
|
inline GAL_TYPE GetBackend() const
|
|
{
|
|
return m_backend;
|
|
}
|
|
|
|
/**
|
|
* Function GetGAL()
|
|
* Returns a pointer to the GAL instance used in the panel.
|
|
* @return The instance of GAL.
|
|
*/
|
|
KIGFX::GAL* GetGAL() const
|
|
{
|
|
return m_gal;
|
|
}
|
|
|
|
/**
|
|
* Function GetView()
|
|
* Returns a pointer to the VIEW instance used in the panel.
|
|
* @return The instance of VIEW.
|
|
*/
|
|
KIGFX::VIEW* GetView() const
|
|
{
|
|
return m_view;
|
|
}
|
|
|
|
/**
|
|
* Function GetViewControls()
|
|
* Returns a pointer to the VIEW_CONTROLS instance used in the panel.
|
|
* @return The instance of VIEW_CONTROLS.
|
|
*/
|
|
KIGFX::VIEW_CONTROLS* GetViewControls() const
|
|
{
|
|
return (KIGFX::VIEW_CONTROLS*)( m_viewControls );
|
|
}
|
|
|
|
/// @copydoc wxWindow::Refresh()
|
|
void Refresh( bool aEraseBackground = true, const wxRect* aRect = NULL ) override;
|
|
|
|
/**
|
|
* Function ForceRefresh()
|
|
* Forces a redraw.
|
|
*/
|
|
void ForceRefresh();
|
|
|
|
/**
|
|
* Function SetEventDispatcher()
|
|
* Sets a dispatcher that processes events and forwards them to tools.
|
|
* @param aEventDispatcher is 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.
|
|
*/
|
|
void SetEventDispatcher( TOOL_DISPATCHER* aEventDispatcher );
|
|
|
|
/**
|
|
* Function StartDrawing()
|
|
* Begins drawing if it was stopped previously.
|
|
*/
|
|
void StartDrawing();
|
|
|
|
/**
|
|
* Function StopDrawing()
|
|
* Prevents the GAL canvas from further drawing till it is recreated
|
|
* or StartDrawing() is called.
|
|
*/
|
|
void StopDrawing();
|
|
|
|
/**
|
|
* Function SetHighContrastLayer
|
|
* Takes care of display settings for the given layer to be displayed in high contrast mode.
|
|
*/
|
|
virtual void SetHighContrastLayer( int aLayer );
|
|
|
|
/**
|
|
* Function SetTopLayer
|
|
* Moves the selected layer to the top, so it is displayed above all others.
|
|
*/
|
|
virtual void SetTopLayer( int aLayer );
|
|
|
|
virtual void GetMsgPanelInfo( std::vector<MSG_PANEL_ITEM>& aList )
|
|
{
|
|
assert( false );
|
|
}
|
|
|
|
/**
|
|
* Function GetLegacyZoom()
|
|
* Returns current view scale converted to zoom value used by the legacy canvas.
|
|
*/
|
|
double GetLegacyZoom() const;
|
|
|
|
/**
|
|
* Function GetParentEDAFrame()
|
|
* Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
|
|
*/
|
|
EDA_DRAW_FRAME* GetParentEDAFrame() const
|
|
{
|
|
return m_edaFrame;
|
|
}
|
|
|
|
/**
|
|
* Function OnShow()
|
|
* Called when the window is shown for the first time.
|
|
*/
|
|
virtual void OnShow() {}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
void SetStealsFocus( bool aStealsFocus )
|
|
{
|
|
m_stealsFocus = aStealsFocus;
|
|
}
|
|
|
|
/**
|
|
* Get whether focus is taken on certain events (see SetStealsFocus()).
|
|
*/
|
|
bool GetStealsFocus() const
|
|
{
|
|
return m_stealsFocus;
|
|
}
|
|
|
|
/**
|
|
* Function SetCurrentCursor
|
|
* Set the current cursor shape for this panel
|
|
*/
|
|
void SetCurrentCursor( int aCursor )
|
|
{
|
|
m_currentCursor = aCursor;
|
|
SetCursor( (wxStockCursor) m_currentCursor );
|
|
}
|
|
|
|
/**
|
|
* Function GetDefaultCursor
|
|
* @return the default cursor shape
|
|
*/
|
|
int GetDefaultCursor() const { return m_defaultCursor; }
|
|
|
|
/**
|
|
* Function GetCurrentCursor
|
|
* @return the current cursor shape, depending on the current selected tool
|
|
*/
|
|
int GetCurrentCursor() const { return m_currentCursor; }
|
|
|
|
/**
|
|
* Returns the bounding box of the view that should be used if model is not valid
|
|
* For example, the worksheet bounding box for an empty PCB
|
|
*
|
|
* @return the default bounding box for the panel
|
|
*/
|
|
virtual BOX2I GetDefaultViewBBox() const
|
|
{
|
|
return BOX2I();
|
|
}
|
|
|
|
/**
|
|
* Used to forward events to the canvas from popups, etc.
|
|
*/
|
|
void OnEvent( wxEvent& aEvent );
|
|
|
|
protected:
|
|
void onPaint( wxPaintEvent& WXUNUSED( aEvent ) );
|
|
void onSize( wxSizeEvent& aEvent );
|
|
void onEnter( wxEvent& aEvent );
|
|
void onLostFocus( wxFocusEvent& aEvent );
|
|
void onRefreshTimer( wxTimerEvent& aEvent );
|
|
void onShowTimer( wxTimerEvent& aEvent );
|
|
|
|
static const int MinRefreshPeriod = 17; ///< 60 FPS.
|
|
|
|
/// Current mouse cursor shape id.
|
|
int m_currentCursor;
|
|
/// The default mouse cursor shape id.
|
|
int m_defaultCursor;
|
|
|
|
/// Pointer to the parent window
|
|
wxWindow* m_parent;
|
|
|
|
/// Parent EDA_DRAW_FRAME (if available)
|
|
EDA_DRAW_FRAME* m_edaFrame;
|
|
|
|
/// Last timestamp when the panel was refreshed
|
|
wxLongLong m_lastRefresh;
|
|
|
|
/// Is there a redraw event requested?
|
|
bool m_pendingRefresh;
|
|
|
|
/// True if GAL is currently redrawing the view
|
|
bool m_drawing;
|
|
|
|
/// Flag that determines if VIEW may use GAL for redrawing the screen.
|
|
bool m_drawingEnabled;
|
|
|
|
/// Timer responsible for preventing too frequent refresh
|
|
wxTimer m_refreshTimer;
|
|
|
|
/// Timer used to execute OnShow() when the window finally appears on the screen.
|
|
wxTimer m_onShowTimer;
|
|
|
|
/// Interface for drawing objects on a 2D-surface
|
|
KIGFX::GAL* m_gal;
|
|
|
|
/// Stores view settings (scale, center, etc.) and items to be drawn
|
|
KIGFX::VIEW* m_view;
|
|
|
|
/// Contains information about how to draw items using GAL
|
|
std::unique_ptr<KIGFX::PAINTER> m_painter;
|
|
|
|
/// Control for VIEW (moving, zooming, etc.)
|
|
KIGFX::WX_VIEW_CONTROLS* m_viewControls;
|
|
|
|
/// Currently used GAL
|
|
GAL_TYPE m_backend;
|
|
KIGFX::GAL_DISPLAY_OPTIONS& m_options;
|
|
|
|
/// Processes and forwards events to tools
|
|
TOOL_DISPATCHER* m_eventDispatcher;
|
|
|
|
/// 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.
|
|
bool m_lostFocus;
|
|
|
|
/// Flag to indicate whether the panel should take focus at certain times (when moused over,
|
|
/// and on various mouse/key events)
|
|
bool m_stealsFocus;
|
|
};
|
|
|
|
#endif
|