simgear/scene/model/SGMaterialAnimation.cxx

   1 // animation.cxx - classes to manage model animation.
   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 <simgear_config.h>
   8 #endif
   9
  10 #include "SGMaterialAnimation.hxx"
  11
  12 #include <osg/AlphaFunc>
  13 #include <osg/Array>
  14 #include <osg/Drawable>
  15 #include <osg/Geode>
  16 #include <osg/Geometry>
  17 #include <osg/Material>
  18 #include <osg/StateSet>
  19 #include <osgDB/FileNameUtils>
  20 #include <osgDB/FileUtils>
  21 #include <osgDB/ReadFile>
  22
  23 #include <simgear/props/condition.hxx>
  24 #include <simgear/props/props.hxx>
  25 #include <simgear/scene/model/model.hxx>
  26
  27 namespace {
  28 /**
  29  * Get a color from properties.
  30  */
  31 struct ColorSpec {
  32   float red, green, blue;
  33   float factor;
  34   float offset;
  35   SGPropertyNode_ptr red_prop;
  36   SGPropertyNode_ptr green_prop;
  37   SGPropertyNode_ptr blue_prop;
  38   SGPropertyNode_ptr factor_prop;
  39   SGPropertyNode_ptr offset_prop;
  40   SGVec4f v;
  41
  42   ColorSpec(const SGPropertyNode* configNode, SGPropertyNode* modelRoot)
  43   {
  44     red = -1.0;
  45     green = -1.0;
  46     blue = -1.0;
  47     if (!configNode)
  48       return;
  49
  50     red = configNode->getFloatValue("red", -1.0);
  51     green = configNode->getFloatValue("green", -1.0);
  52     blue = configNode->getFloatValue("blue", -1.0);
  53     factor = configNode->getFloatValue("factor", 1.0);
  54     offset = configNode->getFloatValue("offset", 0.0);
  55
  56     if (!modelRoot)
  57       return;
  58     const SGPropertyNode *node;
  59     node = configNode->getChild("red-prop");
  60     if (node)
  61       red_prop = modelRoot->getNode(node->getStringValue(), true);
  62     node = configNode->getChild("green-prop");
  63     if (node)
  64       green_prop = modelRoot->getNode(node->getStringValue(), true);
  65     node = configNode->getChild("blue-prop");
  66     if (node)
  67       blue_prop = modelRoot->getNode(node->getStringValue(), true);
  68     node = configNode->getChild("factor-prop");
  69     if (node)
  70       factor_prop = modelRoot->getNode(node->getStringValue(), true);
  71     node = configNode->getChild("offset-prop");
  72     if (node)
  73       offset_prop = modelRoot->getNode(node->getStringValue(), true);
  74   }
  75
  76   bool dirty() {
  77     return red >= 0 || green >= 0 || blue >= 0;
  78   }
  79   bool live() {
  80     return red_prop || green_prop || blue_prop
  81       || factor_prop || offset_prop;
  82   }
  83   SGVec4f &rgba() {
  84     if (red_prop)
  85       red = red_prop->getFloatValue();
  86     if (green_prop)
  87       green = green_prop->getFloatValue();
  88     if (blue_prop)
  89       blue = blue_prop->getFloatValue();
  90     if (factor_prop)
  91       factor = factor_prop->getFloatValue();
  92     if (offset_prop)
  93       offset = offset_prop->getFloatValue();
  94     v[0] = SGMiscf::clip(red*factor + offset, 0, 1);
  95     v[1] = SGMiscf::clip(green*factor + offset, 0, 1);
  96     v[2] = SGMiscf::clip(blue*factor + offset, 0, 1);
  97     v[3] = 1;
  98     return v;
  99   }
 100
 101   osg::Vec4& rgbaVec4()
 102   {
 103     return rgba().osg();
 104   }
 105
 106   SGVec4f &initialRgba() {
 107     v[0] = SGMiscf::clip(red*factor + offset, 0, 1);
 108     v[1] = SGMiscf::clip(green*factor + offset, 0, 1);
 109     v[2] = SGMiscf::clip(blue*factor + offset, 0, 1);
 110     v[3] = 1;
 111     return v;
 112   }
 113 };
 114
 115 /**
 116  * Get a property value from a property.
 117  */
 118 struct PropSpec {
 119   float value;
 120   float factor;
 121   float offset;
 122   float min;
 123   float max;
 124   SGPropertyNode_ptr value_prop;
 125   SGPropertyNode_ptr factor_prop;
 126   SGPropertyNode_ptr offset_prop;
 127
 128   PropSpec(const char* valueName, const char* valuePropName,
 129            const SGPropertyNode* configNode, SGPropertyNode* modelRoot)
 130   {
 131     value = -1;
 132     if (!configNode)
 133       return;
 134
 135     value = configNode->getFloatValue(valueName, -1);
 136     factor = configNode->getFloatValue("factor", 1);
 137     offset = configNode->getFloatValue("offset", 0);
 138     min = configNode->getFloatValue("min", 0);
 139     max = configNode->getFloatValue("max", 1);
 140
 141     if (!modelRoot)
 142       return;
 143     const SGPropertyNode *node;
 144     node = configNode->getChild(valuePropName);
 145     if (node)
 146       value_prop = modelRoot->getNode(node->getStringValue(), true);
 147     node = configNode->getChild("factor-prop");
 148     if (node)
 149       factor_prop = modelRoot->getNode(node->getStringValue(), true);
 150     node = configNode->getChild("offset-prop");
 151     if (node)
 152       offset_prop = modelRoot->getNode(node->getStringValue(), true);
 153   }
 154   bool dirty() { return value >= 0.0; }
 155   bool live() { return value_prop || factor_prop || offset_prop; }
 156   float getValue()
 157   {
 158     if (value_prop)
 159       value = value_prop->getFloatValue();
 160     if (offset_prop)
 161       offset = offset_prop->getFloatValue();
 162     if (factor_prop)
 163       factor = factor_prop->getFloatValue();
 164     return SGMiscf::clip(value*factor + offset, min, max);
 165   }
 166   float getInitialValue()
 167   {
 168     return SGMiscf::clip(value*factor + offset, min, max);
 169   }
 170 };
 171
 172 /**
 173  * The possible color properties supplied by a material animation.
 174  */
 175 enum SuppliedColor {
 176   DIFFUSE = 1,
 177   AMBIENT = 2,
 178   SPECULAR = 4,
 179   EMISSION = 8,
 180   SHININESS = 16,
 181   TRANSPARENCY = 32
 182 };
 183
 184 const unsigned AMBIENT_DIFFUSE = AMBIENT | DIFFUSE;
 185
 186 const int allMaterialColors = (DIFFUSE | AMBIENT | SPECULAR | EMISSION
 187                                | SHININESS);
 188
 189 // Visitor for finding default material colors in the animation node's
 190 // subgraph. This makes some assumptions about the subgraph i.e.,
 191 // there will be one material and one color value found. This is
 192 // probably true for ac3d models and most uses of material animations,
 193 // but will break down if, for example, you animate the transparency
 194 // of a vertex colored model.
 195 class MaterialDefaultsVisitor : public osg::NodeVisitor {
 196 public:
 197   MaterialDefaultsVisitor()
 198     : osg::NodeVisitor(osg::NodeVisitor::TRAVERSE_ALL_CHILDREN),
 199       ambientDiffuse(-1.0f, -1.0f, -1.0f, -1.0f)
 200   {
 201     setVisitorType(osg::NodeVisitor::NODE_VISITOR);
 202   }
 203
 204   virtual void apply(osg::Node& node)
 205   {
 206     maybeGetMaterialValues(node.getStateSet());
 207     traverse(node);
 208   }
 209
 210   virtual void apply(osg::Geode& node)
 211   {
 212     maybeGetMaterialValues(node.getStateSet());
 213     int numDrawables = node.getNumDrawables();
 214     for (int i = 0; i < numDrawables; i++) {
 215       osg::Geometry* geom = dynamic_cast<osg::Geometry*>(node.getDrawable(i));
 216       if (!geom || geom->getColorBinding() != osg::Geometry::BIND_OVERALL)
 217         continue;
 218       maybeGetMaterialValues(geom->getStateSet());
 219       osg::Array* colorArray = geom->getColorArray();
 220       osg::Vec4Array* colorVec4 = dynamic_cast<osg::Vec4Array*>(colorArray);
 221       if (colorVec4) {
 222         ambientDiffuse = (*colorVec4)[0];
 223         break;
 224       }
 225       osg::Vec3Array* colorVec3 = dynamic_cast<osg::Vec3Array*>(colorArray);
 226       if (colorVec3) {
 227         ambientDiffuse = osg::Vec4((*colorVec3)[0], 1.0f);
 228         break;
 229       }
 230     }
 231   }
 232
 233   void maybeGetMaterialValues(osg::StateSet* stateSet)
 234   {
 235     if (!stateSet)
 236       return;
 237     osg::Material* nodeMat
 238       = dynamic_cast<osg::Material*>(stateSet->getAttribute(osg::StateAttribute::MATERIAL));
 239     if (!nodeMat)
 240       return;
 241     material = nodeMat;
 242   }
 243
 244   osg::ref_ptr<osg::Material> material;
 245   osg::Vec4 ambientDiffuse;
 246 };
 247
 248 class UpdateCallback : public osg::NodeCallback {
 249 public:
 250   UpdateCallback(const osgDB::FilePathList& texturePathList,
 251                  const SGCondition* condition,
 252                  const SGPropertyNode* configNode, SGPropertyNode* modelRoot) :
 253     _condition(condition),
 254     _ambient(configNode->getChild("ambient"), modelRoot),
 255     _diffuse(configNode->getChild("diffuse"), modelRoot),
 256     _specular(configNode->getChild("specular"), modelRoot),
 257     _emission(configNode->getChild("emission"), modelRoot),
 258     _shininess("shininess", "shininess-prop",
 259                configNode->getChild("shininess"), modelRoot),
 260     _transparency("alpha", "alpha-prop",
 261                   configNode->getChild("transparency"), modelRoot),
 262     _texturePathList(texturePathList)
 263   {
 264     const SGPropertyNode* node;
 265
 266     node = configNode->getChild("threshold-prop");
 267     if (node)
 268       _thresholdProp = modelRoot->getNode(node->getStringValue(), true);
 269     node = configNode->getChild("texture-prop");
 270     if (node)
 271       _textureProp = modelRoot->getNode(node->getStringValue(), true);
 272   }
 273
 274   virtual void operator()(osg::Node* node, osg::NodeVisitor* nv)
 275   {
 276     osg::StateSet* stateSet = node->getStateSet();
 277     if ((!_condition || _condition->test()) && stateSet) {
 278       if (_textureProp) {
 279         std::string textureName = _textureProp->getStringValue();
 280         if (_textureName != textureName) {
 281           while (stateSet->getTextureAttribute(0,
 282                                                osg::StateAttribute::TEXTURE)) {
 283             stateSet->removeTextureAttribute(0, osg::StateAttribute::TEXTURE);
 284           }
 285           std::string textureFile;
 286           textureFile = osgDB::findFileInPath(textureName, _texturePathList);
 287           if (!textureFile.empty()) {
 288             osg::Texture2D* texture2D = SGLoadTexture2D(textureFile);
 289             if (texture2D) {
 290               stateSet->setTextureAttribute(0, texture2D,
 291                                             osg::StateAttribute::OVERRIDE);
 292               stateSet->setTextureMode(0, GL_TEXTURE_2D,
 293                                        osg::StateAttribute::ON);
 294               _textureName = textureName;
 295             }
 296           }
 297         }
 298       }
 299       if (_thresholdProp) {
 300         osg::StateSet* stateSet = node->getOrCreateStateSet();
 301         osg::StateAttribute* stateAttribute;
 302         stateAttribute = stateSet->getAttribute(osg::StateAttribute::ALPHAFUNC);
 303         osg::AlphaFunc* alphaFunc = dynamic_cast<osg::AlphaFunc*>(stateAttribute);
 304         assert(alphaFunc);
 305         alphaFunc->setReferenceValue(_thresholdProp->getFloatValue());
 306       }
 307       osg::StateAttribute* stateAttribute
 308         = stateSet->getAttribute(osg::StateAttribute::MATERIAL);
 309       osg::Material* material = dynamic_cast<osg::Material*>(stateAttribute);
 310       if (material) {
 311         if (_ambient.live())
 312           material->setAmbient(osg::Material::FRONT_AND_BACK,
 313                                _ambient.rgbaVec4());
 314         if (_diffuse.live())
 315           material->setDiffuse(osg::Material::FRONT_AND_BACK,
 316                                _diffuse.rgbaVec4());
 317         if (_specular.live())
 318           material->setSpecular(osg::Material::FRONT_AND_BACK,
 319                                 _specular.rgbaVec4());
 320         if (_emission.live())
 321           material->setEmission(osg::Material::FRONT_AND_BACK,
 322                                 _emission.rgbaVec4());
 323         if (_shininess.live())
 324           material->setShininess(osg::Material::FRONT_AND_BACK,
 325                                  _shininess.getValue());
 326         if (_transparency.live())       {
 327           float alpha = _transparency.getValue();
 328           material->setAlpha(osg::Material::FRONT_AND_BACK, alpha);
 329           if (alpha < 1.0f) {
 330             stateSet->setRenderingHint(osg::StateSet::TRANSPARENT_BIN);
 331             stateSet->setMode(GL_BLEND, osg::StateAttribute::ON);
 332           } else {
 333             stateSet->setRenderingHint(osg::StateSet::DEFAULT_BIN);
 334           }
 335         }
 336       }
 337     }
 338     traverse(node, nv);
 339   }
 340 private:
 341   SGSharedPtr<const SGCondition> _condition;
 342   SGSharedPtr<const SGPropertyNode> _textureProp;
 343   SGSharedPtr<const SGPropertyNode> _thresholdProp;
 344   std::string _textureName;
 345   ColorSpec _ambient;
 346   ColorSpec _diffuse;
 347   ColorSpec _specular;
 348   ColorSpec _emission;
 349   PropSpec _shininess;
 350   PropSpec _transparency;
 351   osgDB::FilePathList _texturePathList;
 352 };
 353 } // namespace
 354
 355
 356 SGMaterialAnimation::SGMaterialAnimation(const SGPropertyNode* configNode,
 357                                          SGPropertyNode* modelRoot) :
 358   SGAnimation(configNode, modelRoot)
 359 {
 360   if (configNode->hasChild("global"))
 361     SG_LOG(SG_IO, SG_ALERT, "Use of <global> in material animation is "
 362            "no longer supported");
 363 }
 364
 365 osg::Group*
 366 SGMaterialAnimation::createAnimationGroup(osg::Group& parent)
 367 {
 368   osg::Group* group = new osg::Group;
 369   group->setName("material animation group");
 370
 371   SGPropertyNode* inputRoot = getModelRoot();
 372   const SGPropertyNode* node = getConfig()->getChild("property-base");
 373   if (node)
 374     inputRoot = getModelRoot()->getRootNode()->getNode(node->getStringValue(),
 375                                                        true);
 376
 377   osgDB::FilePathList texturePathList = osgDB::getDataFilePathList();
 378
 379   if (getConfig()->hasChild("texture")) {
 380     std::string textureName = getConfig()->getStringValue("texture");
 381     std::string textureFile;
 382     textureFile = osgDB::findFileInPath(textureName, texturePathList);
 383     if (!textureFile.empty()) {
 384       osg::StateSet* stateSet = group->getOrCreateStateSet();
 385       osg::Texture2D* texture2D = SGLoadTexture2D(textureFile);
 386       if (texture2D) {
 387         stateSet->setTextureAttribute(0, texture2D,
 388                                       osg::StateAttribute::OVERRIDE);
 389         stateSet->setTextureMode(0, GL_TEXTURE_2D, osg::StateAttribute::ON);
 390         if (texture2D->getImage()->isImageTranslucent()) {
 391           stateSet->setRenderingHint(osg::StateSet::TRANSPARENT_BIN);
 392           stateSet->setMode(GL_BLEND, osg::StateAttribute::ON);
 393         }
 394       }
 395     }
 396   }
 397   if (getConfig()->hasChild("threshold-prop") ||
 398       getConfig()->hasChild("threshold")) {
 399     osg::StateSet* stateSet = group->getOrCreateStateSet();
 400     osg::AlphaFunc* alphaFunc = new osg::AlphaFunc;
 401     alphaFunc->setFunction(osg::AlphaFunc::GREATER);
 402     float threshold = getConfig()->getFloatValue("threshold", 0);
 403     alphaFunc->setReferenceValue(threshold);
 404     stateSet->setAttribute(alphaFunc, osg::StateAttribute::OVERRIDE);
 405   }
 406
 407   unsigned suppliedColors = 0;
 408   if (getConfig()->hasChild("ambient"))
 409     suppliedColors |= AMBIENT;
 410   if (getConfig()->hasChild("diffuse"))
 411     suppliedColors |= DIFFUSE;
 412   if (getConfig()->hasChild("specular"))
 413     suppliedColors |= SPECULAR;
 414   if (getConfig()->hasChild("emission"))
 415     suppliedColors |= EMISSION;
 416   if (getConfig()->hasChild("shininess")
 417       || getConfig()->hasChild("shininess-prop"))
 418     suppliedColors |= SHININESS;
 419   if (getConfig()->hasChild("transparency"))
 420     suppliedColors |= TRANSPARENCY;
 421
 422   if (suppliedColors != 0) {
 423       osg::StateSet* stateSet = group->getOrCreateStateSet();
 424       osg::Material* mat;
 425
 426       if (defaultMaterial.valid()) {
 427         mat = defaultMaterial.get();
 428
 429       } else {
 430         mat = new osg::Material;
 431         mat->setColorMode(osg::Material::AMBIENT_AND_DIFFUSE);
 432       }
 433       mat->setDataVariance(osg::Object::DYNAMIC);
 434       unsigned defaultColorModeMask = 0;
 435       mat->setUpdateCallback(0); // Just to make sure.
 436       switch (mat->getColorMode()) {
 437       case osg::Material::OFF:
 438         defaultColorModeMask = 0;
 439         break;
 440       case osg::Material::AMBIENT:
 441         defaultColorModeMask = AMBIENT;
 442         break;
 443       case osg::Material::DIFFUSE:
 444         defaultColorModeMask = DIFFUSE;
 445         break;
 446       case osg::Material::AMBIENT_AND_DIFFUSE:
 447         defaultColorModeMask = AMBIENT | DIFFUSE;
 448         break;
 449       case osg::Material::SPECULAR:
 450         defaultColorModeMask = SPECULAR;
 451         break;
 452       case osg::Material::EMISSION:
 453         defaultColorModeMask = EMISSION;
 454         break;
 455       }
 456       // Copy the color found by traversing geometry into the material
 457       // in case we need to specify it (e.g., transparency) and it is
 458       // not specified by the animation.
 459       if (defaultAmbientDiffuse.x() >= 0) {
 460         if (defaultColorModeMask & AMBIENT)
 461           mat->setAmbient(osg::Material::FRONT_AND_BACK, defaultAmbientDiffuse);
 462         if (defaultColorModeMask & DIFFUSE)
 463           mat->setDiffuse(osg::Material::FRONT_AND_BACK, defaultAmbientDiffuse);
 464       }
 465       // Compute which colors in the animation override colors set via
 466       // colorMode / glColor, and set the colorMode for the animation's
 467       // material accordingly.
 468       if (suppliedColors & TRANSPARENCY) {
 469         // All colors will be affected by the material. Hope all the
 470         // defaults are fine, if needed.
 471         mat->setColorMode(osg::Material::OFF);
 472       } else if ((suppliedColors & defaultColorModeMask) != 0) {
 473         // First deal with the complicated AMBIENT/DIFFUSE case.
 474         if ((defaultColorModeMask & AMBIENT_DIFFUSE) != 0) {
 475           // glColor can supply colors not specified by the animation.
 476           unsigned matColorModeMask = ((~suppliedColors & defaultColorModeMask)
 477                                        & AMBIENT_DIFFUSE);
 478           if ((matColorModeMask & DIFFUSE) != 0)
 479             mat->setColorMode(osg::Material::DIFFUSE);
 480           else if ((matColorModeMask & AMBIENT) != 0)
 481             mat->setColorMode(osg::Material::AMBIENT);
 482           else
 483             mat->setColorMode(osg::Material::OFF);
 484         } else {
 485           // The animation overrides the glColor color.
 486           mat->setColorMode(osg::Material::OFF);
 487         }
 488       } else {
 489         // No overlap between the animation and color mode, so leave
 490         // the color mode alone.
 491       }
 492       stateSet->setAttribute(mat,(osg::StateAttribute::ON
 493                                   | osg::StateAttribute::OVERRIDE));
 494   }
 495   group->setUpdateCallback(new UpdateCallback(texturePathList,
 496                                               getCondition(),
 497                                               getConfig(), inputRoot));
 498   parent.addChild(group);
 499   return group;
 500 }
 501
 502 void
 503 SGMaterialAnimation::install(osg::Node& node)
 504 {
 505   SGAnimation::install(node);
 506
 507     MaterialDefaultsVisitor defaultsVisitor;
 508     node.accept(defaultsVisitor);
 509     if (defaultsVisitor.material.valid()) {
 510       defaultMaterial
 511         = static_cast<osg::Material*>(defaultsVisitor.material->clone(osg::CopyOp::SHALLOW_COPY));
 512     }
 513     defaultAmbientDiffuse = defaultsVisitor.ambientDiffuse;
 514 }