source: git/src/gfxcore.h@ a405bc1

RELEASE/1.2 debug-ci debug-ci-sanitisers faster-cavernlog log-select main stereo stereo-2025 walls-data walls-data-hanging-as-warning warn-only-for-hanging-survey
Last change on this file since a405bc1 was a405bc1, checked in by Olly Betts <olly@…>, 13 years ago

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