source: git/src/gfxcore.h @ 4938bcd

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

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