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