source: git/src/gfxcore.h @ d347a2c

RELEASE/1.2debug-cidebug-ci-sanitisersfaster-cavernloglog-selectstereostereo-2025walls-datawalls-data-hanging-as-warningwarn-only-for-hanging-survey
Last change on this file since d347a2c was 6388423, checked in by Olly Betts <olly@…>, 10 years ago

src/gfxcore.cc,src/gfxcore.h: Render terrain as a transparent mesh of
triangles.
  • Property mode set to 100644
File size: 16.6 KB
Line 
1//
2//  gfxcore.h
3//
4//  Core drawing code for Aven.
5//
6//  Copyright (C) 2000-2001,2002,2005 Mark R. Shinwell.
7//  Copyright (C) 2001-2004,2005,2006,2007,2010,2011,2012,2013,2014,2015 Olly Betts
8//  Copyright (C) 2005 Martin Green
9//
10//  This program is free software; you can redistribute it and/or modify
11//  it under the terms of the GNU General Public License as published by
12//  the Free Software Foundation; either version 2 of the License, or
13//  (at your option) any later version.
14//
15//  This program is distributed in the hope that it will be useful,
16//  but WITHOUT ANY WARRANTY; without even the implied warranty of
17//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18//  GNU General Public License for more details.
19//
20//  You should have received a copy of the GNU General Public License
21//  along with this program; if not, write to the Free Software
22//  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
23//
24
25#ifndef gfxcore_h
26#define gfxcore_h
27
28#include <float.h>
29#include <limits.h>
30#include <time.h>
31
32#include "img_hosted.h"
33
34#include "guicontrol.h"
35#include "labelinfo.h"
36#include "vector3.h"
37#include "wx.h"
38#include "gla.h"
39
40#include <list>
41#include <utility>
42#include <vector>
43
44using namespace std;
45
46class MainFrm;
47class traverse;
48
49class XSect;
50class PointInfo;
51class MovieMaker;
52
53class PresentationMark : public Point {
54  public:
55    Double angle, tilt_angle;
56    Double scale;
57    Double time;
58    PresentationMark() : Point(), angle(0), tilt_angle(0), scale(0), time(0)
59        { }
60    PresentationMark(const Vector3 & v, Double angle_, Double tilt_angle_,
61                     Double scale_, Double time_ = 0)
62        : Point(v), angle(angle_), tilt_angle(tilt_angle_), scale(scale_),
63          time(time_)
64        { }
65    bool is_valid() const { return scale > 0; }
66};
67
68struct ZoomBox {
69  public:
70    int x1, y1, x2, y2;
71
72    ZoomBox()
73        : x1(INT_MAX) { }
74
75    bool active() const { return x1 != INT_MAX; }
76
77    void set(const wxPoint & p1, const wxPoint & p2) {
78        x1 = p1.x;
79        y1 = p1.y;
80        x2 = p2.x;
81        y2 = p2.y;
82    }
83
84    void unset() {
85        x1 = INT_MAX;
86    }
87};
88
89enum {
90    COLOUR_BY_NONE,
91    COLOUR_BY_DEPTH,
92    COLOUR_BY_DATE,
93    COLOUR_BY_ERROR,
94    COLOUR_BY_GRADIENT,
95    COLOUR_BY_LENGTH,
96    COLOUR_BY_LIMIT_ // Leave this last.
97};
98
99enum {
100    UPDATE_NONE,
101    UPDATE_BLOBS,
102    UPDATE_BLOBS_AND_CROSSES
103};
104
105enum {
106      SPLAYS_HIDE,
107      SPLAYS_SHOW_FADED,
108      SPLAYS_SHOW_NORMAL,
109};
110
111// It's pointless to redraw the screen as often as we can on a fast machine,
112// since the display hardware will only update so many times per second.
113// This is the maximum framerate we'll redraw at.
114const int MAX_FRAMERATE = 50;
115
116class GfxCore : public GLACanvas {
117    Double m_Scale;
118    int m_ScaleBarWidth;
119
120    typedef enum {
121        LIST_COMPASS,
122        LIST_CLINO,
123        LIST_CLINO_BACK,
124        LIST_SCALE_BAR,
125        LIST_DEPTH_KEY,
126        LIST_DATE_KEY,
127        LIST_ERROR_KEY,
128        LIST_GRADIENT_KEY,
129        LIST_LENGTH_KEY,
130        LIST_UNDERGROUND_LEGS,
131        LIST_TUBES,
132        LIST_SURFACE_LEGS,
133        LIST_BLOBS,
134        LIST_CROSSES,
135        LIST_GRID,
136        LIST_SHADOW,
137        LIST_TERRAIN,
138        LIST_LIMIT_ // Leave this last.
139    } drawing_list;
140
141    static const int NUM_COLOUR_BANDS = 13;
142
143    void SetPanBase() {
144        base_pan = m_PanAngle;
145        base_pan_time = timer.Time() - (1000 / MAX_FRAMERATE);
146    }
147
148    void SetTiltBase() {
149        base_tilt = m_TiltAngle;
150        base_tilt_time = timer.Time() - (1000 / MAX_FRAMERATE);
151    }
152
153    int GetCompassWidth() const;
154    int GetClinoWidth() const;
155
156public:
157    typedef enum {
158        CURSOR_DEFAULT,
159        CURSOR_POINTING_HAND,
160        CURSOR_DRAGGING_HAND,
161        CURSOR_HORIZONTAL_RESIZE,
162        CURSOR_ROTATE_HORIZONTALLY,
163        CURSOR_ROTATE_VERTICALLY,
164        CURSOR_ROTATE_EITHER_WAY,
165        CURSOR_ZOOM,
166        CURSOR_ZOOM_ROTATE
167    } cursor;
168
169private:
170    GUIControl* m_Control;
171    char* m_LabelGrid;
172    MainFrm* m_Parent;
173    bool m_DoneFirstShow;
174    Double m_TiltAngle;
175    Double m_PanAngle;
176    bool m_Rotating;
177    Double m_RotationStep;
178    int m_SwitchingTo;
179    bool m_Crosses;
180    bool m_Legs;
181    int m_Splays;
182    bool m_Names;
183    bool m_Scalebar;
184    bool m_ColourKey;
185    bool m_OverlappingNames;
186    bool m_Compass;
187    bool m_Clino;
188    bool m_Tubes;
189    int m_ColourBy;
190
191    bool m_HaveData;
192    bool m_HaveTerrain;
193    bool m_MouseOutsideCompass;
194    bool m_MouseOutsideElev;
195    bool m_Surface;
196    bool m_Entrances;
197    bool m_FixedPts;
198    bool m_ExportedPts;
199    bool m_Grid;
200    bool m_BoundingBox;
201    bool m_Terrain;
202
203    bool m_Degrees;
204    bool m_Metric;
205    bool m_Percent;
206
207    bool m_HitTestDebug;
208
209    list<LabelInfo*> *m_PointGrid;
210    bool m_HitTestGridValid;
211
212    LabelInfo temp_here;
213    const LabelInfo * m_here;
214    const LabelInfo * m_there;
215
216    wxStopWatch timer;
217    long base_tilt_time;
218    long base_pan_time;
219    Double base_tilt;
220    Double base_pan;
221
222    GLAPen m_Pens[NUM_COLOUR_BANDS + 1];
223
224#define PLAYING 1
225    int presentation_mode; // for now, 0 => off, PLAYING => continuous play
226    bool pres_reverse;
227    double pres_speed;
228    PresentationMark next_mark;
229    double next_mark_time;
230    double this_mark_total;
231
232    MovieMaker * movie;
233
234    cursor current_cursor;
235
236    int sqrd_measure_threshold;
237
238    // The legends for each entry in the colour key.
239    wxString key_legends[NUM_COLOUR_BANDS];
240
241    wxPoint key_lowerleft[COLOUR_BY_LIMIT_];
242
243    ZoomBox zoombox;
244
245    size_t n_tris;
246
247    void PlaceVertexWithColour(const Vector3 &v, Double factor = 1.0);
248    void PlaceVertexWithColour(const Vector3 & v, GLint tex_x, GLint tex_y,
249                               Double factor);
250    void SetDepthColour(Double z, Double factor);
251    void PlaceVertexWithDepthColour(const Vector3 & v, Double factor = 1.0);
252    void PlaceVertexWithDepthColour(const Vector3 & v, GLint tex_x, GLint tex_y, Double factor);
253
254    void SetColourFrom01(double how_far, Double factor);
255
256    void SetColourFromDate(int date, Double factor);
257    void SetColourFromError(double E, Double factor);
258    void SetColourFromGradient(double angle, Double factor);
259    void SetColourFromLength(double len, Double factor);
260
261    int GetClinoOffset() const;
262    void DrawTick(int angle_cw);
263    void DrawArrow(gla_colour col1, gla_colour col2);
264
265    void SkinPassage(vector<XSect> & centreline, bool draw = true);
266
267    virtual void GenerateList(unsigned int l);
268    void GenerateDisplayList();
269    void GenerateDisplayListTubes();
270    void GenerateDisplayListSurface();
271    void DrawTerrainTriangle(const Vector3 & a, const Vector3 & b, const Vector3 & c);
272    void DrawTerrain();
273    void GenerateDisplayListShadow();
274    void GenerateBlobsDisplayList();
275
276    void DrawIndicators();
277
278    void TryToFreeArrays();
279    void FirstShow();
280
281    void DrawScaleBar();
282    void DrawColourKey(int num_bands, const wxString & other, const wxString & units);
283    void DrawDepthKey();
284    void DrawDateKey();
285    void DrawErrorKey();
286    void DrawGradientKey();
287    void DrawLengthKey();
288    void DrawCompass();
289    void DrawClino();
290    void DrawClinoBack();
291    void Draw2dIndicators();
292    void DrawGrid();
293
294    void NattyDrawNames();
295    void SimpleDrawNames();
296
297    void DefaultParameters();
298
299    void Repaint();
300
301    void CreateHitTestGrid();
302
303    int GetCompassXPosition() const;
304    int GetClinoXPosition() const;
305    int GetIndicatorYPosition() const;
306    int GetIndicatorRadius() const;
307
308    void ToggleFlag(bool* flag, int update = UPDATE_NONE);
309
310    const GLAPen& GetPen(int band) const {
311        assert(band >= 0 && band < NUM_COLOUR_BANDS);
312        return m_Pens[band];
313    }
314
315    const GLAPen& GetSurfacePen() const { return m_Pens[NUM_COLOUR_BANDS]; }
316
317    int GetNumColourBands() const { return NUM_COLOUR_BANDS; }
318
319    void DrawShadowedBoundingBox();
320    void DrawBoundingBox();
321
322public:
323    GfxCore(MainFrm* parent, wxWindow* parent_window, GUIControl* control);
324    ~GfxCore();
325
326    void Initialise(bool same_file);
327    void InitialiseTerrain();
328
329    void UpdateBlobs();
330    void ForceRefresh();
331
332    void RefreshLine(const Point* a, const Point* b, const Point* c);
333
334    void SetHereFromTree(const LabelInfo * p);
335
336    void SetHere();
337    void SetHere(const LabelInfo * p);
338    void SetThere();
339    void SetThere(const LabelInfo * p);
340
341    void CentreOn(const Point &p);
342
343    void TranslateCave(int dx, int dy);
344    void TiltCave(Double tilt_angle);
345    void TurnCave(Double angle);
346    void TurnCaveTo(Double angle);
347
348    void OnPaint(wxPaintEvent&);
349    void OnSize(wxSizeEvent& event);
350    void OnIdle(wxIdleEvent& event);
351
352    void OnMouseMove(wxMouseEvent& event) { m_Control->OnMouseMove(event); }
353    void OnLeaveWindow(wxMouseEvent& event);
354
355    void OnLButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnLButtonDown(event); }
356    void OnLButtonUp(wxMouseEvent& event) { m_Control->OnLButtonUp(event); }
357    void OnMButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnMButtonDown(event); }
358    void OnMButtonUp(wxMouseEvent& event) { m_Control->OnMButtonUp(event); }
359    void OnRButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnRButtonDown(event); }
360    void OnRButtonUp(wxMouseEvent& event) { m_Control->OnRButtonUp(event); }
361    void OnMouseWheel(wxMouseEvent& event) { SetFocus(); m_Control->OnMouseWheel(event); }
362    void OnKeyPress(wxKeyEvent &event) { m_Control->OnKeyPress(event); }
363
364    void Animate();
365    bool Animating() const {
366        return m_Rotating || m_SwitchingTo || presentation_mode != 0;
367    }
368
369    void ClearCoords();
370    void SetCoords(wxPoint);
371
372    // Determine whether the compass is currently shown.
373    bool ShowingCompass() const { return m_Compass; }
374    // Determine whether the clino is currently shown.
375    bool ShowingClino() const { return m_Clino; }
376
377    bool PointWithinCompass(wxPoint point) const;
378    bool PointWithinClino(wxPoint point) const;
379    bool PointWithinScaleBar(wxPoint point) const;
380    bool PointWithinColourKey(wxPoint point) const;
381
382    void SetCompassFromPoint(wxPoint point);
383    void SetClinoFromPoint(wxPoint point);
384    void SetScaleBarFromOffset(wxCoord dx);
385
386    void RedrawIndicators();
387
388    void StartRotation();
389    void ToggleRotation();
390    void StopRotation();
391    bool IsExtendedElevation() const;
392    void ReverseRotation();
393    void RotateSlower(bool accel);
394    void RotateFaster(bool accel);
395
396    void SwitchToElevation();
397    void SwitchToPlan();
398
399    void SetViewTo(Double xmin, Double xmax, Double ymin, Double ymax, Double zmin, Double zmax);
400
401    double GetCompassValue() const { return m_PanAngle; }
402    bool ShowingPlan() const;
403    bool ShowingElevation() const;
404    bool ShowingMeasuringLine() const;
405    bool HereIsReal() const { return m_here && m_here != &temp_here; }
406
407    bool CanRaiseViewpoint() const;
408    bool CanLowerViewpoint() const;
409
410    bool IsRotating() const { return m_Rotating; }
411    bool HasData() const { return m_DoneFirstShow && m_HaveData; }
412    bool HasTerrain() const { return m_DoneFirstShow && m_HaveTerrain; }
413    bool HasDepth() const;
414    bool HasErrorInformation() const;
415    bool HasDateInformation() const;
416
417    double GetScale() const { return m_Scale; }
418    void SetScale(Double scale);
419
420    bool ShowingStationNames() const { return m_Names; }
421    bool ShowingOverlappingNames() const { return m_OverlappingNames; }
422    bool ShowingCrosses() const { return m_Crosses; }
423    bool ShowingGrid() const { return m_Grid; }
424
425    int ColouringBy() const { return m_ColourBy; }
426
427    bool HasUndergroundLegs() const;
428    bool HasSplays() const;
429    bool HasSurfaceLegs() const;
430    bool HasTubes() const;
431
432    bool ShowingUndergroundLegs() const { return m_Legs; }
433    int ShowingSplaysMode() const { return m_Splays; }
434    bool ShowingSurfaceLegs() const { return m_Surface; }
435
436    bool ShowingColourKey() const { return m_ColourKey; }
437    bool ShowingScaleBar() const { return m_Scalebar; }
438
439    bool ShowingEntrances() const { return m_Entrances; }
440    bool ShowingFixedPts() const { return m_FixedPts; }
441    bool ShowingExportedPts() const { return m_ExportedPts; }
442
443    int GetNumEntrances() const;
444    int GetNumFixedPts() const;
445    int GetNumExportedPts() const;
446
447    void ToggleUndergroundLegs() {
448        ToggleFlag(&m_Legs, UPDATE_BLOBS_AND_CROSSES);
449    }
450    void SetSplaysMode(int mode) {
451        m_Splays = mode;
452        UpdateBlobs();
453        InvalidateList(LIST_UNDERGROUND_LEGS);
454        ForceRefresh();
455    }
456    void ToggleSurfaceLegs() {
457        ToggleFlag(&m_Surface, UPDATE_BLOBS_AND_CROSSES);
458    }
459    void ToggleCompass() {
460        ToggleFlag(&m_Compass);
461        InvalidateList(LIST_SCALE_BAR);
462    }
463    void ToggleClino() {
464        ToggleFlag(&m_Clino);
465        InvalidateList(LIST_SCALE_BAR);
466    }
467    void ToggleScaleBar() { ToggleFlag(&m_Scalebar); }
468    void ToggleEntrances() { ToggleFlag(&m_Entrances, UPDATE_BLOBS); }
469    void ToggleFixedPts() { ToggleFlag(&m_FixedPts, UPDATE_BLOBS); }
470    void ToggleExportedPts() { ToggleFlag(&m_ExportedPts, UPDATE_BLOBS); }
471    void ToggleGrid() { ToggleFlag(&m_Grid); }
472    void ToggleCrosses() { ToggleFlag(&m_Crosses); }
473    void ToggleStationNames() { ToggleFlag(&m_Names); }
474    void ToggleOverlappingNames() { ToggleFlag(&m_OverlappingNames); }
475    void ToggleColourKey() { ToggleFlag(&m_ColourKey); }
476    void ToggleMetric() {
477        ToggleFlag(&m_Metric);
478        InvalidateList(LIST_DEPTH_KEY);
479        InvalidateList(LIST_LENGTH_KEY);
480        InvalidateList(LIST_SCALE_BAR);
481    }
482    void ToggleHitTestDebug() {
483        ToggleFlag(&m_HitTestDebug);
484    }
485    void ToggleDegrees() {
486        ToggleFlag(&m_Degrees);
487        InvalidateList(LIST_GRADIENT_KEY);
488    }
489    void TogglePercent() { ToggleFlag(&m_Percent); }
490    void ToggleTubes() { ToggleFlag(&m_Tubes); }
491    void TogglePerspective() { GLACanvas::TogglePerspective(); ForceRefresh(); }
492    void ToggleSmoothShading();
493    bool DisplayingBoundingBox() const { return m_BoundingBox; }
494    void ToggleBoundingBox() { ToggleFlag(&m_BoundingBox); }
495    bool DisplayingTerrain() const { return m_Terrain; }
496    void ToggleTerrain() { ToggleFlag(&m_Terrain); }
497    void ToggleFatFinger();
498
499    bool GetMetric() const { return m_Metric; }
500    bool GetDegrees() const { return m_Degrees; }
501    bool GetPercent() const { return m_Percent; }
502    bool GetTubes() const { return m_Tubes; }
503
504    bool CheckHitTestGrid(const wxPoint& point, bool centre);
505
506    void ClearTreeSelection();
507
508    void Defaults();
509
510    void FullScreenMode();
511
512    bool IsFullScreen() const;
513
514    bool FullScreenModeShowingMenus() const;
515
516    void FullScreenModeShowMenus(bool show);
517
518    void DragFinished();
519
520    void SplitLineAcrossBands(int band, int band2,
521                              const Vector3 &p, const Vector3 &q,
522                              Double factor = 1.0);
523    int GetDepthColour(Double z) const;
524    Double GetDepthBoundaryBetweenBands(int a, int b) const;
525    void AddPolyline(const traverse & centreline);
526    void AddPolylineDepth(const traverse & centreline);
527    void AddPolylineDate(const traverse & centreline);
528    void AddPolylineError(const traverse & centreline);
529    void AddPolylineGradient(const traverse & centreline);
530    void AddPolylineLength(const traverse & centreline);
531    void AddQuadrilateral(const Vector3 &a, const Vector3 &b,
532                          const Vector3 &c, const Vector3 &d);
533    void AddPolylineShadow(const traverse & centreline);
534    void AddQuadrilateralDepth(const Vector3 &a, const Vector3 &b,
535                               const Vector3 &c, const Vector3 &d);
536    void AddQuadrilateralDate(const Vector3 &a, const Vector3 &b,
537                              const Vector3 &c, const Vector3 &d);
538    void AddQuadrilateralError(const Vector3 &a, const Vector3 &b,
539                               const Vector3 &c, const Vector3 &d);
540    void AddQuadrilateralGradient(const Vector3 &a, const Vector3 &b,
541                                  const Vector3 &c, const Vector3 &d);
542    void AddQuadrilateralLength(const Vector3 &a, const Vector3 &b,
543                                const Vector3 &c, const Vector3 &d);
544    void MoveViewer(double forward, double up, double right);
545
546    void (GfxCore::* AddQuad)(const Vector3 &a, const Vector3 &b,
547                              const Vector3 &c, const Vector3 &d);
548    void (GfxCore::* AddPoly)(const traverse & centreline);
549
550    PresentationMark GetView() const;
551    void SetView(const PresentationMark & p);
552    void PlayPres(double speed, bool change_speed = true);
553    int GetPresentationMode() const { return presentation_mode; }
554    double GetPresentationSpeed() const { return presentation_mode ? pres_speed : 0; }
555
556    void SetColourBy(int colour_by);
557    bool ExportMovie(const wxString & fnm);
558    void OnPrint(const wxString &filename, const wxString &title,
559                 const wxString &datestamp, time_t datestamp_numeric,
560                 const wxString &cs_proj,
561                 bool close_after_print = false);
562    void OnExport(const wxString &filename, const wxString &title,
563                  const wxString &datestamp, time_t datestamp_numeric,
564                  const wxString &cs_proj);
565    void UpdateCursor(GfxCore::cursor new_cursor);
566    bool MeasuringLineActive() const;
567
568    bool HandleRClick(wxPoint point);
569
570    void InvalidateAllLists() {
571        for (int i = 0; i < LIST_LIMIT_; ++i) {
572            InvalidateList(i);
573        }
574    }
575
576    void SetZoomBox(wxPoint p1, wxPoint p2, bool centred, bool aspect);
577
578    void UnsetZoomBox() {
579        if (!zoombox.active()) return;
580        zoombox.unset();
581        ForceRefresh();
582    }
583
584    void ZoomBoxGo();
585
586private:
587    DECLARE_EVENT_TABLE()
588};
589
590#endif
Note: See TracBrowser for help on using the repository browser.