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 - 2001  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 <GL/gl.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 SG_USING_STD(string);
  58 SG_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 class FGTileEntry;
  66
  67
  68 /**
  69  * A class to hold deferred model loading info
  70  */
  71 class FGDeferredModel {
  72
  73 private:
  74
  75     string model_path;
  76     string texture_path;
  77     FGTileEntry *tile;
  78     ssgTransform *obj_trans;
  79
  80 public:
  81
  82     inline FGDeferredModel() { }
  83     inline FGDeferredModel( const string mp, const string tp,
  84                      FGTileEntry *t, ssgTransform *ot )
  85     {
  86         model_path = mp;
  87         texture_path = tp;
  88         tile = t;
  89         obj_trans = ot;
  90     }
  91     inline ~FGDeferredModel() { }
  92     inline string get_model_path() const { return model_path; }
  93     inline string get_texture_path() const { return texture_path; }
  94     inline FGTileEntry *get_tile() const { return tile; }
  95     inline ssgTransform *get_obj_trans() const { return obj_trans; }
  96 };
  97
  98
  99 /**
 100  * A class to encapsulate everything we need to know about a scenery tile.
 101  */
 102 class FGTileEntry {
 103
 104 public:
 105
 106     typedef vector < sgVec3 * > free_vec3_list;
 107     typedef vector < sgVec2 * > free_vec2_list;
 108     typedef vector < unsigned short * > free_index_list;
 109
 110     // node list
 111     point_list nodes;
 112     int ncount;
 113
 114     // global tile culling data
 115     Point3D center;
 116     double bounding_radius;
 117     Point3D offset;
 118
 119     // this tile's official location in the world
 120     SGBucket tile_bucket;
 121
 122     // list of pointers to memory chunks that need to be freed when
 123     // tile entry goes away
 124     free_vec3_list vec3_ptrs;
 125     free_vec2_list vec2_ptrs;
 126     free_index_list index_ptrs;
 127
 128 private:
 129
 130     // ssg tree structure for this tile is as follows:
 131     // ssgRoot(scene)
 132     //     - ssgBranch(terrain)
 133     //        - ssgTransform(tile)
 134     //           - ssgRangeSelector(tile)
 135     //              - ssgEntity(tile)
 136     //                 - kid1(fan)
 137     //                 - kid2(fan)
 138     //                   ...
 139     //                 - kidn(fan)
 140
 141     // pointer to ssg transform for this tile
 142     ssgTransform *terra_transform;
 143     ssgTransform *lights_transform;
 144
 145     // pointer to ssg range selector for this tile
 146     ssgRangeSelector *terra_range;
 147     ssgRangeSelector *lights_range;
 148
 149     // we create several preset brightness and can choose which one we
 150     // want based on lighting conditions.
 151     ssgSelector *lights_brightness;
 152
 153     /**
 154      * Indicates this tile has been loaded from a file and connected
 155      * into the scene graph.  Note that this may be set asynchronously
 156      * by another thread.
 157      */
 158     volatile bool loaded;
 159
 160     /**
 161      * Count of pending models to load for this tile.  This tile
 162      * cannot be removed until this number reaches zero (i.e. no
 163      * pending models to load for this tile.)
 164      */
 165     volatile int pending_models;
 166
 167     ssgBranch* obj_load( const std::string& path,
 168                          ssgVertexArray* lights, bool is_base );
 169
 170     ssgLeaf* gen_lights( ssgVertexArray *lights, int inc, float bright );
 171
 172 public:
 173
 174     // Constructor
 175     FGTileEntry( const SGBucket& b );
 176
 177     // Destructor
 178     ~FGTileEntry();
 179
 180 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
 181     // Schedule tile to be freed/removed
 182     void sched_removal();
 183 #endif
 184
 185     // Clean up the memory used by this tile and delete the arrays
 186     // used by ssg as well as the whole ssg branch
 187     void free_tile();
 188
 189     // Calculate this tile's offset
 190     void SetOffset( const Point3D& p)
 191     {
 192         offset = center - p;
 193     }
 194
 195     // Return this tile's offset
 196     inline Point3D get_offset() const { return offset; }
 197
 198     // Update the ssg transform node for this tile so it can be
 199     // properly drawn relative to our (0,0,0) point
 200     void prep_ssg_node( const Point3D& p, float vis);
 201
 202     /**
 203      * Load tile data from a file.
 204      * @param base name of directory containing tile data file.
 205      * @param is_base is this a base terrain object for which we should generate
 206      *        random ground light points */
 207     void load( const SGPath& base, bool is_base );
 208
 209     /**
 210      * Return true if the tile entry is loaded, otherwise return false
 211      * indicating that the loading thread is still working on this.
 212      */
 213     inline bool is_loaded() const { return loaded; }
 214
 215     /**
 216      * decrement the pending models count
 217      */
 218     inline void dec_pending_models() { pending_models--; }
 219
 220     /**
 221      * return the number of remaining pending models for this tile
 222      */
 223     inline int get_pending_models() const { return pending_models; }
 224
 225     /**
 226      * Return the "bucket" for this tile
 227      */
 228     inline SGBucket get_tile_bucket() const { return tile_bucket; }
 229
 230     /**
 231      * Add terrain mesh and ground lighting to scene graph.
 232      */
 233     void add_ssg_nodes( ssgBranch* terrain, ssgBranch* ground );
 234
 235     /**
 236      * disconnect terrain mesh and ground lighting nodes from scene
 237      * graph for this tile.
 238      */
 239     void disconnect_ssg_nodes();
 240 };
 241
 242
 243 #endif // _TILEENTRY_HXX