source: git/src/gfxcore.h @ 2bf355e

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

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