source: git/src/gfxcore.h @ 3bb963aa

RELEASE/1.2debug-cidebug-ci-sanitisersfaster-cavernlogwalls-datawalls-data-hanging-as-warning
Last change on this file since 3bb963aa was 0642381, checked in by Olly Betts <olly@…>, 6 years ago

Highlight surveys on survey tree mouseover

This is cleaner than running a search to highlight them, and means
we can restore "double-click survey in tree to zoom".
  • Property mode set to 100644
File size: 18.1 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    wxString highlighted_survey;
228
229    wxStopWatch timer;
230    long base_tilt_time;
231    long base_pan_time;
232    Double base_tilt;
233    Double base_pan;
234
235    GLAPen m_Pens[NUM_COLOUR_BANDS + 1];
236
237#define PLAYING 1
238    int presentation_mode; // for now, 0 => off, PLAYING => continuous play
239    bool pres_reverse;
240    double pres_speed;
241    PresentationMark next_mark;
242    double next_mark_time;
243    double this_mark_total;
244
245    MovieMaker * movie;
246
247    cursor current_cursor;
248
249    int sqrd_measure_threshold;
250
251    // The legends for each entry in the colour key.
252    wxString key_legends[NUM_COLOUR_BANDS];
253
254    wxPoint key_lowerleft[COLOUR_BY_LIMIT_];
255
256    ZoomBox zoombox;
257
258    // Copied from parent, so we can adjust view when reloading the same
259    // file with the view restricted.
260    Vector3 offsets;
261
262    // DEM:
263    unsigned short * dem;
264    unsigned long dem_width, dem_height;
265    double o_x, o_y, step_x, step_y;
266    long nodata_value;
267    bool bigendian;
268    long last_time;
269    size_t n_tris;
270
271    void PlaceVertexWithColour(const Vector3 &v, Double factor = 1.0);
272    void PlaceVertexWithColour(const Vector3 & v,
273                               glaTexCoord tex_x, glaTexCoord tex_y,
274                               Double factor);
275    void SetDepthColour(Double z, Double factor);
276    void PlaceVertexWithDepthColour(const Vector3 & v, Double factor = 1.0);
277    void PlaceVertexWithDepthColour(const Vector3 & v,
278                                    glaTexCoord tex_x, glaTexCoord tex_y,
279                                    Double factor);
280
281    void SetColourFrom01(double how_far, Double factor);
282
283    void SetColourFromDate(int date, Double factor);
284    void SetColourFromError(double E, Double factor);
285    void SetColourFromGradient(double angle, Double factor);
286    void SetColourFromLength(double len, Double factor);
287
288    int GetClinoOffset() const;
289    void DrawTick(int angle_cw);
290    void DrawArrow(gla_colour col1, gla_colour col2);
291
292    void SkinPassage(vector<XSect> & centreline, bool draw = true);
293
294    virtual void GenerateList(unsigned int l);
295    void GenerateDisplayList(bool surface);
296    void GenerateDisplayListTubes();
297    void DrawTerrainTriangle(const Vector3 & a, const Vector3 & b, const Vector3 & c);
298    void DrawTerrain();
299    void GenerateDisplayListShadow();
300    void GenerateBlobsDisplayList();
301
302    void DrawIndicators();
303
304    void TryToFreeArrays();
305    void FirstShow();
306
307    void DrawScaleBar();
308    void DrawColourKey(int num_bands, const wxString & other, const wxString & units);
309    void DrawDepthKey();
310    void DrawDateKey();
311    void DrawErrorKey();
312    void DrawGradientKey();
313    void DrawLengthKey();
314    void DrawCompass();
315    void DrawClino();
316    void DrawClinoBack();
317    void Draw2dIndicators();
318    void DrawGrid();
319
320    void NattyDrawNames();
321    void SimpleDrawNames();
322
323    void DefaultParameters();
324
325    void Repaint();
326
327    void CreateHitTestGrid();
328
329    int GetCompassXPosition() const;
330    int GetClinoXPosition() const;
331    int GetIndicatorYPosition() const;
332    int GetIndicatorRadius() const;
333
334    void ToggleFlag(bool* flag, int update = UPDATE_NONE);
335
336    const GLAPen& GetPen(int band) const {
337        assert(band >= 0 && band < NUM_COLOUR_BANDS);
338        return m_Pens[band];
339    }
340
341    const GLAPen& GetSurfacePen() const { return m_Pens[NUM_COLOUR_BANDS]; }
342
343    int GetNumColourBands() const { return NUM_COLOUR_BANDS; }
344
345    void DrawShadowedBoundingBox();
346    void DrawBoundingBox();
347
348public:
349    GfxCore(MainFrm* parent, wxWindow* parent_window, GUIControl* control);
350    ~GfxCore();
351
352    void Initialise(bool same_file);
353
354    void UpdateBlobs();
355    void ForceRefresh();
356
357    void RefreshLine(const Point* a, const Point* b, const Point* c);
358
359    void SetHereSurvey(const wxString& survey) {
360        if (survey != highlighted_survey) {
361            highlighted_survey = survey;
362            ForceRefresh();
363        }
364    }
365
366    void HighlightSurvey();
367
368    void ZoomToSurvey(const wxString& survey);
369
370    void SetHereFromTree(const LabelInfo * p);
371
372    void SetHere(const LabelInfo * p = NULL);
373    void SetThere(const LabelInfo * p = NULL);
374
375    const LabelInfo* GetThere() const { return m_there; }
376
377    void CentreOn(const Point &p);
378
379    void TranslateCave(int dx, int dy);
380    void TiltCave(Double tilt_angle);
381    void TurnCave(Double angle);
382    void TurnCaveTo(Double angle);
383
384    void OnPaint(wxPaintEvent&);
385    void OnSize(wxSizeEvent& event);
386    void OnIdle(wxIdleEvent& event);
387
388    void OnMouseMove(wxMouseEvent& event) { m_Control->OnMouseMove(event); }
389    void OnLeaveWindow(wxMouseEvent& event);
390
391    void OnLButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnLButtonDown(event); }
392    void OnLButtonUp(wxMouseEvent& event) { m_Control->OnLButtonUp(event); }
393    void OnMButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnMButtonDown(event); }
394    void OnMButtonUp(wxMouseEvent& event) { m_Control->OnMButtonUp(event); }
395    void OnRButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnRButtonDown(event); }
396    void OnRButtonUp(wxMouseEvent& event) { m_Control->OnRButtonUp(event); }
397    void OnMouseWheel(wxMouseEvent& event) { SetFocus(); m_Control->OnMouseWheel(event); }
398    void OnKeyPress(wxKeyEvent &event) { m_Control->OnKeyPress(event); }
399
400    void Animate();
401    bool Animating() const {
402        return m_Rotating || m_SwitchingTo || presentation_mode != 0;
403    }
404
405    void ClearCoords();
406    void SetCoords(wxPoint);
407
408    // Determine whether the compass is currently shown.
409    bool ShowingCompass() const { return m_Compass; }
410    // Determine whether the clino is currently shown.
411    bool ShowingClino() const { return m_Clino; }
412
413    bool PointWithinCompass(wxPoint point) const;
414    bool PointWithinClino(wxPoint point) const;
415    bool PointWithinScaleBar(wxPoint point) const;
416    bool PointWithinColourKey(wxPoint point) const;
417
418    void SetCompassFromPoint(wxPoint point);
419    void SetClinoFromPoint(wxPoint point);
420    void SetScaleBarFromOffset(wxCoord dx);
421
422    void RedrawIndicators();
423
424    void StartRotation();
425    void ToggleRotation();
426    void StopRotation();
427    bool IsExtendedElevation() const;
428    void ReverseRotation();
429    void RotateSlower(bool accel);
430    void RotateFaster(bool accel);
431
432    void SwitchToElevation();
433    void SwitchToPlan();
434
435    void SetViewTo(Double xmin, Double xmax, Double ymin, Double ymax, Double zmin, Double zmax);
436
437    double GetCompassValue() const { return m_PanAngle; }
438    bool ShowingPlan() const;
439    bool ShowingElevation() const;
440    bool ShowingMeasuringLine() const;
441    bool HereIsReal() const { return m_here && m_here != &temp_here; }
442
443    bool CanRaiseViewpoint() const;
444    bool CanLowerViewpoint() const;
445
446    bool IsRotating() const { return m_Rotating; }
447    bool HasData() const { return m_DoneFirstShow && m_HaveData; }
448    bool HasTerrain() const { return m_DoneFirstShow && m_HaveTerrain; }
449    bool HasDepth() const;
450    bool HasErrorInformation() const;
451    bool HasDateInformation() const;
452
453    double GetScale() const { return m_Scale; }
454    void SetScale(Double scale);
455
456    bool ShowingStationNames() const { return m_Names; }
457    bool ShowingOverlappingNames() const { return m_OverlappingNames; }
458    bool ShowingCrosses() const { return m_Crosses; }
459    bool ShowingGrid() const { return m_Grid; }
460
461    int ColouringBy() const { return m_ColourBy; }
462
463    bool HasUndergroundLegs() const;
464    bool HasSplays() const;
465    bool HasDupes() const;
466    bool HasSurfaceLegs() const;
467    bool HasTubes() const;
468
469    bool ShowingUndergroundLegs() const { return m_Legs; }
470    int ShowingSplaysMode() const { return m_Splays; }
471    int ShowingDupesMode() const { return m_Dupes; }
472    bool ShowingSurfaceLegs() const { return m_Surface; }
473
474    bool ShowingColourKey() const { return m_ColourKey; }
475    bool ShowingScaleBar() const { return m_Scalebar; }
476
477    bool ShowingEntrances() const { return m_Entrances; }
478    bool ShowingFixedPts() const { return m_FixedPts; }
479    bool ShowingExportedPts() const { return m_ExportedPts; }
480
481    int GetNumEntrances() const;
482    int GetNumFixedPts() const;
483    int GetNumExportedPts() const;
484
485    void ToggleUndergroundLegs() {
486        ToggleFlag(&m_Legs, UPDATE_BLOBS_AND_CROSSES);
487    }
488    void SetSplaysMode(int mode) {
489        m_Splays = mode;
490        UpdateBlobs();
491        InvalidateList(LIST_SURFACE_LEGS);
492        InvalidateList(LIST_UNDERGROUND_LEGS);
493        ForceRefresh();
494    }
495    void SetDupesMode(int mode) {
496        m_Dupes = mode;
497        UpdateBlobs();
498        InvalidateList(LIST_SURFACE_LEGS);
499        InvalidateList(LIST_UNDERGROUND_LEGS);
500        ForceRefresh();
501    }
502    void ToggleSurfaceLegs() {
503        ToggleFlag(&m_Surface, UPDATE_BLOBS_AND_CROSSES);
504    }
505    void ToggleCompass() {
506        ToggleFlag(&m_Compass);
507        InvalidateList(LIST_SCALE_BAR);
508    }
509    void ToggleClino() {
510        ToggleFlag(&m_Clino);
511        InvalidateList(LIST_SCALE_BAR);
512    }
513    void ToggleScaleBar() { ToggleFlag(&m_Scalebar); }
514    void ToggleEntrances() { ToggleFlag(&m_Entrances, UPDATE_BLOBS); }
515    void ToggleFixedPts() { ToggleFlag(&m_FixedPts, UPDATE_BLOBS); }
516    void ToggleExportedPts() { ToggleFlag(&m_ExportedPts, UPDATE_BLOBS); }
517    void ToggleGrid() { ToggleFlag(&m_Grid); }
518    void ToggleCrosses() { ToggleFlag(&m_Crosses); }
519    void ToggleStationNames() { ToggleFlag(&m_Names); }
520    void ToggleOverlappingNames() { ToggleFlag(&m_OverlappingNames); }
521    void ToggleColourKey() { ToggleFlag(&m_ColourKey); }
522    void ToggleMetric() {
523        ToggleFlag(&m_Metric);
524        InvalidateList(LIST_DEPTH_KEY);
525        InvalidateList(LIST_LENGTH_KEY);
526        InvalidateList(LIST_SCALE_BAR);
527    }
528    void ToggleHitTestDebug() {
529        ToggleFlag(&m_HitTestDebug);
530    }
531    void ToggleRenderStats() {
532        ToggleFlag(&m_RenderStats);
533    }
534    void ToggleDegrees() {
535        ToggleFlag(&m_Degrees);
536        InvalidateList(LIST_GRADIENT_KEY);
537    }
538    void TogglePercent() { ToggleFlag(&m_Percent); }
539    void ToggleTubes() { ToggleFlag(&m_Tubes); }
540    void TogglePerspective() { GLACanvas::TogglePerspective(); ForceRefresh(); }
541    void ToggleSmoothShading();
542    bool DisplayingBoundingBox() const { return m_BoundingBox; }
543    void ToggleBoundingBox() { ToggleFlag(&m_BoundingBox); }
544    bool DisplayingTerrain() const { return m_Terrain; }
545    void ToggleTerrain();
546    void ToggleFatFinger();
547    void ToggleTextured() {
548        GLACanvas::ToggleTextured();
549        ForceRefresh();
550    }
551
552    bool GetMetric() const { return m_Metric; }
553    bool GetDegrees() const { return m_Degrees; }
554    bool GetPercent() const { return m_Percent; }
555    bool GetTubes() const { return m_Tubes; }
556
557    bool CheckHitTestGrid(const wxPoint& point, bool centre);
558
559    void ClearTreeSelection();
560
561    void Defaults();
562
563    void FullScreenMode();
564
565    bool IsFullScreen() const;
566
567    bool FullScreenModeShowingMenus() const;
568
569    void FullScreenModeShowMenus(bool show);
570
571    void DragFinished();
572
573    void SplitLineAcrossBands(int band, int band2,
574                              const Vector3 &p, const Vector3 &q,
575                              Double factor = 1.0);
576    void SplitPolyAcrossBands(vector<vector<Split>>& splits,
577                              int band, int band2,
578                              const Vector3 &p, const Vector3 &q,
579                              glaTexCoord ptx, glaTexCoord pty,
580                              glaTexCoord w, glaTexCoord h);
581    int GetDepthColour(Double z) const;
582    Double GetDepthBoundaryBetweenBands(int a, int b) const;
583    void AddPolyline(const traverse & centreline);
584    void AddPolylineDepth(const traverse & centreline);
585    void AddPolylineDate(const traverse & centreline);
586    void AddPolylineError(const traverse & centreline);
587    void AddPolylineGradient(const traverse & centreline);
588    void AddPolylineLength(const traverse & centreline);
589    void AddQuadrilateral(const Vector3 &a, const Vector3 &b,
590                          const Vector3 &c, const Vector3 &d);
591    void AddPolylineShadow(const traverse & centreline);
592    void AddQuadrilateralDepth(const Vector3 &a, const Vector3 &b,
593                               const Vector3 &c, const Vector3 &d);
594    void AddQuadrilateralDate(const Vector3 &a, const Vector3 &b,
595                              const Vector3 &c, const Vector3 &d);
596    void AddQuadrilateralError(const Vector3 &a, const Vector3 &b,
597                               const Vector3 &c, const Vector3 &d);
598    void AddQuadrilateralGradient(const Vector3 &a, const Vector3 &b,
599                                  const Vector3 &c, const Vector3 &d);
600    void AddQuadrilateralLength(const Vector3 &a, const Vector3 &b,
601                                const Vector3 &c, const Vector3 &d);
602    void MoveViewer(double forward, double up, double right);
603
604    void (GfxCore::* AddQuad)(const Vector3 &a, const Vector3 &b,
605                              const Vector3 &c, const Vector3 &d);
606    void (GfxCore::* AddPoly)(const traverse & centreline);
607
608    PresentationMark GetView() const;
609    void SetView(const PresentationMark & p);
610    void PlayPres(double speed, bool change_speed = true);
611    int GetPresentationMode() const { return presentation_mode; }
612    double GetPresentationSpeed() const { return presentation_mode ? pres_speed : 0; }
613
614    void SetColourBy(int colour_by);
615    bool ExportMovie(const wxString & fnm);
616    void OnPrint(const wxString &filename, const wxString &title,
617                 const wxString &datestamp,
618                 bool close_after_print = false);
619    void OnExport(const wxString &filename, const wxString &title,
620                  const wxString &datestamp);
621    void UpdateCursor(GfxCore::cursor new_cursor);
622    bool MeasuringLineActive() const;
623
624    bool HandleRClick(wxPoint point);
625
626    void InvalidateAllLists() {
627        for (int i = 0; i < LIST_LIMIT_; ++i) {
628            InvalidateList(i);
629        }
630    }
631
632    void SetZoomBox(wxPoint p1, wxPoint p2, bool centred, bool aspect);
633
634    void UnsetZoomBox() {
635        if (!zoombox.active()) return;
636        zoombox.unset();
637        ForceRefresh();
638    }
639
640    void ZoomBoxGo();
641
642    void parse_hgt_filename(const wxString & lc_name);
643    size_t parse_hdr(wxInputStream & is, unsigned long & skipbytes);
644    bool read_bil(wxInputStream & is, size_t size, unsigned long skipbytes);
645    bool LoadDEM(const wxString & file);
646
647private:
648    DECLARE_EVENT_TABLE()
649};
650
651#endif
Note: See TracBrowser for help on using the repository browser.