src/gfxcore.h

   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,2015,2016 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 <limits.h>
  30 #include <time.h>
  31
  32 #include "img_hosted.h"
  33
  34 #include "guicontrol.h"
  35 #include "labelinfo.h"
  36 #include "vector3.h"
  37 #include "wx.h"
  38 #include "gla.h"
  39
  40 #include <list>
  41 #include <utility>
  42 #include <vector>
  43
  44 using namespace std;
  45
  46 class MainFrm;
  47 class traverse;
  48
  49 class XSect;
  50 class PointInfo;
  51 class MovieMaker;
  52
  53 class PresentationMark : public Point {
  54   public:
  55     Double angle, tilt_angle;
  56     Double scale;
  57     Double time;
  58     PresentationMark() : Point(), angle(0), tilt_angle(0), scale(0), time(0)
  59         { }
  60     PresentationMark(const Vector3 & v, Double angle_, Double tilt_angle_,
  61                      Double scale_, Double time_ = 0)
  62         : Point(v), angle(angle_), tilt_angle(tilt_angle_), scale(scale_),
  63           time(time_)
  64         { }
  65     bool is_valid() const { return scale > 0; }
  66 };
  67
  68 struct ZoomBox {
  69   public:
  70     int x1, y1, x2, y2;
  71
  72     ZoomBox()
  73         : x1(INT_MAX) { }
  74
  75     bool active() const { return x1 != INT_MAX; }
  76
  77     void set(const wxPoint & p1, const wxPoint & p2) {
  78         x1 = p1.x;
  79         y1 = p1.y;
  80         x2 = p2.x;
  81         y2 = p2.y;
  82     }
  83
  84     void unset() {
  85         x1 = INT_MAX;
  86     }
  87 };
  88
  89 enum {
  90     COLOUR_BY_NONE,
  91     COLOUR_BY_DEPTH,
  92     COLOUR_BY_DATE,
  93     COLOUR_BY_ERROR,
  94     COLOUR_BY_GRADIENT,
  95     COLOUR_BY_LENGTH,
  96     COLOUR_BY_LIMIT_ // Leave this last.
  97 };
  98
  99 enum {
 100     UPDATE_NONE,
 101     UPDATE_BLOBS,
 102     UPDATE_BLOBS_AND_CROSSES
 103 };
 104
 105 enum {
 106       SPLAYS_HIDE,
 107       SPLAYS_SHOW_FADED,
 108       SPLAYS_SHOW_NORMAL,
 109 };
 110
 111 // It's pointless to redraw the screen as often as we can on a fast machine,
 112 // since the display hardware will only update so many times per second.
 113 // This is the maximum framerate we'll redraw at.
 114 const int MAX_FRAMERATE = 50;
 115
 116 class GfxCore : public GLACanvas {
 117     Double m_Scale;
 118     Double initial_scale;
 119     int m_ScaleBarWidth;
 120
 121     typedef enum {
 122         LIST_COMPASS,
 123         LIST_CLINO,
 124         LIST_CLINO_BACK,
 125         LIST_SCALE_BAR,
 126         LIST_DEPTH_KEY,
 127         LIST_DATE_KEY,
 128         LIST_ERROR_KEY,
 129         LIST_GRADIENT_KEY,
 130         LIST_LENGTH_KEY,
 131         LIST_UNDERGROUND_LEGS,
 132         LIST_TUBES,
 133         LIST_SURFACE_LEGS,
 134         LIST_BLOBS,
 135         LIST_CROSSES,
 136         LIST_GRID,
 137         LIST_SHADOW,
 138         LIST_TERRAIN,
 139         LIST_LIMIT_ // Leave this last.
 140     } drawing_list;
 141
 142     static const int NUM_COLOUR_BANDS = 13;
 143
 144     void SetPanBase() {
 145         base_pan = m_PanAngle;
 146         base_pan_time = timer.Time() - (1000 / MAX_FRAMERATE);
 147     }
 148
 149     void SetTiltBase() {
 150         base_tilt = m_TiltAngle;
 151         base_tilt_time = timer.Time() - (1000 / MAX_FRAMERATE);
 152     }
 153
 154     int GetCompassWidth() const;
 155     int GetClinoWidth() const;
 156
 157 public:
 158     typedef enum {
 159         CURSOR_DEFAULT,
 160         CURSOR_POINTING_HAND,
 161         CURSOR_DRAGGING_HAND,
 162         CURSOR_HORIZONTAL_RESIZE,
 163         CURSOR_ROTATE_HORIZONTALLY,
 164         CURSOR_ROTATE_VERTICALLY,
 165         CURSOR_ROTATE_EITHER_WAY,
 166         CURSOR_ZOOM,
 167         CURSOR_ZOOM_ROTATE
 168     } cursor;
 169
 170 private:
 171     GUIControl* m_Control;
 172     char* m_LabelGrid;
 173     MainFrm* m_Parent;
 174     bool m_DoneFirstShow;
 175     Double m_TiltAngle;
 176     Double m_PanAngle;
 177     bool m_Rotating;
 178     Double m_RotationStep;
 179     int m_SwitchingTo;
 180     bool m_Crosses;
 181     bool m_Legs;
 182     int m_Splays;
 183     bool m_Names;
 184     bool m_Scalebar;
 185     bool m_ColourKey;
 186     bool m_OverlappingNames;
 187     bool m_Compass;
 188     bool m_Clino;
 189     bool m_Tubes;
 190     int m_ColourBy;
 191
 192     bool m_HaveData;
 193     bool m_HaveTerrain;
 194     bool m_MouseOutsideCompass;
 195     bool m_MouseOutsideElev;
 196     bool m_Surface;
 197     bool m_Entrances;
 198     bool m_FixedPts;
 199     bool m_ExportedPts;
 200     bool m_Grid;
 201     bool m_BoundingBox;
 202     bool m_Terrain;
 203
 204     bool m_Degrees;
 205     bool m_Metric;
 206     bool m_Percent;
 207
 208     bool m_HitTestDebug;
 209     bool m_RenderStats;
 210
 211     list<LabelInfo*> *m_PointGrid;
 212     bool m_HitTestGridValid;
 213
 214     LabelInfo temp_here;
 215     const LabelInfo * m_here;
 216     const LabelInfo * m_there;
 217
 218     wxStopWatch timer;
 219     long base_tilt_time;
 220     long base_pan_time;
 221     Double base_tilt;
 222     Double base_pan;
 223
 224     GLAPen m_Pens[NUM_COLOUR_BANDS + 1];
 225
 226 #define PLAYING 1
 227     int presentation_mode; // for now, 0 => off, PLAYING => continuous play
 228     bool pres_reverse;
 229     double pres_speed;
 230     PresentationMark next_mark;
 231     double next_mark_time;
 232     double this_mark_total;
 233
 234     MovieMaker * movie;
 235
 236     cursor current_cursor;
 237
 238     int sqrd_measure_threshold;
 239
 240     // The legends for each entry in the colour key.
 241     wxString key_legends[NUM_COLOUR_BANDS];
 242
 243     wxPoint key_lowerleft[COLOUR_BY_LIMIT_];
 244
 245     ZoomBox zoombox;
 246
 247     // Copied from parent, so we can adjust view when reloading the same
 248     // file with the view restricted.
 249     Vector3 offsets;
 250
 251     // DEM:
 252     unsigned short * dem;
 253     unsigned long dem_width, dem_height;
 254     double o_x, o_y, step_x, step_y;
 255     long nodata_value;
 256     bool bigendian;
 257     long last_time;
 258     size_t n_tris;
 259
 260     void PlaceVertexWithColour(const Vector3 &v, Double factor = 1.0);
 261     void PlaceVertexWithColour(const Vector3 & v, GLint tex_x, GLint tex_y,
 262                                Double factor);
 263     void SetDepthColour(Double z, Double factor);
 264     void PlaceVertexWithDepthColour(const Vector3 & v, Double factor = 1.0);
 265     void PlaceVertexWithDepthColour(const Vector3 & v, GLint tex_x, GLint tex_y, Double factor);
 266
 267     void SetColourFrom01(double how_far, Double factor);
 268
 269     void SetColourFromDate(int date, Double factor);
 270     void SetColourFromError(double E, Double factor);
 271     void SetColourFromGradient(double angle, Double factor);
 272     void SetColourFromLength(double len, Double factor);
 273
 274     int GetClinoOffset() const;
 275     void DrawTick(int angle_cw);
 276     void DrawArrow(gla_colour col1, gla_colour col2);
 277
 278     void SkinPassage(vector<XSect> & centreline, bool draw = true);
 279
 280     virtual void GenerateList(unsigned int l);
 281     void GenerateDisplayList();
 282     void GenerateDisplayListTubes();
 283     void GenerateDisplayListSurface();
 284     void DrawTerrainTriangle(const Vector3 & a, const Vector3 & b, const Vector3 & c);
 285     void DrawTerrain();
 286     void GenerateDisplayListShadow();
 287     void GenerateBlobsDisplayList();
 288
 289     void DrawIndicators();
 290
 291     void TryToFreeArrays();
 292     void FirstShow();
 293
 294     void DrawScaleBar();
 295     void DrawColourKey(int num_bands, const wxString & other, const wxString & units);
 296     void DrawDepthKey();
 297     void DrawDateKey();
 298     void DrawErrorKey();
 299     void DrawGradientKey();
 300     void DrawLengthKey();
 301     void DrawCompass();
 302     void DrawClino();
 303     void DrawClinoBack();
 304     void Draw2dIndicators();
 305     void DrawGrid();
 306
 307     void NattyDrawNames();
 308     void SimpleDrawNames();
 309
 310     void DefaultParameters();
 311
 312     void Repaint();
 313
 314     void CreateHitTestGrid();
 315
 316     int GetCompassXPosition() const;
 317     int GetClinoXPosition() const;
 318     int GetIndicatorYPosition() const;
 319     int GetIndicatorRadius() const;
 320
 321     void ToggleFlag(bool* flag, int update = UPDATE_NONE);
 322
 323     const GLAPen& GetPen(int band) const {
 324         assert(band >= 0 && band < NUM_COLOUR_BANDS);
 325         return m_Pens[band];
 326     }
 327
 328     const GLAPen& GetSurfacePen() const { return m_Pens[NUM_COLOUR_BANDS]; }
 329
 330     int GetNumColourBands() const { return NUM_COLOUR_BANDS; }
 331
 332     void DrawShadowedBoundingBox();
 333     void DrawBoundingBox();
 334
 335 public:
 336     GfxCore(MainFrm* parent, wxWindow* parent_window, GUIControl* control);
 337     ~GfxCore();
 338
 339     void Initialise(bool same_file);
 340
 341     void UpdateBlobs();
 342     void ForceRefresh();
 343
 344     void RefreshLine(const Point* a, const Point* b, const Point* c);
 345
 346     void SetHereFromTree(const LabelInfo * p);
 347
 348     void SetHere(const LabelInfo * p = NULL);
 349     void SetThere(const LabelInfo * p = NULL);
 350
 351     void CentreOn(const Point &p);
 352
 353     void TranslateCave(int dx, int dy);
 354     void TiltCave(Double tilt_angle);
 355     void TurnCave(Double angle);
 356     void TurnCaveTo(Double angle);
 357
 358     void OnPaint(wxPaintEvent&);
 359     void OnSize(wxSizeEvent& event);
 360     void OnIdle(wxIdleEvent& event);
 361
 362     void OnMouseMove(wxMouseEvent& event) { m_Control->OnMouseMove(event); }
 363     void OnLeaveWindow(wxMouseEvent& event);
 364
 365     void OnLButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnLButtonDown(event); }
 366     void OnLButtonUp(wxMouseEvent& event) { m_Control->OnLButtonUp(event); }
 367     void OnMButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnMButtonDown(event); }
 368     void OnMButtonUp(wxMouseEvent& event) { m_Control->OnMButtonUp(event); }
 369     void OnRButtonDown(wxMouseEvent& event) { SetFocus(); m_Control->OnRButtonDown(event); }
 370     void OnRButtonUp(wxMouseEvent& event) { m_Control->OnRButtonUp(event); }
 371     void OnMouseWheel(wxMouseEvent& event) { SetFocus(); m_Control->OnMouseWheel(event); }
 372     void OnKeyPress(wxKeyEvent &event) { m_Control->OnKeyPress(event); }
 373
 374     void Animate();
 375     bool Animating() const {
 376         return m_Rotating || m_SwitchingTo || presentation_mode != 0;
 377     }
 378
 379     void ClearCoords();
 380     void SetCoords(wxPoint);
 381
 382     // Determine whether the compass is currently shown.
 383     bool ShowingCompass() const { return m_Compass; }
 384     // Determine whether the clino is currently shown.
 385     bool ShowingClino() const { return m_Clino; }
 386
 387     bool PointWithinCompass(wxPoint point) const;
 388     bool PointWithinClino(wxPoint point) const;
 389     bool PointWithinScaleBar(wxPoint point) const;
 390     bool PointWithinColourKey(wxPoint point) const;
 391
 392     void SetCompassFromPoint(wxPoint point);
 393     void SetClinoFromPoint(wxPoint point);
 394     void SetScaleBarFromOffset(wxCoord dx);
 395
 396     void RedrawIndicators();
 397
 398     void StartRotation();
 399     void ToggleRotation();
 400     void StopRotation();
 401     bool IsExtendedElevation() const;
 402     void ReverseRotation();
 403     void RotateSlower(bool accel);
 404     void RotateFaster(bool accel);
 405
 406     void SwitchToElevation();
 407     void SwitchToPlan();
 408
 409     void SetViewTo(Double xmin, Double xmax, Double ymin, Double ymax, Double zmin, Double zmax);
 410
 411     double GetCompassValue() const { return m_PanAngle; }
 412     bool ShowingPlan() const;
 413     bool ShowingElevation() const;
 414     bool ShowingMeasuringLine() const;
 415     bool HereIsReal() const { return m_here && m_here != &temp_here; }
 416
 417     bool CanRaiseViewpoint() const;
 418     bool CanLowerViewpoint() const;
 419
 420     bool IsRotating() const { return m_Rotating; }
 421     bool HasData() const { return m_DoneFirstShow && m_HaveData; }
 422     bool HasTerrain() const { return m_DoneFirstShow && m_HaveTerrain; }
 423     bool HasDepth() const;
 424     bool HasErrorInformation() const;
 425     bool HasDateInformation() const;
 426
 427     double GetScale() const { return m_Scale; }
 428     void SetScale(Double scale);
 429
 430     bool ShowingStationNames() const { return m_Names; }
 431     bool ShowingOverlappingNames() const { return m_OverlappingNames; }
 432     bool ShowingCrosses() const { return m_Crosses; }
 433     bool ShowingGrid() const { return m_Grid; }
 434
 435     int ColouringBy() const { return m_ColourBy; }
 436
 437     bool HasUndergroundLegs() const;
 438     bool HasSplays() const;
 439     bool HasSurfaceLegs() const;
 440     bool HasTubes() const;
 441
 442     bool ShowingUndergroundLegs() const { return m_Legs; }
 443     int ShowingSplaysMode() const { return m_Splays; }
 444     bool ShowingSurfaceLegs() const { return m_Surface; }
 445
 446     bool ShowingColourKey() const { return m_ColourKey; }
 447     bool ShowingScaleBar() const { return m_Scalebar; }
 448
 449     bool ShowingEntrances() const { return m_Entrances; }
 450     bool ShowingFixedPts() const { return m_FixedPts; }
 451     bool ShowingExportedPts() const { return m_ExportedPts; }
 452
 453     int GetNumEntrances() const;
 454     int GetNumFixedPts() const;
 455     int GetNumExportedPts() const;
 456
 457     void ToggleUndergroundLegs() {
 458         ToggleFlag(&m_Legs, UPDATE_BLOBS_AND_CROSSES);
 459     }
 460     void SetSplaysMode(int mode) {
 461         m_Splays = mode;
 462         UpdateBlobs();
 463         InvalidateList(LIST_UNDERGROUND_LEGS);
 464         ForceRefresh();
 465     }
 466     void ToggleSurfaceLegs() {
 467         ToggleFlag(&m_Surface, UPDATE_BLOBS_AND_CROSSES);
 468     }
 469     void ToggleCompass() {
 470         ToggleFlag(&m_Compass);
 471         InvalidateList(LIST_SCALE_BAR);
 472     }
 473     void ToggleClino() {
 474         ToggleFlag(&m_Clino);
 475         InvalidateList(LIST_SCALE_BAR);
 476     }
 477     void ToggleScaleBar() { ToggleFlag(&m_Scalebar); }
 478     void ToggleEntrances() { ToggleFlag(&m_Entrances, UPDATE_BLOBS); }
 479     void ToggleFixedPts() { ToggleFlag(&m_FixedPts, UPDATE_BLOBS); }
 480     void ToggleExportedPts() { ToggleFlag(&m_ExportedPts, UPDATE_BLOBS); }
 481     void ToggleGrid() { ToggleFlag(&m_Grid); }
 482     void ToggleCrosses() { ToggleFlag(&m_Crosses); }
 483     void ToggleStationNames() { ToggleFlag(&m_Names); }
 484     void ToggleOverlappingNames() { ToggleFlag(&m_OverlappingNames); }
 485     void ToggleColourKey() { ToggleFlag(&m_ColourKey); }
 486     void ToggleMetric() {
 487         ToggleFlag(&m_Metric);
 488         InvalidateList(LIST_DEPTH_KEY);
 489         InvalidateList(LIST_LENGTH_KEY);
 490         InvalidateList(LIST_SCALE_BAR);
 491     }
 492     void ToggleHitTestDebug() {
 493         ToggleFlag(&m_HitTestDebug);
 494     }
 495     void ToggleRenderStats() {
 496         ToggleFlag(&m_RenderStats);
 497     }
 498     void ToggleDegrees() {
 499         ToggleFlag(&m_Degrees);
 500         InvalidateList(LIST_GRADIENT_KEY);
 501     }
 502     void TogglePercent() { ToggleFlag(&m_Percent); }
 503     void ToggleTubes() { ToggleFlag(&m_Tubes); }
 504     void TogglePerspective() { GLACanvas::TogglePerspective(); ForceRefresh(); }
 505     void ToggleSmoothShading();
 506     bool DisplayingBoundingBox() const { return m_BoundingBox; }
 507     void ToggleBoundingBox() { ToggleFlag(&m_BoundingBox); }
 508     bool DisplayingTerrain() const { return m_Terrain; }
 509     void ToggleTerrain();
 510     void ToggleFatFinger();
 511
 512     bool GetMetric() const { return m_Metric; }
 513     bool GetDegrees() const { return m_Degrees; }
 514     bool GetPercent() const { return m_Percent; }
 515     bool GetTubes() const { return m_Tubes; }
 516
 517     bool CheckHitTestGrid(const wxPoint& point, bool centre);
 518
 519     void ClearTreeSelection();
 520
 521     void Defaults();
 522
 523     void FullScreenMode();
 524
 525     bool IsFullScreen() const;
 526
 527     bool FullScreenModeShowingMenus() const;
 528
 529     void FullScreenModeShowMenus(bool show);
 530
 531     void DragFinished();
 532
 533     void SplitLineAcrossBands(int band, int band2,
 534                               const Vector3 &p, const Vector3 &q,
 535                               Double factor = 1.0);
 536     int GetDepthColour(Double z) const;
 537     Double GetDepthBoundaryBetweenBands(int a, int b) const;
 538     void AddPolyline(const traverse & centreline);
 539     void AddPolylineDepth(const traverse & centreline);
 540     void AddPolylineDate(const traverse & centreline);
 541     void AddPolylineError(const traverse & centreline);
 542     void AddPolylineGradient(const traverse & centreline);
 543     void AddPolylineLength(const traverse & centreline);
 544     void AddQuadrilateral(const Vector3 &a, const Vector3 &b,
 545                           const Vector3 &c, const Vector3 &d);
 546     void AddPolylineShadow(const traverse & centreline);
 547     void AddQuadrilateralDepth(const Vector3 &a, const Vector3 &b,
 548                                const Vector3 &c, const Vector3 &d);
 549     void AddQuadrilateralDate(const Vector3 &a, const Vector3 &b,
 550                               const Vector3 &c, const Vector3 &d);
 551     void AddQuadrilateralError(const Vector3 &a, const Vector3 &b,
 552                                const Vector3 &c, const Vector3 &d);
 553     void AddQuadrilateralGradient(const Vector3 &a, const Vector3 &b,
 554                                   const Vector3 &c, const Vector3 &d);
 555     void AddQuadrilateralLength(const Vector3 &a, const Vector3 &b,
 556                                 const Vector3 &c, const Vector3 &d);
 557     void MoveViewer(double forward, double up, double right);
 558
 559     void (GfxCore::* AddQuad)(const Vector3 &a, const Vector3 &b,
 560                               const Vector3 &c, const Vector3 &d);
 561     void (GfxCore::* AddPoly)(const traverse & centreline);
 562
 563     PresentationMark GetView() const;
 564     void SetView(const PresentationMark & p);
 565     void PlayPres(double speed, bool change_speed = true);
 566     int GetPresentationMode() const { return presentation_mode; }
 567     double GetPresentationSpeed() const { return presentation_mode ? pres_speed : 0; }
 568
 569     void SetColourBy(int colour_by);
 570     bool ExportMovie(const wxString & fnm);
 571     void OnPrint(const wxString &filename, const wxString &title,
 572                  const wxString &datestamp, time_t datestamp_numeric,
 573                  const wxString &cs_proj,
 574                  bool close_after_print = false);
 575     void OnExport(const wxString &filename, const wxString &title,
 576                   const wxString &datestamp, time_t datestamp_numeric,
 577                   const wxString &cs_proj);
 578     void UpdateCursor(GfxCore::cursor new_cursor);
 579     bool MeasuringLineActive() const;
 580
 581     bool HandleRClick(wxPoint point);
 582
 583     void InvalidateAllLists() {
 584         for (int i = 0; i < LIST_LIMIT_; ++i) {
 585             InvalidateList(i);
 586         }
 587     }
 588
 589     void SetZoomBox(wxPoint p1, wxPoint p2, bool centred, bool aspect);
 590
 591     void UnsetZoomBox() {
 592         if (!zoombox.active()) return;
 593         zoombox.unset();
 594         ForceRefresh();
 595     }
 596
 597     void ZoomBoxGo();
 598
 599     void parse_hgt_filename(const wxString & lc_name);
 600     size_t parse_hdr(wxInputStream & is, unsigned long & skipbytes);
 601     bool read_bil(wxInputStream & is, size_t size, unsigned long skipbytes);
 602     bool LoadDEM(const wxString & file);
 603
 604 private:
 605     DECLARE_EVENT_TABLE()
 606 };
 607
 608 #endif