src/Scenery/tilecache.hxx

   1 // tilecache.hxx -- routines to handle scenery tile caching
   2 //
   3 // Written by Curtis Olson, started January 1998.
   4 //
   5 // Copyright (C) 1998 - 2000  Curtis L. Olson  - curt@flightgear.org
   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 _TILECACHE_HXX
  25 #define _TILECACHE_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32
  33 #ifdef HAVE_CONFIG_H
  34 #  include <config.h>
  35 #endif
  36
  37 #ifdef HAVE_WINDOWS_H
  38 #  include <windows.h>
  39 #endif
  40
  41 #include <GL/glut.h>
  42 #include <simgear/xgl/xgl.h>
  43
  44 #include <vector>
  45
  46 #include <simgear/bucket/newbucket.hxx>
  47 #include <simgear/math/point3d.hxx>
  48
  49 #include "tileentry.hxx"
  50
  51 FG_USING_STD(vector);
  52
  53
  54 // A class to store and manage a pile of tiles
  55 class FGTileCache {
  56
  57     // cache storage space
  58     tile_list tile_cache;
  59
  60 public:
  61
  62     // Constructor
  63     FGTileCache( void );
  64
  65     // Destructor
  66     ~FGTileCache( void );
  67
  68     // Initialize the tile cache subsystem
  69     void init( void );
  70
  71     // Search for the specified "bucket" in the cache
  72     int exists( const FGBucket& p );
  73
  74     // Return index of next available slot in tile cache
  75     int next_avail( void );
  76
  77     // Free a tile cache entry
  78     void entry_free( int index );
  79
  80     // Fill in a tile cache entry with real data for the specified bucket
  81     void fill_in( int index, const FGBucket& p );
  82
  83     // Return a pointer to the specified tile cache entry
  84     FGTileEntry *get_tile( int index ) {
  85         return &tile_cache[index];
  86     }
  87
  88     // Return the cache size
  89     inline size_t get_size() const { return tile_cache.size(); }
  90 };
  91
  92
  93 // the tile cache
  94 extern FGTileCache global_tile_cache;
  95
  96
  97 #endif // _TILECACHE_HXX