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