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