simgear/scene/model/animation.hxx

   1
   2 // animation.hxx - classes to manage model animation.
   3 // Written by David Megginson, started 2002.
   4 //
   5 // This file is in the Public Domain, and comes with no warranty.
   6
   7 #ifndef _SG_ANIMATION_HXX
   8 #define _SG_ANIMATION_HXX 1
   9
  10 #ifndef __cplusplus
  11 # error This library requires C++
  12 #endif
  13
  14 #include <osg/ref_ptr>
  15 #include <osg/Group>
  16 #include <osg/Node>
  17 #include <osg/NodeVisitor>
  18 #include <osg/Texture2D>
  19 #include <osgDB/ReaderWriter>
  20
  21 #include <simgear/scene/util/SGNodeMasks.hxx>
  22 #include <simgear/props/props.hxx>
  23 #include <simgear/props/condition.hxx>
  24 #include <simgear/structure/SGExpression.hxx>
  25
  26 // Has anyone done anything *really* stupid, like making min and max macros?
  27 #ifdef min
  28 #undef min
  29 #endif
  30 #ifdef max
  31 #undef max
  32 #endif
  33
  34 SGExpressiond*
  35 read_value(const SGPropertyNode* configNode, SGPropertyNode* modelRoot,
  36            const char* unit, double defMin, double defMax);
  37 \f
  38 //////////////////////////////////////////////////////////////////////
  39 // Base class for animation installers
  40 //////////////////////////////////////////////////////////////////////
  41
  42 class SGAnimation : protected osg::NodeVisitor {
  43 public:
  44   SGAnimation(const SGPropertyNode* configNode, SGPropertyNode* modelRoot);
  45   virtual ~SGAnimation();
  46
  47   static bool animate(osg::Node* node, const SGPropertyNode* configNode,
  48                       SGPropertyNode* modelRoot,
  49                       const osgDB::ReaderWriter::Options* options);
  50
  51 protected:
  52   void apply(osg::Node* node);
  53
  54   virtual void install(osg::Node& node);
  55   virtual osg::Group* createAnimationGroup(osg::Group& parent);
  56
  57   virtual void apply(osg::Group& group);
  58
  59   void removeMode(osg::Node& node, osg::StateAttribute::GLMode mode);
  60   void removeAttribute(osg::Node& node, osg::StateAttribute::Type type);
  61   void removeTextureMode(osg::Node& node, unsigned unit,
  62                          osg::StateAttribute::GLMode mode);
  63   void removeTextureAttribute(osg::Node& node, unsigned unit,
  64                               osg::StateAttribute::Type type);
  65   void setRenderBinToInherit(osg::Node& node);
  66   void cloneDrawables(osg::Node& node);
  67
  68   std::string getType() const
  69   { return std::string(_configNode->getStringValue("type", "")); }
  70
  71   const SGPropertyNode* getConfig() const
  72   { return _configNode; }
  73   SGPropertyNode* getModelRoot() const
  74   { return _modelRoot; }
  75
  76   const SGCondition* getCondition() const;
  77
  78 private:
  79   void installInGroup(const std::string& name, osg::Group& group,
  80                       osg::ref_ptr<osg::Group>& animationGroup);
  81
  82   class RemoveModeVisitor;
  83   class RemoveAttributeVisitor;
  84   class RemoveTextureModeVisitor;
  85   class RemoveTextureAttributeVisitor;
  86   class BinToInheritVisitor;
  87   class DrawableCloneVisitor;
  88
  89   bool _found;
  90   std::string _name;
  91   SGSharedPtr<SGPropertyNode const> _configNode;
  92   SGPropertyNode* _modelRoot;
  93   std::list<std::string> _objectNames;
  94   std::list<osg::ref_ptr<osg::Node> > _installedAnimations;
  95   bool _enableHOT;
  96   bool _disableShadow;
  97 };
  98
  99 \f
 100 //////////////////////////////////////////////////////////////////////
 101 // Null animation installer
 102 //////////////////////////////////////////////////////////////////////
 103
 104 class SGGroupAnimation : public SGAnimation {
 105 public:
 106   SGGroupAnimation(const SGPropertyNode*, SGPropertyNode*);
 107   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 108 };
 109
 110 \f
 111 //////////////////////////////////////////////////////////////////////
 112 // Translate animation installer
 113 //////////////////////////////////////////////////////////////////////
 114
 115 class SGTranslateAnimation : public SGAnimation {
 116 public:
 117   SGTranslateAnimation(const SGPropertyNode* configNode,
 118                        SGPropertyNode* modelRoot);
 119   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 120 private:
 121   class UpdateCallback;
 122   SGSharedPtr<const SGCondition> _condition;
 123   SGSharedPtr<const SGExpressiond> _animationValue;
 124   SGVec3d _axis;
 125   double _initialValue;
 126 };
 127
 128 \f
 129 //////////////////////////////////////////////////////////////////////
 130 // Rotate/Spin animation installer
 131 //////////////////////////////////////////////////////////////////////
 132
 133 class SGRotateAnimation : public SGAnimation {
 134 public:
 135   SGRotateAnimation(const SGPropertyNode* configNode,
 136                     SGPropertyNode* modelRoot);
 137   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 138 private:
 139   class UpdateCallback;
 140   class SpinUpdateCallback;
 141   SGSharedPtr<const SGCondition> _condition;
 142   SGSharedPtr<const SGExpressiond> _animationValue;
 143   SGVec3d _axis;
 144   SGVec3d _center;
 145   double _initialValue;
 146   bool _isSpin;
 147 };
 148
 149 \f
 150 //////////////////////////////////////////////////////////////////////
 151 // Scale animation installer
 152 //////////////////////////////////////////////////////////////////////
 153
 154 class SGScaleAnimation : public SGAnimation {
 155 public:
 156   SGScaleAnimation(const SGPropertyNode* configNode,
 157                    SGPropertyNode* modelRoot);
 158   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 159 private:
 160   class UpdateCallback;
 161   SGSharedPtr<const SGCondition> _condition;
 162   SGSharedPtr<const SGExpressiond> _animationValue[3];
 163   SGVec3d _initialValue;
 164   SGVec3d _center;
 165 };
 166
 167 \f
 168 //////////////////////////////////////////////////////////////////////
 169 // dist scale animation installer
 170 //////////////////////////////////////////////////////////////////////
 171
 172 class SGDistScaleAnimation : public SGAnimation {
 173 public:
 174   SGDistScaleAnimation(const SGPropertyNode* configNode,
 175                        SGPropertyNode* modelRoot);
 176   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 177   class Transform;
 178 };
 179
 180 \f
 181 //////////////////////////////////////////////////////////////////////
 182 // dist scale animation installer
 183 //////////////////////////////////////////////////////////////////////
 184
 185 class SGFlashAnimation : public SGAnimation {
 186 public:
 187   SGFlashAnimation(const SGPropertyNode* configNode,
 188                    SGPropertyNode* modelRoot);
 189   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 190 public:
 191   class Transform;
 192 };
 193
 194 \f
 195 //////////////////////////////////////////////////////////////////////
 196 // dist scale animation installer
 197 //////////////////////////////////////////////////////////////////////
 198
 199 class SGBillboardAnimation : public SGAnimation {
 200 public:
 201   SGBillboardAnimation(const SGPropertyNode* configNode,
 202                        SGPropertyNode* modelRoot);
 203   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 204   class Transform;
 205 };
 206
 207 \f
 208 //////////////////////////////////////////////////////////////////////
 209 // Range animation installer
 210 //////////////////////////////////////////////////////////////////////
 211
 212 class SGRangeAnimation : public SGAnimation {
 213 public:
 214   SGRangeAnimation(const SGPropertyNode* configNode,
 215                    SGPropertyNode* modelRoot);
 216   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 217 private:
 218   class UpdateCallback;
 219   SGSharedPtr<const SGCondition> _condition;
 220   SGSharedPtr<const SGExpressiond> _minAnimationValue;
 221   SGSharedPtr<const SGExpressiond> _maxAnimationValue;
 222   SGVec2d _initialValue;
 223 };
 224
 225 \f
 226 //////////////////////////////////////////////////////////////////////
 227 // Select animation installer
 228 //////////////////////////////////////////////////////////////////////
 229
 230 class SGSelectAnimation : public SGAnimation {
 231 public:
 232   SGSelectAnimation(const SGPropertyNode* configNode,
 233                     SGPropertyNode* modelRoot);
 234   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 235 private:
 236   class UpdateCallback;
 237 };
 238
 239 \f
 240 //////////////////////////////////////////////////////////////////////
 241 // Alpha test animation installer
 242 //////////////////////////////////////////////////////////////////////
 243
 244 class SGAlphaTestAnimation : public SGAnimation {
 245 public:
 246   SGAlphaTestAnimation(const SGPropertyNode* configNode,
 247                        SGPropertyNode* modelRoot);
 248   virtual void install(osg::Node& node);
 249 };
 250
 251 \f
 252 //////////////////////////////////////////////////////////////////////
 253 // Blend animation installer
 254 //////////////////////////////////////////////////////////////////////
 255
 256 class SGBlendAnimation : public SGAnimation {
 257 public:
 258   SGBlendAnimation(const SGPropertyNode* configNode,
 259                    SGPropertyNode* modelRoot);
 260   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 261   virtual void install(osg::Node& node);
 262 private:
 263   class BlendVisitor;
 264   class UpdateCallback;
 265   SGSharedPtr<SGExpressiond> _animationValue;
 266 };
 267
 268 \f
 269 //////////////////////////////////////////////////////////////////////
 270 // Timed animation installer
 271 //////////////////////////////////////////////////////////////////////
 272
 273 class SGTimedAnimation : public SGAnimation {
 274 public:
 275   SGTimedAnimation(const SGPropertyNode* configNode,
 276                    SGPropertyNode* modelRoot);
 277   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 278 private:
 279   class UpdateCallback;
 280 };
 281
 282 \f
 283 //////////////////////////////////////////////////////////////////////
 284 // Shadow animation installer
 285 //////////////////////////////////////////////////////////////////////
 286
 287 class SGShadowAnimation : public SGAnimation {
 288 public:
 289   SGShadowAnimation(const SGPropertyNode* configNode,
 290                     SGPropertyNode* modelRoot);
 291   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 292 private:
 293   class UpdateCallback;
 294 };
 295
 296 \f
 297 //////////////////////////////////////////////////////////////////////
 298 // TextureTransform animation
 299 //////////////////////////////////////////////////////////////////////
 300
 301 class SGTexTransformAnimation : public SGAnimation {
 302 public:
 303   SGTexTransformAnimation(const SGPropertyNode* configNode,
 304                           SGPropertyNode* modelRoot);
 305   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 306 private:
 307   class Transform;
 308   class Translation;
 309   class Rotation;
 310   class UpdateCallback;
 311   void appendTexTranslate(const SGPropertyNode* config,
 312                           UpdateCallback* updateCallback);
 313   void appendTexRotate(const SGPropertyNode* config,
 314                        UpdateCallback* updateCallback);
 315 };
 316
 317 \f
 318 //////////////////////////////////////////////////////////////////////
 319 // Shader animation
 320 //////////////////////////////////////////////////////////////////////
 321
 322 class SGShaderAnimation : public SGAnimation {
 323 public:
 324   SGShaderAnimation(const SGPropertyNode* configNode,
 325                     SGPropertyNode* modelRoot,
 326                     const osgDB::ReaderWriter::Options* options);
 327   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 328 private:
 329   class UpdateCallback;
 330   osg::ref_ptr<osg::Texture2D> _effect_texture;
 331 };
 332
 333 \f
 334 //////////////////////////////////////////////////////////////////////
 335 // Pick animation
 336 //////////////////////////////////////////////////////////////////////
 337
 338 class SGPickAnimation : public SGAnimation {
 339 public:
 340   SGPickAnimation(const SGPropertyNode* configNode,
 341                   SGPropertyNode* modelRoot);
 342   virtual osg::Group* createAnimationGroup(osg::Group& parent);
 343 private:
 344   class PickCallback;
 345 };
 346
 347 #endif // _SG_ANIMATION_HXX