Line data    Source code

       1              : /*
       2              :  * Copyright (c) 2007-2015:  Sebastian Reiter
       3              :  * Author: Sebastian Reiter
       4              :  * 
       5              :  * This file is part of UG4.
       6              :  * 
       7              :  * UG4 is free software: you can redistribute it and/or modify it under the
       8              :  * terms of the GNU Lesser General Public License version 3 (as published by the
       9              :  * Free Software Foundation) with the following additional attribution
      10              :  * requirements (according to LGPL/GPL v3 §7):
      11              :  * 
      12              :  * (1) The following notice must be displayed in the Appropriate Legal Notices
      13              :  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
      14              :  * 
      15              :  * (2) The following notice must be displayed at a prominent place in the
      16              :  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
      17              :  * 
      18              :  * (3) The following bibliography is recommended for citation and must be
      19              :  * preserved in all covered files:
      20              :  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
      21              :  *   parallel geometric multigrid solver on hierarchically distributed grids.
      22              :  *   Computing and visualization in science 16, 4 (2013), 151-164"
      23              :  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
      24              :  *   flexible software system for simulating pde based models on high performance
      25              :  *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
      26              :  * 
      27              :  * This program is distributed in the hope that it will be useful,
      28              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      29              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
      30              :  * GNU Lesser General Public License for more details.
      31              :  */
      32              : 
      33              : #ifndef __H__UG__NODE_TREE__TRAVERSER__
      34              : #define __H__UG__NODE_TREE__TRAVERSER__
      35              : 
      36              : #include <vector>
      37              : #include "object.h"
      38              : #include "node.h"
      39              : 
      40              : namespace ug{
      41              : namespace node_tree
      42              : {
      43              : 
      44              : class Traverser;
      45              : class GroupNode;
      46              : class BoxedGroupNode;
      47              : 
      48              : ////////////////////////////////////////////////////////////////////////
      49              : //      Traverser
      50              : ///     Derivates of a Traverser can be used to traverse a scenegraph.
      51              : /**
      52              : */
      53              : class Traverser
      54              : {
      55              :         public:
      56              :                 Traverser();
      57              :                 virtual ~Traverser();
      58              : 
      59              :         protected:
      60              :                 void apply(SPNode& node);
      61              : 
      62              :                 template<typename HandlerType>
      63              :                 void register_handler_function(unsigned int oc, HandlerType func);
      64              : 
      65              :                 void traverse_object(Object* obj);
      66              : 
      67              :                 virtual void handle_group(GroupNode* group);
      68              :                 virtual void handle_boxed_group(BoxedGroupNode* boxedGroup);
      69              : 
      70              :         private:
      71              :                 bool handler_function_registered(unsigned int oc);
      72              : 
      73              :         private:
      74              :                 typedef void (Traverser::*HandlerFunc)(Object* obj);
      75              :                 std::vector<HandlerFunc>  m_vHandlerFuncs;
      76              : };
      77              : 
      78              : 
      79              : template<typename HandlerType>
      80            0 : void Traverser::register_handler_function(unsigned int oc, HandlerType func)
      81              : {
      82              : //      make sure that there is enough space
      83            0 :         if(oc >= m_vHandlerFuncs.size())
      84            0 :                 m_vHandlerFuncs.resize(oc+1, 0);
      85              : 
      86            0 :         m_vHandlerFuncs[oc] = (HandlerFunc)func;
      87            0 : }
      88              : 
      89              : 
      90              : }//     end of namespace node_tree
      91              : }//     end of namespace ug
      92              : 
      93              : #endif