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