src/Scenery/tileentry.cxx

   1 // tileentry.cxx -- routines to handle a 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 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include <simgear/compiler.h>
  29 #include <plib/ul.h>
  30 #include <Main/main.hxx>
  31
  32
  33 #include STL_STRING
  34
  35 #include <osg/Array>
  36 #include <osg/Geometry>
  37 #include <osg/Geode>
  38 #include <osg/LOD>
  39 #include <osg/MatrixTransform>
  40 #include <osg/NodeCallback>
  41 #include <osg/Switch>
  42
  43 #include <simgear/bucket/newbucket.hxx>
  44 #include <simgear/debug/logstream.hxx>
  45 #include <simgear/math/polar3d.hxx>
  46 #include <simgear/math/sg_geodesy.hxx>
  47 #include <simgear/math/sg_random.h>
  48 #include <simgear/misc/sgstream.hxx>
  49 #include <simgear/scene/material/mat.hxx>
  50 #include <simgear/scene/material/matlib.hxx>
  51 #include <simgear/scene/tgdb/apt_signs.hxx>
  52 #include <simgear/scene/tgdb/obj.hxx>
  53 #include <simgear/scene/model/placementtrans.hxx>
  54 #include <simgear/scene/util/SGUpdateVisitor.hxx>
  55
  56 #include <Aircraft/aircraft.hxx>
  57 #include <Include/general.hxx>
  58 #include <Main/fg_props.hxx>
  59 #include <Main/globals.hxx>
  60 #include <Main/viewer.hxx>
  61 #include <Scenery/scenery.hxx>
  62 #include <Time/light.hxx>
  63
  64 #include "tileentry.hxx"
  65 #include "tilemgr.hxx"
  66
  67 SG_USING_STD(string);
  68
  69 class FGTileUpdateCallback : public osg::NodeCallback {
  70 public:
  71   virtual void operator()(osg::Node* node, osg::NodeVisitor* nv)
  72   {
  73     assert(dynamic_cast<SGUpdateVisitor*>(nv));
  74     SGUpdateVisitor* updateVisitor = static_cast<SGUpdateVisitor*>(nv);
  75
  76     osg::Vec3 center = node->getBound().center();
  77     double dist2 = distSqr(updateVisitor->getGlobalEyePos(),
  78                            SGVec3d(center[0], center[1], center[2]));
  79     if (updateVisitor->getSqrVisibility() < dist2)
  80       return;
  81
  82     traverse(node, nv);
  83   }
  84 };
  85
  86 // Constructor
  87 FGTileEntry::FGTileEntry ( const SGBucket& b )
  88     : tile_bucket( b ),
  89       terra_transform( new osg::Group ),
  90       terra_range( new osg::LOD ),
  91       loaded(false),
  92       pending_models(0),
  93       is_inner_ring(false),
  94       free_tracker(0)
  95 {
  96     terra_transform->setUpdateCallback(new FGTileUpdateCallback);
  97 }
  98
  99
 100 // Destructor
 101 FGTileEntry::~FGTileEntry () {
 102 }
 103
 104 static void WorldCoordinate( osg::Matrix& obj_pos, double lat,
 105                              double lon, double elev, double hdg )
 106 {
 107     double lon_rad = lon * SGD_DEGREES_TO_RADIANS;
 108     double lat_rad = lat * SGD_DEGREES_TO_RADIANS;
 109     double hdg_rad = hdg * SGD_DEGREES_TO_RADIANS;
 110
 111     // setup transforms
 112     Point3D geod( lon_rad, lat_rad, elev );
 113
 114     Point3D world_pos = sgGeodToCart( geod );
 115     Point3D offset = world_pos;
 116
 117     sgdMat4 mat;
 118
 119     double sin_lat = sin( lat_rad );
 120     double cos_lat = cos( lat_rad );
 121     double cos_lon = cos( lon_rad );
 122     double sin_lon = sin( lon_rad );
 123     double sin_hdg = sin( hdg_rad ) ;
 124     double cos_hdg = cos( hdg_rad ) ;
 125
 126     mat[0][0] =  cos_hdg * sin_lat * cos_lon - sin_hdg * sin_lon;
 127     mat[0][1] =  cos_hdg * sin_lat * sin_lon + sin_hdg * cos_lon;
 128     mat[0][2] = -cos_hdg * cos_lat;
 129     mat[0][3] =  SG_ZERO;
 130
 131     mat[1][0] = -sin_hdg * sin_lat * cos_lon - cos_hdg * sin_lon;
 132     mat[1][1] = -sin_hdg * sin_lat * sin_lon + cos_hdg * cos_lon;
 133     mat[1][2] =  sin_hdg * cos_lat;
 134     mat[1][3] =  SG_ZERO;
 135
 136     mat[2][0] = cos_lat * cos_lon;
 137     mat[2][1] = cos_lat * sin_lon;
 138     mat[2][2] = sin_lat;
 139     mat[2][3] =  SG_ZERO;
 140
 141     mat[3][0] = offset.x();
 142     mat[3][1] = offset.y();
 143     mat[3][2] = offset.z();
 144     mat[3][3] = SG_ONE ;
 145
 146     for (unsigned i = 0; i < 4; ++i)
 147       for (unsigned j = 0; j < 4; ++j)
 148         obj_pos(i, j) = mat[i][j];
 149 }
 150
 151
 152 // Free "n" leaf elements of an ssg tree.  returns the number of
 153 // elements freed.  An empty branch node is considered a leaf.  This
 154 // is intended to spread the load of freeing a complex tile out over
 155 // several frames.
 156 static int fgPartialFreeSSGtree( osg::Group *b, int n ) {
 157     int num_deletes = b->getNumChildren();
 158
 159     b->removeChildren(0, b->getNumChildren());
 160
 161     return num_deletes;
 162 }
 163
 164
 165 // Clean up the memory used by this tile and delete the arrays used by
 166 // ssg as well as the whole ssg branch
 167 bool FGTileEntry::free_tile() {
 168     int delete_size = 100;
 169     SG_LOG( SG_TERRAIN, SG_DEBUG,
 170             "FREEING TILE = (" << tile_bucket << ")" );
 171
 172     SG_LOG( SG_TERRAIN, SG_DEBUG, "(start) free_tracker = " << free_tracker );
 173
 174     if ( !(free_tracker & NODES) ) {
 175         free_tracker |= NODES;
 176     } else if ( !(free_tracker & VEC_PTRS) ) {
 177         free_tracker |= VEC_PTRS;
 178     } else if ( !(free_tracker & TERRA_NODE) ) {
 179         // delete the terrain branch (this should already have been
 180         // disconnected from the scene graph)
 181         SG_LOG( SG_TERRAIN, SG_DEBUG, "FREEING terra_transform" );
 182         if ( fgPartialFreeSSGtree( terra_transform.get(), delete_size ) == 0 ) {
 183             terra_transform = 0;
 184             free_tracker |= TERRA_NODE;
 185         }
 186     } else if ( !(free_tracker & LIGHTMAPS) ) {
 187         free_tracker |= LIGHTMAPS;
 188     } else {
 189         return true;
 190     }
 191
 192     SG_LOG( SG_TERRAIN, SG_DEBUG, "(end) free_tracker = " << free_tracker );
 193
 194     // if we fall down to here, we still have work todo, return false
 195     return false;
 196 }
 197
 198
 199 // Update the ssg transform node for this tile so it can be
 200 // properly drawn relative to our (0,0,0) point
 201 void FGTileEntry::prep_ssg_node(float vis) {
 202     if ( !loaded ) return;
 203
 204     // visibility can change from frame to frame so we update the
 205     // range selector cutoff's each time.
 206     float bounding_radius = terra_range->getChild(0)->getBound().radius();
 207     terra_range->setRange( 0, 0, vis + bounding_radius );
 208 }
 209
 210 bool FGTileEntry::obj_load( const string& path,
 211                             osg::Group *geometry, bool is_base )
 212 {
 213     bool use_random_objects =
 214         fgGetBool("/sim/rendering/random-objects", true);
 215
 216     // try loading binary format
 217     osg::Node* node = SGLoadBTG(path, globals->get_matlib(), is_base, use_random_objects);
 218     if (node)
 219       geometry->addChild(node);
 220
 221     return node;
 222 }
 223
 224
 225 typedef enum {
 226     OBJECT,
 227     OBJECT_SHARED,
 228     OBJECT_STATIC,
 229     OBJECT_SIGN,
 230     OBJECT_RUNWAY_SIGN
 231 } object_type;
 232
 233
 234 // storage class for deferred object processing in FGTileEntry::load()
 235 struct Object {
 236     Object(object_type t, const string& token, const SGPath& p, istream& in)
 237         : type(t), path(p)
 238     {
 239         in >> name;
 240         if (type != OBJECT)
 241             in >> lon >> lat >> elev >> hdg;
 242         in >> ::skipeol;
 243
 244         if (type == OBJECT)
 245             SG_LOG(SG_TERRAIN, SG_INFO, "    " << token << "  " << name);
 246         else
 247             SG_LOG(SG_TERRAIN, SG_INFO, "    " << token << "  " << name << "  lon=" <<
 248                     lon << "  lat=" << lat << "  elev=" << elev << "  hdg=" << hdg);
 249     }
 250     object_type type;
 251     string name;
 252     SGPath path;
 253     double lon, lat, elev, hdg;
 254 };
 255
 256
 257 void
 258 FGTileEntry::load( const string_list &path_list, bool is_base )
 259 {
 260     bool found_tile_base = false;
 261
 262     SGPath object_base;
 263     vector<const Object*> objects;
 264
 265     string index_str = tile_bucket.gen_index_str();
 266     SG_LOG( SG_TERRAIN, SG_INFO, "Loading tile " << index_str );
 267
 268     // scan and parse all files and store information
 269     for (unsigned int i = 0; i < path_list.size(); i++) {
 270         // If we found a terrain tile in Terrain/, we have to process the
 271         // Objects/ dir in the same group, too, before we can stop scanning.
 272         // FGGlobals::set_fg_scenery() inserts an empty string to path_list
 273         // as marker.
 274         if (path_list[i].empty()) {
 275             if (found_tile_base)
 276                 break;
 277             else
 278                 continue;
 279         }
 280
 281         bool has_base = false;
 282
 283         SGPath tile_path = path_list[i];
 284         tile_path.append( tile_bucket.gen_base_path() );
 285
 286         SGPath basename = tile_path;
 287         basename.append( index_str );
 288
 289         SG_LOG( SG_TERRAIN, SG_INFO, "  Trying " << basename.str() );
 290
 291
 292         // Check for master .stg (scene terra gear) file
 293         SGPath stg_name = basename;
 294         stg_name.concat( ".stg" );
 295
 296         sg_gzifstream in( stg_name.str() );
 297         if ( !in.is_open() )
 298             continue;
 299
 300         while ( ! in.eof() ) {
 301             string token;
 302             in >> token;
 303
 304             if ( token[0] == '#' ) {
 305                in >> ::skipeol;
 306                continue;
 307             }
 308                             // Load only once (first found)
 309             if ( token == "OBJECT_BASE" ) {
 310                 string name;
 311                 in >> name >> ::skipws;
 312                 SG_LOG( SG_TERRAIN, SG_INFO, "    " << token << " " << name );
 313
 314                 if (!found_tile_base) {
 315                     found_tile_base = true;
 316                     has_base = true;
 317
 318                     object_base = tile_path;
 319                     object_base.append(name);
 320
 321                 } else
 322                     SG_LOG(SG_TERRAIN, SG_INFO, "    (skipped)");
 323
 324                             // Load only if base is not in another file
 325             } else if ( token == "OBJECT" ) {
 326                 if (!found_tile_base || has_base)
 327                     objects.push_back(new Object(OBJECT, token, tile_path, in));
 328                 else {
 329                     string name;
 330                     in >> name >> ::skipeol;
 331                     SG_LOG(SG_TERRAIN, SG_INFO, "    " << token << "  "
 332                             << name << "  (skipped)");
 333                 }
 334
 335                             // Always OK to load
 336             } else if ( token == "OBJECT_STATIC" ) {
 337                 objects.push_back(new Object(OBJECT_STATIC, token, tile_path, in));
 338
 339             } else if ( token == "OBJECT_SHARED" ) {
 340                 objects.push_back(new Object(OBJECT_SHARED, token, tile_path, in));
 341
 342             } else if ( token == "OBJECT_SIGN" ) {
 343                 objects.push_back(new Object(OBJECT_SIGN, token, tile_path, in));
 344
 345             } else if ( token == "OBJECT_RUNWAY_SIGN" ) {
 346                 objects.push_back(new Object(OBJECT_RUNWAY_SIGN, token, tile_path, in));
 347
 348             } else {
 349                 SG_LOG( SG_TERRAIN, SG_DEBUG,
 350                         "Unknown token '" << token << "' in " << stg_name.str() );
 351                 in >> ::skipws;
 352             }
 353         }
 354     }
 355
 356
 357     // obj_load() will generate ground lighting for us ...
 358     osg::Group* new_tile = new osg::Group;
 359
 360     if (found_tile_base) {
 361         // load tile if found ...
 362         obj_load( object_base.str(), new_tile, true );
 363
 364     } else {
 365         // ... or generate an ocean tile on the fly
 366         SG_LOG(SG_TERRAIN, SG_INFO, "  Generating ocean tile");
 367         if ( !SGGenTile( path_list[0], tile_bucket,
 368                         globals->get_matlib(), new_tile ) ) {
 369             SG_LOG( SG_TERRAIN, SG_ALERT,
 370                     "Warning: failed to generate ocean tile!" );
 371         }
 372     }
 373
 374
 375     // now that we have a valid center, process all the objects
 376     for (unsigned int j = 0; j < objects.size(); j++) {
 377         const Object *obj = objects[j];
 378
 379         if (obj->type == OBJECT) {
 380             SGPath custom_path = obj->path;
 381             custom_path.append( obj->name );
 382             obj_load( custom_path.str(), new_tile, false );
 383
 384         } else if (obj->type == OBJECT_SHARED || obj->type == OBJECT_STATIC) {
 385             // object loading is deferred to main render thread,
 386             // but lets figure out the paths right now.
 387             SGPath custom_path;
 388             if ( obj->type == OBJECT_STATIC ) {
 389                 custom_path = obj->path;
 390             } else {
 391                 custom_path = globals->get_fg_root();
 392             }
 393             custom_path.append( obj->name );
 394
 395             osg::Matrix obj_pos;
 396             WorldCoordinate( obj_pos, obj->lat, obj->lon, obj->elev, obj->hdg );
 397
 398             osg::MatrixTransform *obj_trans = new osg::MatrixTransform;
 399             obj_trans->setMatrix( obj_pos );
 400
 401             // wire as much of the scene graph together as we can
 402             new_tile->addChild( obj_trans );
 403             pending_models++;
 404
 405             // push an entry onto the model load queue
 406             FGDeferredModel *dm
 407                 = new FGDeferredModel( custom_path.str(),
 408                                        obj->path.str(),
 409                                        tile_bucket,
 410                                        this, obj_trans,
 411                                        obj->type == OBJECT_SHARED );
 412             FGTileMgr::model_ready( dm );
 413
 414
 415         } else if (obj->type == OBJECT_SIGN || obj->type == OBJECT_RUNWAY_SIGN) {
 416             // load the object itself
 417             SGPath custom_path = obj->path;
 418             custom_path.append( obj->name );
 419
 420             osg::Matrix obj_pos;
 421             WorldCoordinate( obj_pos, obj->lat, obj->lon, obj->elev, obj->hdg );
 422
 423             osg::MatrixTransform *obj_trans = new osg::MatrixTransform;
 424             obj_trans->setMatrix( obj_pos );
 425
 426             osg::Node *custom_obj = 0;
 427             if (obj->type == OBJECT_SIGN)
 428                 custom_obj = SGMakeSign(globals->get_matlib(), custom_path.str(), obj->name);
 429             else
 430                 custom_obj = SGMakeRunwaySign(globals->get_matlib(), custom_path.str(), obj->name);
 431
 432             // wire the pieces together
 433             if ( custom_obj != NULL ) {
 434                 obj_trans -> addChild( custom_obj );
 435             }
 436             new_tile->addChild( obj_trans );
 437
 438         }
 439         delete obj;
 440     }
 441
 442     terra_range->addChild( new_tile );
 443     terra_transform->addChild( terra_range.get() );
 444 }
 445
 446 void
 447 FGTileEntry::add_ssg_nodes( osg::Group *terrain_branch )
 448 {
 449     // bump up the ref count so we can remove this later without
 450     // having ssg try to free the memory.
 451     terrain_branch->addChild( terra_transform.get() );
 452
 453     SG_LOG( SG_TERRAIN, SG_DEBUG,
 454             "connected a tile into scene graph.  terra_transform = "
 455             << terra_transform.get() );
 456     SG_LOG( SG_TERRAIN, SG_DEBUG, "num parents now = "
 457             << terra_transform->getNumParents() );
 458
 459     loaded = true;
 460 }
 461
 462
 463 void
 464 FGTileEntry::disconnect_ssg_nodes()
 465 {
 466     SG_LOG( SG_TERRAIN, SG_DEBUG, "disconnecting ssg nodes" );
 467
 468     if ( ! loaded ) {
 469         SG_LOG( SG_TERRAIN, SG_DEBUG, "removing a not-fully loaded tile!" );
 470     } else {
 471         SG_LOG( SG_TERRAIN, SG_DEBUG, "removing a fully loaded tile!  terra_transform = " << terra_transform.get() );
 472     }
 473
 474     // find the terrain branch parent
 475     int pcount = terra_transform->getNumParents();
 476     if ( pcount > 0 ) {
 477         // find the first parent (should only be one)
 478         osg::Group *parent = terra_transform->getParent( 0 ) ;
 479         if( parent ) {
 480             // disconnect the tile (we previously ref()'d it so it
 481             // won't get freed now)
 482             parent->removeChild( terra_transform.get() );
 483         } else {
 484             SG_LOG( SG_TERRAIN, SG_ALERT,
 485                     "parent pointer is NULL!  Dying" );
 486             exit(-1);
 487         }
 488     } else {
 489         SG_LOG( SG_TERRAIN, SG_ALERT,
 490                 "Parent count is zero for an ssg tile!  Dying" );
 491         exit(-1);
 492     }
 493 }