source: git/src/gfxcore.h @ 419befc

RELEASE/1.2debug-cidebug-ci-sanitisersstereowalls-datawalls-data-hanging-as-warning
Last change on this file since 419befc was 384534c, checked in by Olly Betts <olly@…>, 11 years ago

src/gfxcore.cc,src/gfxcore.h: Export of passage detail now works
before we have displayed tubes in the OpenGL view.
  • Property mode set to 100644
File size: 14.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 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
30#include "img.h"
31
32#include "guicontrol.h"
33#include "vector3.h"
34#include "wx.h"
35#include "gla.h"
36
37#include <list>
38#include <utility>
39#include <vector>
40
41using namespace std;
42
43class MainFrm;
44class traverse;
45
46// Mac OS X headers pollute the global namespace with generic names like
47// "class Point", which clashes with our "class Point".  So for __WXMAC__
48// put our class in a namespace and define Point as a macro.
49#ifdef __WXMAC__
50namespace svx {
51#endif
52
53class Point : public Vector3 {
54  public:
55    Point() {}
56    Point(const Vector3 & v) : Vector3(v) { }
57    Point(const img_point & pt) : Vector3(pt.x, pt.y, pt.z) { }
58    Double GetX() const { return x; }
59    Double GetY() const { return y; }
60    Double GetZ() const { return z; }
61    void Invalidate() { x = DBL_MAX; }
62    bool IsValid() const { return x != DBL_MAX; }
63};
64
65#ifdef __WXMAC__
66}
67#define Point svx::Point
68#endif
69
70class XSect;
71class LabelInfo;
72class PointInfo;
73class MovieMaker;
74
75class PresentationMark : public Point {
76  public:
77    Double angle, tilt_angle;
78    Double scale;
79    Double time;
80    PresentationMark() : Point(), angle(0), tilt_angle(0), scale(0), time(0)
81        { }
82    PresentationMark(const Vector3 & v, Double angle_, Double tilt_angle_,
83                     Double scale_, Double time_ = 0)
84        : Point(v), angle(angle_), tilt_angle(tilt_angle_), scale(scale_),
85          time(time_)
86        { }
87    bool is_valid() const { return scale > 0; }
88};
89
90enum {
91    COLOUR_BY_NONE,
92    COLOUR_BY_DEPTH,
93    COLOUR_BY_DATE,
94    COLOUR_BY_ERROR,
95    COLOUR_BY_LIMIT_ // Leave this last.
96};
97
98enum {
99    UPDATE_NONE,
100    UPDATE_BLOBS,
101    UPDATE_BLOBS_AND_CROSSES
102};
103
104class GfxCore : public GLACanvas {
105    Double m_Scale;
106    int m_ScaleBarWidth;
107
108    typedef enum {
109        LIST_COMPASS,
110        LIST_CLINO,
111        LIST_CLINO_BACK,
112        LIST_SCALE_BAR,
113        LIST_DEPTH_KEY,
114        LIST_DATE_KEY,
115        LIST_ERROR_KEY,
116        LIST_UNDERGROUND_LEGS,
117        LIST_TUBES,
118        LIST_SURFACE_LEGS,
119        LIST_BLOBS,
120        LIST_CROSSES,
121        LIST_GRID,
122        LIST_SHADOW,
123        LIST_LIMIT_ // Leave this last.
124    } drawing_list;
125
126    static const int NUM_COLOUR_BANDS = 13;
127
128public:
129    typedef enum {
130        CURSOR_DEFAULT,
131        CURSOR_POINTING_HAND,
132        CURSOR_DRAGGING_HAND,
133        CURSOR_HORIZONTAL_RESIZE,
134        CURSOR_ROTATE_HORIZONTALLY,
135        CURSOR_ROTATE_VERTICALLY,
136        CURSOR_ROTATE_EITHER_WAY,
137        CURSOR_ZOOM,
138        CURSOR_ZOOM_ROTATE
139    } cursor;
140
141private:
142    GUIControl* m_Control;
143    char* m_LabelGrid;
144    MainFrm* m_Parent;
145    bool m_DoneFirstShow;
146    Double m_TiltAngle;
147    Double m_PanAngle;
148    bool m_Rotating;
149    Double m_RotationStep;
150    int m_SwitchingTo;
151    bool m_Crosses;
152    bool m_Legs;
153    bool m_Names;
154    bool m_Scalebar;
155    bool m_ColourKey;
156    bool m_OverlappingNames;
157    bool m_Compass;
158    bool m_Clino;
159    bool m_Tubes;
160    int m_ColourBy;
161
162    bool m_HaveData;
163    bool m_MouseOutsideCompass;
164    bool m_MouseOutsideElev;
165    bool m_Surface;
166    bool m_Entrances;
167    bool m_FixedPts;
168    bool m_ExportedPts;
169    bool m_Grid;
170    bool m_BoundingBox;
171
172    bool m_Degrees;
173    bool m_Metric;
174
175    list<LabelInfo*> *m_PointGrid;
176    bool m_HitTestGridValid;
177
178    bool m_here_is_temporary;
179    Point m_here, m_there;
180
181    wxStopWatch timer;
182    long drawtime;
183
184    GLAPen * m_Pens;
185
186#define PLAYING 1
187    int presentation_mode; // for now, 0 => off, PLAYING => continuous play
188    bool pres_reverse;
189    double pres_speed;
190    PresentationMark next_mark;
191    double next_mark_time;
192    double this_mark_total;
193
194    MovieMaker * movie;
195
196    cursor current_cursor;
197
198    // The legends for each entry in the colour key.
199    wxString key_legends[NUM_COLOUR_BANDS];
200
201    wxPoint key_lowerleft[COLOUR_BY_LIMIT_];
202
203    void PlaceVertexWithColour(const Vector3 &v, Double factor = 1.0);
204    void PlaceVertexWithColour(const Vector3 & v, GLint tex_x, GLint tex_y,
205                               Double factor);
206    void SetDepthColour(Double z, Double factor);
207    void PlaceVertexWithDepthColour(const Vector3 & v, Double factor = 1.0);
208    void PlaceVertexWithDepthColour(const Vector3 & v, GLint tex_x, GLint tex_y, Double factor);
209
210    void SetColourFromDate(int date, Double factor);
211    void SetColourFromError(double E, Double factor);
212
213    int GetClinoOffset() const;
214    void DrawTick(int angle_cw);
215    void DrawArrow(gla_colour col1, gla_colour col2);
216
217    void SkinPassage(vector<XSect> & centreline, bool draw = true);
218
219    virtual void GenerateList(unsigned int l);
220    void GenerateDisplayList();
221    void GenerateDisplayListTubes();
222    void GenerateDisplayListSurface();
223    void GenerateDisplayListShadow();
224    void GenerateBlobsDisplayList();
225
226    void DrawIndicators();
227
228    void TryToFreeArrays();
229    void FirstShow();
230
231    void DrawScaleBar();
232    void DrawColourKey(int num_bands, const wxString & other, const wxString & units);
233    void DrawDepthKey();
234    void DrawDateKey();
235    void DrawErrorKey();
236    void DrawCompass();
237    void DrawClino();
238    void DrawClinoBack();
239    void Draw2dIndicators();
240    void DrawGrid();
241
242    void NattyDrawNames();
243    void SimpleDrawNames();
244
245    void DefaultParameters();
246
247    void Repaint();
248
249    void CreateHitTestGrid();
250
251    int GetCompassXPosition() const;
252    int GetClinoXPosition() const;
253    int GetIndicatorYPosition() const;
254    int GetIndicatorRadius() const;
255
256    void ToggleFlag(bool* flag, int update = UPDATE_NONE);
257
258    GLAPen& GetPen(int band) const {
259        assert(band >= 0 && band < NUM_COLOUR_BANDS);
260        return m_Pens[band];
261    }
262
263    GLAPen& GetSurfacePen() const { return m_Pens[NUM_COLOUR_BANDS]; }
264
265    int GetNumColourBands() const { return NUM_COLOUR_BANDS; }
266
267    void DrawShadowedBoundingBox();
268    void DrawBoundingBox();
269
270public:
271    GfxCore(MainFrm* parent, wxWindow* parent_window, GUIControl* control);
272    ~GfxCore();
273
274    void Initialise(bool same_file);
275    void InitialiseTerrain();
276
277    void UpdateBlobs();
278    void ForceRefresh();
279
280    void RefreshLine(const Point& a, const Point& b, const Point& c);
281
282    void SetHere();
283    void SetHere(const Point &p);
284    void SetThere();
285    void SetThere(const Point &p);
286
287    void CentreOn(const Point &p);
288
289    void TranslateCave(int dx, int dy);
290    void TiltCave(Double tilt_angle);
291    void TurnCave(Double angle);
292    void TurnCaveTo(Double angle);
293
294    void OnPaint(wxPaintEvent&);
295    void OnSize(wxSizeEvent& event);
296    void OnIdle(wxIdleEvent& event);
297
298    void OnMouseMove(wxMouseEvent& event) { m_Control->OnMouseMove(event); }
299    void OnLeaveWindow(wxMouseEvent& event);
300
301    void OnLButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnLButtonDown(event); }
302    void OnLButtonUp(wxMouseEvent& event) { m_Control->OnLButtonUp(event); }
303    void OnMButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnMButtonDown(event); }
304    void OnMButtonUp(wxMouseEvent& event) { m_Control->OnMButtonUp(event); }
305    void OnRButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnRButtonDown(event); }
306    void OnRButtonUp(wxMouseEvent& event) { m_Control->OnRButtonUp(event); }
307    void OnMouseWheel(wxMouseEvent& event) { SetFocus(); m_Control->OnMouseWheel(event); }
308    void OnKeyPress(wxKeyEvent &event) { m_Control->OnKeyPress(event); }
309
310    bool Animate();
311    bool Animating() const {
312        return m_Rotating || m_SwitchingTo || presentation_mode != 0;
313    }
314
315    void ClearCoords();
316    void SetCoords(wxPoint);
317
318    // Determine whether the compass is currently shown.
319    bool ShowingCompass() const { return m_Compass; }
320    // Determine whether the clino is currently shown.
321    bool ShowingClino() const { return m_Clino; }
322
323    bool PointWithinCompass(wxPoint point) const;
324    bool PointWithinClino(wxPoint point) const;
325    bool PointWithinScaleBar(wxPoint point) const;
326    bool PointWithinColourKey(wxPoint point) const;
327
328    void SetCompassFromPoint(wxPoint point);
329    void SetClinoFromPoint(wxPoint point);
330    void SetScaleBarFromOffset(wxCoord dx);
331
332    void RedrawIndicators();
333
334    void StartRotation();
335    void ToggleRotation();
336    void StopRotation();
337    bool IsExtendedElevation() const;
338    void ReverseRotation();
339    void RotateSlower(bool accel);
340    void RotateFaster(bool accel);
341
342    void SwitchToElevation();
343    void SwitchToPlan();
344
345    void SetViewTo(Double xmin, Double xmax, Double ymin, Double ymax, Double zmin, Double zmax);
346
347    double GetCompassValue() const { return m_PanAngle; }
348    bool ShowingPlan() const;
349    bool ShowingElevation() const;
350    bool ShowingMeasuringLine() const;
351    bool HereIsReal() const { return m_here.IsValid() && !m_here_is_temporary; }
352
353    bool CanRaiseViewpoint() const;
354    bool CanLowerViewpoint() const;
355
356    bool IsRotating() const { return m_Rotating; }
357    bool HasData() const { return m_DoneFirstShow && m_HaveData; }
358    bool HasDepth() const;
359    bool HasErrorInformation() const;
360    bool HasDateInformation() const;
361
362    double GetScale() const { return m_Scale; }
363    void SetScale(Double scale);
364
365    bool ShowingStationNames() const { return m_Names; }
366    bool ShowingOverlappingNames() const { return m_OverlappingNames; }
367    bool ShowingCrosses() const { return m_Crosses; }
368    bool ShowingGrid() const { return m_Grid; }
369
370    int ColouringBy() const { return m_ColourBy; }
371
372    bool HasUndergroundLegs() const;
373    bool HasSurfaceLegs() const;
374    bool HasTubes() const;
375
376    bool ShowingUndergroundLegs() const { return m_Legs; }
377    bool ShowingSurfaceLegs() const { return m_Surface; }
378
379    bool ShowingColourKey() const { return m_ColourKey; }
380    bool ShowingScaleBar() const { return m_Scalebar; }
381
382    bool ShowingEntrances() const { return m_Entrances; }
383    bool ShowingFixedPts() const { return m_FixedPts; }
384    bool ShowingExportedPts() const { return m_ExportedPts; }
385
386    int GetNumEntrances() const;
387    int GetNumFixedPts() const;
388    int GetNumExportedPts() const;
389
390    void ToggleUndergroundLegs() {
391        ToggleFlag(&m_Legs, UPDATE_BLOBS_AND_CROSSES);
392    }
393    void ToggleSurfaceLegs() {
394        ToggleFlag(&m_Surface, UPDATE_BLOBS_AND_CROSSES);
395    }
396    void ToggleCompass() {
397        ToggleFlag(&m_Compass);
398        InvalidateList(LIST_SCALE_BAR);
399    }
400    void ToggleClino() {
401        ToggleFlag(&m_Clino);
402        InvalidateList(LIST_SCALE_BAR);
403    }
404    void ToggleScaleBar() { ToggleFlag(&m_Scalebar); }
405    void ToggleEntrances() { ToggleFlag(&m_Entrances, UPDATE_BLOBS); }
406    void ToggleFixedPts() { ToggleFlag(&m_FixedPts, UPDATE_BLOBS); }
407    void ToggleExportedPts() { ToggleFlag(&m_ExportedPts, UPDATE_BLOBS); }
408    void ToggleGrid() { ToggleFlag(&m_Grid); }
409    void ToggleCrosses() { ToggleFlag(&m_Crosses); }
410    void ToggleStationNames() { ToggleFlag(&m_Names); }
411    void ToggleOverlappingNames() { ToggleFlag(&m_OverlappingNames); }
412    void ToggleColourKey() { ToggleFlag(&m_ColourKey); }
413    void ToggleMetric() {
414        ToggleFlag(&m_Metric);
415        InvalidateList(LIST_DEPTH_KEY);
416        InvalidateList(LIST_SCALE_BAR);
417    }
418    void ToggleDegrees() { ToggleFlag(&m_Degrees); }
419    void ToggleTubes() { ToggleFlag(&m_Tubes); }
420    void TogglePerspective() { GLACanvas::TogglePerspective(); ForceRefresh(); }
421    void ToggleSmoothShading();
422    bool DisplayingBoundingBox() const { return m_BoundingBox; }
423    void ToggleBoundingBox() { ToggleFlag(&m_BoundingBox); }
424
425    bool GetMetric() const { return m_Metric; }
426    bool GetDegrees() const { return m_Degrees; }
427    bool GetTubes() const { return m_Tubes; }
428
429    bool CheckHitTestGrid(const wxPoint& point, bool centre);
430
431    void ClearTreeSelection();
432
433    void Defaults();
434
435    void FullScreenMode();
436
437    bool IsFullScreen() const;
438
439    void DragFinished();
440
441    void SplitLineAcrossBands(int band, int band2,
442                              const Vector3 &p, const Vector3 &q,
443                              Double factor = 1.0);
444    int GetDepthColour(Double z) const;
445    Double GetDepthBoundaryBetweenBands(int a, int b) const;
446    void AddPolyline(const traverse & centreline);
447    void AddPolylineDepth(const traverse & centreline);
448    void AddPolylineDate(const traverse & centreline);
449    void AddPolylineError(const traverse & centreline);
450    void AddQuadrilateral(const Vector3 &a, const Vector3 &b,
451                          const Vector3 &c, const Vector3 &d);
452    void AddPolylineShadow(const traverse & centreline);
453    void AddQuadrilateralDepth(const Vector3 &a, const Vector3 &b,
454                               const Vector3 &c, const Vector3 &d);
455    void AddQuadrilateralDate(const Vector3 &a, const Vector3 &b,
456                              const Vector3 &c, const Vector3 &d);
457    void AddQuadrilateralError(const Vector3 &a, const Vector3 &b,
458                               const Vector3 &c, const Vector3 &d);
459    void MoveViewer(double forward, double up, double right);
460
461    void (GfxCore::* AddQuad)(const Vector3 &a, const Vector3 &b,
462                              const Vector3 &c, const Vector3 &d);
463    void (GfxCore::* AddPoly)(const traverse & centreline);
464
465    PresentationMark GetView() const;
466    void SetView(const PresentationMark & p);
467    void PlayPres(double speed, bool change_speed = true);
468    int GetPresentationMode() const { return presentation_mode; }
469    double GetPresentationSpeed() const { return presentation_mode ? pres_speed : 0; }
470
471    void SetColourBy(int colour_by);
472    bool ExportMovie(const wxString & fnm);
473    void OnPrint(const wxString &filename, const wxString &title,
474                 const wxString &datestamp);
475    void OnExport(const wxString &filename, const wxString &title);
476    void SetCursor(GfxCore::cursor new_cursor);
477    bool MeasuringLineActive() const;
478
479    bool HandleRClick(wxPoint point);
480
481    void InvalidateAllLists() {
482        for (int i = 0; i < LIST_LIMIT_; ++i) {
483            InvalidateList(i);
484        }
485    }
486private:
487    DECLARE_EVENT_TABLE()
488};
489
490#endif
Note: See TracBrowser for help on using the repository browser.