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 STL_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 SG_USING_STD(string);
  52 SG_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
  77     static bool obj_load( const std::string& path,
  78                           osg::Group* geometry,
  79                           bool is_base,
  80                           const osgDB::ReaderWriter::Options* options);
  81
  82     /**
  83      * this value is used by the tile scheduler/loader to mark which
  84      * tiles are in the primary ring (i.e. the current tile or the
  85      * surrounding eight.)  Other routines then can use this as an
  86      * optimization and not do some operation to tiles outside of this
  87      * inner ring.  (For instance vasi color updating)
  88      */
  89     bool is_inner_ring;
  90
  91     /**
  92      * this variable tracks the status of the incremental memory
  93      * freeing.
  94      */
  95     enum {
  96         NODES = 0x01,
  97         VEC_PTRS = 0x02,
  98         TERRA_NODE = 0x04,
  99         GROUND_LIGHTS = 0x08,
 100         VASI_LIGHTS = 0x10,
 101         RWY_LIGHTS = 0x20,
 102         TAXI_LIGHTS = 0x40,
 103         LIGHTMAPS = 0x80
 104     };
 105     int free_tracker;
 106
 107     static ModelLoadHelper *_modelLoader;
 108
 109 public:
 110
 111     // Constructor
 112     TileEntry( const SGBucket& b );
 113
 114     // Destructor
 115     ~TileEntry();
 116
 117     static void setModelLoadHelper(ModelLoadHelper *m) { _modelLoader=m; }
 118
 119     // Clean up the memory used by this tile and delete the arrays
 120     // used by ssg as well as the whole ssg branch.  This does a
 121     // partial clean up and exits so we can spread the load across
 122     // multiple frames.  Returns false if work remaining to be done,
 123     // true if dynamically allocated memory used by this tile is
 124     // completely freed.
 125     bool free_tile();
 126
 127     // Update the ssg transform node for this tile so it can be
 128     // properly drawn relative to our (0,0,0) point
 129     void prep_ssg_node(float vis);
 130
 131     /**
 132      * Transition to OSG database pager
 133      */
 134     static osg::Node* loadTileByName(const std::string& index_str,
 135                                      const osgDB::ReaderWriter::Options*);
 136     /**
 137      * Return true if the tile entry is loaded, otherwise return false
 138      * indicating that the loading thread is still working on this.
 139      */
 140     inline bool is_loaded() const
 141     {
 142         return _node->getNumChildren() > 0;
 143     }
 144
 145     /**
 146      * Return the "bucket" for this tile
 147      */
 148     inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
 149
 150     /**
 151      * Add terrain mesh and ground lighting to scene graph.
 152      */
 153     void addToSceneGraph( osg::Group *terrain_branch);
 154
 155     /**
 156      * disconnect terrain mesh and ground lighting nodes from scene
 157      * graph for this tile.
 158      */
 159     void removeFromSceneGraph();
 160
 161
 162     /**
 163      * return the scenegraph node for the terrain
 164      */
 165     osg::LOD *getNode() const { return _node.get(); }
 166
 167     double get_timestamp() const;
 168     void set_timestamp( double time_ms );
 169
 170     inline bool get_inner_ring() const { return is_inner_ring; }
 171     inline void set_inner_ring( bool val ) { is_inner_ring = val; }
 172 };
 173
 174 class ModelLoadHelper {
 175 public:
 176     virtual osg::Node *loadTileModel(const string& modelPath, bool cacheModel)=0;
 177
 178 };
 179
 180 }
 181
 182 #endif // _TILEENTRY_HXX