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     static bool obj_load( const std::string& path,
  72                           osg::Group* geometry,
  73                           bool is_base,
  74                           const osgDB::ReaderWriter::Options* options);
  75
  76     /**
  77      * this value is used by the tile scheduler/loader to mark which
  78      * tiles are in the primary ring (i.e. the current tile or the
  79      * surrounding eight.)  Other routines then can use this as an
  80      * optimization and not do some operation to tiles outside of this
  81      * inner ring.  (For instance vasi color updating)
  82      */
  83     bool is_inner_ring;
  84
  85     static ModelLoadHelper *_modelLoader;
  86
  87 public:
  88
  89     // Constructor
  90     TileEntry( const SGBucket& b );
  91
  92     // Destructor
  93     ~TileEntry();
  94
  95     static void setModelLoadHelper(ModelLoadHelper *m) { _modelLoader=m; }
  96
  97     // Update the ssg transform node for this tile so it can be
  98     // properly drawn relative to our (0,0,0) point
  99     void prep_ssg_node(float vis);
 100
 101     /**
 102      * Transition to OSG database pager
 103      */
 104     static osg::Node* loadTileByFileName(const std::string& index_str,
 105                                          const osgDB::ReaderWriter::Options*);
 106     /**
 107      * Return true if the tile entry is loaded, otherwise return false
 108      * indicating that the loading thread is still working on this.
 109      */
 110     inline bool is_loaded() const
 111     {
 112         return _node->getNumChildren() > 0;
 113     }
 114
 115     /**
 116      * Return the "bucket" for this tile
 117      */
 118     inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
 119
 120     /**
 121      * Add terrain mesh and ground lighting to scene graph.
 122      */
 123     void addToSceneGraph( osg::Group *terrain_branch);
 124
 125     /**
 126      * disconnect terrain mesh and ground lighting nodes from scene
 127      * graph for this tile.
 128      */
 129     void removeFromSceneGraph();
 130
 131
 132     /**
 133      * return the scenegraph node for the terrain
 134      */
 135     osg::LOD *getNode() const { return _node.get(); }
 136
 137     double get_timestamp() const;
 138     void set_timestamp( double time_ms );
 139
 140     inline bool get_inner_ring() const { return is_inner_ring; }
 141     inline void set_inner_ring( bool val ) { is_inner_ring = val; }
 142
 143     // Get the ref_ptr to the DatabaseRequest object, in order to pass
 144     // this to the pager.
 145     osg::ref_ptr<osg::Referenced>& getDatabaseRequest()
 146     {
 147         return _databaseRequest;
 148     }
 149 };
 150
 151 class ModelLoadHelper {
 152 public:
 153     virtual osg::Node *loadTileModel(const string& modelPath, bool cacheModel)=0;
 154
 155 };
 156
 157 }
 158
 159 #endif // _TILEENTRY_HXX