simgear/scene/tgdb/obj.cxx

   1 // obj.cxx -- routines to handle loading scenery and building the plib
   2 //            scene graph.
   3 //
   4 // Written by Curtis Olson, started October 1997.
   5 //
   6 // Copyright (C) 1997  Curtis L. Olson  - http://www.flightgear.org/~curt
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 //
  22 // $Id$
  23
  24
  25 #ifdef HAVE_CONFIG_H
  26 #  include <simgear_config.h>
  27 #endif
  28
  29 #include <simgear/compiler.h>
  30
  31 #include <list>
  32
  33 #include STL_STRING
  34
  35 #include <simgear/bucket/newbucket.hxx>
  36 #include <simgear/io/sg_binobj.hxx>
  37 #include <simgear/math/sg_geodesy.hxx>
  38 #include <simgear/math/sg_types.hxx>
  39 #include <simgear/misc/texcoord.hxx>
  40 #include <simgear/scene/material/mat.hxx>
  41 #include <simgear/scene/material/matlib.hxx>
  42 #include <simgear/scene/tgdb/leaf.hxx>
  43 #include <simgear/scene/tgdb/pt_lights.hxx>
  44 #include <simgear/scene/tgdb/userdata.hxx>
  45
  46 #include "obj.hxx"
  47
  48 SG_USING_STD(string);
  49 SG_USING_STD(list);
  50
  51 struct Leaf {
  52     GLenum type;
  53     int index;
  54 };
  55
  56
  57 // Generate an ocean tile
  58 bool sgGenTile( const string& path, SGBucket b,
  59                 Point3D *center, double *bounding_radius,
  60                 SGMaterialLib *matlib, ssgBranch* geometry )
  61 {
  62     ssgSimpleState *state = NULL;
  63
  64     geometry->setName( (char *)path.c_str() );
  65
  66     double tex_width = 1000.0;
  67     // double tex_height;
  68
  69     // find Ocean material in the properties list
  70     SGMaterial *mat = matlib->find( "Ocean" );
  71     if ( mat != NULL ) {
  72         // set the texture width and height values for this
  73         // material
  74         tex_width = mat->get_xsize();
  75         // tex_height = newmat->get_ysize();
  76
  77         // set ssgState
  78         state = mat->get_state();
  79     } else {
  80         SG_LOG( SG_TERRAIN, SG_ALERT,
  81                 "Ack! unknown usemtl name = " << "Ocean"
  82                 << " in " << path );
  83     }
  84
  85     // Calculate center point
  86     double clon = b.get_center_lon();
  87     double clat = b.get_center_lat();
  88     double height = b.get_height();
  89     double width = b.get_width();
  90
  91     *center = sgGeodToCart( Point3D(clon*SGD_DEGREES_TO_RADIANS,
  92                                     clat*SGD_DEGREES_TO_RADIANS,
  93                                     0.0) );
  94     // cout << "center = " << center << endl;;
  95
  96     // Caculate corner vertices
  97     Point3D geod[4];
  98     geod[0] = Point3D( clon - width/2.0, clat - height/2.0, 0.0 );
  99     geod[1] = Point3D( clon + width/2.0, clat - height/2.0, 0.0 );
 100     geod[2] = Point3D( clon + width/2.0, clat + height/2.0, 0.0 );
 101     geod[3] = Point3D( clon - width/2.0, clat + height/2.0, 0.0 );
 102
 103     Point3D rad[4];
 104     int i;
 105     for ( i = 0; i < 4; ++i ) {
 106         rad[i] = Point3D( geod[i].x() * SGD_DEGREES_TO_RADIANS,
 107                           geod[i].y() * SGD_DEGREES_TO_RADIANS,
 108                           geod[i].z() );
 109     }
 110
 111     Point3D cart[4], rel[4];
 112     for ( i = 0; i < 4; ++i ) {
 113         cart[i] = sgGeodToCart(rad[i]);
 114         rel[i] = cart[i] - *center;
 115         // cout << "corner " << i << " = " << cart[i] << endl;
 116     }
 117
 118     // Calculate bounding radius
 119     *bounding_radius = center->distance3D( cart[0] );
 120     // cout << "bounding radius = " << t->bounding_radius << endl;
 121
 122     // Calculate normals
 123     Point3D normals[4];
 124     for ( i = 0; i < 4; ++i ) {
 125         double length = cart[i].distance3D( Point3D(0.0) );
 126         normals[i] = cart[i] / length;
 127         // cout << "normal = " << normals[i] << endl;
 128     }
 129
 130     // Calculate texture coordinates
 131     point_list geod_nodes;
 132     geod_nodes.clear();
 133     geod_nodes.reserve(4);
 134     int_list rectangle;
 135     rectangle.clear();
 136     rectangle.reserve(4);
 137     for ( i = 0; i < 4; ++i ) {
 138         geod_nodes.push_back( geod[i] );
 139         rectangle.push_back( i );
 140     }
 141     point_list texs = sgCalcTexCoords( b, geod_nodes, rectangle,
 142                                        1000.0 / tex_width );
 143
 144     // Allocate ssg structure
 145     ssgVertexArray   *vl = new ssgVertexArray( 4 );
 146     ssgNormalArray   *nl = new ssgNormalArray( 4 );
 147     ssgTexCoordArray *tl = new ssgTexCoordArray( 4 );
 148     ssgColourArray   *cl = new ssgColourArray( 1 );
 149
 150     sgVec4 color;
 151     sgSetVec4( color, 1.0, 1.0, 1.0, 1.0 );
 152     cl->add( color );
 153
 154     // sgVec3 *vtlist = new sgVec3 [ 4 ];
 155     // t->vec3_ptrs.push_back( vtlist );
 156     // sgVec3 *vnlist = new sgVec3 [ 4 ];
 157     // t->vec3_ptrs.push_back( vnlist );
 158     // sgVec2 *tclist = new sgVec2 [ 4 ];
 159     // t->vec2_ptrs.push_back( tclist );
 160
 161     sgVec2 tmp2;
 162     sgVec3 tmp3;
 163     for ( i = 0; i < 4; ++i ) {
 164         sgSetVec3( tmp3,
 165                    rel[i].x(), rel[i].y(), rel[i].z() );
 166         vl->add( tmp3 );
 167
 168         sgSetVec3( tmp3,
 169                    normals[i].x(), normals[i].y(), normals[i].z() );
 170         nl->add( tmp3 );
 171
 172         sgSetVec2( tmp2, texs[i].x(), texs[i].y());
 173         tl->add( tmp2 );
 174     }
 175
 176     ssgLeaf *leaf =
 177         new ssgVtxTable ( GL_TRIANGLE_FAN, vl, nl, tl, cl );
 178
 179     leaf->setState( state );
 180     geometry->addKid( leaf );
 181
 182     return true;
 183 }
 184
 185
 186 /**
 187  * SSG callback for an in-range leaf of randomly-placed objects.
 188  *
 189  * This pretraversal callback is attached to a branch that is
 190  * traversed only when a leaf is in range.  If the leaf is not
 191  * currently prepared to be populated with randomly-placed objects,
 192  * this callback will prepare it (actual population is handled by
 193  * the tri_in_range_callback for individual triangles).
 194  *
 195  * @param entity The entity to which the callback is attached (not used).
 196  * @param mask The entity's traversal mask (not used).
 197  * @return Always 1, to allow traversal and culling to continue.
 198  */
 199 static int
 200 leaf_in_range_callback (ssgEntity * entity, int mask)
 201 {
 202   SGLeafUserData * data = (SGLeafUserData *)entity->getUserData();
 203
 204   if (!data->is_filled_in) {
 205                                 // Iterate through all the triangles
 206                                 // and populate them.
 207     int num_tris = data->leaf->getNumTriangles();
 208     for ( int i = 0; i < num_tris; ++i ) {
 209             data->setup_triangle(i);
 210     }
 211     data->is_filled_in = true;
 212   }
 213   return 1;
 214 }
 215
 216
 217 /**
 218  * SSG callback for an out-of-range leaf of randomly-placed objects.
 219  *
 220  * This pretraversal callback is attached to a branch that is
 221  * traversed only when a leaf is out of range.  If the leaf is
 222  * currently prepared to be populated with randomly-placed objects (or
 223  * is actually populated), the objects will be removed.
 224  *
 225  * @param entity The entity to which the callback is attached (not used).
 226  * @param mask The entity's traversal mask (not used).
 227  * @return Always 0, to prevent any further traversal or culling.
 228  */
 229 static int
 230 leaf_out_of_range_callback (ssgEntity * entity, int mask)
 231 {
 232   SGLeafUserData * data = (SGLeafUserData *)entity->getUserData();
 233   if (data->is_filled_in) {
 234     data->branch->removeAllKids();
 235     data->is_filled_in = false;
 236   }
 237   return 0;
 238 }
 239
 240
 241 /**
 242  * Randomly place objects on a surface.
 243  *
 244  * The leaf node provides the geometry of the surface, while the
 245  * material provides the objects and placement density.  Latitude
 246  * and longitude are required so that the objects can be rotated
 247  * to the world-up vector.  This function does not actually add
 248  * any objects; instead, it attaches an ssgRangeSelector to the
 249  * branch with callbacks to generate the objects when needed.
 250  *
 251  * @param leaf The surface where the objects should be placed.
 252  * @param branch The branch that will hold the randomly-placed objects.
 253  * @param center The center of the leaf in FlightGear coordinates.
 254  * @param material_name The name of the surface's material.
 255  */
 256 static void
 257 gen_random_surface_objects (ssgLeaf *leaf,
 258                             ssgBranch *branch,
 259                             Point3D *center,
 260                             SGMaterial *mat )
 261 {
 262                                 // If the surface has no triangles, return
 263                                 // now.
 264     int num_tris = leaf->getNumTriangles();
 265     if (num_tris < 1)
 266         return;
 267
 268                                 // If the material has no randomly-placed
 269                                 // objects, return now.
 270     if (mat->get_object_group_count() < 1)
 271         return;
 272
 273                                 // Calculate the geodetic centre of
 274                                 // the tile, for aligning automatic
 275                                 // objects.
 276     double xyz[3], lon_rad, lat_rad, alt_m;
 277     xyz[0] = center->x(); xyz[1] = center->y(); xyz[2] = center->z();
 278     sgCartToGeod(xyz, &lat_rad, &lon_rad, &alt_m);
 279
 280                                 // LOD for the leaf
 281                                 // max random object range: 20000m
 282     float ranges[] = { 0, 20000, 1000000 };
 283     ssgRangeSelector * lod = new ssgRangeSelector;
 284     lod->setRanges(ranges, 3);
 285     branch->addKid(lod);
 286
 287                                 // Create the in-range and out-of-range
 288                                 // branches.
 289     ssgBranch * in_range = new ssgBranch;
 290     ssgBranch * out_of_range = new ssgBranch;
 291     lod->addKid(in_range);
 292     lod->addKid(out_of_range);
 293
 294     SGLeafUserData * data = new SGLeafUserData;
 295     data->is_filled_in = false;
 296     data->leaf = leaf;
 297     data->mat = mat;
 298     data->branch = in_range;
 299     data->sin_lat = sin(lat_rad);
 300     data->cos_lat = cos(lat_rad);
 301     data->sin_lon = sin(lon_rad);
 302     data->cos_lon = cos(lon_rad);
 303
 304     in_range->setUserData(data);
 305     in_range->setTravCallback(SSG_CALLBACK_PRETRAV, leaf_in_range_callback);
 306     out_of_range->setUserData(data);
 307     out_of_range->setTravCallback(SSG_CALLBACK_PRETRAV,
 308                                    leaf_out_of_range_callback);
 309     out_of_range
 310       ->addKid(new SGDummyBSphereEntity(leaf->getBSphere()->getRadius()));
 311 }
 312
 313
 314 \f
 315 ////////////////////////////////////////////////////////////////////////
 316 // Scenery loaders.
 317 ////////////////////////////////////////////////////////////////////////
 318
 319 // Load an Binary obj file
 320 bool sgBinObjLoad( const string& path, const bool is_base,
 321                    Point3D *center,
 322                    double *bounding_radius,
 323                    SGMaterialLib *matlib,
 324                    bool use_random_objects,
 325                    ssgBranch *geometry,
 326                    ssgBranch *vasi_lights,
 327                    ssgBranch *rwy_lights,
 328                    ssgBranch *taxi_lights,
 329                    ssgVertexArray *ground_lights )
 330 {
 331     SGBinObject obj;
 332
 333     if ( ! obj.read_bin( path ) ) {
 334         return false;
 335     }
 336
 337     ssgBranch *local_terrain = new ssgBranch;
 338     local_terrain->setName( "LocalTerrain" );
 339     geometry->addKid( local_terrain );
 340
 341     geometry->setName( (char *)path.c_str() );
 342
 343     // reference point (center offset/bounding sphere)
 344     *center = obj.get_gbs_center();
 345     *bounding_radius = obj.get_gbs_radius();
 346
 347     point_list const& nodes = obj.get_wgs84_nodes();
 348     // point_list const& colors = obj.get_colors();
 349     point_list const& normals = obj.get_normals();
 350     point_list const& texcoords = obj.get_texcoords();
 351
 352     string material;
 353     int_list tex_index;
 354
 355     group_list::size_type i;
 356
 357     // generate points
 358     string_list const& pt_materials = obj.get_pt_materials();
 359     group_list const& pts_v = obj.get_pts_v();
 360     group_list const& pts_n = obj.get_pts_n();
 361     for ( i = 0; i < pts_v.size(); ++i ) {
 362         // cout << "pts_v.size() = " << pts_v.size() << endl;
 363         if ( pt_materials[i].substr(0, 3) == "RWY" ) {
 364             // airport environment lighting
 365             sgdVec3 up;
 366             sgdSetVec3( up, center->x(), center->y(), center->z() );
 367             // returns a transform -> lod -> leaf structure
 368             ssgBranch *branch = sgMakeDirectionalLights( nodes, normals,
 369                                                          pts_v[i], pts_n[i],
 370                                                          matlib,
 371                                                          pt_materials[i], up );
 372             if ( pt_materials[i] == "RWY_VASI_LIGHTS" ) {
 373                 vasi_lights->addKid( branch );
 374             } else if ( pt_materials[i] == "RWY_BLUE_TAXIWAY_LIGHTS"
 375                 || pt_materials[i] == "RWY_GREEN_TAXIWAY_LIGHTS" )
 376             {
 377                 taxi_lights->addKid( branch );
 378             } else {
 379                 rwy_lights->addKid( branch );
 380             }
 381         } else {
 382             // other geometry
 383             material = pt_materials[i];
 384             tex_index.clear();
 385             ssgLeaf *leaf = sgMakeLeaf( path, GL_POINTS, matlib, material,
 386                                         nodes, normals, texcoords,
 387                                         pts_v[i], pts_n[i], tex_index,
 388                                         false, ground_lights );
 389             local_terrain->addKid( leaf );
 390         }
 391     }
 392
 393     // Put all randomly-placed objects under a separate branch
 394     // (actually an ssgRangeSelector) named "random-models".
 395     ssgBranch * random_object_branch = 0;
 396     if (use_random_objects) {
 397         float ranges[] = { 0, 20000 }; // Maximum 20km range for random objects
 398         ssgRangeSelector * object_lod = new ssgRangeSelector;
 399         object_lod->setRanges(ranges, 2);
 400         object_lod->setName("random-models");
 401         geometry->addKid(object_lod);
 402         random_object_branch = new ssgBranch;
 403         object_lod->addKid(random_object_branch);
 404     }
 405
 406     typedef map<string,list<Leaf> > LeafMap;
 407     LeafMap leafMap;
 408     Leaf leaf;
 409     leaf.type = GL_TRIANGLES;
 410     string_list const& tri_materials = obj.get_tri_materials();
 411     group_list const& tris_v = obj.get_tris_v();
 412     group_list const& tris_n = obj.get_tris_n();
 413     group_list const& tris_tc = obj.get_tris_tc();
 414     for ( i = 0; i < tris_v.size(); i++ ) {
 415         leaf.index = i;
 416         leafMap[ tri_materials[i] ].push_back( leaf );
 417     }
 418     leaf.type = GL_TRIANGLE_STRIP;
 419     string_list const& strip_materials = obj.get_strip_materials();
 420     group_list const& strips_v = obj.get_strips_v();
 421     group_list const& strips_n = obj.get_strips_n();
 422     group_list const& strips_tc = obj.get_strips_tc();
 423     for ( i = 0; i < strips_v.size(); i++ ) {
 424         leaf.index = i;
 425         leafMap[ strip_materials[i] ].push_back( leaf );
 426     }
 427     leaf.type = GL_TRIANGLE_FAN;
 428     string_list const& fan_materials = obj.get_fan_materials();
 429     group_list const& fans_v = obj.get_fans_v();
 430     group_list const& fans_n = obj.get_fans_n();
 431     group_list const& fans_tc = obj.get_fans_tc();
 432     for ( i = 0; i < fans_v.size(); i++ ) {
 433         leaf.index = i;
 434         leafMap[ fan_materials[i] ].push_back( leaf );
 435     }
 436
 437     LeafMap::iterator lmi = leafMap.begin();
 438     while ( lmi != leafMap.end() ) {
 439         list<Leaf> &leaf_list = lmi->second;
 440         list<Leaf>::iterator li = leaf_list.begin();
 441         while ( li != leaf_list.end() ) {
 442             Leaf &leaf = *li;
 443             int ind = leaf.index;
 444             if ( leaf.type == GL_TRIANGLES ) {
 445                 ssgLeaf *leaf = sgMakeLeaf( path, GL_TRIANGLES, matlib,
 446                                             tri_materials[ind],
 447                                             nodes, normals, texcoords,
 448                                             tris_v[ind], tris_n[ind], tris_tc[ind],
 449                                             is_base, ground_lights );
 450                 if ( use_random_objects ) {
 451                     SGMaterial *mat = matlib->find( tri_materials[ind] );
 452                     if ( mat == NULL ) {
 453                         SG_LOG( SG_INPUT, SG_ALERT,
 454                                 "Unknown material for random surface objects = "
 455                                 << tri_materials[ind] );
 456                     } else {
 457                         gen_random_surface_objects( leaf, random_object_branch,
 458                                                     center, mat );
 459                     }
 460                 }
 461                 local_terrain->addKid( leaf );
 462             } else if ( leaf.type == GL_TRIANGLE_STRIP ) {
 463                 ssgLeaf *leaf = sgMakeLeaf( path, GL_TRIANGLE_STRIP,
 464                                             matlib, strip_materials[ind],
 465                                             nodes, normals, texcoords,
 466                                             strips_v[ind], strips_n[ind], strips_tc[ind],
 467                                             is_base, ground_lights );
 468                 if ( use_random_objects ) {
 469                     SGMaterial *mat = matlib->find( strip_materials[ind] );
 470                     if ( mat == NULL ) {
 471                         SG_LOG( SG_INPUT, SG_ALERT,
 472                                 "Unknown material for random surface objects = "
 473                                 << strip_materials[ind] );
 474                     } else {
 475                         gen_random_surface_objects( leaf, random_object_branch,
 476                                                     center, mat );
 477                     }
 478                 }
 479                 local_terrain->addKid( leaf );
 480             } else {
 481                 ssgLeaf *leaf = sgMakeLeaf( path, GL_TRIANGLE_FAN,
 482                                             matlib, fan_materials[ind],
 483                                             nodes, normals, texcoords,
 484                                             fans_v[ind], fans_n[ind], fans_tc[ind],
 485                                             is_base, ground_lights );
 486                 if ( use_random_objects ) {
 487                     SGMaterial *mat = matlib->find( fan_materials[ind] );
 488                     if ( mat == NULL ) {
 489                         SG_LOG( SG_INPUT, SG_ALERT,
 490                                 "Unknown material for random surface objects = "
 491                                 << fan_materials[ind] );
 492                     } else {
 493                         gen_random_surface_objects( leaf, random_object_branch,
 494                                                     center, mat );
 495                     }
 496                 }
 497                 local_terrain->addKid( leaf );
 498             }
 499             ++li;
 500         }
 501         ++lmi;
 502     }
 503
 504     return true;
 505 }