simgear/scene/tgdb/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 #include <simgear/compiler.h>
  33
  34 #include <vector>
  35 #include <string>
  36
  37 #include <simgear/bucket/newbucket.hxx>
  38 #include <simgear/misc/sg_path.hxx>
  39
  40 #include <osg/ref_ptr>
  41 #include <osgDB/ReaderWriter>
  42 #include <osg/Group>
  43 #include <osg/LOD>
  44
  45 #if defined( sgi )
  46 #include <strings.h>
  47 #endif
  48
  49 namespace simgear {
  50
  51 class ModelLoadHelper;
  52
  53 /**
  54  * A class to encapsulate everything we need to know about a scenery tile.
  55  */
  56 class TileEntry {
  57
  58 public:
  59     // this tile's official location in the world
  60     SGBucket tile_bucket;
  61     std::string tileFileName;
  62
  63 private:
  64
  65     // pointer to ssg range selector for this tile
  66     osg::ref_ptr<osg::LOD> _node;
  67     // Reference to DatabaseRequest object set and used by the
  68     // osgDB::DatabasePager.
  69     osg::ref_ptr<osg::Referenced> _databaseRequest;
  70
  71     /**
  72      * This value is used by the tile scheduler/loader to load tiles
  73      * in a useful sequence. The priority is set to reflect the tiles
  74      * distance from the center, so all tiles are loaded in an innermost
  75      * to outermost sequence.
  76      */
  77     float _priority;
  78     /** Flag indicating if tile belongs to current view. */
  79     bool _current_view;
  80     /** Time when tile expires. */
  81     double _time_expired;
  82
  83     static ModelLoadHelper *_modelLoader;
  84
  85 public:
  86
  87     // Constructor
  88     TileEntry( const SGBucket& b );
  89     TileEntry( const TileEntry& t );
  90
  91     // Destructor
  92     ~TileEntry();
  93
  94     static void setModelLoadHelper(ModelLoadHelper *m) { _modelLoader=m; }
  95
  96     // Update the ssg transform node for this tile so it can be
  97     // properly drawn relative to our (0,0,0) point
  98     void prep_ssg_node(float vis);
  99
 100     /**
 101      * Transition to OSG database pager
 102      */
 103     static osg::Node* loadTileByFileName(const std::string& index_str,
 104                                          const osgDB::Options*);
 105     /**
 106      * Return true if the tile entry is loaded, otherwise return false
 107      * indicating that the loading thread is still working on this.
 108      */
 109     inline bool is_loaded() const
 110     {
 111         return _node->getNumChildren() > 0;
 112     }
 113
 114     /**
 115      * Return the "bucket" for this tile
 116      */
 117     inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
 118
 119     /**
 120      * Add terrain mesh and ground lighting to scene graph.
 121      */
 122     void addToSceneGraph( osg::Group *terrain_branch);
 123
 124     /**
 125      * disconnect terrain mesh and ground lighting nodes from scene
 126      * graph for this tile.
 127      */
 128     void removeFromSceneGraph();
 129
 130     /**
 131      * Refresh a tile, reload the node from disk.
 132      */
 133     void refresh();
 134
 135     /**
 136      * return the scenegraph node for the terrain
 137      */
 138     osg::LOD *getNode() const { return _node.get(); }
 139
 140     inline double get_time_expired() const { return _time_expired; }
 141     inline void update_time_expired( double time_expired ) { if (_time_expired<time_expired) _time_expired = time_expired; }
 142
 143     inline void set_priority(float priority) { _priority=priority; }
 144     inline float get_priority() const { return _priority; }
 145     inline void set_current_view(bool current_view) { _current_view = current_view; }
 146     inline bool is_current_view() const { return _current_view; }
 147
 148     /**
 149      * Return true if the tile entry is still needed, otherwise return false
 150      * indicating that the tile is no longer in active use.
 151      */
 152     inline bool is_expired(double current_time) const { return (_current_view) ? false : (current_time > _time_expired); }
 153
 154     // Get the ref_ptr to the DatabaseRequest object, in order to pass
 155     // this to the pager.
 156     osg::ref_ptr<osg::Referenced>& getDatabaseRequest()
 157     {
 158         return _databaseRequest;
 159     }
 160 };
 161
 162 class ModelLoadHelper {
 163 public:
 164     virtual osg::Node *loadTileModel(const std::string& modelPath, bool cacheModel)=0;
 165
 166 };
 167
 168 }
 169
 170 #endif // _TILEENTRY_HXX