/*
 * Copyright (c) 2007-2015:  Sebastian Reiter
 * Author: Sebastian Reiter
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 */

#ifndef __H__UG__NODE_TREE__NODE__
#define __H__UG__NODE_TREE__NODE__

#include "object.h"
#include "common/util/smart_pointer.h"


////////////////////////////////////////////////////////////////////////
//	SPNODE
///	casts any type to SPNode.
/**
 * This macro should only be applied to SmartPointers,
 * which encapsulate a derivative of Node.
 */
//not needed any more, if the smart-pointer template constructor works
//TODO: remove this makro.
#define SPNODE(node) *((ng::SPNode*)&node)


namespace ug{
namespace node_tree
{

class Node;

////////////////////////////////////////////////////////////////////////
///	the smartpointer used to encapsulate the node
typedef SmartPtr<Node> SPNode;

////////////////////////////////////////////////////////////////////////
//	Node
///	Nodes serve as base-objects for items of wich a scene-graph consists.
/**
 * Nodes can not be directly instanced. Derivatives of Node should
 * feature a static create() function, through wich the user can recieve
 * an instance (encapsulated by the smart pointer SPNode).
 * This concept should be shared by all derived nodes.
 */
class Node : public Object
{
	friend class Traverser;
	
	public:
		virtual ~Node()	{}
		
	protected:
		Node()	{}
};

}//	end of namespace node_tree
}//	end of namespace ug

#endif
