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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 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
  46 #include <osg/ref_ptr>
  47 #include <osg/Array>
  48 #include <osg/Group>
  49 #include <osg/LOD>
  50 #include <osg/MatrixTransform>
  51 #include <osg/Switch>
  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
  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     osg::ref_ptr<osg::MatrixTransform> obj_trans;
  80     SGBucket bucket;
  81     bool cache_obj;
  82
  83
  84 public:
  85
  86     inline FGDeferredModel() { }
  87     inline FGDeferredModel( const string& mp, const string& tp, SGBucket b,
  88                             FGTileEntry *t, osg::MatrixTransform *ot, bool co )
  89     {
  90         model_path = mp;
  91         texture_path = tp;
  92         bucket = b;
  93         tile = t;
  94         obj_trans = ot;
  95         cache_obj = co;
  96     }
  97     inline ~FGDeferredModel() { }
  98     inline const string& get_model_path() const { return model_path; }
  99     inline const string& get_texture_path() const { return texture_path; }
 100     inline const SGBucket& get_bucket() const { return bucket; }
 101     inline const bool get_cache_state() const { return cache_obj; }
 102     inline FGTileEntry *get_tile() const { return tile; }
 103     inline osg::MatrixTransform *get_obj_trans() const { return obj_trans.get(); }
 104 };
 105
 106
 107 /**
 108  * A class to encapsulate everything we need to know about a scenery tile.
 109  */
 110 class FGTileEntry {
 111
 112 public:
 113     // this tile's official location in the world
 114     SGBucket tile_bucket;
 115
 116 private:
 117
 118     // pointer to ssg transform for this tile
 119     osg::ref_ptr<osg::Group> terra_transform;
 120
 121     // pointer to ssg range selector for this tile
 122     osg::ref_ptr<osg::LOD> terra_range;
 123
 124     /**
 125      * Indicates this tile has been loaded from a file and connected
 126      * into the scene graph.  Note that this may be set asynchronously
 127      * by another thread.
 128      */
 129     volatile bool loaded;
 130
 131     /**
 132      * Count of pending models to load for this tile.  This tile
 133      * cannot be removed until this number reaches zero (i.e. no
 134      * pending models to load for this tile.)
 135      */
 136     volatile int pending_models;
 137
 138     bool obj_load( const string& path,
 139                    osg::Group* geometry,
 140                    bool is_base );
 141
 142     double timestamp;
 143
 144     /**
 145      * this value is used by the tile scheduler/loader to mark which
 146      * tiles are in the primary ring (i.e. the current tile or the
 147      * surrounding eight.)  Other routines then can use this as an
 148      * optimization and not do some operation to tiles outside of this
 149      * inner ring.  (For instance vasi color updating)
 150      */
 151     bool is_inner_ring;
 152
 153     /**
 154      * this variable tracks the status of the incremental memory
 155      * freeing.
 156      */
 157     enum {
 158         NODES = 0x01,
 159         VEC_PTRS = 0x02,
 160         TERRA_NODE = 0x04,
 161         GROUND_LIGHTS = 0x08,
 162         VASI_LIGHTS = 0x10,
 163         RWY_LIGHTS = 0x20,
 164         TAXI_LIGHTS = 0x40,
 165         LIGHTMAPS = 0x80
 166     };
 167     int free_tracker;
 168
 169 public:
 170
 171     // Constructor
 172     FGTileEntry( const SGBucket& b );
 173
 174     // Destructor
 175     ~FGTileEntry();
 176
 177     // Clean up the memory used by this tile and delete the arrays
 178     // used by ssg as well as the whole ssg branch.  This does a
 179     // partial clean up and exits so we can spread the load across
 180     // multiple frames.  Returns false if work remaining to be done,
 181     // true if dynamically allocated memory used by this tile is
 182     // completely freed.
 183     bool free_tile();
 184
 185     // Update the ssg transform node for this tile so it can be
 186     // properly drawn relative to our (0,0,0) point
 187     void prep_ssg_node(float vis);
 188
 189     /**
 190      * Load tile data from a file.
 191      * @param base name of directory containing tile data file.
 192      * @param is_base is this a base terrain object for which we should generate
 193      *        random ground light points */
 194     void load( const string_list &base_path, bool is_base );
 195
 196     /**
 197      * Return true if the tile entry is loaded, otherwise return false
 198      * indicating that the loading thread is still working on this.
 199      */
 200     inline bool is_loaded() const { return loaded; }
 201
 202     /**
 203      * decrement the pending models count
 204      */
 205     inline void dec_pending_models() { pending_models--; }
 206
 207     /**
 208      * return the number of remaining pending models for this tile
 209      */
 210     inline int get_pending_models() const { return pending_models; }
 211
 212     /**
 213      * Return the "bucket" for this tile
 214      */
 215     inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
 216
 217     /**
 218      * Add terrain mesh and ground lighting to scene graph.
 219      */
 220     void add_ssg_nodes( osg::Group *terrain_branch);
 221
 222     /**
 223      * disconnect terrain mesh and ground lighting nodes from scene
 224      * graph for this tile.
 225      */
 226     void disconnect_ssg_nodes();
 227
 228
 229     /**
 230      * return the SSG Transform node for the terrain
 231      */
 232     osg::Group *get_terra_transform() const { return terra_transform.get(); }
 233
 234     inline double get_timestamp() const { return timestamp; }
 235     inline void set_timestamp( double time_ms ) { timestamp = time_ms; }
 236
 237     inline bool get_inner_ring() const { return is_inner_ring; }
 238     inline void set_inner_ring( bool val ) { is_inner_ring = val; }
 239 };
 240
 241
 242 #endif // _TILEENTRY_HXX