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 <XGL/xgl.h>
  42
  43 #include <Include/compiler.h>
  44
  45 #include <vector>
  46 #include STL_STRING
  47
  48 #include <ssg.h>                // plib includes
  49
  50 #include <Bucket/newbucket.hxx>
  51 #include <Math/point3d.hxx>
  52 #include <Objects/fragment.hxx>
  53
  54 #ifdef FG_HAVE_NATIVE_SGI_COMPILERS
  55 #include <strings.h>
  56 #endif
  57
  58 FG_USING_STD(string);
  59 FG_USING_STD(vector);
  60
  61
  62 typedef vector < Point3D > point_list;
  63 typedef point_list::iterator point_list_iterator;
  64 typedef point_list::const_iterator const_point_list_iterator;
  65
  66
  67 // Scenery tile class
  68 class FGTileEntry {
  69
  70 private:
  71
  72     // Tile state
  73     enum tile_state {
  74         Unused = 0,
  75         Scheduled_for_use = 1,
  76         Scheduled_for_cache = 2,
  77         Loaded = 3,
  78         Cached = 4
  79     };
  80
  81 public:
  82
  83     typedef vector < fgFRAGMENT > container;
  84     typedef container::iterator FragmentIterator;
  85     typedef container::const_iterator FragmentConstIterator;
  86
  87     typedef vector < unsigned short * > free_list;
  88
  89 public:
  90     // node list (the per fragment face lists reference this node list)
  91     point_list nodes;
  92     int ncount;
  93
  94     // global tile culling data
  95     Point3D center;
  96     double bounding_radius;
  97     Point3D offset;
  98
  99     // model view matrix for this tile
 100     GLfloat model_view[16];
 101
 102     // this tile's official location in the world
 103     FGBucket tile_bucket;
 104
 105     // the tile cache will keep track here if the tile is being used
 106     tile_state state;
 107
 108     container fragment_list;
 109
 110     // ssg related structures
 111     sgVec3 *vtlist;
 112     sgVec3 *vnlist;
 113     sgVec2 *tclist;
 114     free_list free_ptrs; // list of pointers to free when tile
 115                                  // entry goes away
 116
 117     // ssg tree structure for this tile is as follows:
 118     // ssgRoot(scene)
 119     //     - ssgBranch(terrain)
 120     //      - ssgSelector(tile)
 121     //        - ssgTransform(tile)
 122     //           - ssgRangeSelector(tile)
 123     //              - ssgEntity(tile)
 124     //                 - kid1(fan)
 125     //                 - kid2(fan)
 126     //                   ...
 127     //                 - kidn(fan)
 128
 129     // selector (turn tile on/off)
 130     ssgSelector *select_ptr;
 131
 132     // pointer to ssg transform for this tile
 133     ssgTransform *transform_ptr;
 134
 135     // pointer to ssg range selector for this tile
 136     ssgRangeSelector *range_ptr;
 137
 138 public:
 139
 140     // Constructor
 141     FGTileEntry ( void );
 142
 143     // Destructor
 144     ~FGTileEntry ( void );
 145
 146     FragmentIterator begin() { return fragment_list.begin(); }
 147     FragmentConstIterator begin() const { return fragment_list.begin(); }
 148
 149     FragmentIterator end() { return fragment_list.end(); }
 150     FragmentConstIterator end() const { return fragment_list.end(); }
 151
 152     void add_fragment( fgFRAGMENT& frag ) {
 153         frag.tile_ptr = this;
 154         fragment_list.push_back( frag );
 155     }
 156
 157     size_t num_fragments() const {
 158         return fragment_list.size();
 159     }
 160
 161     // Step through the fragment list, deleting the display list, then
 162     // the fragment, until the list is empty.  Also delete the arrays
 163     // used by ssg as well as the whole ssg branch
 164     void free_tile();
 165
 166     // Calculate this tile's offset
 167     void SetOffset( const Point3D& p)
 168     {
 169         offset = center - p;
 170     }
 171
 172     // Return this tile's offset
 173     inline Point3D get_offset( void ) const { return offset; }
 174
 175     // Calculate the model_view transformation matrix for this tile
 176     inline void update_view_matrix(GLfloat *MODEL_VIEW)
 177     {
 178
 179 #if defined( USE_MEM ) || defined( WIN32 )
 180         memcpy( model_view, MODEL_VIEW, 16*sizeof(GLfloat) );
 181 #else
 182         bcopy( MODEL_VIEW, model_view, 16*sizeof(GLfloat) );
 183 #endif
 184
 185         // This is equivalent to doing a glTranslatef(x, y, z);
 186         model_view[12] += (model_view[0]*offset.x() +
 187                            model_view[4]*offset.y() +
 188                            model_view[8]*offset.z());
 189         model_view[13] += (model_view[1]*offset.x() +
 190                            model_view[5]*offset.y() +
 191                            model_view[9]*offset.z());
 192         model_view[14] += (model_view[2]*offset.x() +
 193                            model_view[6]*offset.y() +
 194                            model_view[10]*offset.z() );
 195         // m[15] += (m[3]*x + m[7]*y + m[11]*z);
 196         // m[3] m7[] m[11] are 0.0 see LookAt() in views.cxx
 197         // so m[15] is unchanged
 198     }
 199
 200     inline bool is_unused() const { return state == Unused; }
 201     inline bool is_scheduled_for_use() const {
 202         return state == Scheduled_for_use;
 203     }
 204     inline bool is_scheduled_for_cache() const {
 205         return state == Scheduled_for_cache;
 206     }
 207     inline bool is_loaded() const { return state == Loaded; }
 208     inline bool is_cached() const { return state == Cached; }
 209
 210     inline void mark_unused() { state = Unused; }
 211     inline void mark_scheduled_for_use() { state = Scheduled_for_use; }
 212     inline void mark_scheduled_for_cache() { state = Scheduled_for_use; }
 213     inline void mark_loaded() { state = Loaded; }
 214
 215
 216     // when a tile is still in the cache, but not in the immediate
 217     // draw l ist, it can still remain in the scene graph, but we use
 218     // a range selector to disable it from ever being drawn.
 219     void ssg_disable();
 220 };
 221
 222
 223 typedef vector < FGTileEntry > tile_list;
 224 typedef tile_list::iterator tile_list_iterator;
 225 typedef tile_list::const_iterator const_tile_list_iterator;
 226
 227
 228 #endif // _TILEENTRY_HXX