src/Model/model.cxx

   1 // model.cxx - manage a 3D aircraft model.
   2 // Written by David Megginson, started 2002.
   3 //
   4 // This file is in the Public Domain, and comes with no warranty.
   5
   6 #ifdef HAVE_CONFIG_H
   7 #  include <config.h>
   8 #endif
   9
  10 #include <string.h>             // for strcmp()
  11
  12 #include <plib/sg.h>
  13 #include <plib/ssg.h>
  14
  15 #include <simgear/compiler.h>
  16 #include <simgear/debug/logstream.hxx>
  17 #include <simgear/math/point3d.hxx>
  18 #include <simgear/math/sg_geodesy.hxx>
  19 #include <simgear/misc/exception.hxx>
  20 #include <simgear/misc/sg_path.hxx>
  21
  22 #include <Main/globals.hxx>
  23 #include <Main/location.hxx>
  24 #include <Scenery/scenery.hxx>
  25
  26 #include "model.hxx"
  27
  28
  29 \f
  30 ////////////////////////////////////////////////////////////////////////
  31 // Static utility functions.
  32 ////////////////////////////////////////////////////////////////////////
  33
  34 /**
  35  * Locate a named SSG node in a branch.
  36  */
  37 static ssgEntity *
  38 find_named_node (ssgEntity * node, const char * name)
  39 {
  40   char * node_name = node->getName();
  41   if (node_name != 0 && !strcmp(name, node_name))
  42     return node;
  43   else if (node->isAKindOf(ssgTypeBranch())) {
  44     int nKids = node->getNumKids();
  45     for (int i = 0; i < nKids; i++) {
  46       ssgEntity * result =
  47         find_named_node(((ssgBranch*)node)->getKid(i), name);
  48       if (result != 0)
  49         return result;
  50     }
  51   }
  52   return 0;
  53 }
  54
  55 /**
  56  * Splice a branch in between all child nodes and their parents.
  57  */
  58 static void
  59 splice_branch (ssgBranch * branch, ssgEntity * child)
  60 {
  61   int nParents = child->getNumParents();
  62   branch->addKid(child);
  63   for (int i = 0; i < nParents; i++) {
  64     ssgBranch * parent = child->getParent(i);
  65     parent->replaceKid(child, branch);
  66   }
  67 }
  68
  69 /**
  70  * Set up the transform matrix for a spin or rotation.
  71  */
  72 static void
  73 set_rotation (sgMat4 &matrix, double position_deg,
  74               sgVec3 &center, sgVec3 &axis)
  75 {
  76  float temp_angle = -position_deg * SG_DEGREES_TO_RADIANS ;
  77
  78  float s = (float) sin ( temp_angle ) ;
  79  float c = (float) cos ( temp_angle ) ;
  80  float t = SG_ONE - c ;
  81
  82  // axis was normalized at load time
  83  // hint to the compiler to put these into FP registers
  84  float x = axis[0];
  85  float y = axis[1];
  86  float z = axis[2];
  87
  88  matrix[0][0] = t * x * x + c ;
  89  matrix[0][1] = t * y * x - s * z ;
  90  matrix[0][2] = t * z * x + s * y ;
  91  matrix[0][3] = SG_ZERO;
  92
  93  matrix[1][0] = t * x * y + s * z ;
  94  matrix[1][1] = t * y * y + c ;
  95  matrix[1][2] = t * z * y - s * x ;
  96  matrix[1][3] = SG_ZERO;
  97
  98  matrix[2][0] = t * x * z - s * y ;
  99  matrix[2][1] = t * y * z + s * x ;
 100  matrix[2][2] = t * z * z + c ;
 101  matrix[2][3] = SG_ZERO;
 102
 103   // hint to the compiler to put these into FP registers
 104  x = center[0];
 105  y = center[1];
 106  z = center[2];
 107
 108  matrix[3][0] = x - x*matrix[0][0] - y*matrix[1][0] - z*matrix[2][0];
 109  matrix[3][1] = y - x*matrix[0][1] - y*matrix[1][1] - z*matrix[2][1];
 110  matrix[3][2] = z - x*matrix[0][2] - y*matrix[1][2] - z*matrix[2][2];
 111  matrix[3][3] = SG_ONE;
 112 }
 113
 114 /**
 115  * Set up the transform matrix for a translation.
 116  */
 117 static void
 118 set_translation (sgMat4 &matrix, double position_m, sgVec3 &axis)
 119 {
 120   sgVec3 xyz;
 121   sgScaleVec3(xyz, axis, position_m);
 122   sgMakeTransMat4(matrix, xyz);
 123 }
 124
 125
 126 \f
 127 ////////////////////////////////////////////////////////////////////////
 128 // Implementation of FG3DModel
 129 ////////////////////////////////////////////////////////////////////////
 130
 131 FG3DModel::FG3DModel ()
 132   : _model(0),
 133     _selector(new ssgSelector),
 134     _position(new ssgTransform)
 135 {
 136 }
 137
 138 FG3DModel::~FG3DModel ()
 139 {
 140   // since the nodes are attached to the scene graph, they'll be
 141   // deleted automatically
 142
 143   for (int i = 0; i < _animations.size(); i++) {
 144     Animation * tmp = _animations[i];
 145     _animations[i] = 0;
 146     delete tmp;
 147   }
 148
 149 }
 150
 151 void
 152 FG3DModel::init (const string &path)
 153 {
 154   SGPropertyNode props;
 155
 156                                 // Load the 3D aircraft object itself
 157   SGPath xmlpath = globals->get_fg_root();
 158   SGPath modelpath = path;
 159   xmlpath.append(modelpath.str());
 160
 161                                 // Check for an XML wrapper
 162   if (xmlpath.str().substr(xmlpath.str().size() - 4, 4) == ".xml") {
 163     readProperties(xmlpath.str(), &props);
 164     if (props.hasValue("/path")) {
 165       modelpath = modelpath.dir();
 166       modelpath.append(props.getStringValue("/path"));
 167     } else {
 168       throw sg_exception("No path for model");
 169     }
 170   }
 171
 172                                 // Assume that textures are in
 173                                 // the same location as the XML file.
 174   ssgTexturePath((char *)xmlpath.dir().c_str());
 175   _model = ssgLoad((char *)modelpath.c_str());
 176   if (_model == 0)
 177     throw sg_exception("Failed to load 3D model");
 178
 179                                 // Load animations
 180   vector<SGPropertyNode *> animation_nodes = props.getChildren("animation");
 181   for (unsigned int i = 0; i < animation_nodes.size(); i++) {
 182     vector<SGPropertyNode *> name_nodes =
 183       animation_nodes[i]->getChildren("object-name");
 184     if (name_nodes.size() < 1) {
 185       SG_LOG(SG_INPUT, SG_ALERT, "No object-name given for transformation");
 186     } else {
 187       for (unsigned int j = 0; j < name_nodes.size(); j++) {
 188         Animation * animation =
 189           make_animation(name_nodes[j]->getStringValue(), animation_nodes[i]);
 190         if (animation != 0)
 191           _animations.push_back(animation);
 192       }
 193     }
 194   }
 195
 196                                 // Set up the range selector node
 197   float ranges[2];
 198   ssgRangeSelector * lod = new ssgRangeSelector;
 199   lod->addKid(_model);
 200   ranges[0] = props.getFloatValue("range/min-m", 0);
 201   ranges[1] = props.getFloatValue("range/max-m", 5000);
 202   lod->setRanges(ranges, 2);
 203
 204
 205                                 // Set up the alignment node
 206   ssgTransform * align = new ssgTransform;
 207   align->addKid(lod);
 208   sgMat4 rot_matrix;
 209   sgMat4 off_matrix;
 210   sgMat4 res_matrix;
 211   float h_rot = props.getFloatValue("/offsets/heading-deg", 0.0);
 212   float p_rot = props.getFloatValue("/offsets/roll-deg", 0.0);
 213   float r_rot = props.getFloatValue("/offsets/pitch-deg", 0.0);
 214   float x_off = props.getFloatValue("/offsets/x-m", 0.0);
 215   float y_off = props.getFloatValue("/offsets/y-m", 0.0);
 216   float z_off = props.getFloatValue("/offsets/z-m", 0.0);
 217   sgMakeRotMat4(rot_matrix, h_rot, p_rot, r_rot);
 218   sgMakeTransMat4(off_matrix, x_off, y_off, z_off);
 219   sgMultMat4(res_matrix, off_matrix, rot_matrix);
 220   align->setTransform(res_matrix);
 221
 222                                 // Set up the position node
 223   _position->addKid(align);
 224
 225                                 // Set up the selector node
 226   _selector->addKid(_position);
 227   _selector->clrTraversalMaskBits(SSGTRAV_HOT);
 228
 229                                 // Set up a location class
 230   _location = (FGLocation *) new FGLocation;
 231
 232 }
 233
 234 void
 235 FG3DModel::update (int dt)
 236 {
 237   for (unsigned int i = 0; i < _animations.size(); i++)
 238     _animations[i]->update(dt);
 239
 240   sgCoord obj_pos;
 241
 242   sgMat4 POS, TRANS;
 243
 244   _location->setPosition( _lon_deg, _lat_deg, _elev_ft );
 245   _location->setOrientation( _roll_deg, _pitch_deg, _heading_deg );
 246   sgCopyMat4(TRANS, _location->getTransformMatrix());
 247   sgMakeTransMat4( POS, _location->get_view_pos() );
 248
 249   sgPostMultMat4( TRANS, POS );
 250
 251   sgSetCoord( &obj_pos, TRANS );
 252
 253   _position->setTransform(&obj_pos);
 254 }
 255
 256 bool
 257 FG3DModel::getVisible () const
 258 {
 259   return _selector->getSelect();
 260 }
 261
 262 void
 263 FG3DModel::setVisible (bool visible)
 264 {
 265   _selector->select(visible);
 266 }
 267
 268 void
 269 FG3DModel::setLongitudeDeg (double lon_deg)
 270 {
 271   _lon_deg = lon_deg;
 272 }
 273
 274 void
 275 FG3DModel::setLatitudeDeg (double lat_deg)
 276 {
 277   _lat_deg = lat_deg;
 278 }
 279
 280 void
 281 FG3DModel::setElevationFt (double elev_ft)
 282 {
 283   _elev_ft = elev_ft;
 284 }
 285
 286 void
 287 FG3DModel::setPosition (double lon_deg, double lat_deg, double elev_ft)
 288 {
 289   _lon_deg = lon_deg;
 290   _lat_deg = lat_deg;
 291   _elev_ft = elev_ft;
 292 }
 293
 294 void
 295 FG3DModel::setRollDeg (double roll_deg)
 296 {
 297   _roll_deg = roll_deg;
 298 }
 299
 300 void
 301 FG3DModel::setPitchDeg (double pitch_deg)
 302 {
 303   _pitch_deg = pitch_deg;
 304 }
 305
 306 void
 307 FG3DModel::setHeadingDeg (double heading_deg)
 308 {
 309   _heading_deg = heading_deg;
 310 }
 311
 312 void
 313 FG3DModel::setOrientation (double roll_deg, double pitch_deg,
 314                            double heading_deg)
 315 {
 316   _roll_deg = roll_deg;
 317   _pitch_deg = pitch_deg;
 318   _heading_deg = heading_deg;
 319 }
 320
 321 FG3DModel::Animation *
 322 FG3DModel::make_animation (const char * object_name,
 323                                  SGPropertyNode * node)
 324 {
 325   Animation * animation = 0;
 326   const char * type = node->getStringValue("type");
 327   if (!strcmp("none", type)) {
 328     animation = new NullAnimation();
 329   } else if (!strcmp("range", type)) {
 330     animation = new RangeAnimation();
 331   } else if (!strcmp("select", type)) {
 332     animation = new SelectAnimation();
 333   } else if (!strcmp("spin", type)) {
 334     animation = new SpinAnimation();
 335   } else if (!strcmp("rotate", type)) {
 336     animation = new RotateAnimation();
 337   } else if (!strcmp("translate", type)) {
 338     animation = new TranslateAnimation();
 339   } else {
 340     animation = new NullAnimation();
 341     SG_LOG(SG_INPUT, SG_WARN, "Unknown animation type " << type);
 342   }
 343
 344   ssgEntity * object = find_named_node(_model, object_name);
 345   if (object == 0) {
 346     SG_LOG(SG_INPUT, SG_WARN, "Object " << object_name << " not found");
 347     delete animation;
 348     animation = 0;
 349   } else {
 350     animation->init(object, node);
 351   }
 352
 353   return animation;
 354 }
 355
 356
 357 \f
 358 ////////////////////////////////////////////////////////////////////////
 359 // Implementation of FG3DModel::Animation
 360 ////////////////////////////////////////////////////////////////////////
 361
 362 FG3DModel::Animation::Animation ()
 363 {
 364 }
 365
 366 FG3DModel::Animation::~Animation ()
 367 {
 368 }
 369
 370
 371 \f
 372 ////////////////////////////////////////////////////////////////////////
 373 // Implementation of FG3DModel::NullAnimation
 374 ////////////////////////////////////////////////////////////////////////
 375
 376 FG3DModel::NullAnimation::NullAnimation ()
 377   : _branch(new ssgBranch)
 378 {
 379 }
 380
 381 FG3DModel::NullAnimation::~NullAnimation ()
 382 {
 383   _branch = 0;
 384 }
 385
 386 void
 387 FG3DModel::NullAnimation::init (ssgEntity * object,
 388                                       SGPropertyNode * props)
 389 {
 390   splice_branch(_branch, object);
 391   _branch->setName(props->getStringValue("name", 0));
 392 }
 393
 394 void
 395 FG3DModel::NullAnimation::update (int dt)
 396 {
 397 }
 398
 399
 400 \f
 401 ////////////////////////////////////////////////////////////////////////
 402 // Implementation of FG3DModel::RangeAnimation
 403 ////////////////////////////////////////////////////////////////////////
 404
 405 FG3DModel::RangeAnimation::RangeAnimation ()
 406   : _branch(new ssgRangeSelector)
 407 {
 408 }
 409
 410 FG3DModel::RangeAnimation::~RangeAnimation ()
 411 {
 412   _branch = 0;
 413 }
 414
 415 void
 416 FG3DModel::RangeAnimation::init (ssgEntity * object,
 417                                       SGPropertyNode * props)
 418 {
 419   float ranges[2];
 420   splice_branch(_branch, object);
 421   _branch->setName(props->getStringValue("name", 0));
 422   ranges[0] = props->getFloatValue("min-m", 0);
 423   ranges[1] = props->getFloatValue("max-m", 5000);
 424   _branch->setRanges(ranges, 2);
 425 }
 426
 427 void
 428 FG3DModel::RangeAnimation::update (int dt)
 429 {
 430 }
 431
 432
 433 \f
 434 ////////////////////////////////////////////////////////////////////////
 435 // Implementation of FG3DModel::SelectAnimation
 436 ////////////////////////////////////////////////////////////////////////
 437
 438 FG3DModel::SelectAnimation::SelectAnimation ()
 439   : _condition(0),
 440     _selector(new ssgSelector)
 441 {
 442 }
 443
 444 FG3DModel::SelectAnimation::~SelectAnimation ()
 445 {
 446   delete _condition;
 447   _selector = 0;
 448 }
 449
 450 void
 451 FG3DModel::SelectAnimation::init (ssgEntity * object,
 452                                       SGPropertyNode * props)
 453 {
 454   splice_branch(_selector, object);
 455   _selector->setName(props->getStringValue("name", 0));
 456   SGPropertyNode * node = props->getChild("condition");
 457   if (node != 0) {
 458     _condition = fgReadCondition(node);
 459   }
 460 }
 461
 462 void
 463 FG3DModel::SelectAnimation::update (int dt)
 464 {
 465   if (_condition != 0 && _condition->test())
 466     _selector->select(0xffff);
 467   else
 468     _selector->select(0x0000);
 469 }
 470
 471
 472 \f
 473 ////////////////////////////////////////////////////////////////////////
 474 // Implementation of FG3DModel::SpinAnimation
 475 ////////////////////////////////////////////////////////////////////////
 476
 477 FG3DModel::SpinAnimation::SpinAnimation ()
 478   : _prop(0),
 479     _factor(0),
 480     _position_deg(0),
 481     _transform(new ssgTransform)
 482 {
 483 }
 484
 485 FG3DModel::SpinAnimation::~SpinAnimation ()
 486 {
 487   _transform = 0;
 488 }
 489
 490 void
 491 FG3DModel::SpinAnimation::init (ssgEntity * object,
 492                                       SGPropertyNode * props)
 493 {
 494                                 // Splice in the new transform node
 495   splice_branch(_transform, object);
 496   _transform->setName(props->getStringValue("name", 0));
 497   _prop = fgGetNode(props->getStringValue("property", "/null"), true);
 498   _factor = props->getDoubleValue("factor", 1.0);
 499   _position_deg = props->getDoubleValue("starting-position-deg", 0);
 500   _center[0] = props->getFloatValue("center/x-m", 0);
 501   _center[1] = props->getFloatValue("center/y-m", 0);
 502   _center[2] = props->getFloatValue("center/z-m", 0);
 503   _axis[0] = props->getFloatValue("axis/x", 0);
 504   _axis[1] = props->getFloatValue("axis/y", 0);
 505   _axis[2] = props->getFloatValue("axis/z", 0);
 506   sgNormalizeVec3(_axis);
 507 }
 508
 509 void
 510 FG3DModel::SpinAnimation::update (int dt)
 511 {
 512   float velocity_rpms = (_prop->getDoubleValue() * _factor / 60000.0);
 513   _position_deg += (dt * velocity_rpms * 360);
 514   while (_position_deg < 0)
 515     _position_deg += 360.0;
 516   while (_position_deg >= 360.0)
 517     _position_deg -= 360.0;
 518   set_rotation(_matrix, _position_deg, _center, _axis);
 519   _transform->setTransform(_matrix);
 520 }
 521
 522
 523 \f
 524 ////////////////////////////////////////////////////////////////////////
 525 // Implementation of FG3DModel::RotateAnimation
 526 ////////////////////////////////////////////////////////////////////////
 527
 528 FG3DModel::RotateAnimation::RotateAnimation ()
 529   : _prop(0),
 530     _offset_deg(0.0),
 531     _factor(1.0),
 532     _has_min(false),
 533     _min_deg(0.0),
 534     _has_max(false),
 535     _max_deg(1.0),
 536     _position_deg(0.0),
 537     _transform(new ssgTransform)
 538 {
 539 }
 540
 541 FG3DModel::RotateAnimation::~RotateAnimation ()
 542 {
 543   _transform = 0;
 544 }
 545
 546 void
 547 FG3DModel::RotateAnimation::init (ssgEntity * object,
 548                                         SGPropertyNode * props)
 549 {
 550                                 // Splice in the new transform node
 551   splice_branch(_transform, object);
 552   _transform->setName(props->getStringValue("name", 0));
 553   _prop = fgGetNode(props->getStringValue("property", "/null"), true);
 554   _offset_deg = props->getDoubleValue("offset-deg", 0.0);
 555   _factor = props->getDoubleValue("factor", 1.0);
 556   if (props->hasValue("min-deg")) {
 557     _has_min = true;
 558     _min_deg = props->getDoubleValue("min-deg");
 559   }
 560   if (props->hasValue("max-deg")) {
 561     _has_max = true;
 562     _max_deg = props->getDoubleValue("max-deg");
 563   }
 564   _position_deg = props->getDoubleValue("starting-position-deg", 0);
 565   _center[0] = props->getFloatValue("center/x-m", 0);
 566   _center[1] = props->getFloatValue("center/y-m", 0);
 567   _center[2] = props->getFloatValue("center/z-m", 0);
 568   _axis[0] = props->getFloatValue("axis/x", 0);
 569   _axis[1] = props->getFloatValue("axis/y", 0);
 570   _axis[2] = props->getFloatValue("axis/z", 0);
 571   sgNormalizeVec3(_axis);
 572 }
 573
 574 void
 575 FG3DModel::RotateAnimation::update (int dt)
 576 {
 577   _position_deg = ((_prop->getDoubleValue() + _offset_deg) * _factor);
 578   if (_has_min && _position_deg < _min_deg)
 579     _position_deg = _min_deg;
 580   if (_has_max && _position_deg > _max_deg)
 581     _position_deg = _max_deg;
 582   set_rotation(_matrix, _position_deg, _center, _axis);
 583   _transform->setTransform(_matrix);
 584 }
 585
 586
 587 \f
 588 ////////////////////////////////////////////////////////////////////////
 589 // Implementation of FG3DModel::TranslateAnimation
 590 ////////////////////////////////////////////////////////////////////////
 591
 592 FG3DModel::TranslateAnimation::TranslateAnimation ()
 593   : _prop(0),
 594     _offset_m(0.0),
 595     _factor(1.0),
 596     _has_min(false),
 597     _min_m(0.0),
 598     _has_max(false),
 599     _max_m(1.0),
 600     _position_m(0.0),
 601     _transform(new ssgTransform)
 602 {
 603 }
 604
 605 FG3DModel::TranslateAnimation::~TranslateAnimation ()
 606 {
 607   _transform = 0;
 608 }
 609
 610 void
 611 FG3DModel::TranslateAnimation::init (ssgEntity * object,
 612                                         SGPropertyNode * props)
 613 {
 614                                 // Splice in the new transform node
 615   splice_branch(_transform, object);
 616   _transform->setName(props->getStringValue("name", 0));
 617   _prop = fgGetNode(props->getStringValue("property", "/null"), true);
 618   _offset_m = props->getDoubleValue("offset-m", 0.0);
 619   _factor = props->getDoubleValue("factor", 1.0);
 620   if (props->hasValue("min-m")) {
 621     _has_min = true;
 622     _min_m = props->getDoubleValue("min-m");
 623   }
 624   if (props->hasValue("max-m")) {
 625     _has_max = true;
 626     _max_m = props->getDoubleValue("max-m");
 627   }
 628   _position_m = props->getDoubleValue("starting-position-m", 0);
 629   _axis[0] = props->getFloatValue("axis/x", 0);
 630   _axis[1] = props->getFloatValue("axis/y", 0);
 631   _axis[2] = props->getFloatValue("axis/z", 0);
 632   sgNormalizeVec3(_axis);
 633 }
 634
 635 void
 636 FG3DModel::TranslateAnimation::update (int dt)
 637 {
 638   _position_m = ((_prop->getDoubleValue() + _offset_m) * _factor);
 639   if (_has_min && _position_m < _min_m)
 640     _position_m = _min_m;
 641   if (_has_max && _position_m > _max_m)
 642     _position_m = _max_m;
 643   set_translation(_matrix, _position_m, _axis);
 644   _transform->setTransform(_matrix);
 645 }
 646
 647
 648 // end of model.cxx
 649
 650
 651
 652