stage/include/ost/gfx/gfx_node_visitor.hh
Go to the documentation of this file.00001 //------------------------------------------------------------------------------ 00002 // This file is part of the OpenStructure project <www.openstructure.org> 00003 // 00004 // Copyright (C) 2008-2011 by the OpenStructure authors 00005 // 00006 // This library is free software; you can redistribute it and/or modify it under 00007 // the terms of the GNU Lesser General Public License as published by the Free 00008 // Software Foundation; either version 3.0 of the License, or (at your option) 00009 // any later version. 00010 // This library is distributed in the hope that it will be useful, but WITHOUT 00011 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00012 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 00013 // details. 00014 // 00015 // You should have received a copy of the GNU Lesser General Public License 00016 // along with this library; if not, write to the Free Software Foundation, Inc., 00017 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 00018 //------------------------------------------------------------------------------ 00019 #ifndef OST_GFX_NODE_VISITOR_HH 00020 #define OST_GFX_NODE_VISITOR_HH 00021 00022 /* 00023 Author: Ansgar Philippsen 00024 */ 00025 00026 #include <stack> 00027 00028 #include <ost/gfx/module_config.hh> 00029 #include "gfx_node_fw.hh" 00030 #include "gfx_object_fw.hh" 00031 00032 namespace ost { namespace gfx { 00033 00034 class DLLEXPORT_OST_GFX GfxNodeVisitor 00035 { 00036 public: 00037 // in the below methods, contains the 'path' to the current 00038 // node or obj, where top() returns the direct parent 00039 typedef std::stack<GfxNode*> Stack; 00040 00041 virtual void OnStart() {} 00042 virtual void OnEnd() {} 00043 00044 // is called for each base node in the hierarchy 00045 // expected to return true if descent into child nodes is wanted 00046 virtual bool VisitNode(GfxNode* node, const Stack& st) {return true;} 00047 00048 // is called for each leaf 00049 virtual void VisitObject(GfxObj* obj, const Stack& st) {} 00050 00051 // is called just before returning to parent hierarchy 00052 virtual void LeaveNode(GfxNode* node, const Stack& st) {} 00053 00054 virtual ~GfxNodeVisitor() {} 00055 }; 00056 00057 }} // ns 00058 00059 #endif
