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/math/point3d.hxx>
  39 #include <simgear/misc/sg_path.hxx>
  40
  41 #include <osg/ref_ptr>
  42 #include <osgDB/ReaderWriter>
  43 #include <osg/Group>
  44 #include <osg/LOD>
  45
  46 #if defined( sgi )
  47 #include <strings.h>
  48 #endif
  49
  50 namespace simgear {
  51
  52 class ModelLoadHelper;
  53
  54 /**
  55  * A class to encapsulate everything we need to know about a scenery tile.
  56  */
  57 class TileEntry {
  58
  59 public:
  60     // this tile's official location in the world
  61     SGBucket tile_bucket;
  62     std::string tileFileName;
  63
  64 private:
  65
  66     // pointer to ssg range selector for this tile
  67     osg::ref_ptr<osg::LOD> _node;
  68     // Reference to DatabaseRequest object set and used by the
  69     // osgDB::DatabasePager.
  70     osg::ref_ptr<osg::Referenced> _databaseRequest;
  71
  72     static bool obj_load( const std::string& path,
  73                           osg::Group* geometry,
  74                           bool is_base,
  75                           const osgDB::ReaderWriter::Options* options);
  76
  77     /**
  78      * this value is used by the tile scheduler/loader to mark which
  79      * tiles are in the primary ring (i.e. the current tile or the
  80      * surrounding eight.)  Other routines then can use this as an
  81      * optimization and not do some operation to tiles outside of this
  82      * inner ring.  (For instance vasi color updating)
  83      */
  84     bool is_inner_ring;
  85
  86     static ModelLoadHelper *_modelLoader;
  87
  88 public:
  89
  90     // Constructor
  91     TileEntry( const SGBucket& b );
  92
  93     // Destructor
  94     ~TileEntry();
  95
  96     static void setModelLoadHelper(ModelLoadHelper *m) { _modelLoader=m; }
  97
  98     // Update the ssg transform node for this tile so it can be
  99     // properly drawn relative to our (0,0,0) point
 100     void prep_ssg_node(float vis);
 101
 102     /**
 103      * Transition to OSG database pager
 104      */
 105     static osg::Node* loadTileByFileName(const std::string& index_str,
 106                                          const osgDB::ReaderWriter::Options*);
 107     /**
 108      * Return true if the tile entry is loaded, otherwise return false
 109      * indicating that the loading thread is still working on this.
 110      */
 111     inline bool is_loaded() const
 112     {
 113         return _node->getNumChildren() > 0;
 114     }
 115
 116     /**
 117      * Return the "bucket" for this tile
 118      */
 119     inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
 120
 121     /**
 122      * Add terrain mesh and ground lighting to scene graph.
 123      */
 124     void addToSceneGraph( osg::Group *terrain_branch);
 125
 126     /**
 127      * disconnect terrain mesh and ground lighting nodes from scene
 128      * graph for this tile.
 129      */
 130     void removeFromSceneGraph();
 131
 132
 133     /**
 134      * return the scenegraph node for the terrain
 135      */
 136     osg::LOD *getNode() const { return _node.get(); }
 137
 138     double get_timestamp() const;
 139     void set_timestamp( double time_ms );
 140
 141     inline bool get_inner_ring() const { return is_inner_ring; }
 142     inline void set_inner_ring( bool val ) { is_inner_ring = val; }
 143
 144     // Get the ref_ptr to the DatabaseRequest object, in order to pass
 145     // this to the pager.
 146     osg::ref_ptr<osg::Referenced>& getDatabaseRequest()
 147     {
 148         return _databaseRequest;
 149     }
 150 };
 151
 152 class ModelLoadHelper {
 153 public:
 154     virtual osg::Node *loadTileModel(const string& modelPath, bool cacheModel)=0;
 155
 156 };
 157
 158 }
 159
 160 #endif // _TILEENTRY_HXX