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 <list>
  35
  36 #include <plib/ssg.h>
  37
  38 #include <simgear/bucket/newbucket.hxx>
  39
  40 #include "hitlist.hxx"
  41
  42 FG_USING_STD(list);
  43
  44
  45 #define FG_LOCAL_X_Y         81  // max(o->tile_diameter) ** 2
  46
  47 #define FG_SQUARE( X ) ( (X) * (X) )
  48
  49 #if defined(USE_MEM) || defined(WIN32)
  50 #  define FG_MEM_COPY(to,from,n)        memcpy(to, from, n)
  51 #else
  52 #  define FG_MEM_COPY(to,from,n)        bcopy(from, to, n)
  53 #endif
  54
  55
  56 // forward declaration
  57 class FGTileEntry;
  58
  59
  60 class FGLoadRec {
  61
  62 public:
  63
  64     FGBucket b;
  65     int cache_index;
  66 };
  67
  68
  69 class FGTileMgr {
  70
  71 private:
  72
  73     // Tile loading state
  74     enum load_state {
  75         Start = 0,
  76         Inited = 1,
  77         Running = 2
  78     };
  79
  80     load_state state;
  81
  82     enum SCROLL_DIRECTION {
  83         SCROLL_INIT = -1,
  84         SCROLL_NONE = 0,
  85         SCROLL_NORTH,
  86         SCROLL_EAST,
  87         SCROLL_SOUTH,
  88         SCROLL_WEST,
  89     };
  90
  91     SCROLL_DIRECTION scroll_direction;
  92
  93     // pending tile load queue
  94     list < FGLoadRec > load_queue;
  95
  96     // initialize the cache
  97     void initialize_queue();
  98
  99     // forced emptying of the queue.  This is necessay to keep
 100     // bookeeping straight for the tile_cache -- which actually
 101     // handles all the (de)allocations
 102     void destroy_queue();
 103
 104     FGBucket BucketOffset( int dx, int dy );
 105
 106     // schedule a tile for loading
 107     int sched_tile( const FGBucket& b );
 108
 109     // load a tile
 110     void load_tile( const FGBucket& b, int cache_index );
 111
 112     // schedule a tile row(column) for loading
 113     void scroll( void );
 114
 115     // see comment at prep_ssg_nodes()
 116     void prep_ssg_node( int idx );
 117
 118     // int hitcount;
 119     // sgdVec3 hit_pts [ MAX_HITS ] ;
 120
 121     // ssgEntity *last_hit;
 122     FGHitList hit_list;
 123
 124     FGBucket previous_bucket;
 125     FGBucket current_bucket;
 126     FGBucket pending;
 127
 128     FGTileEntry *current_tile;
 129
 130     // index of current tile in tile cache;
 131     long int tile_index;
 132     int tile_diameter;
 133
 134     // current longitude latitude
 135     double longitude;
 136     double latitude;
 137     double last_longitude;
 138     double last_latitude;
 139
 140 public:
 141
 142     // Constructor
 143     FGTileMgr ( void );
 144
 145     // Destructor
 146     ~FGTileMgr ( void );
 147
 148     // Initialize the Tile Manager subsystem
 149     int init( void );
 150
 151     // given the current lon/lat (in degrees), fill in the array of
 152     // local chunks.  If the chunk isn't already in the cache, then
 153     // read it from disk.
 154     int update( double lon, double lat );
 155
 156     // Determine scenery altitude.  Normally this just happens when we
 157     // render the scene, but we'd also like to be able to do this
 158     // explicitely.  lat & lon are in radians.  abs_view_pos in
 159     // meters.  Returns result in meters.
 160     void my_ssg_los( string s, ssgBranch *branch, sgdMat4 m,
 161                      const sgdVec3 p, const sgdVec3 dir, sgdVec3 normal );
 162
 163     void my_ssg_los( ssgBranch *branch, sgdMat4 m,
 164                      const sgdVec3 p, const sgdVec3 dir,
 165                      FGHitList *list );
 166
 167     bool current_elev_ssg( sgdVec3 abs_view_pos,
 168                            sgVec3 view_pos );
 169
 170     // Prepare the ssg nodes ... for each tile, set it's proper
 171     // transform and update it's range selector based on current
 172     // visibilty
 173     void prep_ssg_nodes( void );
 174
 175     inline int queue_size() const { return load_queue.size(); }
 176 };
 177
 178
 179 // the tile manager
 180 extern FGTileMgr global_tile_mgr;
 181
 182
 183 #endif // _TILEMGR_HXX