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  - http://www.flightgear.org/~curt
   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 #include <simgear/compiler.h>
  37
  38 #include <vector>
  39 #include STL_STRING
  40
  41 #include <simgear/bucket/newbucket.hxx>
  42 #include <simgear/math/point3d.hxx>
  43 #include <simgear/misc/sg_path.hxx>
  44
  45 #if defined( sgi )
  46 #include <strings.h>
  47 #endif
  48
  49 SG_USING_STD(string);
  50 SG_USING_STD(vector);
  51
  52
  53 typedef vector < Point3D > point_list;
  54 typedef point_list::iterator point_list_iterator;
  55 typedef point_list::const_iterator const_point_list_iterator;
  56
  57
  58 class ssgLeaf;
  59 class ssgBranch;
  60 class ssgTransform;
  61 class ssgPlacementTransform;
  62 class ssgSelector;
  63 class ssgRangeSelector;
  64 class ssgVertexArray;
  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     SGBucket bucket;
  80
  81
  82 public:
  83
  84     inline FGDeferredModel() { }
  85     inline FGDeferredModel( const string& mp, const string& tp, SGBucket b,
  86                      FGTileEntry *t, ssgTransform *ot )
  87     {
  88         model_path = mp;
  89         texture_path = tp;
  90         bucket = b;
  91         tile = t;
  92         obj_trans = ot;
  93     }
  94     inline ~FGDeferredModel() { }
  95     inline const string& get_model_path() const { return model_path; }
  96     inline const string& get_texture_path() const { return texture_path; }
  97     inline const SGBucket& get_bucket() const { return bucket; }
  98     inline FGTileEntry *get_tile() const { return tile; }
  99     inline ssgTransform *get_obj_trans() const { return obj_trans; }
 100 };
 101
 102
 103 /**
 104  * A class to encapsulate everything we need to know about a scenery tile.
 105  */
 106 class FGTileEntry {
 107
 108 public:
 109
 110     // global tile culling data
 111     Point3D center;
 112     double bounding_radius;
 113
 114     // this tile's official location in the world
 115     SGBucket tile_bucket;
 116
 117 private:
 118
 119     // ssg tree structure for this tile is as follows:
 120     // ssgRoot(scene)
 121     //     - ssgBranch(terrain)
 122     //        - ssgTransform(tile)
 123     //           - ssgRangeSelector(tile)
 124     //              - ssgEntity(tile)
 125     //                 - kid1(fan)
 126     //                 - kid2(fan)
 127     //                   ...
 128     //                 - kidn(fan)
 129
 130     // pointer to ssg transform for this tile
 131     ssgPlacementTransform *terra_transform;
 132     ssgPlacementTransform *vasi_lights_transform;
 133     ssgPlacementTransform *rwy_lights_transform;
 134     ssgPlacementTransform *taxi_lights_transform;
 135     ssgPlacementTransform *gnd_lights_transform;
 136
 137     // pointer to ssg range selector for this tile
 138     ssgRangeSelector *terra_range;
 139     ssgRangeSelector *gnd_lights_range;
 140
 141     // we create several preset brightness and can choose which one we
 142     // want based on lighting conditions.
 143     ssgSelector *gnd_lights_brightness;
 144
 145     // we need to be able to turn runway lights on or off (doing this
 146     // via a call back would be nifty, but then the call back needs to
 147     // know about the higher level application's global state which is
 148     // a problem if we move the code into simgear.)
 149     ssgSelector *vasi_lights_selector;
 150     ssgSelector *rwy_lights_selector;
 151     ssgSelector *taxi_lights_selector;
 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     bool obj_load( const string& path,
 168                    ssgBranch* geometry,
 169                    ssgBranch* vasi_lights,
 170                    ssgBranch* rwy_lights,
 171                    ssgBranch* taxi_lights,
 172                    ssgVertexArray* gound_lights,
 173                    bool is_base );
 174
 175     ssgLeaf* gen_lights( SGMaterialLib *matlib, ssgVertexArray *lights,
 176                          int inc, float bright );
 177
 178     double timestamp;
 179
 180     /**
 181      * this value is used by the tile scheduler/loader to mark which
 182      * tiles are in the primary ring (i.e. the current tile or the
 183      * surrounding eight.)  Other routines then can use this as an
 184      * optimization and not do some operation to tiles outside of this
 185      * inner ring.  (For instance vasi color updating)
 186      */
 187     bool is_inner_ring;
 188
 189     /**
 190      * this variable tracks the status of the incremental memory
 191      * freeing.
 192      */
 193     enum {
 194         NODES = 0x01,
 195         VEC_PTRS = 0x02,
 196         TERRA_NODE = 0x04,
 197         GROUND_LIGHTS = 0x08,
 198         VASI_LIGHTS = 0x10,
 199         RWY_LIGHTS = 0x20,
 200         TAXI_LIGHTS = 0x40,
 201         LIGHTMAPS = 0x80
 202     };
 203     int free_tracker;
 204
 205 public:
 206
 207     // Constructor
 208     FGTileEntry( const SGBucket& b );
 209
 210     // Destructor
 211     ~FGTileEntry();
 212
 213     // Clean up the memory used by this tile and delete the arrays
 214     // used by ssg as well as the whole ssg branch.  This does a
 215     // partial clean up and exits so we can spread the load across
 216     // multiple frames.  Returns false if work remaining to be done,
 217     // true if dynamically allocated memory used by this tile is
 218     // completely freed.
 219     bool free_tile();
 220
 221     // Update the ssg transform node for this tile so it can be
 222     // properly drawn relative to our (0,0,0) point
 223     void prep_ssg_node( const Point3D& p, sgVec3 up, float vis);
 224
 225     /**
 226      * Load tile data from a file.
 227      * @param base name of directory containing tile data file.
 228      * @param is_base is this a base terrain object for which we should generate
 229      *        random ground light points */
 230     void load( const string_list &base_path, bool is_base );
 231
 232     /**
 233      * Return true if the tile entry is loaded, otherwise return false
 234      * indicating that the loading thread is still working on this.
 235      */
 236     inline bool is_loaded() const { return loaded; }
 237
 238     /**
 239      * decrement the pending models count
 240      */
 241     inline void dec_pending_models() { pending_models--; }
 242
 243     /**
 244      * return the number of remaining pending models for this tile
 245      */
 246     inline int get_pending_models() const { return pending_models; }
 247
 248     /**
 249      * Return the "bucket" for this tile
 250      */
 251     inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
 252
 253     /**
 254      * Apply ssgLeaf::makeDList to all leaf of a branch
 255      */
 256     void makeDList( ssgBranch *b );
 257
 258     /**
 259      * Add terrain mesh and ground lighting to scene graph.
 260      */
 261     void add_ssg_nodes( ssgBranch *terrain_branch,
 262                         ssgBranch *gnd_lights_branch,
 263                         ssgBranch *vasi_lights_branch,
 264                         ssgBranch *rwy_lights_branch,
 265                         ssgBranch *taxi_lights_branch );
 266
 267     /**
 268      * disconnect terrain mesh and ground lighting nodes from scene
 269      * graph for this tile.
 270      */
 271     void disconnect_ssg_nodes();
 272
 273
 274     /**
 275      * return the SSG Transform node for the terrain
 276      */
 277     inline ssgPlacementTransform *get_terra_transform() const { return terra_transform; }
 278
 279     inline double get_timestamp() const { return timestamp; }
 280     inline void set_timestamp( double time_ms ) { timestamp = time_ms; }
 281
 282     inline bool get_inner_ring() const { return is_inner_ring; }
 283     inline void set_inner_ring( bool val ) { is_inner_ring = val; }
 284 };
 285
 286
 287 #endif // _TILEENTRY_HXX