SG_USING_STD(vector);
#include <plib/sg.h>
+#include <plib/ssg.h>
+
+#include <simgear/misc/props.hxx>
// Don't pull in the headers, since we don't need them here.
+class ssgBranch;
+class ssgCutout;
class ssgEntity;
class ssgRangeSelector;
class ssgSelector;
class ssgTransform;
-class SGPropertyNode;
class SGInterpTable;
class FGCondition;
class FGLocation;
#undef max
#endif
-class FG3DModel
+
+/**
+ * Load a 3D model with or without XML wrapper.
+ *
+ * If the path ends in ".xml", then it will be used as a property-
+ * list wrapper to add animations to the model.
+ *
+ * Subsystems should not normally invoke this function directly;
+ * instead, they should use the FGModelLoader declared in loader.hxx.
+ */
+ssgBranch * fgLoad3DModel (const string &path);
+
+
+\f
+//////////////////////////////////////////////////////////////////////
+// Animation classes
+//////////////////////////////////////////////////////////////////////
+
+/**
+ * Abstract base class for all animations.
+ */
+class Animation : public ssgBase
{
public:
- FG3DModel ();
- virtual ~FG3DModel ();
+ Animation (SGPropertyNode_ptr props, ssgBranch * branch);
- virtual void init (const string &path);
- virtual void update (int dt);
+ virtual ~Animation ();
- virtual bool getVisible () const;
- virtual void setVisible (bool visible);
+ /**
+ * Get the SSG branch holding the animation.
+ */
+ virtual ssgBranch * getBranch () { return _branch; }
- virtual double getLongitudeDeg () const { return _lon_deg; }
- virtual double getLatitudeDeg () const { return _lat_deg; }
- virtual double getElevationFt () const { return _elev_ft; }
+ /**
+ * Initialize the animation, after children have been added.
+ */
+ virtual void init ();
- virtual void setLongitudeDeg (double lon_deg);
- virtual void setLatitudeDeg (double lat_deg);
- virtual void setElevationFt (double elev_ft);
- virtual void setPosition (double lon_deg, double lat_deg, double elev_ft);
+ /**
+ * Update the animation.
+ */
+ virtual void update ();
- virtual double getRollDeg () const { return _roll_deg; }
- virtual double getPitchDeg () const { return _pitch_deg; }
- virtual double getHeadingDeg () const { return _heading_deg; }
+protected:
- virtual void setRollDeg (double roll_deg);
- virtual void setPitchDeg (double pitch_deg);
- virtual void setHeadingDeg (double heading_deg);
- virtual void setOrientation (double roll_deg, double pitch_deg,
- double heading_deg);
+ ssgBranch * _branch;
- virtual ssgEntity * getSceneGraph () const { return (ssgEntity *)_selector; }
+};
- virtual FGLocation * getFGLocation () const { return _location; }
-private:
-
- class Animation;
- Animation * make_animation (const char * object_name, SGPropertyNode * node);
+/**
+ * A no-op animation.
+ */
+class NullAnimation : public Animation
+{
+public:
+ NullAnimation (SGPropertyNode_ptr props);
+ virtual ~NullAnimation ();
+};
- // Geodetic position
- double _lon_deg;
- double _lat_deg;
- double _elev_ft;
- // Orientation
- double _roll_deg;
- double _pitch_deg;
- double _heading_deg;
+/**
+ * A range, or level-of-detail (LOD) animation.
+ */
+class RangeAnimation : public Animation
+{
+public:
+ RangeAnimation (SGPropertyNode_ptr props);
+ virtual ~RangeAnimation ();
+};
- // Animations
- vector <Animation *> _animations;
+/**
+ * Animation to turn and face the screen.
+ */
+class BillboardAnimation : public Animation
+{
+public:
+ BillboardAnimation (SGPropertyNode_ptr props);
+ virtual ~BillboardAnimation ();
+};
- // Scene graph
- ssgEntity * _model;
- ssgSelector * _selector;
- ssgTransform * _position;
+/**
+ * Animation to select alternative versions of the same object.
+ */
+class SelectAnimation : public Animation
+{
+public:
+ SelectAnimation (SGPropertyNode_ptr props);
+ virtual ~SelectAnimation ();
+ virtual void update ();
+private:
+ FGCondition * _condition;
+};
- // Location
- FGLocation * _location;
+/**
+ * Animation to spin an object around a center point.
+ *
+ * This animation rotates at a specific velocity.
+ */
+class SpinAnimation : public Animation
+{
+public:
+ SpinAnimation (SGPropertyNode_ptr props);
+ virtual ~SpinAnimation ();
+ virtual void update ();
+private:
+ SGPropertyNode_ptr _prop;
+ double _factor;
+ double _position_deg;
+ double _last_time_sec;
+ sgMat4 _matrix;
+ sgVec3 _center;
+ sgVec3 _axis;
+};
- \f
- //////////////////////////////////////////////////////////////////////
- // Internal classes for individual animations.
- //////////////////////////////////////////////////////////////////////
- /**
- * Abstract base class for all animations.
- */
- class Animation
- {
- public:
+/**
+ * Animation to draw objects for a specific amount of time each.
+ */
+class TimedAnimation : public Animation
+{
+public:
+ TimedAnimation (SGPropertyNode_ptr props);
+ virtual ~TimedAnimation ();
+ virtual void update ();
+private:
+ double _duration_sec;
+ double _last_time_sec;
+ int _step;
+};
- Animation ();
- virtual ~Animation ();
+/**
+ * Animation to rotate an object around a center point.
+ *
+ * This animation rotates to a specific position.
+ */
+class RotateAnimation : public Animation
+{
+public:
+ RotateAnimation (SGPropertyNode_ptr props);
+ virtual ~RotateAnimation ();
+ virtual void update ();
+private:
+ SGPropertyNode_ptr _prop;
+ double _offset_deg;
+ double _factor;
+ SGInterpTable * _table;
+ bool _has_min;
+ double _min_deg;
+ bool _has_max;
+ double _max_deg;
+ double _position_deg;
+ sgMat4 _matrix;
+ sgVec3 _center;
+ sgVec3 _axis;
+};
- /**
- * Initialize the animation.
- *
- * @param object The object to animate.
- * @param props The property node with configuration information.
- */
- virtual void init (ssgEntity * object, SGPropertyNode * props) = 0;
+/**
+ * Animation to slide along an axis.
+ */
+class TranslateAnimation : public Animation
+{
+public:
+ TranslateAnimation (SGPropertyNode_ptr props);
+ virtual ~TranslateAnimation ();
+ virtual void update ();
+private:
+ SGPropertyNode_ptr _prop;
+ double _offset_m;
+ double _factor;
+ SGInterpTable * _table;
+ bool _has_min;
+ double _min_m;
+ bool _has_max;
+ double _max_m;
+ double _position_m;
+ sgMat4 _matrix;
+ sgVec3 _axis;
+};
- /**
- * Update the animation.
- *
- * @param dt The elapsed time in milliseconds since the last call.
- */
- virtual void update (int dt) = 0;
- };
+\f
+////////////////////////////////////////////////////////////////////////
+// Model placement.
+////////////////////////////////////////////////////////////////////////
+/**
+ * A wrapper for a model with a definite placement.
+ */
+class FGModelPlacement
+{
+public:
- /**
- * A no-op animation.
- */
- class NullAnimation : public Animation
- {
- public:
- NullAnimation ();
- virtual ~NullAnimation ();
- virtual void init (ssgEntity * object, SGPropertyNode * props);
- virtual void update (int dt);
- private:
- ssgBranch * _branch;
- };
+ FGModelPlacement ();
+ virtual ~FGModelPlacement ();
-
- /**
- * A range, or level-of-detail (LOD) animation.
- */
- class RangeAnimation : public Animation
- {
- public:
- RangeAnimation ();
- virtual ~RangeAnimation ();
- virtual void init (ssgEntity * object, SGPropertyNode * props);
- virtual void update (int dt);
- private:
- ssgRangeSelector * _branch;
- };
+ virtual void init (const string &path);
+ virtual void update ();
+ virtual ssgEntity * getSceneGraph () { return (ssgEntity *)_selector; }
- /**
- * Animation to select alternative versions of the same object.
- */
- class SelectAnimation : public Animation
- {
- public:
- SelectAnimation ();
- virtual ~SelectAnimation ();
- virtual void init (ssgEntity * object, SGPropertyNode * props);
- virtual void update (int dt);
- private:
- FGCondition * _condition;
- ssgSelector * _selector;
- };
+ virtual FGLocation * getFGLocation () { return _location; }
+ virtual bool getVisible () const;
+ virtual void setVisible (bool visible);
- /**
- * Animation to spin an object around a center point.
- *
- * This animation rotates at a specific velocity.
- */
- class SpinAnimation : public Animation
- {
- public:
- SpinAnimation ();
- virtual ~SpinAnimation ();
- virtual void init (ssgEntity * object, SGPropertyNode * props);
- virtual void update (int dt);
- private:
- SGPropertyNode * _prop;
- double _factor;
- double _position_deg;
- sgMat4 _matrix;
- sgVec3 _center;
- sgVec3 _axis;
- ssgTransform * _transform;
- };
+ virtual double getLongitudeDeg () const { return _lon_deg; }
+ virtual double getLatitudeDeg () const { return _lat_deg; }
+ virtual double getElevationFt () const { return _elev_ft; }
+ virtual void setLongitudeDeg (double lon_deg);
+ virtual void setLatitudeDeg (double lat_deg);
+ virtual void setElevationFt (double elev_ft);
+ virtual void setPosition (double lon_deg, double lat_deg, double elev_ft);
- /**
- * Animation to rotate an object around a center point.
- *
- * This animation rotates to a specific position.
- */
- class RotateAnimation : public Animation
- {
- public:
- RotateAnimation ();
- virtual ~RotateAnimation ();
- virtual void init (ssgEntity * object, SGPropertyNode * props);
- virtual void update (int dt);
- private:
- SGPropertyNode * _prop;
- double _offset_deg;
- double _factor;
- SGInterpTable * _table;
- bool _has_min;
- double _min_deg;
- bool _has_max;
- double _max_deg;
- double _position_deg;
- sgMat4 _matrix;
- sgVec3 _center;
- sgVec3 _axis;
- ssgTransform * _transform;
- };
+ virtual double getRollDeg () const { return _roll_deg; }
+ virtual double getPitchDeg () const { return _pitch_deg; }
+ virtual double getHeadingDeg () const { return _heading_deg; }
+ virtual void setRollDeg (double roll_deg);
+ virtual void setPitchDeg (double pitch_deg);
+ virtual void setHeadingDeg (double heading_deg);
+ virtual void setOrientation (double roll_deg, double pitch_deg,
+ double heading_deg);
- /**
- * Animation to slide along an axis.
- */
- class TranslateAnimation : public Animation
- {
- public:
- TranslateAnimation ();
- virtual ~TranslateAnimation ();
- virtual void init (ssgEntity * object, SGPropertyNode * props);
- virtual void update (int dt);
- private:
- SGPropertyNode * _prop;
- double _offset_m;
- double _factor;
- SGInterpTable * _table;
- bool _has_min;
- double _min_m;
- bool _has_max;
- double _max_m;
- double _position_m;
- sgMat4 _matrix;
- sgVec3 _axis;
- ssgTransform * _transform;
- };
+private:
+
+ // Geodetic position
+ double _lon_deg;
+ double _lat_deg;
+ double _elev_ft;
-};
+ // Orientation
+ double _roll_deg;
+ double _pitch_deg;
+ double _heading_deg;
-#endif // __MODEL_HXX
+ ssgSelector * _selector;
+ ssgTransform * _position;
+ // Location
+ FGLocation * _location;
+};
+#endif // __MODEL_HXX