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