src/Scenery/tilemgr.hxx

   1 // tilemgr.hxx -- routines to handle dynamic management of scenery tiles
   2 //
   3 // Written by Curtis Olson, started January 1998.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _TILEMGR_HXX
  25 #define _TILEMGR_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32 #include <simgear/compiler.h>
  33
  34 #include <plib/ssg.h>
  35
  36 #include <simgear/bucket/newbucket.hxx>
  37 #ifdef ENABLE_THREADS
  38 #  include <simgear/threads/SGQueue.hxx>
  39 #endif // ENABLE_THREADS
  40
  41 #include "FGTileLoader.hxx"
  42 #include "hitlist.hxx"
  43 #include "newcache.hxx"
  44
  45 #if defined(USE_MEM) || defined(WIN32)
  46 #  define FG_MEM_COPY(to,from,n)        memcpy(to, from, n)
  47 #else
  48 #  define FG_MEM_COPY(to,from,n)        bcopy(from, to, n)
  49 #endif
  50
  51
  52 // forward declaration
  53 class FGTileEntry;
  54
  55
  56 class FGTileMgr {
  57
  58 private:
  59
  60     // Tile loading state
  61     enum load_state {
  62         Start = 0,
  63         Inited = 1,
  64         Running = 2
  65     };
  66
  67     load_state state;
  68
  69     // initialize the cache
  70     void initialize_queue();
  71
  72     // forced emptying of the queue.  This is necessay to keep
  73     // bookeeping straight for the tile_cache -- which actually
  74     // handles all the (de)allocations
  75     void destroy_queue();
  76
  77     // schedule a tile for loading
  78     void sched_tile( const SGBucket& b );
  79
  80     // schedule a needed buckets for loading
  81     void schedule_needed();
  82
  83     // see comment at prep_ssg_nodes()
  84     void prep_ssg_node( int idx );
  85
  86     // int hitcount;
  87     // sgdVec3 hit_pts [ MAX_HITS ] ;
  88
  89     // ssgEntity *last_hit;
  90     FGHitList hit_list;
  91
  92     SGBucket previous_bucket;
  93     SGBucket current_bucket;
  94     SGBucket pending;
  95
  96     FGTileEntry *current_tile;
  97
  98     // x and y distance of tiles to load/draw
  99     float vis;
 100     int xrange, yrange;
 101
 102     // current longitude latitude
 103     double longitude;
 104     double latitude;
 105     double last_longitude;
 106     double last_latitude;
 107
 108     /**
 109      * tile cache
 110      */
 111     FGNewCache tile_cache;
 112
 113     /**
 114      * Queue tiles for loading.
 115      */
 116     FGTileLoader loader;
 117     int counter_hack;
 118
 119 #ifdef ENABLE_THREADS
 120     /**
 121      * Tiles to add to scene graph.
 122      */
 123     static SGLockedQueue<FGTileEntry*> loaded_queue;
 124
 125 public:
 126
 127     /**
 128      * Add a loaded tile to the scene graph queue.
 129      */
 130     static void loaded( FGTileEntry* t ) { loaded_queue.push(t); }
 131 #endif // ENABLE_THREADS
 132
 133 public:
 134
 135     // Constructor
 136     FGTileMgr();
 137
 138     // Destructor
 139     ~FGTileMgr();
 140
 141     // Initialize the Tile Manager subsystem
 142     int init();
 143
 144     // given the current lon/lat (in degrees), fill in the array of
 145     // local chunks.  If the chunk isn't already in the cache, then
 146     // read it from disk.
 147     int update( double lon, double lat );
 148
 149     // Determine scenery altitude.  Normally this just happens when we
 150     // render the scene, but we'd also like to be able to do this
 151     // explicitely.  lat & lon are in radians.  abs_view_pos in
 152     // meters.  Returns result in meters.
 153     void my_ssg_los( string s, ssgBranch *branch, sgdMat4 m,
 154                      const sgdVec3 p, const sgdVec3 dir, sgdVec3 normal );
 155
 156     void my_ssg_los( ssgBranch *branch, sgdMat4 m,
 157                      const sgdVec3 p, const sgdVec3 dir,
 158                      FGHitList *list );
 159
 160     bool current_elev_ssg( sgdVec3 abs_view_pos, double *terrain_elev );
 161
 162     // Prepare the ssg nodes ... for each tile, set it's proper
 163     // transform and update it's range selector based on current
 164     // visibilty
 165     void prep_ssg_nodes();
 166 };
 167
 168
 169 // the tile manager
 170 extern FGTileMgr global_tile_mgr;
 171
 172
 173 #endif // _TILEMGR_HXX