1 // animation.cxx - classes to manage model animation.
2 // Written by David Megginson, started 2002.
4 // This file is in the Public Domain, and comes with no warranty.
7 # include <simgear_config.h>
10 #include "SGMaterialAnimation.hxx"
12 #include <osg/AlphaFunc>
14 #include <osg/Drawable>
16 #include <osg/Geometry>
17 #include <osg/Material>
18 #include <osg/StateSet>
19 #include <osgDB/FileNameUtils>
20 #include <osgDB/FileUtils>
21 #include <osgDB/ReadFile>
23 #include <simgear/props/condition.hxx>
24 #include <simgear/props/props.hxx>
25 #include <simgear/scene/model/model.hxx>
29 * Get a color from properties.
32 float red, green, blue;
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;
42 ColorSpec(const SGPropertyNode* configNode, SGPropertyNode* modelRoot)
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);
58 const SGPropertyNode *node;
59 node = configNode->getChild("red-prop");
61 red_prop = modelRoot->getNode(node->getStringValue(), true);
62 node = configNode->getChild("green-prop");
64 green_prop = modelRoot->getNode(node->getStringValue(), true);
65 node = configNode->getChild("blue-prop");
67 blue_prop = modelRoot->getNode(node->getStringValue(), true);
68 node = configNode->getChild("factor-prop");
70 factor_prop = modelRoot->getNode(node->getStringValue(), true);
71 node = configNode->getChild("offset-prop");
73 offset_prop = modelRoot->getNode(node->getStringValue(), true);
77 return red >= 0 || green >= 0 || blue >= 0;
80 return red_prop || green_prop || blue_prop
81 || factor_prop || offset_prop;
85 red = red_prop->getFloatValue();
87 green = green_prop->getFloatValue();
89 blue = blue_prop->getFloatValue();
91 factor = factor_prop->getFloatValue();
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);
101 osg::Vec4& rgbaVec4()
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);
116 * Get a property value from a property.
124 SGPropertyNode_ptr value_prop;
125 SGPropertyNode_ptr factor_prop;
126 SGPropertyNode_ptr offset_prop;
128 PropSpec(const char* valueName, const char* valuePropName,
129 const SGPropertyNode* configNode, SGPropertyNode* modelRoot)
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);
143 const SGPropertyNode *node;
144 node = configNode->getChild(valuePropName);
146 value_prop = modelRoot->getNode(node->getStringValue(), true);
147 node = configNode->getChild("factor-prop");
149 factor_prop = modelRoot->getNode(node->getStringValue(), true);
150 node = configNode->getChild("offset-prop");
152 offset_prop = modelRoot->getNode(node->getStringValue(), true);
154 bool dirty() { return value >= 0.0; }
155 bool live() { return value_prop || factor_prop || offset_prop; }
159 value = value_prop->getFloatValue();
161 offset = offset_prop->getFloatValue();
163 factor = factor_prop->getFloatValue();
164 return SGMiscf::clip(value*factor + offset, min, max);
166 float getInitialValue()
168 return SGMiscf::clip(value*factor + offset, min, max);
173 * The possible color properties supplied by a material animation.
184 const unsigned AMBIENT_DIFFUSE = AMBIENT | DIFFUSE;
186 const int allMaterialColors = (DIFFUSE | AMBIENT | SPECULAR | EMISSION
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 {
197 MaterialDefaultsVisitor()
198 : osg::NodeVisitor(osg::NodeVisitor::TRAVERSE_ALL_CHILDREN),
199 ambientDiffuse(-1.0f, -1.0f, -1.0f, -1.0f)
201 setVisitorType(osg::NodeVisitor::NODE_VISITOR);
204 virtual void apply(osg::Node& node)
206 maybeGetMaterialValues(node.getStateSet());
210 virtual void apply(osg::Geode& node)
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)
218 maybeGetMaterialValues(geom->getStateSet());
219 osg::Array* colorArray = geom->getColorArray();
220 osg::Vec4Array* colorVec4 = dynamic_cast<osg::Vec4Array*>(colorArray);
222 ambientDiffuse = (*colorVec4)[0];
225 osg::Vec3Array* colorVec3 = dynamic_cast<osg::Vec3Array*>(colorArray);
227 ambientDiffuse = osg::Vec4((*colorVec3)[0], 1.0f);
233 void maybeGetMaterialValues(osg::StateSet* stateSet)
237 osg::Material* nodeMat
238 = dynamic_cast<osg::Material*>(stateSet->getAttribute(osg::StateAttribute::MATERIAL));
244 osg::ref_ptr<osg::Material> material;
245 osg::Vec4 ambientDiffuse;
248 class UpdateCallback : public osg::NodeCallback {
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)
264 const SGPropertyNode* node;
266 node = configNode->getChild("threshold-prop");
268 _thresholdProp = modelRoot->getNode(node->getStringValue(), true);
269 node = configNode->getChild("texture-prop");
271 _textureProp = modelRoot->getNode(node->getStringValue(), true);
272 _shininess.max = 128;
275 virtual void operator()(osg::Node* node, osg::NodeVisitor* nv)
277 osg::StateSet* stateSet = node->getStateSet();
278 if ((!_condition || _condition->test()) && stateSet) {
280 std::string textureName = _textureProp->getStringValue();
281 if (_textureName != textureName) {
282 while (stateSet->getTextureAttribute(0,
283 osg::StateAttribute::TEXTURE)) {
284 stateSet->removeTextureAttribute(0, osg::StateAttribute::TEXTURE);
286 std::string textureFile;
287 textureFile = osgDB::findFileInPath(textureName, _texturePathList);
288 if (!textureFile.empty()) {
289 osg::Texture2D* texture2D = SGLoadTexture2D(textureFile);
291 stateSet->setTextureAttribute(0, texture2D,
292 osg::StateAttribute::OVERRIDE);
293 stateSet->setTextureMode(0, GL_TEXTURE_2D,
294 osg::StateAttribute::ON);
295 _textureName = textureName;
300 if (_thresholdProp) {
301 osg::StateSet* stateSet = node->getOrCreateStateSet();
302 osg::StateAttribute* stateAttribute;
303 stateAttribute = stateSet->getAttribute(osg::StateAttribute::ALPHAFUNC);
304 osg::AlphaFunc* alphaFunc = dynamic_cast<osg::AlphaFunc*>(stateAttribute);
306 alphaFunc->setReferenceValue(_thresholdProp->getFloatValue());
308 osg::StateAttribute* stateAttribute
309 = stateSet->getAttribute(osg::StateAttribute::MATERIAL);
310 osg::Material* material = dynamic_cast<osg::Material*>(stateAttribute);
313 material->setAmbient(osg::Material::FRONT_AND_BACK,
314 _ambient.rgbaVec4());
316 material->setDiffuse(osg::Material::FRONT_AND_BACK,
317 _diffuse.rgbaVec4());
318 if (_specular.live())
319 material->setSpecular(osg::Material::FRONT_AND_BACK,
320 _specular.rgbaVec4());
321 if (_emission.live())
322 material->setEmission(osg::Material::FRONT_AND_BACK,
323 _emission.rgbaVec4());
324 if (_shininess.live())
325 material->setShininess(osg::Material::FRONT_AND_BACK,
326 _shininess.getValue());
327 if (_transparency.live()) {
328 float alpha = _transparency.getValue();
329 material->setAlpha(osg::Material::FRONT_AND_BACK, alpha);
331 stateSet->setRenderingHint(osg::StateSet::TRANSPARENT_BIN);
332 stateSet->setMode(GL_BLEND, osg::StateAttribute::ON);
334 stateSet->setRenderingHint(osg::StateSet::DEFAULT_BIN);
342 SGSharedPtr<const SGCondition> _condition;
343 SGSharedPtr<const SGPropertyNode> _textureProp;
344 SGSharedPtr<const SGPropertyNode> _thresholdProp;
345 std::string _textureName;
351 PropSpec _transparency;
352 osgDB::FilePathList _texturePathList;
357 SGMaterialAnimation::SGMaterialAnimation(const SGPropertyNode* configNode,
358 SGPropertyNode* modelRoot,
359 const osgDB::ReaderWriter::Options*
361 SGAnimation(configNode, modelRoot),
362 texturePathList(options->getDatabasePathList())
364 if (configNode->hasChild("global"))
365 SG_LOG(SG_IO, SG_ALERT, "Use of <global> in material animation is "
366 "no longer supported");
370 SGMaterialAnimation::createAnimationGroup(osg::Group& parent)
372 osg::Group* group = new osg::Group;
373 group->setName("material animation group");
375 SGPropertyNode* inputRoot = getModelRoot();
376 const SGPropertyNode* node = getConfig()->getChild("property-base");
378 inputRoot = getModelRoot()->getNode(node->getStringValue(), true);
379 if (getConfig()->hasChild("texture-prop")) {
380 osg::StateSet* stateSet = group->getOrCreateStateSet();
381 stateSet->setDataVariance(osg::Object::DYNAMIC);
383 if (getConfig()->hasChild("texture")) {
384 std::string textureName = getConfig()->getStringValue("texture");
385 std::string textureFile;
386 textureFile = osgDB::findFileInPath(textureName, texturePathList);
387 if (!textureFile.empty()) {
388 osg::StateSet* stateSet = group->getOrCreateStateSet();
389 osg::Texture2D* texture2D = SGLoadTexture2D(textureFile);
391 stateSet->setTextureAttribute(0, texture2D,
392 osg::StateAttribute::OVERRIDE);
393 stateSet->setTextureMode(0, GL_TEXTURE_2D, osg::StateAttribute::ON);
394 if (texture2D->getImage()->isImageTranslucent()) {
395 stateSet->setRenderingHint(osg::StateSet::TRANSPARENT_BIN);
396 stateSet->setMode(GL_BLEND, osg::StateAttribute::ON);
401 if (getConfig()->hasChild("threshold-prop") ||
402 getConfig()->hasChild("threshold")) {
403 osg::StateSet* stateSet = group->getOrCreateStateSet();
404 osg::AlphaFunc* alphaFunc = new osg::AlphaFunc;
405 alphaFunc->setFunction(osg::AlphaFunc::GREATER);
406 float threshold = getConfig()->getFloatValue("threshold", 0);
407 alphaFunc->setReferenceValue(threshold);
408 stateSet->setAttribute(alphaFunc, osg::StateAttribute::OVERRIDE);
411 unsigned suppliedColors = 0;
412 if (getConfig()->hasChild("ambient"))
413 suppliedColors |= AMBIENT;
414 if (getConfig()->hasChild("diffuse"))
415 suppliedColors |= DIFFUSE;
416 if (getConfig()->hasChild("specular"))
417 suppliedColors |= SPECULAR;
418 if (getConfig()->hasChild("emission"))
419 suppliedColors |= EMISSION;
420 if (getConfig()->hasChild("shininess")
421 || getConfig()->hasChild("shininess-prop"))
422 suppliedColors |= SHININESS;
423 if (getConfig()->hasChild("transparency"))
424 suppliedColors |= TRANSPARENCY;
426 if (suppliedColors != 0) {
427 osg::StateSet* stateSet = group->getOrCreateStateSet();
430 if (defaultMaterial.valid()) {
431 mat = defaultMaterial.get();
434 mat = new osg::Material;
435 mat->setColorMode(osg::Material::AMBIENT_AND_DIFFUSE);
437 mat->setDataVariance(osg::Object::DYNAMIC);
438 unsigned defaultColorModeMask = 0;
439 mat->setUpdateCallback(0); // Just to make sure.
440 switch (mat->getColorMode()) {
441 case osg::Material::OFF:
442 defaultColorModeMask = 0;
444 case osg::Material::AMBIENT:
445 defaultColorModeMask = AMBIENT;
447 case osg::Material::DIFFUSE:
448 defaultColorModeMask = DIFFUSE;
450 case osg::Material::AMBIENT_AND_DIFFUSE:
451 defaultColorModeMask = AMBIENT | DIFFUSE;
453 case osg::Material::SPECULAR:
454 defaultColorModeMask = SPECULAR;
456 case osg::Material::EMISSION:
457 defaultColorModeMask = EMISSION;
460 // Copy the color found by traversing geometry into the material
461 // in case we need to specify it (e.g., transparency) and it is
462 // not specified by the animation.
463 if (defaultAmbientDiffuse.x() >= 0) {
464 if (defaultColorModeMask & AMBIENT)
465 mat->setAmbient(osg::Material::FRONT_AND_BACK, defaultAmbientDiffuse);
466 if (defaultColorModeMask & DIFFUSE)
467 mat->setDiffuse(osg::Material::FRONT_AND_BACK, defaultAmbientDiffuse);
469 // Compute which colors in the animation override colors set via
470 // colorMode / glColor, and set the colorMode for the animation's
471 // material accordingly.
472 if (suppliedColors & TRANSPARENCY) {
473 // All colors will be affected by the material. Hope all the
474 // defaults are fine, if needed.
475 mat->setColorMode(osg::Material::OFF);
476 } else if ((suppliedColors & defaultColorModeMask) != 0) {
477 // First deal with the complicated AMBIENT/DIFFUSE case.
478 if ((defaultColorModeMask & AMBIENT_DIFFUSE) != 0) {
479 // glColor can supply colors not specified by the animation.
480 unsigned matColorModeMask = ((~suppliedColors & defaultColorModeMask)
482 if ((matColorModeMask & DIFFUSE) != 0)
483 mat->setColorMode(osg::Material::DIFFUSE);
484 else if ((matColorModeMask & AMBIENT) != 0)
485 mat->setColorMode(osg::Material::AMBIENT);
487 mat->setColorMode(osg::Material::OFF);
489 // The animation overrides the glColor color.
490 mat->setColorMode(osg::Material::OFF);
493 // No overlap between the animation and color mode, so leave
494 // the color mode alone.
496 stateSet->setAttribute(mat,(osg::StateAttribute::ON
497 | osg::StateAttribute::OVERRIDE));
499 group->setUpdateCallback(new UpdateCallback(texturePathList,
501 getConfig(), inputRoot));
502 parent.addChild(group);
507 SGMaterialAnimation::install(osg::Node& node)
509 SGAnimation::install(node);
511 MaterialDefaultsVisitor defaultsVisitor;
512 node.accept(defaultsVisitor);
513 if (defaultsVisitor.material.valid()) {
515 = static_cast<osg::Material*>(defaultsVisitor.material->clone(osg::CopyOp::SHALLOW_COPY));
517 defaultAmbientDiffuse = defaultsVisitor.ambientDiffuse;