source: git/src/gfxcore.h @ e4f82db

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

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