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 <queue>
  35
  36 #include <plib/ssg.h>
  37
  38 #include <simgear/bucket/newbucket.hxx>
  39 #ifdef ENABLE_THREADS
  40 #  include <simgear/threads/SGQueue.hxx>
  41 #endif // ENABLE_THREADS
  42
  43 #include "FGTileLoader.hxx"
  44 #include "hitlist.hxx"
  45 #include "newcache.hxx"
  46
  47 #if defined(USE_MEM) || defined(WIN32)
  48 #  define FG_MEM_COPY(to,from,n)        memcpy(to, from, n)
  49 #else
  50 #  define FG_MEM_COPY(to,from,n)        bcopy(from, to, n)
  51 #endif
  52
  53
  54 // forward declaration
  55 class FGTileEntry;
  56 class FGDeferredModel;
  57
  58
  59 class FGTileMgr {
  60
  61 private:
  62
  63     // Tile loading state
  64     enum load_state {
  65         Start = 0,
  66         Inited = 1,
  67         Running = 2
  68     };
  69
  70     load_state state;
  71
  72     // initialize the cache
  73     void initialize_queue();
  74
  75     // schedule a tile for loading
  76     void sched_tile( const SGBucket& b );
  77
  78     // schedule a needed buckets for loading
  79     void schedule_needed();
  80
  81     // see comment at prep_ssg_nodes()
  82     void prep_ssg_node( int idx );
  83
  84     // int hitcount;
  85     // sgdVec3 hit_pts [ MAX_HITS ] ;
  86
  87     // ssgEntity *last_hit;
  88     FGHitList hit_list;
  89
  90     SGBucket previous_bucket;
  91     SGBucket current_bucket;
  92     SGBucket pending;
  93
  94     FGTileEntry *current_tile;
  95
  96     // x and y distance of tiles to load/draw
  97     float vis;
  98     int xrange, yrange;
  99
 100     // current longitude latitude
 101     double longitude;
 102     double latitude;
 103     double last_longitude;
 104     double last_latitude;
 105
 106     /**
 107      * tile cache
 108      */
 109     FGNewCache tile_cache;
 110
 111     /**
 112      * Queue tiles for loading.
 113      */
 114     FGTileLoader loader;
 115     int counter_hack;
 116
 117     /**
 118      * Work queues.
 119      *
 120      * attach_queue is the tiles that have been loaded [by the pager]
 121      * that can be attached to the scene graph by the render thread.
 122      *
 123      * model_queue is the set of models that need to be loaded by the
 124      * primary render thread.
 125      */
 126 #ifdef ENABLE_THREADS
 127     static SGLockedQueue<FGTileEntry *> attach_queue;
 128     static SGLockedQueue<FGDeferredModel *> model_queue;
 129 #else
 130     static queue<FGTileEntry *> attach_queue;
 131     static queue<FGDeferredModel *> model_queue;
 132 #endif // ENABLE_THREADS
 133
 134 public:
 135
 136     /**
 137      * Add a loaded tile to the 'attach to the scene graph' queue.
 138      */
 139     static void ready_to_attach( FGTileEntry *t ) { attach_queue.push( t ); }
 140
 141 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
 142     /**
 143      * Tile is detatched from scene graph and is ready to delete
 144      */
 145     inline void ready_to_delete( FGTileEntry *t ) { loader.remove( t ); }
 146 #endif
 147
 148     /**
 149      * Add a pending model to the 'deferred model load' queue
 150      */
 151     static void model_ready( FGDeferredModel *dm ) { model_queue.push( dm ); }
 152
 153 public:
 154
 155     // Constructor
 156     FGTileMgr();
 157
 158     // Destructor
 159     ~FGTileMgr();
 160
 161     // Initialize the Tile Manager subsystem
 162     int init();
 163
 164     // given the current lon/lat (in degrees), fill in the array of
 165     // local chunks.  If the chunk isn't already in the cache, then
 166     // read it from disk.
 167     int update( double lon, double lat );
 168
 169     // Determine scenery altitude.  Normally this just happens when we
 170     // render the scene, but we'd also like to be able to do this
 171     // explicitely.  lat & lon are in radians.  abs_view_pos in
 172     // meters.  Returns result in meters.
 173     void my_ssg_los( string s, ssgBranch *branch, sgdMat4 m,
 174                      const sgdVec3 p, const sgdVec3 dir, sgdVec3 normal );
 175
 176     void my_ssg_los( ssgBranch *branch, sgdMat4 m,
 177                      const sgdVec3 p, const sgdVec3 dir,
 178                      FGHitList *list );
 179
 180     bool current_elev_ssg( sgdVec3 abs_view_pos, double *terrain_elev );
 181
 182     // Prepare the ssg nodes ... for each tile, set it's proper
 183     // transform and update it's range selector based on current
 184     // visibilty
 185     void prep_ssg_nodes();
 186 };
 187
 188
 189 // the tile manager
 190 extern FGTileMgr global_tile_mgr;
 191
 192
 193 #endif // _TILEMGR_HXX