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 #if 0
  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 #endif
 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     std::string tileFileName;
 116
 117 private:
 118
 119     // pointer to ssg range selector for this tile
 120     osg::ref_ptr<osg::LOD> _node;
 121
 122     static bool obj_load( const std::string& path,
 123                           osg::Group* geometry,
 124                           bool is_base );
 125
 126     /**
 127      * this value is used by the tile scheduler/loader to mark which
 128      * tiles are in the primary ring (i.e. the current tile or the
 129      * surrounding eight.)  Other routines then can use this as an
 130      * optimization and not do some operation to tiles outside of this
 131      * inner ring.  (For instance vasi color updating)
 132      */
 133     bool is_inner_ring;
 134
 135     /**
 136      * this variable tracks the status of the incremental memory
 137      * freeing.
 138      */
 139     enum {
 140         NODES = 0x01,
 141         VEC_PTRS = 0x02,
 142         TERRA_NODE = 0x04,
 143         GROUND_LIGHTS = 0x08,
 144         VASI_LIGHTS = 0x10,
 145         RWY_LIGHTS = 0x20,
 146         TAXI_LIGHTS = 0x40,
 147         LIGHTMAPS = 0x80
 148     };
 149     int free_tracker;
 150
 151 public:
 152
 153     // Constructor
 154     FGTileEntry( const SGBucket& b );
 155
 156     // Destructor
 157     ~FGTileEntry();
 158
 159     // Clean up the memory used by this tile and delete the arrays
 160     // used by ssg as well as the whole ssg branch.  This does a
 161     // partial clean up and exits so we can spread the load across
 162     // multiple frames.  Returns false if work remaining to be done,
 163     // true if dynamically allocated memory used by this tile is
 164     // completely freed.
 165     bool free_tile();
 166
 167     // Update the ssg transform node for this tile so it can be
 168     // properly drawn relative to our (0,0,0) point
 169     void prep_ssg_node(float vis);
 170
 171     /**
 172      * Transition to OSG database pager
 173      */
 174     static osg::Node* loadTileByName(const std::string& index_str,
 175                                      const string_list &path_list);
 176     /**
 177      * Return true if the tile entry is loaded, otherwise return false
 178      * indicating that the loading thread is still working on this.
 179      */
 180     inline bool is_loaded() const
 181     {
 182         return _node->getNumChildren() > 0;
 183     }
 184
 185     /**
 186      * Return the "bucket" for this tile
 187      */
 188     inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
 189
 190     /**
 191      * Add terrain mesh and ground lighting to scene graph.
 192      */
 193     void add_ssg_nodes( osg::Group *terrain_branch);
 194
 195     /**
 196      * disconnect terrain mesh and ground lighting nodes from scene
 197      * graph for this tile.
 198      */
 199     void disconnect_ssg_nodes();
 200
 201
 202     /**
 203      * return the scenegraph node for the terrain
 204      */
 205     osg::LOD *getNode() const { return _node.get(); }
 206
 207     double get_timestamp() const;
 208     void set_timestamp( double time_ms );
 209
 210     inline bool get_inner_ring() const { return is_inner_ring; }
 211     inline void set_inner_ring( bool val ) { is_inner_ring = val; }
 212 };
 213
 214
 215 #endif // _TILEENTRY_HXX