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),
265 const SGPropertyNode* node;
267 node = configNode->getChild("threshold-prop");
269 _thresholdProp = modelRoot->getNode(node->getStringValue(), true);
270 node = configNode->getChild("texture-prop");
272 _textureProp = modelRoot->getNode(node->getStringValue(), true);
273 _shininess.max = 128;
276 virtual void operator()(osg::Node* node, osg::NodeVisitor* nv)
278 osg::StateSet* stateSet = node->getStateSet();
279 if ((!_condition || _condition->test()) && stateSet) {
281 std::string textureName = _textureProp->getStringValue();
282 if (_textureName != textureName) {
283 while (stateSet->getTextureAttribute(0,
284 osg::StateAttribute::TEXTURE)) {
285 stateSet->removeTextureAttribute(0, osg::StateAttribute::TEXTURE);
287 std::string textureFile;
288 textureFile = osgDB::findFileInPath(textureName, _texturePathList);
289 if (!textureFile.empty()) {
290 osg::Texture2D* texture2D = SGLoadTexture2D(textureFile);
292 stateSet->setTextureAttribute(0, texture2D,
293 osg::StateAttribute::OVERRIDE);
294 stateSet->setTextureMode(0, GL_TEXTURE_2D,
295 osg::StateAttribute::ON);
296 _textureName = textureName;
301 if (_thresholdProp) {
302 osg::StateSet* stateSet = node->getOrCreateStateSet();
303 osg::StateAttribute* stateAttribute;
304 stateAttribute = stateSet->getAttribute(osg::StateAttribute::ALPHAFUNC);
305 osg::AlphaFunc* alphaFunc = dynamic_cast<osg::AlphaFunc*>(stateAttribute);
307 alphaFunc->setReferenceValue(_thresholdProp->getFloatValue());
309 osg::StateAttribute* stateAttribute
310 = stateSet->getAttribute(osg::StateAttribute::MATERIAL);
311 osg::Material* material = dynamic_cast<osg::Material*>(stateAttribute);
313 if (_ambient.live() || (!_prevState && _ambient.dirty()))
314 material->setAmbient(osg::Material::FRONT_AND_BACK,
315 _ambient.rgbaVec4());
316 if (_diffuse.live() || (!_prevState && _diffuse.dirty()))
317 material->setDiffuse(osg::Material::FRONT_AND_BACK,
318 _diffuse.rgbaVec4());
319 if (_specular.live() || (!_prevState && _specular.dirty()))
320 material->setSpecular(osg::Material::FRONT_AND_BACK,
321 _specular.rgbaVec4());
322 if (_emission.live() || (!_prevState && _emission.dirty()))
323 material->setEmission(osg::Material::FRONT_AND_BACK,
324 _emission.rgbaVec4());
325 if (_shininess.live() || (!_prevState && _shininess.dirty()))
326 material->setShininess(osg::Material::FRONT_AND_BACK,
327 _shininess.getValue());
328 if (_transparency.live() || (!_prevState && _transparency.dirty())) {
329 float alpha = _transparency.getValue();
330 material->setAlpha(osg::Material::FRONT_AND_BACK, alpha);
332 stateSet->setRenderingHint(osg::StateSet::TRANSPARENT_BIN);
333 stateSet->setMode(GL_BLEND, osg::StateAttribute::ON);
335 stateSet->setRenderingHint(osg::StateSet::DEFAULT_BIN);
346 SGSharedPtr<const SGCondition> _condition;
347 SGSharedPtr<const SGPropertyNode> _textureProp;
348 SGSharedPtr<const SGPropertyNode> _thresholdProp;
349 std::string _textureName;
355 PropSpec _transparency;
356 osgDB::FilePathList _texturePathList;
362 SGMaterialAnimation::SGMaterialAnimation(const SGPropertyNode* configNode,
363 SGPropertyNode* modelRoot,
364 const osgDB::ReaderWriter::Options*
366 SGAnimation(configNode, modelRoot),
367 texturePathList(options->getDatabasePathList())
369 if (configNode->hasChild("global"))
370 SG_LOG(SG_IO, SG_ALERT, "Use of <global> in material animation is "
371 "no longer supported");
375 SGMaterialAnimation::createAnimationGroup(osg::Group& parent)
377 osg::Group* group = new osg::Group;
378 group->setName("material animation group");
380 SGPropertyNode* inputRoot = getModelRoot();
381 const SGPropertyNode* node = getConfig()->getChild("property-base");
383 inputRoot = getModelRoot()->getNode(node->getStringValue(), true);
384 if (getConfig()->hasChild("texture-prop")) {
385 osg::StateSet* stateSet = group->getOrCreateStateSet();
386 stateSet->setDataVariance(osg::Object::DYNAMIC);
388 if (getConfig()->hasChild("texture")) {
389 std::string textureName = getConfig()->getStringValue("texture");
390 std::string textureFile;
391 textureFile = osgDB::findFileInPath(textureName, texturePathList);
392 if (!textureFile.empty()) {
393 osg::StateSet* stateSet = group->getOrCreateStateSet();
394 osg::Texture2D* texture2D = SGLoadTexture2D(textureFile);
396 stateSet->setTextureAttribute(0, texture2D,
397 osg::StateAttribute::OVERRIDE);
398 stateSet->setTextureMode(0, GL_TEXTURE_2D, osg::StateAttribute::ON);
399 if (texture2D->getImage()->isImageTranslucent()) {
400 stateSet->setRenderingHint(osg::StateSet::TRANSPARENT_BIN);
401 stateSet->setMode(GL_BLEND, osg::StateAttribute::ON);
406 if (getConfig()->hasChild("threshold-prop") ||
407 getConfig()->hasChild("threshold")) {
408 osg::StateSet* stateSet = group->getOrCreateStateSet();
409 osg::AlphaFunc* alphaFunc = new osg::AlphaFunc;
410 alphaFunc->setFunction(osg::AlphaFunc::GREATER);
411 float threshold = getConfig()->getFloatValue("threshold", 0);
412 alphaFunc->setReferenceValue(threshold);
413 stateSet->setAttribute(alphaFunc, osg::StateAttribute::OVERRIDE);
416 unsigned suppliedColors = 0;
417 if (getConfig()->hasChild("ambient"))
418 suppliedColors |= AMBIENT;
419 if (getConfig()->hasChild("diffuse"))
420 suppliedColors |= DIFFUSE;
421 if (getConfig()->hasChild("specular"))
422 suppliedColors |= SPECULAR;
423 if (getConfig()->hasChild("emission"))
424 suppliedColors |= EMISSION;
425 if (getConfig()->hasChild("shininess")
426 || getConfig()->hasChild("shininess-prop"))
427 suppliedColors |= SHININESS;
428 if (getConfig()->hasChild("transparency"))
429 suppliedColors |= TRANSPARENCY;
431 if (suppliedColors != 0) {
432 osg::StateSet* stateSet = group->getOrCreateStateSet();
435 if (defaultMaterial.valid()) {
436 mat = defaultMaterial.get();
439 mat = new osg::Material;
440 mat->setColorMode(osg::Material::AMBIENT_AND_DIFFUSE);
442 mat->setDataVariance(osg::Object::DYNAMIC);
443 unsigned defaultColorModeMask = 0;
444 mat->setUpdateCallback(0); // Just to make sure.
445 switch (mat->getColorMode()) {
446 case osg::Material::OFF:
447 defaultColorModeMask = 0;
449 case osg::Material::AMBIENT:
450 defaultColorModeMask = AMBIENT;
452 case osg::Material::DIFFUSE:
453 defaultColorModeMask = DIFFUSE;
455 case osg::Material::AMBIENT_AND_DIFFUSE:
456 defaultColorModeMask = AMBIENT | DIFFUSE;
458 case osg::Material::SPECULAR:
459 defaultColorModeMask = SPECULAR;
461 case osg::Material::EMISSION:
462 defaultColorModeMask = EMISSION;
465 // Copy the color found by traversing geometry into the material
466 // in case we need to specify it (e.g., transparency) and it is
467 // not specified by the animation.
468 if (defaultAmbientDiffuse.x() >= 0) {
469 if (defaultColorModeMask & AMBIENT)
470 mat->setAmbient(osg::Material::FRONT_AND_BACK, defaultAmbientDiffuse);
471 if (defaultColorModeMask & DIFFUSE)
472 mat->setDiffuse(osg::Material::FRONT_AND_BACK, defaultAmbientDiffuse);
474 // Compute which colors in the animation override colors set via
475 // colorMode / glColor, and set the colorMode for the animation's
476 // material accordingly.
477 if (suppliedColors & TRANSPARENCY) {
478 // All colors will be affected by the material. Hope all the
479 // defaults are fine, if needed.
480 mat->setColorMode(osg::Material::OFF);
481 } else if ((suppliedColors & defaultColorModeMask) != 0) {
482 // First deal with the complicated AMBIENT/DIFFUSE case.
483 if ((defaultColorModeMask & AMBIENT_DIFFUSE) != 0) {
484 // glColor can supply colors not specified by the animation.
485 unsigned matColorModeMask = ((~suppliedColors & defaultColorModeMask)
487 if ((matColorModeMask & DIFFUSE) != 0)
488 mat->setColorMode(osg::Material::DIFFUSE);
489 else if ((matColorModeMask & AMBIENT) != 0)
490 mat->setColorMode(osg::Material::AMBIENT);
492 mat->setColorMode(osg::Material::OFF);
494 // The animation overrides the glColor color.
495 mat->setColorMode(osg::Material::OFF);
498 // No overlap between the animation and color mode, so leave
499 // the color mode alone.
501 stateSet->setAttribute(mat,(osg::StateAttribute::ON
502 | osg::StateAttribute::OVERRIDE));
504 group->setUpdateCallback(new UpdateCallback(texturePathList,
506 getConfig(), inputRoot));
507 parent.addChild(group);
512 SGMaterialAnimation::install(osg::Node& node)
514 SGAnimation::install(node);
516 MaterialDefaultsVisitor defaultsVisitor;
517 node.accept(defaultsVisitor);
518 if (defaultsVisitor.material.valid()) {
520 = static_cast<osg::Material*>(defaultsVisitor.material->clone(osg::CopyOp::SHALLOW_COPY));
522 defaultAmbientDiffuse = defaultsVisitor.ambientDiffuse;