Simulator/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) 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 _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 <XGL/xgl.h>
  43
  44 #include <Bucket/newbucket.hxx>
  45 #include <Math/point3d.hxx>
  46
  47 #include "tile.hxx"
  48
  49
  50 // For best results ... i.e. to avoid tile load problems and blank areas
  51 //
  52 // FG_TILE_CACHE_SIZE >= (o->tile_diameter + 1) ** 2
  53 #define FG_TILE_CACHE_SIZE 121
  54
  55 // A class to store and manage a pile of tiles
  56 class fgTILECACHE {
  57
  58 //     enum
  59 //     {
  60 //      // For best results... i.e. to avoid tile load problems and blank areas
  61 //      // FG_TILE_CACHE_SIZE >= (o->tile_diameter + 1) ** 2
  62 //      FG_TILE_CACHE_SIZE = 121
  63 //     };
  64
  65     // cache storage space
  66     fgTILE tile_cache[ FG_TILE_CACHE_SIZE ];
  67
  68 public:
  69
  70     // Constructor
  71     fgTILECACHE( void );
  72
  73     // Initialize the tile cache subsystem
  74     void init( void );
  75
  76     // Search for the specified "bucket" in the cache
  77     int exists( const FGBucket& p );
  78
  79     // Return index of next available slot in tile cache
  80     int next_avail( void );
  81
  82     // Free a tile cache entry
  83     void entry_free( int index );
  84
  85     // Fill in a tile cache entry with real data for the specified bucket
  86     void fill_in( int index, FGBucket& p );
  87
  88     // Return a pointer to the specified tile cache entry
  89     fgTILE *get_tile( int index ) {
  90         return &tile_cache[index];
  91     }
  92
  93     // Destructor
  94     ~fgTILECACHE( void );
  95 };
  96
  97
  98 // the tile cache
  99 extern fgTILECACHE global_tile_cache;
 100
 101
 102 #endif // _TILECACHE_HXX
 103
 104