Source/System/GraphOp/OSGMaterialGroupPushGraphOp.cpp

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *                   Copyright (C) 2008 by the OpenSG Forum                  *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #include "OSGMaterialGroupPushGraphOp.h"
  40 #include "OSGGraphOpFactory.h"
  41 #include "OSGAction.h"
  42 #include "OSGMaterialDrawable.h"
  43
  44 #include <boost/bind.hpp>
  45
  46 /*! \class OSG::MaterialGroupPushGraphOp
  47     \ingroup GrpSystemNodeCoresDrawablesGeometry
  48
  49     Moves the Materials form MaterialGroups to the MaterialDrawables below
  50     them and replaces the obsolete MaterialGroups with Groups.
  51 */
  52
  53 OSG_BEGIN_NAMESPACE
  54
  55 namespace
  56 {
  57     static bool registerOp(void)
  58     {
  59         GraphOpRefPtr newOp = MaterialGroupPushGraphOp::create();
  60
  61         GraphOpFactory::the()->registerOp(newOp);
  62         return true;
  63     }
  64
  65     static OSG::StaticInitFuncWrapper registerOpWrapper(registerOp);
  66 } // namespace
  67
  68 const char *MaterialGroupPushGraphOp::getClassname(void)
  69 {
  70     return "MaterialGroupPushGraphOp";
  71 }
  72
  73 MaterialGroupPushGraphOp::MaterialGroupPushGraphOp(const char* name)
  74     : Inherited(name)
  75 {
  76     // nothing to do
  77 }
  78
  79 MaterialGroupPushGraphOpTransitPtr
  80 MaterialGroupPushGraphOp::create(void)
  81 {
  82     return MaterialGroupPushGraphOpTransitPtr(
  83         new MaterialGroupPushGraphOp);
  84 }
  85
  86 GraphOpTransitPtr MaterialGroupPushGraphOp::clone(void)
  87 {
  88     return GraphOpTransitPtr(new MaterialGroupPushGraphOp);
  89 }
  90
  91 void MaterialGroupPushGraphOp::setParams(const std::string params)
  92 {
  93     ParamSet ps(params);
  94
  95     std::string out = ps.getUnusedParams();
  96     if(out.length())
  97     {
  98         FWARNING(("MaterialGroupPushGraphOp doesn't have parameters '%s'.\n",
  99                 out.c_str()));
 100     }
 101 }
 102
 103 std::string MaterialGroupPushGraphOp::usage(void)
 104 {
 105     return "MaterialGroupPush: Move Transform towards leafs of the scene.\n";
 106 }
 107
 108
 109 MaterialGroupPushGraphOp::~MaterialGroupPushGraphOp(void)
 110 {
 111     // nothing to do
 112 }
 113
 114
 115 Action::ResultE MaterialGroupPushGraphOp::traverseEnter(Node * const node)
 116 {
 117     if(isInExcludeList(node))
 118         return Action::Skip;
 119
 120     return Action::Continue;
 121 }
 122
 123 Action::ResultE MaterialGroupPushGraphOp::traverseLeave(
 124     Node * const node, Action::ResultE res)
 125 {
 126     if(isInExcludeList(node))
 127         return Action::Skip;
 128
 129     if(isInPreserveList(node))
 130         return Action::Continue;
 131
 132     MaterialGroup *mg = dynamic_cast<MaterialGroup *>(node->getCore());
 133
 134     if(mg == NULL)
 135         return Action::Continue;
 136
 137     // if not a leaf, search children recursively to find push targets
 138     if(!node->getMFChildren()->empty())
 139     {
 140         _pushPossible = true;
 141         _pushTargets.clear();
 142
 143         OSG::traverse(
 144             *(node->getMFChildren()),
 145             boost::bind(
 146                 &MaterialGroupPushGraphOp::traverseTargetsEnter, this, _1));
 147
 148         if(_pushPossible == true)
 149         {
 150             // push MaterialGroup into targets
 151             pushMaterialGroup(mg);
 152
 153             // replace MaterialGroup with group
 154             GroupUnrecPtr replaceCore = Group::create();
 155             node->setCore(replaceCore);
 156         }
 157     }
 158
 159     return Action::Continue;
 160 }
 161
 162 /*! Find push targets in subtree.
 163  */
 164 Action::ResultE MaterialGroupPushGraphOp::traverseTargetsEnter(Node * const node)
 165 {
 166     NodeCore *core = node->getCore();
 167
 168     if(core == NULL)
 169     {
 170         // warn about broken subtree, but do not prevent push, just skip it
 171         FWARNING(("MaterialGroupPushGraphOp::traverseTargetsEnter: "
 172                   "Found node without core!\n"));
 173         return Action::Skip;
 174     }
 175
 176     if(isInExcludeList(node) || isInPreserveList(node))
 177     {
 178         // prevent the push as the mat group can not be moved into this branch.
 179         _pushPossible = false;
 180
 181         return Action::Quit;
 182     }
 183
 184     if(core->getType().isDerivedFrom(MaterialDrawable::getClassType()))
 185     {
 186         // found a push target in this branch, store it and stop searching
 187         _pushTargets.push_back(node);
 188
 189         return Action::Skip;
 190     }
 191
 192     if( core->getType().isDerivedFrom(Group        ::getClassType()) &&
 193        !core->getType().isDerivedFrom(MaterialGroup::getClassType())   )
 194     {
 195         // keep searching children for push targets
 196         return Action::Continue;
 197     }
 198
 199     // unknown core type, be conservative and prevent the push
 200     _pushPossible = false;
 201
 202     return Action::Quit;
 203 }
 204
 205 void MaterialGroupPushGraphOp::pushMaterialGroup(MaterialGroup *mg)
 206 {
 207     PushTargetStore::iterator ptIt  = _pushTargets.begin();
 208     PushTargetStore::iterator ptEnd = _pushTargets.end  ();
 209
 210     for(; ptIt != ptEnd; ++ptIt)
 211     {
 212         MaterialDrawable *dstMD =
 213             dynamic_cast<MaterialDrawable *>((*ptIt)->getCore());
 214         if(dstMD != NULL)
 215         {
 216             dstMD->setMaterial(mg->getMaterial());
 217         }
 218     }
 219 }
 220
 221
 222 OSG_END_NAMESPACE