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     // forced emptying of the queue.  This is necessay to keep
  76     // bookeeping straight for the tile_cache -- which actually
  77     // handles all the (de)allocations
  78     void destroy_queue();
  79
  80     // schedule a tile for loading
  81     void sched_tile( const SGBucket& b );
  82
  83     // schedule a needed buckets for loading
  84     void schedule_needed();
  85
  86     // see comment at prep_ssg_nodes()
  87     void prep_ssg_node( int idx );
  88
  89     // int hitcount;
  90     // sgdVec3 hit_pts [ MAX_HITS ] ;
  91
  92     // ssgEntity *last_hit;
  93     FGHitList hit_list;
  94
  95     SGBucket previous_bucket;
  96     SGBucket current_bucket;
  97     SGBucket pending;
  98
  99     FGTileEntry *current_tile;
 100
 101     // x and y distance of tiles to load/draw
 102     float vis;
 103     int xrange, yrange;
 104
 105     // current longitude latitude
 106     double longitude;
 107     double latitude;
 108     double last_longitude;
 109     double last_latitude;
 110
 111     /**
 112      * tile cache
 113      */
 114     FGNewCache tile_cache;
 115
 116     /**
 117      * Queue tiles for loading.
 118      */
 119     FGTileLoader loader;
 120     int counter_hack;
 121
 122     /**
 123      * Work queues.
 124      *
 125      * attach_queue is the tiles that have been loaded [by the pager]
 126      * that can be attached to the scene graph by the render thread.
 127      *
 128      * model_queue is the set of models that need to be loaded by the
 129      * primary render thread.
 130      */
 131 #ifdef ENABLE_THREADS
 132     static SGLockedQueue<FGTileEntry *> attach_queue;
 133     static SGLockedQueue<FGDeferredModel *> model_queue;
 134 #else
 135     static queue<FGTileEntry *> attach_queue;
 136     static queue<FGDeferredModel *> model_queue;
 137 #endif // ENABLE_THREADS
 138
 139 public:
 140
 141     /**
 142      * Add a loaded tile to the 'attach to the scene graph' queue.
 143      */
 144     static void ready_to_attach( FGTileEntry *t ) { attach_queue.push( t ); }
 145
 146     /**
 147      * Tile is detatched from scene graph and is ready to delete
 148      */
 149     inline void ready_to_delete( FGTileEntry *t ) { loader.remove( t ); }
 150
 151     /**
 152      * Add a pending model to the 'deferred model load' queue
 153      */
 154     static void model_ready( FGDeferredModel *dm ) { model_queue.push( dm ); }
 155
 156 public:
 157
 158     // Constructor
 159     FGTileMgr();
 160
 161     // Destructor
 162     ~FGTileMgr();
 163
 164     // Initialize the Tile Manager subsystem
 165     int init();
 166
 167     // given the current lon/lat (in degrees), fill in the array of
 168     // local chunks.  If the chunk isn't already in the cache, then
 169     // read it from disk.
 170     int update( double lon, double lat );
 171
 172     // Determine scenery altitude.  Normally this just happens when we
 173     // render the scene, but we'd also like to be able to do this
 174     // explicitely.  lat & lon are in radians.  abs_view_pos in
 175     // meters.  Returns result in meters.
 176     void my_ssg_los( string s, ssgBranch *branch, sgdMat4 m,
 177                      const sgdVec3 p, const sgdVec3 dir, sgdVec3 normal );
 178
 179     void my_ssg_los( ssgBranch *branch, sgdMat4 m,
 180                      const sgdVec3 p, const sgdVec3 dir,
 181                      FGHitList *list );
 182
 183     bool current_elev_ssg( sgdVec3 abs_view_pos, double *terrain_elev );
 184
 185     // Prepare the ssg nodes ... for each tile, set it's proper
 186     // transform and update it's range selector based on current
 187     // visibilty
 188     void prep_ssg_nodes();
 189 };
 190
 191
 192 // the tile manager
 193 extern FGTileMgr global_tile_mgr;
 194
 195
 196 #endif // _TILEMGR_HXX