source: git/src/gfxcore.h @ 2102591

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

Partition traverses into list by flag combinations

Instead of a list for surface and one for underground, we now have
8 lists of traverses, one for each combination of img_FLAG_SURFACE,
img_FLAG_SPLAY and img_FLAG_DUPLICATE.

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