source: git/src/gfxcore.h @ 5e0b9f9d

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

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