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