source: git/src/gfxcore.h @ 11c7eb6

RELEASE/1.2debug-cidebug-ci-sanitisersstereowalls-data
Last change on this file since 11c7eb6 was 11c7eb6, checked in by Olly Betts <olly@…>, 10 years ago

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