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__NODE__
      34              : #define __H__UG__NODE_TREE__NODE__
      35              : 
      36              : #include "object.h"
      37              : #include "common/util/smart_pointer.h"
      38              : 
      39              : 
      40              : ////////////////////////////////////////////////////////////////////////
      41              : //      SPNODE
      42              : ///     casts any type to SPNode.
      43              : /**
      44              :  * This macro should only be applied to SmartPointers,
      45              :  * which encapsulate a derivative of Node.
      46              :  */
      47              : //not needed any more, if the smart-pointer template constructor works
      48              : //TODO: remove this makro.
      49              : #define SPNODE(node) *((ng::SPNode*)&node)
      50              : 
      51              : 
      52              : namespace ug{
      53              : namespace node_tree
      54              : {
      55              : 
      56              : class Node;
      57              : 
      58              : ////////////////////////////////////////////////////////////////////////
      59              : ///     the smartpointer used to encapsulate the node
      60              : typedef SmartPtr<Node> SPNode;
      61              : 
      62              : ////////////////////////////////////////////////////////////////////////
      63              : //      Node
      64              : ///     Nodes serve as base-objects for items of wich a scene-graph consists.
      65              : /**
      66              :  * Nodes can not be directly instanced. Derivatives of Node should
      67              :  * feature a static create() function, through wich the user can recieve
      68              :  * an instance (encapsulated by the smart pointer SPNode).
      69              :  * This concept should be shared by all derived nodes.
      70              :  */
      71              : class Node : public Object
      72              : {
      73              :         friend class Traverser;
      74              :         
      75              :         public:
      76            0 :                 virtual ~Node() {}
      77              :                 
      78              :         protected:
      79              :                 Node()  {}
      80              : };
      81              : 
      82              : }//     end of namespace node_tree
      83              : }//     end of namespace ug
      84              : 
      85              : #endif