source: git/src/gla.h @ 0b3f35e

Last change on this file since 0b3f35e was eadf5fd, checked in by Olly Betts <olly@…>, 9 days ago

Fix HiDPI handling with wxMSW

Fixes #144, reported by Juan Corrin.

  • Property mode set to 100644
File size: 8.9 KB
Line 
1//
2//  gla.h
3//
4//  Header file for the GLA abstraction layer.
5//
6//  Copyright (C) 2002 Mark R. Shinwell.
7//  Copyright (C) 2003-2025 Olly Betts
8//
9//  This program is free software; you can redistribute it and/or modify
10//  it under the terms of the GNU General Public License as published by
11//  the Free Software Foundation; either version 2 of the License, or
12//  (at your option) any later version.
13//
14//  This program is distributed in the hope that it will be useful,
15//  but WITHOUT ANY WARRANTY; without even the implied warranty of
16//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17//  GNU General Public License for more details.
18//
19//  You should have received a copy of the GNU General Public License
20//  along with this program; if not, write to the Free Software
21//  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
22//
23
24#ifndef gla_h
25#define gla_h
26
27#include <string>
28#include <vector>
29
30using namespace std;
31
32#include "wx.h"
33#include "vector3.h"
34
35#include "glbitmapfont.h"
36
37#ifdef HAVE_GL_GL_H
38# include <GL/gl.h>
39#elif defined HAVE_OPENGL_GL_H
40# include <OpenGL/gl.h>
41#endif
42
43#ifdef HAVE_GL_GLU_H
44# include <GL/glu.h>
45#elif defined HAVE_OPENGL_GLU_H
46# include <OpenGL/glu.h>
47#endif
48
49class GfxCore;
50
51string GetGLSystemDescription();
52
53// #define GLA_DEBUG
54
55typedef GLdouble glaCoord;
56
57typedef GLfloat glaTexCoord;
58
59// Colours for drawing.  Don't reorder these!
60enum gla_colour {
61    col_BLACK = 0,
62    col_GREY,
63    col_LIGHT_GREY,
64    col_LIGHT_GREY_2,
65    col_DARK_GREY,
66    col_WHITE,
67    col_TURQUOISE,
68    col_GREEN,
69    col_INDICATOR_1,
70    col_INDICATOR_2,
71    col_YELLOW,
72    col_RED,
73    col_BLUE,
74    col_MAGENTA,
75    col_LAST // must be the last entry here
76};
77
78class GLAPen {
79    friend class GLACanvas; // allow direct access to components
80
81    double components[3] = { 0.0, 0.0, 0.0 }; // red, green, blue
82
83public:
84    GLAPen() {}
85
86    void SetColour(double red, double green, double blue); // arguments in range 0 to 1.0
87    void Interpolate(const GLAPen&, double how_far);
88
89    double GetRed() const;
90    double GetGreen() const;
91    double GetBlue() const;
92};
93
94class GLAList {
95    GLuint gl_list = 0;
96    unsigned int flags = 0;
97  public:
98    GLAList() { }
99    GLAList(GLuint gl_list_, unsigned int flags_)
100        : gl_list(gl_list_), flags(flags_) { }
101    operator bool() { return gl_list != 0; }
102    bool need_to_generate();
103    void finalise(unsigned int list_flags);
104    bool DrawList() const;
105    void invalidate_if(unsigned int mask) {
106        // If flags == NEVER_CACHE, the list won't be invalidated (unless
107        // mask is 0, which isn't a normal thing to pass).
108        if (flags & mask)
109            flags = 0;
110    }
111};
112
113class GLACanvas : public wxGLCanvas {
114    friend class GLAList; // For flag values.
115
116    wxGLContext ctx;
117
118#ifdef GLA_DEBUG
119    int m_Vertices;
120#endif
121
122    GLdouble modelview_matrix[16];
123    GLdouble projection_matrix[16];
124    GLint viewport[4];
125
126    // Viewing volume diameter:
127    glaCoord m_VolumeDiameter = 1.0;
128
129    // Parameters for plotting data:
130    double m_Pan = 0.0, m_Tilt = 0.0;
131    double m_Scale = 0.0;
132    Vector3 m_Translation;
133
134    double z_stretch = 1.0;
135
136    BitmapFont m_Font;
137
138    GLUquadric* m_Quadric = nullptr;
139
140    GLuint m_Texture = 0;
141    GLuint m_BlobTexture;
142    GLuint m_CrossTexture;
143
144    double alpha = 1.0;
145
146    bool m_SmoothShading = false;
147    bool m_Textured = false;
148    bool m_Perspective = false;
149    bool m_Fog = false;
150    bool m_AntiAlias = false;
151    bool save_hints;
152    enum { UNKNOWN = 0, POINT = 'P', LINES = 'L', SPRITE = 'S' };
153    int blob_method = UNKNOWN;
154    int cross_method = UNKNOWN;
155
156    int x_size = 0;
157    int y_size = 0;
158
159    double dpi_scale_factor = 1.0;
160
161    vector<GLAList> drawing_lists;
162
163    enum {
164        INVALIDATE_ON_SCALE = 1,
165        INVALIDATE_ON_X_RESIZE = 2,
166        INVALIDATE_ON_Y_RESIZE = 4,
167        INVALIDATE_ON_HIDPI = 8,
168        NEVER_CACHE = 16,
169        CACHED = 32
170    };
171    mutable unsigned int list_flags = 0;
172
173    wxString vendor, renderer;
174
175    bool CheckVisualFidelity(const unsigned char * target) const;
176
177public:
178    GLACanvas(wxWindow* parent, int id);
179    ~GLACanvas();
180
181    static bool check_visual();
182
183    void FirstShow();
184
185    void Clear();
186    void ClearNative();
187    void StartDrawing();
188    void FinishDrawing();
189
190    void SetVolumeDiameter(glaCoord diameter);
191    void SetDataTransform();
192    void SetIndicatorTransform();
193
194    void DrawList(unsigned int l);
195    void DrawListZPrepass(unsigned int l);
196    void DrawList2D(unsigned int l, glaCoord x, glaCoord y, double rotation);
197    void InvalidateList(unsigned int l) {
198        if (l < drawing_lists.size()) {
199            // Invalidate any existing cached list.
200            drawing_lists[l].invalidate_if(CACHED);
201        }
202    }
203
204    virtual void GenerateList(unsigned int l) = 0;
205
206    void SetColour(const GLAPen& pen, double rgb_scale);
207    void SetColour(const GLAPen& pen);
208    void SetColour(gla_colour colour, double rgb_scale);
209    void SetColour(gla_colour colour);
210    void SetAlpha(double new_alpha) { alpha = new_alpha; }
211
212    void DrawText(glaCoord x, glaCoord y, glaCoord z, const wxString& str);
213    void DrawIndicatorText(int x, int y, const wxString& str);
214    void GetTextExtent(const wxString& str, int * x_ext, int * y_ext) const;
215
216    void BeginQuadrilaterals();
217    void EndQuadrilaterals();
218    void BeginLines();
219    void EndLines();
220    void BeginTriangleStrip();
221    void EndTriangleStrip();
222    void BeginTriangles();
223    void EndTriangles();
224    void BeginPolyline();
225    void EndPolyline();
226    void BeginPolyloop();
227    void EndPolyloop();
228    void BeginPolygon();
229    void EndPolygon();
230    void BeginPoints();
231    void EndPoints();
232    void BeginBlobs();
233    void EndBlobs();
234    void BeginCrosses();
235    void EndCrosses();
236
237    void DrawRectangle(gla_colour fill, gla_colour edge,
238                       glaCoord x0, glaCoord y0, glaCoord w, glaCoord h);
239    void DrawShadedRectangle(const GLAPen & fill_bot, const GLAPen & fill_top,
240                             glaCoord x0, glaCoord y0, glaCoord w, glaCoord h);
241    void DrawCircle(gla_colour edge, gla_colour fill, glaCoord cx, glaCoord cy, glaCoord radius);
242    void DrawSemicircle(gla_colour edge, gla_colour fill, glaCoord cx, glaCoord cy, glaCoord radius, glaCoord start);
243
244    void DrawBlob(glaCoord x, glaCoord y, glaCoord z);
245    void DrawBlob(glaCoord x, glaCoord y);
246    void DrawCross(glaCoord x, glaCoord y, glaCoord z);
247    void DrawRing(glaCoord x, glaCoord y);
248
249    void PlaceVertex(const Vector3 & v, glaTexCoord tex_x, glaTexCoord tex_y) {
250        PlaceVertex(v.GetX(), v.GetY(), v.GetZ(), tex_x, tex_y);
251    }
252    void PlaceVertex(const Vector3 & v) {
253        PlaceVertex(v.GetX(), v.GetY(), v.GetZ());
254    }
255    void PlaceVertex(glaCoord x, glaCoord y, glaCoord z);
256    void PlaceVertex(glaCoord x, glaCoord y, glaCoord z,
257                     glaTexCoord tex_x, glaTexCoord tex_y);
258    void PlaceIndicatorVertex(glaCoord x, glaCoord y);
259
260    void PlaceNormal(const Vector3 &v);
261
262    void EnableDashedLines();
263    void DisableDashedLines();
264
265    void EnableSmoothPolygons(bool filled);
266    void DisableSmoothPolygons();
267
268    void SetRotation(double pan, double tilt) {
269        m_Pan = pan;
270        m_Tilt = tilt;
271    }
272    void SetScale(double);
273    void SetTranslation(const Vector3 &v) {
274        m_Translation = v;
275    }
276    void AddTranslation(const Vector3 &v) {
277        m_Translation += v;
278    }
279    const Vector3 & GetTranslation() const {
280        return m_Translation;
281    }
282    void AddTranslationScreenCoordinates(int dx, int dy);
283
284    bool Transform(const Vector3 & v, glaCoord* x_out, glaCoord* y_out, glaCoord* z_out) const;
285    void ReverseTransform(double x, double y, glaCoord* x_out, glaCoord* y_out, glaCoord* z_out) const;
286
287    void SetZStretch(double z_stretch_) { z_stretch = z_stretch_; }
288
289    int GetFontSize() const { return m_Font.get_font_size(); }
290
291    void ToggleSmoothShading();
292    bool GetSmoothShading() const { return m_SmoothShading; }
293
294    double SurveyUnitsAcrossViewport() const;
295
296    void ToggleTextured();
297    bool GetTextured() const { return m_Textured; }
298
299    void TogglePerspective() { m_Perspective = !m_Perspective; }
300    bool GetPerspective() const { return m_Perspective; }
301
302    void ToggleFog() { m_Fog = !m_Fog; }
303    bool GetFog() const { return m_Fog; }
304
305    void ToggleAntiAlias() { m_AntiAlias = !m_AntiAlias; }
306    bool GetAntiAlias() const { return m_AntiAlias; }
307
308    bool SaveScreenshot(const wxString & fnm, wxBitmapType type) const;
309
310    void ReadPixels(int width, int height, unsigned char * buf) const;
311
312    void PolygonOffset(bool on) const;
313
314    int GetXSize() const {
315        list_flags |= INVALIDATE_ON_X_RESIZE;
316        return x_size;
317    }
318
319    int GetYSize() const {
320        list_flags |= INVALIDATE_ON_Y_RESIZE;
321        return y_size;
322    }
323
324    double GetDPIScaleFactor() const {
325        list_flags |= INVALIDATE_ON_HIDPI;
326        return dpi_scale_factor;
327    }
328
329    void UpdateDPIScaleFactor();
330    void OnMove(wxMoveEvent & event);
331
332    void OnSize(wxSizeEvent & event);
333
334    glaCoord GetVolumeDiameter() const { return m_VolumeDiameter; }
335
336    void ScaleMouseEvent(wxMouseEvent& e) const {
337        e.SetX(e.GetX() * dpi_scale_factor);
338        e.SetY(e.GetY() * dpi_scale_factor);
339    }
340
341private:
342    DECLARE_EVENT_TABLE()
343};
344
345#endif
Note: See TracBrowser for help on using the repository browser.