src/Scenery/tileentry.hxx

   1 // tileentry.hxx -- routines to handle an individual scenery tile
   2 //
   3 // Written by Curtis Olson, started May 1998.
   4 //
   5 // Copyright (C) 1998, 1999  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 _TILEENTRY_HXX
  25 #define _TILEENTRY_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32 #ifdef HAVE_CONFIG_H
  33 #  include <config.h>
  34 #endif
  35
  36 #ifdef HAVE_WINDOWS_H
  37 #  include <windows.h>
  38 #endif
  39
  40 #include <GL/glut.h>
  41 #include <simgear/xgl/xgl.h>
  42
  43 #include <simgear/compiler.h>
  44
  45 #include <vector>
  46 #include STL_STRING
  47
  48 #include <plib/ssg.h>           // plib includes
  49
  50 #include <simgear/bucket/newbucket.hxx>
  51 #include <simgear/math/point3d.hxx>
  52
  53 #if defined( sgi )
  54 #include <strings.h>
  55 #endif
  56
  57 FG_USING_STD(string);
  58 FG_USING_STD(vector);
  59
  60
  61 typedef vector < Point3D > point_list;
  62 typedef point_list::iterator point_list_iterator;
  63 typedef point_list::const_iterator const_point_list_iterator;
  64
  65
  66 // Scenery tile class
  67 class FGTileEntry {
  68
  69 private:
  70
  71     // Tile state
  72     enum tile_state {
  73         Unused = 0,
  74         Scheduled_for_use = 1,
  75         Scheduled_for_cache = 2,
  76         Loaded = 3,
  77         Cached = 4
  78     };
  79
  80 public:
  81
  82     typedef vector < sgVec3 * > free_vec3_list;
  83     typedef vector < sgVec2 * > free_vec2_list;
  84     typedef vector < unsigned short * > free_index_list;
  85
  86 public:
  87
  88     // node list
  89     point_list nodes;
  90     int ncount;
  91
  92     // global tile culling data
  93     Point3D center;
  94     double bounding_radius;
  95     Point3D offset;
  96
  97     // this tile's official location in the world
  98     FGBucket tile_bucket;
  99
 100     // the tile cache will keep track here if the tile is being used
 101     tile_state state;
 102
 103     // list of pointers to memory chunks that need to be freed when
 104     // tile entry goes away
 105     free_vec3_list vec3_ptrs;
 106     free_vec2_list vec2_ptrs;
 107     free_index_list index_ptrs;
 108
 109     // ssg tree structure for this tile is as follows:
 110     // ssgRoot(scene)
 111     //     - ssgBranch(terrain)
 112     //      - ssgSelector(tile)
 113     //        - ssgTransform(tile)
 114     //           - ssgRangeSelector(tile)
 115     //              - ssgEntity(tile)
 116     //                 - kid1(fan)
 117     //                 - kid2(fan)
 118     //                   ...
 119     //                 - kidn(fan)
 120
 121     // selector (turn tile on/off)
 122     ssgSelector *select_ptr;
 123
 124     // pointer to ssg transform for this tile
 125     ssgTransform *transform_ptr;
 126
 127     // pointer to ssg range selector for this tile
 128     ssgRangeSelector *range_ptr;
 129
 130 public:
 131
 132     // Constructor
 133     FGTileEntry ( void );
 134
 135     // Destructor
 136     ~FGTileEntry ( void );
 137
 138     // Clean up the memory used by this tile and delete the arrays
 139     // used by ssg as well as the whole ssg branch
 140     void free_tile();
 141
 142     // Calculate this tile's offset
 143     void SetOffset( const Point3D& p)
 144     {
 145         offset = center - p;
 146     }
 147
 148     // Return this tile's offset
 149     inline Point3D get_offset( void ) const { return offset; }
 150
 151     inline bool is_unused() const { return state == Unused; }
 152     inline bool is_scheduled_for_use() const {
 153         return state == Scheduled_for_use;
 154     }
 155     inline bool is_scheduled_for_cache() const {
 156         return state == Scheduled_for_cache;
 157     }
 158     inline bool is_loaded() const { return state == Loaded; }
 159     inline bool is_cached() const { return state == Cached; }
 160
 161     inline void mark_unused() { state = Unused; }
 162     inline void mark_scheduled_for_use() { state = Scheduled_for_use; }
 163     inline void mark_scheduled_for_cache() { state = Scheduled_for_use; }
 164     inline void mark_loaded() { state = Loaded; }
 165
 166
 167     // when a tile is still in the cache, but not in the immediate
 168     // draw l ist, it can still remain in the scene graph, but we use
 169     // a range selector to disable it from ever being drawn.
 170     void ssg_disable();
 171 };
 172
 173
 174 typedef vector < FGTileEntry > tile_list;
 175 typedef tile_list::iterator tile_list_iterator;
 176 typedef tile_list::const_iterator const_tile_list_iterator;
 177
 178
 179 #endif // _TILEENTRY_HXX