source: git/src/gla.h @ 8c048fa

RELEASE/1.2debug-cidebug-ci-sanitisersstereowalls-data
Last change on this file since 8c048fa was 8c048fa, checked in by Olly Betts <olly@…>, 11 years ago

src/gla-gl.cc,src/gla.h: Update to use wxGLContext to avoid
deprecation warnings from wx 2.9.

  • Property mode set to 100644
File size: 7.8 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,2004,2005,2006,2007,2011,2012 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#include <string>
25#include <vector>
26
27using namespace std;
28
29#include "wx.h"
30#include "aventypes.h"
31#include "vector3.h"
32
33#include "glbitmapfont.h"
34
35class GfxCore;
36
37string GetGLSystemDescription();
38
39// #define GLA_DEBUG
40
41typedef Double glaCoord;
42
43typedef GLint glaTexCoord;
44
45// Colours for drawing.  Don't reorder these!
46enum gla_colour {
47    col_BLACK = 0,
48    col_GREY,
49    col_LIGHT_GREY,
50    col_LIGHT_GREY_2,
51    col_DARK_GREY,
52    col_WHITE,
53    col_TURQUOISE,
54    col_GREEN,
55    col_INDICATOR_1,
56    col_INDICATOR_2,
57    col_YELLOW,
58    col_RED,
59    col_BLUE,
60    col_LAST // must be the last entry here
61};
62
63class GLAPen {
64    friend class GLACanvas; // allow direct access to components
65
66    double components[3]; // red, green, blue
67
68public:
69    GLAPen();
70
71    void SetColour(double red, double green, double blue); // arguments in range 0 to 1.0
72    void Interpolate(const GLAPen&, double how_far);
73
74    double GetRed() const;
75    double GetGreen() const;
76    double GetBlue() const;
77};
78
79class GLAList {
80    GLuint gl_list;
81    unsigned int flags;
82  public:
83    GLAList() : gl_list(0), flags(0) { }
84    GLAList(GLuint gl_list_, unsigned int flags_)
85        : gl_list(gl_list_), flags(flags_) { }
86    operator bool() { return gl_list != 0; }
87    bool need_to_generate();
88    void finalise(unsigned int list_flags);
89    bool DrawList() const;
90    void invalidate_if(unsigned int mask) {
91        // If flags == NEVER_CACHE, the list won't be invalidated (unless
92        // mask is 0, which isn't a normal thing to pass).
93        if (flags & mask)
94            flags = 0;
95    }
96};
97
98class GLACanvas : public wxGLCanvas {
99    friend class GLAList; // For flag values.
100
101    wxGLContext ctx;
102
103#ifdef GLA_DEBUG
104    int m_Vertices;
105#endif
106
107    GLdouble modelview_matrix[16];
108    GLdouble projection_matrix[16];
109    GLint viewport[4];
110
111    // Viewing volume diameter:
112    glaCoord m_VolumeDiameter;
113
114    // Parameters for plotting data:
115    Double m_Pan, m_Tilt;
116    Double m_Scale;
117    Vector3 m_Translation;
118
119    BitmapFont m_Font;
120
121    GLUquadric* m_Quadric;
122
123    GLuint m_Texture;
124    GLuint m_CrossTexture;
125
126    bool m_SmoothShading;
127    bool m_Textured;
128    bool m_Perspective;
129    bool m_Fog;
130    bool m_AntiAlias;
131    bool save_hints;
132    enum { UNKNOWN = 0, POINT = 'P', LINES = 'L', SPRITE = 'S' };
133    int blob_method;
134    int cross_method;
135
136    int x_size;
137    int y_size;
138
139    vector<GLAList> drawing_lists;
140
141    enum {
142        INVALIDATE_ON_SCALE = 1,
143        INVALIDATE_ON_X_RESIZE = 2,
144        INVALIDATE_ON_Y_RESIZE = 4,
145        NEVER_CACHE = 8,
146        CACHED = 16
147    };
148    mutable unsigned int list_flags;
149
150    wxString vendor, renderer;
151
152    bool CheckVisualFidelity(const unsigned char * target) const;
153
154public:
155    GLACanvas(wxWindow* parent, int id);
156    ~GLACanvas();
157
158    void FirstShow();
159
160    void Clear();
161    void StartDrawing();
162    void FinishDrawing();
163
164    void SetVolumeDiameter(glaCoord diameter);
165    void SetDataTransform();
166    void SetIndicatorTransform();
167
168    void DrawList(unsigned int l);
169    void DrawList2D(unsigned int l, glaCoord x, glaCoord y, Double rotation);
170    void InvalidateList(unsigned int l) {
171        if (l < drawing_lists.size()) {
172            // Invalidate any existing cached list.
173            drawing_lists[l].invalidate_if(CACHED);
174        }
175    }
176
177    virtual void GenerateList(unsigned int l) = 0;
178
179    void SetColour(const GLAPen& pen, double rgb_scale);
180    void SetColour(const GLAPen& pen);
181    void SetColour(gla_colour colour);
182
183    void DrawText(glaCoord x, glaCoord y, glaCoord z, const wxString& str);
184    void DrawIndicatorText(int x, int y, const wxString& str);
185    void GetTextExtent(const wxString& str, int * x_ext, int * y_ext);
186
187    void BeginQuadrilaterals();
188    void EndQuadrilaterals();
189    void BeginLines();
190    void EndLines();
191    void BeginTriangleStrip();
192    void EndTriangleStrip();
193    void BeginTriangles();
194    void EndTriangles();
195    void BeginPolyline();
196    void EndPolyline();
197    void BeginPolygon();
198    void EndPolygon();
199    void BeginBlobs();
200    void EndBlobs();
201    void BeginCrosses();
202    void EndCrosses();
203
204    void DrawRectangle(gla_colour edge, gla_colour fill,
205                       glaCoord x0, glaCoord y0, glaCoord w, glaCoord h);
206    void DrawShadedRectangle(const GLAPen & fill_bot, const GLAPen & fill_top,
207                             glaCoord x0, glaCoord y0, glaCoord w, glaCoord h);
208    void DrawCircle(gla_colour edge, gla_colour fill, glaCoord cx, glaCoord cy, glaCoord radius);
209    void DrawSemicircle(gla_colour edge, gla_colour fill, glaCoord cx, glaCoord cy, glaCoord radius, glaCoord start);
210    void DrawTriangle(gla_colour edge, gla_colour fill,
211                      const Vector3 &p0, const Vector3 &p1, const Vector3 &p2);
212
213    void DrawBlob(glaCoord x, glaCoord y, glaCoord z);
214    void DrawBlob(glaCoord x, glaCoord y);
215    void DrawCross(glaCoord x, glaCoord y, glaCoord z);
216    void DrawRing(glaCoord x, glaCoord y);
217
218    void PlaceVertex(const Vector3 & v, glaTexCoord tex_x, glaTexCoord tex_y) {
219        PlaceVertex(v.GetX(), v.GetY(), v.GetZ(), tex_x, tex_y);
220    }
221    void PlaceVertex(const Vector3 & v) {
222        PlaceVertex(v.GetX(), v.GetY(), v.GetZ());
223    }
224    void PlaceVertex(glaCoord x, glaCoord y, glaCoord z);
225    void PlaceVertex(glaCoord x, glaCoord y, glaCoord z,
226                     glaTexCoord tex_x, glaTexCoord tex_y);
227    void PlaceIndicatorVertex(glaCoord x, glaCoord y);
228
229    void PlaceNormal(const Vector3 &v);
230
231    void EnableDashedLines();
232    void DisableDashedLines();
233
234    void EnableSmoothPolygons(bool filled);
235    void DisableSmoothPolygons();
236
237    void SetRotation(double pan, double tilt) {
238        m_Pan = pan;
239        m_Tilt = tilt;
240    }
241    void SetScale(Double);
242    void SetTranslation(const Vector3 &v) {
243        m_Translation = v;
244    }
245    void AddTranslation(const Vector3 &v) {
246        m_Translation += v;
247    }
248    const Vector3 & GetTranslation() const {
249        return m_Translation;
250    }
251    void AddTranslationScreenCoordinates(int dx, int dy);
252
253    bool Transform(const Vector3 & v, double* x_out, double* y_out, double* z_out) const;
254    void ReverseTransform(Double x, Double y, double* x_out, double* y_out, double* z_out) const;
255
256    int GetFontSize() const { return m_Font.get_font_size(); }
257
258    void ToggleSmoothShading();
259    bool GetSmoothShading() const { return m_SmoothShading; }
260
261    Double SurveyUnitsAcrossViewport() const;
262
263    void ToggleTextured();
264    bool GetTextured() const { return m_Textured; }
265
266    void TogglePerspective() { m_Perspective = !m_Perspective; }
267    bool GetPerspective() const { return m_Perspective; }
268
269    void ToggleFog() { m_Fog = !m_Fog; }
270    bool GetFog() const { return m_Fog; }
271
272    void ToggleAntiAlias() { m_AntiAlias = !m_AntiAlias; }
273    bool GetAntiAlias() const { return m_AntiAlias; }
274
275    bool SaveScreenshot(const wxString & fnm, wxBitmapType type) const;
276
277    void ReadPixels(int width, int height, unsigned char * buf) const;
278
279    void PolygonOffset(bool on) const;
280
281    int GetXSize() const { list_flags |= INVALIDATE_ON_X_RESIZE; return x_size; }
282    int GetYSize() const { list_flags |= INVALIDATE_ON_Y_RESIZE; return y_size; }
283
284    void OnSize(wxSizeEvent & event);
285
286    glaCoord GetVolumeDiameter() const { return m_VolumeDiameter; }
287
288private:
289    DECLARE_EVENT_TABLE()
290};
Note: See TracBrowser for help on using the repository browser.