source: git/src/gfxcore.h @ 09ad6d7

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

Make use of C++11 to avoid needing to write > >
  • Property mode set to 100644
File size: 17.9 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,2016,2017,2018 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    SHOW_HIDE,
107    SHOW_DASHED,
108    SHOW_FADED,
109    SHOW_NORMAL,
110};
111
112struct Split {
113    Vector3 vec;
114    glaCoord tx, ty;
115
116    Split(const Vector3& vec_, glaCoord tx_, glaCoord ty_)
117        : vec(vec_), tx(tx_), ty(ty_) { }
118};
119
120// It's pointless to redraw the screen as often as we can on a fast machine,
121// since the display hardware will only update so many times per second.
122// This is the maximum framerate we'll redraw at.
123const int MAX_FRAMERATE = 50;
124
125class GfxCore : public GLACanvas {
126    Double m_Scale;
127    Double initial_scale;
128    int m_ScaleBarWidth;
129
130    typedef enum {
131        LIST_COMPASS,
132        LIST_CLINO,
133        LIST_CLINO_BACK,
134        LIST_SCALE_BAR,
135        LIST_DEPTH_KEY,
136        LIST_DATE_KEY,
137        LIST_ERROR_KEY,
138        LIST_GRADIENT_KEY,
139        LIST_LENGTH_KEY,
140        LIST_UNDERGROUND_LEGS,
141        LIST_TUBES,
142        LIST_SURFACE_LEGS,
143        LIST_BLOBS,
144        LIST_CROSSES,
145        LIST_GRID,
146        LIST_SHADOW,
147        LIST_TERRAIN,
148        LIST_LIMIT_ // Leave this last.
149    } drawing_list;
150
151    static const int NUM_COLOUR_BANDS = 13;
152
153    void SetPanBase() {
154        base_pan = m_PanAngle;
155        base_pan_time = timer.Time() - (1000 / MAX_FRAMERATE);
156    }
157
158    void SetTiltBase() {
159        base_tilt = m_TiltAngle;
160        base_tilt_time = timer.Time() - (1000 / MAX_FRAMERATE);
161    }
162
163    int GetCompassWidth() const;
164    int GetClinoWidth() const;
165
166public:
167    typedef enum {
168        CURSOR_DEFAULT,
169        CURSOR_POINTING_HAND,
170        CURSOR_DRAGGING_HAND,
171        CURSOR_HORIZONTAL_RESIZE,
172        CURSOR_ROTATE_HORIZONTALLY,
173        CURSOR_ROTATE_VERTICALLY,
174        CURSOR_ROTATE_EITHER_WAY,
175        CURSOR_ZOOM,
176        CURSOR_ZOOM_ROTATE
177    } cursor;
178
179private:
180    GUIControl* m_Control;
181    char* m_LabelGrid;
182    MainFrm* m_Parent;
183    bool m_DoneFirstShow;
184    Double m_TiltAngle;
185    Double m_PanAngle;
186    bool m_Rotating;
187    Double m_RotationStep;
188    int m_SwitchingTo;
189    bool m_Crosses;
190    bool m_Legs;
191    int m_Splays;
192    int m_Dupes;
193    bool m_Names;
194    bool m_Scalebar;
195    bool m_ColourKey;
196    bool m_OverlappingNames;
197    bool m_Compass;
198    bool m_Clino;
199    bool m_Tubes;
200    int m_ColourBy;
201
202    bool m_HaveData;
203    bool m_HaveTerrain;
204    bool m_MouseOutsideCompass;
205    bool m_MouseOutsideElev;
206    bool m_Surface;
207    bool m_Entrances;
208    bool m_FixedPts;
209    bool m_ExportedPts;
210    bool m_Grid;
211    bool m_BoundingBox;
212    bool m_Terrain;
213
214    bool m_Degrees;
215    bool m_Metric;
216    bool m_Percent;
217
218    bool m_HitTestDebug;
219    bool m_RenderStats;
220
221    list<LabelInfo*> *m_PointGrid;
222    bool m_HitTestGridValid;
223
224    LabelInfo temp_here;
225    const LabelInfo * m_here;
226    const LabelInfo * m_there;
227
228    wxStopWatch timer;
229    long base_tilt_time;
230    long base_pan_time;
231    Double base_tilt;
232    Double base_pan;
233
234    GLAPen m_Pens[NUM_COLOUR_BANDS + 1];
235
236#define PLAYING 1
237    int presentation_mode; // for now, 0 => off, PLAYING => continuous play
238    bool pres_reverse;
239    double pres_speed;
240    PresentationMark next_mark;
241    double next_mark_time;
242    double this_mark_total;
243
244    MovieMaker * movie;
245
246    cursor current_cursor;
247
248    int sqrd_measure_threshold;
249
250    // The legends for each entry in the colour key.
251    wxString key_legends[NUM_COLOUR_BANDS];
252
253    wxPoint key_lowerleft[COLOUR_BY_LIMIT_];
254
255    ZoomBox zoombox;
256
257    // Copied from parent, so we can adjust view when reloading the same
258    // file with the view restricted.
259    Vector3 offsets;
260
261    // DEM:
262    unsigned short * dem;
263    unsigned long dem_width, dem_height;
264    double o_x, o_y, step_x, step_y;
265    long nodata_value;
266    bool bigendian;
267    long last_time;
268    size_t n_tris;
269
270    void PlaceVertexWithColour(const Vector3 &v, Double factor = 1.0);
271    void PlaceVertexWithColour(const Vector3 & v,
272                               glaTexCoord tex_x, glaTexCoord tex_y,
273                               Double factor);
274    void SetDepthColour(Double z, Double factor);
275    void PlaceVertexWithDepthColour(const Vector3 & v, Double factor = 1.0);
276    void PlaceVertexWithDepthColour(const Vector3 & v,
277                                    glaTexCoord tex_x, glaTexCoord tex_y,
278                                    Double factor);
279
280    void SetColourFrom01(double how_far, Double factor);
281
282    void SetColourFromDate(int date, Double factor);
283    void SetColourFromError(double E, Double factor);
284    void SetColourFromGradient(double angle, Double factor);
285    void SetColourFromLength(double len, Double factor);
286
287    int GetClinoOffset() const;
288    void DrawTick(int angle_cw);
289    void DrawArrow(gla_colour col1, gla_colour col2);
290
291    void SkinPassage(vector<XSect> & centreline, bool draw = true);
292
293    virtual void GenerateList(unsigned int l);
294    void GenerateDisplayList(bool surface);
295    void GenerateDisplayListTubes();
296    void DrawTerrainTriangle(const Vector3 & a, const Vector3 & b, const Vector3 & c);
297    void DrawTerrain();
298    void GenerateDisplayListShadow();
299    void GenerateBlobsDisplayList();
300
301    void DrawIndicators();
302
303    void TryToFreeArrays();
304    void FirstShow();
305
306    void DrawScaleBar();
307    void DrawColourKey(int num_bands, const wxString & other, const wxString & units);
308    void DrawDepthKey();
309    void DrawDateKey();
310    void DrawErrorKey();
311    void DrawGradientKey();
312    void DrawLengthKey();
313    void DrawCompass();
314    void DrawClino();
315    void DrawClinoBack();
316    void Draw2dIndicators();
317    void DrawGrid();
318
319    void NattyDrawNames();
320    void SimpleDrawNames();
321
322    void DefaultParameters();
323
324    void Repaint();
325
326    void CreateHitTestGrid();
327
328    int GetCompassXPosition() const;
329    int GetClinoXPosition() const;
330    int GetIndicatorYPosition() const;
331    int GetIndicatorRadius() const;
332
333    void ToggleFlag(bool* flag, int update = UPDATE_NONE);
334
335    const GLAPen& GetPen(int band) const {
336        assert(band >= 0 && band < NUM_COLOUR_BANDS);
337        return m_Pens[band];
338    }
339
340    const GLAPen& GetSurfacePen() const { return m_Pens[NUM_COLOUR_BANDS]; }
341
342    int GetNumColourBands() const { return NUM_COLOUR_BANDS; }
343
344    void DrawShadowedBoundingBox();
345    void DrawBoundingBox();
346
347public:
348    GfxCore(MainFrm* parent, wxWindow* parent_window, GUIControl* control);
349    ~GfxCore();
350
351    void Initialise(bool same_file);
352
353    void UpdateBlobs();
354    void ForceRefresh();
355
356    void RefreshLine(const Point* a, const Point* b, const Point* c);
357
358    void SetHereFromTree(const LabelInfo * p);
359
360    void SetHere(const LabelInfo * p = NULL);
361    void SetThere(const LabelInfo * p = NULL);
362
363    const LabelInfo* GetThere() const { return m_there; }
364
365    void CentreOn(const Point &p);
366
367    void TranslateCave(int dx, int dy);
368    void TiltCave(Double tilt_angle);
369    void TurnCave(Double angle);
370    void TurnCaveTo(Double angle);
371
372    void OnPaint(wxPaintEvent&);
373    void OnSize(wxSizeEvent& event);
374    void OnIdle(wxIdleEvent& event);
375
376    void OnMouseMove(wxMouseEvent& event) { m_Control->OnMouseMove(event); }
377    void OnLeaveWindow(wxMouseEvent& event);
378
379    void OnLButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnLButtonDown(event); }
380    void OnLButtonUp(wxMouseEvent& event) { m_Control->OnLButtonUp(event); }
381    void OnMButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnMButtonDown(event); }
382    void OnMButtonUp(wxMouseEvent& event) { m_Control->OnMButtonUp(event); }
383    void OnRButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnRButtonDown(event); }
384    void OnRButtonUp(wxMouseEvent& event) { m_Control->OnRButtonUp(event); }
385    void OnMouseWheel(wxMouseEvent& event) { SetFocus(); m_Control->OnMouseWheel(event); }
386    void OnKeyPress(wxKeyEvent &event) { m_Control->OnKeyPress(event); }
387
388    void Animate();
389    bool Animating() const {
390        return m_Rotating || m_SwitchingTo || presentation_mode != 0;
391    }
392
393    void ClearCoords();
394    void SetCoords(wxPoint);
395
396    // Determine whether the compass is currently shown.
397    bool ShowingCompass() const { return m_Compass; }
398    // Determine whether the clino is currently shown.
399    bool ShowingClino() const { return m_Clino; }
400
401    bool PointWithinCompass(wxPoint point) const;
402    bool PointWithinClino(wxPoint point) const;
403    bool PointWithinScaleBar(wxPoint point) const;
404    bool PointWithinColourKey(wxPoint point) const;
405
406    void SetCompassFromPoint(wxPoint point);
407    void SetClinoFromPoint(wxPoint point);
408    void SetScaleBarFromOffset(wxCoord dx);
409
410    void RedrawIndicators();
411
412    void StartRotation();
413    void ToggleRotation();
414    void StopRotation();
415    bool IsExtendedElevation() const;
416    void ReverseRotation();
417    void RotateSlower(bool accel);
418    void RotateFaster(bool accel);
419
420    void SwitchToElevation();
421    void SwitchToPlan();
422
423    void SetViewTo(Double xmin, Double xmax, Double ymin, Double ymax, Double zmin, Double zmax);
424
425    double GetCompassValue() const { return m_PanAngle; }
426    bool ShowingPlan() const;
427    bool ShowingElevation() const;
428    bool ShowingMeasuringLine() const;
429    bool HereIsReal() const { return m_here && m_here != &temp_here; }
430
431    bool CanRaiseViewpoint() const;
432    bool CanLowerViewpoint() const;
433
434    bool IsRotating() const { return m_Rotating; }
435    bool HasData() const { return m_DoneFirstShow && m_HaveData; }
436    bool HasTerrain() const { return m_DoneFirstShow && m_HaveTerrain; }
437    bool HasDepth() const;
438    bool HasErrorInformation() const;
439    bool HasDateInformation() const;
440
441    double GetScale() const { return m_Scale; }
442    void SetScale(Double scale);
443
444    bool ShowingStationNames() const { return m_Names; }
445    bool ShowingOverlappingNames() const { return m_OverlappingNames; }
446    bool ShowingCrosses() const { return m_Crosses; }
447    bool ShowingGrid() const { return m_Grid; }
448
449    int ColouringBy() const { return m_ColourBy; }
450
451    bool HasUndergroundLegs() const;
452    bool HasSplays() const;
453    bool HasDupes() const;
454    bool HasSurfaceLegs() const;
455    bool HasTubes() const;
456
457    bool ShowingUndergroundLegs() const { return m_Legs; }
458    int ShowingSplaysMode() const { return m_Splays; }
459    int ShowingDupesMode() const { return m_Dupes; }
460    bool ShowingSurfaceLegs() const { return m_Surface; }
461
462    bool ShowingColourKey() const { return m_ColourKey; }
463    bool ShowingScaleBar() const { return m_Scalebar; }
464
465    bool ShowingEntrances() const { return m_Entrances; }
466    bool ShowingFixedPts() const { return m_FixedPts; }
467    bool ShowingExportedPts() const { return m_ExportedPts; }
468
469    int GetNumEntrances() const;
470    int GetNumFixedPts() const;
471    int GetNumExportedPts() const;
472
473    void ToggleUndergroundLegs() {
474        ToggleFlag(&m_Legs, UPDATE_BLOBS_AND_CROSSES);
475    }
476    void SetSplaysMode(int mode) {
477        m_Splays = mode;
478        UpdateBlobs();
479        InvalidateList(LIST_SURFACE_LEGS);
480        InvalidateList(LIST_UNDERGROUND_LEGS);
481        ForceRefresh();
482    }
483    void SetDupesMode(int mode) {
484        m_Dupes = mode;
485        UpdateBlobs();
486        InvalidateList(LIST_SURFACE_LEGS);
487        InvalidateList(LIST_UNDERGROUND_LEGS);
488        ForceRefresh();
489    }
490    void ToggleSurfaceLegs() {
491        ToggleFlag(&m_Surface, UPDATE_BLOBS_AND_CROSSES);
492    }
493    void ToggleCompass() {
494        ToggleFlag(&m_Compass);
495        InvalidateList(LIST_SCALE_BAR);
496    }
497    void ToggleClino() {
498        ToggleFlag(&m_Clino);
499        InvalidateList(LIST_SCALE_BAR);
500    }
501    void ToggleScaleBar() { ToggleFlag(&m_Scalebar); }
502    void ToggleEntrances() { ToggleFlag(&m_Entrances, UPDATE_BLOBS); }
503    void ToggleFixedPts() { ToggleFlag(&m_FixedPts, UPDATE_BLOBS); }
504    void ToggleExportedPts() { ToggleFlag(&m_ExportedPts, UPDATE_BLOBS); }
505    void ToggleGrid() { ToggleFlag(&m_Grid); }
506    void ToggleCrosses() { ToggleFlag(&m_Crosses); }
507    void ToggleStationNames() { ToggleFlag(&m_Names); }
508    void ToggleOverlappingNames() { ToggleFlag(&m_OverlappingNames); }
509    void ToggleColourKey() { ToggleFlag(&m_ColourKey); }
510    void ToggleMetric() {
511        ToggleFlag(&m_Metric);
512        InvalidateList(LIST_DEPTH_KEY);
513        InvalidateList(LIST_LENGTH_KEY);
514        InvalidateList(LIST_SCALE_BAR);
515    }
516    void ToggleHitTestDebug() {
517        ToggleFlag(&m_HitTestDebug);
518    }
519    void ToggleRenderStats() {
520        ToggleFlag(&m_RenderStats);
521    }
522    void ToggleDegrees() {
523        ToggleFlag(&m_Degrees);
524        InvalidateList(LIST_GRADIENT_KEY);
525    }
526    void TogglePercent() { ToggleFlag(&m_Percent); }
527    void ToggleTubes() { ToggleFlag(&m_Tubes); }
528    void TogglePerspective() { GLACanvas::TogglePerspective(); ForceRefresh(); }
529    void ToggleSmoothShading();
530    bool DisplayingBoundingBox() const { return m_BoundingBox; }
531    void ToggleBoundingBox() { ToggleFlag(&m_BoundingBox); }
532    bool DisplayingTerrain() const { return m_Terrain; }
533    void ToggleTerrain();
534    void ToggleFatFinger();
535    void ToggleTextured() {
536        GLACanvas::ToggleTextured();
537        ForceRefresh();
538    }
539
540    bool GetMetric() const { return m_Metric; }
541    bool GetDegrees() const { return m_Degrees; }
542    bool GetPercent() const { return m_Percent; }
543    bool GetTubes() const { return m_Tubes; }
544
545    bool CheckHitTestGrid(const wxPoint& point, bool centre);
546
547    void ClearTreeSelection();
548
549    void Defaults();
550
551    void FullScreenMode();
552
553    bool IsFullScreen() const;
554
555    bool FullScreenModeShowingMenus() const;
556
557    void FullScreenModeShowMenus(bool show);
558
559    void DragFinished();
560
561    void SplitLineAcrossBands(int band, int band2,
562                              const Vector3 &p, const Vector3 &q,
563                              Double factor = 1.0);
564    void SplitPolyAcrossBands(vector<vector<Split>>& splits,
565                              int band, int band2,
566                              const Vector3 &p, const Vector3 &q,
567                              glaTexCoord ptx, glaTexCoord pty,
568                              glaTexCoord w, glaTexCoord h);
569    int GetDepthColour(Double z) const;
570    Double GetDepthBoundaryBetweenBands(int a, int b) const;
571    void AddPolyline(const traverse & centreline);
572    void AddPolylineDepth(const traverse & centreline);
573    void AddPolylineDate(const traverse & centreline);
574    void AddPolylineError(const traverse & centreline);
575    void AddPolylineGradient(const traverse & centreline);
576    void AddPolylineLength(const traverse & centreline);
577    void AddQuadrilateral(const Vector3 &a, const Vector3 &b,
578                          const Vector3 &c, const Vector3 &d);
579    void AddPolylineShadow(const traverse & centreline);
580    void AddQuadrilateralDepth(const Vector3 &a, const Vector3 &b,
581                               const Vector3 &c, const Vector3 &d);
582    void AddQuadrilateralDate(const Vector3 &a, const Vector3 &b,
583                              const Vector3 &c, const Vector3 &d);
584    void AddQuadrilateralError(const Vector3 &a, const Vector3 &b,
585                               const Vector3 &c, const Vector3 &d);
586    void AddQuadrilateralGradient(const Vector3 &a, const Vector3 &b,
587                                  const Vector3 &c, const Vector3 &d);
588    void AddQuadrilateralLength(const Vector3 &a, const Vector3 &b,
589                                const Vector3 &c, const Vector3 &d);
590    void MoveViewer(double forward, double up, double right);
591
592    void (GfxCore::* AddQuad)(const Vector3 &a, const Vector3 &b,
593                              const Vector3 &c, const Vector3 &d);
594    void (GfxCore::* AddPoly)(const traverse & centreline);
595
596    PresentationMark GetView() const;
597    void SetView(const PresentationMark & p);
598    void PlayPres(double speed, bool change_speed = true);
599    int GetPresentationMode() const { return presentation_mode; }
600    double GetPresentationSpeed() const { return presentation_mode ? pres_speed : 0; }
601
602    void SetColourBy(int colour_by);
603    bool ExportMovie(const wxString & fnm);
604    void OnPrint(const wxString &filename, const wxString &title,
605                 const wxString &datestamp,
606                 bool close_after_print = false);
607    void OnExport(const wxString &filename, const wxString &title,
608                  const wxString &datestamp);
609    void UpdateCursor(GfxCore::cursor new_cursor);
610    bool MeasuringLineActive() const;
611
612    bool HandleRClick(wxPoint point);
613
614    void InvalidateAllLists() {
615        for (int i = 0; i < LIST_LIMIT_; ++i) {
616            InvalidateList(i);
617        }
618    }
619
620    void SetZoomBox(wxPoint p1, wxPoint p2, bool centred, bool aspect);
621
622    void UnsetZoomBox() {
623        if (!zoombox.active()) return;
624        zoombox.unset();
625        ForceRefresh();
626    }
627
628    void ZoomBoxGo();
629
630    void parse_hgt_filename(const wxString & lc_name);
631    size_t parse_hdr(wxInputStream & is, unsigned long & skipbytes);
632    bool read_bil(wxInputStream & is, size_t size, unsigned long skipbytes);
633    bool LoadDEM(const wxString & file);
634
635private:
636    DECLARE_EVENT_TABLE()
637};
638
639#endif
Note: See TracBrowser for help on using the repository browser.