KiCad PCB EDA Suite
opengl_gal.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KICAD, a free EDA CAD application.
3  *
4  * Copyright (C) 2012 Torsten Hueter, torstenhtr <at> gmx.de
5  * Copyright (C) 2020 Kicad Developers, see AUTHORS.txt for contributors.
6  * Copyright (C) 2013-2017 CERN
7  * @author Maciej Suminski <maciej.suminski@cern.ch>
8  *
9  * Graphics Abstraction Layer (GAL) for OpenGL
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, you may find one here:
23  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
24  * or you may search the http://www.gnu.org website for the version 2 license,
25  * or you may write to the Free Software Foundation, Inc.,
26  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
27  */
28 
29 #ifndef OPENGLGAL_H_
30 #define OPENGLGAL_H_
31 
32 // GAL imports
35 #include <gal/opengl/shader.h>
37 #include <gal/opengl/vertex_item.h>
41 #include <gal/hidpi_gl_canvas.h>
42 
43 #include <unordered_map>
44 #include <boost/smart_ptr/shared_array.hpp>
45 #include <memory>
46 
47 #ifndef CALLBACK
48 #define CALLBACK
49 #endif
50 
51 struct bitmap_glyph;
52 
53 namespace KIGFX
54 {
55 class SHADER;
56 class GL_BITMAP_CACHE;
57 
65 class OPENGL_GAL : public GAL, public HIDPI_GL_CANVAS
66 {
67 public:
83  OPENGL_GAL( GAL_DISPLAY_OPTIONS& aDisplayOptions, wxWindow* aParent,
84  wxEvtHandler* aMouseListener = nullptr, wxEvtHandler* aPaintListener = nullptr,
85  const wxString& aName = wxT( "GLCanvas" ) );
86 
87  ~OPENGL_GAL();
88 
94  static wxString CheckFeatures( GAL_DISPLAY_OPTIONS& aOptions );
95 
96  bool IsOpenGlEngine() override { return true; }
97 
99  bool IsInitialized() const override
100  {
101  // is*Initialized flags, but it is enough for OpenGL to show up
102  return IsShownOnScreen() && !GetClientRect().IsEmpty();
103  }
104 
106  bool IsVisible() const override
107  {
108  return IsShownOnScreen() && !GetClientRect().IsEmpty();
109  }
110 
111  // ---------------
112  // Drawing methods
113  // ---------------
114 
116  void DrawLine( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint ) override;
117 
119  void DrawSegment( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint,
120  double aWidth ) override;
121 
123  void DrawCircle( const VECTOR2D& aCenterPoint, double aRadius ) override;
124 
126  void DrawArc( const VECTOR2D& aCenterPoint, double aRadius,
127  double aStartAngle, double aEndAngle ) override;
128 
130  void DrawArcSegment( const VECTOR2D& aCenterPoint, double aRadius,
131  double aStartAngle, double aEndAngle, double aWidth ) override;
132 
134  void DrawRectangle( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint ) override;
135 
137  void DrawPolyline( const std::deque<VECTOR2D>& aPointList ) override;
138  void DrawPolyline( const VECTOR2D aPointList[], int aListSize ) override;
139  void DrawPolyline( const SHAPE_LINE_CHAIN& aLineChain ) override;
140 
142  void DrawPolygon( const std::deque<VECTOR2D>& aPointList ) override;
143  void DrawPolygon( const VECTOR2D aPointList[], int aListSize ) override;
144  void DrawPolygon( const SHAPE_POLY_SET& aPolySet ) override;
145  void DrawPolygon( const SHAPE_LINE_CHAIN& aPolySet ) override;
146 
148  void DrawCurve( const VECTOR2D& startPoint, const VECTOR2D& controlPointA,
149  const VECTOR2D& controlPointB, const VECTOR2D& endPoint,
150  double aFilterValue = 0.0 ) override;
151 
153  void DrawBitmap( const BITMAP_BASE& aBitmap ) override;
154 
156  void BitmapText( const wxString& aText, const VECTOR2D& aPosition,
157  double aRotationAngle ) override;
158 
160  void DrawGrid() override;
161 
162  // --------------
163  // Screen methods
164  // --------------
165 
167  void ResizeScreen( int aWidth, int aHeight ) override;
168 
170  bool Show( bool aShow ) override;
171 
173  void Flush() override;
174 
176  void ClearScreen( ) override;
177 
178  // --------------
179  // Transformation
180  // --------------
181 
183  void Transform( const MATRIX3x3D& aTransformation ) override;
184 
186  void Rotate( double aAngle ) override;
187 
189  void Translate( const VECTOR2D& aTranslation ) override;
190 
192  void Scale( const VECTOR2D& aScale ) override;
193 
195  void Save() override;
196 
198  void Restore() override;
199 
200  // --------------------------------------------
201  // Group methods
202  // ---------------------------------------------
203 
205  int BeginGroup() override;
206 
208  void EndGroup() override;
209 
211  void DrawGroup( int aGroupNumber ) override;
212 
214  void ChangeGroupColor( int aGroupNumber, const COLOR4D& aNewColor ) override;
215 
217  void ChangeGroupDepth( int aGroupNumber, int aDepth ) override;
218 
220  void DeleteGroup( int aGroupNumber ) override;
221 
223  void ClearCache() override;
224 
225  // --------------------------------------------------------
226  // Handling the world <-> screen transformation
227  // --------------------------------------------------------
228 
230  void SetTarget( RENDER_TARGET aTarget ) override;
231 
233  RENDER_TARGET GetTarget() const override;
234 
236  void ClearTarget( RENDER_TARGET aTarget ) override;
237 
239  virtual bool HasTarget( RENDER_TARGET aTarget ) override;
240 
242  void SetNegativeDrawMode( bool aSetting ) override {}
243 
244  void ComputeWorldScreenMatrix() override;
245 
246  // -------
247  // Cursor
248  // -------
249 
251  void DrawCursor( const VECTOR2D& aCursorPosition ) override;
252 
259  void PostPaint( wxPaintEvent& aEvent );
260 
261  void SetMouseListener( wxEvtHandler* aMouseListener )
262  {
263  mouseListener = aMouseListener;
264  }
265 
266  void SetPaintListener( wxEvtHandler* aPaintListener )
267  {
268  paintListener = aPaintListener;
269  }
270 
271  void EnableDepthTest( bool aEnabled = false ) override;
272 
274  typedef struct
275  {
278 
280  std::deque< boost::shared_array<GLdouble> >& intersectPoints;
281  } TessParams;
282 
283 private:
285  typedef GAL super;
286 
287  static const int CIRCLE_POINTS = 64;
288  static const int CURVE_POINTS = 32;
289 
290  static wxGLContext* glMainContext;
291  wxGLContext* glPrivContext;
292  static int instanceCounter;
293  wxEvtHandler* mouseListener;
294  wxEvtHandler* paintListener;
295 
296  static GLuint fontTexture;
297 
298  // Vertex buffer objects related fields
299  typedef std::unordered_map< unsigned int, std::shared_ptr<VERTEX_ITEM> > GROUPS_MAP;
301  unsigned int groupCounter;
306 
307  // Framebuffer & compositing
309  unsigned int mainBuffer;
310  unsigned int overlayBuffer;
312 
313  // Shader
315 
316  // Internal flags
318  static bool isBitmapFontLoaded;
321  bool isGrouping;
328 
329  std::unique_ptr<GL_BITMAP_CACHE> bitmapCache;
330 
331  void lockContext( int aClientCookie ) override;
332 
333  void unlockContext( int aClientCookie ) override;
334 
336  void beginUpdate() override;
337 
339  void endUpdate() override;
340 
342  void beginDrawing() override;
343 
345  void endDrawing() override;
346 
348  bool updatedGalDisplayOptions( const GAL_DISPLAY_OPTIONS& aOptions ) override;
349 
350  // Polygon tesselation
352  GLUtesselator* tesselator;
354  std::deque< boost::shared_array<GLdouble> > tessIntersects;
355 
362  void drawLineQuad( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint );
363 
373  void drawSemiCircle( const VECTOR2D& aCenterPoint, double aRadius, double aAngle );
374 
383  void drawFilledSemiCircle( const VECTOR2D& aCenterPoint, double aRadius, double aAngle );
384 
393  void drawStrokedSemiCircle( const VECTOR2D& aCenterPoint, double aRadius, double aAngle );
394 
400  void drawPolyline( const std::function<VECTOR2D (int)>& aPointGetter, int aPointCount );
401 
408  void drawPolygon( GLdouble* aPoints, int aPointCount );
409 
413  void drawTriangulatedPolyset( const SHAPE_POLY_SET& aPoly );
414 
415 
423  int drawBitmapChar( unsigned long aChar );
424 
434  void drawBitmapOverbar( double aLength, double aHeight );
435 
443  std::pair<VECTOR2D, float> computeBitmapTextSize( const UTF8& aText ) const;
444 
445  // Event handling
451  void onPaint( wxPaintEvent& aEvent );
452 
458  void skipMouseEvent( wxMouseEvent& aEvent );
459 
463  void blitCursor();
464 
470  unsigned int getNewGroupNumber();
471 
475  double calcAngleStep( double aRadius ) const
476  {
477  // Bigger arcs need smaller alpha increment to make them look smooth
478  return std::min( 1e6 / aRadius, 2.0 * M_PI / CIRCLE_POINTS );
479  }
480 
481  double getWorldPixelSize() const;
482 
484 
489  void init();
490 };
491 } // namespace KIGFX
492 
493 #endif // OPENGLGAL_H_
UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to...
Definition: utf8.h:73
VERTEX_MANAGER * currentManager
Currently used VERTEX_MANAGER (for storing VERTEX_ITEMs)
Definition: opengl_gal.h:302
void beginUpdate() override
Definition: opengl_gal.cpp:619
void DrawBitmap(const BITMAP_BASE &aBitmap) override
Draw a bitmap image.
static wxGLContext * glMainContext
Parent OpenGL context.
Definition: opengl_gal.h:290
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:175
unsigned int overlayBuffer
Auxiliary rendering target (for menus etc.)
Definition: opengl_gal.h:310
std::deque< boost::shared_array< GLdouble > > & intersectPoints
Intersect points, that have to be freed after tessellation.
Definition: opengl_gal.h:280
void Scale(const VECTOR2D &aScale) override
Scale the context.
void ClearTarget(RENDER_TARGET aTarget) override
Clears the target for rendering.
void DrawCurve(const VECTOR2D &startPoint, const VECTOR2D &controlPointA, const VECTOR2D &controlPointB, const VECTOR2D &endPoint, double aFilterValue=0.0) override
Draw a cubic bezier spline.
void Translate(const VECTOR2D &aTranslation) override
Translate the context.
RENDER_TARGET currentTarget
Current rendering target.
Definition: opengl_gal.h:311
bool isBitmapFontInitialized
Is the shader set to use bitmap fonts?
Definition: opengl_gal.h:319
void drawPolygon(GLdouble *aPoints, int aPointCount)
Draws a filled polygon.
static GLuint fontTexture
Bitmap font texture handle (shared)
Definition: opengl_gal.h:296
void drawLineQuad(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
Draw a quad for the line.
VERTEX_MANAGER * overlayManager
Container for storing overlaid VERTEX_ITEMs.
Definition: opengl_gal.h:305
Class OpenGL_GAL is the OpenGL implementation of the Graphics Abstraction Layer.
Definition: opengl_gal.h:65
VECTOR2D getScreenPixelSize() const
Definition: opengl_gal.cpp:401
void ComputeWorldScreenMatrix() override
Compute the world <-> screen transformation matrix.
void Restore() override
Restore the context.
void ChangeGroupDepth(int aGroupNumber, int aDepth) override
Changes the depth (Z-axis position) of the group.
std::unique_ptr< GL_BITMAP_CACHE > bitmapCache
Definition: opengl_gal.h:329
void EnableDepthTest(bool aEnabled=false) override
Parameters passed to the GLU tesselator.
wxGLCanvas wrapper for HiDPI/Retina support.
int BeginGroup() override
Begin a group.
void DrawPolygon(const std::deque< VECTOR2D > &aPointList) override
Draw a polygon.
Definition: opengl_gal.cpp:998
Class to control vertex container and GPU with possibility of emulating old-style OpenGL 1....
bool isContextLocked
Used for assertion checking.
Definition: opengl_gal.h:323
void SetPaintListener(wxEvtHandler *aPaintListener)
Definition: opengl_gal.h:266
SHADER * shader
There is only one shader used for different objects.
Definition: opengl_gal.h:314
Class that handles multitarget rendering (ie.
bool isGrouping
Was a group started?
Definition: opengl_gal.h:322
std::unordered_map< unsigned int, std::shared_ptr< VERTEX_ITEM > > GROUPS_MAP
Definition: opengl_gal.h:299
bool IsInitialized() const override
Returns the initalization status for the canvas.
Definition: opengl_gal.h:99
OPENGL_GAL(GAL_DISPLAY_OPTIONS &aDisplayOptions, wxWindow *aParent, wxEvtHandler *aMouseListener=nullptr, wxEvtHandler *aPaintListener=nullptr, const wxString &aName=wxT("GLCanvas"))
Constructor OPENGL_GAL.
Definition: opengl_gal.cpp:196
void ResizeScreen(int aWidth, int aHeight) override
Resizes the canvas.
void unlockContext(int aClientCookie) override
Definition: opengl_gal.cpp:605
void Transform(const MATRIX3x3D &aTransformation) override
Transform the context.
VERTEX_MANAGER * nonCachedManager
Container for storing non-cached VERTEX_ITEMs.
Definition: opengl_gal.h:304
static int instanceCounter
GL GAL instance counter.
Definition: opengl_gal.h:292
VERTEX_MANAGER * vboManager
Manager used for storing new vertices.
Definition: opengl_gal.h:277
double getWorldPixelSize() const
Definition: opengl_gal.cpp:394
void DrawArcSegment(const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle, double aWidth) override
Draw an arc segment.
Definition: opengl_gal.cpp:829
RENDER_TARGET GetTarget() const override
Gets the currently used target for rendering.
static const int CURVE_POINTS
The number of points for curve approximation.
Definition: opengl_gal.h:288
This class handle bitmap images in KiCad.
Definition: bitmap_base.h:51
void endUpdate() override
Definition: opengl_gal.cpp:635
void Save() override
Save the context.
void init()
Basic OpenGL initialization and feature checks.
OPENGL_COMPOSITOR * compositor
Handles multiple rendering targets.
Definition: opengl_gal.h:308
GROUPS_MAP groups
Stores informations about VBO objects (groups)
Definition: opengl_gal.h:300
unsigned int mainBuffer
Main rendering target.
Definition: opengl_gal.h:309
bool Show(bool aShow) override
Shows/hides the GAL canvas.
void SetMouseListener(wxEvtHandler *aMouseListener)
Definition: opengl_gal.h:261
SHAPE_POLY_SET.
void SetNegativeDrawMode(bool aSetting) override
Sets negative draw mode in the renderer.
Definition: opengl_gal.h:242
void EndGroup() override
End the group.
void DeleteGroup(int aGroupNumber) override
Delete the group from the memory.
double calcAngleStep(double aRadius) const
Compute the angle step when drawing arcs/circles approximated with lines.
Definition: opengl_gal.h:475
wxEvtHandler * mouseListener
Definition: opengl_gal.h:293
bool updatedGalDisplayOptions(const GAL_DISPLAY_OPTIONS &aOptions) override
Function updatedGalDisplayOptions.
Definition: opengl_gal.cpp:367
void DrawGrid() override
void PostPaint(wxPaintEvent &aEvent)
Function PostPaint posts an event to m_paint_listener.
Definition: opengl_gal.cpp:357
void DrawLine(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
Draw a line.
Definition: opengl_gal.cpp:644
void onPaint(wxPaintEvent &aEvent)
This is the OnPaint event handler.
GLint ufm_screenPixelSize
Definition: opengl_gal.h:326
void endDrawing() override
Definition: opengl_gal.cpp:556
void DrawGroup(int aGroupNumber) override
Draw the stored group.
bool isFramebufferInitialized
Are the framebuffers initialized?
Definition: opengl_gal.h:317
void ClearCache() override
Delete all data created during caching of graphic items.
bool IsOpenGlEngine() override
Returns true if the GAL engine is a opengl based type.
Definition: opengl_gal.h:96
void drawTriangulatedPolyset(const SHAPE_POLY_SET &aPoly)
Draws a set of polygons with a cached triangulation.
Class SHADER provides the access to the OpenGL shaders.
Definition: shader.h:76
void lockContext(int aClientCookie) override
Private: use GAL_CONTEXT_LOCKER RAII object.
Definition: opengl_gal.cpp:595
GAL super
Super class definition.
Definition: opengl_gal.h:285
GLUtesselator * tesselator
The tessellator.
Definition: opengl_gal.h:352
void Rotate(double aAngle) override
Rotate the context.
void drawStrokedSemiCircle(const VECTOR2D &aCenterPoint, double aRadius, double aAngle)
Draw a stroked semicircle.
void blitCursor()
Blits cursor into the current screen.
VERTEX_MANAGER * cachedManager
Container for storing cached VERTEX_ITEMs.
Definition: opengl_gal.h:303
void DrawPolyline(const std::deque< VECTOR2D > &aPointList) override
Draw a polyline.
Definition: opengl_gal.cpp:975
void DrawSegment(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint, double aWidth) override
Draw a rounded segment.
Definition: opengl_gal.cpp:652
GLint ufm_worldPixelSize
Definition: opengl_gal.h:325
wxEvtHandler * paintListener
Definition: opengl_gal.h:294
std::deque< boost::shared_array< GLdouble > > tessIntersects
Storage for intersecting points.
Definition: opengl_gal.h:354
void DrawArc(const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle) override
Draw an arc.
Definition: opengl_gal.cpp:763
void SetTarget(RENDER_TARGET aTarget) override
Sets the target for rendering.
Class to store instances of VERTEX without caching.
bool isInitialized
Basic initialization flag, has to be done when the window is visible.
Definition: opengl_gal.h:320
void drawSemiCircle(const VECTOR2D &aCenterPoint, double aRadius, double aAngle)
Draw a semicircle.
static wxString CheckFeatures(GAL_DISPLAY_OPTIONS &aOptions)
Checks OpenGL features.
Definition: opengl_gal.cpp:328
SHAPE_LINE_CHAIN.
Class to handle an item held in a container.
unsigned int groupCounter
Counter used for generating keys for groups.
Definition: opengl_gal.h:301
virtual bool HasTarget(RENDER_TARGET aTarget) override
Returns true if the target exists.
int drawBitmapChar(unsigned long aChar)
Draws a single character using bitmap font.
CIRCLE_POINTS
void ClearScreen() override
Clear the screen.
unsigned int getNewGroupNumber()
Returns a valid key that can be used as a new group number.
wxGLContext * glPrivContext
Canvas-specific OpenGL context.
Definition: opengl_gal.h:291
void DrawRectangle(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
Draw a rectangle.
Definition: opengl_gal.cpp:937
void Flush() override
Force all remaining objects to be drawn.
void DrawCursor(const VECTOR2D &aCursorPosition) override
Draw the cursor.
void drawPolyline(const std::function< VECTOR2D(int)> &aPointGetter, int aPointCount)
Generic way of drawing a polyline stored in different containers.
std::pair< VECTOR2D, float > computeBitmapTextSize(const UTF8 &aText) const
Computes a size of text drawn using bitmap font with current text setting applied.
RENDER_TARGET
RENDER_TARGET: Possible rendering targets.
Definition: definitions.h:46
void BitmapText(const wxString &aText, const VECTOR2D &aPosition, double aRotationAngle) override
Draws a text using a bitmap font.
bool IsVisible() const override
Definition: opengl_gal.h:106
void beginDrawing() override
Definition: opengl_gal.cpp:408
GLint ufm_pixelSizeMultiplier
Definition: opengl_gal.h:327
void DrawCircle(const VECTOR2D &aCenterPoint, double aRadius) override
Draw a circle using world coordinates.
Definition: opengl_gal.cpp:707
static bool isBitmapFontLoaded
Is the bitmap font texture loaded?
Definition: opengl_gal.h:318
void skipMouseEvent(wxMouseEvent &aEvent)
Skip the mouse event to the parent.
void drawFilledSemiCircle(const VECTOR2D &aCenterPoint, double aRadius, double aAngle)
Draw a filled semicircle.
void ChangeGroupColor(int aGroupNumber, const COLOR4D &aNewColor) override
Changes the color used to draw the group.
Class GAL is the abstract interface for drawing on a 2D-surface.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100
void drawBitmapOverbar(double aLength, double aHeight)
Draws an overbar over the currently drawn text.