source: git/src/gfxcore.h @ f481ceb

Last change on this file since f481ceb was f481ceb, checked in by Olly Betts <olly@…>, 11 years ago

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